Skip to content

Add integration tests to the CICD pipeline#1854

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nikosdouvlis merged 16 commits into from
Oct 13, 2023
Merged

Add integration tests to the CICD pipeline #1854

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
90d08c6
chore(repo): Introduce `testAgainstRunningApps` helper
nikosdouvlis Oct 2, 2023
d66b956
chore(repo): Add integration testing readme
nikosdouvlis Oct 9, 2023
b03199b
chore(repo): Introduce publint
nikosdouvlis Oct 9, 2023
3fa1bf7
chore(repo): Introduce attw cli
nikosdouvlis Oct 9, 2023
0e5bf8a
chore(repo): Allow starting long-running app using patterns
nikosdouvlis Oct 9, 2023
20990d7
chore(repo): Revamp CICD caching strategies to improve performance
nikosdouvlis Oct 9, 2023
2919fae
chore(repo): Enable HTML report for integration tests on CI
nikosdouvlis Oct 9, 2023
1923d86
chore(repo): Make the CICD scripts DRY
nikosdouvlis Oct 9, 2023
c70ffeb
chore(repo): Completely ignore stdio of all detached spawned processes
nikosdouvlis Oct 11, 2023
a7a384b
chore(repo): Introduce `applicationConfig.addDependency` to programma…
nikosdouvlis Oct 11, 2023
a7d8e7e
chore(repo): Set playwright concurrency to 50% on CI
nikosdouvlis Oct 11, 2023
3798036
chore(repo): Introduce nightly checks
nikosdouvlis Oct 11, 2023
226348b
chore(repo): Add verdaccio
nikosdouvlis Oct 11, 2023
76fad6a
chore(repo): Run quality checks first
nikosdouvlis Oct 12, 2023
c2a3c5d
chore(repo): Publish packages locally using Verdaccio
nikosdouvlis Oct 12, 2023
cacef87
chore(repo): Merge main
nikosdouvlis Oct 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions .github/workflows/base-build.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
on:
workflow_call:

jobs:
build:
# if: ${{ github.repository == 'clerkinc/javascript' }}
runs-on: ${{ vars.RUNNER_LARGE }}
steps:
- name: Checkout repo
uses: actions/checkout@v3
- name: Setup
uses: ./.github/actions/setup
- name: Build
run: npm run build
- name: Upload package artifacts
uses: actions/upload-artifact@v3
with:
name: package-artifacts
path: ./node_modules/.cache/turbo
retention-days: 1
- name: Configure npm to use Verdaccio
run: |
npm set registry http://localhost:4873/
nohup ./node_modules/.bin/verdaccio --config ./verdaccio.publish.yaml &
sleep 5
./node_modules/.bin/npm-cli-adduser -u user -p pass -e test@test.com -r http://localhost:4873/
./node_modules/.bin/npm-cli-login -u user -p pass -e test@test.com -r http://localhost:4873/
- name: Publish to Verdaccio
# The command below includes a sanity check
# and fails early if the default npm registry is used
run: |
npm run release:verdaccio
- name: List published packages
run: |
ls -all .verdaccio/storage/@clerk
- uses: actions/upload-artifact@v3
with:
name: verdaccio
path: .verdaccio
15 changes: 15 additions & 0 deletions .github/workflows/base-changeset.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
on:
workflow_call:

jobs:
check:
runs-on: ${{ vars.RUNNER_LARGE }}
steps:
- name: Checkout repo
uses: actions/checkout@v3
with:
ref: ${{github.event.pull_request.head.sha}}
fetch-depth: 0
- name: Setup
uses: ./.github/actions/setup
- run: npx changeset status --since=origin/main
62 changes: 62 additions & 0 deletions .github/workflows/base-e2e.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
name: Integration reusable workflow
on:
workflow_call:
inputs:
SCRIPT:
required: true
type: string
secrets:
INTEGRATION_INSTANCE_KEYS:
required: true
MAILSAC_API_KEY:
required: true

jobs:
run:
continue-on-error: true
timeout-minutes: 60
runs-on: ${{ vars.RUNNER_LARGE }}
concurrency:
group: integration-${{ github.ref }}-${{ inputs.script }}
cancel-in-progress: true
steps:
- uses: actions/checkout@v3
- name: Setup
uses: ./.github/actions/setup
- name: Get installed Playwright version
id: playwright-version
run: echo "PLAYWRIGHT_VERSION=$(node -e "console.log($(npm ls @playwright/test --json).dependencies['@playwright/test'].version)")" >> $GITHUB_ENV
- name: Cache playwright binaries
uses: actions/cache@v3
id: playwright-cache
with:
path: ~/.cache/ms-playwright
key: ${{ runner.os }}-playwright-${{ env.PLAYWRIGHT_VERSION }}
- name: Install Playwright Browsers
if: steps.playwright-cache.outputs.cache-hit != 'true'
run: npx playwright install --with-deps
- name: Download Verdaccio artifacts
uses: actions/download-artifact@v3
with:
name: verdaccio
path: .verdaccio
- name: Run Verdaccio
run: |
npm set registry http://localhost:4873/
nohup ./node_modules/.bin/verdaccio --config ./verdaccio.install.yaml &
sleep 5
- name: Install @clerk/backend in /integration
run: |
cd integration && npm init -y && npm install @clerk/backend && cd ..
- name: Run Playwright tests
run: ${{ inputs.SCRIPT }}
env:
INTEGRATION_INSTANCE_KEYS: ${{ secrets.INTEGRATION_INSTANCE_KEYS }}
MAILSAC_API_KEY: ${{ secrets.MAILSAC_API_KEY }}
E2E_CLERK_VERSION: 'latest'
- uses: actions/upload-artifact@v3
if: always()
with:
name: playwright-report
path: playwright-report/
retention-days: 30
13 changes: 13 additions & 0 deletions .github/workflows/base-lint.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
on:
workflow_call:

jobs:
check:
continue-on-error: true
runs-on: ${{ vars.RUNNER_LARGE }}
steps:
- name: Checkout repo
uses: actions/checkout@v3
- name: Setup
uses: ./.github/actions/setup
- run: npm run lint
12 changes: 12 additions & 0 deletions .github/workflows/base-prettier.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
on:
workflow_call:

jobs:
check:
runs-on: ${{ vars.RUNNER_LARGE }}
steps:
- name: Checkout repo
uses: actions/checkout@v3
- name: Setup
uses: ./.github/actions/setup
- run: npm run format:check
34 changes: 34 additions & 0 deletions .github/workflows/base-registry.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
on:
workflow_call:

jobs:
registry:
runs-on: ${{ vars.RUNNER_LARGE }}
steps:
- uses: actions/checkout@v3
- name: Setup
uses: ./.github/actions/setup
- name: Download turbo cache
uses: actions/download-artifact@v3
with:
name: package-artifacts
path: ./node_modules/.cache/turbo
- name: Configure npm to use Verdaccio
run: |
npm set registry http://localhost:4873/
nohup ./node_modules/.bin/verdaccio --config ./verdaccio.publish.yaml &
sleep 5
./node_modules/.bin/npm-cli-adduser -u user -p pass -e test@test.com -r http://localhost:4873/
./node_modules/.bin/npm-cli-login -u user -p pass -e test@test.com -r http://localhost:4873/
- name: Publish to Verdaccio
# The command below includes a sanity check
# and fails early if the default npm registry is used
run: |
npm run release:verdaccio
- name: List published packages
run: |
ls -all .verdaccio/storage/@clerk
- uses: actions/upload-artifact@v3
with:
name: verdaccio
path: .verdaccio
104 changes: 104 additions & 0 deletions .github/workflows/checks.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
name: Quality checks and tests
on:
pull_request:
branches: [ main ]

concurrency:
group: checks-${{ github.ref }}
cancel-in-progress: true

jobs:
prettier:
name: Prettier
uses: ./.github/workflows/base-prettier.yml

eslint:
name: Eslint
uses: ./.github/workflows/base-lint.yml

changeset:
name: Require changeset
uses: ./.github/workflows/base-changeset.yml

build:
if: ${{ github.repository == 'clerkinc/javascript' }}
name: Build & publish
needs: [ prettier, changeset ]
uses: ./.github/workflows/base-build.yml

unit-tests:
name: Run unit tests
needs: build
runs-on: ${{ vars.RUNNER_LARGE }}
strategy:
matrix:
node-version: [ 18, 19 ]
steps:
- uses: actions/checkout@v3
- name: Setup
uses: ./.github/actions/setup
- name: Download turbo cache
uses: actions/download-artifact@v3
with:
name: package-artifacts
path: ./node_modules/.cache/turbo
- name: Run tests
run: npm run test:ci

publint:
name: Run publint
needs: build
runs-on: ${{ vars.RUNNER_LARGE }}
steps:
- uses: actions/checkout@v3
- name: Setup
uses: ./.github/actions/setup
- name: Download turbo cache
uses: actions/download-artifact@v3
with:
name: package-artifacts
path: ./node_modules/.cache/turbo
- name: Lint packages using publint
run: npm run lint:publint

attw:
name: Run attw
needs: build
runs-on: ${{ vars.RUNNER_LARGE }}
steps:
- uses: actions/checkout@v3
- name: Setup
uses: ./.github/actions/setup
- name: Download turbo cache
uses: actions/download-artifact@v3
with:
name: package-artifacts
path: ./node_modules/.cache/turbo
- name: Lint types using attw
# Remove this when all related errors are fixed
continue-on-error: true
run: npm run lint:attw

integration-generic:
name: Integration (Generic)
needs: build
uses: ./.github/workflows/base-e2e.yml
with:
SCRIPT: 'npm run test:integration:generic'
secrets: inherit

integration-nextjs:
name: Integration (NextJS)
needs: build
uses: ./.github/workflows/base-e2e.yml
with:
SCRIPT: 'npm run test:integration:nextjs'
secrets: inherit

integration-remix:
name: Integration (Remix)
needs: build
uses: ./.github/workflows/base-e2e.yml
with:
SCRIPT: 'npm run test:integration:remix'
secrets: inherit
2 changes: 1 addition & 1 deletion .github/workflows/labeler.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ jobs:
permissions:
contents: read
pull-requests: write
runs-on: ubuntu-latest
runs-on: ${{ vars.RUNNER_LARGE }}
steps:
- uses: actions/labeler@v4
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/lock-threads.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ concurrency:

jobs:
action:
runs-on: ubuntu-latest
runs-on: ${{ vars.RUNNER_NORMAL }}
steps:
- uses: actions/stale@v8
with:
Expand Down
32 changes: 32 additions & 0 deletions .github/workflows/nightly-checks.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
name: Nightly upstream tests
on:
workflow_dispatch:
schedule:
- cron: '0 7 * * *'

jobs:
build:
name: Build packages and upload artifacts
uses: ./.github/workflows/base-build.yml

integration-nextjs:
name: Integration (NextJS canary)
needs: build
uses: ./.github/workflows/base-e2e.yml
with:
SCRIPT: 'E2E_NEXTJS_VERSION=canary npm run test:integration:nextjs'
secrets: inherit

notify-slack:
name: Notify Slack
needs: integration-nextjs
if: ${{ contains(needs.*.result, 'failure') }}
runs-on: ${{ vars.RUNNER_LARGE }}
steps:
- name: Report Status
uses: ravsamhq/notify-slack-action@v1
with:
status: 'failure'
notify_when: 'failure'
env:
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_SDK_E2E_ALERTS_WEBHOOK_URL }}
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Add integration tests to the CICD pipeline by nikosdouvlis · Pull Request #1854 · clerk/javascript · GitHub
Skip to content
Add integration tests to the CICD pipeline#1854

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 16 commits into

from

Oct 13, 2023
 Merged


Add integration tests to the CICD pipeline
#1854
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
90d08c6

chore(repo): Introduce `testAgainstRunningApps` helper


nikosdouvlis Oct 2, 2023
d66b956

chore(repo): Add integration testing readme


nikosdouvlis Oct 9, 2023
b03199b

chore(repo): Introduce publint


nikosdouvlis Oct 9, 2023
3fa1bf7

chore(repo): Introduce attw cli


nikosdouvlis Oct 9, 2023
0e5bf8a

chore(repo): Allow starting long-running app using patterns


nikosdouvlis Oct 9, 2023
20990d7

chore(repo): Revamp CICD caching strategies to improve performance


nikosdouvlis Oct 9, 2023
2919fae

chore(repo): Enable HTML report for integration tests on CI


nikosdouvlis Oct 9, 2023
1923d86

chore(repo): Make the CICD scripts DRY


nikosdouvlis Oct 9, 2023
c70ffeb

chore(repo): Completely ignore stdio of all detached spawned processes


nikosdouvlis Oct 11, 2023
a7a384b

chore(repo): Introduce `applicationConfig.addDependency` to programma…


nikosdouvlis Oct 11, 2023
a7d8e7e

chore(repo): Set playwright concurrency to 50% on CI


nikosdouvlis Oct 11, 2023
3798036

chore(repo): Introduce nightly checks


nikosdouvlis Oct 11, 2023
226348b

chore(repo): Add verdaccio


nikosdouvlis Oct 11, 2023
76fad6a

chore(repo): Run quality checks first


nikosdouvlis Oct 12, 2023
c2a3c5d

chore(repo): Publish packages locally using Verdaccio


nikosdouvlis Oct 12, 2023
cacef87

chore(repo): Merge main


nikosdouvlis Oct 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


39 changes: 39 additions & 0 deletions
.github/workflows/base-build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
on:
 workflow_call:

jobs:
 build:
 # if: ${{ github.repository == 'clerkinc/javascript' }}
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Build
 run: npm run build
 - name: Upload package artifacts
 uses: actions/upload-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 retention-days: 1
 - name: Configure npm to use Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.publish.yaml &
 sleep 5
 ./node_modules/.bin/npm-cli-adduser -u user -p pass -e test@test.com -r http://localhost:4873/
 ./node_modules/.bin/npm-cli-login -u user -p pass -e test@test.com -r http://localhost:4873/
 - name: Publish to Verdaccio
 # The command below includes a sanity check
 # and fails early if the default npm registry is used
 run: |
 npm run release:verdaccio
 - name: List published packages
 run: |
 ls -all .verdaccio/storage/@clerk
 - uses: actions/upload-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio

15 changes: 15 additions & 0 deletions
.github/workflows/base-changeset.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
on:
 workflow_call:

jobs:
 check:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 with:
 ref: ${{github.event.pull_request.head.sha}}
 fetch-depth: 0
 - name: Setup
 uses: ./.github/actions/setup
 - run: npx changeset status --since=origin/main

62 changes: 62 additions & 0 deletions
.github/workflows/base-e2e.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
name: Integration reusable workflow
on:
 workflow_call:
 inputs:
 SCRIPT:
 required: true
 type: string
 secrets:
 INTEGRATION_INSTANCE_KEYS:
 required: true
 MAILSAC_API_KEY:
 required: true

jobs:
 run:
 continue-on-error: true
 timeout-minutes: 60
 runs-on: ${{ vars.RUNNER_LARGE }}
 concurrency:
 group: integration-${{ github.ref }}-${{ inputs.script }}
 cancel-in-progress: true
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Get installed Playwright version
 id: playwright-version
 run: echo "PLAYWRIGHT_VERSION=$(node -e "console.log($(npm ls @playwright/test --json).dependencies['@playwright/test'].version)")" >> $GITHUB_ENV
 - name: Cache playwright binaries
 uses: actions/cache@v3
 id: playwright-cache
 with:
 path: ~/.cache/ms-playwright
 key: ${{ runner.os }}-playwright-${{ env.PLAYWRIGHT_VERSION }}
 - name: Install Playwright Browsers
 if: steps.playwright-cache.outputs.cache-hit != 'true'
 run: npx playwright install --with-deps
 - name: Download Verdaccio artifacts
 uses: actions/download-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio
 - name: Run Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.install.yaml &
 sleep 5
 - name: Install @clerk/backend in /integration
 run: |
 cd integration && npm init -y && npm install @clerk/backend && cd ..
 - name: Run Playwright tests
 run: ${{ inputs.SCRIPT }}
 env:
 INTEGRATION_INSTANCE_KEYS: ${{ secrets.INTEGRATION_INSTANCE_KEYS }}
 MAILSAC_API_KEY: ${{ secrets.MAILSAC_API_KEY }}
 E2E_CLERK_VERSION: 'latest'
 - uses: actions/upload-artifact@v3
 if: always()
 with:
 name: playwright-report
 path: playwright-report/
 retention-days: 30

13 changes: 13 additions & 0 deletions
.github/workflows/base-lint.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
on:
 workflow_call:

jobs:
 check:
 continue-on-error: true
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - run: npm run lint

12 changes: 12 additions & 0 deletions
.github/workflows/base-prettier.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
on:
 workflow_call:

jobs:
 check:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - run: npm run format:check

34 changes: 34 additions & 0 deletions
.github/workflows/base-registry.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
on:
 workflow_call:

jobs:
 registry:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Configure npm to use Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.publish.yaml &
 sleep 5
 ./node_modules/.bin/npm-cli-adduser -u user -p pass -e test@test.com -r http://localhost:4873/
 ./node_modules/.bin/npm-cli-login -u user -p pass -e test@test.com -r http://localhost:4873/
 - name: Publish to Verdaccio
 # The command below includes a sanity check
 # and fails early if the default npm registry is used
 run: |
 npm run release:verdaccio
 - name: List published packages
 run: |
 ls -all .verdaccio/storage/@clerk
 - uses: actions/upload-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio

104 changes: 104 additions & 0 deletions
.github/workflows/checks.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
name: Quality checks and tests
on:
 pull_request:
 branches: [ main ]

concurrency:
 group: checks-${{ github.ref }}
 cancel-in-progress: true

jobs:
 prettier:
 name: Prettier
 uses: ./.github/workflows/base-prettier.yml

 eslint:
 name: Eslint
 uses: ./.github/workflows/base-lint.yml

 changeset:
 name: Require changeset
 uses: ./.github/workflows/base-changeset.yml

 build:
 if: ${{ github.repository == 'clerkinc/javascript' }}
 name: Build & publish
 needs: [ prettier, changeset ]
 uses: ./.github/workflows/base-build.yml

 unit-tests:
 name: Run unit tests
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 strategy:
 matrix:
 node-version: [ 18, 19 ]
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Run tests
 run: npm run test:ci

 publint:
 name: Run publint
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Lint packages using publint
 run: npm run lint:publint

 attw:
 name: Run attw
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Lint types using attw
 # Remove this when all related errors are fixed
 continue-on-error: true
 run: npm run lint:attw

 integration-generic:
 name: Integration (Generic)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:generic'
 secrets: inherit

 integration-nextjs:
 name: Integration (NextJS)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:nextjs'
 secrets: inherit

 integration-remix:
 name: Integration (Remix)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:remix'
 secrets: inherit

2 changes: 1 addition & 1 deletion
.github/workflows/labeler.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ jobs:
 permissions:
 contents: read
 pull-requests: write
 runs-on: ubuntu-latest
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/labeler@v4
 with:
Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/lock-threads.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ concurrency:

jobs:
 action:
 runs-on: ubuntu-latest
 runs-on: ${{ vars.RUNNER_NORMAL }}
 steps:
 - uses: actions/stale@v8
 with:
Expand Down

32 changes: 32 additions & 0 deletions
.github/workflows/nightly-checks.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
name: Nightly upstream tests
on:
 workflow_dispatch:
 schedule:
 - cron: '0 7 * * *'

jobs:
 build:
 name: Build packages and upload artifacts
 uses: ./.github/workflows/base-build.yml

 integration-nextjs:
 name: Integration (NextJS canary)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'E2E_NEXTJS_VERSION=canary npm run test:integration:nextjs'
 secrets: inherit

 notify-slack:
 name: Notify Slack
 needs: integration-nextjs
 if: ${{ contains(needs.*.result, 'failure') }}
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Report Status
 uses: ravsamhq/notify-slack-action@v1
 with:
 status: 'failure'
 notify_when: 'failure'
 env:
 SLACK_WEBHOOK_URL: ${{ secrets.SLACK_SDK_E2E_ALERTS_WEBHOOK_URL }}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add integration tests to the CICD pipeline by nikosdouvlis · Pull Request #1854 · clerk/javascript · GitHub
Skip to content
Add integration tests to the CICD pipeline#1854

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 16 commits into

from

Oct 13, 2023
 Merged


Add integration tests to the CICD pipeline
#1854
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
90d08c6

chore(repo): Introduce `testAgainstRunningApps` helper


nikosdouvlis Oct 2, 2023
d66b956

chore(repo): Add integration testing readme


nikosdouvlis Oct 9, 2023
b03199b

chore(repo): Introduce publint


nikosdouvlis Oct 9, 2023
3fa1bf7

chore(repo): Introduce attw cli


nikosdouvlis Oct 9, 2023
0e5bf8a

chore(repo): Allow starting long-running app using patterns


nikosdouvlis Oct 9, 2023
20990d7

chore(repo): Revamp CICD caching strategies to improve performance


nikosdouvlis Oct 9, 2023
2919fae

chore(repo): Enable HTML report for integration tests on CI


nikosdouvlis Oct 9, 2023
1923d86

chore(repo): Make the CICD scripts DRY


nikosdouvlis Oct 9, 2023
c70ffeb

chore(repo): Completely ignore stdio of all detached spawned processes


nikosdouvlis Oct 11, 2023
a7a384b

chore(repo): Introduce `applicationConfig.addDependency` to programma…


nikosdouvlis Oct 11, 2023
a7d8e7e

chore(repo): Set playwright concurrency to 50% on CI


nikosdouvlis Oct 11, 2023
3798036

chore(repo): Introduce nightly checks


nikosdouvlis Oct 11, 2023
226348b

chore(repo): Add verdaccio


nikosdouvlis Oct 11, 2023
76fad6a

chore(repo): Run quality checks first


nikosdouvlis Oct 12, 2023
c2a3c5d

chore(repo): Publish packages locally using Verdaccio


nikosdouvlis Oct 12, 2023
cacef87

chore(repo): Merge main


nikosdouvlis Oct 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


39 changes: 39 additions & 0 deletions
.github/workflows/base-build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
on:
 workflow_call:

jobs:
 build:
 # if: ${{ github.repository == 'clerkinc/javascript' }}
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Build
 run: npm run build
 - name: Upload package artifacts
 uses: actions/upload-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 retention-days: 1
 - name: Configure npm to use Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.publish.yaml &
 sleep 5
 ./node_modules/.bin/npm-cli-adduser -u user -p pass -e test@test.com -r http://localhost:4873/
 ./node_modules/.bin/npm-cli-login -u user -p pass -e test@test.com -r http://localhost:4873/
 - name: Publish to Verdaccio
 # The command below includes a sanity check
 # and fails early if the default npm registry is used
 run: |
 npm run release:verdaccio
 - name: List published packages
 run: |
 ls -all .verdaccio/storage/@clerk
 - uses: actions/upload-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio

15 changes: 15 additions & 0 deletions
.github/workflows/base-changeset.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
on:
 workflow_call:

jobs:
 check:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 with:
 ref: ${{github.event.pull_request.head.sha}}
 fetch-depth: 0
 - name: Setup
 uses: ./.github/actions/setup
 - run: npx changeset status --since=origin/main

62 changes: 62 additions & 0 deletions
.github/workflows/base-e2e.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
name: Integration reusable workflow
on:
 workflow_call:
 inputs:
 SCRIPT:
 required: true
 type: string
 secrets:
 INTEGRATION_INSTANCE_KEYS:
 required: true
 MAILSAC_API_KEY:
 required: true

jobs:
 run:
 continue-on-error: true
 timeout-minutes: 60
 runs-on: ${{ vars.RUNNER_LARGE }}
 concurrency:
 group: integration-${{ github.ref }}-${{ inputs.script }}
 cancel-in-progress: true
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Get installed Playwright version
 id: playwright-version
 run: echo "PLAYWRIGHT_VERSION=$(node -e "console.log($(npm ls @playwright/test --json).dependencies['@playwright/test'].version)")" >> $GITHUB_ENV
 - name: Cache playwright binaries
 uses: actions/cache@v3
 id: playwright-cache
 with:
 path: ~/.cache/ms-playwright
 key: ${{ runner.os }}-playwright-${{ env.PLAYWRIGHT_VERSION }}
 - name: Install Playwright Browsers
 if: steps.playwright-cache.outputs.cache-hit != 'true'
 run: npx playwright install --with-deps
 - name: Download Verdaccio artifacts
 uses: actions/download-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio
 - name: Run Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.install.yaml &
 sleep 5
 - name: Install @clerk/backend in /integration
 run: |
 cd integration && npm init -y && npm install @clerk/backend && cd ..
 - name: Run Playwright tests
 run: ${{ inputs.SCRIPT }}
 env:
 INTEGRATION_INSTANCE_KEYS: ${{ secrets.INTEGRATION_INSTANCE_KEYS }}
 MAILSAC_API_KEY: ${{ secrets.MAILSAC_API_KEY }}
 E2E_CLERK_VERSION: 'latest'
 - uses: actions/upload-artifact@v3
 if: always()
 with:
 name: playwright-report
 path: playwright-report/
 retention-days: 30

13 changes: 13 additions & 0 deletions
.github/workflows/base-lint.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
on:
 workflow_call:

jobs:
 check:
 continue-on-error: true
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - run: npm run lint

12 changes: 12 additions & 0 deletions
.github/workflows/base-prettier.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
on:
 workflow_call:

jobs:
 check:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - run: npm run format:check

34 changes: 34 additions & 0 deletions
.github/workflows/base-registry.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
on:
 workflow_call:

jobs:
 registry:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Configure npm to use Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.publish.yaml &
 sleep 5
 ./node_modules/.bin/npm-cli-adduser -u user -p pass -e test@test.com -r http://localhost:4873/
 ./node_modules/.bin/npm-cli-login -u user -p pass -e test@test.com -r http://localhost:4873/
 - name: Publish to Verdaccio
 # The command below includes a sanity check
 # and fails early if the default npm registry is used
 run: |
 npm run release:verdaccio
 - name: List published packages
 run: |
 ls -all .verdaccio/storage/@clerk
 - uses: actions/upload-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio

104 changes: 104 additions & 0 deletions
.github/workflows/checks.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
name: Quality checks and tests
on:
 pull_request:
 branches: [ main ]

concurrency:
 group: checks-${{ github.ref }}
 cancel-in-progress: true

jobs:
 prettier:
 name: Prettier
 uses: ./.github/workflows/base-prettier.yml

 eslint:
 name: Eslint
 uses: ./.github/workflows/base-lint.yml

 changeset:
 name: Require changeset
 uses: ./.github/workflows/base-changeset.yml

 build:
 if: ${{ github.repository == 'clerkinc/javascript' }}
 name: Build & publish
 needs: [ prettier, changeset ]
 uses: ./.github/workflows/base-build.yml

 unit-tests:
 name: Run unit tests
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 strategy:
 matrix:
 node-version: [ 18, 19 ]
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Run tests
 run: npm run test:ci

 publint:
 name: Run publint
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Lint packages using publint
 run: npm run lint:publint

 attw:
 name: Run attw
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Lint types using attw
 # Remove this when all related errors are fixed
 continue-on-error: true
 run: npm run lint:attw

 integration-generic:
 name: Integration (Generic)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:generic'
 secrets: inherit

 integration-nextjs:
 name: Integration (NextJS)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:nextjs'
 secrets: inherit

 integration-remix:
 name: Integration (Remix)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:remix'
 secrets: inherit

2 changes: 1 addition & 1 deletion
.github/workflows/labeler.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ jobs:
 permissions:
 contents: read
 pull-requests: write
 runs-on: ubuntu-latest
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/labeler@v4
 with:
Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/lock-threads.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ concurrency:

jobs:
 action:
 runs-on: ubuntu-latest
 runs-on: ${{ vars.RUNNER_NORMAL }}
 steps:
 - uses: actions/stale@v8
 with:
Expand Down

32 changes: 32 additions & 0 deletions
.github/workflows/nightly-checks.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
name: Nightly upstream tests
on:
 workflow_dispatch:
 schedule:
 - cron: '0 7 * * *'

jobs:
 build:
 name: Build packages and upload artifacts
 uses: ./.github/workflows/base-build.yml

 integration-nextjs:
 name: Integration (NextJS canary)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'E2E_NEXTJS_VERSION=canary npm run test:integration:nextjs'
 secrets: inherit

 notify-slack:
 name: Notify Slack
 needs: integration-nextjs
 if: ${{ contains(needs.*.result, 'failure') }}
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Report Status
 uses: ravsamhq/notify-slack-action@v1
 with:
 status: 'failure'
 notify_when: 'failure'
 env:
 SLACK_WEBHOOK_URL: ${{ secrets.SLACK_SDK_E2E_ALERTS_WEBHOOK_URL }}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add integration tests to the CICD pipeline by nikosdouvlis · Pull Request #1854 · clerk/javascript · GitHub
Skip to content
Add integration tests to the CICD pipeline#1854

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 16 commits into

from

Oct 13, 2023
 Merged


Add integration tests to the CICD pipeline
#1854
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
90d08c6

chore(repo): Introduce `testAgainstRunningApps` helper


nikosdouvlis Oct 2, 2023
d66b956

chore(repo): Add integration testing readme


nikosdouvlis Oct 9, 2023
b03199b

chore(repo): Introduce publint


nikosdouvlis Oct 9, 2023
3fa1bf7

chore(repo): Introduce attw cli


nikosdouvlis Oct 9, 2023
0e5bf8a

chore(repo): Allow starting long-running app using patterns


nikosdouvlis Oct 9, 2023
20990d7

chore(repo): Revamp CICD caching strategies to improve performance


nikosdouvlis Oct 9, 2023
2919fae

chore(repo): Enable HTML report for integration tests on CI


nikosdouvlis Oct 9, 2023
1923d86

chore(repo): Make the CICD scripts DRY


nikosdouvlis Oct 9, 2023
c70ffeb

chore(repo): Completely ignore stdio of all detached spawned processes


nikosdouvlis Oct 11, 2023
a7a384b

chore(repo): Introduce `applicationConfig.addDependency` to programma…


nikosdouvlis Oct 11, 2023
a7d8e7e

chore(repo): Set playwright concurrency to 50% on CI


nikosdouvlis Oct 11, 2023
3798036

chore(repo): Introduce nightly checks


nikosdouvlis Oct 11, 2023
226348b

chore(repo): Add verdaccio


nikosdouvlis Oct 11, 2023
76fad6a

chore(repo): Run quality checks first


nikosdouvlis Oct 12, 2023
c2a3c5d

chore(repo): Publish packages locally using Verdaccio


nikosdouvlis Oct 12, 2023
cacef87

chore(repo): Merge main


nikosdouvlis Oct 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


39 changes: 39 additions & 0 deletions
.github/workflows/base-build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
on:
 workflow_call:

jobs:
 build:
 # if: ${{ github.repository == 'clerkinc/javascript' }}
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Build
 run: npm run build
 - name: Upload package artifacts
 uses: actions/upload-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 retention-days: 1
 - name: Configure npm to use Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.publish.yaml &
 sleep 5
 ./node_modules/.bin/npm-cli-adduser -u user -p pass -e test@test.com -r http://localhost:4873/
 ./node_modules/.bin/npm-cli-login -u user -p pass -e test@test.com -r http://localhost:4873/
 - name: Publish to Verdaccio
 # The command below includes a sanity check
 # and fails early if the default npm registry is used
 run: |
 npm run release:verdaccio
 - name: List published packages
 run: |
 ls -all .verdaccio/storage/@clerk
 - uses: actions/upload-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio

15 changes: 15 additions & 0 deletions
.github/workflows/base-changeset.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
on:
 workflow_call:

jobs:
 check:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 with:
 ref: ${{github.event.pull_request.head.sha}}
 fetch-depth: 0
 - name: Setup
 uses: ./.github/actions/setup
 - run: npx changeset status --since=origin/main

62 changes: 62 additions & 0 deletions
.github/workflows/base-e2e.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
name: Integration reusable workflow
on:
 workflow_call:
 inputs:
 SCRIPT:
 required: true
 type: string
 secrets:
 INTEGRATION_INSTANCE_KEYS:
 required: true
 MAILSAC_API_KEY:
 required: true

jobs:
 run:
 continue-on-error: true
 timeout-minutes: 60
 runs-on: ${{ vars.RUNNER_LARGE }}
 concurrency:
 group: integration-${{ github.ref }}-${{ inputs.script }}
 cancel-in-progress: true
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Get installed Playwright version
 id: playwright-version
 run: echo "PLAYWRIGHT_VERSION=$(node -e "console.log($(npm ls @playwright/test --json).dependencies['@playwright/test'].version)")" >> $GITHUB_ENV
 - name: Cache playwright binaries
 uses: actions/cache@v3
 id: playwright-cache
 with:
 path: ~/.cache/ms-playwright
 key: ${{ runner.os }}-playwright-${{ env.PLAYWRIGHT_VERSION }}
 - name: Install Playwright Browsers
 if: steps.playwright-cache.outputs.cache-hit != 'true'
 run: npx playwright install --with-deps
 - name: Download Verdaccio artifacts
 uses: actions/download-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio
 - name: Run Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.install.yaml &
 sleep 5
 - name: Install @clerk/backend in /integration
 run: |
 cd integration && npm init -y && npm install @clerk/backend && cd ..
 - name: Run Playwright tests
 run: ${{ inputs.SCRIPT }}
 env:
 INTEGRATION_INSTANCE_KEYS: ${{ secrets.INTEGRATION_INSTANCE_KEYS }}
 MAILSAC_API_KEY: ${{ secrets.MAILSAC_API_KEY }}
 E2E_CLERK_VERSION: 'latest'
 - uses: actions/upload-artifact@v3
 if: always()
 with:
 name: playwright-report
 path: playwright-report/
 retention-days: 30

13 changes: 13 additions & 0 deletions
.github/workflows/base-lint.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
on:
 workflow_call:

jobs:
 check:
 continue-on-error: true
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - run: npm run lint

12 changes: 12 additions & 0 deletions
.github/workflows/base-prettier.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
on:
 workflow_call:

jobs:
 check:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - run: npm run format:check

34 changes: 34 additions & 0 deletions
.github/workflows/base-registry.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
on:
 workflow_call:

jobs:
 registry:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Configure npm to use Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.publish.yaml &
 sleep 5
 ./node_modules/.bin/npm-cli-adduser -u user -p pass -e test@test.com -r http://localhost:4873/
 ./node_modules/.bin/npm-cli-login -u user -p pass -e test@test.com -r http://localhost:4873/
 - name: Publish to Verdaccio
 # The command below includes a sanity check
 # and fails early if the default npm registry is used
 run: |
 npm run release:verdaccio
 - name: List published packages
 run: |
 ls -all .verdaccio/storage/@clerk
 - uses: actions/upload-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio

104 changes: 104 additions & 0 deletions
.github/workflows/checks.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
name: Quality checks and tests
on:
 pull_request:
 branches: [ main ]

concurrency:
 group: checks-${{ github.ref }}
 cancel-in-progress: true

jobs:
 prettier:
 name: Prettier
 uses: ./.github/workflows/base-prettier.yml

 eslint:
 name: Eslint
 uses: ./.github/workflows/base-lint.yml

 changeset:
 name: Require changeset
 uses: ./.github/workflows/base-changeset.yml

 build:
 if: ${{ github.repository == 'clerkinc/javascript' }}
 name: Build & publish
 needs: [ prettier, changeset ]
 uses: ./.github/workflows/base-build.yml

 unit-tests:
 name: Run unit tests
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 strategy:
 matrix:
 node-version: [ 18, 19 ]
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Run tests
 run: npm run test:ci

 publint:
 name: Run publint
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Lint packages using publint
 run: npm run lint:publint

 attw:
 name: Run attw
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Lint types using attw
 # Remove this when all related errors are fixed
 continue-on-error: true
 run: npm run lint:attw

 integration-generic:
 name: Integration (Generic)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:generic'
 secrets: inherit

 integration-nextjs:
 name: Integration (NextJS)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:nextjs'
 secrets: inherit

 integration-remix:
 name: Integration (Remix)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:remix'
 secrets: inherit

2 changes: 1 addition & 1 deletion
.github/workflows/labeler.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ jobs:
 permissions:
 contents: read
 pull-requests: write
 runs-on: ubuntu-latest
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/labeler@v4
 with:
Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/lock-threads.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ concurrency:

jobs:
 action:
 runs-on: ubuntu-latest
 runs-on: ${{ vars.RUNNER_NORMAL }}
 steps:
 - uses: actions/stale@v8
 with:
Expand Down

32 changes: 32 additions & 0 deletions
.github/workflows/nightly-checks.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
name: Nightly upstream tests
on:
 workflow_dispatch:
 schedule:
 - cron: '0 7 * * *'

jobs:
 build:
 name: Build packages and upload artifacts
 uses: ./.github/workflows/base-build.yml

 integration-nextjs:
 name: Integration (NextJS canary)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'E2E_NEXTJS_VERSION=canary npm run test:integration:nextjs'
 secrets: inherit

 notify-slack:
 name: Notify Slack
 needs: integration-nextjs
 if: ${{ contains(needs.*.result, 'failure') }}
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Report Status
 uses: ravsamhq/notify-slack-action@v1
 with:
 status: 'failure'
 notify_when: 'failure'
 env:
 SLACK_WEBHOOK_URL: ${{ secrets.SLACK_SDK_E2E_ALERTS_WEBHOOK_URL }}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Add integration tests to the CICD pipeline by nikosdouvlis · Pull Request #1854 · clerk/javascript · GitHub
Skip to content
Add integration tests to the CICD pipeline#1854

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 16 commits into

from

Oct 13, 2023
 Merged


Add integration tests to the CICD pipeline
#1854
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
90d08c6

chore(repo): Introduce `testAgainstRunningApps` helper


nikosdouvlis Oct 2, 2023
d66b956

chore(repo): Add integration testing readme


nikosdouvlis Oct 9, 2023
b03199b

chore(repo): Introduce publint


nikosdouvlis Oct 9, 2023
3fa1bf7

chore(repo): Introduce attw cli


nikosdouvlis Oct 9, 2023
0e5bf8a

chore(repo): Allow starting long-running app using patterns


nikosdouvlis Oct 9, 2023
20990d7

chore(repo): Revamp CICD caching strategies to improve performance


nikosdouvlis Oct 9, 2023
2919fae

chore(repo): Enable HTML report for integration tests on CI


nikosdouvlis Oct 9, 2023
1923d86

chore(repo): Make the CICD scripts DRY


nikosdouvlis Oct 9, 2023
c70ffeb

chore(repo): Completely ignore stdio of all detached spawned processes


nikosdouvlis Oct 11, 2023
a7a384b

chore(repo): Introduce `applicationConfig.addDependency` to programma…


nikosdouvlis Oct 11, 2023
a7d8e7e

chore(repo): Set playwright concurrency to 50% on CI


nikosdouvlis Oct 11, 2023
3798036

chore(repo): Introduce nightly checks


nikosdouvlis Oct 11, 2023
226348b

chore(repo): Add verdaccio


nikosdouvlis Oct 11, 2023
76fad6a

chore(repo): Run quality checks first


nikosdouvlis Oct 12, 2023
c2a3c5d

chore(repo): Publish packages locally using Verdaccio


nikosdouvlis Oct 12, 2023
cacef87

chore(repo): Merge main


nikosdouvlis Oct 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


39 changes: 39 additions & 0 deletions
.github/workflows/base-build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
on:
 workflow_call:

jobs:
 build:
 # if: ${{ github.repository == 'clerkinc/javascript' }}
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Build
 run: npm run build
 - name: Upload package artifacts
 uses: actions/upload-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 retention-days: 1
 - name: Configure npm to use Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.publish.yaml &
 sleep 5
 ./node_modules/.bin/npm-cli-adduser -u user -p pass -e test@test.com -r http://localhost:4873/
 ./node_modules/.bin/npm-cli-login -u user -p pass -e test@test.com -r http://localhost:4873/
 - name: Publish to Verdaccio
 # The command below includes a sanity check
 # and fails early if the default npm registry is used
 run: |
 npm run release:verdaccio
 - name: List published packages
 run: |
 ls -all .verdaccio/storage/@clerk
 - uses: actions/upload-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio

15 changes: 15 additions & 0 deletions
.github/workflows/base-changeset.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
on:
 workflow_call:

jobs:
 check:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 with:
 ref: ${{github.event.pull_request.head.sha}}
 fetch-depth: 0
 - name: Setup
 uses: ./.github/actions/setup
 - run: npx changeset status --since=origin/main

62 changes: 62 additions & 0 deletions
.github/workflows/base-e2e.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
name: Integration reusable workflow
on:
 workflow_call:
 inputs:
 SCRIPT:
 required: true
 type: string
 secrets:
 INTEGRATION_INSTANCE_KEYS:
 required: true
 MAILSAC_API_KEY:
 required: true

jobs:
 run:
 continue-on-error: true
 timeout-minutes: 60
 runs-on: ${{ vars.RUNNER_LARGE }}
 concurrency:
 group: integration-${{ github.ref }}-${{ inputs.script }}
 cancel-in-progress: true
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Get installed Playwright version
 id: playwright-version
 run: echo "PLAYWRIGHT_VERSION=$(node -e "console.log($(npm ls @playwright/test --json).dependencies['@playwright/test'].version)")" >> $GITHUB_ENV
 - name: Cache playwright binaries
 uses: actions/cache@v3
 id: playwright-cache
 with:
 path: ~/.cache/ms-playwright
 key: ${{ runner.os }}-playwright-${{ env.PLAYWRIGHT_VERSION }}
 - name: Install Playwright Browsers
 if: steps.playwright-cache.outputs.cache-hit != 'true'
 run: npx playwright install --with-deps
 - name: Download Verdaccio artifacts
 uses: actions/download-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio
 - name: Run Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.install.yaml &
 sleep 5
 - name: Install @clerk/backend in /integration
 run: |
 cd integration && npm init -y && npm install @clerk/backend && cd ..
 - name: Run Playwright tests
 run: ${{ inputs.SCRIPT }}
 env:
 INTEGRATION_INSTANCE_KEYS: ${{ secrets.INTEGRATION_INSTANCE_KEYS }}
 MAILSAC_API_KEY: ${{ secrets.MAILSAC_API_KEY }}
 E2E_CLERK_VERSION: 'latest'
 - uses: actions/upload-artifact@v3
 if: always()
 with:
 name: playwright-report
 path: playwright-report/
 retention-days: 30

13 changes: 13 additions & 0 deletions
.github/workflows/base-lint.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
on:
 workflow_call:

jobs:
 check:
 continue-on-error: true
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - run: npm run lint

12 changes: 12 additions & 0 deletions
.github/workflows/base-prettier.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
on:
 workflow_call:

jobs:
 check:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - run: npm run format:check

34 changes: 34 additions & 0 deletions
.github/workflows/base-registry.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
on:
 workflow_call:

jobs:
 registry:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Configure npm to use Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.publish.yaml &
 sleep 5
 ./node_modules/.bin/npm-cli-adduser -u user -p pass -e test@test.com -r http://localhost:4873/
 ./node_modules/.bin/npm-cli-login -u user -p pass -e test@test.com -r http://localhost:4873/
 - name: Publish to Verdaccio
 # The command below includes a sanity check
 # and fails early if the default npm registry is used
 run: |
 npm run release:verdaccio
 - name: List published packages
 run: |
 ls -all .verdaccio/storage/@clerk
 - uses: actions/upload-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio

104 changes: 104 additions & 0 deletions
.github/workflows/checks.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
name: Quality checks and tests
on:
 pull_request:
 branches: [ main ]

concurrency:
 group: checks-${{ github.ref }}
 cancel-in-progress: true

jobs:
 prettier:
 name: Prettier
 uses: ./.github/workflows/base-prettier.yml

 eslint:
 name: Eslint
 uses: ./.github/workflows/base-lint.yml

 changeset:
 name: Require changeset
 uses: ./.github/workflows/base-changeset.yml

 build:
 if: ${{ github.repository == 'clerkinc/javascript' }}
 name: Build & publish
 needs: [ prettier, changeset ]
 uses: ./.github/workflows/base-build.yml

 unit-tests:
 name: Run unit tests
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 strategy:
 matrix:
 node-version: [ 18, 19 ]
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Run tests
 run: npm run test:ci

 publint:
 name: Run publint
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Lint packages using publint
 run: npm run lint:publint

 attw:
 name: Run attw
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Lint types using attw
 # Remove this when all related errors are fixed
 continue-on-error: true
 run: npm run lint:attw

 integration-generic:
 name: Integration (Generic)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:generic'
 secrets: inherit

 integration-nextjs:
 name: Integration (NextJS)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:nextjs'
 secrets: inherit

 integration-remix:
 name: Integration (Remix)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:remix'
 secrets: inherit

2 changes: 1 addition & 1 deletion
.github/workflows/labeler.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ jobs:
 permissions:
 contents: read
 pull-requests: write
 runs-on: ubuntu-latest
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/labeler@v4
 with:
Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/lock-threads.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ concurrency:

jobs:
 action:
 runs-on: ubuntu-latest
 runs-on: ${{ vars.RUNNER_NORMAL }}
 steps:
 - uses: actions/stale@v8
 with:
Expand Down

32 changes: 32 additions & 0 deletions
.github/workflows/nightly-checks.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
name: Nightly upstream tests
on:
 workflow_dispatch:
 schedule:
 - cron: '0 7 * * *'

jobs:
 build:
 name: Build packages and upload artifacts
 uses: ./.github/workflows/base-build.yml

 integration-nextjs:
 name: Integration (NextJS canary)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'E2E_NEXTJS_VERSION=canary npm run test:integration:nextjs'
 secrets: inherit

 notify-slack:
 name: Notify Slack
 needs: integration-nextjs
 if: ${{ contains(needs.*.result, 'failure') }}
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Report Status
 uses: ravsamhq/notify-slack-action@v1
 with:
 status: 'failure'
 notify_when: 'failure'
 env:
 SLACK_WEBHOOK_URL: ${{ secrets.SLACK_SDK_E2E_ALERTS_WEBHOOK_URL }}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add integration tests to the CICD pipeline by nikosdouvlis · Pull Request #1854 · clerk/javascript · GitHub
Skip to content
Add integration tests to the CICD pipeline#1854

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 16 commits into

from

Oct 13, 2023
 Merged


Add integration tests to the CICD pipeline
#1854
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
90d08c6

chore(repo): Introduce `testAgainstRunningApps` helper


nikosdouvlis Oct 2, 2023
d66b956

chore(repo): Add integration testing readme


nikosdouvlis Oct 9, 2023
b03199b

chore(repo): Introduce publint


nikosdouvlis Oct 9, 2023
3fa1bf7

chore(repo): Introduce attw cli


nikosdouvlis Oct 9, 2023
0e5bf8a

chore(repo): Allow starting long-running app using patterns


nikosdouvlis Oct 9, 2023
20990d7

chore(repo): Revamp CICD caching strategies to improve performance


nikosdouvlis Oct 9, 2023
2919fae

chore(repo): Enable HTML report for integration tests on CI


nikosdouvlis Oct 9, 2023
1923d86

chore(repo): Make the CICD scripts DRY


nikosdouvlis Oct 9, 2023
c70ffeb

chore(repo): Completely ignore stdio of all detached spawned processes


nikosdouvlis Oct 11, 2023
a7a384b

chore(repo): Introduce `applicationConfig.addDependency` to programma…


nikosdouvlis Oct 11, 2023
a7d8e7e

chore(repo): Set playwright concurrency to 50% on CI


nikosdouvlis Oct 11, 2023
3798036

chore(repo): Introduce nightly checks


nikosdouvlis Oct 11, 2023
226348b

chore(repo): Add verdaccio


nikosdouvlis Oct 11, 2023
76fad6a

chore(repo): Run quality checks first


nikosdouvlis Oct 12, 2023
c2a3c5d

chore(repo): Publish packages locally using Verdaccio


nikosdouvlis Oct 12, 2023
cacef87

chore(repo): Merge main


nikosdouvlis Oct 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


39 changes: 39 additions & 0 deletions
.github/workflows/base-build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
on:
 workflow_call:

jobs:
 build:
 # if: ${{ github.repository == 'clerkinc/javascript' }}
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Build
 run: npm run build
 - name: Upload package artifacts
 uses: actions/upload-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 retention-days: 1
 - name: Configure npm to use Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.publish.yaml &
 sleep 5
 ./node_modules/.bin/npm-cli-adduser -u user -p pass -e test@test.com -r http://localhost:4873/
 ./node_modules/.bin/npm-cli-login -u user -p pass -e test@test.com -r http://localhost:4873/
 - name: Publish to Verdaccio
 # The command below includes a sanity check
 # and fails early if the default npm registry is used
 run: |
 npm run release:verdaccio
 - name: List published packages
 run: |
 ls -all .verdaccio/storage/@clerk
 - uses: actions/upload-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio

15 changes: 15 additions & 0 deletions
.github/workflows/base-changeset.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
on:
 workflow_call:

jobs:
 check:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 with:
 ref: ${{github.event.pull_request.head.sha}}
 fetch-depth: 0
 - name: Setup
 uses: ./.github/actions/setup
 - run: npx changeset status --since=origin/main

62 changes: 62 additions & 0 deletions
.github/workflows/base-e2e.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
name: Integration reusable workflow
on:
 workflow_call:
 inputs:
 SCRIPT:
 required: true
 type: string
 secrets:
 INTEGRATION_INSTANCE_KEYS:
 required: true
 MAILSAC_API_KEY:
 required: true

jobs:
 run:
 continue-on-error: true
 timeout-minutes: 60
 runs-on: ${{ vars.RUNNER_LARGE }}
 concurrency:
 group: integration-${{ github.ref }}-${{ inputs.script }}
 cancel-in-progress: true
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Get installed Playwright version
 id: playwright-version
 run: echo "PLAYWRIGHT_VERSION=$(node -e "console.log($(npm ls @playwright/test --json).dependencies['@playwright/test'].version)")" >> $GITHUB_ENV
 - name: Cache playwright binaries
 uses: actions/cache@v3
 id: playwright-cache
 with:
 path: ~/.cache/ms-playwright
 key: ${{ runner.os }}-playwright-${{ env.PLAYWRIGHT_VERSION }}
 - name: Install Playwright Browsers
 if: steps.playwright-cache.outputs.cache-hit != 'true'
 run: npx playwright install --with-deps
 - name: Download Verdaccio artifacts
 uses: actions/download-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio
 - name: Run Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.install.yaml &
 sleep 5
 - name: Install @clerk/backend in /integration
 run: |
 cd integration && npm init -y && npm install @clerk/backend && cd ..
 - name: Run Playwright tests
 run: ${{ inputs.SCRIPT }}
 env:
 INTEGRATION_INSTANCE_KEYS: ${{ secrets.INTEGRATION_INSTANCE_KEYS }}
 MAILSAC_API_KEY: ${{ secrets.MAILSAC_API_KEY }}
 E2E_CLERK_VERSION: 'latest'
 - uses: actions/upload-artifact@v3
 if: always()
 with:
 name: playwright-report
 path: playwright-report/
 retention-days: 30

13 changes: 13 additions & 0 deletions
.github/workflows/base-lint.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
on:
 workflow_call:

jobs:
 check:
 continue-on-error: true
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - run: npm run lint

12 changes: 12 additions & 0 deletions
.github/workflows/base-prettier.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
on:
 workflow_call:

jobs:
 check:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - run: npm run format:check

34 changes: 34 additions & 0 deletions
.github/workflows/base-registry.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
on:
 workflow_call:

jobs:
 registry:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Configure npm to use Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.publish.yaml &
 sleep 5
 ./node_modules/.bin/npm-cli-adduser -u user -p pass -e test@test.com -r http://localhost:4873/
 ./node_modules/.bin/npm-cli-login -u user -p pass -e test@test.com -r http://localhost:4873/
 - name: Publish to Verdaccio
 # The command below includes a sanity check
 # and fails early if the default npm registry is used
 run: |
 npm run release:verdaccio
 - name: List published packages
 run: |
 ls -all .verdaccio/storage/@clerk
 - uses: actions/upload-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio

104 changes: 104 additions & 0 deletions
.github/workflows/checks.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
name: Quality checks and tests
on:
 pull_request:
 branches: [ main ]

concurrency:
 group: checks-${{ github.ref }}
 cancel-in-progress: true

jobs:
 prettier:
 name: Prettier
 uses: ./.github/workflows/base-prettier.yml

 eslint:
 name: Eslint
 uses: ./.github/workflows/base-lint.yml

 changeset:
 name: Require changeset
 uses: ./.github/workflows/base-changeset.yml

 build:
 if: ${{ github.repository == 'clerkinc/javascript' }}
 name: Build & publish
 needs: [ prettier, changeset ]
 uses: ./.github/workflows/base-build.yml

 unit-tests:
 name: Run unit tests
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 strategy:
 matrix:
 node-version: [ 18, 19 ]
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Run tests
 run: npm run test:ci

 publint:
 name: Run publint
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Lint packages using publint
 run: npm run lint:publint

 attw:
 name: Run attw
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Lint types using attw
 # Remove this when all related errors are fixed
 continue-on-error: true
 run: npm run lint:attw

 integration-generic:
 name: Integration (Generic)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:generic'
 secrets: inherit

 integration-nextjs:
 name: Integration (NextJS)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:nextjs'
 secrets: inherit

 integration-remix:
 name: Integration (Remix)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:remix'
 secrets: inherit

2 changes: 1 addition & 1 deletion
.github/workflows/labeler.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ jobs:
 permissions:
 contents: read
 pull-requests: write
 runs-on: ubuntu-latest
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/labeler@v4
 with:
Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/lock-threads.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ concurrency:

jobs:
 action:
 runs-on: ubuntu-latest
 runs-on: ${{ vars.RUNNER_NORMAL }}
 steps:
 - uses: actions/stale@v8
 with:
Expand Down

32 changes: 32 additions & 0 deletions
.github/workflows/nightly-checks.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
name: Nightly upstream tests
on:
 workflow_dispatch:
 schedule:
 - cron: '0 7 * * *'

jobs:
 build:
 name: Build packages and upload artifacts
 uses: ./.github/workflows/base-build.yml

 integration-nextjs:
 name: Integration (NextJS canary)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'E2E_NEXTJS_VERSION=canary npm run test:integration:nextjs'
 secrets: inherit

 notify-slack:
 name: Notify Slack
 needs: integration-nextjs
 if: ${{ contains(needs.*.result, 'failure') }}
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Report Status
 uses: ravsamhq/notify-slack-action@v1
 with:
 status: 'failure'
 notify_when: 'failure'
 env:
 SLACK_WEBHOOK_URL: ${{ secrets.SLACK_SDK_E2E_ALERTS_WEBHOOK_URL }}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Add integration tests to the CICD pipeline by nikosdouvlis · Pull Request #1854 · clerk/javascript · GitHub
Skip to content
Add integration tests to the CICD pipeline#1854

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 16 commits into

from

Oct 13, 2023
 Merged


Add integration tests to the CICD pipeline
#1854
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
90d08c6

chore(repo): Introduce `testAgainstRunningApps` helper


nikosdouvlis Oct 2, 2023
d66b956

chore(repo): Add integration testing readme


nikosdouvlis Oct 9, 2023
b03199b

chore(repo): Introduce publint


nikosdouvlis Oct 9, 2023
3fa1bf7

chore(repo): Introduce attw cli


nikosdouvlis Oct 9, 2023
0e5bf8a

chore(repo): Allow starting long-running app using patterns


nikosdouvlis Oct 9, 2023
20990d7

chore(repo): Revamp CICD caching strategies to improve performance


nikosdouvlis Oct 9, 2023
2919fae

chore(repo): Enable HTML report for integration tests on CI


nikosdouvlis Oct 9, 2023
1923d86

chore(repo): Make the CICD scripts DRY


nikosdouvlis Oct 9, 2023
c70ffeb

chore(repo): Completely ignore stdio of all detached spawned processes


nikosdouvlis Oct 11, 2023
a7a384b

chore(repo): Introduce `applicationConfig.addDependency` to programma…


nikosdouvlis Oct 11, 2023
a7d8e7e

chore(repo): Set playwright concurrency to 50% on CI


nikosdouvlis Oct 11, 2023
3798036

chore(repo): Introduce nightly checks


nikosdouvlis Oct 11, 2023
226348b

chore(repo): Add verdaccio


nikosdouvlis Oct 11, 2023
76fad6a

chore(repo): Run quality checks first


nikosdouvlis Oct 12, 2023
c2a3c5d

chore(repo): Publish packages locally using Verdaccio


nikosdouvlis Oct 12, 2023
cacef87

chore(repo): Merge main


nikosdouvlis Oct 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


39 changes: 39 additions & 0 deletions
.github/workflows/base-build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
on:
 workflow_call:

jobs:
 build:
 # if: ${{ github.repository == 'clerkinc/javascript' }}
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Build
 run: npm run build
 - name: Upload package artifacts
 uses: actions/upload-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 retention-days: 1
 - name: Configure npm to use Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.publish.yaml &
 sleep 5
 ./node_modules/.bin/npm-cli-adduser -u user -p pass -e test@test.com -r http://localhost:4873/
 ./node_modules/.bin/npm-cli-login -u user -p pass -e test@test.com -r http://localhost:4873/
 - name: Publish to Verdaccio
 # The command below includes a sanity check
 # and fails early if the default npm registry is used
 run: |
 npm run release:verdaccio
 - name: List published packages
 run: |
 ls -all .verdaccio/storage/@clerk
 - uses: actions/upload-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio

15 changes: 15 additions & 0 deletions
.github/workflows/base-changeset.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
on:
 workflow_call:

jobs:
 check:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 with:
 ref: ${{github.event.pull_request.head.sha}}
 fetch-depth: 0
 - name: Setup
 uses: ./.github/actions/setup
 - run: npx changeset status --since=origin/main

62 changes: 62 additions & 0 deletions
.github/workflows/base-e2e.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
name: Integration reusable workflow
on:
 workflow_call:
 inputs:
 SCRIPT:
 required: true
 type: string
 secrets:
 INTEGRATION_INSTANCE_KEYS:
 required: true
 MAILSAC_API_KEY:
 required: true

jobs:
 run:
 continue-on-error: true
 timeout-minutes: 60
 runs-on: ${{ vars.RUNNER_LARGE }}
 concurrency:
 group: integration-${{ github.ref }}-${{ inputs.script }}
 cancel-in-progress: true
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Get installed Playwright version
 id: playwright-version
 run: echo "PLAYWRIGHT_VERSION=$(node -e "console.log($(npm ls @playwright/test --json).dependencies['@playwright/test'].version)")" >> $GITHUB_ENV
 - name: Cache playwright binaries
 uses: actions/cache@v3
 id: playwright-cache
 with:
 path: ~/.cache/ms-playwright
 key: ${{ runner.os }}-playwright-${{ env.PLAYWRIGHT_VERSION }}
 - name: Install Playwright Browsers
 if: steps.playwright-cache.outputs.cache-hit != 'true'
 run: npx playwright install --with-deps
 - name: Download Verdaccio artifacts
 uses: actions/download-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio
 - name: Run Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.install.yaml &
 sleep 5
 - name: Install @clerk/backend in /integration
 run: |
 cd integration && npm init -y && npm install @clerk/backend && cd ..
 - name: Run Playwright tests
 run: ${{ inputs.SCRIPT }}
 env:
 INTEGRATION_INSTANCE_KEYS: ${{ secrets.INTEGRATION_INSTANCE_KEYS }}
 MAILSAC_API_KEY: ${{ secrets.MAILSAC_API_KEY }}
 E2E_CLERK_VERSION: 'latest'
 - uses: actions/upload-artifact@v3
 if: always()
 with:
 name: playwright-report
 path: playwright-report/
 retention-days: 30

13 changes: 13 additions & 0 deletions
.github/workflows/base-lint.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
on:
 workflow_call:

jobs:
 check:
 continue-on-error: true
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - run: npm run lint

12 changes: 12 additions & 0 deletions
.github/workflows/base-prettier.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
on:
 workflow_call:

jobs:
 check:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - run: npm run format:check

34 changes: 34 additions & 0 deletions
.github/workflows/base-registry.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
on:
 workflow_call:

jobs:
 registry:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Configure npm to use Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.publish.yaml &
 sleep 5
 ./node_modules/.bin/npm-cli-adduser -u user -p pass -e test@test.com -r http://localhost:4873/
 ./node_modules/.bin/npm-cli-login -u user -p pass -e test@test.com -r http://localhost:4873/
 - name: Publish to Verdaccio
 # The command below includes a sanity check
 # and fails early if the default npm registry is used
 run: |
 npm run release:verdaccio
 - name: List published packages
 run: |
 ls -all .verdaccio/storage/@clerk
 - uses: actions/upload-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio

104 changes: 104 additions & 0 deletions
.github/workflows/checks.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
name: Quality checks and tests
on:
 pull_request:
 branches: [ main ]

concurrency:
 group: checks-${{ github.ref }}
 cancel-in-progress: true

jobs:
 prettier:
 name: Prettier
 uses: ./.github/workflows/base-prettier.yml

 eslint:
 name: Eslint
 uses: ./.github/workflows/base-lint.yml

 changeset:
 name: Require changeset
 uses: ./.github/workflows/base-changeset.yml

 build:
 if: ${{ github.repository == 'clerkinc/javascript' }}
 name: Build & publish
 needs: [ prettier, changeset ]
 uses: ./.github/workflows/base-build.yml

 unit-tests:
 name: Run unit tests
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 strategy:
 matrix:
 node-version: [ 18, 19 ]
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Run tests
 run: npm run test:ci

 publint:
 name: Run publint
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Lint packages using publint
 run: npm run lint:publint

 attw:
 name: Run attw
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Lint types using attw
 # Remove this when all related errors are fixed
 continue-on-error: true
 run: npm run lint:attw

 integration-generic:
 name: Integration (Generic)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:generic'
 secrets: inherit

 integration-nextjs:
 name: Integration (NextJS)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:nextjs'
 secrets: inherit

 integration-remix:
 name: Integration (Remix)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:remix'
 secrets: inherit

2 changes: 1 addition & 1 deletion
.github/workflows/labeler.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ jobs:
 permissions:
 contents: read
 pull-requests: write
 runs-on: ubuntu-latest
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/labeler@v4
 with:
Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/lock-threads.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ concurrency:

jobs:
 action:
 runs-on: ubuntu-latest
 runs-on: ${{ vars.RUNNER_NORMAL }}
 steps:
 - uses: actions/stale@v8
 with:
Expand Down

32 changes: 32 additions & 0 deletions
.github/workflows/nightly-checks.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
name: Nightly upstream tests
on:
 workflow_dispatch:
 schedule:
 - cron: '0 7 * * *'

jobs:
 build:
 name: Build packages and upload artifacts
 uses: ./.github/workflows/base-build.yml

 integration-nextjs:
 name: Integration (NextJS canary)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'E2E_NEXTJS_VERSION=canary npm run test:integration:nextjs'
 secrets: inherit

 notify-slack:
 name: Notify Slack
 needs: integration-nextjs
 if: ${{ contains(needs.*.result, 'failure') }}
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Report Status
 uses: ravsamhq/notify-slack-action@v1
 with:
 status: 'failure'
 notify_when: 'failure'
 env:
 SLACK_WEBHOOK_URL: ${{ secrets.SLACK_SDK_E2E_ALERTS_WEBHOOK_URL }}
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
Add integration tests to the CICD pipeline by nikosdouvlis · Pull Request #1854 · clerk/javascript · GitHub
Skip to content
Add integration tests to the CICD pipeline#1854

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

nikosdouvlis
merged 16 commits into

from

Oct 13, 2023
 Merged


Add integration tests to the CICD pipeline
#1854
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
90d08c6

chore(repo): Introduce `testAgainstRunningApps` helper


nikosdouvlis Oct 2, 2023
d66b956

chore(repo): Add integration testing readme


nikosdouvlis Oct 9, 2023
b03199b

chore(repo): Introduce publint


nikosdouvlis Oct 9, 2023
3fa1bf7

chore(repo): Introduce attw cli


nikosdouvlis Oct 9, 2023
0e5bf8a

chore(repo): Allow starting long-running app using patterns


nikosdouvlis Oct 9, 2023
20990d7

chore(repo): Revamp CICD caching strategies to improve performance


nikosdouvlis Oct 9, 2023
2919fae

chore(repo): Enable HTML report for integration tests on CI


nikosdouvlis Oct 9, 2023
1923d86

chore(repo): Make the CICD scripts DRY


nikosdouvlis Oct 9, 2023
c70ffeb

chore(repo): Completely ignore stdio of all detached spawned processes


nikosdouvlis Oct 11, 2023
a7a384b

chore(repo): Introduce `applicationConfig.addDependency` to programma…


nikosdouvlis Oct 11, 2023
a7d8e7e

chore(repo): Set playwright concurrency to 50% on CI


nikosdouvlis Oct 11, 2023
3798036

chore(repo): Introduce nightly checks


nikosdouvlis Oct 11, 2023
226348b

chore(repo): Add verdaccio


nikosdouvlis Oct 11, 2023
76fad6a

chore(repo): Run quality checks first


nikosdouvlis Oct 12, 2023
c2a3c5d

chore(repo): Publish packages locally using Verdaccio


nikosdouvlis Oct 12, 2023
cacef87

chore(repo): Merge main


nikosdouvlis Oct 13, 2023

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


39 changes: 39 additions & 0 deletions
.github/workflows/base-build.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
on:
 workflow_call:

jobs:
 build:
 # if: ${{ github.repository == 'clerkinc/javascript' }}
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Build
 run: npm run build
 - name: Upload package artifacts
 uses: actions/upload-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 retention-days: 1
 - name: Configure npm to use Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.publish.yaml &
 sleep 5
 ./node_modules/.bin/npm-cli-adduser -u user -p pass -e test@test.com -r http://localhost:4873/
 ./node_modules/.bin/npm-cli-login -u user -p pass -e test@test.com -r http://localhost:4873/
 - name: Publish to Verdaccio
 # The command below includes a sanity check
 # and fails early if the default npm registry is used
 run: |
 npm run release:verdaccio
 - name: List published packages
 run: |
 ls -all .verdaccio/storage/@clerk
 - uses: actions/upload-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio

15 changes: 15 additions & 0 deletions
.github/workflows/base-changeset.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
on:
 workflow_call:

jobs:
 check:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 with:
 ref: ${{github.event.pull_request.head.sha}}
 fetch-depth: 0
 - name: Setup
 uses: ./.github/actions/setup
 - run: npx changeset status --since=origin/main

62 changes: 62 additions & 0 deletions
.github/workflows/base-e2e.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
name: Integration reusable workflow
on:
 workflow_call:
 inputs:
 SCRIPT:
 required: true
 type: string
 secrets:
 INTEGRATION_INSTANCE_KEYS:
 required: true
 MAILSAC_API_KEY:
 required: true

jobs:
 run:
 continue-on-error: true
 timeout-minutes: 60
 runs-on: ${{ vars.RUNNER_LARGE }}
 concurrency:
 group: integration-${{ github.ref }}-${{ inputs.script }}
 cancel-in-progress: true
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Get installed Playwright version
 id: playwright-version
 run: echo "PLAYWRIGHT_VERSION=$(node -e "console.log($(npm ls @playwright/test --json).dependencies['@playwright/test'].version)")" >> $GITHUB_ENV
 - name: Cache playwright binaries
 uses: actions/cache@v3
 id: playwright-cache
 with:
 path: ~/.cache/ms-playwright
 key: ${{ runner.os }}-playwright-${{ env.PLAYWRIGHT_VERSION }}
 - name: Install Playwright Browsers
 if: steps.playwright-cache.outputs.cache-hit != 'true'
 run: npx playwright install --with-deps
 - name: Download Verdaccio artifacts
 uses: actions/download-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio
 - name: Run Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.install.yaml &
 sleep 5
 - name: Install @clerk/backend in /integration
 run: |
 cd integration && npm init -y && npm install @clerk/backend && cd ..
 - name: Run Playwright tests
 run: ${{ inputs.SCRIPT }}
 env:
 INTEGRATION_INSTANCE_KEYS: ${{ secrets.INTEGRATION_INSTANCE_KEYS }}
 MAILSAC_API_KEY: ${{ secrets.MAILSAC_API_KEY }}
 E2E_CLERK_VERSION: 'latest'
 - uses: actions/upload-artifact@v3
 if: always()
 with:
 name: playwright-report
 path: playwright-report/
 retention-days: 30

13 changes: 13 additions & 0 deletions
.github/workflows/base-lint.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
on:
 workflow_call:

jobs:
 check:
 continue-on-error: true
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - run: npm run lint

12 changes: 12 additions & 0 deletions
.github/workflows/base-prettier.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
on:
 workflow_call:

jobs:
 check:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Checkout repo
 uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - run: npm run format:check

34 changes: 34 additions & 0 deletions
.github/workflows/base-registry.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
on:
 workflow_call:

jobs:
 registry:
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Configure npm to use Verdaccio
 run: |
 npm set registry http://localhost:4873/
 nohup ./node_modules/.bin/verdaccio --config ./verdaccio.publish.yaml &
 sleep 5
 ./node_modules/.bin/npm-cli-adduser -u user -p pass -e test@test.com -r http://localhost:4873/
 ./node_modules/.bin/npm-cli-login -u user -p pass -e test@test.com -r http://localhost:4873/
 - name: Publish to Verdaccio
 # The command below includes a sanity check
 # and fails early if the default npm registry is used
 run: |
 npm run release:verdaccio
 - name: List published packages
 run: |
 ls -all .verdaccio/storage/@clerk
 - uses: actions/upload-artifact@v3
 with:
 name: verdaccio
 path: .verdaccio

104 changes: 104 additions & 0 deletions
.github/workflows/checks.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
name: Quality checks and tests
on:
 pull_request:
 branches: [ main ]

concurrency:
 group: checks-${{ github.ref }}
 cancel-in-progress: true

jobs:
 prettier:
 name: Prettier
 uses: ./.github/workflows/base-prettier.yml

 eslint:
 name: Eslint
 uses: ./.github/workflows/base-lint.yml

 changeset:
 name: Require changeset
 uses: ./.github/workflows/base-changeset.yml

 build:
 if: ${{ github.repository == 'clerkinc/javascript' }}
 name: Build & publish
 needs: [ prettier, changeset ]
 uses: ./.github/workflows/base-build.yml

 unit-tests:
 name: Run unit tests
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 strategy:
 matrix:
 node-version: [ 18, 19 ]
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Run tests
 run: npm run test:ci

 publint:
 name: Run publint
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Lint packages using publint
 run: npm run lint:publint

 attw:
 name: Run attw
 needs: build
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/checkout@v3
 - name: Setup
 uses: ./.github/actions/setup
 - name: Download turbo cache
 uses: actions/download-artifact@v3
 with:
 name: package-artifacts
 path: ./node_modules/.cache/turbo
 - name: Lint types using attw
 # Remove this when all related errors are fixed
 continue-on-error: true
 run: npm run lint:attw

 integration-generic:
 name: Integration (Generic)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:generic'
 secrets: inherit

 integration-nextjs:
 name: Integration (NextJS)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:nextjs'
 secrets: inherit

 integration-remix:
 name: Integration (Remix)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'npm run test:integration:remix'
 secrets: inherit

2 changes: 1 addition & 1 deletion
.github/workflows/labeler.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,7 @@ jobs:
 permissions:
 contents: read
 pull-requests: write
 runs-on: ubuntu-latest
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - uses: actions/labeler@v4
 with:
Expand Down

2 changes: 1 addition & 1 deletion
.github/workflows/lock-threads.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,7 @@ concurrency:

jobs:
 action:
 runs-on: ubuntu-latest
 runs-on: ${{ vars.RUNNER_NORMAL }}
 steps:
 - uses: actions/stale@v8
 with:
Expand Down

32 changes: 32 additions & 0 deletions
.github/workflows/nightly-checks.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
name: Nightly upstream tests
on:
 workflow_dispatch:
 schedule:
 - cron: '0 7 * * *'

jobs:
 build:
 name: Build packages and upload artifacts
 uses: ./.github/workflows/base-build.yml

 integration-nextjs:
 name: Integration (NextJS canary)
 needs: build
 uses: ./.github/workflows/base-e2e.yml
 with:
 SCRIPT: 'E2E_NEXTJS_VERSION=canary npm run test:integration:nextjs'
 secrets: inherit

 notify-slack:
 name: Notify Slack
 needs: integration-nextjs
 if: ${{ contains(needs.*.result, 'failure') }}
 runs-on: ${{ vars.RUNNER_LARGE }}
 steps:
 - name: Report Status
 uses: ravsamhq/notify-slack-action@v1
 with:
 status: 'failure'
 notify_when: 'failure'
 env:
 SLACK_WEBHOOK_URL: ${{ secrets.SLACK_SDK_E2E_ALERTS_WEBHOOK_URL }}
Loading