dockstore / dockstore

Our VM/Docker sharing infrastructure and management component
https://dockstore.org/
Apache License 2.0
116 stars 27 forks source link

Fix bug in skipTests #5863

Closed ll5zh closed 2 months ago

ll5zh commented 2 months ago

Description [skipTests] has a bug regarding double quotes in commit messages, discovered in this run: https://app.circleci.com/pipelines/github/dockstore/dockstore/11103/workflows/32fc7c3e-7ef6-4349-86a1-57993fec2401/jobs/42460. It looks like the command fails to process the " characters literally, causing syntax errors when exporting COMMIT_MESSAGE.

Adding a command that substitutes instances of " with \" seems to resolve the issue, by escaping all double quotes (see https://app.circleci.com/pipelines/github/dockstore/dockstore/11107/workflows/76244033-1d18-4bb7-b748-6e76cdfb6fff/jobs/42481). On this branch, I also tried commit messages containing different special characters, to check that they can be properly exported as COMMIT_MESSAGE.

Review Instructions From config.yml and the test commits, verify that commit messages containing double quotes (and other common, non-alphanumeric characters) are exported correctly (i.e. COMMIT_MESSAGE should be outputted properly).

Are there any other special characters that might be found in commit messages, which haven't been attempted and might cause similar issues to the double quote?

Issue SEAB-5015 (https://oicr.slack.com/archives/C05EZH3RVNY/p1712251398680789)

Security and Privacy

If there are any concerns that require extra attention from the security team, highlight them here and check the box when complete.

e.g. Does this change...

Please make sure that you've checked the following before submitting your pull request. Thanks!

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 74.52%. Comparing base (c3fd1cb) to head (32e3903). Report is 2 commits behind head on develop.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## develop #5863 +/- ## ============================================== + Coverage 61.78% 74.52% +12.74% - Complexity 4277 5274 +997 ============================================== Files 369 369 Lines 19056 19056 Branches 2025 2025 ============================================== + Hits 11774 14202 +2428 + Misses 6300 3893 -2407 + Partials 982 961 -21 ``` | [Flag](https://app.codecov.io/gh/dockstore/dockstore/pull/5863/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dockstore) | Coverage Δ | | |---|---|---| | [bitbuckettests](https://app.codecov.io/gh/dockstore/dockstore/pull/5863/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dockstore) | `27.06% <ø> (ø)` | | | [integrationtests](https://app.codecov.io/gh/dockstore/dockstore/pull/5863/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dockstore) | `58.55% <ø> (+23.67%)` | :arrow_up: | | [languageparsingtests](https://app.codecov.io/gh/dockstore/dockstore/pull/5863/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dockstore) | `11.00% <ø> (?)` | | | [localstacktests](https://app.codecov.io/gh/dockstore/dockstore/pull/5863/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dockstore) | `21.57% <ø> (?)` | | | [toolintegrationtests](https://app.codecov.io/gh/dockstore/dockstore/pull/5863/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dockstore) | `30.41% <ø> (ø)` | | | [unit-tests_and_non-confidential-tests](https://app.codecov.io/gh/dockstore/dockstore/pull/5863/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dockstore) | `28.89% <ø> (ø)` | | | [workflowintegrationtests](https://app.codecov.io/gh/dockstore/dockstore/pull/5863/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dockstore) | `38.64% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dockstore#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

sonarcloud[bot] commented 2 months ago

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud