test: add basic e2e

Author: BioPhoton

e2e/plugin-typescript-e2e/tests/collect.e2e.test.ts

@@ -0,0 +1,64 @@
+import { cp } from 'node:fs/promises';
+import path, { join } from 'node:path';
+import { afterAll, beforeAll, expect } from 'vitest';
+import { 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,
+  omitVariableReportData,
+  removeColorCodes,
+} from '@code-pushup/test-utils';
+import { executeProcess, readJsonFile } from '@code-pushup/utils';
+
+describe.todo(
+  'PLUGIN collect report with typescript-plugin NPM package',
+  () => {
+    const envRoot = path.join(E2E_ENVIRONMENTS_DIR, nxTargetProject());
+    const testFileDir = path.join(envRoot, TEST_OUTPUT_DIR, 'collect');
+    const defaultSetupDir = path.join(testFileDir, 'default-setup');
+
+    const fixturesDir = path.join(
+      'e2e',
+      nxTargetProject(),
+      'mocks',
+      'fixtures',
+    );
+
+    beforeAll(async () => {
+      await cp(fixturesDir, testFileDir, { recursive: true });
+    });
+
+    afterAll(async () => {
+      await teardownTestFolder(testFileDir);
+    });
+
+    it('should run plugin over CLI and creates report.json', async () => {
+      const { code, stdout } = await executeProcess({
+        command: 'npx',
+        // verbose exposes audits with perfect scores that are hidden in the default stdout
+        args: [
+          '@code-pushup/cli',
+          'collect',
+          `--config=${join(TEST_OUTPUT_DIR, 'collect', 'default-setup', 'code-pushup.config.ts')}`,
+          '--no-progress',
+          '--verbose',
+        ],
+        cwd: envRoot,
+      });
+
+      expect(code).toBe(0);
+      const cleanStdout = removeColorCodes(stdout);
+      expect(cleanStdout).toContain('● Largest Contentful Paint');
+
+      const report = await readJsonFile(
+        path.join(defaultSetupDir, '.code-pushup', 'report.json'),
+      );
+      expect(() => reportSchema.parse(report)).not.toThrow();
+      expect(
+        omitVariableReportData(report as Report, { omitAuditData: true }),
+      ).toMatchSnapshot();
+    });
+  },
+);

e2e/plugin-typescript-e2e/tests/install.e2e.test.ts

@@ -1,29 +1,23 @@
+import { readFile } from 'node:fs/promises';
 import path from 'node:path';
 import { expect } from 'vitest';
 import { nxTargetProject } from '@code-pushup/test-nx-utils';
-import { E2E_ENVIRONMENTS_DIR, TEST_OUTPUT_DIR } from '@code-pushup/test-utils';
+import { E2E_ENVIRONMENTS_DIR } from '@code-pushup/test-utils';
 import { getCurrentTsVersion } from '@code-pushup/typescript-plugin';
-import { readJsonFile } from '@code-pushup/utils';
 
 describe('PLUGIN install of typescript-plugin NPM package', () => {
-  const testFileDir = path.join(
-    E2E_ENVIRONMENTS_DIR,
-    nxTargetProject(),
-    TEST_OUTPUT_DIR,
-    'install',
+  const envRoot = path.join(E2E_ENVIRONMENTS_DIR, nxTargetProject());
+  const cacheDir = path.join(
+    'node_modules',
+    '.code-pushup',
+    'typescript-plugin',
+    'default-ts-configs',
   );
 
   it('should have current TS version defaults generated after install', async () => {
     await expect(
-      readJsonFile(
-        path.join(
-          testFileDir,
-          'node_modules',
-          '.code-pushup',
-          'plugin-typescript',
-          'default-ts-configs',
-          await getCurrentTsVersion(),
-        ),
+      readFile(
+        path.join(envRoot, cacheDir, `${await getCurrentTsVersion()}.ts`),
       ),
     ).resolves.not.toThrow();
   });

packages/plugin-typescript/src/lib/constants.ts

@@ -5,11 +5,7 @@ import { camelCaseToKebabCase, kebabCaseToSentence } from '@code-pushup/utils';
 import { TS_ERROR_CODES } from './runner/ts-error-codes.js';
 import type { CompilerOptionName } from './runner/types.js';
 
-export const TS_PLUGIN_CACHE = join(
-  'node_modules',
-  '.code-pushup',
-  'typescript-plugin',
-);
+export const TS_PLUGIN_CACHE = join('.code-pushup', 'typescript-plugin');
 export const TS_CONFIG_DIR = join(TS_PLUGIN_CACHE, 'default-ts-configs');
 
 export const TYPESCRIPT_PLUGIN_SLUG = 'typescript';

packages/plugin-typescript/src/lib/runner/utils.ts

@@ -130,7 +130,12 @@ export async function getCurrentTsVersion(): Promise<SemVerString> {
 
 export async function loadTsConfigDefaultsByVersion() {
   const version = await getCurrentTsVersion();
-  const configPath = join(TS_CONFIG_DIR, `${version}.ts`);
+  const configPath = join(
+    process.cwd(),
+    'node_modules',
+    TS_CONFIG_DIR,
+    `${version}.js`,
+  );
   try {
     await access(configPath);
   } catch {
@@ -144,7 +149,7 @@ export async function loadTsConfigDefaultsByVersion() {
     return module.default as { compilerOptions: CompilerOptions };
   } catch (error) {
     throw new Error(
-      `Could load default TS config for version ${version}. /n ${(error as Error).message}`,
+      `Could load default TS config for version ${version} at ${configPath}. The plugin maintainer has to support this version. \n ${(error as Error).message}`,
     );
   }
 }

packages/plugin-typescript/src/postinstall/index.ts

@@ -3,4 +3,5 @@ import { generateCurrentTsConfig } from './utils.js';
 // eslint-disable-next-line unicorn/prefer-top-level-await
 (async () => {
   await generateCurrentTsConfig();
+  console.log('Generated current TS config');
 })();

packages/plugin-typescript/src/postinstall/utils.ts

@@ -1,37 +1,47 @@
 // Run typescript init (with a version specified) to generate a tsconfig.json that will have all defaults listed.
 // store this json per ts version in src/default-configs.ts
 // get a list of TS version, maybe from npm and somehow filter only versions
-import { writeFile } from 'node:fs/promises';
+import { rm, writeFile } from 'node:fs/promises';
 // eslint-disable-next-line unicorn/import-style
-import { join } from 'node:path';
+import { dirname, join } from 'node:path';
 import type { CompilerOptions } from 'typescript';
 import {
   ensureDirectoryExists,
   executeProcess,
   readTextFile,
 } from '@code-pushup/utils';
-import { TS_CONFIG_DIR } from '../lib/constants.js';
 import type { SemVerString } from '../lib/runner/types.js';
 import { getCurrentTsVersion } from '../lib/runner/utils.js';
 
-export const TMP_TS_CONFIG_DIR = join('tmp', 'plugin-typescript-ts-config');
+const normalizedTsConfigFolder = join(
+  '..',
+  '..',
+  '.code-pushup',
+  'typescript-plugin',
+  'default-ts-configs',
+);
+const tmpDir = join(normalizedTsConfigFolder, 'tmp');
 
 export async function generateDefaultTsConfig(version: SemVerString) {
-  await ensureDirectoryExists(TS_CONFIG_DIR);
+  await ensureDirectoryExists(normalizedTsConfigFolder);
   await generateRawTsConfigFile(version);
   const config = await extractTsConfig(version);
+  await cleanupArtefacts();
   await cleanupNpmCache(version);
-  return writeFile(
-    join(TS_CONFIG_DIR, `${version}.ts`),
+  await writeFile(
+    join(normalizedTsConfigFolder, `${version}.js`),
     [
       `const config = ${JSON.stringify(config, null, 2)}`,
       `export default config;`,
     ].join('\n'),
   );
+  console.log(
+    `Generated default TS config for version ${version} under ${normalizedTsConfigFolder}`,
+  );
 }
 
 export async function generateRawTsConfigFile(version: SemVerString) {
-  const dir = join(TMP_TS_CONFIG_DIR, version);
+  const dir = join(tmpDir, version);
   await ensureDirectoryExists(dir);
   await executeProcess({
     command: 'npx',
@@ -47,7 +57,7 @@ export async function generateRawTsConfigFile(version: SemVerString) {
 export async function extractTsConfig(
   version: SemVerString,
 ): Promise<CompilerOptions> {
-  const dir = join(TMP_TS_CONFIG_DIR, version);
+  const dir = join(tmpDir, version);
   await ensureDirectoryExists(dir);
   try {
     return parseTsConfigJson(await readTextFile(join(dir, 'tsconfig.json')));
@@ -69,6 +79,14 @@ export async function cleanupNpmCache(version: SemVerString) {
   });
 }
 
+/**
+ * Cleanup artefacts`
+ * @param version
+ */
+export async function cleanupArtefacts() {
+  await rm(tmpDir, { recursive: true });
+}
+
 /**
  * Parse the tsconfig.json file content into a CompilerOptions object.
  * tsconfig.json files can have comments and trailing commas, which are not valid JSON.