test: migrate code tests to acceptance

[thisislawatts]

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?

Lifts the unit tests for snyk code test up to be closed box acceptance test, this allows us to perform higher level validation against the stdout, stderr and exit code without our tests knowing anything about the underlying implementation. This allows us to refactor away from TS CLI for rendering to use the GO CLI.

This is not a complete migration of tests, instead a sample of happy and error pathways to validate the new infrastructure fakeDeepCodeServer and some changes aimed at making tests easier to write.

How should this be manually tested?

npx jest ./test/jest/acceptance/snyk-code/snyk-code.spec.ts

[github-actions]

	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/jest/acceptance/snyk-code/snyk-code.spec.ts
⚠️	"test: succeed testing with correct exit code - with sarif oputput and no markdown" is too long. Keep the first line of your commit message under 72 characters.

Generated by 🚫 dangerJS against 5ae71af

[thisislawatts]

Introduce the ability to configure the CODE_CLIENT_PROXY_URL via environment variables. This is aimed at making it easier to test.

[thisislawatts]

Diverging from the existing pattern with fakeServer where port is passed in. Instead by kicking it off before env we can default to using any available port on the machine. This will make it easier to introduce parallelisation within the same machine at a later date. Included as part of this work as a proof of concept. Refactoring existing fakerServer to default to this behaviour can be done as part of a follow up changeset.

[j-luong]

question: what's the reason for not extending fake-server.ts and creating a second "fake-server"?

edit: I think this comment may have something to do with it? If so, it might be worth adding something like a TODO in this file so we don't forget about it

[thisislawatts]

A good question, fake-server is less generic than it sounds, it aims to replicate our primary public APIs, whereas the second server is for secondary set of public APIs. Currently these are distributed across two "namespaces" api.snyk.io and deepcode.snyk.io. This is something of a legacy shadow, I agree something to tidy up in a future refactor. Ideally as part of moving our fake servers to assign their own port 🤩