| Page Type | Languages | Key Services | Tools |
|---|---|---|---|
| Sample | .NET Core | Azure App Service Azure DevOps (Pipelines, Releases, Test Plans) |
Playwright Visual Studio |
This sample codebase demonstrates how to set up and run automated Playwright tests integrated with Azure DevOps Test Plans against a web application running on App Service in Azure.
This example should be viewed as a foundation for modification and expansion into more complex applications.
- An Azure Subscription - for hosting cloud infrastructure
- Azure DevOps with Test Plans licensing - for managing and running automated tests
- Az CLI - for deploying Azure infrastructure as code
- .NET Core - for web application and Playwright development
- Visual Studio - for development and associating test cases to plans
- Run the script
Devops/Infrastructure/env.ps1, passing in your desired resource names as parameters. - This will create a Resource Group, App Service Plan, and App Service.
The following is described in greater detail in the Playwright documentation here. The following commands are run in the command prompt (Windows).
-
The
WebApplication1directory contains a web project (WebApplication1/WebApplication1) and a testing project (WebApplication1/PlaywrightTests). The Playwright tests project was created as an NUnit project. -
To develop locally with Playwright, you need to install the library into the project by running the following command in the project directory:
dotnet add package Microsoft.Playwright.Nunit -
Then, the project needs to be built, which generates a file that enables you to install the required browser binaries. Run
dotnet build, and once complete, run the following in a command prompt (where netX is your output folder name):pwsh bin/Debug/netX/playwright.ps1 install
A sample test for this project was written in WebApplication1/PlaywrightTests/WebAppTest.cs, which simply checks that clicking the privacy link in the web app navigates to the privacy page. To test this locally, start the webapp on a localhost port, then run the test in Visual Studio.
-
This project contains
WebApplication1/PlaywrightTests/.runsettings, which is a Playwright configuration file that can be modified to denote which browser should be used for testing, whether the browser should run in headless mode, if the execution steps should be slowed down (this makes it easier to watch the tests execute locally), and more. -
This project also contains
WebApplication1/PlaywrightTests/appsettings.test.json, which is a custom configuration file used to denote the host URL of the web application being tested. This file sets the URL as localhost for testing, but will be updated via variable substitution in the continuous deployment pipeline for testing against the live web application.
Note that the build and release pipelines in this guide use Microsoft-hosted agents that run on Windows OS. The below steps may vary slightly if you choose another OS or agent hosting option.
To begin the process of generating the artifacts to test, a build pipeline needs to be created. The Devops/Build/webapp-tests-ci.yml file is pipeline-as-code that builds the .NET Web Application in the repository and publishes the binaries to an artifact along with the Playwright test binaries as .dll files. The publication of the test binaries is a critical step to enabling execution of the Playwright tests via Test Plans.
Learn more about how to publish a build pipeline in Azure DevOps using YAML here.
In order to execute the automated Playwright tests via Test Plans, a Release pipeline needs to be set up so that it can be configured via Test Plan Settings. This release pipeline will also deploy the web application to Azure using the artifact published in the build.
A service connection needs to be created to enable the release of the WebApplication1 code to the App Service created above.
Follow this guide to create a service connection to your Azure subscription.
Example of a simple release pipeline with deployment and testing stages.
Set the trigger of the release pipeline to be the artifact produced from the build pipeline. See this guide to learn more.
Create a stage for deploying WebApplication1 to the App Service created above using the service connection. In the above image, this stage is called 'Deploy'. This guide describes how to use the Azure Web App task to deploy the solution to App Service.
Use the App Service Deploy task to release the app code to Azure.
Running the 'Deploy' stage of the Release pipeline will deploy the web application to the App Service.
Setup and execution steps for running Playwright tests.
-
File Transform step: The
WebApplication1/PlaywrightTests/appsettings.test.jsoncontains aurlvalue which needs to be updated to point to the URL of the App Service deployed in the previous stage. Create a pipeline variable called 'url' and set the value to the URL of your app service. This can be found in the Azure Portal on the Overview tab of the App Service resource created above. If you're using a custom DNS, set that value as the 'url'.
-
Install Playwright step: Just like was done to run Playwright tests on your local machine, you need to ensure proper browsers are installed on the agent. The file you need to execute was published in the build artifact along with the test binaries; in this example, you should execute the following command in the PowerShell task:
$(System.DefaultWorkingDirectory)/_AzDO-Demo-Tests-CI/AzDO-Demo-Artifact/PlaywrightTests/PlaywrightTests/.playwright/node/win32_x64/playwright.cmd install -
VsTest step: Follow the steps under #6 in this guide to set up the VsTest task.
- To run tests linked to Test Plans, you need to choose 'Test run' as the 'Select tests using' option. Note that you will not be able to run this task directly via the Release Pipeline - it can only be run in Test Plans.
- Conversely, to run the test task directly in the Release Pipeline (not via Test Plans), choose 'Test assemblies' in the 'Select tests using' dropdown.
At this point, you will have the following:
- A working build pipeline which generates an artifact with the web app and test binaries
- An App Service resource in Azure
- Release stages that publish the app code to Azure and prepare the agent for Playwright test execution
To execute the Playwright tests with Test Plans, you now need to set up the test plan, tie it to the release pipeline, and associate the automated Playwright test to the test plan.
In order to execute tests, you must first create the test record in Test Plans. A test plan is made up of test suites, which are in turn made up of test cases. This hierarchy promotes organization of tests in a variety of ways; for example, a test plan may focus on a product or major module, a test suite may focus on more specific components that make up the product or module, and a test case may focus on an operation or set of steps that can be executed upon those components. This guide provides a comprehensive series of steps to create test plans, suites, and cases.
Once a test plan has been created, you can define where the automated tests associated to the test plan will be run. Note that the environment to run automated tests is scoped to a stage of a release pipeline at the test plan level. This guide (steps 1-4) walks through how to link the release pipeline created above to the test plan.
Once you have created a test case inside of your test plan + suite, you need to link your Playwright test to the test case, so that its automated completion can be reported back to the test case and work item, if linked.
Follow this guide to associate a Playwright test case in Visual Studio with a test case in Azure DevOps.
In the Visual Studio test explorer, make sure to drill all the way down to the test case:
Once you associate your Visual Studio test case with your Test Plans test case, you'll be able to confirm the association by editing the test case in Test Plans and opening the 'Associated Automation' tab:
A best practice when writing tests in Azure Test Plans is to link the tests to the feature/user story that the test is associated with. Read more about this here.
-
Now that you have your...
- Infrastructure provisioned in an environment in Azure
- Playwright test case(s) written
- Build pipeline producing test artifacts
- Release pipeline deploying app code and configured to run tests
- A test plan, suite, and case(s) defined
- Automated test(s) linked to your test case(s)
-
In Test Plans, run your test by choosing Run for web application:
You will be able to track the execution progress and outcomes in the Test Plans interface.
Test automation is a critical aspect of software development that can help improve the speed and quality of testing. Automated tests can be run quickly and frequently; however, test automation is only a small part of the continuous quality cycle. Continuous quality involves a holistic approach to quality assurance that also includes manual testing, code reviews, vulnerability checks, and several other quality checks throughout the development process. By combining these different approaches, teams can ensure that software is not only functional, but also reliable, maintainable, and user-friendly.
The diagram above shows an example of where in the development lifecycle test automation with Playwright via Test Plans could be created and executed: The tests may be written during feature development and then run on the QA environment. Alternatively, teams may also opt to wait for the UI to be stable before writing their functional tests.
Playwright has out-of-the-box support for all modern browsers and can be run locally as well as in build and release pipelines. Its modern automation capabilities make it a great candidate for running tests in scenarios like:
- End-to-end automated UI testing
- Regression testing
- Headless browser testing
Read more about "Why Playwright?" here.