Skip to content
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.

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

test: refactor tests to introduce helper to determine port #5137

Merged
merged 4 commits into from
Mar 26, 2024

Conversation

thisislawatts
Copy link
Member

@thisislawatts thisislawatts commented Mar 26, 2024

Pull Request Submission

Please check the boxes once done.

The pull request must:

  • Reviewer Documentation
    • follow CONTRIBUTING rules
    • be accompanied by a detailed description of the changes
    • contain a risk assessment of the change (Low | Medium | High) with regards to breaking existing functionality. A change e.g. of an underlying language plugin can completely break the functionality for that language, but appearing as only a version change in the dependencies.
    • highlight breaking API if applicable
    • contain a link to the automatic tests that cover the updated functionality.
    • contain testing instructions in case that the reviewer wants to manual verify as well, to add to the manual testing done by the author.
    • link to the link to the PR for the User-facing documentation
  • User facing Documentation
    • update any relevant documentation in gitbook by submitting a gitbook PR, and including the PR link here
    • ensure that the message of the final single commit is descriptive and prefixed with either feat: or fix: , others might be used in rare occasions as well, if there is no need to document the changes in the release notes. The changes or fixes should be described in detail in the commit message for the changelog & release notes.
  • Testing
    • Changes, removals and additions to functionality must be covered by acceptance / integration tests or smoke tests - either already existing ones, or new ones, created by the author of the PR.

Pull Request Review

All pull requests must undergo a thorough review process before being merged.
The review process of the code PR should include code review, testing, and any necessary feedback or revisions.
Pull request reviews of functionality developed in other teams only review the given documentation and test reports.

Manual testing will not be performed by the reviewing team, and is the responsibility of the author of the PR.

For Node projects: It’s important to make sure changes in package.json are also affecting package-lock.json correctly.

If a dependency is not necessary, don’t add it.

When adding a new package as a dependency, make sure that the change is absolutely necessary. We would like to refrain from adding new dependencies when possible.
Documentation PRs in gitbook are reviewed by Snyk's content team. They will also advise on the best phrasing and structuring if needed.

Pull Request Approval

Once a pull request has been reviewed and all necessary revisions have been made, it is approved for merging into
the main codebase. The merging of the code PR is performed by the code owners, the merging of the documentation PR
by our content writers.

What does this PR do?

We need to know about the port ahead of time so that we can
use it in our configuration. This supports iterating on fixed
ports to random ports so we can support running in parallel and
ensure no collision between our tests.
@thisislawatts

Where should the reviewer start?

Verify that our tests are passing in CI

How should this be manually tested?

Run the tests locally

Copy link
Contributor

github-actions bot commented Mar 26, 2024

Warnings
⚠️

Since the CLI is unifying on a standard and improved tooling, we're starting to migrate old-style imports and exports to ES6 ones.
A file you've modified is using either module.exports or require(). If you can, please update them to ES6 import syntax and export syntax.
Files found:

  • test/tap/auth.test.ts
  • test/tap/cli.test.ts

Generated by 🚫 dangerJS against 3699e1a

@@ -49,6 +49,8 @@ const createProject = async (

/**
* Workaround until we move all fixtures to ./test/fixtures
*
* @deprecated Use createProject instead.
Copy link
Member Author

Choose a reason for hiding this comment

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

docs: Drive by tidy up as I was in the area 🧹 I hadn't realised there was an inflight migration to move things into test/fixture. Adding this little nudge for contributors whose IDE uses these hints.

@thisislawatts thisislawatts marked this pull request as ready for review March 26, 2024 19:10
@thisislawatts thisislawatts requested a review from a team as a code owner March 26, 2024 19:10
We need to know about the port ahead of time so that we can
use it in our configuration. This supports iterating on fixed
ports to random ports so we can support running in parallel and
ensure no collision between our tests.
Copy link
Contributor

@cmars cmars left a comment

Choose a reason for hiding this comment

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

LGTM

@thisislawatts thisislawatts merged commit 3607eb3 into main Mar 26, 2024
11 checks passed
@thisislawatts thisislawatts deleted the test/refactor-tests branch March 26, 2024 19:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants