Skip to content

Commit 7866294

Browse files
committed
addressed comments
1 parent c6623f8 commit 7866294

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

articles/playwright-testing/how-to-use-service-config-file.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@ ms.custom: playwright-testing-preview
77
---
88
# Use options available in configuration file with Microsoft Playwright Testing preview
99

10-
This article shows you how to use the options available in the `playwright.service.config.ts` file.
10+
This article shows you how to use the options available in the `playwright.service.config.ts` file that was generated for you.
11+
If you do not have this file in your code, follow the QuickStart guide, see [Quickstart: Run end-to-end tests at scale with Microsoft Playwright Testing Preview](./quickstart-run-end-to-end-tests.md)
1112

1213
> [!IMPORTANT]
1314
> Microsoft Playwright Testing is currently in preview. For legal terms that apply to Azure features that are in beta, in preview, or otherwise not yet released into general availability, see the [Supplemental Terms of Use for Microsoft Azure Previews](https://azure.microsoft.com/support/legal/preview-supplemental-terms/).
@@ -48,7 +49,7 @@ export default defineConfig(
4849

4950
## Settings in `playwright.service.config.ts` file
5051

51-
1. **`defaultAuth`**:
52+
* **`defaultAuth`**:
5253
- **Description**: This setting allows you to choose the authentication method you want to use for your test run.
5354
- **Available Options**:
5455
- `TOKEN` to use access tokens. You need to enable authtication using access tokens if you want to use this option, see [manage authentication](./how-to-manage-authentication.md).
@@ -60,7 +61,7 @@ export default defineConfig(
6061
```
6162

6263

63-
1. **`os`**:
64+
* **`os`**:
6465
- **Description**: This setting allows you to choose the operating system where the browsers running Playwright tests will be hosted.
6566
- **Available Options**:
6667
- `ServiceOS.WINDOWS` for Windows OS.
@@ -71,43 +72,43 @@ export default defineConfig(
7172
os: ServiceOS.WINDOWS
7273
```
7374

74-
2. **`runId`**:
75+
* **`runId`**:
7576
- **Description**: This setting allows you to set a unique ID for every test run to distinguish them in the service portal.
7677
- **Example**:
7778
```typescript
7879
runId: new Date().toISOString()
7980
```
8081

81-
3. **`credential`**:
82+
* **`credential`**:
8283
- **Description**: This setting allows you to select the authentication method you want to use with Entra.
8384
- **Example**:
8485
```typescript
8586
credential: new AzureCliCredential()
8687
```
8788

88-
5. **`useCloudHostedBrowsers`**
89+
* **`useCloudHostedBrowsers`**
8990
- **Description**: This setting allows you to choose whether to use cloud-hosted browsers or the browsers on your client machine to run your Playwright tests. If you disable this option, your tests will run on the browsers of your client machine instead of cloud-hosted browsers, and you will not incur any charges.
9091
- **Default Value**: true
9192
- **Example**:
9293
```typescript
9394
useCloudHostedBrowsers: true
9495
```
9596

96-
5. **`exposeNetwork`**
97+
* **`exposeNetwork`**
9798
- **Description**: This setting allows you to connect to local resources from your Playwright test code without having to configure additional firewall settings. To learn more, see [how to test local applications](./how-to-test-local-applications.md)
9899
- **Example**:
99100
```typescript
100101
exposeNetwork: '<loopback>'
101102
```
102103

103-
5. **`timeout`**
104+
* **`timeout`**
104105
- **Description**: This setting allows you to set timeout for your tests connecting to the cloud-hosted browsers.
105106
- **Example**:
106107
```typescript
107108
timeout: 30000,
108109
```
109110

110-
5. **`reporter`**
111+
* **`reporter`**
111112
- **Description**: The `playwright.service.config.ts` file extends the playwright config file of your setup. This option overrides the existing reporters and sets Microsoft Playwright Testing reporter. You can add or modify this list to include the reporters that you want to use. You will be billed for Microsoft Playwright Testing reporting if you add `@azure/microsoft-playwright-testing/reporter`.
112113
- **Default Value**: ["@azure/microsoft-playwright-testing/reporter"]
113114
- **Example**:
@@ -116,7 +117,7 @@ export default defineConfig(
116117
["list"],
117118
["@azure/microsoft-playwright-testing/reporter"],
118119
```
119-
4. **`enableGitHubSummary`**:
120+
* **`enableGitHubSummary`**:
120121
- **Description**: This setting allows you to configure the Microsoft Playwright Testing service reporter. You can choose whether to include the test run summary in the GitHub summary when running in GitHub Actions.
121122
- **Default Value**: true
122123
- **Example**:

0 commit comments

Comments
 (0)