Skip to content

Commit 0598a8e

Browse files
Sid200026vvs11
Sid200026
and
vvs11
authored
Onboard Azure.Developer.MicrosoftPlaywrightTesting sdk (Azure#45044)
* feat(): onboard Azure.Developer.MicrosoftPlaywrightTesting sdk * chore(): add support for github summary * docs(): sample, CHANGELOG and README * docs(): content of samples * chore():: modify samples as per azure sdk guidelines * refactor(): unit tests as per azure sdk guidelines * chore(): use autorest to generate api clients * fix(): json parsing of error messages * chore(): add live tests * fix(): run id handling across scalable and reporting * Adressing comments * comment * chore(): resolve documentation comments * docs(): import c# code snippets from .cs files * refactor(): update CODEOWNERS with latest labels * chore(): add git commit based display name * feat(): scalable run error handling * refactor(): convert API client class to internal * chore(): apiview review comments addressed for base sdk * refactor(): rename tokenCredential to credential * refactor(): rename PlaywrightServiceSettings to PlaywrightServiceOptions * refactor(): use serviceAuth only * refactor(): remove defaultAuth references * refactor(): convert serviceOs class to internal * refactor(): convert public fields into properties * chore(): add cancellation token in async methods * refactor(): use default for null cancellation tokens * refactor(): added users in CODEOWNERS * fix(): live test resource json * docs(): add missing sections in README files * refactor(): rename base package to Azure.Developer.MicrosoftPlaywrightTesting.TestLogger * docs(): move authenticate client section after prerequisites --------- Co-authored-by: Siddharth Singha Roy <[email protected]> Co-authored-by: Vansh Vardhan Singh <[email protected]>
1 parent e6fd97a commit 0598a8e

File tree

50 files changed

+4921
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+4921
-2
lines changed

‎.github/CODEOWNERS‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -756,10 +756,10 @@
756756
# ServiceOwners: @rhurey @dargilco
757757

758758
# PRLabel: %Microsoft Playwright Testing
759-
/sdk/playwrighttesting/ @shreyaanand @mjmadhu
759+
/sdk/playwrighttesting/ @Sid200026 @puagarwa @ShreyaAnand
760760

761761
# ServiceLabel: %Microsoft Playwright Testing
762-
# ServiceOwners: @shreyaanand @mjmadhu
762+
# ServiceOwners: @Sid200026 @puagarwa @ShreyaAnand
763763

764764
# ServiceLabel: %Policy
765765
# ServiceOwners: @aperezcloud @kenieva

‎eng/Packages.Data.props‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,11 @@
178178
<PackageReference Update="OpenAI" Version="2.1.0-beta.1" />
179179
</ItemGroup>
180180

181+
<ItemGroup Condition="$(MSBuildProjectName.StartsWith('Azure.Developer.MicrosoftPlaywrightTesting'))">
182+
<PackageReference Update="Microsoft.TestPlatform.ObjectModel" Version="17.10.0" />
183+
<PackageReference Update="NUnit" Version="3.13.2" />
184+
</ItemGroup>
185+
181186
<!--
182187
Dependency versions for Track 2, Microsoft.* libraries.
183188
These are dependencies for Track 2 integration packages

‎sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.NUnit/Azure.Developer.MicrosoftPlaywrightTesting.NUnit.sln‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
2+
Microsoft Visual Studio Solution File, Format Version 12.00
3+
# Visual Studio Version 17
4+
VisualStudioVersion = 17.0.31903.59
5+
MinimumVisualStudioVersion = 10.0.40219.1
6+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Azure.Developer.MicrosoftPlaywrightTesting.NUnit", "src\Azure.Developer.MicrosoftPlaywrightTesting.NUnit.csproj", "{CF3C8F52-D3FD-4338-9432-58FF4BF4475E}"
7+
EndProject
8+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Azure.Developer.MicrosoftPlaywrightTesting.NUnit.Tests", "tests\Azure.Developer.MicrosoftPlaywrightTesting.NUnit.Tests.csproj", "{081210F2-A9F8-4137-97F4-5D5EF238B553}"
9+
EndProject
10+
Global
11+
GlobalSection(SolutionConfigurationPlatforms) = preSolution
12+
Debug|Any CPU = Debug|Any CPU
13+
Release|Any CPU = Release|Any CPU
14+
EndGlobalSection
15+
GlobalSection(SolutionProperties) = preSolution
16+
HideSolutionNode = FALSE
17+
EndGlobalSection
18+
GlobalSection(ProjectConfigurationPlatforms) = postSolution
19+
{CF3C8F52-D3FD-4338-9432-58FF4BF4475E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
20+
{CF3C8F52-D3FD-4338-9432-58FF4BF4475E}.Debug|Any CPU.Build.0 = Debug|Any CPU
21+
{CF3C8F52-D3FD-4338-9432-58FF4BF4475E}.Release|Any CPU.ActiveCfg = Release|Any CPU
22+
{CF3C8F52-D3FD-4338-9432-58FF4BF4475E}.Release|Any CPU.Build.0 = Release|Any CPU
23+
{081210F2-A9F8-4137-97F4-5D5EF238B553}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
24+
{081210F2-A9F8-4137-97F4-5D5EF238B553}.Debug|Any CPU.Build.0 = Debug|Any CPU
25+
{081210F2-A9F8-4137-97F4-5D5EF238B553}.Release|Any CPU.ActiveCfg = Release|Any CPU
26+
{081210F2-A9F8-4137-97F4-5D5EF238B553}.Release|Any CPU.Build.0 = Release|Any CPU
27+
EndGlobalSection
28+
EndGlobal

‎sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.NUnit/CHANGELOG.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Release History
2+
3+
## 1.0.0-beta.1 (2024-09-11)
4+
5+
### Features Added
6+
7+
- Added authentication using Microsoft Entra ID for the service.
8+
- Added reporting capabilities for the service. You can now publish the reports and artifacts generated by Playwright OSS to the service.

‎sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.NUnit/Directory.Build.props‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
<Project ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
2+
<!--
3+
Add any shared properties you want for the projects under this package directory that need to be set before the auto imported Directory.Build.props
4+
-->
5+
<Import Project="$([MSBuild]::GetDirectoryNameOfFileAbove($(MSBuildThisFileDirectory).., Directory.Build.props))\Directory.Build.props" />
6+
</Project>

‎sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.NUnit/README.md‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
# Microsoft Azure Playwright Testing NUnit client library for .NET
2+
3+
Microsoft Playwright Testing is a fully managed service that uses the cloud to enable you to run Playwright tests with much higher parallelization across different operating system-browser combinations simultaneously. This means faster test runs with broader scenario coverage, which helps speed up delivery of features without sacrificing quality. The service also enables you to publish test results and related artifacts to the service and view them in the service portal enabling faster and easier troubleshooting. With Microsoft Playwright Testing service, you can release features faster and more confidently.
4+
5+
Ready to get started? Jump into our [quickstart guide]<!--(https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.NUnit/README.md#getting-started)-->!
6+
7+
## Useful links
8+
- [Quickstart: Run end-to-end tests at scale](https://aka.ms/mpt/quickstart)
9+
- [View Microsoft Playwright Testing service demo](https://youtu.be/GenC1jAeTZE)
10+
- [Documentation](https://aka.ms/mpt/docs)
11+
- [Pricing](https://aka.ms/mpt/pricing)
12+
- [Share feedback](https://aka.ms/mpt/feedback)
13+
14+
## Getting started
15+
16+
### Install the package
17+
18+
Install the client library for .NET with [NuGet](https://www.nuget.org/):
19+
20+
```dotnetcli
21+
dotnet add package Azure.Developer.MicrosoftPlaywrightTesting.NUnit --prerelease
22+
```
23+
24+
### Prerequisites
25+
26+
- An [Azure subscription](https://azure.microsoft.com/free/dotnet/)
27+
- Your Azure account must be assigned the [Owner](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#owner), [Contributor](https://learn.microsoft.com/azure/role-based-access-control/built-in-roles#contributor), or one of the [classic administrator roles](https://learn.microsoft.com/azure/role-based-access-control/rbac-and-directory-admin-roles#classic-subscription-administrator-roles).
28+
29+
### Authenticate the client
30+
31+
To learn more about options for Microsoft Entra Id authentication, refer to [Azure.Identity credentials](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity#credentials). You can also refer to [our samples]<!--(https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.NUnit/samples/Sample1_CustomisingServiceParameters.md)--> on how to configurate different Azure Identity credentials.
32+
33+
#### Create a Workspace
34+
35+
1. Sign in to the [Playwright portal](https://aka.ms/mpt/portal) with your Azure account.
36+
37+
2. Create the Workspace
38+
39+
![Create new workspace](https://github.com/microsoft/playwright-testing-service/assets/12104064/d571e86b-9d43-48ac-a2b7-63afb9bb86a8)
40+
41+
|Field |Description |
42+
|---------|---------|
43+
|**Workspace Name** | A unique name to identify your workspace.<BR>The name can't contain special characters or whitespace. |
44+
|**Azure Subscription** | Select an Azure subscription where you want to create the workspace. |
45+
|**Region** | This is where test run data will be stored for your workspace. |
46+
47+
> [!NOTE]
48+
> If you don't see this screen, select an existing workspace and go to the next section.
49+
```
50+
51+
### Set up Microsoft Playwright Testing
52+
53+
Create a file `PlaywrightServiceSetup.cs` in the root directory with the below content
54+
55+
```C# Snippet:Sample2_SetDefaultAuthenticationMechanism
56+
using Azure.Developer.MicrosoftPlaywrightTesting.NUnit;
57+
58+
namespace PlaywrightATests; // Remember to change this as per your project namespace
59+
60+
[SetUpFixture]
61+
public class PlaywrightServiceSetup : PlaywrightServiceNUnit {};
62+
```
63+
64+
> [!NOTE]
65+
> Make sure your project uses `Microsoft.Playwright.NUnit` version 1.37 or above.
66+
67+
### Obtain region endpoint
68+
69+
1. In the [Playwright portal](https://aka.ms/mpt/portal), copy the command under **Add region endpoint in your set up**.
70+
71+
![Set workspace endpoint](https://github.com/microsoft/playwright-testing-service/assets/12104064/d81ca629-2b23-4d34-8b70-67b6f7061a83)
72+
73+
The endpoint URL corresponds to the workspace region. You might see a different endpoint URL in the Playwright portal, depending on the region you selected when creating the workspace.
74+
75+
### Set up environment
76+
77+
Ensure that the `PLAYWRIGHT_SERVICE_URL` that you obtained in previous step is available in your environment.
78+
79+
### Run the tests
80+
81+
Run Playwright tests against browsers managed by the service using the configuration you created above.
82+
83+
```dotnetcli
84+
dotnet test --logger "ms-playwright-service"
85+
```
86+
87+
## Key concepts
88+
89+
Key concepts of the Microsoft Playwright Testing NUnit SDK for .NET can be found [here](https://aka.ms/mpt/what-is-mpt)
90+
91+
## Examples
92+
93+
Code samples for using this SDK can be found in the following locations
94+
- [.NET Microsoft Playwright Testing NUnit Library Code Samples](https://aka.ms/mpt/sample)
95+
96+
## Troubleshooting
97+
98+
- File an issue via [GitHub Issues](https://github.com/Azure/azure-sdk-for-net/issues).
99+
- Check [previous questions](https://stackoverflow.com/questions/tagged/azure+.net) or ask new ones on Stack Overflow using Azure and .NET tags.
100+
101+
## Next steps
102+
103+
- Run tests in a [CI/CD pipeline.](https://aka.ms/mpt/configure-pipeline)
104+
105+
- Learn how to [manage access](https://aka.ms/mpt/manage-access) to the created workspace.
106+
107+
- Experiment with different number of workers to [determine the optimal configuration of your test suite](https://aka.ms/mpt/parallelism).
108+
109+
## Contributing
110+
This project welcomes contributions and suggestions. Most contributions require
111+
you to agree to a Contributor License Agreement (CLA) declaring that you have
112+
the right to, and actually do, grant us the rights to use your contribution. For
113+
details, visit [cla.microsoft.com][cla].
114+
115+
This project has adopted the [Microsoft Open Source Code of Conduct][coc].
116+
For more information see the [Code of Conduct FAQ][coc_faq] or contact
117+
[[email protected]][coc_contact] with any additional questions or comments.
118+
119+
![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net/sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.NUnit/README.png)

‎sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.NUnit/api/Azure.Developer.MicrosoftPlaywrightTesting.NUnit.netstandard2.0.cs‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
namespace Azure.Developer.MicrosoftPlaywrightTesting.NUnit
2+
{
3+
[NUnit.Framework.SetUpFixtureAttribute]
4+
public partial class PlaywrightServiceNUnit : Azure.Developer.MicrosoftPlaywrightTesting.TestLogger.PlaywrightService
5+
{
6+
public PlaywrightServiceNUnit(Azure.Core.TokenCredential? credential = null) : base (default(Azure.Developer.MicrosoftPlaywrightTesting.TestLogger.PlaywrightServiceOptions), default(Azure.Core.TokenCredential)) { }
7+
public static Azure.Developer.MicrosoftPlaywrightTesting.TestLogger.PlaywrightServiceOptions playwrightServiceOptions { get { throw null; } }
8+
[NUnit.Framework.OneTimeSetUpAttribute]
9+
public System.Threading.Tasks.Task SetupAsync(System.Threading.CancellationToken cancellationToken = default(System.Threading.CancellationToken)) { throw null; }
10+
[NUnit.Framework.OneTimeTearDownAttribute]
11+
public void Teardown() { }
12+
}
13+
}

‎sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.NUnit/samples/README.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
page_type: sample
3+
languages:
4+
- csharp
5+
products:
6+
- azure
7+
- playwright-testing
8+
name: Azure.Developer.MicrosoftPlaywrightTesting.NUnit samples for .NET
9+
description: Samples for the Azure.Developer.MicrosoftPlaywrightTesting.NUnit client library
10+
---
11+
12+
# Azure.Developer.MicrosoftPlaywrightTesting.NUnit samples for .NET
13+
14+
- [Customising service parameters]<!--(https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.NUnit/samples/Sample1_CustomisingServiceParameters.md)-->
15+
- [Set default authentication mechanism]<!--(https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.NUnit/samples/Sample2_SetDefaultAuthenticationMechanism.md)-->

‎sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.NUnit/samples/Sample1_CustomisingServiceParameters.md‎

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
## Learn about different available service parameters and how to use them
2+
3+
Follow the steps listed in this [README]<!--(https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.NUnit/README.md)--> to integrate your existing Playwright test suite with the Microsoft Playwright Testing service.
4+
5+
This guide explains the different options available to you in the Azure.Developer.MicrosoftPlaywrightTesting.NUnit package and how to use them.
6+
7+
### Using .runsettings file
8+
9+
1. Create a `.runsettings` file in the root directory:
10+
11+
```xml
12+
<?xml version="1.0" encoding="utf-8"?>
13+
<RunSettings>
14+
<TestRunParameters>
15+
<!-- The below parameters are optional -->
16+
<Parameter name="Os" value="linux" />
17+
<Parameter name="RunId" value="sample-run-id" />
18+
<Parameter name="ExposeNetwork" value="<loopback>" />
19+
<Parameter name="ServiceAuth" value="EntraId" />
20+
<Parameter name="UseCloudHostedBrowsers" value="true" />
21+
<Parameter name="AzureTokenCredentialType" value="DefaultAzureCredential" />
22+
<Parameter name="ManagedIdentityClientId" value="77bfc267-86cb-4eeb-9e4a-747a217a318c" />
23+
<Parameter name="EnableGitHubSummary" value="false" />
24+
</TestRunParameters>
25+
<!-- Enable Reporting feature -->
26+
<LoggerRunSettings>
27+
<Loggers>
28+
<Logger friendlyName="ms-playwright-service" enabled="true" />
29+
</Loggers>
30+
</LoggerRunSettings>
31+
</RunSettings>
32+
```
33+
34+
> [!NOTE]
35+
> You can also modify the runid by setting the environment variable `PLAYWRIGHT_SERVICE_RUN_ID`.
36+
37+
2. Run tests using the above `.runsettings` file:
38+
39+
```dotnetcli
40+
dotnet test --settings .runsettings
41+
```
42+
43+
#### Known issue: Minimal support for Azure Identity library credentials
44+
45+
This issue only impacts the reporting feature. Currently, the service provides minimal support for the following [Azure Credential types.](https://learn.microsoft.com/dotnet/api/overview/azure/identity-readme?view=azure-dotnet#credential-classes)
46+
47+
Along with this, we also support passing a Managed Identity ClientId to be used along with `DefaultAzureCredential` and `ManagedIdentityCredential`.
48+
49+
If you only want to use cloud-hosted browsers along with your tests, you can disable the reporting feature by removing the logger from the runsettings file and then modify the `PlaywrightServiceSetup.cs` file as per the following.
50+
51+
```C# Snippet:Sample1_CustomisingServiceParameters
52+
using Azure.Core;
53+
using Azure.Developer.MicrosoftPlaywrightTesting.NUnit;
54+
using Azure.Identity;
55+
56+
namespace PlaywrightTests;
57+
58+
[SetUpFixture]
59+
public class PlaywrightServiceSetup : PlaywrightServiceNUnit
60+
{
61+
public static readonly TokenCredential managedIdentityCredential = new ManagedIdentityCredential();
62+
63+
public PlaywrightServiceSetup() : base(managedIdentityCredential) {}
64+
}
65+
```
66+
67+
## Options
68+
69+
1. **`Os`**:
70+
- **Description**: This setting allows you to choose the operating system where the browsers running Playwright tests will be hosted.
71+
- **Available Options**:
72+
- `System.Runtime.InteropServices.OSPlatform.Windows` for Windows OS.
73+
- `System.Runtime.InteropServices.OSPlatform.LINUX` for Linux OS.
74+
- **Default Value**: `System.Runtime.InteropServices.OSPlatform.LINUX`
75+
76+
2. **`RunId`**:
77+
- **Description**: This setting allows you to set a unique ID for every test run to distinguish them in the service portal.
78+
79+
3. **`ExposeNetwork`**:
80+
- **Description**: This settings exposes network available on the connecting client to the browser being connected to.
81+
82+
4. **`ServiceAuth`**
83+
- **Description**: This setting allows you to specify the default authentication mechanism to be used for sending requests to the service.
84+
- **Available Options**:
85+
- `ServiceAuthType.EntraId` for Microsoft Entra ID authentication.
86+
- `ServiceAuthType.AccessToken` for MPT Access Token authentication.
87+
- **Default Value**: `ServiceAuthType.EntraId`
88+
89+
5. **`UseCloudHostedBrowsers`**
90+
- **Description**: This setting allows you to select whether to use cloud-hosted browsers to run your Playwright tests. Reporting features remain available even if you disable this setting.
91+
- **Default Value**: `true`
92+
93+
6. **`AzureTokenCredentialType`**:
94+
- **Description**: This setting allows you to select the authentication method you want to use with Entra.
95+
- **Available Options**:
96+
- `AzureTokenCredentialType.EnvironmentCredential`
97+
- `AzureTokenCredentialType.WorkloadIdentityCredential`
98+
- `AzureTokenCredentialType.ManagedIdentityCredential`
99+
- `AzureTokenCredentialType.SharedTokenCacheCredential`
100+
- `AzureTokenCredentialType.VisualStudioCredential`
101+
- `AzureTokenCredentialType.VisualStudioCodeCredential`
102+
- `AzureTokenCredentialType.AzureCliCredential`
103+
- `AzureTokenCredentialType.AzurePowerShellCredential`
104+
- `AzureTokenCredentialType.AzureDeveloperCliCredential`
105+
- `AzureTokenCredentialType.InteractiveBrowserCredential`
106+
- `AzureTokenCredentialType.DefaultAzureCredential`
107+
- **Default Value**: `AzureTokenCredentialType.DefaultAzureCredential`
108+
109+
7. **`ManagedIdentityClientId`**
110+
- **Description**: This setting allows you to specify the managed identity client id to be used for Microsoft Entra Id authentication.
111+
112+
8. **`EnableGitHubSummary`**:
113+
- **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.
114+
- **Default Value**: `true`
115+

‎sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.NUnit/samples/Sample2_SetDefaultAuthenticationMechanism.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# How to authenticate to Microsoft Playwright Testing service using service access token.
2+
3+
Follow the steps listed in this [README]<!--(https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.NUnit/README.md)--> to integrate your existing Playwright test suite with the Microsoft Playwright Testing service.
4+
5+
This guide will walk you through the steps to integrate your Playwright project where you are launching browsers from within the tests with the service.
6+
7+
### Setup Microsoft Playwright Testing
8+
9+
1. Create a file `PlaywrightServiceSetup.cs` in the root directory with the following
10+
11+
```C# Snippet:Sample2_SetDefaultAuthenticationMechanism
12+
using Azure.Developer.MicrosoftPlaywrightTesting.NUnit;
13+
14+
namespace PlaywrightATests; // Remember to change this as per your project namespace
15+
16+
[SetUpFixture]
17+
public class PlaywrightServiceSetup : PlaywrightServiceNUnit {};
18+
```
19+
20+
2. Create a .runsettings file to modify default authentication mechanism.
21+
22+
```xml
23+
<?xml version="1.0" encoding="utf-8"?>
24+
<RunSettings>
25+
<TestRunParameters>
26+
<!-- Set the service auth type as AccessToken -->
27+
<Parameter name="ServiceAuth" value="AccessToken" />
28+
</TestRunParameters>
29+
</RunSettings>
30+
```
31+
32+
> [!NOTE]
33+
> Make sure your project uses Microsoft.Playwright.NUnit version 1.37 or above.
34+
35+
### Obtain region endpoint
36+
37+
1. In the [Playwright portal](https://aka.ms/mpt/portal), copy the command under **Add region endpoint in your set up**.
38+
39+
![Set workspace endpoint](https://github.com/microsoft/playwright-testing-service/assets/12104064/d81ca629-2b23-4d34-8b70-67b6f7061a83)
40+
41+
The endpoint URL corresponds to the workspace region. You might see a different endpoint URL in the Playwright portal, depending on the region you selected when creating the workspace.
42+
43+
### Set up environment
44+
45+
Ensure that the `PLAYWRIGHT_SERVICE_URL` that you obtained in previous step is available in your environment.
46+
47+
### Authenticate the client
48+
49+
To learn more about options for Microsoft Entra Id authentication, refer to [Azure.Identity credentials](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/identity/Azure.Identity#credentials). You can also refer to [our samples]<!--(https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/playwrighttesting/Azure.Developer.MicrosoftPlaywrightTesting.NUnit/samples/Sample1_CustomisingServiceParameters.md)--> on how to configurate different Azure Identity credentials.
50+
51+
### Run the tests
52+
53+
Run Playwright tests against browsers managed by the service using the configuration you created above.
54+
55+
```dotnetcli
56+
dotnet test --settings .runsettings
57+
```

0 commit comments

Comments
 (0)