/** * 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 { expect, test } from './playwright-test-fixtures'; /** * Test cases: * - `a1.spec.ts`: 4 tests (default mode) * - `a2.spec.ts`: 2 tests (parallel mode) * - `a3.spec.ts`: 2 tests (parallel mode) * - `a4.spec.ts`: 2 tests (default mode) * * Test Groups distribution for 2 shards * ``` * [a1-test1, a1-test2, a1-test3, a1-test4], [a2-test1], [a2-test2], [a3-test1], [a3-test2], [a4-test1, a4-test2] * Shard 1/2: ^^^^^^^1 ^^^^^^^1 ^^^^^^^1 ^^^^^^^1 ^^^^^^^5 * Shard 2/2: ^^^^^^^3 ^^^^^^^4 ^^^^^^^6 ^^^^^^^2 ^^^^^^^2 * ``` * * Test Groups distribution for 3 shards * ``` * [a1-test1, a1-test2, a1-test3, a1-test4], [a2-test1], [a2-test2], [a3-test1], [a3-test2], [a4-test1, a4-test2] * Shard 1/3: ^^^^^^^1 ^^^^^^^1 ^^^^^^^1 ^^^^^^^1 * Shard 2/3: ^^^^^^^5 ^^^^^^^2 ^^^^^^^2 * Shard 3/3: ^^^^^^^3 ^^^^^^^4 ^^^^^^^6 * ``` * * Test Groups distribution for 4 shards * ``` * [a1-test1, a1-test2, a1-test3, a1-test4], [a2-test1], [a2-test2], [a3-test1], [a3-test2], [a4-test1, a4-test2] * Shard 1/4: ^^^^^^^1 ^^^^^^^1 ^^^^^^^1 ^^^^^^^1 * Shard 2/4: ^^^^^^^2 ^^^^^^^2 * Shard 3/4: ^^^^^^^3 ^^^^^^^5 * Shard 4/4: ^^^^^^^4 ^^^^^^^6 * ``` * * Test Groups distribution for 4 shards with fully-parallel * ``` * [a1-test1, a1-test2, a1-test3, a1-test4], [a2-test1], [a2-test2], [a3-test1], [a3-test2], [a4-test1, a4-test2] * Shard 1/4: ^^^^^^^1 ^^^^^^^5 ^^^^^^^9 * Shard 2/4: ^^^^^^^2 ^^^^^^^6 ^^^^^^10 * Shard 3/4: ^^^^^^^3 ^^^^^^^7 ^^^^^^11 * Shard 4/4: ^^^^^^^4 ^^^^^^^8 * ``` */ const tests = { 'a1.spec.ts': ` import { test } from '@playwright/test'; test('test1', async () => { console.log('\\n%%a1-test1-done'); }); test('test2', async () => { console.log('\\n%%a1-test2-done'); }); test('test3', async () => { console.log('\\n%%a1-test3-done'); }); test('test4', async () => { console.log('\\n%%a1-test4-done'); }); `, 'a2.spec.ts': ` import { test } from '@playwright/test'; test.describe.configure({ mode: 'parallel' }); test('test1', async () => { console.log('\\n%%a2-test1-done'); }); test('test2', async () => { console.log('\\n%%a2-test2-done'); }); `, 'a3.spec.ts': ` import { test } from '@playwright/test'; test.describe.configure({ mode: 'parallel' }); test('test1', async () => { console.log('\\n%%a3-test1-done'); }); test('test2', async () => { console.log('\\n%%a3-test2-done'); }); `, 'a4.spec.ts': ` import { test } from '@playwright/test'; test('test1', async () => { console.log('\\n%%a4-test1-done'); }); test('test2', async () => { console.log('\\n%%a4-test2-done'); }); `, }; test('should respect shard=1/2', async ({ runInlineTest }) => { const result = await runInlineTest(tests, { ['sharding-mode']: 'round-robin', shard: '1/2', workers: 1 }); expect(result.exitCode).toBe(0); expect(result.passed).toBe(5); expect(result.skipped).toBe(0); expect(result.outputLines).toEqual([ 'a1-test1-done', 'a1-test2-done', 'a1-test3-done', 'a1-test4-done', 'a3-test1-done', ]); }); test('should respect shard=2/2', async ({ runInlineTest }) => { const result = await runInlineTest(tests, { ['sharding-mode']: 'round-robin', shard: '2/2', workers: 1 }); expect(result.exitCode).toBe(0); expect(result.passed).toBe(5); expect(result.skipped).toBe(0); expect(result.outputLines).toEqual([ 'a2-test1-done', 'a2-test2-done', 'a3-test2-done', 'a4-test1-done', 'a4-test2-done', ]); }); test('should respect shard=1/3', async ({ runInlineTest }) => { const result = await runInlineTest(tests, { ['sharding-mode']: 'round-robin', shard: '1/3', workers: 1 }); expect(result.exitCode).toBe(0); expect(result.passed).toBe(4); expect(result.skipped).toBe(0); expect(result.outputLines).toEqual([ 'a1-test1-done', 'a1-test2-done', 'a1-test3-done', 'a1-test4-done', ]); }); test('should respect shard=2/3', async ({ runInlineTest }) => { const result = await runInlineTest(tests, { ['sharding-mode']: 'round-robin', shard: '2/3', workers: 1 }); expect(result.exitCode).toBe(0); expect(result.passed).toBe(3); expect(result.skipped).toBe(0); expect(result.outputLines).toEqual([ 'a3-test1-done', 'a4-test1-done', 'a4-test2-done', ]); }); test('should respect shard=3/3', async ({ runInlineTest }) => { const result = await runInlineTest(tests, { ['sharding-mode']: 'round-robin', shard: '3/3', workers: 1 }); expect(result.exitCode).toBe(0); expect(result.passed).toBe(3); expect(result.skipped).toBe(0); expect(result.outputLines).toEqual([ 'a2-test1-done', 'a2-test2-done', 'a3-test2-done', ]); }); test('should respect shard=1/4', async ({ runInlineTest }) => { const result = await runInlineTest(tests, { ['sharding-mode']: 'round-robin', shard: '1/4', workers: 1 }); expect(result.exitCode).toBe(0); expect(result.passed).toBe(4); expect(result.skipped).toBe(0); expect(result.outputLines).toEqual([ 'a1-test1-done', 'a1-test2-done', 'a1-test3-done', 'a1-test4-done', ]); }); test('should respect shard=2/4', async ({ runInlineTest }) => { const result = await runInlineTest(tests, { ['sharding-mode']: 'round-robin', shard: '2/4', workers: 1 }); expect(result.exitCode).toBe(0); expect(result.passed).toBe(2); expect(result.skipped).toBe(0); expect(result.outputLines).toEqual([ 'a4-test1-done', 'a4-test2-done', ]); }); test('should respect shard=3/4', async ({ runInlineTest }) => { const result = await runInlineTest(tests, { ['sharding-mode']: 'round-robin', shard: '3/4', workers: 1 }); expect(result.exitCode).toBe(0); expect(result.passed).toBe(2); expect(result.skipped).toBe(0); expect(result.outputLines).toEqual([ 'a2-test1-done', 'a3-test1-done', ]); }); test('should respect shard=4/4', async ({ runInlineTest }) => { const result = await runInlineTest(tests, { ['sharding-mode']: 'round-robin', shard: '4/4', workers: 1 }); expect(result.exitCode).toBe(0); expect(result.passed).toBe(2); expect(result.skipped).toBe(0); expect(result.outputLines).toEqual([ 'a2-test2-done', 'a3-test2-done', ]); }); test('should respect shard=1/2 in config', async ({ runInlineTest }) => { const result = await runInlineTest({ ...tests, 'playwright.config.js': ` module.exports = { shardingMode: 'round-robin', shard: { current: 1, total: 2 } }; `, }, { workers: 1 }); expect(result.exitCode).toBe(0); expect(result.passed).toBe(5); expect(result.skipped).toBe(0); expect(result.outputLines).toEqual([ 'a1-test1-done', 'a1-test2-done', 'a1-test3-done', 'a1-test4-done', 'a3-test1-done', ]); }); test('should work with workers=1 and --fully-parallel', async ({ runInlineTest }) => { test.info().annotations.push({ type: 'issue', description: 'https://github.com/microsoft/playwright/issues/21226' }); const tests = { 'a1.spec.ts': ` import { test } from '@playwright/test'; test('should pass', async ({ }) => { }); `, 'a2.spec.ts': ` import { test } from '@playwright/test'; test('should pass', async ({ }) => { }); test.skip('should skip', async ({ }) => { }); `, }; { const result = await runInlineTest(tests, { ['sharding-mode']: 'round-robin', shard: '1/2', ['fully-parallel']: true, workers: 1 }); expect(result.exitCode).toBe(0); expect(result.passed).toBe(1); expect(result.skipped).toBe(1); } { const result = await runInlineTest(tests, { ['sharding-mode']: 'round-robin', shard: '2/2', ['fully-parallel']: true, workers: 1 }); expect(result.exitCode).toBe(0); expect(result.passed).toBe(1); expect(result.skipped).toBe(0); } }); test('should not shard mode:serial suites when fully-parallel', async ({ runInlineTest }) => { const tests = { 'a1.spec.ts': ` import { test } from '@playwright/test'; test.describe.configure({ mode: 'serial' }); test('test1', async ({ }) => { console.log('\\n%%a1-test1-done'); }); test('test2', async ({ }) => { console.log('\\n%%a1-test2-done'); }); test('test3', async ({ }) => { console.log('\\n%%a1-test3-done'); }); `, 'a2.spec.ts': ` import { test } from '@playwright/test'; test.describe(() => { test('test1', async ({ }) => { console.log('\\n%%a2-test1-done'); }); test('test2', async ({ }) => { console.log('\\n%%a2-test2-done'); }); }); `, 'a3.spec.ts': ` import { test } from '@playwright/test'; test.describe(() => { test('test1', async ({ }) => { console.log('\\n%%a3-test1-done'); }); test('test2', async ({ }) => { console.log('\\n%%a3-test2-done'); }); }); `, }; { const result = await runInlineTest(tests, { ['sharding-mode']: 'round-robin', shard: '1/2', ['fully-parallel']: true, workers: 1 }); expect(result.exitCode).toBe(0); expect(result.passed).toBe(4); expect(result.outputLines).toEqual([ 'a1-test1-done', 'a1-test2-done', 'a1-test3-done', 'a3-test2-done', ]); } { const result = await runInlineTest(tests, { ['sharding-mode']: 'round-robin', shard: '2/2', ['fully-parallel']: true, workers: 1 }); expect(result.exitCode).toBe(0); expect(result.passed).toBe(3); expect(result.outputLines).toEqual([ 'a2-test1-done', 'a2-test2-done', 'a3-test1-done', ]); } { const result = await runInlineTest(tests, { ['sharding-mode']: 'round-robin', shard: '1/5', ['fully-parallel']: true, workers: 1 }); expect(result.exitCode).toBe(0); expect(result.passed).toBe(3); expect(result.outputLines).toEqual([ 'a1-test1-done', 'a1-test2-done', 'a1-test3-done', ]); } { const result = await runInlineTest(tests, { ['sharding-mode']: 'round-robin', shard: '2/5', ['fully-parallel']: true, workers: 1 }); expect(result.exitCode).toBe(0); expect(result.passed).toBe(1); expect(result.outputLines).toEqual([ 'a2-test1-done', ]); } { const result = await runInlineTest(tests, { ['sharding-mode']: 'round-robin', shard: '5/5', ['fully-parallel']: true, workers: 1 }); expect(result.exitCode).toBe(0); expect(result.passed).toBe(1); expect(result.outputLines).toEqual([ 'a3-test2-done', ]); } });