playwright/tests/playwright-test/only-changed.spec.ts

/**
 * Copyright (c) Microsoft Corporation.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import { test, expect, magicFileCreationSymbol } from './playwright-test-fixtures';
import { execSync } from 'node:child_process';
import { writeFile } from 'node:fs/promises';
import { join } from 'node:path';

test('should detect untracked files', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.spec.ts': `
        import { test, expect } from '@playwright/test';
        test('fails', () => { expect(1).toBe(2); });
      `,
    'b.spec.ts': `
        import { test, expect } from '@playwright/test';
        test('fails', () => { expect(1).toBe(2); });
      `,
    async [magicFileCreationSymbol](baseDir) {
      execSync(`git init --initial-branch=main`, { cwd: baseDir });
      execSync(`git add .`, { cwd: baseDir });
      execSync(`git commit -m init`, { cwd: baseDir });

      await writeFile(join(baseDir, 'c.spec.ts'), `
        import { test, expect } from '@playwright/test';
        test('fails', () => { expect(1).toBe(2); });
      `);
    }
  }, { 'only-changed': true });

  expect(result.exitCode).toBe(1);
  expect(result.failed).toBe(1);
  expect(result.output).toContain('c.spec.ts');
});


test('should detect changed files', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.spec.ts': `
        import { test, expect } from '@playwright/test';
        test('fails', () => { expect(1).toBe(2); });
      `,
    'b.spec.ts': `
        import { test, expect } from '@playwright/test';
        test('fails', () => { expect(1).toBe(2); });
      `,
    async [magicFileCreationSymbol](baseDir) {
      execSync(`git init --initial-branch=main`, { cwd: baseDir });
      execSync(`git add .`, { cwd: baseDir });
      execSync(`git commit -m init`, { cwd: baseDir });

      await writeFile(join(baseDir, 'b.spec.ts'), `
        import { test, expect } from '@playwright/test';
        test('fails', () => { expect(1).toBe(3); });
      `);
    }
  }, { 'only-changed': true });

  expect(result.exitCode).toBe(1);
  expect(result.failed).toBe(1);
  expect(result.output).toContain('b.spec.ts');
});

test('should diff based on base commit', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.spec.ts': `
        import { test, expect } from '@playwright/test';
        test('fails', () => { expect(1).toBe(2); });
      `,
    'b.spec.ts': `
        import { test, expect } from '@playwright/test';
        test('fails', () => { expect(1).toBe(2); });
      `,
    async [magicFileCreationSymbol](baseDir) {
      execSync(`git init --initial-branch=main`, { cwd: baseDir });
      execSync(`git add .`, { cwd: baseDir });
      execSync(`git commit -m init`, { cwd: baseDir });

      await writeFile(join(baseDir, 'b.spec.ts'), `
        import { test, expect } from '@playwright/test';
        test('fails', () => { expect(1).toBe(3); });
      `);

      execSync(`git commit -a -m update`, { cwd: baseDir });
    }
  }, { 'only-changed': `HEAD~1` });

  expect(result.exitCode).toBe(1);
  expect(result.failed).toBe(1);
  expect(result.output).toContain('b.spec.ts');
});

test.describe('should be smart about PR base reference from CI', () => {
  test('GitHub Actions', async ({ runInlineTest }) => {
    const result = await runInlineTest({
      'a.spec.ts': `
          import { test, expect } from '@playwright/test';
          test('fails', () => { expect(1).toBe(2); });
        `,
      'b.spec.ts': `
          import { test, expect } from '@playwright/test';
          test('fails', () => { expect(1).toBe(2); });
        `,
      async [magicFileCreationSymbol](baseDir) {
        execSync(`git init --initial-branch=main`, { cwd: baseDir });
        execSync(`git add .`, { cwd: baseDir });
        execSync(`git commit -m init`, { cwd: baseDir });

        await writeFile(join(baseDir, 'b.spec.ts'), `
          import { test, expect } from '@playwright/test';
          test('fails', () => { expect(1).toBe(3); });
        `);

        execSync(`git commit -a -m update`, { cwd: baseDir });
      }
    }, { 'only-changed': true }, { GITHUB_BASE_REF: 'HEAD~1' });

    expect(result.exitCode).toBe(1);
    expect(result.failed).toBe(1);
    expect(result.output).toContain('b.spec.ts');
  });


  test('Azure DevOps', async ({ runInlineTest }) => {
    const result = await runInlineTest({
      'a.spec.ts': `
          import { test, expect } from '@playwright/test';
          test('fails', () => { expect(1).toBe(2); });
        `,
      'b.spec.ts': `
          import { test, expect } from '@playwright/test';
          test('fails', () => { expect(1).toBe(2); });
        `,
      async [magicFileCreationSymbol](baseDir) {
        execSync(`git init --initial-branch=main`, { cwd: baseDir });
        execSync(`git add .`, { cwd: baseDir });
        execSync(`git commit -m init`, { cwd: baseDir });

        await writeFile(join(baseDir, 'b.spec.ts'), `
          import { test, expect } from '@playwright/test';
          test('fails', () => { expect(1).toBe(3); });
        `);

        execSync(`git commit -a -m update`, { cwd: baseDir });
      }
    }, {
      'only-changed': true
    }, {
      // see https://learn.microsoft.com/en-us/azure/devops/pipelines/release/variables?view=azure-devops&tabs=batch#primary-artifact
      'Build.PullRequest.TargetBranch': 'HEAD~1'
    });

    expect(result.exitCode).toBe(1);
    expect(result.failed).toBe(1);
    expect(result.output).toContain('b.spec.ts');
  });
});