|
1 | 1 | import { runSnykCLI } from '../util/runSnykCLI'; |
2 | 2 | import { isWindowsOperatingSystem, describeIf } from '../../utils'; |
3 | 3 | import { EXIT_CODES } from '../../../src/cli/exit-codes'; |
| 4 | +import { FakeServer, fakeServer, getFirstIPv4Address } from '../../acceptance/fake-server'; |
| 5 | +import { getAvailableServerPort } from '../util/getServerPort'; |
| 6 | +const { promisify } = require('util'); |
4 | 7 |
|
5 | 8 | jest.setTimeout(1000 * 60); |
6 | 9 |
|
@@ -38,4 +41,138 @@ describe('exit code behaviour - general', () => { |
38 | 41 |
|
39 | 42 | expect(code).toEqual(EXIT_CODES.EX_UNAVAILABLE); |
40 | 43 | }); |
| 44 | + |
| 45 | + describe('[SNYK-0099] Maintenance error', () => { |
| 46 | + let server: FakeServer; |
| 47 | + let apiPort: string; |
| 48 | + let fakeServerUrl: string; |
| 49 | + let fakeServerHost: string; |
| 50 | + let fakeServerEnv: Record<string, string>; |
| 51 | + |
| 52 | + const serverToken = 'random'; |
| 53 | + const apiPath = '/api/v1'; |
| 54 | + |
| 55 | + const errorObject = { |
| 56 | + jsonapi: { version: '1.0' }, |
| 57 | + errors: [ |
| 58 | + { |
| 59 | + id: '11111111-2222-3333-4444-555555555555', |
| 60 | + links: { |
| 61 | + about: |
| 62 | + 'https://docs.snyk.io/scan-with-snyk/error-catalog#snyk-0099', |
| 63 | + }, |
| 64 | + status: '503', |
| 65 | + code: 'SNYK-0099', |
| 66 | + title: 'Unavailable due to maintenance', |
| 67 | + detail: '', |
| 68 | + meta: { |
| 69 | + links: [ |
| 70 | + 'https://status.snyk.io/', |
| 71 | + 'https://privatecloudstatus.snyk.io', |
| 72 | + ], |
| 73 | + isErrorCatalogError: true, |
| 74 | + classification: 'UNSUPPORTED', |
| 75 | + level: 'error', |
| 76 | + }, |
| 77 | + }, |
| 78 | + ], |
| 79 | + description: |
| 80 | + 'We are currently unavailable due to a maintenance window. For additional information please visit our status pages. Thank you for your patience.', |
| 81 | + }; |
| 82 | + |
| 83 | + beforeEach(async () => { |
| 84 | + apiPort = await getAvailableServerPort(process); |
| 85 | + fakeServerHost = 'http://' + getFirstIPv4Address() + ':' + apiPort; |
| 86 | + fakeServerUrl = fakeServerHost + apiPath; |
| 87 | + fakeServerEnv = { |
| 88 | + ...process.env, |
| 89 | + SNYK_API: fakeServerUrl, |
| 90 | + SNYK_DISABLE_ANALYTICS: '1', |
| 91 | + SNYK_HTTP_PROTOCOL_UPGRADE: '0', |
| 92 | + }; |
| 93 | + |
| 94 | + server = fakeServer(apiPath, serverToken); |
| 95 | + const serverListen = promisify(server.listen); |
| 96 | + await serverListen(apiPort); |
| 97 | + }); |
| 98 | + |
| 99 | + afterEach(async () => { |
| 100 | + const serverClose = promisify(server.close); |
| 101 | + await serverClose(); |
| 102 | + }); |
| 103 | + |
| 104 | + describe('no retry-after header in error response', () => { |
| 105 | + beforeEach(async () => { |
| 106 | + server.setGlobalResponse( |
| 107 | + errorObject, |
| 108 | + parseInt(errorObject['errors'][0].status), |
| 109 | + ); |
| 110 | + }) |
| 111 | + |
| 112 | + it('Does not attempt any retries', async () => { |
| 113 | + await runSnykCLI(`test -d --log-level=trace`, { |
| 114 | + env: { |
| 115 | + ...fakeServerEnv, |
| 116 | + // apply a user configured attempts of 10 |
| 117 | + INTERNAL_NETWORK_REQUEST_MAX_ATTEMPTS: '10', |
| 118 | + }, |
| 119 | + }); |
| 120 | + |
| 121 | + // Count how many times an endpoint was hit |
| 122 | + const requests = server.getRequests(); |
| 123 | + const testEndpointHits = requests.filter(r => |
| 124 | + r.url.includes('/test-dep-graph') || r.url.includes('/vuln/') |
| 125 | + ).length; |
| 126 | + |
| 127 | + expect(testEndpointHits).toBe(1); // Only 1 attempt, no retries |
| 128 | + }); |
| 129 | + }); |
| 130 | + |
| 131 | + describe('retry-after header in error response', () => { |
| 132 | + it('Respects retry-after header', async () => { |
| 133 | + server.setGlobalResponse( |
| 134 | + errorObject, |
| 135 | + parseInt(errorObject['errors'][0].status), |
| 136 | + { 'retry-after': '1' }, |
| 137 | + ); |
| 138 | + |
| 139 | + const { stderr } = await runSnykCLI(`test -d --log-level=trace`, { |
| 140 | + env: { |
| 141 | + ...fakeServerEnv, |
| 142 | + INTERNAL_NETWORK_REQUEST_MAX_ATTEMPTS: '2', |
| 143 | + }, |
| 144 | + }); |
| 145 | + |
| 146 | + const expectedRetryAfterDebugMsg = 'Retrying request, reason: retry after 1s'; |
| 147 | + const expectedRetryAfterHeaderDebugMsg = 'Retry-After:[1]'; |
| 148 | + expect(stderr).toContain(expectedRetryAfterDebugMsg); |
| 149 | + expect(stderr).toContain(expectedRetryAfterHeaderDebugMsg); |
| 150 | + |
| 151 | + const requests = server.getRequests(); |
| 152 | + const testEndpointHits = requests.filter(r => |
| 153 | + r.url.includes('/test-dep-graph') || r.url.includes('/vuln/') |
| 154 | + ).length; |
| 155 | + |
| 156 | + expect(testEndpointHits).toBe(2); // expected 2 network attempts |
| 157 | + }); |
| 158 | + }); |
| 159 | + |
| 160 | + it('Correct exit code', async () => { |
| 161 | + server.setGlobalResponse( |
| 162 | + errorObject, |
| 163 | + parseInt(errorObject['errors'][0].status), |
| 164 | + ); |
| 165 | + |
| 166 | + const { code, stdout } = await runSnykCLI(`test`, { |
| 167 | + env: { |
| 168 | + ...fakeServerEnv, |
| 169 | + INTERNAL_NETWORK_REQUEST_MAX_ATTEMPTS: '1', |
| 170 | + }, |
| 171 | + }); |
| 172 | + |
| 173 | + |
| 174 | + expect(stdout).toContain(errorObject['errors'][0].code); |
| 175 | + expect(code).toEqual(EXIT_CODES.EX_TEMPFAIL); |
| 176 | + }); |
| 177 | + }); |
41 | 178 | }); |
0 commit comments