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(plugin-js-packages-e2e): create vulnerabilities e2e test #898

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions e2e/plugin-js-packages-e2e/eslint.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import tseslint from 'typescript-eslint';
import baseConfig from '../../eslint.config.js';

export default tseslint.config(...baseConfig, {
files: ['**/*.ts'],
languageOptions: {
parserOptions: {
projectService: true,
tsconfigRootDir: import.meta.dirname,
},
},
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import jsPackagesPlugin from '@code-pushup/js-packages-plugin';
import type { CoreConfig } from '@code-pushup/models';

export default {
persist: { outputDir: './' },
plugins: [await jsPackagesPlugin({ packageManager: 'npm' })],
} satisfies CoreConfig;
191 changes: 191 additions & 0 deletions e2e/plugin-js-packages-e2e/mocks/fixtures/npm-repo/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"dependencies": {
"express": "3.0.0"
}
}
23 changes: 23 additions & 0 deletions e2e/plugin-js-packages-e2e/project.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"name": "plugin-js-packages-e2e",
"$schema": "../../node_modules/nx/schemas/project-schema.json",
"projectType": "application",
"sourceRoot": "e2e/plugin-js-packages-e2e/src",
"implicitDependencies": ["cli", "plugin-js-packages"],
"targets": {
"lint": {
"executor": "@nx/linter:eslint",
"outputs": ["{options.outputFile}"],
"options": {
"lintFilePatterns": ["e2e/plugin-eslint-e2e/**/*.ts"]
}
},
"e2e": {
"executor": "@nx/vite:test",
"options": {
"configFile": "e2e/plugin-eslint-e2e/vite.config.e2e.ts"
}
}
},
"tags": ["scope:plugin", "type:e2e"]
}
98 changes: 98 additions & 0 deletions e2e/plugin-js-packages-e2e/tests/plugin-js-packages.e2e.test.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
import { cp } from 'node:fs/promises';
import path from 'node:path';
import { afterAll, beforeAll, expect, it } from 'vitest';
import {
type AuditReport,
type Report,
reportSchema,
} from '@code-pushup/models';
import { nxTargetProject } from '@code-pushup/test-nx-utils';
import { teardownTestFolder } from '@code-pushup/test-setup';
import { E2E_ENVIRONMENTS_DIR, TEST_OUTPUT_DIR } from '@code-pushup/test-utils';
import { executeProcess, readJsonFile } from '@code-pushup/utils';

describe('plugin-js-packages', () => {
const fixturesDir = path.join(
'e2e',
'plugin-js-packages-e2e',
'mocks',
'fixtures',
);
const fixturesNPMDir = path.join(fixturesDir, 'npm-repo');

const envRoot = path.join(
E2E_ENVIRONMENTS_DIR,
nxTargetProject(),
TEST_OUTPUT_DIR,
);
const npmRepoDir = path.join(envRoot, 'npm-repo');

beforeAll(async () => {
await cp(fixturesNPMDir, npmRepoDir, { recursive: true });
});

afterAll(async () => {
await teardownTestFolder(npmRepoDir);
});

it('should run JS packages plugin for NPM and create report.json', async () => {
const { code } = await executeProcess({
command: 'node',
args: [
'../../node_modules/@code-pushup/cli/src/index.js',
'collect',
'--no-progress',
],
cwd: npmRepoDir,
});

expect(code).toBe(0);

const report = await readJsonFile<Report>(
path.join(npmRepoDir, 'report.json'),
);

const plugin = report.plugins[0]!;
const npmAuditProd = plugin.audits.find(
({ slug }) => slug === 'npm-audit-prod',
)!;
const npmOutdatedProd = plugin.audits.find(
({ slug }) => slug === 'npm-outdated-prod',
)!;

expect(plugin.packageName).toBe('@code-pushup/js-packages-plugin');
expect(plugin.audits).toHaveLength(4);

expect(npmAuditProd).toEqual<AuditReport>(
expect.objectContaining({
value: expect.any(Number),
}),
);
expect(npmAuditProd.value).toBeGreaterThanOrEqual(7); // there are 7 vulnerabilities (6 high, 1 low) in prod dependency at the time
expect(npmAuditProd.displayValue).toMatch(/\d vulnerabilities/);
expect(npmAuditProd.details?.issues!.length).toBeGreaterThanOrEqual(7);

const expressConnectIssue = npmAuditProd.details!.issues![0]!;
expect(expressConnectIssue?.severity).toBe('error');
expect(expressConnectIssue?.message).toContain('express');
expect(expressConnectIssue?.message).toContain('2.30.2');
expect(expressConnectIssue?.message).toContain(
'methodOverride Middleware Reflected Cross-Site Scripting in connect',
);

expect(npmOutdatedProd.score).toBe(0);
expect(npmOutdatedProd.value).toBe(1); // there is 1 outdated prod dependency at the time
expect(npmOutdatedProd.displayValue).toBe(
'1 major outdated package version',
);
expect(npmOutdatedProd.details?.issues).toHaveLength(1);

const expressOutdatedIssue = npmOutdatedProd.details!.issues![0]!;
expect(expressOutdatedIssue.severity).toBe('error');
expect(expressOutdatedIssue.message).toMatch(
/^Package \[`express`]\(http:\/\/expressjs\.com\/?\) requires a \*\*major\*\* update from \*\*3.0.0\*\* to \*\*\d+\.\d+\.\d+\*\*\.$/,
);

expect(() => reportSchema.parse(report)).not.toThrow();
});
});
20 changes: 20 additions & 0 deletions e2e/plugin-js-packages-e2e/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"extends": "../../tsconfig.base.json",
"compilerOptions": {
"module": "ESNext",
"forceConsistentCasingInFileNames": true,
"strict": true,
"noImplicitOverride": true,
"noPropertyAccessFromIndexSignature": true,
"noImplicitReturns": true,
"noFallthroughCasesInSwitch": true,
"types": ["vitest"]
},
"files": [],
"include": [],
"references": [
{
"path": "./tsconfig.test.json"
}
]
}
15 changes: 15 additions & 0 deletions e2e/plugin-js-packages-e2e/tsconfig.test.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"extends": "./tsconfig.json",
"compilerOptions": {
"outDir": "../../dist/out-tsc",
"types": ["vitest/globals", "vitest/importMeta", "vite/client", "node"],
"target": "ES2020"
},
"exclude": ["__test-env__/**"],
"include": [
"vite.config.e2e.ts",
"tests/**/*.e2e.test.ts",
"tests/**/*.d.ts",
"mocks/**/*.ts"
]
}
Loading
Loading