playwright/tests/playwright-test/test-ignore.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 } from './playwright-test-fixtures';
import * as path from 'path';

const tests = {
  'a.test.ts': `
    import { test, expect } from '@playwright/test';
    test('pass', ({}) => {});
  `,
  'b.test.ts': `
    import { test, expect } from '@playwright/test';
    test('pass', ({}) => {});
  `,
  'c.test.ts': `
    import { test, expect } from '@playwright/test';
    test('pass', ({}) => {});
  `
};

test('should run all three tests', async ({ runInlineTest }) => {
  const result = await runInlineTest(tests);
  expect(result.passed).toBe(3);
  expect(result.exitCode).toBe(0);
});

test('should ignore a test', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    ...tests,
    'playwright.config.ts': `
      module.exports = { testIgnore: 'b.test.ts' };
    `,
  });
  expect(result.passed).toBe(2);
  expect(result.exitCode).toBe(0);
});

test('should ignore a folder', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'playwright.config.ts': `
      module.exports = { testIgnore: 'folder/**' };
    `,
    'a.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'folder/a.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'folder/b.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'folder/c.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `
  });
  expect(result.passed).toBe(1);
  expect(result.exitCode).toBe(0);
});

test('should ignore a node_modules', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'a.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'node_modules/a.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'node_modules/b.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'folder/c.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `
  });
  expect(result.passed).toBe(2);
  expect(result.exitCode).toBe(0);
});

test('should filter tests', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    ...tests,
    'playwright.config.ts': `
      module.exports = { testIgnore: 'c.test.*' };
    `,
  });
  expect(result.passed).toBe(2);
  expect(result.exitCode).toBe(0);
});

test('should use a different test match', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    ...tests,
    'playwright.config.ts': `
      module.exports = { testMatch: '[a|b].test.ts' };
    `,
  });
  expect(result.passed).toBe(2);
  expect(result.exitCode).toBe(0);
});

test('should use an array for testMatch', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'playwright.config.ts': `
      module.exports = { testMatch: ['b.test.ts', /\\${path.sep}a.[tes]{4}.TS$/i] };
    `,
    'dir/a.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'b.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'c.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `
  });
  expect(result.passed).toBe(2);
  expect(result.report.suites.map(s => s.file).sort()).toEqual(['b.test.ts', 'dir/a.test.ts']);
  expect(result.exitCode).toBe(0);
});

test('should match absolute path', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'playwright.config.ts': `
      import * as path from 'path';
      module.exports = { testDir: path.join(__dirname, 'dir'), testMatch: /dir\\${path.sep}a/ };
    `,
    'dir/a.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'dir/b.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'a.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `
  });
  expect(result.passed).toBe(1);
  expect(result.report.suites.map(s => s.file).sort()).toEqual(['a.test.ts']);
  expect(result.exitCode).toBe(0);
});

test('should match cli string argument', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'playwright.config.ts': `
      import * as path from 'path';
      module.exports = { testDir: path.join(__dirname, 'dir') };
    `,
    'dir/a.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'dir/b.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'a.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `
  }, {}, {}, { additionalArgs: [`dir\\${path.sep}a`] });
  expect(result.passed).toBe(1);
  expect(result.report.suites.map(s => s.file).sort()).toEqual(['a.test.ts']);
  expect(result.exitCode).toBe(0);
});

test('should match regex string argument', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'dir/filea.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'dir/fileb.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'filea.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `
  }, {}, {}, { additionalArgs: ['/filea.*ts/'] });
  expect(result.passed).toBe(2);
  expect(result.report.suites.map(s => s.file).sort()).toEqual(['dir/filea.test.ts', 'filea.test.ts']);
  expect(result.exitCode).toBe(0);
});

test('should match regex string with a colon argument', async ({ runInlineTest }) => {
  test.skip(process.platform === 'win32', 'Windows does not support colons in the file name');
  const result = await runInlineTest({
    'fileb.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'weird:file.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `
  }, {}, {}, { additionalArgs: ['/weird:file\.test\.ts/'] });
  expect(result.passed).toBe(1);
  expect(result.report.suites.map(s => s.file).sort()).toEqual(['weird:file.test.ts']);
  expect(result.exitCode).toBe(0);
});

test('should match case insensitive', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'capital/A.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'lowercase/a.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'b.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `
  }, {}, {}, { additionalArgs: ['a.test.ts'] });
  expect(result.passed).toBe(2);
  expect(result.report.suites.map(s => s.file).sort()).toEqual(['capital/A.test.ts', 'lowercase/a.test.ts']);
  expect(result.exitCode).toBe(0);
});

test('should match by directory', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'dir-a/file.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'dir-b/file1.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'dir-b/file2.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'file.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `
  }, {}, {}, { additionalArgs: ['dir-b'] });
  expect(result.passed).toBe(2);
  expect(result.report.suites.map(s => s.file).sort()).toEqual(['dir-b/file1.test.ts', 'dir-b/file2.test.ts']);
  expect(result.exitCode).toBe(0);
});

test('should ignore node_modules even with custom testIgnore', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'playwright.config.ts': `
      module.exports = { testIgnore: 'a.test.ts' };
    `,
    'a.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'node_modules/a.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'node_modules/b.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'folder/c.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `
  });
  expect(result.passed).toBe(1);
  expect(result.exitCode).toBe(0);
});

test('should only match files with JS/TS file extensions', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    'playwright.config.ts': `
      module.exports = { testMatch: /foobar/ };
    `,
    'foobar.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'foobar.test.js': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'foobar.test.ts-snapshots/compares-page-screenshot-chromium-linux-test-chromium.png': `
      <S0MeTh1ngN0nPArsAble!
    `
  });
  expect(result.exitCode).toBe(0);
  expect(result.passed).toBe(2);
});

test('should match dot-files', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    '.a.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
  });
  expect(result.passed).toBe(1);
  expect(result.report.suites.map(s => s.file).sort()).toEqual(['.a.test.ts']);
  expect(result.exitCode).toBe(0);
});

test('should match in dot-directories', async ({ runInlineTest }) => {
  const result = await runInlineTest({
    '.dir/a.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    '.dir/b.test.js': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
  });
  expect(result.passed).toBe(2);
  expect(result.report.suites.map(s => s.file).sort()).toEqual(['.dir/a.test.ts', '.dir/b.test.js']);
  expect(result.exitCode).toBe(0);
});

test('should always work with unix separators', async ({ runInlineTest }) => {
  // Cygwin or Git Bash might send us a path with unix separators.
  const result = await runInlineTest({
    'playwright.config.ts': `
      import * as path from 'path';
      module.exports = { testDir: path.join(__dirname, 'dir') };
    `,
    'dir/a.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'dir/b.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `,
    'a.test.ts': `
      import { test, expect } from '@playwright/test';
      test('pass', ({}) => {});
    `
  }, {}, {}, { additionalArgs: [`dir/a`] });
  expect(result.passed).toBe(1);
  expect(result.report.suites.map(s => s.file).sort()).toEqual(['a.test.ts']);
  expect(result.exitCode).toBe(0);
});