-
Notifications
You must be signed in to change notification settings - Fork 2.2k
/
cypress.impl.ts
196 lines (175 loc) · 5.38 KB
/
cypress.impl.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
import 'dotenv/config';
import { basename, dirname, join } from 'path';
import { installedCypressVersion } from '../../utils/cypress-version';
import {
ExecutorContext,
logger,
parseTargetString,
readTargetOptions,
runExecutor,
stripIndents,
} from '@nrwl/devkit';
const Cypress = require('cypress'); // @NOTE: Importing via ES6 messes the whole test dependencies.
export type Json = { [k: string]: any };
export interface CypressExecutorOptions extends Json {
baseUrl: string;
cypressConfig: string;
devServerTarget: string;
headless: boolean;
exit: boolean;
parallel: boolean;
record: boolean;
key?: string;
tsConfig: string;
watch: boolean;
browser?: string;
env?: Record<string, string>;
spec?: string;
copyFiles?: string;
ciBuildId?: string;
group?: string;
ignoreTestFiles?: string;
reporter?: string;
reporterOptions?: string;
skipServe: boolean;
testingType?: 'component' | 'e2e';
}
export default async function cypressExecutor(
options: CypressExecutorOptions,
context: ExecutorContext
) {
options = normalizeOptions(options, context);
let success;
for await (const baseUrl of startDevServer(options, context)) {
try {
success = await runCypress(baseUrl, options);
if (!options.watch) break;
} catch (e) {
logger.error(e.message);
success = false;
if (!options.watch) break;
}
}
return { success };
}
function normalizeOptions(
options: CypressExecutorOptions,
context: ExecutorContext
) {
options.env = options.env || {};
if (options.tsConfig) {
options.env.tsConfig = join(context.root, options.tsConfig);
}
checkSupportedBrowser(options);
return options;
}
function checkSupportedBrowser({ browser }: CypressExecutorOptions) {
// Browser was not passed in as an option, cypress will use whatever default it has set and we dont need to check it
if (!browser) {
return;
}
if (installedCypressVersion() >= 4 && browser == 'canary') {
logger.warn(stripIndents`
Warning:
You are using a browser that is not supported by cypress v4+.
Read here for more info:
https://docs.cypress.io/guides/references/migration-guide.html#Launching-Chrome-Canary-with-browser
`);
return;
}
const supportedV3Browsers = ['electron', 'chrome', 'canary', 'chromium'];
if (
installedCypressVersion() <= 3 &&
!supportedV3Browsers.includes(browser)
) {
logger.warn(stripIndents`
Warning:
You are using a browser that is not supported by cypress v3.
`);
return;
}
}
async function* startDevServer(
opts: CypressExecutorOptions,
context: ExecutorContext
) {
// no dev server, return the provisioned base url
if (!opts.devServerTarget || opts.skipServe) {
yield opts.baseUrl;
return;
}
const { project, target, configuration } = parseTargetString(
opts.devServerTarget
);
const devServerTargetOpts = readTargetOptions(
{ project, target, configuration },
context
);
const targetSupportsWatchOpt = Object.keys(devServerTargetOpts).includes(
'watch'
);
for await (const output of await runExecutor<{
success: boolean;
baseUrl?: string;
}>(
{ project, target, configuration },
// @NOTE: Do not forward watch option if not supported by the target dev server,
// this is relevant for running Cypress against dev server target that does not support this option,
// for instance @nguniversal/builders:ssr-dev-server.
targetSupportsWatchOpt ? { watch: opts.watch } : {},
context
)) {
if (!output.success && !opts.watch)
throw new Error('Could not compile application files');
yield opts.baseUrl || (output.baseUrl as string);
}
}
/**
* @whatItDoes Initialize the Cypress test runner with the provided project configuration.
* If `headless` is `false`: open the Cypress application, the user will
* be able to interact directly with the application.
* If `headless` is `true`: Cypress will run in headless mode and will
* provide directly the results in the console output.
*/
async function runCypress(baseUrl: string, opts: CypressExecutorOptions) {
// Cypress expects the folder where a `cypress.json` is present
const projectFolderPath = dirname(opts.cypressConfig);
const options: any = {
project: projectFolderPath,
configFile: basename(opts.cypressConfig),
};
// If not, will use the `baseUrl` normally from `cypress.json`
if (baseUrl) {
options.config = { baseUrl };
}
if (opts.browser) {
options.browser = opts.browser;
}
if (opts.env) {
options.env = opts.env;
}
if (opts.spec) {
options.spec = opts.spec;
}
options.exit = opts.exit;
options.headed = !opts.headless;
options.headless = opts.headless;
options.record = opts.record;
options.key = opts.key;
options.parallel = opts.parallel;
options.ciBuildId = opts.ciBuildId;
options.group = opts.group;
options.ignoreTestFiles = opts.ignoreTestFiles;
options.reporter = opts.reporter;
options.reporterOptions = opts.reporterOptions;
options.testingType = opts.testingType;
const result = await (!opts.watch || opts.headless
? Cypress.run(options)
: Cypress.open(options));
/**
* `cypress.open` is returning `0` and is not of the same type as `cypress.run`.
* `cypress.open` is the graphical UI, so it will be obvious to know what wasn't
* working. Forcing the build to success when `cypress.open` is used.
*/
return !result.totalFailed && !result.failures;
}