@azure/create-playwright 1.0.0-beta.1 → 1.0.0-beta.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -11
- package/dist/commonjs/bin/init.js +6 -2
- package/dist/commonjs/bin/init.js.map +1 -1
- package/dist/commonjs/initialize.js +65 -63
- package/dist/commonjs/initialize.js.map +1 -1
- package/dist/commonjs/packageManager.js +19 -23
- package/dist/commonjs/packageManager.js.map +1 -1
- package/dist/esm/bin/init.js +6 -2
- package/dist/esm/bin/init.js.map +1 -1
- package/dist/esm/initialize.js +65 -63
- package/dist/esm/initialize.js.map +1 -1
- package/dist/esm/packageManager.js +19 -23
- package/dist/esm/packageManager.js.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -15,21 +15,20 @@ pnpm create @azure/playwright
|
|
|
15
15
|
```
|
|
16
16
|
|
|
17
17
|
## Useful Links
|
|
18
|
-
- [Quickstart: Run end-to-end tests at scale](https://aka.ms/
|
|
19
|
-
- [Quickstart: Set up continuous end-to-end testing across different browsers and operating systems](https://aka.ms/
|
|
20
|
-
- [Explore features and benefits](https://aka.ms/
|
|
21
|
-
- [
|
|
22
|
-
- [
|
|
23
|
-
- [
|
|
24
|
-
- [Share feedback](https://aka.ms/mpt/feedback)
|
|
18
|
+
- [Quickstart: Run end-to-end tests at scale](https://aka.ms/pww/docs/quickstart)
|
|
19
|
+
- [Quickstart: Set up continuous end-to-end testing across different browsers and operating systems](https://aka.ms/pww/docs/ci)
|
|
20
|
+
- [Explore features and benefits](https://aka.ms/pww/docs/about)
|
|
21
|
+
- [Documentation](https://aka.ms/pww/docs)
|
|
22
|
+
- [Pricing](https://aka.ms/pww/docs/pricing)
|
|
23
|
+
- [Share feedback](https://aka.ms/pww/docs/feedback)
|
|
25
24
|
|
|
26
25
|
## Next steps
|
|
27
26
|
|
|
28
|
-
- Run tests in a [CI/CD pipeline.](https://aka.ms/
|
|
27
|
+
- Run tests in a [CI/CD pipeline.](https://aka.ms/pww/docs/configure-pipeline)
|
|
29
28
|
|
|
30
|
-
- Learn how to [manage access](https://aka.ms/
|
|
29
|
+
- Learn how to [manage access](https://aka.ms/pww/docs/manage-access) to the created workspace.
|
|
31
30
|
|
|
32
|
-
- Experiment with different number of workers to [determine the optimal configuration of your test suite](https://aka.ms/
|
|
31
|
+
- Experiment with different number of workers to [determine the optimal configuration of your test suite](https://aka.ms/pww/docs/parallelism).
|
|
33
32
|
|
|
34
33
|
## Contributing
|
|
35
34
|
|
|
@@ -51,4 +50,4 @@ This project may contain trademarks or logos for projects, products, or services
|
|
|
51
50
|
trademarks or logos is subject to and must follow
|
|
52
51
|
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/legal/intellectualproperty/trademarks/usage/general).
|
|
53
52
|
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
|
|
54
|
-
Any use of third-party trademarks or logos is subject to those third-party's policies.
|
|
53
|
+
Any use of third-party trademarks or logos is subject to those third-party's policies.
|
|
@@ -10,10 +10,14 @@ const init = async () => {
|
|
|
10
10
|
const { config: playwrightConfigFile } = options;
|
|
11
11
|
let playwrightServiceInitConfig;
|
|
12
12
|
if (playwrightConfigFile) {
|
|
13
|
-
playwrightServiceInitConfig =
|
|
13
|
+
playwrightServiceInitConfig = {
|
|
14
|
+
...(0, utils_js_1.getLanguageAndConfigInfoFromConfigurationFile)(playwrightConfigFile),
|
|
15
|
+
};
|
|
14
16
|
}
|
|
15
17
|
else {
|
|
16
|
-
playwrightServiceInitConfig =
|
|
18
|
+
playwrightServiceInitConfig = {
|
|
19
|
+
...(0, utils_js_1.getLanguageAndConfigInfoFromDirectory)(),
|
|
20
|
+
};
|
|
17
21
|
}
|
|
18
22
|
console.log("");
|
|
19
23
|
const playwrightServiceInitialize = new initialize_js_1.PlaywrightServiceInitialize(playwrightServiceInitConfig);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../src/bin/init.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAGlC,oDAA+D;AAC/D,0CAIqB;AAEd,MAAM,IAAI,GAAG,KAAK,IAAmB,EAAE;IAC5C,MAAM,OAAO,GAAG,IAAA,4BAAiB,GAAE,CAAC;IACpC,MAAM,EAAE,MAAM,EAAE,oBAAoB,EAAE,GAAG,OAAO,CAAC;IACjD,IAAI,2BAAwD,CAAC;IAE7D,IAAI,oBAAoB,EAAE,CAAC;QACzB,2BAA2B,
|
|
1
|
+
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../src/bin/init.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAGlC,oDAA+D;AAC/D,0CAIqB;AAEd,MAAM,IAAI,GAAG,KAAK,IAAmB,EAAE;IAC5C,MAAM,OAAO,GAAG,IAAA,4BAAiB,GAAE,CAAC;IACpC,MAAM,EAAE,MAAM,EAAE,oBAAoB,EAAE,GAAG,OAAO,CAAC;IACjD,IAAI,2BAAwD,CAAC;IAE7D,IAAI,oBAAoB,EAAE,CAAC;QACzB,2BAA2B,GAAG;YAC5B,GAAG,IAAA,wDAA6C,EAAC,oBAAoB,CAAC;SACvE,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,2BAA2B,GAAG;YAC5B,GAAG,IAAA,gDAAqC,GAAE;SAC3C,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChB,MAAM,2BAA2B,GAAG,IAAI,2CAA2B,CAAC,2BAA2B,CAAC,CAAC;IACjG,MAAM,2BAA2B,CAAC,4BAA4B,EAAE,CAAC;AACnE,CAAC,CAAC;AAlBW,QAAA,IAAI,QAkBf","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PlaywrightServiceInitConfig } from \"../types.js\";\nimport { PlaywrightServiceInitialize } from \"../initialize.js\";\nimport {\n getLanguageAndConfigInfoFromConfigurationFile,\n getLanguageAndConfigInfoFromDirectory,\n parseCLIArguments,\n} from \"../utils.js\";\n\nexport const init = async (): Promise<void> => {\n const options = parseCLIArguments();\n const { config: playwrightConfigFile } = options;\n let playwrightServiceInitConfig: PlaywrightServiceInitConfig;\n\n if (playwrightConfigFile) {\n playwrightServiceInitConfig = {\n ...getLanguageAndConfigInfoFromConfigurationFile(playwrightConfigFile),\n };\n } else {\n playwrightServiceInitConfig = {\n ...getLanguageAndConfigInfoFromDirectory(),\n };\n }\n\n console.log(\"\");\n const playwrightServiceInitialize = new PlaywrightServiceInitialize(playwrightServiceInitConfig);\n await playwrightServiceInitialize.addServiceSupportToTestSuite();\n};\n"]}
|
|
@@ -24,70 +24,75 @@ const questions = [
|
|
|
24
24
|
},
|
|
25
25
|
];
|
|
26
26
|
class PlaywrightServiceInitialize {
|
|
27
|
+
_setupConfig;
|
|
28
|
+
_packageManager;
|
|
27
29
|
constructor(setupConfig) {
|
|
28
|
-
this.
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
this.
|
|
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
|
-
|
|
30
|
+
this._setupConfig = setupConfig;
|
|
31
|
+
this._packageManager = (0, packageManager_js_1.getPackageManager)();
|
|
32
|
+
}
|
|
33
|
+
addServiceSupportToTestSuite = async () => {
|
|
34
|
+
const canProceedWithServiceInitialization = await this.checkIfServiceConfigCanBeAdded(); // if service config already present, ask user for overwrite permission
|
|
35
|
+
if (!canProceedWithServiceInitialization)
|
|
36
|
+
return;
|
|
37
|
+
await this.installServicePackage(); // install service packages
|
|
38
|
+
await this.createServiceConfig(); // create service config file
|
|
39
|
+
this.displayAdditionalInformation(); // display additional information
|
|
40
|
+
};
|
|
41
|
+
checkIfServiceConfigCanBeAdded = async () => {
|
|
42
|
+
if (!this.isServiceConfigFileAlreadyPresent())
|
|
43
|
+
return true;
|
|
44
|
+
const response = (await prompts_1.default.prompt(questions, {
|
|
45
|
+
onCancel: this.promptOnCancel,
|
|
46
|
+
}));
|
|
47
|
+
if (response.canOverride)
|
|
48
|
+
return true;
|
|
49
|
+
if (!response.confirmationForExit)
|
|
50
|
+
return this.checkIfServiceConfigCanBeAdded();
|
|
51
|
+
console.log(`\n${constants_js_1.Messages.SETUP_PROCESS_EXIT_MESSAGE}`);
|
|
52
|
+
return false;
|
|
53
|
+
};
|
|
54
|
+
promptOnCancel = () => {
|
|
55
|
+
process.exit(0);
|
|
56
|
+
};
|
|
57
|
+
isServiceConfigFileAlreadyPresent = () => {
|
|
58
|
+
return node_fs_1.default.existsSync(this.getServiceConfigFileName());
|
|
59
|
+
};
|
|
60
|
+
displayAdditionalInformation = () => {
|
|
61
|
+
const runCommandParallelWorkers = this._packageManager.runCommand("playwright", `test -c ${this.getServiceConfigFileName()} --workers=20`);
|
|
62
|
+
console.log(`\n\nTo run playwrights tests using Playwright Service\n`);
|
|
63
|
+
console.log(`\t${runCommandParallelWorkers}\n`);
|
|
64
|
+
console.log("Getting Started - https://aka.ms/pww/docs/quickstart\n");
|
|
65
|
+
console.log("If you're already using the Azure Playwright service, please review the quickstart guide [https://aka.ms/pww/docs/quickstart] to ensure your tests continue running smoothly.");
|
|
66
|
+
};
|
|
67
|
+
installServicePackage = async () => {
|
|
68
|
+
const command = this._packageManager.installDevDependencyCommand("@azure/playwright @azure/identity");
|
|
69
|
+
console.log(`Installing Service package (${command})`);
|
|
70
|
+
await (0, utils_js_1.executeCommand)(command);
|
|
71
|
+
};
|
|
72
|
+
createServiceConfig = async () => {
|
|
73
|
+
const serviceConfigFile = this.getServiceConfigFileName();
|
|
74
|
+
const serviceConfigFileContent = this.getServiceConfigContent();
|
|
75
|
+
await node_fs_1.default.promises.writeFile(serviceConfigFile, serviceConfigFileContent);
|
|
76
|
+
console.log(`Success! Created service configuration file - ${serviceConfigFile}`);
|
|
77
|
+
};
|
|
78
|
+
getServiceConfigContent = () => {
|
|
79
|
+
const customerConfigFileName = (0, utils_js_1.getFileReferenceForImport)(this._setupConfig.playwrightConfigFile);
|
|
80
|
+
const importCommandTypeScript = `import { defineConfig } from '@playwright/test';
|
|
76
81
|
import { getServiceConfig, ServiceOS } from '@azure/playwright';
|
|
77
82
|
import { DefaultAzureCredential } from '@azure/identity';
|
|
78
83
|
import config from '${customerConfigFileName}';
|
|
79
84
|
`;
|
|
80
|
-
|
|
85
|
+
const importCommandJavaScript = `const { defineConfig } = require('@playwright/test');
|
|
81
86
|
const { getServiceConfig, ServiceOS } = require('@azure/playwright');
|
|
82
87
|
const { DefaultAzureCredential } = require('@azure/identity');
|
|
83
88
|
const config = require('${customerConfigFileName}');
|
|
84
89
|
`;
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
/* Learn more about service configuration at https://aka.ms/
|
|
90
|
+
const importCommand = this._setupConfig.projectLanguage === constants_js_1.Languages.TypeScript
|
|
91
|
+
? importCommandTypeScript
|
|
92
|
+
: importCommandJavaScript;
|
|
93
|
+
const content = importCommand +
|
|
94
|
+
`
|
|
95
|
+
/* Learn more about service configuration at https://aka.ms/pww/docs/config */
|
|
91
96
|
export default defineConfig(
|
|
92
97
|
config,
|
|
93
98
|
getServiceConfig(config, {
|
|
@@ -98,14 +103,11 @@ export default defineConfig(
|
|
|
98
103
|
})
|
|
99
104
|
);
|
|
100
105
|
`;
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
this._setupConfig = setupConfig;
|
|
107
|
-
this._packageManager = (0, packageManager_js_1.getPackageManager)();
|
|
108
|
-
}
|
|
106
|
+
return content;
|
|
107
|
+
};
|
|
108
|
+
getServiceConfigFileName = () => {
|
|
109
|
+
return "playwright.service.config" + constants_js_1.Extensions[this._setupConfig.projectLanguage];
|
|
110
|
+
};
|
|
109
111
|
}
|
|
110
112
|
exports.PlaywrightServiceInitialize = PlaywrightServiceInitialize;
|
|
111
113
|
//# sourceMappingURL=initialize.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"initialize.js","sourceRoot":"","sources":["../../src/initialize.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;AAGlC,8DAA8B;AAC9B,8DAAyB;AACzB,iDAAiE;AAMjE,yCAAuE;AACvE,2DAAwD;AAExD,MAAM,SAAS,GAAmB;IAChC;QACE,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,aAAa;QACnB,OAAO,EAAE,uBAAQ,CAAC,oBAAoB;QACtC,OAAO,EAAE,IAAI;KACd;IACD;QACE,IAAI,EAAE,CAAC,IAAa,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;QAClD,IAAI,EAAE,qBAAqB;QAC3B,OAAO,EAAE,uBAAQ,CAAC,6BAA6B;QAC/C,OAAO,EAAE,IAAI;KACd;CACF,CAAC;AAEF,MAAa,2BAA2B;
|
|
1
|
+
{"version":3,"file":"initialize.js","sourceRoot":"","sources":["../../src/initialize.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;;AAGlC,8DAA8B;AAC9B,8DAAyB;AACzB,iDAAiE;AAMjE,yCAAuE;AACvE,2DAAwD;AAExD,MAAM,SAAS,GAAmB;IAChC;QACE,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,aAAa;QACnB,OAAO,EAAE,uBAAQ,CAAC,oBAAoB;QACtC,OAAO,EAAE,IAAI;KACd;IACD;QACE,IAAI,EAAE,CAAC,IAAa,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;QAClD,IAAI,EAAE,qBAAqB;QAC3B,OAAO,EAAE,uBAAQ,CAAC,6BAA6B;QAC/C,OAAO,EAAE,IAAI;KACd;CACF,CAAC;AAEF,MAAa,2BAA2B;IAC9B,YAAY,CAA8B;IAC1C,eAAe,CAAiB;IAExC,YAAY,WAAwC;QAClD,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,eAAe,GAAG,IAAA,qCAAiB,GAAE,CAAC;IAC7C,CAAC;IAEM,4BAA4B,GAAG,KAAK,IAAmB,EAAE;QAC9D,MAAM,mCAAmC,GAAG,MAAM,IAAI,CAAC,8BAA8B,EAAE,CAAC,CAAC,uEAAuE;QAChK,IAAI,CAAC,mCAAmC;YAAE,OAAO;QACjD,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC,2BAA2B;QAC/D,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,6BAA6B;QAC/D,IAAI,CAAC,4BAA4B,EAAE,CAAC,CAAC,iCAAiC;IACxE,CAAC,CAAC;IAEM,8BAA8B,GAAG,KAAK,IAAsB,EAAE;QACpE,IAAI,CAAC,IAAI,CAAC,iCAAiC,EAAE;YAAE,OAAO,IAAI,CAAC;QAC3D,MAAM,QAAQ,GAAG,CAAC,MAAM,iBAAO,CAAC,MAAM,CAAC,SAAS,EAAE;YAChD,QAAQ,EAAE,IAAI,CAAC,cAAc;SAC9B,CAAC,CAA2B,CAAC;QAC9B,IAAI,QAAQ,CAAC,WAAW;YAAE,OAAO,IAAI,CAAC;QACtC,IAAI,CAAC,QAAQ,CAAC,mBAAmB;YAAE,OAAO,IAAI,CAAC,8BAA8B,EAAE,CAAC;QAEhF,OAAO,CAAC,GAAG,CAAC,KAAK,uBAAQ,CAAC,0BAA0B,EAAE,CAAC,CAAC;QACxD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEM,cAAc,GAAG,GAAU,EAAE;QACnC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC;IAEM,iCAAiC,GAAG,GAAY,EAAE;QACxD,OAAO,iBAAE,CAAC,UAAU,CAAC,IAAI,CAAC,wBAAwB,EAAE,CAAC,CAAC;IACxD,CAAC,CAAC;IAEM,4BAA4B,GAAG,GAAS,EAAE;QAChD,MAAM,yBAAyB,GAAG,IAAI,CAAC,eAAe,CAAC,UAAU,CAC/D,YAAY,EACZ,WAAW,IAAI,CAAC,wBAAwB,EAAE,eAAe,CAC1D,CAAC;QAEF,OAAO,CAAC,GAAG,CAAC,yDAAyD,CAAC,CAAC;QACvE,OAAO,CAAC,GAAG,CAAC,KAAK,yBAAyB,IAAI,CAAC,CAAC;QAEhD,OAAO,CAAC,GAAG,CAAC,wDAAwD,CAAC,CAAC;QAEtE,OAAO,CAAC,GAAG,CACT,+KAA+K,CAChL,CAAC;IACJ,CAAC,CAAC;IAEM,qBAAqB,GAAG,KAAK,IAAmB,EAAE;QACxD,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,2BAA2B,CAC9D,mCAAmC,CACpC,CAAC;QACF,OAAO,CAAC,GAAG,CAAC,+BAA+B,OAAO,GAAG,CAAC,CAAC;QACvD,MAAM,IAAA,yBAAc,EAAC,OAAO,CAAC,CAAC;IAChC,CAAC,CAAC;IAEM,mBAAmB,GAAG,KAAK,IAAmB,EAAE;QACtD,MAAM,iBAAiB,GAAG,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAC1D,MAAM,wBAAwB,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAChE,MAAM,iBAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,iBAAiB,EAAE,wBAAwB,CAAC,CAAC;QACzE,OAAO,CAAC,GAAG,CAAC,iDAAiD,iBAAiB,EAAE,CAAC,CAAC;IACpF,CAAC,CAAC;IAEM,uBAAuB,GAAG,GAAW,EAAE;QAC7C,MAAM,sBAAsB,GAAG,IAAA,oCAAyB,EACtD,IAAI,CAAC,YAAY,CAAC,oBAAoB,CACvC,CAAC;QAEF,MAAM,uBAAuB,GAAG;;;sBAGd,sBAAsB;CAC3C,CAAC;QAEE,MAAM,uBAAuB,GAAG;;;0BAGV,sBAAsB;CAC/C,CAAC;QAEE,MAAM,aAAa,GACjB,IAAI,CAAC,YAAY,CAAC,eAAe,KAAK,wBAAS,CAAC,UAAU;YACxD,CAAC,CAAC,uBAAuB;YACzB,CAAC,CAAC,uBAAuB,CAAC;QAE9B,MAAM,OAAO,GACX,aAAa;YACb;;;;;;;;;;;CAWL,CAAC;QACE,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC;IAEM,wBAAwB,GAAG,GAAW,EAAE;QAC9C,OAAO,2BAA2B,GAAG,yBAAU,CAAC,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;IACrF,CAAC,CAAC;CACH;AA9GD,kEA8GC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PromptObject } from \"prompts\";\nimport prompts from \"prompts\";\nimport fs from \"node:fs\";\nimport { Extensions, Languages, Messages } from \"./constants.js\";\nimport type {\n OverridePromptResponse,\n PackageManager,\n PlaywrightServiceInitConfig,\n} from \"./types.js\";\nimport { executeCommand, getFileReferenceForImport } from \"./utils.js\";\nimport { getPackageManager } from \"./packageManager.js\";\n\nconst questions: PromptObject[] = [\n {\n type: \"confirm\",\n name: \"canOverride\",\n message: Messages.CAN_OVERRIDE_MESSAGE,\n initial: true,\n },\n {\n type: (prev: boolean) => (prev ? null : \"confirm\"),\n name: \"confirmationForExit\",\n message: Messages.CONFIRMATION_FOR_EXIT_MESSAGE,\n initial: true,\n },\n];\n\nexport class PlaywrightServiceInitialize {\n private _setupConfig: PlaywrightServiceInitConfig;\n private _packageManager: PackageManager;\n\n constructor(setupConfig: PlaywrightServiceInitConfig) {\n this._setupConfig = setupConfig;\n this._packageManager = getPackageManager();\n }\n\n public addServiceSupportToTestSuite = async (): Promise<void> => {\n const canProceedWithServiceInitialization = await this.checkIfServiceConfigCanBeAdded(); // if service config already present, ask user for overwrite permission\n if (!canProceedWithServiceInitialization) return;\n await this.installServicePackage(); // install service packages\n await this.createServiceConfig(); // create service config file\n this.displayAdditionalInformation(); // display additional information\n };\n\n private checkIfServiceConfigCanBeAdded = async (): Promise<boolean> => {\n if (!this.isServiceConfigFileAlreadyPresent()) return true;\n const response = (await prompts.prompt(questions, {\n onCancel: this.promptOnCancel,\n })) as OverridePromptResponse;\n if (response.canOverride) return true;\n if (!response.confirmationForExit) return this.checkIfServiceConfigCanBeAdded();\n\n console.log(`\\n${Messages.SETUP_PROCESS_EXIT_MESSAGE}`);\n return false;\n };\n\n private promptOnCancel = (): never => {\n process.exit(0);\n };\n\n private isServiceConfigFileAlreadyPresent = (): boolean => {\n return fs.existsSync(this.getServiceConfigFileName());\n };\n\n private displayAdditionalInformation = (): void => {\n const runCommandParallelWorkers = this._packageManager.runCommand(\n \"playwright\",\n `test -c ${this.getServiceConfigFileName()} --workers=20`,\n );\n\n console.log(`\\n\\nTo run playwrights tests using Playwright Service\\n`);\n console.log(`\\t${runCommandParallelWorkers}\\n`);\n\n console.log(\"Getting Started - https://aka.ms/pww/docs/quickstart\\n\");\n\n console.log(\n \"If you're already using the Azure Playwright service, please review the quickstart guide [https://aka.ms/pww/docs/quickstart] to ensure your tests continue running smoothly.\",\n );\n };\n\n private installServicePackage = async (): Promise<void> => {\n const command = this._packageManager.installDevDependencyCommand(\n \"@azure/playwright @azure/identity\",\n );\n console.log(`Installing Service package (${command})`);\n await executeCommand(command);\n };\n\n private createServiceConfig = async (): Promise<void> => {\n const serviceConfigFile = this.getServiceConfigFileName();\n const serviceConfigFileContent = this.getServiceConfigContent();\n await fs.promises.writeFile(serviceConfigFile, serviceConfigFileContent);\n console.log(`Success! Created service configuration file - ${serviceConfigFile}`);\n };\n\n private getServiceConfigContent = (): string => {\n const customerConfigFileName = getFileReferenceForImport(\n this._setupConfig.playwrightConfigFile,\n );\n\n const importCommandTypeScript = `import { defineConfig } from '@playwright/test';\nimport { getServiceConfig, ServiceOS } from '@azure/playwright';\nimport { DefaultAzureCredential } from '@azure/identity';\nimport config from '${customerConfigFileName}';\n`;\n\n const importCommandJavaScript = `const { defineConfig } = require('@playwright/test');\nconst { getServiceConfig, ServiceOS } = require('@azure/playwright');\nconst { DefaultAzureCredential } = require('@azure/identity');\nconst config = require('${customerConfigFileName}');\n`;\n\n const importCommand =\n this._setupConfig.projectLanguage === Languages.TypeScript\n ? importCommandTypeScript\n : importCommandJavaScript;\n\n const content =\n importCommand +\n `\n/* Learn more about service configuration at https://aka.ms/pww/docs/config */\nexport default defineConfig(\n config,\n getServiceConfig(config, {\n exposeNetwork: '<loopback>',\n timeout: 3 * 60 * 1000, // 3 minutes\n os: ServiceOS.LINUX,\n credential: new DefaultAzureCredential(),\n })\n);\n`;\n return content;\n };\n\n private getServiceConfigFileName = (): string => {\n return \"playwright.service.config\" + Extensions[this._setupConfig.projectLanguage];\n };\n}\n"]}
|
|
@@ -7,38 +7,34 @@ const node_fs_1 = require("node:fs");
|
|
|
7
7
|
const node_process_1 = require("node:process");
|
|
8
8
|
const node_path_1 = require("node:path");
|
|
9
9
|
class NPM {
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
};
|
|
17
|
-
}
|
|
10
|
+
installDevDependencyCommand = (packageName) => {
|
|
11
|
+
return `npm install --save-dev ${packageName}`;
|
|
12
|
+
};
|
|
13
|
+
runCommand = (command, args) => {
|
|
14
|
+
return `npx ${command} ${args}`;
|
|
15
|
+
};
|
|
18
16
|
}
|
|
19
17
|
exports.NPM = NPM;
|
|
20
18
|
class PNPM {
|
|
19
|
+
useWorkspace = false;
|
|
21
20
|
constructor() {
|
|
22
|
-
this.useWorkspace = false;
|
|
23
|
-
this.installDevDependencyCommand = (packageName) => {
|
|
24
|
-
return `pnpm add --save-dev ${this.useWorkspace ? "-w " : ""}${packageName}`;
|
|
25
|
-
};
|
|
26
|
-
this.runCommand = (command, args) => {
|
|
27
|
-
return `pnpm ${command} ${args}`;
|
|
28
|
-
};
|
|
29
21
|
this.useWorkspace = (0, node_fs_1.existsSync)((0, node_path_1.resolve)((0, node_process_1.cwd)(), "pnpm-workspace.yaml"));
|
|
30
22
|
}
|
|
23
|
+
installDevDependencyCommand = (packageName) => {
|
|
24
|
+
return `pnpm add --save-dev ${this.useWorkspace ? "-w " : ""}${packageName}`;
|
|
25
|
+
};
|
|
26
|
+
runCommand = (command, args) => {
|
|
27
|
+
return `pnpm ${command} ${args}`;
|
|
28
|
+
};
|
|
31
29
|
}
|
|
32
30
|
exports.PNPM = PNPM;
|
|
33
31
|
class Yarn {
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
};
|
|
41
|
-
}
|
|
32
|
+
installDevDependencyCommand = (packageName) => {
|
|
33
|
+
return `yarn add --dev ${packageName}`;
|
|
34
|
+
};
|
|
35
|
+
runCommand = (command, args) => {
|
|
36
|
+
return `yarn ${command} ${args}`;
|
|
37
|
+
};
|
|
42
38
|
}
|
|
43
39
|
exports.Yarn = Yarn;
|
|
44
40
|
// https://stackoverflow.com/questions/68133683/is-there-a-cross-platform-way-to-get-the-name-of-the-parent-process-in-node-js
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"packageManager.js","sourceRoot":"","sources":["../../src/packageManager.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,qCAAqC;AAErC,+CAAmC;AACnC,yCAAoC;AAEpC,MAAa,GAAG;
|
|
1
|
+
{"version":3,"file":"packageManager.js","sourceRoot":"","sources":["../../src/packageManager.ts"],"names":[],"mappings":";AAAA,uCAAuC;AACvC,kCAAkC;;;AAElC,qCAAqC;AAErC,+CAAmC;AACnC,yCAAoC;AAEpC,MAAa,GAAG;IACd,2BAA2B,GAAG,CAAC,WAAmB,EAAU,EAAE;QAC5D,OAAO,0BAA0B,WAAW,EAAE,CAAC;IACjD,CAAC,CAAC;IACF,UAAU,GAAG,CAAC,OAAe,EAAE,IAAY,EAAU,EAAE;QACrD,OAAO,OAAO,OAAO,IAAI,IAAI,EAAE,CAAC;IAClC,CAAC,CAAC;CACH;AAPD,kBAOC;AAED,MAAa,IAAI;IACP,YAAY,GAAY,KAAK,CAAC;IAEtC;QACE,IAAI,CAAC,YAAY,GAAG,IAAA,oBAAU,EAAC,IAAA,mBAAO,EAAC,IAAA,kBAAG,GAAE,EAAE,qBAAqB,CAAC,CAAC,CAAC;IACxE,CAAC;IAED,2BAA2B,GAAG,CAAC,WAAmB,EAAU,EAAE;QAC5D,OAAO,uBAAuB,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,WAAW,EAAE,CAAC;IAC/E,CAAC,CAAC;IACF,UAAU,GAAG,CAAC,OAAe,EAAE,IAAY,EAAU,EAAE;QACrD,OAAO,QAAQ,OAAO,IAAI,IAAI,EAAE,CAAC;IACnC,CAAC,CAAC;CACH;AAbD,oBAaC;AAED,MAAa,IAAI;IACf,2BAA2B,GAAG,CAAC,WAAmB,EAAU,EAAE;QAC5D,OAAO,kBAAkB,WAAW,EAAE,CAAC;IACzC,CAAC,CAAC;IACF,UAAU,GAAG,CAAC,OAAe,EAAE,IAAY,EAAU,EAAE;QACrD,OAAO,QAAQ,OAAO,IAAI,IAAI,EAAE,CAAC;IACnC,CAAC,CAAC;CACH;AAPD,oBAOC;AAED,8HAA8H;AACvH,MAAM,iBAAiB,GAAG,GAAmB,EAAE;IACpD,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;QACvD,IAAI,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC;YAAE,OAAO,IAAI,IAAI,EAAE,CAAC;QAClD,IAAI,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC;YAAE,OAAO,IAAI,IAAI,EAAE,CAAC;IACpD,CAAC;IACD,OAAO,IAAI,GAAG,EAAE,CAAC;AACnB,CAAC,CAAC;AAPW,QAAA,iBAAiB,qBAO5B","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { existsSync } from \"node:fs\";\nimport type { PackageManager } from \"./types.js\";\nimport { cwd } from \"node:process\";\nimport { resolve } from \"node:path\";\n\nexport class NPM implements PackageManager {\n installDevDependencyCommand = (packageName: string): string => {\n return `npm install --save-dev ${packageName}`;\n };\n runCommand = (command: string, args: string): string => {\n return `npx ${command} ${args}`;\n };\n}\n\nexport class PNPM implements PackageManager {\n private useWorkspace: boolean = false;\n\n constructor() {\n this.useWorkspace = existsSync(resolve(cwd(), \"pnpm-workspace.yaml\"));\n }\n\n installDevDependencyCommand = (packageName: string): string => {\n return `pnpm add --save-dev ${this.useWorkspace ? \"-w \" : \"\"}${packageName}`;\n };\n runCommand = (command: string, args: string): string => {\n return `pnpm ${command} ${args}`;\n };\n}\n\nexport class Yarn implements PackageManager {\n installDevDependencyCommand = (packageName: string): string => {\n return `yarn add --dev ${packageName}`;\n };\n runCommand = (command: string, args: string): string => {\n return `yarn ${command} ${args}`;\n };\n}\n\n// https://stackoverflow.com/questions/68133683/is-there-a-cross-platform-way-to-get-the-name-of-the-parent-process-in-node-js\nexport const getPackageManager = (): PackageManager => {\n if (process.env[\"npm_config_user_agent\"]) {\n const userAgent = process.env[\"npm_config_user_agent\"];\n if (userAgent.includes(\"yarn\")) return new Yarn();\n if (userAgent.includes(\"pnpm\")) return new PNPM();\n }\n return new NPM();\n};\n"]}
|
package/dist/esm/bin/init.js
CHANGED
|
@@ -7,10 +7,14 @@ export const init = async () => {
|
|
|
7
7
|
const { config: playwrightConfigFile } = options;
|
|
8
8
|
let playwrightServiceInitConfig;
|
|
9
9
|
if (playwrightConfigFile) {
|
|
10
|
-
playwrightServiceInitConfig =
|
|
10
|
+
playwrightServiceInitConfig = {
|
|
11
|
+
...getLanguageAndConfigInfoFromConfigurationFile(playwrightConfigFile),
|
|
12
|
+
};
|
|
11
13
|
}
|
|
12
14
|
else {
|
|
13
|
-
playwrightServiceInitConfig =
|
|
15
|
+
playwrightServiceInitConfig = {
|
|
16
|
+
...getLanguageAndConfigInfoFromDirectory(),
|
|
17
|
+
};
|
|
14
18
|
}
|
|
15
19
|
console.log("");
|
|
16
20
|
const playwrightServiceInitialize = new PlaywrightServiceInitialize(playwrightServiceInitConfig);
|
package/dist/esm/bin/init.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../src/bin/init.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,2BAA2B,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EACL,6CAA6C,EAC7C,qCAAqC,EACrC,iBAAiB,GAClB,MAAM,aAAa,CAAC;AAErB,MAAM,CAAC,MAAM,IAAI,GAAG,KAAK,IAAmB,EAAE;IAC5C,MAAM,OAAO,GAAG,iBAAiB,EAAE,CAAC;IACpC,MAAM,EAAE,MAAM,EAAE,oBAAoB,EAAE,GAAG,OAAO,CAAC;IACjD,IAAI,2BAAwD,CAAC;IAE7D,IAAI,oBAAoB,EAAE,CAAC;QACzB,2BAA2B,
|
|
1
|
+
{"version":3,"file":"init.js","sourceRoot":"","sources":["../../../src/bin/init.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAE,2BAA2B,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EACL,6CAA6C,EAC7C,qCAAqC,EACrC,iBAAiB,GAClB,MAAM,aAAa,CAAC;AAErB,MAAM,CAAC,MAAM,IAAI,GAAG,KAAK,IAAmB,EAAE;IAC5C,MAAM,OAAO,GAAG,iBAAiB,EAAE,CAAC;IACpC,MAAM,EAAE,MAAM,EAAE,oBAAoB,EAAE,GAAG,OAAO,CAAC;IACjD,IAAI,2BAAwD,CAAC;IAE7D,IAAI,oBAAoB,EAAE,CAAC;QACzB,2BAA2B,GAAG;YAC5B,GAAG,6CAA6C,CAAC,oBAAoB,CAAC;SACvE,CAAC;IACJ,CAAC;SAAM,CAAC;QACN,2BAA2B,GAAG;YAC5B,GAAG,qCAAqC,EAAE;SAC3C,CAAC;IACJ,CAAC;IAED,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;IAChB,MAAM,2BAA2B,GAAG,IAAI,2BAA2B,CAAC,2BAA2B,CAAC,CAAC;IACjG,MAAM,2BAA2B,CAAC,4BAA4B,EAAE,CAAC;AACnE,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PlaywrightServiceInitConfig } from \"../types.js\";\nimport { PlaywrightServiceInitialize } from \"../initialize.js\";\nimport {\n getLanguageAndConfigInfoFromConfigurationFile,\n getLanguageAndConfigInfoFromDirectory,\n parseCLIArguments,\n} from \"../utils.js\";\n\nexport const init = async (): Promise<void> => {\n const options = parseCLIArguments();\n const { config: playwrightConfigFile } = options;\n let playwrightServiceInitConfig: PlaywrightServiceInitConfig;\n\n if (playwrightConfigFile) {\n playwrightServiceInitConfig = {\n ...getLanguageAndConfigInfoFromConfigurationFile(playwrightConfigFile),\n };\n } else {\n playwrightServiceInitConfig = {\n ...getLanguageAndConfigInfoFromDirectory(),\n };\n }\n\n console.log(\"\");\n const playwrightServiceInitialize = new PlaywrightServiceInitialize(playwrightServiceInitConfig);\n await playwrightServiceInitialize.addServiceSupportToTestSuite();\n};\n"]}
|
package/dist/esm/initialize.js
CHANGED
|
@@ -20,70 +20,75 @@ const questions = [
|
|
|
20
20
|
},
|
|
21
21
|
];
|
|
22
22
|
export class PlaywrightServiceInitialize {
|
|
23
|
+
_setupConfig;
|
|
24
|
+
_packageManager;
|
|
23
25
|
constructor(setupConfig) {
|
|
24
|
-
this.
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
this.
|
|
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
|
-
|
|
26
|
+
this._setupConfig = setupConfig;
|
|
27
|
+
this._packageManager = getPackageManager();
|
|
28
|
+
}
|
|
29
|
+
addServiceSupportToTestSuite = async () => {
|
|
30
|
+
const canProceedWithServiceInitialization = await this.checkIfServiceConfigCanBeAdded(); // if service config already present, ask user for overwrite permission
|
|
31
|
+
if (!canProceedWithServiceInitialization)
|
|
32
|
+
return;
|
|
33
|
+
await this.installServicePackage(); // install service packages
|
|
34
|
+
await this.createServiceConfig(); // create service config file
|
|
35
|
+
this.displayAdditionalInformation(); // display additional information
|
|
36
|
+
};
|
|
37
|
+
checkIfServiceConfigCanBeAdded = async () => {
|
|
38
|
+
if (!this.isServiceConfigFileAlreadyPresent())
|
|
39
|
+
return true;
|
|
40
|
+
const response = (await prompts.prompt(questions, {
|
|
41
|
+
onCancel: this.promptOnCancel,
|
|
42
|
+
}));
|
|
43
|
+
if (response.canOverride)
|
|
44
|
+
return true;
|
|
45
|
+
if (!response.confirmationForExit)
|
|
46
|
+
return this.checkIfServiceConfigCanBeAdded();
|
|
47
|
+
console.log(`\n${Messages.SETUP_PROCESS_EXIT_MESSAGE}`);
|
|
48
|
+
return false;
|
|
49
|
+
};
|
|
50
|
+
promptOnCancel = () => {
|
|
51
|
+
process.exit(0);
|
|
52
|
+
};
|
|
53
|
+
isServiceConfigFileAlreadyPresent = () => {
|
|
54
|
+
return fs.existsSync(this.getServiceConfigFileName());
|
|
55
|
+
};
|
|
56
|
+
displayAdditionalInformation = () => {
|
|
57
|
+
const runCommandParallelWorkers = this._packageManager.runCommand("playwright", `test -c ${this.getServiceConfigFileName()} --workers=20`);
|
|
58
|
+
console.log(`\n\nTo run playwrights tests using Playwright Service\n`);
|
|
59
|
+
console.log(`\t${runCommandParallelWorkers}\n`);
|
|
60
|
+
console.log("Getting Started - https://aka.ms/pww/docs/quickstart\n");
|
|
61
|
+
console.log("If you're already using the Azure Playwright service, please review the quickstart guide [https://aka.ms/pww/docs/quickstart] to ensure your tests continue running smoothly.");
|
|
62
|
+
};
|
|
63
|
+
installServicePackage = async () => {
|
|
64
|
+
const command = this._packageManager.installDevDependencyCommand("@azure/playwright @azure/identity");
|
|
65
|
+
console.log(`Installing Service package (${command})`);
|
|
66
|
+
await executeCommand(command);
|
|
67
|
+
};
|
|
68
|
+
createServiceConfig = async () => {
|
|
69
|
+
const serviceConfigFile = this.getServiceConfigFileName();
|
|
70
|
+
const serviceConfigFileContent = this.getServiceConfigContent();
|
|
71
|
+
await fs.promises.writeFile(serviceConfigFile, serviceConfigFileContent);
|
|
72
|
+
console.log(`Success! Created service configuration file - ${serviceConfigFile}`);
|
|
73
|
+
};
|
|
74
|
+
getServiceConfigContent = () => {
|
|
75
|
+
const customerConfigFileName = getFileReferenceForImport(this._setupConfig.playwrightConfigFile);
|
|
76
|
+
const importCommandTypeScript = `import { defineConfig } from '@playwright/test';
|
|
72
77
|
import { getServiceConfig, ServiceOS } from '@azure/playwright';
|
|
73
78
|
import { DefaultAzureCredential } from '@azure/identity';
|
|
74
79
|
import config from '${customerConfigFileName}';
|
|
75
80
|
`;
|
|
76
|
-
|
|
81
|
+
const importCommandJavaScript = `const { defineConfig } = require('@playwright/test');
|
|
77
82
|
const { getServiceConfig, ServiceOS } = require('@azure/playwright');
|
|
78
83
|
const { DefaultAzureCredential } = require('@azure/identity');
|
|
79
84
|
const config = require('${customerConfigFileName}');
|
|
80
85
|
`;
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
/* Learn more about service configuration at https://aka.ms/
|
|
86
|
+
const importCommand = this._setupConfig.projectLanguage === Languages.TypeScript
|
|
87
|
+
? importCommandTypeScript
|
|
88
|
+
: importCommandJavaScript;
|
|
89
|
+
const content = importCommand +
|
|
90
|
+
`
|
|
91
|
+
/* Learn more about service configuration at https://aka.ms/pww/docs/config */
|
|
87
92
|
export default defineConfig(
|
|
88
93
|
config,
|
|
89
94
|
getServiceConfig(config, {
|
|
@@ -94,13 +99,10 @@ export default defineConfig(
|
|
|
94
99
|
})
|
|
95
100
|
);
|
|
96
101
|
`;
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
this._setupConfig = setupConfig;
|
|
103
|
-
this._packageManager = getPackageManager();
|
|
104
|
-
}
|
|
102
|
+
return content;
|
|
103
|
+
};
|
|
104
|
+
getServiceConfigFileName = () => {
|
|
105
|
+
return "playwright.service.config" + Extensions[this._setupConfig.projectLanguage];
|
|
106
|
+
};
|
|
105
107
|
}
|
|
106
108
|
//# sourceMappingURL=initialize.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"initialize.js","sourceRoot":"","sources":["../../src/initialize.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAMjE,OAAO,EAAE,cAAc,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,MAAM,SAAS,GAAmB;IAChC;QACE,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,aAAa;QACnB,OAAO,EAAE,QAAQ,CAAC,oBAAoB;QACtC,OAAO,EAAE,IAAI;KACd;IACD;QACE,IAAI,EAAE,CAAC,IAAa,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;QAClD,IAAI,EAAE,qBAAqB;QAC3B,OAAO,EAAE,QAAQ,CAAC,6BAA6B;QAC/C,OAAO,EAAE,IAAI;KACd;CACF,CAAC;AAEF,MAAM,OAAO,2BAA2B;
|
|
1
|
+
{"version":3,"file":"initialize.js","sourceRoot":"","sources":["../../src/initialize.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,OAAO,MAAM,SAAS,CAAC;AAC9B,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAMjE,OAAO,EAAE,cAAc,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AACvE,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AAExD,MAAM,SAAS,GAAmB;IAChC;QACE,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,aAAa;QACnB,OAAO,EAAE,QAAQ,CAAC,oBAAoB;QACtC,OAAO,EAAE,IAAI;KACd;IACD;QACE,IAAI,EAAE,CAAC,IAAa,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;QAClD,IAAI,EAAE,qBAAqB;QAC3B,OAAO,EAAE,QAAQ,CAAC,6BAA6B;QAC/C,OAAO,EAAE,IAAI;KACd;CACF,CAAC;AAEF,MAAM,OAAO,2BAA2B;IAC9B,YAAY,CAA8B;IAC1C,eAAe,CAAiB;IAExC,YAAY,WAAwC;QAClD,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC;QAChC,IAAI,CAAC,eAAe,GAAG,iBAAiB,EAAE,CAAC;IAC7C,CAAC;IAEM,4BAA4B,GAAG,KAAK,IAAmB,EAAE;QAC9D,MAAM,mCAAmC,GAAG,MAAM,IAAI,CAAC,8BAA8B,EAAE,CAAC,CAAC,uEAAuE;QAChK,IAAI,CAAC,mCAAmC;YAAE,OAAO;QACjD,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAAC,2BAA2B;QAC/D,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC,CAAC,6BAA6B;QAC/D,IAAI,CAAC,4BAA4B,EAAE,CAAC,CAAC,iCAAiC;IACxE,CAAC,CAAC;IAEM,8BAA8B,GAAG,KAAK,IAAsB,EAAE;QACpE,IAAI,CAAC,IAAI,CAAC,iCAAiC,EAAE;YAAE,OAAO,IAAI,CAAC;QAC3D,MAAM,QAAQ,GAAG,CAAC,MAAM,OAAO,CAAC,MAAM,CAAC,SAAS,EAAE;YAChD,QAAQ,EAAE,IAAI,CAAC,cAAc;SAC9B,CAAC,CAA2B,CAAC;QAC9B,IAAI,QAAQ,CAAC,WAAW;YAAE,OAAO,IAAI,CAAC;QACtC,IAAI,CAAC,QAAQ,CAAC,mBAAmB;YAAE,OAAO,IAAI,CAAC,8BAA8B,EAAE,CAAC;QAEhF,OAAO,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAC,0BAA0B,EAAE,CAAC,CAAC;QACxD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC;IAEM,cAAc,GAAG,GAAU,EAAE;QACnC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC;IAEM,iCAAiC,GAAG,GAAY,EAAE;QACxD,OAAO,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,wBAAwB,EAAE,CAAC,CAAC;IACxD,CAAC,CAAC;IAEM,4BAA4B,GAAG,GAAS,EAAE;QAChD,MAAM,yBAAyB,GAAG,IAAI,CAAC,eAAe,CAAC,UAAU,CAC/D,YAAY,EACZ,WAAW,IAAI,CAAC,wBAAwB,EAAE,eAAe,CAC1D,CAAC;QAEF,OAAO,CAAC,GAAG,CAAC,yDAAyD,CAAC,CAAC;QACvE,OAAO,CAAC,GAAG,CAAC,KAAK,yBAAyB,IAAI,CAAC,CAAC;QAEhD,OAAO,CAAC,GAAG,CAAC,wDAAwD,CAAC,CAAC;QAEtE,OAAO,CAAC,GAAG,CACT,+KAA+K,CAChL,CAAC;IACJ,CAAC,CAAC;IAEM,qBAAqB,GAAG,KAAK,IAAmB,EAAE;QACxD,MAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,2BAA2B,CAC9D,mCAAmC,CACpC,CAAC;QACF,OAAO,CAAC,GAAG,CAAC,+BAA+B,OAAO,GAAG,CAAC,CAAC;QACvD,MAAM,cAAc,CAAC,OAAO,CAAC,CAAC;IAChC,CAAC,CAAC;IAEM,mBAAmB,GAAG,KAAK,IAAmB,EAAE;QACtD,MAAM,iBAAiB,GAAG,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAC1D,MAAM,wBAAwB,GAAG,IAAI,CAAC,uBAAuB,EAAE,CAAC;QAChE,MAAM,EAAE,CAAC,QAAQ,CAAC,SAAS,CAAC,iBAAiB,EAAE,wBAAwB,CAAC,CAAC;QACzE,OAAO,CAAC,GAAG,CAAC,iDAAiD,iBAAiB,EAAE,CAAC,CAAC;IACpF,CAAC,CAAC;IAEM,uBAAuB,GAAG,GAAW,EAAE;QAC7C,MAAM,sBAAsB,GAAG,yBAAyB,CACtD,IAAI,CAAC,YAAY,CAAC,oBAAoB,CACvC,CAAC;QAEF,MAAM,uBAAuB,GAAG;;;sBAGd,sBAAsB;CAC3C,CAAC;QAEE,MAAM,uBAAuB,GAAG;;;0BAGV,sBAAsB;CAC/C,CAAC;QAEE,MAAM,aAAa,GACjB,IAAI,CAAC,YAAY,CAAC,eAAe,KAAK,SAAS,CAAC,UAAU;YACxD,CAAC,CAAC,uBAAuB;YACzB,CAAC,CAAC,uBAAuB,CAAC;QAE9B,MAAM,OAAO,GACX,aAAa;YACb;;;;;;;;;;;CAWL,CAAC;QACE,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC;IAEM,wBAAwB,GAAG,GAAW,EAAE;QAC9C,OAAO,2BAA2B,GAAG,UAAU,CAAC,IAAI,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC;IACrF,CAAC,CAAC;CACH","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport type { PromptObject } from \"prompts\";\nimport prompts from \"prompts\";\nimport fs from \"node:fs\";\nimport { Extensions, Languages, Messages } from \"./constants.js\";\nimport type {\n OverridePromptResponse,\n PackageManager,\n PlaywrightServiceInitConfig,\n} from \"./types.js\";\nimport { executeCommand, getFileReferenceForImport } from \"./utils.js\";\nimport { getPackageManager } from \"./packageManager.js\";\n\nconst questions: PromptObject[] = [\n {\n type: \"confirm\",\n name: \"canOverride\",\n message: Messages.CAN_OVERRIDE_MESSAGE,\n initial: true,\n },\n {\n type: (prev: boolean) => (prev ? null : \"confirm\"),\n name: \"confirmationForExit\",\n message: Messages.CONFIRMATION_FOR_EXIT_MESSAGE,\n initial: true,\n },\n];\n\nexport class PlaywrightServiceInitialize {\n private _setupConfig: PlaywrightServiceInitConfig;\n private _packageManager: PackageManager;\n\n constructor(setupConfig: PlaywrightServiceInitConfig) {\n this._setupConfig = setupConfig;\n this._packageManager = getPackageManager();\n }\n\n public addServiceSupportToTestSuite = async (): Promise<void> => {\n const canProceedWithServiceInitialization = await this.checkIfServiceConfigCanBeAdded(); // if service config already present, ask user for overwrite permission\n if (!canProceedWithServiceInitialization) return;\n await this.installServicePackage(); // install service packages\n await this.createServiceConfig(); // create service config file\n this.displayAdditionalInformation(); // display additional information\n };\n\n private checkIfServiceConfigCanBeAdded = async (): Promise<boolean> => {\n if (!this.isServiceConfigFileAlreadyPresent()) return true;\n const response = (await prompts.prompt(questions, {\n onCancel: this.promptOnCancel,\n })) as OverridePromptResponse;\n if (response.canOverride) return true;\n if (!response.confirmationForExit) return this.checkIfServiceConfigCanBeAdded();\n\n console.log(`\\n${Messages.SETUP_PROCESS_EXIT_MESSAGE}`);\n return false;\n };\n\n private promptOnCancel = (): never => {\n process.exit(0);\n };\n\n private isServiceConfigFileAlreadyPresent = (): boolean => {\n return fs.existsSync(this.getServiceConfigFileName());\n };\n\n private displayAdditionalInformation = (): void => {\n const runCommandParallelWorkers = this._packageManager.runCommand(\n \"playwright\",\n `test -c ${this.getServiceConfigFileName()} --workers=20`,\n );\n\n console.log(`\\n\\nTo run playwrights tests using Playwright Service\\n`);\n console.log(`\\t${runCommandParallelWorkers}\\n`);\n\n console.log(\"Getting Started - https://aka.ms/pww/docs/quickstart\\n\");\n\n console.log(\n \"If you're already using the Azure Playwright service, please review the quickstart guide [https://aka.ms/pww/docs/quickstart] to ensure your tests continue running smoothly.\",\n );\n };\n\n private installServicePackage = async (): Promise<void> => {\n const command = this._packageManager.installDevDependencyCommand(\n \"@azure/playwright @azure/identity\",\n );\n console.log(`Installing Service package (${command})`);\n await executeCommand(command);\n };\n\n private createServiceConfig = async (): Promise<void> => {\n const serviceConfigFile = this.getServiceConfigFileName();\n const serviceConfigFileContent = this.getServiceConfigContent();\n await fs.promises.writeFile(serviceConfigFile, serviceConfigFileContent);\n console.log(`Success! Created service configuration file - ${serviceConfigFile}`);\n };\n\n private getServiceConfigContent = (): string => {\n const customerConfigFileName = getFileReferenceForImport(\n this._setupConfig.playwrightConfigFile,\n );\n\n const importCommandTypeScript = `import { defineConfig } from '@playwright/test';\nimport { getServiceConfig, ServiceOS } from '@azure/playwright';\nimport { DefaultAzureCredential } from '@azure/identity';\nimport config from '${customerConfigFileName}';\n`;\n\n const importCommandJavaScript = `const { defineConfig } = require('@playwright/test');\nconst { getServiceConfig, ServiceOS } = require('@azure/playwright');\nconst { DefaultAzureCredential } = require('@azure/identity');\nconst config = require('${customerConfigFileName}');\n`;\n\n const importCommand =\n this._setupConfig.projectLanguage === Languages.TypeScript\n ? importCommandTypeScript\n : importCommandJavaScript;\n\n const content =\n importCommand +\n `\n/* Learn more about service configuration at https://aka.ms/pww/docs/config */\nexport default defineConfig(\n config,\n getServiceConfig(config, {\n exposeNetwork: '<loopback>',\n timeout: 3 * 60 * 1000, // 3 minutes\n os: ServiceOS.LINUX,\n credential: new DefaultAzureCredential(),\n })\n);\n`;\n return content;\n };\n\n private getServiceConfigFileName = (): string => {\n return \"playwright.service.config\" + Extensions[this._setupConfig.projectLanguage];\n };\n}\n"]}
|
|
@@ -4,36 +4,32 @@ import { existsSync } from "node:fs";
|
|
|
4
4
|
import { cwd } from "node:process";
|
|
5
5
|
import { resolve } from "node:path";
|
|
6
6
|
export class NPM {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
};
|
|
14
|
-
}
|
|
7
|
+
installDevDependencyCommand = (packageName) => {
|
|
8
|
+
return `npm install --save-dev ${packageName}`;
|
|
9
|
+
};
|
|
10
|
+
runCommand = (command, args) => {
|
|
11
|
+
return `npx ${command} ${args}`;
|
|
12
|
+
};
|
|
15
13
|
}
|
|
16
14
|
export class PNPM {
|
|
15
|
+
useWorkspace = false;
|
|
17
16
|
constructor() {
|
|
18
|
-
this.useWorkspace = false;
|
|
19
|
-
this.installDevDependencyCommand = (packageName) => {
|
|
20
|
-
return `pnpm add --save-dev ${this.useWorkspace ? "-w " : ""}${packageName}`;
|
|
21
|
-
};
|
|
22
|
-
this.runCommand = (command, args) => {
|
|
23
|
-
return `pnpm ${command} ${args}`;
|
|
24
|
-
};
|
|
25
17
|
this.useWorkspace = existsSync(resolve(cwd(), "pnpm-workspace.yaml"));
|
|
26
18
|
}
|
|
19
|
+
installDevDependencyCommand = (packageName) => {
|
|
20
|
+
return `pnpm add --save-dev ${this.useWorkspace ? "-w " : ""}${packageName}`;
|
|
21
|
+
};
|
|
22
|
+
runCommand = (command, args) => {
|
|
23
|
+
return `pnpm ${command} ${args}`;
|
|
24
|
+
};
|
|
27
25
|
}
|
|
28
26
|
export class Yarn {
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
};
|
|
36
|
-
}
|
|
27
|
+
installDevDependencyCommand = (packageName) => {
|
|
28
|
+
return `yarn add --dev ${packageName}`;
|
|
29
|
+
};
|
|
30
|
+
runCommand = (command, args) => {
|
|
31
|
+
return `yarn ${command} ${args}`;
|
|
32
|
+
};
|
|
37
33
|
}
|
|
38
34
|
// https://stackoverflow.com/questions/68133683/is-there-a-cross-platform-way-to-get-the-name-of-the-parent-process-in-node-js
|
|
39
35
|
export const getPackageManager = () => {
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"packageManager.js","sourceRoot":"","sources":["../../src/packageManager.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAErC,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,OAAO,GAAG;
|
|
1
|
+
{"version":3,"file":"packageManager.js","sourceRoot":"","sources":["../../src/packageManager.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAErC,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,OAAO,GAAG;IACd,2BAA2B,GAAG,CAAC,WAAmB,EAAU,EAAE;QAC5D,OAAO,0BAA0B,WAAW,EAAE,CAAC;IACjD,CAAC,CAAC;IACF,UAAU,GAAG,CAAC,OAAe,EAAE,IAAY,EAAU,EAAE;QACrD,OAAO,OAAO,OAAO,IAAI,IAAI,EAAE,CAAC;IAClC,CAAC,CAAC;CACH;AAED,MAAM,OAAO,IAAI;IACP,YAAY,GAAY,KAAK,CAAC;IAEtC;QACE,IAAI,CAAC,YAAY,GAAG,UAAU,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,qBAAqB,CAAC,CAAC,CAAC;IACxE,CAAC;IAED,2BAA2B,GAAG,CAAC,WAAmB,EAAU,EAAE;QAC5D,OAAO,uBAAuB,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,WAAW,EAAE,CAAC;IAC/E,CAAC,CAAC;IACF,UAAU,GAAG,CAAC,OAAe,EAAE,IAAY,EAAU,EAAE;QACrD,OAAO,QAAQ,OAAO,IAAI,IAAI,EAAE,CAAC;IACnC,CAAC,CAAC;CACH;AAED,MAAM,OAAO,IAAI;IACf,2BAA2B,GAAG,CAAC,WAAmB,EAAU,EAAE;QAC5D,OAAO,kBAAkB,WAAW,EAAE,CAAC;IACzC,CAAC,CAAC;IACF,UAAU,GAAG,CAAC,OAAe,EAAE,IAAY,EAAU,EAAE;QACrD,OAAO,QAAQ,OAAO,IAAI,IAAI,EAAE,CAAC;IACnC,CAAC,CAAC;CACH;AAED,8HAA8H;AAC9H,MAAM,CAAC,MAAM,iBAAiB,GAAG,GAAmB,EAAE;IACpD,IAAI,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,EAAE,CAAC;QACzC,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAC;QACvD,IAAI,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC;YAAE,OAAO,IAAI,IAAI,EAAE,CAAC;QAClD,IAAI,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC;YAAE,OAAO,IAAI,IAAI,EAAE,CAAC;IACpD,CAAC;IACD,OAAO,IAAI,GAAG,EAAE,CAAC;AACnB,CAAC,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nimport { existsSync } from \"node:fs\";\nimport type { PackageManager } from \"./types.js\";\nimport { cwd } from \"node:process\";\nimport { resolve } from \"node:path\";\n\nexport class NPM implements PackageManager {\n installDevDependencyCommand = (packageName: string): string => {\n return `npm install --save-dev ${packageName}`;\n };\n runCommand = (command: string, args: string): string => {\n return `npx ${command} ${args}`;\n };\n}\n\nexport class PNPM implements PackageManager {\n private useWorkspace: boolean = false;\n\n constructor() {\n this.useWorkspace = existsSync(resolve(cwd(), \"pnpm-workspace.yaml\"));\n }\n\n installDevDependencyCommand = (packageName: string): string => {\n return `pnpm add --save-dev ${this.useWorkspace ? \"-w \" : \"\"}${packageName}`;\n };\n runCommand = (command: string, args: string): string => {\n return `pnpm ${command} ${args}`;\n };\n}\n\nexport class Yarn implements PackageManager {\n installDevDependencyCommand = (packageName: string): string => {\n return `yarn add --dev ${packageName}`;\n };\n runCommand = (command: string, args: string): string => {\n return `yarn ${command} ${args}`;\n };\n}\n\n// https://stackoverflow.com/questions/68133683/is-there-a-cross-platform-way-to-get-the-name-of-the-parent-process-in-node-js\nexport const getPackageManager = (): PackageManager => {\n if (process.env[\"npm_config_user_agent\"]) {\n const userAgent = process.env[\"npm_config_user_agent\"];\n if (userAgent.includes(\"yarn\")) return new Yarn();\n if (userAgent.includes(\"pnpm\")) return new PNPM();\n }\n return new NPM();\n};\n"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@azure/create-playwright",
|
|
3
|
-
"version": "1.0.0-beta.
|
|
3
|
+
"version": "1.0.0-beta.2",
|
|
4
4
|
"description": "Package to setup @azure/playwright",
|
|
5
5
|
"homepage": "https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/loadtesting/create-playwright/README.md",
|
|
6
6
|
"sdk-type": "client",
|
|
@@ -78,7 +78,7 @@
|
|
|
78
78
|
}
|
|
79
79
|
},
|
|
80
80
|
"tshy": {
|
|
81
|
-
"project": "
|
|
81
|
+
"project": "../../../tsconfig.src.build.json",
|
|
82
82
|
"exports": {
|
|
83
83
|
"./package.json": "./package.json",
|
|
84
84
|
".": "./src/index.ts"
|