Skip to content

feat(ci): Add junit reporters to jest/vitest, codecov test results #15341

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
merged 6 commits into from
Feb 10, 2025
Merged

feat(ci): Add junit reporters to jest/vitest, codecov test results #15341

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
a375268
feat(ci): Add junit reporters to jest/vitest, codecov test results
billyvg Feb 7, 2025
3c54638
try glob
billyvg Feb 7, 2025
455666a
tweaks
billyvg Feb 7, 2025
5cc7979
Update jest/jest.config.js
billyvg Feb 7, 2025
8095394
classnameTemplate for vitest
billyvg Feb 7, 2025
0765013
formatting
billyvg Feb 7, 2025
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
32 changes: 32 additions & 0 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -381,6 +381,14 @@ jobs:
with:
token: ${{ secrets.CODECOV_TOKEN }}

- name: Upload test results to Codecov
if: cancelled() == false
continue-on-error: true
uses: codecov/test-results-action@v1
with:
files: packages/**/*.junit.xml
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/getsentry/sentry-javascript/actions/runs/13207000168/job/36874091470?pr=15341#step:9:70

token: ${{ secrets.CODECOV_TOKEN }}

job_bun_unit_tests:
name: Bun Unit Tests
needs: [job_get_metadata, job_build]
Expand Down Expand Up @@ -484,6 +492,14 @@ jobs:
with:
token: ${{ secrets.CODECOV_TOKEN }}

- name: Upload test results to Codecov
if: cancelled() == false
continue-on-error: true
uses: codecov/test-results-action@v1
with:
files: packages/**/*.junit.xml
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/getsentry/sentry-javascript/actions/runs/13207000168/job/36874097050?pr=15341#step:9:70

token: ${{ secrets.CODECOV_TOKEN }}

job_browser_playwright_tests:
name: Playwright ${{ matrix.bundle }}${{ matrix.project && matrix.project != 'chromium' && format(' {0}', matrix.project) || ''}}${{ matrix.shard && format(' ({0}/{1})', matrix.shard, matrix.shards) || ''}} Tests
needs: [job_get_metadata, job_build]
Expand Down Expand Up @@ -701,6 +717,14 @@ jobs:
working-directory: dev-packages/node-integration-tests
run: yarn test

- name: Upload test results to Codecov
if: cancelled() == false
continue-on-error: true
uses: codecov/test-results-action@v1
with:
directory: dev-packages/node-integration-tests
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like its working

token: ${{ secrets.CODECOV_TOKEN }}

job_remix_integration_tests:
name: Remix (Node ${{ matrix.node }}) Tests
needs: [job_get_metadata, job_build]
Expand Down Expand Up @@ -737,6 +761,14 @@ jobs:
cd packages/remix
yarn test:integration:ci

- name: Upload test results to Codecov
if: cancelled() == false
continue-on-error: true
uses: codecov/test-results-action@v1
with:
directory: packages/remix
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks like it's working

token: ${{ secrets.CODECOV_TOKEN }}

job_e2e_prepare:
name: Prepare E2E tests
# We want to run this if:
Expand Down
9 changes: 9 additions & 0 deletions jest/jest.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,15 @@ module.exports = {
...(process.env.CI
? {
coverageReporters: ['json', 'lcov', 'clover'],
reporters: [
'default',
[
'jest-junit',
{
outputName: 'jest.junit.xml',
},
],
],
}
: {}),
};
1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@
"eslint": "7.32.0",
"jest": "^27.5.1",
"jest-environment-node": "^27.5.1",
"jest-junit": "^16.0.0",
"jsdom": "^21.1.2",
"lerna": "7.1.1",
"madge": "7.0.0",
Expand Down
1 change: 0 additions & 1 deletion packages/angular/vitest.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ export default defineConfig({
coverage: {},
globals: true,
setupFiles: ['./setup-test.ts'],
reporters: ['default'],
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The 'default' reporter was removed from some vitest configurations, but it might be beneficial to leave this for local development. If you're aiming to use Junit reporter on CI and default reporter locally, you might want to consider a conditionally loaded configuration based on the environment (development vs CI).

environment: 'jsdom',
},
});
1 change: 0 additions & 1 deletion packages/replay-internal/vitest.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,5 @@ export default defineConfig({
test: {
...baseConfig.test,
setupFiles: ['./test.setup.ts'],
reporters: ['default'],
},
});
4 changes: 4 additions & 0 deletions vite/vite.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@ export default defineConfig({
enabled: true,
reportsDirectory: './coverage',
},
reporters: ['default', ...(process.env.CI ? ['junit'] : [])],
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The test results filename should probably include the names of the individual test suites to prevent them from overwriting each other. Consider dynamically generating the output filename based on the test suite name.

outputFile: {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Double check the jest configurations and make sure that outputFile is a valid configuration option, as it's not recognized in the base jest configuration.

junit: 'vitest.junit.xml',
},
typecheck: {
tsconfig: './tsconfig.test.json',
},
Expand Down
15 changes: 15 additions & 0 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19066,6 +19066,16 @@ jest-jasmine2@^27.5.1:
pretty-format "^27.5.1"
throat "^6.0.1"

jest-junit@^16.0.0:
version "16.0.0"
resolved "https://registry.yarnpkg.com/jest-junit/-/jest-junit-16.0.0.tgz#d838e8c561cf9fdd7eb54f63020777eee4136785"
integrity sha512-A94mmw6NfJab4Fg/BlvVOUXzXgF0XIH6EmTgJ5NDPp4xoKq0Kr7sErb+4Xs9nZvu58pJojz5RFGpqnZYJTrRfQ==
dependencies:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The addition of the jest-junit package has introduced several new dependencies. Make sure these new dependancies do not cause conflicts with existing code or other packages.

mkdirp "^1.0.4"
strip-ansi "^6.0.1"
uuid "^8.3.2"
xml "^1.0.1"

jest-leak-detector@^27.5.1:
version "27.5.1"
resolved "https://registry.yarnpkg.com/jest-leak-detector/-/jest-leak-detector-27.5.1.tgz#6ec9d54c3579dd6e3e66d70e3498adf80fde3fb8"
Expand Down Expand Up @@ -30490,6 +30500,11 @@ xml-name-validator@^4.0.0:
resolved "https://registry.yarnpkg.com/xml-name-validator/-/xml-name-validator-4.0.0.tgz#79a006e2e63149a8600f15430f0a4725d1524835"
integrity sha512-ICP2e+jsHvAj2E2lIHxa5tjXRlKDJo4IdvPvCXbXQGdzSfmSpNVyIKMvoZHjDY9DP0zV17iI85o90vRFXNccRw==

xml@^1.0.1:
version "1.0.1"
resolved "https://registry.yarnpkg.com/xml/-/xml-1.0.1.tgz#78ba72020029c5bc87b8a81a3cfcd74b4a2fc1e5"
integrity sha512-huCv9IH9Tcf95zuYCsQraZtWnJvBtLVE0QHMOs8bWyZAFZNDcYjsPq1nEx8jKA9y+Beo9v+7OBPRisQTjinQMw==

xmlchars@^2.2.0:
version "2.2.0"
resolved "https://registry.yarnpkg.com/xmlchars/-/xmlchars-2.2.0.tgz#060fe1bcb7f9c76fe2a17db86a9bc3ab894210cb"
Expand Down
Loading