|
| 1 | +import { join } from 'path'; |
| 2 | +import { mocked } from 'ts-jest/utils'; |
| 3 | +import { NeedleResponse } from 'needle'; |
| 4 | +import { test } from '../../../../../src/cli/commands'; |
| 5 | +import { loadPlugin } from '../../../../../src/lib/plugins/index'; |
| 6 | +import { CommandResult } from '../../../../../src/cli/commands/types'; |
| 7 | +import makeRequest = require('../../../../../src/lib/request/request'); |
| 8 | + |
| 9 | +jest.mock('../../../../../src/lib/plugins/index'); |
| 10 | +jest.mock('../../../../../src/lib/request/request'); |
| 11 | + |
| 12 | +const mockedLoadPlugin = mocked(loadPlugin, true); |
| 13 | +const mockedMakeRequest = mocked(makeRequest); |
| 14 | + |
| 15 | +describe('snyk test for python project', () => { |
| 16 | + afterEach(() => { |
| 17 | + jest.clearAllMocks(); |
| 18 | + }); |
| 19 | + |
| 20 | + describe('no flag is used', () => { |
| 21 | + describe('project contains poetry.lock file', () => { |
| 22 | + it('should scan poetry vulnerabilities', async (done) => { |
| 23 | + const fixturePath = join( |
| 24 | + __dirname, |
| 25 | + '../../../../acceptance/workspaces', |
| 26 | + 'poetry-app', |
| 27 | + ); |
| 28 | + |
| 29 | + const plugin = { |
| 30 | + async inspect() { |
| 31 | + return { |
| 32 | + plugin: { |
| 33 | + targetFile: 'poetry.lock', |
| 34 | + name: 'snyk-python-plugin', |
| 35 | + runtime: 'Python', |
| 36 | + }, |
| 37 | + package: {}, |
| 38 | + }; |
| 39 | + }, |
| 40 | + }; |
| 41 | + mockedLoadPlugin.mockImplementationOnce(() => { |
| 42 | + return plugin; |
| 43 | + }); |
| 44 | + mockedMakeRequest.mockImplementationOnce(() => { |
| 45 | + return Promise.resolve({ |
| 46 | + res: { statusCode: 200 } as NeedleResponse, |
| 47 | + body: { |
| 48 | + result: { issuesData: {}, affectedPkgs: {} }, |
| 49 | + meta: { org: 'test-org', isPublic: false }, |
| 50 | + filesystemPolicy: false, |
| 51 | + }, |
| 52 | + }); |
| 53 | + }); |
| 54 | + |
| 55 | + const result: CommandResult = await test(fixturePath, { |
| 56 | + json: true, |
| 57 | + }); |
| 58 | + |
| 59 | + expect(mockedLoadPlugin).toHaveBeenCalledTimes(1); |
| 60 | + expect(mockedLoadPlugin).toHaveBeenCalledWith('poetry'); |
| 61 | + |
| 62 | + expect(mockedMakeRequest).toHaveBeenCalledTimes(1); |
| 63 | + expect(mockedMakeRequest).toHaveBeenCalledWith( |
| 64 | + expect.objectContaining({ |
| 65 | + body: expect.objectContaining({ |
| 66 | + displayTargetFile: 'poetry.lock', |
| 67 | + }), |
| 68 | + }), |
| 69 | + ); |
| 70 | + |
| 71 | + const expectedResultObject = { |
| 72 | + vulnerabilities: [], |
| 73 | + ok: true, |
| 74 | + dependencyCount: 0, |
| 75 | + org: 'test-org', |
| 76 | + policy: undefined, |
| 77 | + isPrivate: true, |
| 78 | + licensesPolicy: null, |
| 79 | + packageManager: 'poetry', |
| 80 | + projectId: undefined, |
| 81 | + ignoreSettings: null, |
| 82 | + docker: undefined, |
| 83 | + summary: 'No known vulnerabilities', |
| 84 | + severityThreshold: undefined, |
| 85 | + remediation: undefined, |
| 86 | + filesystemPolicy: false, |
| 87 | + uniqueCount: 0, |
| 88 | + targetFile: 'poetry.lock', |
| 89 | + projectName: undefined, |
| 90 | + foundProjectCount: undefined, |
| 91 | + displayTargetFile: 'poetry.lock', |
| 92 | + platform: undefined, |
| 93 | + path: fixturePath, |
| 94 | + }; |
| 95 | + expect(result).toMatchObject({ |
| 96 | + result: JSON.stringify(expectedResultObject, null, 2), |
| 97 | + }); |
| 98 | + |
| 99 | + done(); |
| 100 | + }); |
| 101 | + }); |
| 102 | + }); |
| 103 | + |
| 104 | + describe('--all-projects flag is used to scan the project', () => { |
| 105 | + describe('project does not contain poetry.lock file', () => { |
| 106 | + it('should not attempt to scan poetry vulnerabilities', async (done) => { |
| 107 | + const fixturePath = join( |
| 108 | + __dirname, |
| 109 | + 'fixtures', |
| 110 | + 'pyproject-without-poetry', |
| 111 | + ); |
| 112 | + const plugin = { |
| 113 | + async inspect() { |
| 114 | + return { |
| 115 | + plugin: { |
| 116 | + targetFile: 'Pipfile', |
| 117 | + name: 'snyk-python-plugin', |
| 118 | + runtime: 'Python', |
| 119 | + }, |
| 120 | + package: {}, |
| 121 | + }; |
| 122 | + }, |
| 123 | + }; |
| 124 | + mockedLoadPlugin.mockImplementationOnce(() => { |
| 125 | + return plugin; |
| 126 | + }); |
| 127 | + mockedMakeRequest.mockImplementationOnce(() => { |
| 128 | + return Promise.resolve({ |
| 129 | + res: { statusCode: 200 } as NeedleResponse, |
| 130 | + body: { |
| 131 | + result: { issuesData: {}, affectedPkgs: {} }, |
| 132 | + meta: { org: 'test-org', isPublic: false }, |
| 133 | + filesystemPolicy: false, |
| 134 | + }, |
| 135 | + }); |
| 136 | + }); |
| 137 | + |
| 138 | + const result: CommandResult = await test(fixturePath, { |
| 139 | + allProjects: true, |
| 140 | + json: true, |
| 141 | + }); |
| 142 | + |
| 143 | + expect(mockedLoadPlugin).toHaveBeenCalledTimes(1); |
| 144 | + expect(mockedLoadPlugin).toHaveBeenCalledWith('pip'); |
| 145 | + |
| 146 | + expect(mockedMakeRequest).toHaveBeenCalledTimes(1); |
| 147 | + expect(mockedMakeRequest).toHaveBeenCalledWith( |
| 148 | + expect.objectContaining({ |
| 149 | + body: expect.objectContaining({ |
| 150 | + displayTargetFile: 'Pipfile', |
| 151 | + }), |
| 152 | + }), |
| 153 | + ); |
| 154 | + |
| 155 | + const expectedResultObject = { |
| 156 | + vulnerabilities: [], |
| 157 | + ok: true, |
| 158 | + dependencyCount: 0, |
| 159 | + org: 'test-org', |
| 160 | + policy: undefined, |
| 161 | + isPrivate: true, |
| 162 | + licensesPolicy: null, |
| 163 | + packageManager: 'pip', |
| 164 | + projectId: undefined, |
| 165 | + ignoreSettings: null, |
| 166 | + docker: undefined, |
| 167 | + summary: 'No known vulnerabilities', |
| 168 | + severityThreshold: undefined, |
| 169 | + remediation: undefined, |
| 170 | + filesystemPolicy: false, |
| 171 | + uniqueCount: 0, |
| 172 | + targetFile: 'Pipfile', |
| 173 | + projectName: undefined, |
| 174 | + foundProjectCount: undefined, |
| 175 | + displayTargetFile: 'Pipfile', |
| 176 | + platform: undefined, |
| 177 | + path: fixturePath, |
| 178 | + }; |
| 179 | + expect(result).toMatchObject({ |
| 180 | + result: JSON.stringify(expectedResultObject, null, 2), |
| 181 | + }); |
| 182 | + |
| 183 | + done(); |
| 184 | + }); |
| 185 | + }); |
| 186 | + |
| 187 | + describe('project does contain poetry.lock file', () => { |
| 188 | + it('should scan poetry vulnerabilities', async (done) => { |
| 189 | + const fixturePath = join( |
| 190 | + __dirname, |
| 191 | + 'fixtures', |
| 192 | + 'pyproject-with-poetry', |
| 193 | + ); |
| 194 | + |
| 195 | + const pipfilePythonPluginResponse = { |
| 196 | + async inspect() { |
| 197 | + return { |
| 198 | + plugin: { |
| 199 | + targetFile: 'Pipfile', |
| 200 | + name: 'snyk-python-plugin', |
| 201 | + runtime: 'Python', |
| 202 | + }, |
| 203 | + package: {}, |
| 204 | + }; |
| 205 | + }, |
| 206 | + }; |
| 207 | + const pyprojectPythonPluginResponse = { |
| 208 | + async inspect() { |
| 209 | + return { |
| 210 | + plugin: { |
| 211 | + targetFile: 'poetry.lock', |
| 212 | + name: 'snyk-python-plugin', |
| 213 | + runtime: 'Python', |
| 214 | + }, |
| 215 | + package: {}, |
| 216 | + }; |
| 217 | + }, |
| 218 | + }; |
| 219 | + mockedLoadPlugin |
| 220 | + .mockImplementationOnce(() => pipfilePythonPluginResponse) |
| 221 | + .mockImplementationOnce(() => pyprojectPythonPluginResponse); |
| 222 | + mockedMakeRequest.mockImplementation(() => { |
| 223 | + return Promise.resolve({ |
| 224 | + res: { statusCode: 200 } as NeedleResponse, |
| 225 | + body: { |
| 226 | + result: { issuesData: {}, affectedPkgs: {} }, |
| 227 | + meta: { org: 'test-org', isPublic: false }, |
| 228 | + filesystemPolicy: false, |
| 229 | + }, |
| 230 | + }); |
| 231 | + }); |
| 232 | + |
| 233 | + const result: CommandResult = await test(fixturePath, { |
| 234 | + allProjects: true, |
| 235 | + json: true, |
| 236 | + }); |
| 237 | + |
| 238 | + expect(mockedLoadPlugin).toHaveBeenCalledTimes(2); |
| 239 | + expect(mockedLoadPlugin).toHaveBeenCalledWith('pip'); |
| 240 | + expect(mockedLoadPlugin).toHaveBeenCalledWith('poetry'); |
| 241 | + |
| 242 | + expect(mockedMakeRequest).toHaveBeenCalledTimes(2); |
| 243 | + expect(mockedMakeRequest).toHaveBeenCalledWith( |
| 244 | + expect.objectContaining({ |
| 245 | + body: expect.objectContaining({ |
| 246 | + displayTargetFile: 'Pipfile', |
| 247 | + foundProjectCount: 1, |
| 248 | + }), |
| 249 | + }), |
| 250 | + ); |
| 251 | + expect(mockedMakeRequest).toHaveBeenCalledWith( |
| 252 | + expect.objectContaining({ |
| 253 | + body: expect.objectContaining({ |
| 254 | + displayTargetFile: 'poetry.lock', |
| 255 | + foundProjectCount: 1, |
| 256 | + }), |
| 257 | + }), |
| 258 | + ); |
| 259 | + |
| 260 | + const expectedPipfileResultObject = { |
| 261 | + vulnerabilities: [], |
| 262 | + ok: true, |
| 263 | + dependencyCount: 0, |
| 264 | + org: 'test-org', |
| 265 | + policy: undefined, |
| 266 | + isPrivate: true, |
| 267 | + licensesPolicy: null, |
| 268 | + packageManager: 'pip', |
| 269 | + projectId: undefined, |
| 270 | + ignoreSettings: null, |
| 271 | + docker: undefined, |
| 272 | + summary: 'No known vulnerabilities', |
| 273 | + severityThreshold: undefined, |
| 274 | + remediation: undefined, |
| 275 | + filesystemPolicy: false, |
| 276 | + uniqueCount: 0, |
| 277 | + targetFile: 'Pipfile', |
| 278 | + foundProjectCount: 1, |
| 279 | + projectName: undefined, |
| 280 | + displayTargetFile: 'Pipfile', |
| 281 | + platform: undefined, |
| 282 | + path: fixturePath, |
| 283 | + }; |
| 284 | + const expectedPyprojectResultObject = { |
| 285 | + vulnerabilities: [], |
| 286 | + ok: true, |
| 287 | + dependencyCount: 0, |
| 288 | + org: 'test-org', |
| 289 | + policy: undefined, |
| 290 | + isPrivate: true, |
| 291 | + licensesPolicy: null, |
| 292 | + packageManager: 'poetry', |
| 293 | + projectId: undefined, |
| 294 | + ignoreSettings: null, |
| 295 | + docker: undefined, |
| 296 | + summary: 'No known vulnerabilities', |
| 297 | + severityThreshold: undefined, |
| 298 | + remediation: undefined, |
| 299 | + filesystemPolicy: false, |
| 300 | + uniqueCount: 0, |
| 301 | + targetFile: 'poetry.lock', |
| 302 | + foundProjectCount: 1, |
| 303 | + projectName: undefined, |
| 304 | + displayTargetFile: 'poetry.lock', |
| 305 | + platform: undefined, |
| 306 | + path: fixturePath, |
| 307 | + }; |
| 308 | + expect(result).toMatchObject({ |
| 309 | + result: JSON.stringify( |
| 310 | + [expectedPipfileResultObject, expectedPyprojectResultObject], |
| 311 | + null, |
| 312 | + 2, |
| 313 | + ), |
| 314 | + }); |
| 315 | + |
| 316 | + done(); |
| 317 | + }); |
| 318 | + }); |
| 319 | + }); |
| 320 | +}); |
0 commit comments