-
Notifications
You must be signed in to change notification settings - Fork 586
feat: add command for monitoring SBOMs #5847
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| {"scanResults":[{"name":"npm:development","facts":[{"type":"depGraph","data":{"graph":{"nodes":[{"deps":[{"nodeId":"[email protected]"}],"nodeId":"[email protected]","pkgId":"[email protected]"},{"deps":[{"nodeId":"[email protected]"},{"nodeId":"[email protected]"}],"nodeId":"[email protected]","pkgId":"[email protected]"},{"deps":[],"nodeId":"[email protected]","pkgId":"[email protected]"},{"deps":[],"nodeId":"[email protected]","pkgId":"[email protected]"},{"deps":[],"nodeId":"[email protected]","pkgId":"[email protected]"},{"deps":[{"nodeId":"[email protected]"},{"nodeId":"[email protected]"},{"nodeId":"[email protected]"}],"nodeId":"root-node","pkgId":"[email protected]"},{"deps":[{"nodeId":"[email protected]"}],"nodeId":"[email protected]","pkgId":"[email protected]"},{"deps":[{"nodeId":"[email protected]"}],"nodeId":"[email protected]","pkgId":"[email protected]"},{"deps":[],"nodeId":"[email protected]","pkgId":"[email protected]"}],"rootNodeId":"root-node"},"pkgManager":{"name":"npm"},"pkgs":[{"id":"[email protected]","info":{"name":"development","version":"1.0.0"}},{"id":"[email protected]","info":{"name":"brace-expansion","version":"1.1.11"}},{"id":"[email protected]","info":{"name":"yallist","version":"4.0.0"}},{"id":"[email protected]","info":{"name":"minimatch","version":"3.0.4"}},{"id":"[email protected]","info":{"name":"balanced-match","version":"1.0.2"}},{"id":"[email protected]","info":{"name":"concat-map","version":"0.0.1"}},{"id":"[email protected]","info":{"name":"semver","version":"7.3.5"}},{"id":"[email protected]","info":{"name":"lru-cache","version":"6.0.0"}},{"id":"[email protected]","info":{"name":"fuzzball","version":"1.4.0"}}],"schemaVersion":"1.3.0"}}],"target":{"remoteUrl":""},"identity":{"type":"npm"}}],"warnings":null} |
134 changes: 134 additions & 0 deletions
134
test/jest/acceptance/snyk-sbom-monitor/all-projects.spec.ts
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| import { runSnykCLI } from '../../util/runSnykCLI'; | ||
| import { fakeServer } from '../../../acceptance/fake-server'; | ||
| import { getServerPort } from '../../util/getServerPort'; | ||
| import { getFixturePath } from '../../util/getFixturePath'; | ||
| import * as path from 'path'; | ||
|
|
||
| jest.setTimeout(1000 * 60); | ||
|
|
||
| describe('snyk sbom monitor (mocked server only)', () => { | ||
| let server: ReturnType<typeof fakeServer>; | ||
| let env: Record<string, string>; | ||
|
|
||
| beforeAll((done) => { | ||
| const port = getServerPort(process); | ||
| const baseApi = '/v1'; | ||
| env = { | ||
| ...process.env, | ||
| SNYK_API: 'http://localhost:' + port + baseApi, | ||
| SNYK_API_REST_URL: 'http://localhost:' + port + baseApi, | ||
| SNYK_HOST: 'http://localhost:' + port, | ||
| SNYK_TOKEN: '123456789', | ||
| SNYK_DISABLE_ANALYTICS: '1', | ||
| }; | ||
| server = fakeServer(baseApi, env.SNYK_TOKEN); | ||
| server.listen(port, () => { | ||
| done(); | ||
| }); | ||
| }); | ||
|
|
||
| beforeEach(() => { | ||
| server.setFeatureFlag('sbomMonitorBeta', true); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| jest.resetAllMocks(); | ||
| server.restore(); | ||
| }); | ||
|
|
||
| afterAll((done) => { | ||
| server.close(() => { | ||
| done(); | ||
| }); | ||
| }); | ||
|
|
||
| test('monitor success', async () => { | ||
| const fileToTest = path.resolve( | ||
| getFixturePath('sbom'), | ||
| 'npm-sbom-cdx15.json', | ||
| ); | ||
|
|
||
| const { code, stdout, stderr } = await runSnykCLI( | ||
| `sbom monitor --org aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --experimental --file ${fileToTest}`, | ||
| { env }, | ||
| ); | ||
|
|
||
| expect(code).toEqual(0); | ||
|
|
||
| expect(stderr).toEqual(''); | ||
| expect(stdout).toContain(`Monitoring 'test-project'...`); | ||
| expect(stdout).toContain( | ||
| `Explore this snapshot at http://example-url/project/project-public-id/history/snapshot-public-id`, | ||
| ); | ||
| expect(stdout).toContain( | ||
| `Notifications about newly disclosed issues related to these dependencies will be emailed to you.`, | ||
| ); | ||
| }); | ||
|
|
||
| test('monitor bad SBOM', async () => { | ||
| const fileToTest = path.resolve(getFixturePath('sbom'), 'bad-sbom.json'); | ||
|
|
||
| const { code, stdout, stderr } = await runSnykCLI( | ||
| `sbom monitor --org badaabad-badb-badb-badb-badbadbadbad --experimental --file ${fileToTest}`, | ||
| { env }, | ||
| ); | ||
|
|
||
| expect(code).toEqual(2); | ||
|
|
||
| expect(stderr).toEqual(''); | ||
| expect(stdout).toContain(`Bad Request (SNYK-0003)`); | ||
| expect(stdout).toContain(`invalid SBOM`); | ||
| }); | ||
|
|
||
| test('missing experimental flag', async () => { | ||
| const fileToTest = path.resolve( | ||
| getFixturePath('sbom'), | ||
| 'npm-sbom-cdx15.json', | ||
| ); | ||
|
|
||
| const { stdout, stderr } = await runSnykCLI( | ||
| `sbom monitor --org aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --file ${fileToTest}`, | ||
| { env }, | ||
| ); | ||
|
|
||
| expect(stdout).toMatch( | ||
| 'Flag `--experimental` is required to execute this command.', | ||
| ); | ||
|
|
||
| expect(stderr).toEqual(''); | ||
| }); | ||
|
|
||
| test('missing file flag', async () => { | ||
| const { stdout, stderr } = await runSnykCLI( | ||
| `sbom monitor --org aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --experimental`, | ||
| { env }, | ||
| ); | ||
|
|
||
| expect(stdout).toContainText( | ||
| 'Flag `--file` is required to execute this command. Value should point to a valid SBOM document.', | ||
| ); | ||
|
|
||
| expect(stderr).toEqual(''); | ||
| }); | ||
|
|
||
| test('feature flag sbomMonitorBeta is disabled', async () => { | ||
| const fileToTest = path.resolve( | ||
| getFixturePath('sbom'), | ||
| 'npm-sbom-cdx15.json', | ||
| ); | ||
|
|
||
| server.setFeatureFlag('sbomMonitorBeta', false); | ||
|
|
||
| const { code, stdout, stderr } = await runSnykCLI( | ||
| `sbom monitor --org aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee --experimental --file ${fileToTest}`, | ||
| { env }, | ||
| ); | ||
|
|
||
| expect(code).toEqual(2); | ||
|
|
||
| expect(stderr).toEqual(''); | ||
| expect(stdout).toContain( | ||
| `The feature you are trying to use is not available for your organization.`, | ||
| ); | ||
| }); | ||
| }); | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question: would we feel comfortable to run the happy path test against the actual API? Having tests run only against a mock, will not uncover integration issues.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is something we should strive for but not in this PR. The SBOM Monitor command tests are using the same mocked service strategy as both the SBOM Create and SBOM Test commands.