playwright/tests/playwright-test/store.spec.ts
2023-03-17 11:50:44 -07:00

338 lines
11 KiB
TypeScript

/**
* 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 fs from 'fs';
import path from 'path';
import { expect, test } from './playwright-test-fixtures';
test('should provide _store fixture', async ({ runInlineTest }) => {
const result = await runInlineTest({
'playwright.config.js': `
module.exports = {};
`,
'a.test.ts': `
import { test, _store, expect } from '@playwright/test';
test('should _store number', async ({ }) => {
expect(_store).toBeTruthy();
expect(await _store.get('number.json')).toBe(undefined);
await _store.set('number.json', 2022)
expect(await _store.get('number.json')).toBe(2022);
});
test('should _store object', async ({ }) => {
expect(_store).toBeTruthy();
expect(await _store.get('object.json')).toBe(undefined);
await _store.set('object.json', { 'a': 2022 })
expect(await _store.get('object.json')).toEqual({ 'a': 2022 });
});
`,
}, { workers: 1 });
expect(result.exitCode).toBe(0);
expect(result.passed).toBe(2);
});
test('should share _store state between project setup and tests', async ({ runInlineTest }) => {
const result = await runInlineTest({
'playwright.config.js': `
module.exports = {
projects: [
{
name: 'p1',
testMatch: /.*_store.setup.ts/
},
{
name: 'p2',
dependencies: ['p1'],
testMatch: /.*.test.ts/
}
]
};
`,
'_store.setup.ts': `
import { test, _store, expect } from '@playwright/test';
test('should initialize _store', async ({ }) => {
expect(await _store.get('number.json')).toBe(undefined);
await _store.set('number.json', 2022)
expect(await _store.get('number.json')).toBe(2022);
expect(await _store.get('object.json')).toBe(undefined);
await _store.set('object.json', { 'a': 2022 })
expect(await _store.get('object.json')).toEqual({ 'a': 2022 });
});
`,
'a.test.ts': `
import { test, _store, expect } from '@playwright/test';
test('should get data from setup', async ({ }) => {
expect(await _store.get('number.json')).toBe(2022);
expect(await _store.get('object.json')).toEqual({ 'a': 2022 });
});
`,
'b.test.ts': `
import { test, _store, expect } from '@playwright/test';
test('should get data from setup', async ({ }) => {
expect(await _store.get('number.json')).toBe(2022);
expect(await _store.get('object.json')).toEqual({ 'a': 2022 });
});
`,
}, { workers: 1 });
expect(result.exitCode).toBe(0);
expect(result.passed).toBe(3);
});
test('should persist _store state between project runs', async ({ runInlineTest }) => {
const files = {
'playwright.config.js': `
module.exports = { };
`,
'a.test.ts': `
import { test, _store, expect } from '@playwright/test';
test('should have no data on first run', async ({ }) => {
expect(await _store.get('number.json')).toBe(undefined);
await _store.set('number.json', 2022)
expect(await _store.get('object.json')).toBe(undefined);
await _store.set('object.json', { 'a': 2022 })
});
`,
'b.test.ts': `
import { test, _store, expect } from '@playwright/test';
test('should get data from previous run', async ({ }) => {
expect(await _store.get('number.json')).toBe(2022);
expect(await _store.get('object.json')).toEqual({ 'a': 2022 });
});
`,
};
{
const result = await runInlineTest(files, { grep: 'should have no data on first run' });
expect(result.exitCode).toBe(0);
expect(result.passed).toBe(1);
}
{
const result = await runInlineTest(files, { grep: 'should get data from previous run' });
expect(result.exitCode).toBe(0);
expect(result.passed).toBe(1);
}
});
test('should load context storageState from _store', async ({ runInlineTest, server }) => {
server.setRoute('/setcookie.html', (req, res) => {
res.setHeader('Set-Cookie', ['a=v1']);
res.end();
});
const result = await runInlineTest({
'playwright.config.js': `
module.exports = {
projects: [
{
name: 'setup',
testMatch: /.*_store.setup.ts/
},
{
name: 'p2',
dependencies: ['setup'],
testMatch: /.*.test.ts/
}
]
};
`,
'_store.setup.ts': `
import { test, _store, expect } from '@playwright/test';
test('should save storageState', async ({ page, context }) => {
expect(await _store.get('user')).toBe(undefined);
await page.goto('${server.PREFIX}/setcookie.html');
const state = await page.context().storageState();
await _store.set('user.json', state);
});
`,
'a.test.ts': `
import { test, _store, expect } from '@playwright/test';
test.use({
storageState: async ({}, use) => use(_store.get('user.json'))
})
test('should get data from setup', async ({ page }) => {
await page.goto('${server.EMPTY_PAGE}');
const cookies = await page.evaluate(() => document.cookie);
expect(cookies).toBe('a=v1');
});
`,
'b.test.ts': `
import { test, expect } from '@playwright/test';
test('should not get data from setup if not configured', async ({ page }) => {
await page.goto('${server.EMPTY_PAGE}');
const cookies = await page.evaluate(() => document.cookie);
expect(cookies).toBe('');
});
`,
}, { workers: 1 });
expect(result.exitCode).toBe(0);
expect(result.passed).toBe(3);
});
test('should load value from filesystem', async ({ runInlineTest }) => {
const _storeDir = test.info().outputPath('playwright');
const file = path.join(_storeDir, 'foo/bar.json');
await fs.promises.mkdir(path.dirname(file), { recursive: true });
await fs.promises.writeFile(file, JSON.stringify({ 'a': 2023 }));
const result = await runInlineTest({
'playwright.config.js': `
module.exports = {};
`,
'a.test.ts': `
import { test, _store, expect } from '@playwright/test';
test('should _store number', async ({ }) => {
expect(await _store.get('foo/bar.json')).toEqual({ 'a': 2023 });
});
`,
}, { workers: 1 });
expect(result.exitCode).toBe(0);
expect(result.passed).toBe(1);
});
test('should return root path', async ({ runInlineTest }) => {
const _storeDir = test.info().outputPath('playwright');
const result = await runInlineTest({
'playwright.config.js': `
module.exports = {};
`,
'a.test.ts': `
import { test, _store, expect } from '@playwright/test';
test('should _store number', async ({ }) => {
expect(_store.root()).toBe('${_storeDir.replace(/\\/g, '\\\\')}');
});
`,
}, { workers: 1 });
expect(result.exitCode).toBe(0);
expect(result.passed).toBe(1);
});
test('should work in global setup and teardown', async ({ runInlineTest }) => {
const result = await runInlineTest({
'playwright.config.ts': `
import * as path from 'path';
module.exports = {
globalSetup: 'globalSetup.ts',
globalTeardown: 'globalTeardown.ts',
};
`,
'globalSetup.ts': `
import { _store, expect } from '@playwright/test';
module.exports = async () => {
expect(_store).toBeTruthy();
await _store.set('foo/bar.json', {'a': 2023});
};
`,
'globalTeardown.ts': `
import { _store, expect } from '@playwright/test';
module.exports = async () => {
const val = await _store.get('foo/bar.json');
console.log('teardown=' + val);
};
`,
'a.test.ts': `
import { test, _store, expect } from '@playwright/test';
test('should read value from global setup', async ({ }) => {
expect(await _store.get('foo/bar.json')).toEqual({ 'a': 2023 });
await _store.set('foo/bar.json', 'from test');
});
`,
}, { workers: 1 });
expect(result.exitCode).toBe(0);
expect(result.passed).toBe(1);
});
test('_store root can be changed with TestConfig._storeDir', async ({ runInlineTest }) => {
const result = await runInlineTest({
'playwright.config.ts': `
import * as path from 'path';
module.exports = {
_storeDir: 'my/_store/dir',
};
`,
'a.test.ts': `
import { test, _store, expect } from '@playwright/test';
test('should _store value', async ({ }) => {
await _store.set('foo/bar.json', {'a': 2023});
});
test('should read value', async ({ }) => {
expect(await _store.get('foo/bar.json')).toEqual({ 'a': 2023 });
});
`,
}, { workers: 1 });
expect(result.exitCode).toBe(0);
expect(result.passed).toBe(2);
const file = path.join(test.info().outputPath(), 'my/_store/dir/foo/bar.json');
expect(JSON.parse(await fs.promises.readFile(file, 'utf-8'))).toEqual({ 'a': 2023 });
});
test('should delete value', async ({ runInlineTest }) => {
const result = await runInlineTest({
'a.test.ts': `
import { test, _store, expect } from '@playwright/test';
test('should _store value', async ({ }) => {
await _store.set('foo/bar.json', {'a': 2023});
expect(await _store.get('foo/bar.json')).toEqual({ 'a': 2023 });
await _store.delete('foo/bar.json');
expect(await _store.get('foo/bar.json')).toBe(undefined);
});
`,
}, { workers: 1 });
expect(result.exitCode).toBe(0);
expect(result.passed).toBe(1);
});
test('should support text, json and binary values', async ({ runInlineTest }) => {
const result = await runInlineTest({
'a.test.ts': `
import { test, _store, expect } from '@playwright/test';
test('json', async ({ }) => {
await _store.set('key.json', {'a': 2023});
expect(await _store.get('key.json')).toEqual({ 'a': 2023 });
});
test('text', async ({ }) => {
await _store.set('key.txt', 'Hello');
expect(await _store.get('key.txt')).toEqual('Hello');
});
test('binary', async ({ }) => {
const buf = Buffer.alloc(256);
for (let i = 0; i < 256; i++)
buf[i] = i;
await _store.set('key.png', buf);
expect(await _store.get('key.png')).toEqual(buf);
});
`,
}, { workers: 1 });
expect(result.exitCode).toBe(0);
expect(result.passed).toBe(3);
});
test('should throw on unsupported value type for given key extension', async ({ runInlineTest }) => {
const result = await runInlineTest({
'a.test.ts': `
import { test, _store, expect } from '@playwright/test';
test('json', async ({ }) => {
const buf = Buffer.alloc(5);
await _store.set('key.json', buf);
});
test('text', async ({ }) => {
await _store.set('key.txt', {});
});
test('binary', async ({ }) => {
await _store.set('key.png', {});
});
`,
}, { workers: 1 });
expect(result.exitCode).toBe(1);
expect(result.failed).toBe(3);
});