Cypress

1// Apify SDK - toolkit for building Apify Actors (Read more at https://docs.apify.com/sdk/js/)
2import { Actor } from 'apify';
3import fs from 'fs';
4
5// Component and E2E testing library (read more at https://docs.cypress.io/guides/overview/why-cypress)
6import cypress from 'cypress';
7// File system traversing library (read more at https://www.jsdocs.io/package/globby)
8import { globby } from 'globby';
9// Apify logging utility library
10import log from '@apify/log';
11// Library for console logging tables
12import 'console.table';
13
14// this is ESM project, and as such, it requires you to specify extensions in your relative imports
15// read more about this here: https://nodejs.org/docs/latest-v18.x/api/esm.html#mandatory-file-extensions
16// import { router } from './routes.js';
17
18// Helper function to run tests from specific test file with given configuration from INPUT.json
19const runOneSpec = (spec) => cypress.run({ config: input, spec });
20
21// The init() call configures the Actor for its environment. It's recommended to start every Actor with an init()
22await Actor.init();
23
24// Define the configuration to start the cypress test with - get it from the input of the Actor or use a default config.
25const input = await Actor.getInput() || { baseUrl: "https://apify.com", video: true };
26log.info(`Running tests with following input: ${JSON.stringify(input)}`);
27
28// Get cypress test files from ./cypress/e2e that end with spec.cy.js
29const tests = await globby('./cypress/e2e/*-spec.cy.js');
30log.info(`Getting tests: ${tests}`);
31
32const testsResultsSummary = [];
33
34// Opens an instance of Key-value store (read more https://docs.apify.com/sdk/js/reference/class/Actor#openKeyValueStore)
35const kvs = await Actor.openKeyValueStore();
36// Opens an instance of Dataset (read more https://docs.apify.com/sdk/js/reference/class/Actor#openDataset)
37const dataset = await Actor.openDataset();
38
39// Run tests one by one
40for (const test of tests) {
41    const result = await runOneSpec(test);
42    let keyValueStoreLink;
43    // Save video recording of the test to Key-value store
44    if (result?.config?.video) {
45        const baseName = test.split('/').pop();
46        const file = `./cypress/videos/${baseName}.mp4`;
47        const kvsKeyName = baseName.replaceAll('.', '-');
48        // Saves video to Key-value store under kvsKeyName (read more at https://docs.apify.com/sdk/js/reference/class/KeyValueStore#setValue)
49        await kvs.setValue(kvsKeyName, fs.readFileSync(file), { contentType: 'video/mp4' });
50        keyValueStoreLink = kvs.getPublicUrl(kvsKeyName);
51    }
52
53    // Transform the test results
54    const transformedResult = {
55        testSuiteTitle: result.runs[0].tests ? result.runs[0].tests[0].title[0] : result.runs[0].spec.baseName,
56        totalPassed: result.totalPassed,
57        totalPending: result.totalPending,
58        totalFailed: result.totalFailed,
59        totalSkipped: result.totalSkipped,
60        totalDuration: result.totalDuration,
61        videoLink: keyValueStoreLink,
62        rawData: result,
63    };
64
65    // Save transformed test results to Dataset (read more at https://docs.apify.com/sdk/js/reference/class/Dataset#pushData)
66    await dataset.pushData(transformedResult);
67    testsResultsSummary.push(transformedResult);
68}
69
70// Create a loggable test summary
71const summary = testsResultsSummary
72    .map((test) => {
73        return {
74            spec: test?.testSuiteTitle,
75            passes: test?.totalPassed,
76            failures: test?.totalFailed,
77            pending: test?.totalPending,
78            skipped: test?.totalSkipped,
79            duration: test?.totalDuration,
80        };
81    });
82
83// Log the summary as a table
84console.table('Summary', summary);
85
86// Gracefully exit the Actor process. It's recommended to quit all Actors with an exit()
87await Actor.exit();