collect.e2e.test.ts

import { cp } from 'node:fs/promises';
import path from 'node:path';
import { simpleGit } from 'simple-git';
import { afterAll, afterEach, beforeAll, describe, expect, it } from 'vitest';
import { type Report, reportSchema } from '@code-pushup/models';
import { omitVariableReportData } from '@code-pushup/test-fixtures';
import { nxTargetProject } from '@code-pushup/test-nx-utils';
import {
  E2E_ENVIRONMENTS_DIR,
  TEST_OUTPUT_DIR,
  initGitRepo,
  restoreNxIgnoredFiles,
  teardownTestFolder,
} from '@code-pushup/test-utils';
import { executeProcess, readJsonFile } from '@code-pushup/utils';

describe('PLUGIN collect report with jsdocs-plugin NPM package', () => {
  const fixturesDir = path.join(
    'e2e',
    'plugin-jsdocs-e2e',
    'mocks',
    'fixtures',
  );
  const fixturesAngularDir = path.join(fixturesDir, 'angular');
  const fixturesReactDir = path.join(fixturesDir, 'react');

  const envRoot = path.join(
    E2E_ENVIRONMENTS_DIR,
    nxTargetProject(),
    TEST_OUTPUT_DIR,
  );
  const angularDir = path.join(envRoot, 'angular');
  const reactDir = path.join(envRoot, 'react');
  const angularOutputDir = path.join(angularDir, '.code-pushup');
  const reactOutputDir = path.join(reactDir, '.code-pushup');

  beforeAll(async () => {
    await cp(fixturesAngularDir, angularDir, { recursive: true });
    await cp(fixturesReactDir, reactDir, { recursive: true });
    await restoreNxIgnoredFiles(angularDir);
    await restoreNxIgnoredFiles(reactDir);
    await initGitRepo(simpleGit, { baseDir: angularDir });
    await initGitRepo(simpleGit, { baseDir: reactDir });
  });

  afterAll(async () => {
    await teardownTestFolder(angularDir);
    await teardownTestFolder(reactDir);
  });

  afterEach(async () => {
    await teardownTestFolder(angularOutputDir);
    await teardownTestFolder(reactOutputDir);
  });

  it('should run JSDoc plugin for Angular example dir and create report.json', async () => {
    const { code } = await executeProcess({
      command: 'npx',
      args: ['@code-pushup/cli', 'collect'],
      cwd: angularDir,
    });

    expect(code).toBe(0);

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

    expect(() => reportSchema.parse(report)).not.toThrow();
    expect(omitVariableReportData(report)).toMatchSnapshot();
  });
});