Playwright + Chrome Test Runner

1import { Actor } from 'apify';
2import log from '@apify/log';
3import { Dictionary } from 'apify-client';
4import fs from 'fs';
5import path from 'path';
6import { execSync } from 'child_process';
7import { collectAttachmentPaths, transformToTabular } from './transform';
8
9function ensureFolder(pathname: string) {
10    if (!fs.existsSync(pathname)) {
11        fs.mkdirSync(pathname, { recursive: true });
12    }
13}
14
15function getConfigPath(){
16    return `${__dirname}/../playwright.config.ts`;
17}
18
19function getResultDir(){
20    return `${__dirname}/../playwright-report`;
21}
22
23const getConfig = (options: {screen: {width: number, height: number}, headful: boolean, timeout: number, locale: string, darkMode: boolean, ignoreHTTPSErrors: boolean, video: string}) => {
24    const {screen, headful, timeout, ignoreHTTPSErrors, darkMode, locale, video} = options;
25
26    return `
27// Watch out! This file gets regenerated on every run of the actor.
28// Any changes you make will be lost.
29
30// Tweak your configuration through the Actor's input through the Apify console or directly in the \`input.json\` file.
31import { defineConfig } from '@playwright/test';
32export default defineConfig({
33    timeout: ${timeout},
34    use: {
35        headless: ${!headful},
36        viewport: { width: ${screen.width}, height: ${screen.height} },
37        ignoreHTTPSErrors: ${ignoreHTTPSErrors},
38        colorScheme: '${darkMode ? 'dark' : 'light'}',
39        locale: '${locale}',
40        video: '${video}',
41    },
42    reporter: [
43        ['html', { outputFolder: '${getResultDir()}', open: 'never' }],
44        ['json', { outputFile: '${getResultDir()}/test-results.json' }]
45    ],
46});`
47}
48function runTests() {
49    try {
50        execSync(`npx playwright test --config=${getConfigPath()}`, {
51            cwd: __dirname,
52            encoding: 'utf8',
53            stdio: 'inherit',
54        });
55    } catch (e) {
56        // suppress error, the report will be generated anyway
57    }
58}
59
60function updateConfig(args: {
61    screenWidth?: number,
62    screenHeight?: number,
63    headful?: boolean,
64    timeout?: number,
65    darkMode?: boolean,
66    locale?: string,
67    ignoreHTTPSErrors?: boolean,
68    video?: string,
69}) {
70    const {
71        screenWidth = 1280,
72        screenHeight =  720,
73        headful = false,
74        timeout = 60,
75        darkMode = false,
76        locale = 'en-US',
77        ignoreHTTPSErrors = true,
78        video = 'off'
79    } = args;
80
81    const config = getConfig({screen: { width: screenWidth, height: screenHeight }, headful, timeout: timeout * 1000, locale, darkMode, ignoreHTTPSErrors, video});
82    fs.writeFileSync(getConfigPath(), config, { encoding: 'utf-8' });
83}
84
85(async () => {
86    await Actor.init();
87    const input = (await Actor.getInput() ?? {}) as Dictionary;
88
89    ensureFolder(getResultDir());
90    updateConfig(input);
91
92    runTests();
93
94    const kvs = await Actor.openKeyValueStore();
95    await kvs.setValue('report', fs.readFileSync(path.join(getResultDir(), 'index.html'), { encoding: 'utf-8' }), { contentType: 'text/html' });
96    const jsonReport = JSON.parse(fs.readFileSync(path.join(getResultDir(), 'test-results.json'), { encoding: 'utf-8' }));
97    const attachmentPaths = collectAttachmentPaths(jsonReport);
98
99    const attachmentLinks = await Promise.all(attachmentPaths.map(async (x) => {
100        const attachment = fs.readFileSync(x.path);
101        await kvs.setValue(x.key, attachment, { contentType: x.type ?? 'application/octet' });
102        return {...x, url: await kvs.getPublicUrl(x.key)};
103    }));
104
105    await Actor.pushData(transformToTabular(jsonReport, attachmentLinks));
106
107    const reportURL = await kvs.getPublicUrl('report');
108    log.info('The test run has finished! The report is available in the Output tab or at the link below:');
109    console.log(reportURL);
110
111    await Actor.exit();
112})();