├── .azure-pipelines └── publish.yml ├── .github └── workflows │ ├── ci.yml │ └── python-publish.yml ├── .gitignore ├── .pre-commit-config.yaml ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── SECURITY.md ├── conda_build_config.yaml ├── conda_build_config_asyncio.yaml ├── local-requirements.txt ├── meta.yaml ├── pytest-playwright-asyncio ├── LICENSE ├── README.md ├── pyproject.toml └── pytest_playwright_asyncio │ ├── __init__.py │ ├── py.typed │ └── pytest_playwright.py ├── pytest-playwright ├── LICENSE ├── README.md ├── pyproject.toml └── pytest_playwright │ ├── __init__.py │ ├── py.typed │ └── pytest_playwright.py ├── setup.cfg └── tests ├── assets └── django │ ├── __init__.py │ ├── settings.py │ └── urls.py ├── conftest.py ├── test_asyncio.py └── test_sync.py /.azure-pipelines/publish.yml: -------------------------------------------------------------------------------- 1 | pr: none 2 | 3 | trigger: 4 | tags: 5 | include: 6 | - '*' 7 | 8 | resources: 9 | repositories: 10 | - repository: 1esPipelines 11 | type: git 12 | name: 1ESPipelineTemplates/1ESPipelineTemplates 13 | ref: refs/tags/release 14 | 15 | extends: 16 | template: v1/1ES.Official.PipelineTemplate.yml@1esPipelines 17 | parameters: 18 | pool: 19 | name: DevDivPlaywrightAzurePipelinesUbuntu2204 20 | os: linux 21 | sdl: 22 | sourceAnalysisPool: 23 | name: DevDivPlaywrightAzurePipelinesWindows2022 24 | # The image must be windows-based due to restrictions of the SDL tools. See: https://aka.ms/AAo6v8e 25 | # In the case of a windows build, this can be the same as the above pool image. 26 | os: windows 27 | stages: 28 | - stage: Stage 29 | jobs: 30 | - job: Build 31 | templateContext: 32 | outputs: 33 | - output: pipelineArtifact 34 | path: $(Build.ArtifactStagingDirectory)/esrp-build 35 | artifact: esrp-build 36 | steps: 37 | - task: UsePythonVersion@0 38 | inputs: 39 | versionSpec: '3.9' 40 | displayName: 'Use Python' 41 | - script: | 42 | python -m pip install --upgrade pip 43 | pip install -r local-requirements.txt 44 | python -m build --outdir $(Build.ArtifactStagingDirectory)/esrp-build pytest-playwright 45 | python -m build --outdir $(Build.ArtifactStagingDirectory)/esrp-build pytest-playwright-asyncio 46 | displayName: 'Install & Build' 47 | - job: Publish 48 | dependsOn: Build 49 | templateContext: 50 | type: releaseJob 51 | isProduction: true 52 | inputs: 53 | - input: pipelineArtifact 54 | artifactName: esrp-build 55 | targetPath: $(Build.ArtifactStagingDirectory)/esrp-build 56 | steps: 57 | - checkout: none 58 | - task: EsrpRelease@9 59 | inputs: 60 | connectedservicename: 'Playwright-ESRP-PME' 61 | usemanagedidentity: true 62 | keyvaultname: 'playwright-esrp-pme' 63 | signcertname: 'ESRP-Release-Sign' 64 | clientid: '13434a40-7de4-4c23-81a3-d843dc81c2c5' 65 | intent: 'PackageDistribution' 66 | contenttype: 'PyPi' 67 | # Keeping it commented out as a workaround for: 68 | # https://portal.microsofticm.com/imp/v3/incidents/incident/499972482/summary 69 | # contentsource: 'folder' 70 | folderlocation: '$(Build.ArtifactStagingDirectory)/esrp-build' 71 | waitforreleasecompletion: true 72 | owners: 'maxschmitt@microsoft.com' 73 | approvers: 'maxschmitt@microsoft.com' 74 | serviceendpointurl: 'https://api.esrp.microsoft.com' 75 | mainpublisher: 'Playwright' 76 | domaintenantid: '975f013f-7f24-47e8-a7d3-abc4752bf346' 77 | displayName: 'ESRP Release to PIP' 78 | -------------------------------------------------------------------------------- /.github/workflows/ci.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | push: 4 | branches: [ main ] 5 | pull_request: 6 | branches: [ main ] 7 | jobs: 8 | lint: 9 | runs-on: ubuntu-latest 10 | steps: 11 | - uses: actions/checkout@v4 12 | - name: Set up Python 13 | uses: actions/setup-python@v5 14 | with: 15 | python-version: 3.11 16 | - name: Install dependencies 17 | run: | 18 | python -m pip install --upgrade pip 19 | pip install -r local-requirements.txt 20 | - name: Lint 21 | run: pre-commit run --show-diff-on-failure --color=always --all-files 22 | build: 23 | timeout-minutes: 30 24 | strategy: 25 | fail-fast: false 26 | matrix: 27 | os: [ubuntu-latest, windows-latest, macos-latest] 28 | python-version: ['3.9', '3.10', '3.11'] 29 | include: 30 | - os: ubuntu-latest 31 | python-version: '3.12' 32 | - os: ubuntu-latest 33 | python-version: '3.13' 34 | runs-on: ${{ matrix.os }} 35 | steps: 36 | - uses: actions/checkout@v4 37 | - name: Set up Python ${{ matrix.python-version }} 38 | uses: actions/setup-python@v5 39 | with: 40 | python-version: ${{ matrix.python-version }} 41 | - name: Install dependencies 42 | shell: bash 43 | run: | 44 | python -m pip install --upgrade pip 45 | pip install -r local-requirements.txt 46 | pip install -e pytest-playwright 47 | pip install -e pytest-playwright-asyncio 48 | playwright install --with-deps 49 | if [ '${{ matrix.os }}' == 'macos-latest' ]; then 50 | playwright install msedge --with-deps 51 | fi 52 | - name: Test 53 | if: ${{ matrix.os != 'ubuntu-latest' }} 54 | run: pytest --cov=pytest_playwright --cov-report xml 55 | - name: Test on Linux 56 | if: ${{ matrix.os == 'ubuntu-latest' }} 57 | run: xvfb-run pytest --cov=pytest_playwright --cov-report xml 58 | build-conda: 59 | name: Conda Build 60 | strategy: 61 | fail-fast: false 62 | matrix: 63 | os: [ ubuntu-latest, macos-latest, windows-latest ] 64 | runs-on: ${{ matrix.os }} 65 | steps: 66 | - uses: actions/checkout@v4 67 | with: 68 | fetch-depth: 0 69 | - name: Get conda 70 | uses: conda-incubator/setup-miniconda@v3 71 | with: 72 | python-version: 3.9 73 | channels: microsoft,conda-forge 74 | - name: Prepare 75 | run: | 76 | conda install conda-build conda-verify 77 | # Until https://github.com/anaconda/conda-anaconda-telemetry/issues/87 has been fixed 78 | conda remove --name base conda-anaconda-telemetry 79 | - name: Build pytest-playwright 80 | run: conda build . 81 | - name: Build pytest-playwright-asyncio 82 | run: conda build --variant-config-file conda_build_config_asyncio.yaml . 83 | -------------------------------------------------------------------------------- /.github/workflows/python-publish.yml: -------------------------------------------------------------------------------- 1 | # This workflows will upload a Python Package using Twine when a release is created 2 | # For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries 3 | 4 | name: Upload Python Package 5 | on: 6 | release: 7 | types: [published] 8 | jobs: 9 | deploy-conda: 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v4 13 | with: 14 | fetch-depth: 0 15 | - name: Get conda 16 | uses: conda-incubator/setup-miniconda@v3 17 | with: 18 | python-version: 3.9 19 | channels: microsoft,conda-forge 20 | - name: Prepare 21 | run: | 22 | conda install anaconda-client conda-build conda-verify 23 | # Until https://github.com/anaconda/conda-anaconda-telemetry/issues/87 has been fixed 24 | conda remove --name base conda-anaconda-telemetry 25 | - name: Build and Upload 26 | env: 27 | ANACONDA_API_TOKEN: ${{ secrets.ANACONDA_API_TOKEN }} 28 | run: | 29 | conda config --set anaconda_upload yes 30 | conda build --user microsoft . 31 | conda build --user microsoft --variant-config-file conda_build_config_asyncio.yaml . 32 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | # Created by https://www.toptal.com/developers/gitignore/api/python 3 | # Edit at https://www.toptal.com/developers/gitignore?templates=python 4 | 5 | ### Python ### 6 | # Byte-compiled / optimized / DLL files 7 | __pycache__/ 8 | *.py[cod] 9 | *$py.class 10 | 11 | # C extensions 12 | *.so 13 | 14 | # Distribution / packaging 15 | .Python 16 | build/ 17 | develop-eggs/ 18 | dist/ 19 | downloads/ 20 | eggs/ 21 | .eggs/ 22 | lib/ 23 | lib64/ 24 | parts/ 25 | sdist/ 26 | var/ 27 | wheels/ 28 | pip-wheel-metadata/ 29 | share/python-wheels/ 30 | *.egg-info/ 31 | .installed.cfg 32 | *.egg 33 | MANIFEST 34 | 35 | # PyInstaller 36 | # Usually these files are written by a python script from a template 37 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 38 | *.manifest 39 | *.spec 40 | 41 | # Installer logs 42 | pip-log.txt 43 | pip-delete-this-directory.txt 44 | 45 | # Unit test / coverage reports 46 | htmlcov/ 47 | .tox/ 48 | .nox/ 49 | .coverage 50 | .coverage.* 51 | .cache 52 | nosetests.xml 53 | coverage.xml 54 | *.cover 55 | *.py,cover 56 | .hypothesis/ 57 | .pytest_cache/ 58 | 59 | # Translations 60 | *.mo 61 | *.pot 62 | 63 | # Django stuff: 64 | *.log 65 | local_settings.py 66 | db.sqlite3 67 | db.sqlite3-journal 68 | 69 | # Flask stuff: 70 | instance/ 71 | .webassets-cache 72 | 73 | # Scrapy stuff: 74 | .scrapy 75 | 76 | # Sphinx documentation 77 | docs/_build/ 78 | 79 | # PyBuilder 80 | target/ 81 | 82 | # Jupyter Notebook 83 | .ipynb_checkpoints 84 | 85 | # IPython 86 | profile_default/ 87 | ipython_config.py 88 | 89 | # pyenv 90 | .python-version 91 | 92 | # pipenv 93 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 94 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 95 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 96 | # install all needed dependencies. 97 | #Pipfile.lock 98 | 99 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 100 | __pypackages__/ 101 | 102 | # Celery stuff 103 | celerybeat-schedule 104 | celerybeat.pid 105 | 106 | # SageMath parsed files 107 | *.sage.py 108 | 109 | # Environments 110 | .env 111 | .venv 112 | env/ 113 | venv/ 114 | ENV/ 115 | env.bak/ 116 | venv.bak/ 117 | 118 | # Spyder project settings 119 | .spyderproject 120 | .spyproject 121 | 122 | # Rope project settings 123 | .ropeproject 124 | 125 | # mkdocs documentation 126 | /site 127 | 128 | # mypy 129 | .mypy_cache/ 130 | .dmypy.json 131 | dmypy.json 132 | 133 | # Pyre type checker 134 | .pyre/ 135 | 136 | # pytype static type analyzer 137 | .pytype/ 138 | 139 | # End of https://www.toptal.com/developers/gitignore/api/python 140 | .vscode 141 | 142 | # Jetbrains IDEs 143 | .idea 144 | 145 | .DS_Store 146 | /test-results/ 147 | -------------------------------------------------------------------------------- /.pre-commit-config.yaml: -------------------------------------------------------------------------------- 1 | # See https://pre-commit.com for more information 2 | # See https://pre-commit.com/hooks.html for more hooks 3 | repos: 4 | - repo: https://github.com/pre-commit/pre-commit-hooks 5 | rev: v5.0.0 6 | hooks: 7 | - id: trailing-whitespace 8 | - id: end-of-file-fixer 9 | - id: check-yaml 10 | exclude: meta.yaml 11 | - id: check-added-large-files 12 | - repo: https://github.com/psf/black 13 | rev: 24.10.0 14 | hooks: 15 | - id: black 16 | - repo: https://github.com/pre-commit/mirrors-mypy 17 | rev: v1.13.0 18 | hooks: 19 | - id: mypy 20 | additional_dependencies: [types-python-slugify==6.1.0] 21 | - repo: https://github.com/pycqa/flake8 22 | rev: 7.1.1 23 | hooks: 24 | - id: flake8 25 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Microsoft Open Source Code of Conduct 2 | 3 | This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). 4 | 5 | Resources: 6 | 7 | - [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/) 8 | - [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) 9 | - Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns 10 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | This project welcomes contributions and suggestions. Most contributions require you to agree to a 4 | Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us 5 | the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. 6 | 7 | When you submit a pull request, a CLA bot will automatically determine whether you need to provide 8 | a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions 9 | provided by the bot. You will only need to do this once across all repos using our CLA. 10 | 11 | This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). 12 | For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or 13 | contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. 14 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Portions Copyright (c) Microsoft Corporation. 190 | Portions Copyright 2017 Google Inc. 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Pytest plugin for Playwright [![PyPI](https://img.shields.io/pypi/v/pytest-playwright)](https://pypi.org/project/pytest-playwright/) 2 | 3 | Write end-to-end tests for your web apps with [Playwright](https://github.com/microsoft/playwright-python) and [pytest](https://docs.pytest.org/en/stable/). 4 | 5 | - Support for **all modern browsers** including Chromium, WebKit and Firefox. 6 | - Support for **headless and headed** execution. 7 | - **Built-in fixtures** that provide browser primitives to test functions. 8 | 9 | ## Documentation 10 | 11 | See on [playwright.dev](https://playwright.dev/python/docs/test-runners) for examples and more detailed information. 12 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | ## Security 4 | 5 | Microsoft takes the security of our software products and services seriously, which includes all source code repositories managed through our GitHub organizations, which include [Microsoft](https://github.com/Microsoft), [Azure](https://github.com/Azure), [DotNet](https://github.com/dotnet), [AspNet](https://github.com/aspnet), [Xamarin](https://github.com/xamarin), and [our GitHub organizations](https://opensource.microsoft.com/). 6 | 7 | If you believe you have found a security vulnerability in any Microsoft-owned repository that meets [Microsoft's definition of a security vulnerability](https://docs.microsoft.com/en-us/previous-versions/tn-archive/cc751383(v=technet.10)), please report it to us as described below. 8 | 9 | ## Reporting Security Issues 10 | 11 | **Please do not report security vulnerabilities through public GitHub issues.** 12 | 13 | Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report). 14 | 15 | If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc). 16 | 17 | You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc). 18 | 19 | Please include the requested information listed below (as much as you can provide) to help us better understand the nature and scope of the possible issue: 20 | 21 | * Type of issue (e.g. buffer overflow, SQL injection, cross-site scripting, etc.) 22 | * Full paths of source file(s) related to the manifestation of the issue 23 | * The location of the affected source code (tag/branch/commit or direct URL) 24 | * Any special configuration required to reproduce the issue 25 | * Step-by-step instructions to reproduce the issue 26 | * Proof-of-concept or exploit code (if possible) 27 | * Impact of the issue, including how an attacker might exploit the issue 28 | 29 | This information will help us triage your report more quickly. 30 | 31 | If you are reporting for a bug bounty, more complete reports can contribute to a higher bounty award. Please visit our [Microsoft Bug Bounty Program](https://microsoft.com/msrc/bounty) page for more details about our active programs. 32 | 33 | ## Preferred Languages 34 | 35 | We prefer all communications to be in English. 36 | 37 | ## Policy 38 | 39 | Microsoft follows the principle of [Coordinated Vulnerability Disclosure](https://www.microsoft.com/en-us/msrc/cvd). 40 | 41 | 42 | -------------------------------------------------------------------------------- /conda_build_config.yaml: -------------------------------------------------------------------------------- 1 | package: pytest-playwright 2 | -------------------------------------------------------------------------------- /conda_build_config_asyncio.yaml: -------------------------------------------------------------------------------- 1 | package: pytest-playwright-asyncio 2 | -------------------------------------------------------------------------------- /local-requirements.txt: -------------------------------------------------------------------------------- 1 | black==24.3.0 2 | pytest-cov==3.0.0 3 | mypy==0.961 4 | build==1.2.2.post1 5 | twine==4.0.1 6 | wheel==0.38.1 7 | flake8==7.1.1 8 | pre-commit==4.0.1 9 | Django==4.2.22 10 | pytest-xdist==2.5.0 11 | pytest-asyncio==1.0.0 12 | -------------------------------------------------------------------------------- /meta.yaml: -------------------------------------------------------------------------------- 1 | channels: 2 | - microsoft 3 | - conda-forge 4 | 5 | package: 6 | name: "{{ package }}" 7 | version: "{{ environ.get('GIT_DESCRIBE_TAG') | replace('v', '') }}" 8 | 9 | source: 10 | path: . 11 | 12 | build: 13 | number: 0 14 | noarch: python 15 | script: python -m pip install --no-deps --ignore-installed ./{{ package }} 16 | 17 | requirements: 18 | host: 19 | - python >=3.9 20 | - setuptools-scm 21 | - pip 22 | run: 23 | - python >=3.9 24 | - microsoft::playwright >=1.37.0 25 | - pytest >=6.2.4,<9.0.0 26 | - pytest-base-url >=1.0.0,<3.0.0 27 | - python-slugify >=6.0.0,<9.0.0 28 | {% if package == 'pytest-playwright-asyncio' %} 29 | - pytest-asyncio >=0.24.0 30 | {% endif %} 31 | 32 | test: 33 | imports: 34 | - "{{ package | replace('-', '_') }}" 35 | commands: 36 | - pip check 37 | requires: 38 | - pip 39 | 40 | about: 41 | home: https://github.com/microsoft/playwright-pytest 42 | summary: A pytest wrapper with {% if package == 'pytest-playwright-asyncio' %} async{% endif %}fixtures for Playwright to automate web browsers 43 | license: Apache-2.0 44 | license_file: LICENSE 45 | -------------------------------------------------------------------------------- /pytest-playwright-asyncio/LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Portions Copyright (c) Microsoft Corporation. 190 | Portions Copyright 2017 Google Inc. 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /pytest-playwright-asyncio/README.md: -------------------------------------------------------------------------------- 1 | # Pytest plugin for Playwright [![PyPI](https://img.shields.io/pypi/v/pytest-playwright-asyncio)](https://pypi.org/project/pytest-playwright-asyncio/) 2 | 3 | Write end-to-end tests for your web apps with [Playwright](https://github.com/microsoft/playwright-python) and [pytest](https://docs.pytest.org/en/stable/). 4 | 5 | - Support for **all modern browsers** including Chromium, WebKit and Firefox. 6 | - Support for **headless and headed** execution. 7 | - **Built-in fixtures** that provide browser primitives to test functions. 8 | 9 | ## Documentation 10 | 11 | See on [playwright.dev](https://playwright.dev/python/docs/test-runners) for examples and more detailed information. 12 | -------------------------------------------------------------------------------- /pytest-playwright-asyncio/pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["setuptools==75.4.0", "setuptools_scm==8.1.0"] 3 | build-backend = "setuptools.build_meta" 4 | 5 | [project] 6 | name = "pytest-playwright-asyncio" 7 | description = "A pytest wrapper with async fixtures for Playwright to automate web browsers" 8 | readme = "README.md" 9 | authors = [ 10 | {name = "Microsoft"} 11 | ] 12 | license = {file = "LICENSE"} 13 | requires-python = ">=3.9" 14 | classifiers = [ 15 | "Programming Language :: Python :: 3", 16 | "Programming Language :: Python :: 3.9", 17 | "Programming Language :: Python :: 3.10", 18 | "Programming Language :: Python :: 3.11", 19 | "Programming Language :: Python :: 3.12", 20 | "Programming Language :: Python :: 3.13", 21 | "License :: OSI Approved :: Apache Software License", 22 | "Operating System :: OS Independent", 23 | "Framework :: Pytest", 24 | ] 25 | dynamic = ["version"] 26 | dependencies = [ 27 | "playwright>=1.18", 28 | "pytest>=6.2.4,<9.0.0", 29 | "pytest-base-url>=1.0.0,<3.0.0", 30 | "python-slugify>=6.0.0,<9.0.0", 31 | "pytest-asyncio>=0.24.0", 32 | ] 33 | 34 | [project.urls] 35 | homepage = "https://github.com/microsoft/playwright-pytest" 36 | 37 | [project.entry-points.pytest11] 38 | playwright-asyncio = "pytest_playwright_asyncio.pytest_playwright" 39 | 40 | [tool.setuptools] 41 | packages = ["pytest_playwright_asyncio"] 42 | [tool.setuptools_scm] 43 | root = ".." 44 | -------------------------------------------------------------------------------- /pytest-playwright-asyncio/pytest_playwright_asyncio/__init__.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) Microsoft Corporation. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | from pytest_playwright_asyncio.pytest_playwright import CreateContextCallback 16 | 17 | __all__ = [ 18 | "CreateContextCallback", 19 | ] 20 | -------------------------------------------------------------------------------- /pytest-playwright-asyncio/pytest_playwright_asyncio/py.typed: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/microsoft/playwright-pytest/364145f3b56749a72ffa57efc9804768d84291f8/pytest-playwright-asyncio/pytest_playwright_asyncio/py.typed -------------------------------------------------------------------------------- /pytest-playwright-asyncio/pytest_playwright_asyncio/pytest_playwright.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) Microsoft Corporation. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | import hashlib 16 | import json 17 | import shutil 18 | import os 19 | import sys 20 | import warnings 21 | from pathlib import Path 22 | from typing import ( 23 | Any, 24 | AsyncGenerator, 25 | Awaitable, 26 | Callable, 27 | Dict, 28 | Generator, 29 | List, 30 | Literal, 31 | Optional, 32 | Protocol, 33 | Sequence, 34 | Union, 35 | Pattern, 36 | cast, 37 | ) 38 | 39 | import pytest 40 | from playwright.async_api import ( 41 | Browser, 42 | BrowserContext, 43 | BrowserType, 44 | Error, 45 | Page, 46 | Playwright, 47 | async_playwright, 48 | ProxySettings, 49 | StorageState, 50 | HttpCredentials, 51 | Geolocation, 52 | ViewportSize, 53 | ) 54 | import pytest_asyncio 55 | from slugify import slugify 56 | import tempfile 57 | 58 | 59 | @pytest.fixture(scope="session") 60 | def _pw_artifacts_folder() -> Generator[tempfile.TemporaryDirectory, None, None]: 61 | artifacts_folder = tempfile.TemporaryDirectory(prefix="playwright-pytest-") 62 | yield artifacts_folder 63 | try: 64 | # On Windows, files can be still in use. 65 | # https://github.com/microsoft/playwright-pytest/issues/163 66 | artifacts_folder.cleanup() 67 | except (PermissionError, NotADirectoryError): 68 | pass 69 | 70 | 71 | @pytest.fixture(scope="session", autouse=True) 72 | def delete_output_dir(pytestconfig: Any) -> None: 73 | output_dir = pytestconfig.getoption("--output") 74 | if os.path.exists(output_dir): 75 | try: 76 | shutil.rmtree(output_dir) 77 | except (FileNotFoundError, PermissionError): 78 | # When running in parallel, another thread may have already deleted the files 79 | pass 80 | except OSError as error: 81 | if error.errno != 16: 82 | raise 83 | # We failed to remove folder, might be due to the whole folder being mounted inside a container: 84 | # https://github.com/microsoft/playwright/issues/12106 85 | # https://github.com/microsoft/playwright-python/issues/1781 86 | # Do a best-effort to remove all files inside of it instead. 87 | entries = os.listdir(output_dir) 88 | for entry in entries: 89 | shutil.rmtree(entry) 90 | 91 | 92 | def pytest_generate_tests(metafunc: Any) -> None: 93 | if "browser_name" in metafunc.fixturenames: 94 | browsers = metafunc.config.option.browser or ["chromium"] 95 | metafunc.parametrize("browser_name", browsers, scope="session") 96 | 97 | 98 | def pytest_configure(config: Any) -> None: 99 | config.addinivalue_line( 100 | "markers", "skip_browser(name): mark test to be skipped a specific browser" 101 | ) 102 | config.addinivalue_line( 103 | "markers", "only_browser(name): mark test to run only on a specific browser" 104 | ) 105 | config.addinivalue_line( 106 | "markers", 107 | "browser_context_args(**kwargs): provide additional arguments to browser.new_context()", 108 | ) 109 | 110 | 111 | # Making test result information available in fixtures 112 | # https://docs.pytest.org/en/latest/example/simple.html#making-test-result-information-available-in-fixtures 113 | @pytest.hookimpl(tryfirst=True, hookwrapper=True) 114 | def pytest_runtest_makereport(item: Any) -> Generator[None, Any, None]: 115 | # execute all other hooks to obtain the report object 116 | outcome = yield 117 | rep = outcome.get_result() 118 | 119 | # set a report attribute for each phase of a call, which can 120 | # be "setup", "call", "teardown" 121 | 122 | setattr(item, "rep_" + rep.when, rep) 123 | 124 | 125 | def _get_skiplist(item: Any, values: List[str], value_name: str) -> List[str]: 126 | skipped_values: List[str] = [] 127 | # Allowlist 128 | only_marker = item.get_closest_marker(f"only_{value_name}") 129 | if only_marker: 130 | skipped_values = values 131 | skipped_values.remove(only_marker.args[0]) 132 | 133 | # Denylist 134 | skip_marker = item.get_closest_marker(f"skip_{value_name}") 135 | if skip_marker: 136 | skipped_values.append(skip_marker.args[0]) 137 | 138 | return skipped_values 139 | 140 | 141 | def pytest_runtest_setup(item: Any) -> None: 142 | if not hasattr(item, "callspec"): 143 | return 144 | browser_name = item.callspec.params.get("browser_name") 145 | if not browser_name: 146 | return 147 | 148 | skip_browsers_names = _get_skiplist( 149 | item, ["chromium", "firefox", "webkit"], "browser" 150 | ) 151 | 152 | if browser_name in skip_browsers_names: 153 | pytest.skip("skipped for this browser: {}".format(browser_name)) 154 | 155 | 156 | VSCODE_PYTHON_EXTENSION_ID = "ms-python.python" 157 | 158 | 159 | @pytest.fixture(scope="session") 160 | def browser_type_launch_args(pytestconfig: Any) -> Dict: 161 | launch_options = {} 162 | headed_option = pytestconfig.getoption("--headed") 163 | if headed_option: 164 | launch_options["headless"] = False 165 | elif VSCODE_PYTHON_EXTENSION_ID in sys.argv[0] and _is_debugger_attached(): 166 | # When the VSCode debugger is attached, then launch the browser headed by default 167 | launch_options["headless"] = False 168 | browser_channel_option = pytestconfig.getoption("--browser-channel") 169 | if browser_channel_option: 170 | launch_options["channel"] = browser_channel_option 171 | slowmo_option = pytestconfig.getoption("--slowmo") 172 | if slowmo_option: 173 | launch_options["slow_mo"] = slowmo_option 174 | return launch_options 175 | 176 | 177 | def _is_debugger_attached() -> bool: 178 | pydevd = sys.modules.get("pydevd") 179 | if not pydevd or not hasattr(pydevd, "get_global_debugger"): 180 | return False 181 | debugger = pydevd.get_global_debugger() 182 | if not debugger or not hasattr(debugger, "is_attached"): 183 | return False 184 | return debugger.is_attached() 185 | 186 | 187 | @pytest.fixture 188 | def output_path(pytestconfig: Any, request: pytest.FixtureRequest) -> str: 189 | output_dir = Path(pytestconfig.getoption("--output")).absolute() 190 | return os.path.join(output_dir, _truncate_file_name(slugify(request.node.nodeid))) 191 | 192 | 193 | def _truncate_file_name(file_name: str) -> str: 194 | if len(file_name) < 256: 195 | return file_name 196 | return f"{file_name[:100]}-{hashlib.sha256(file_name.encode()).hexdigest()[:7]}-{file_name[-100:]}" 197 | 198 | 199 | @pytest.fixture(scope="session") 200 | def browser_context_args( 201 | pytestconfig: Any, 202 | playwright: Playwright, 203 | device: Optional[str], 204 | base_url: Optional[str], 205 | _pw_artifacts_folder: tempfile.TemporaryDirectory, 206 | ) -> Dict: 207 | context_args = {} 208 | if device: 209 | context_args.update(playwright.devices[device]) 210 | if base_url: 211 | context_args["base_url"] = base_url 212 | 213 | video_option = pytestconfig.getoption("--video") 214 | capture_video = video_option in ["on", "retain-on-failure"] 215 | if capture_video: 216 | context_args["record_video_dir"] = _pw_artifacts_folder.name 217 | 218 | return context_args 219 | 220 | 221 | @pytest_asyncio.fixture(loop_scope="session") 222 | async def _artifacts_recorder( 223 | request: pytest.FixtureRequest, 224 | output_path: str, 225 | playwright: Playwright, 226 | pytestconfig: Any, 227 | _pw_artifacts_folder: tempfile.TemporaryDirectory, 228 | ) -> AsyncGenerator["ArtifactsRecorder", None]: 229 | artifacts_recorder = ArtifactsRecorder( 230 | pytestconfig, request, output_path, playwright, _pw_artifacts_folder 231 | ) 232 | yield artifacts_recorder 233 | # If request.node is missing rep_call, then some error happened during execution 234 | # that prevented teardown, but should still be counted as a failure 235 | failed = request.node.rep_call.failed if hasattr(request.node, "rep_call") else True 236 | await artifacts_recorder.did_finish_test(failed) 237 | 238 | 239 | @pytest_asyncio.fixture(scope="session") 240 | async def playwright() -> AsyncGenerator[Playwright, None]: 241 | pw = await async_playwright().start() 242 | yield pw 243 | await pw.stop() 244 | 245 | 246 | @pytest.fixture(scope="session") 247 | def browser_type(playwright: Playwright, browser_name: str) -> BrowserType: 248 | return getattr(playwright, browser_name) 249 | 250 | 251 | @pytest.fixture(scope="session") 252 | def connect_options() -> Optional[Dict]: 253 | return None 254 | 255 | 256 | @pytest.fixture(scope="session") 257 | def launch_browser( 258 | browser_type_launch_args: Dict, 259 | browser_type: BrowserType, 260 | connect_options: Optional[Dict], 261 | ) -> Callable[..., Awaitable[Browser]]: 262 | async def launch(**kwargs: Dict) -> Browser: 263 | launch_options = {**browser_type_launch_args, **kwargs} 264 | if connect_options: 265 | browser = await browser_type.connect( 266 | **( 267 | { 268 | **connect_options, 269 | "headers": { 270 | "x-playwright-launch-options": json.dumps(launch_options), 271 | **(connect_options.get("headers") or {}), 272 | }, 273 | } 274 | ) 275 | ) 276 | else: 277 | browser = await browser_type.launch(**launch_options) 278 | return browser 279 | 280 | return launch 281 | 282 | 283 | @pytest_asyncio.fixture(scope="session") 284 | async def browser( 285 | launch_browser: Callable[[], Awaitable[Browser]] 286 | ) -> AsyncGenerator[Browser, None]: 287 | browser = await launch_browser() 288 | yield browser 289 | await browser.close() 290 | 291 | 292 | class CreateContextCallback(Protocol): 293 | def __call__( 294 | self, 295 | viewport: Optional[ViewportSize] = None, 296 | screen: Optional[ViewportSize] = None, 297 | no_viewport: Optional[bool] = None, 298 | ignore_https_errors: Optional[bool] = None, 299 | java_script_enabled: Optional[bool] = None, 300 | bypass_csp: Optional[bool] = None, 301 | user_agent: Optional[str] = None, 302 | locale: Optional[str] = None, 303 | timezone_id: Optional[str] = None, 304 | geolocation: Optional[Geolocation] = None, 305 | permissions: Optional[Sequence[str]] = None, 306 | extra_http_headers: Optional[Dict[str, str]] = None, 307 | offline: Optional[bool] = None, 308 | http_credentials: Optional[HttpCredentials] = None, 309 | device_scale_factor: Optional[float] = None, 310 | is_mobile: Optional[bool] = None, 311 | has_touch: Optional[bool] = None, 312 | color_scheme: Optional[ 313 | Literal["dark", "light", "no-preference", "null"] 314 | ] = None, 315 | reduced_motion: Optional[Literal["no-preference", "null", "reduce"]] = None, 316 | forced_colors: Optional[Literal["active", "none", "null"]] = None, 317 | accept_downloads: Optional[bool] = None, 318 | default_browser_type: Optional[str] = None, 319 | proxy: Optional[ProxySettings] = None, 320 | record_har_path: Optional[Union[str, Path]] = None, 321 | record_har_omit_content: Optional[bool] = None, 322 | record_video_dir: Optional[Union[str, Path]] = None, 323 | record_video_size: Optional[ViewportSize] = None, 324 | storage_state: Optional[Union[StorageState, str, Path]] = None, 325 | base_url: Optional[str] = None, 326 | strict_selectors: Optional[bool] = None, 327 | service_workers: Optional[Literal["allow", "block"]] = None, 328 | record_har_url_filter: Optional[Union[str, Pattern[str]]] = None, 329 | record_har_mode: Optional[Literal["full", "minimal"]] = None, 330 | record_har_content: Optional[Literal["attach", "embed", "omit"]] = None, 331 | ) -> Awaitable[BrowserContext]: ... 332 | 333 | 334 | @pytest_asyncio.fixture(loop_scope="session") 335 | async def new_context( 336 | browser: Browser, 337 | browser_context_args: Dict, 338 | _artifacts_recorder: "ArtifactsRecorder", 339 | request: pytest.FixtureRequest, 340 | ) -> AsyncGenerator[CreateContextCallback, None]: 341 | browser_context_args = browser_context_args.copy() 342 | context_args_marker = next(request.node.iter_markers("browser_context_args"), None) 343 | additional_context_args = context_args_marker.kwargs if context_args_marker else {} 344 | browser_context_args.update(additional_context_args) 345 | contexts: List[BrowserContext] = [] 346 | 347 | async def _new_context(**kwargs: Any) -> BrowserContext: 348 | context = await browser.new_context(**browser_context_args, **kwargs) 349 | original_close = context.close 350 | 351 | async def _close_wrapper(*args: Any, **kwargs: Any) -> None: 352 | contexts.remove(context) 353 | await _artifacts_recorder.on_will_close_browser_context(context) 354 | await original_close(*args, **kwargs) 355 | 356 | context.close = _close_wrapper 357 | contexts.append(context) 358 | await _artifacts_recorder.on_did_create_browser_context(context) 359 | return context 360 | 361 | yield cast(CreateContextCallback, _new_context) 362 | for context in contexts.copy(): 363 | await context.close() 364 | 365 | 366 | @pytest_asyncio.fixture(loop_scope="session") 367 | async def context(new_context: CreateContextCallback) -> BrowserContext: 368 | return await new_context() 369 | 370 | 371 | @pytest_asyncio.fixture(loop_scope="session") 372 | async def page(context: BrowserContext) -> Page: 373 | return await context.new_page() 374 | 375 | 376 | @pytest.fixture(scope="session") 377 | def is_webkit(browser_name: str) -> bool: 378 | return browser_name == "webkit" 379 | 380 | 381 | @pytest.fixture(scope="session") 382 | def is_firefox(browser_name: str) -> bool: 383 | return browser_name == "firefox" 384 | 385 | 386 | @pytest.fixture(scope="session") 387 | def is_chromium(browser_name: str) -> bool: 388 | return browser_name == "chromium" 389 | 390 | 391 | @pytest.fixture(scope="session") 392 | def browser_name(pytestconfig: Any) -> Optional[str]: 393 | # When using unittest.TestCase it won't use pytest_generate_tests 394 | # For that we still try to give the user a slightly less feature-rich experience 395 | browser_names = pytestconfig.getoption("--browser") 396 | if len(browser_names) == 0: 397 | return "chromium" 398 | if len(browser_names) == 1: 399 | return browser_names[0] 400 | warnings.warn( 401 | "When using unittest.TestCase specifying multiple browsers is not supported" 402 | ) 403 | return browser_names[0] 404 | 405 | 406 | @pytest.fixture(scope="session") 407 | def browser_channel(pytestconfig: Any) -> Optional[str]: 408 | return pytestconfig.getoption("--browser-channel") 409 | 410 | 411 | @pytest.fixture(scope="session") 412 | def device(pytestconfig: Any) -> Optional[str]: 413 | return pytestconfig.getoption("--device") 414 | 415 | 416 | def pytest_addoption(parser: Any) -> None: 417 | group = parser.getgroup("playwright", "Playwright") 418 | group.addoption( 419 | "--browser", 420 | action="append", 421 | default=[], 422 | help="Browser engine which should be used", 423 | choices=["chromium", "firefox", "webkit"], 424 | ) 425 | group.addoption( 426 | "--headed", 427 | action="store_true", 428 | default=False, 429 | help="Run tests in headed mode.", 430 | ) 431 | group.addoption( 432 | "--browser-channel", 433 | action="store", 434 | default=None, 435 | help="Browser channel to be used.", 436 | ) 437 | group.addoption( 438 | "--slowmo", 439 | default=0, 440 | type=int, 441 | help="Run tests with slow mo", 442 | ) 443 | group.addoption( 444 | "--device", 445 | default=None, 446 | action="store", 447 | help="Device to be emulated.", 448 | ) 449 | group.addoption( 450 | "--output", 451 | default="test-results", 452 | help="Directory for artifacts produced by tests, defaults to test-results.", 453 | ) 454 | group.addoption( 455 | "--tracing", 456 | default="off", 457 | choices=["on", "off", "retain-on-failure"], 458 | help="Whether to record a trace for each test.", 459 | ) 460 | group.addoption( 461 | "--video", 462 | default="off", 463 | choices=["on", "off", "retain-on-failure"], 464 | help="Whether to record video for each test.", 465 | ) 466 | group.addoption( 467 | "--screenshot", 468 | default="off", 469 | choices=["on", "off", "only-on-failure"], 470 | help="Whether to automatically capture a screenshot after each test.", 471 | ) 472 | group.addoption( 473 | "--full-page-screenshot", 474 | action="store_true", 475 | default=False, 476 | help="Whether to take a full page screenshot", 477 | ) 478 | 479 | 480 | class ArtifactsRecorder: 481 | def __init__( 482 | self, 483 | pytestconfig: Any, 484 | request: pytest.FixtureRequest, 485 | output_path: str, 486 | playwright: Playwright, 487 | pw_artifacts_folder: tempfile.TemporaryDirectory, 488 | ) -> None: 489 | self._request = request 490 | self._pytestconfig = pytestconfig 491 | self._playwright = playwright 492 | self._output_path = output_path 493 | self._pw_artifacts_folder = pw_artifacts_folder 494 | 495 | self._all_pages: List[Page] = [] 496 | self._screenshots: List[str] = [] 497 | self._traces: List[str] = [] 498 | self._tracing_option = pytestconfig.getoption("--tracing") 499 | self._capture_trace = self._tracing_option in ["on", "retain-on-failure"] 500 | 501 | def _build_artifact_test_folder(self, folder_or_file_name: str) -> str: 502 | return os.path.join( 503 | self._output_path, 504 | _truncate_file_name(folder_or_file_name), 505 | ) 506 | 507 | async def did_finish_test(self, failed: bool) -> None: 508 | screenshot_option = self._pytestconfig.getoption("--screenshot") 509 | capture_screenshot = screenshot_option == "on" or ( 510 | failed and screenshot_option == "only-on-failure" 511 | ) 512 | if capture_screenshot: 513 | for index, screenshot in enumerate(self._screenshots): 514 | human_readable_status = "failed" if failed else "finished" 515 | screenshot_path = self._build_artifact_test_folder( 516 | f"test-{human_readable_status}-{index + 1}.png", 517 | ) 518 | os.makedirs(os.path.dirname(screenshot_path), exist_ok=True) 519 | shutil.move(screenshot, screenshot_path) 520 | else: 521 | for screenshot in self._screenshots: 522 | os.remove(screenshot) 523 | 524 | if self._tracing_option == "on" or ( 525 | failed and self._tracing_option == "retain-on-failure" 526 | ): 527 | for index, trace in enumerate(self._traces): 528 | trace_file_name = ( 529 | "trace.zip" if len(self._traces) == 1 else f"trace-{index + 1}.zip" 530 | ) 531 | trace_path = self._build_artifact_test_folder(trace_file_name) 532 | os.makedirs(os.path.dirname(trace_path), exist_ok=True) 533 | shutil.move(trace, trace_path) 534 | else: 535 | for trace in self._traces: 536 | os.remove(trace) 537 | 538 | video_option = self._pytestconfig.getoption("--video") 539 | preserve_video = video_option == "on" or ( 540 | failed and video_option == "retain-on-failure" 541 | ) 542 | if preserve_video: 543 | for index, page in enumerate(self._all_pages): 544 | video = page.video 545 | if not video: 546 | continue 547 | try: 548 | video_file_name = ( 549 | "video.webm" 550 | if len(self._all_pages) == 1 551 | else f"video-{index + 1}.webm" 552 | ) 553 | await video.save_as( 554 | path=self._build_artifact_test_folder(video_file_name) 555 | ) 556 | except Error: 557 | # Silent catch empty videos. 558 | pass 559 | else: 560 | for page in self._all_pages: 561 | # Can be changed to "if page.video" without try/except once https://github.com/microsoft/playwright-python/pull/2410 is released and widely adopted. 562 | if video_option in ["on", "retain-on-failure"]: 563 | try: 564 | if page.video: 565 | await page.video.delete() 566 | except Error: 567 | pass 568 | 569 | async def on_did_create_browser_context(self, context: BrowserContext) -> None: 570 | context.on("page", lambda page: self._all_pages.append(page)) 571 | if self._request and self._capture_trace: 572 | await context.tracing.start( 573 | title=slugify(self._request.node.nodeid), 574 | screenshots=True, 575 | snapshots=True, 576 | sources=True, 577 | ) 578 | 579 | async def on_will_close_browser_context(self, context: BrowserContext) -> None: 580 | if self._capture_trace: 581 | trace_path = Path(self._pw_artifacts_folder.name) / _create_guid() 582 | await context.tracing.stop(path=trace_path) 583 | self._traces.append(str(trace_path)) 584 | else: 585 | await context.tracing.stop() 586 | 587 | if self._pytestconfig.getoption("--screenshot") in ["on", "only-on-failure"]: 588 | for page in context.pages: 589 | try: 590 | screenshot_path = ( 591 | Path(self._pw_artifacts_folder.name) / _create_guid() 592 | ) 593 | await page.screenshot( 594 | timeout=5000, 595 | path=screenshot_path, 596 | full_page=self._pytestconfig.getoption( 597 | "--full-page-screenshot" 598 | ), 599 | ) 600 | self._screenshots.append(str(screenshot_path)) 601 | except Error: 602 | pass 603 | 604 | 605 | def _create_guid() -> str: 606 | return hashlib.sha256(os.urandom(16)).hexdigest() 607 | -------------------------------------------------------------------------------- /pytest-playwright/LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Portions Copyright (c) Microsoft Corporation. 190 | Portions Copyright 2017 Google Inc. 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /pytest-playwright/README.md: -------------------------------------------------------------------------------- 1 | # Pytest plugin for Playwright [![PyPI](https://img.shields.io/pypi/v/pytest-playwright)](https://pypi.org/project/pytest-playwright/) 2 | 3 | Write end-to-end tests for your web apps with [Playwright](https://github.com/microsoft/playwright-python) and [pytest](https://docs.pytest.org/en/stable/). 4 | 5 | - Support for **all modern browsers** including Chromium, WebKit and Firefox. 6 | - Support for **headless and headed** execution. 7 | - **Built-in fixtures** that provide browser primitives to test functions. 8 | 9 | **Note**: If you are looking for an asyncio version of this plugin, check out [pytest-playwright-asyncio](https://pypi.org/project/pytest-playwright-asyncio/). 10 | 11 | ## Documentation 12 | 13 | See on [playwright.dev](https://playwright.dev/python/docs/test-runners) for examples and more detailed information. 14 | -------------------------------------------------------------------------------- /pytest-playwright/pyproject.toml: -------------------------------------------------------------------------------- 1 | [build-system] 2 | requires = ["setuptools==75.4.0", "setuptools_scm==8.1.0"] 3 | build-backend = "setuptools.build_meta" 4 | 5 | [project] 6 | name = "pytest-playwright" 7 | description = "A pytest wrapper with fixtures for Playwright to automate web browsers" 8 | readme = "README.md" 9 | authors = [ 10 | {name = "Microsoft"} 11 | ] 12 | license = {file = "LICENSE"} 13 | requires-python = ">=3.9" 14 | classifiers = [ 15 | "Programming Language :: Python :: 3", 16 | "Programming Language :: Python :: 3.9", 17 | "Programming Language :: Python :: 3.10", 18 | "Programming Language :: Python :: 3.11", 19 | "Programming Language :: Python :: 3.12", 20 | "Programming Language :: Python :: 3.13", 21 | "License :: OSI Approved :: Apache Software License", 22 | "Operating System :: OS Independent", 23 | "Framework :: Pytest", 24 | ] 25 | dynamic = ["version"] 26 | dependencies = [ 27 | "playwright>=1.18", 28 | "pytest>=6.2.4,<9.0.0", 29 | "pytest-base-url>=1.0.0,<3.0.0", 30 | "python-slugify>=6.0.0,<9.0.0", 31 | ] 32 | 33 | [project.urls] 34 | homepage = "https://github.com/microsoft/playwright-pytest" 35 | 36 | [project.entry-points.pytest11] 37 | playwright = "pytest_playwright.pytest_playwright" 38 | 39 | [tool.setuptools] 40 | packages = ["pytest_playwright"] 41 | [tool.setuptools_scm] 42 | root = ".." 43 | -------------------------------------------------------------------------------- /pytest-playwright/pytest_playwright/__init__.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) Microsoft Corporation. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | from pytest_playwright.pytest_playwright import CreateContextCallback 16 | 17 | __all__ = [ 18 | "CreateContextCallback", 19 | ] 20 | -------------------------------------------------------------------------------- /pytest-playwright/pytest_playwright/py.typed: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/microsoft/playwright-pytest/364145f3b56749a72ffa57efc9804768d84291f8/pytest-playwright/pytest_playwright/py.typed -------------------------------------------------------------------------------- /pytest-playwright/pytest_playwright/pytest_playwright.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) Microsoft Corporation. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | import hashlib 16 | import json 17 | import shutil 18 | import os 19 | import sys 20 | import warnings 21 | from pathlib import Path 22 | from typing import ( 23 | Any, 24 | Callable, 25 | Dict, 26 | Generator, 27 | List, 28 | Literal, 29 | Optional, 30 | Protocol, 31 | Sequence, 32 | Union, 33 | Pattern, 34 | cast, 35 | ) 36 | 37 | import pytest 38 | from playwright.sync_api import ( 39 | Browser, 40 | BrowserContext, 41 | BrowserType, 42 | Error, 43 | Page, 44 | Playwright, 45 | sync_playwright, 46 | ProxySettings, 47 | StorageState, 48 | HttpCredentials, 49 | Geolocation, 50 | ViewportSize, 51 | ) 52 | from slugify import slugify 53 | import tempfile 54 | 55 | 56 | @pytest.fixture(scope="session") 57 | def _pw_artifacts_folder() -> Generator[tempfile.TemporaryDirectory, None, None]: 58 | artifacts_folder = tempfile.TemporaryDirectory(prefix="playwright-pytest-") 59 | yield artifacts_folder 60 | try: 61 | # On Windows, files can be still in use. 62 | # https://github.com/microsoft/playwright-pytest/issues/163 63 | artifacts_folder.cleanup() 64 | except (PermissionError, NotADirectoryError): 65 | pass 66 | 67 | 68 | @pytest.fixture(scope="session", autouse=True) 69 | def delete_output_dir(pytestconfig: Any) -> None: 70 | output_dir = pytestconfig.getoption("--output") 71 | if os.path.exists(output_dir): 72 | try: 73 | shutil.rmtree(output_dir) 74 | except (FileNotFoundError, PermissionError): 75 | # When running in parallel, another thread may have already deleted the files 76 | pass 77 | except OSError as error: 78 | if error.errno != 16: 79 | raise 80 | # We failed to remove folder, might be due to the whole folder being mounted inside a container: 81 | # https://github.com/microsoft/playwright/issues/12106 82 | # https://github.com/microsoft/playwright-python/issues/1781 83 | # Do a best-effort to remove all files inside of it instead. 84 | entries = os.listdir(output_dir) 85 | for entry in entries: 86 | shutil.rmtree(entry) 87 | 88 | 89 | def pytest_generate_tests(metafunc: Any) -> None: 90 | if "browser_name" in metafunc.fixturenames: 91 | browsers = metafunc.config.option.browser or ["chromium"] 92 | metafunc.parametrize("browser_name", browsers, scope="session") 93 | 94 | 95 | def pytest_configure(config: Any) -> None: 96 | config.addinivalue_line( 97 | "markers", "skip_browser(name): mark test to be skipped a specific browser" 98 | ) 99 | config.addinivalue_line( 100 | "markers", "only_browser(name): mark test to run only on a specific browser" 101 | ) 102 | config.addinivalue_line( 103 | "markers", 104 | "browser_context_args(**kwargs): provide additional arguments to browser.new_context()", 105 | ) 106 | 107 | 108 | # Making test result information available in fixtures 109 | # https://docs.pytest.org/en/latest/example/simple.html#making-test-result-information-available-in-fixtures 110 | @pytest.hookimpl(tryfirst=True, hookwrapper=True) 111 | def pytest_runtest_makereport(item: Any) -> Generator[None, Any, None]: 112 | # execute all other hooks to obtain the report object 113 | outcome = yield 114 | rep = outcome.get_result() 115 | 116 | # set a report attribute for each phase of a call, which can 117 | # be "setup", "call", "teardown" 118 | 119 | setattr(item, "rep_" + rep.when, rep) 120 | 121 | 122 | def _get_skiplist(item: Any, values: List[str], value_name: str) -> List[str]: 123 | skipped_values: List[str] = [] 124 | # Allowlist 125 | only_marker = item.get_closest_marker(f"only_{value_name}") 126 | if only_marker: 127 | skipped_values = values 128 | skipped_values.remove(only_marker.args[0]) 129 | 130 | # Denylist 131 | skip_marker = item.get_closest_marker(f"skip_{value_name}") 132 | if skip_marker: 133 | skipped_values.append(skip_marker.args[0]) 134 | 135 | return skipped_values 136 | 137 | 138 | def pytest_runtest_setup(item: Any) -> None: 139 | if not hasattr(item, "callspec"): 140 | return 141 | browser_name = item.callspec.params.get("browser_name") 142 | if not browser_name: 143 | return 144 | 145 | skip_browsers_names = _get_skiplist( 146 | item, ["chromium", "firefox", "webkit"], "browser" 147 | ) 148 | 149 | if browser_name in skip_browsers_names: 150 | pytest.skip("skipped for this browser: {}".format(browser_name)) 151 | 152 | 153 | VSCODE_PYTHON_EXTENSION_ID = "ms-python.python" 154 | 155 | 156 | @pytest.fixture(scope="session") 157 | def browser_type_launch_args(pytestconfig: Any) -> Dict: 158 | launch_options = {} 159 | headed_option = pytestconfig.getoption("--headed") 160 | if headed_option: 161 | launch_options["headless"] = False 162 | elif VSCODE_PYTHON_EXTENSION_ID in sys.argv[0] and _is_debugger_attached(): 163 | # When the VSCode debugger is attached, then launch the browser headed by default 164 | launch_options["headless"] = False 165 | browser_channel_option = pytestconfig.getoption("--browser-channel") 166 | if browser_channel_option: 167 | launch_options["channel"] = browser_channel_option 168 | slowmo_option = pytestconfig.getoption("--slowmo") 169 | if slowmo_option: 170 | launch_options["slow_mo"] = slowmo_option 171 | return launch_options 172 | 173 | 174 | def _is_debugger_attached() -> bool: 175 | pydevd = sys.modules.get("pydevd") 176 | if not pydevd or not hasattr(pydevd, "get_global_debugger"): 177 | return False 178 | debugger = pydevd.get_global_debugger() 179 | if not debugger or not hasattr(debugger, "is_attached"): 180 | return False 181 | return debugger.is_attached() 182 | 183 | 184 | @pytest.fixture 185 | def output_path(pytestconfig: Any, request: pytest.FixtureRequest) -> str: 186 | output_dir = Path(pytestconfig.getoption("--output")).absolute() 187 | return os.path.join(output_dir, _truncate_file_name(slugify(request.node.nodeid))) 188 | 189 | 190 | def _truncate_file_name(file_name: str) -> str: 191 | if len(file_name) < 256: 192 | return file_name 193 | return f"{file_name[:100]}-{hashlib.sha256(file_name.encode()).hexdigest()[:7]}-{file_name[-100:]}" 194 | 195 | 196 | @pytest.fixture(scope="session") 197 | def browser_context_args( 198 | pytestconfig: Any, 199 | playwright: Playwright, 200 | device: Optional[str], 201 | base_url: Optional[str], 202 | _pw_artifacts_folder: tempfile.TemporaryDirectory, 203 | ) -> Dict: 204 | context_args = {} 205 | if device: 206 | context_args.update(playwright.devices[device]) 207 | if base_url: 208 | context_args["base_url"] = base_url 209 | 210 | video_option = pytestconfig.getoption("--video") 211 | capture_video = video_option in ["on", "retain-on-failure"] 212 | if capture_video: 213 | context_args["record_video_dir"] = _pw_artifacts_folder.name 214 | 215 | return context_args 216 | 217 | 218 | @pytest.fixture() 219 | def _artifacts_recorder( 220 | request: pytest.FixtureRequest, 221 | output_path: str, 222 | playwright: Playwright, 223 | pytestconfig: Any, 224 | _pw_artifacts_folder: tempfile.TemporaryDirectory, 225 | ) -> Generator["ArtifactsRecorder", None, None]: 226 | artifacts_recorder = ArtifactsRecorder( 227 | pytestconfig, request, output_path, playwright, _pw_artifacts_folder 228 | ) 229 | yield artifacts_recorder 230 | # If request.node is missing rep_call, then some error happened during execution 231 | # that prevented teardown, but should still be counted as a failure 232 | failed = request.node.rep_call.failed if hasattr(request.node, "rep_call") else True 233 | artifacts_recorder.did_finish_test(failed) 234 | 235 | 236 | @pytest.fixture(scope="session") 237 | def playwright() -> Generator[Playwright, None, None]: 238 | pw = sync_playwright().start() 239 | yield pw 240 | pw.stop() 241 | 242 | 243 | @pytest.fixture(scope="session") 244 | def browser_type(playwright: Playwright, browser_name: str) -> BrowserType: 245 | return getattr(playwright, browser_name) 246 | 247 | 248 | @pytest.fixture(scope="session") 249 | def connect_options() -> Optional[Dict]: 250 | return None 251 | 252 | 253 | @pytest.fixture(scope="session") 254 | def launch_browser( 255 | browser_type_launch_args: Dict, 256 | browser_type: BrowserType, 257 | connect_options: Optional[Dict], 258 | ) -> Callable[..., Browser]: 259 | def launch(**kwargs: Dict) -> Browser: 260 | launch_options = {**browser_type_launch_args, **kwargs} 261 | if connect_options: 262 | browser = browser_type.connect( 263 | **( 264 | { 265 | **connect_options, 266 | "headers": { 267 | "x-playwright-launch-options": json.dumps(launch_options), 268 | **(connect_options.get("headers") or {}), 269 | }, 270 | } 271 | ) 272 | ) 273 | else: 274 | browser = browser_type.launch(**launch_options) 275 | return browser 276 | 277 | return launch 278 | 279 | 280 | @pytest.fixture(scope="session") 281 | def browser(launch_browser: Callable[[], Browser]) -> Generator[Browser, None, None]: 282 | browser = launch_browser() 283 | yield browser 284 | browser.close() 285 | 286 | 287 | class CreateContextCallback(Protocol): 288 | def __call__( 289 | self, 290 | viewport: Optional[ViewportSize] = None, 291 | screen: Optional[ViewportSize] = None, 292 | no_viewport: Optional[bool] = None, 293 | ignore_https_errors: Optional[bool] = None, 294 | java_script_enabled: Optional[bool] = None, 295 | bypass_csp: Optional[bool] = None, 296 | user_agent: Optional[str] = None, 297 | locale: Optional[str] = None, 298 | timezone_id: Optional[str] = None, 299 | geolocation: Optional[Geolocation] = None, 300 | permissions: Optional[Sequence[str]] = None, 301 | extra_http_headers: Optional[Dict[str, str]] = None, 302 | offline: Optional[bool] = None, 303 | http_credentials: Optional[HttpCredentials] = None, 304 | device_scale_factor: Optional[float] = None, 305 | is_mobile: Optional[bool] = None, 306 | has_touch: Optional[bool] = None, 307 | color_scheme: Optional[ 308 | Literal["dark", "light", "no-preference", "null"] 309 | ] = None, 310 | reduced_motion: Optional[Literal["no-preference", "null", "reduce"]] = None, 311 | forced_colors: Optional[Literal["active", "none", "null"]] = None, 312 | accept_downloads: Optional[bool] = None, 313 | default_browser_type: Optional[str] = None, 314 | proxy: Optional[ProxySettings] = None, 315 | record_har_path: Optional[Union[str, Path]] = None, 316 | record_har_omit_content: Optional[bool] = None, 317 | record_video_dir: Optional[Union[str, Path]] = None, 318 | record_video_size: Optional[ViewportSize] = None, 319 | storage_state: Optional[Union[StorageState, str, Path]] = None, 320 | base_url: Optional[str] = None, 321 | strict_selectors: Optional[bool] = None, 322 | service_workers: Optional[Literal["allow", "block"]] = None, 323 | record_har_url_filter: Optional[Union[str, Pattern[str]]] = None, 324 | record_har_mode: Optional[Literal["full", "minimal"]] = None, 325 | record_har_content: Optional[Literal["attach", "embed", "omit"]] = None, 326 | ) -> BrowserContext: ... 327 | 328 | 329 | @pytest.fixture 330 | def new_context( 331 | browser: Browser, 332 | browser_context_args: Dict, 333 | _artifacts_recorder: "ArtifactsRecorder", 334 | request: pytest.FixtureRequest, 335 | ) -> Generator[CreateContextCallback, None, None]: 336 | browser_context_args = browser_context_args.copy() 337 | context_args_marker = next(request.node.iter_markers("browser_context_args"), None) 338 | additional_context_args = context_args_marker.kwargs if context_args_marker else {} 339 | browser_context_args.update(additional_context_args) 340 | contexts: List[BrowserContext] = [] 341 | 342 | def _new_context(**kwargs: Any) -> BrowserContext: 343 | context = browser.new_context(**browser_context_args, **kwargs) 344 | original_close = context.close 345 | 346 | def _close_wrapper(*args: Any, **kwargs: Any) -> None: 347 | contexts.remove(context) 348 | _artifacts_recorder.on_will_close_browser_context(context) 349 | original_close(*args, **kwargs) 350 | 351 | context.close = _close_wrapper 352 | contexts.append(context) 353 | _artifacts_recorder.on_did_create_browser_context(context) 354 | return context 355 | 356 | yield cast(CreateContextCallback, _new_context) 357 | for context in contexts.copy(): 358 | context.close() 359 | 360 | 361 | @pytest.fixture 362 | def context(new_context: CreateContextCallback) -> BrowserContext: 363 | return new_context() 364 | 365 | 366 | @pytest.fixture 367 | def page(context: BrowserContext) -> Page: 368 | return context.new_page() 369 | 370 | 371 | @pytest.fixture(scope="session") 372 | def is_webkit(browser_name: str) -> bool: 373 | return browser_name == "webkit" 374 | 375 | 376 | @pytest.fixture(scope="session") 377 | def is_firefox(browser_name: str) -> bool: 378 | return browser_name == "firefox" 379 | 380 | 381 | @pytest.fixture(scope="session") 382 | def is_chromium(browser_name: str) -> bool: 383 | return browser_name == "chromium" 384 | 385 | 386 | @pytest.fixture(scope="session") 387 | def browser_name(pytestconfig: Any) -> Optional[str]: 388 | # When using unittest.TestCase it won't use pytest_generate_tests 389 | # For that we still try to give the user a slightly less feature-rich experience 390 | browser_names = pytestconfig.getoption("--browser") 391 | if len(browser_names) == 0: 392 | return "chromium" 393 | if len(browser_names) == 1: 394 | return browser_names[0] 395 | warnings.warn( 396 | "When using unittest.TestCase specifying multiple browsers is not supported" 397 | ) 398 | return browser_names[0] 399 | 400 | 401 | @pytest.fixture(scope="session") 402 | def browser_channel(pytestconfig: Any) -> Optional[str]: 403 | return pytestconfig.getoption("--browser-channel") 404 | 405 | 406 | @pytest.fixture(scope="session") 407 | def device(pytestconfig: Any) -> Optional[str]: 408 | return pytestconfig.getoption("--device") 409 | 410 | 411 | def pytest_addoption(parser: Any) -> None: 412 | group = parser.getgroup("playwright", "Playwright") 413 | group.addoption( 414 | "--browser", 415 | action="append", 416 | default=[], 417 | help="Browser engine which should be used", 418 | choices=["chromium", "firefox", "webkit"], 419 | ) 420 | group.addoption( 421 | "--headed", 422 | action="store_true", 423 | default=False, 424 | help="Run tests in headed mode.", 425 | ) 426 | group.addoption( 427 | "--browser-channel", 428 | action="store", 429 | default=None, 430 | help="Browser channel to be used.", 431 | ) 432 | group.addoption( 433 | "--slowmo", 434 | default=0, 435 | type=int, 436 | help="Run tests with slow mo", 437 | ) 438 | group.addoption( 439 | "--device", 440 | default=None, 441 | action="store", 442 | help="Device to be emulated.", 443 | ) 444 | group.addoption( 445 | "--output", 446 | default="test-results", 447 | help="Directory for artifacts produced by tests, defaults to test-results.", 448 | ) 449 | group.addoption( 450 | "--tracing", 451 | default="off", 452 | choices=["on", "off", "retain-on-failure"], 453 | help="Whether to record a trace for each test.", 454 | ) 455 | group.addoption( 456 | "--video", 457 | default="off", 458 | choices=["on", "off", "retain-on-failure"], 459 | help="Whether to record video for each test.", 460 | ) 461 | group.addoption( 462 | "--screenshot", 463 | default="off", 464 | choices=["on", "off", "only-on-failure"], 465 | help="Whether to automatically capture a screenshot after each test.", 466 | ) 467 | group.addoption( 468 | "--full-page-screenshot", 469 | action="store_true", 470 | default=False, 471 | help="Whether to take a full page screenshot", 472 | ) 473 | 474 | 475 | class ArtifactsRecorder: 476 | def __init__( 477 | self, 478 | pytestconfig: Any, 479 | request: pytest.FixtureRequest, 480 | output_path: str, 481 | playwright: Playwright, 482 | pw_artifacts_folder: tempfile.TemporaryDirectory, 483 | ) -> None: 484 | self._request = request 485 | self._pytestconfig = pytestconfig 486 | self._playwright = playwright 487 | self._output_path = output_path 488 | self._pw_artifacts_folder = pw_artifacts_folder 489 | 490 | self._all_pages: List[Page] = [] 491 | self._screenshots: List[str] = [] 492 | self._traces: List[str] = [] 493 | self._tracing_option = pytestconfig.getoption("--tracing") 494 | self._capture_trace = self._tracing_option in ["on", "retain-on-failure"] 495 | 496 | def _build_artifact_test_folder(self, folder_or_file_name: str) -> str: 497 | return os.path.join( 498 | self._output_path, 499 | _truncate_file_name(folder_or_file_name), 500 | ) 501 | 502 | def did_finish_test(self, failed: bool) -> None: 503 | screenshot_option = self._pytestconfig.getoption("--screenshot") 504 | capture_screenshot = screenshot_option == "on" or ( 505 | failed and screenshot_option == "only-on-failure" 506 | ) 507 | if capture_screenshot: 508 | for index, screenshot in enumerate(self._screenshots): 509 | human_readable_status = "failed" if failed else "finished" 510 | screenshot_path = self._build_artifact_test_folder( 511 | f"test-{human_readable_status}-{index + 1}.png", 512 | ) 513 | os.makedirs(os.path.dirname(screenshot_path), exist_ok=True) 514 | shutil.move(screenshot, screenshot_path) 515 | else: 516 | for screenshot in self._screenshots: 517 | os.remove(screenshot) 518 | 519 | if self._tracing_option == "on" or ( 520 | failed and self._tracing_option == "retain-on-failure" 521 | ): 522 | for index, trace in enumerate(self._traces): 523 | trace_file_name = ( 524 | "trace.zip" if len(self._traces) == 1 else f"trace-{index + 1}.zip" 525 | ) 526 | trace_path = self._build_artifact_test_folder(trace_file_name) 527 | os.makedirs(os.path.dirname(trace_path), exist_ok=True) 528 | shutil.move(trace, trace_path) 529 | else: 530 | for trace in self._traces: 531 | os.remove(trace) 532 | 533 | video_option = self._pytestconfig.getoption("--video") 534 | preserve_video = video_option == "on" or ( 535 | failed and video_option == "retain-on-failure" 536 | ) 537 | if preserve_video: 538 | for index, page in enumerate(self._all_pages): 539 | video = page.video 540 | if not video: 541 | continue 542 | try: 543 | video_file_name = ( 544 | "video.webm" 545 | if len(self._all_pages) == 1 546 | else f"video-{index + 1}.webm" 547 | ) 548 | video.save_as( 549 | path=self._build_artifact_test_folder(video_file_name) 550 | ) 551 | except Error: 552 | # Silent catch empty videos. 553 | pass 554 | else: 555 | for page in self._all_pages: 556 | # Can be changed to "if page.video" without try/except once https://github.com/microsoft/playwright-python/pull/2410 is released and widely adopted. 557 | if video_option in ["on", "retain-on-failure"]: 558 | try: 559 | if page.video: 560 | page.video.delete() 561 | except Error: 562 | pass 563 | 564 | def on_did_create_browser_context(self, context: BrowserContext) -> None: 565 | context.on("page", lambda page: self._all_pages.append(page)) 566 | if self._request and self._capture_trace: 567 | context.tracing.start( 568 | title=slugify(self._request.node.nodeid), 569 | screenshots=True, 570 | snapshots=True, 571 | sources=True, 572 | ) 573 | 574 | def on_will_close_browser_context(self, context: BrowserContext) -> None: 575 | if self._capture_trace: 576 | trace_path = Path(self._pw_artifacts_folder.name) / _create_guid() 577 | context.tracing.stop(path=trace_path) 578 | self._traces.append(str(trace_path)) 579 | else: 580 | context.tracing.stop() 581 | 582 | if self._pytestconfig.getoption("--screenshot") in ["on", "only-on-failure"]: 583 | for page in context.pages: 584 | try: 585 | screenshot_path = ( 586 | Path(self._pw_artifacts_folder.name) / _create_guid() 587 | ) 588 | page.screenshot( 589 | timeout=5000, 590 | path=screenshot_path, 591 | full_page=self._pytestconfig.getoption( 592 | "--full-page-screenshot" 593 | ), 594 | ) 595 | self._screenshots.append(str(screenshot_path)) 596 | except Error: 597 | pass 598 | 599 | 600 | def _create_guid() -> str: 601 | return hashlib.sha256(os.urandom(16)).hexdigest() 602 | -------------------------------------------------------------------------------- /setup.cfg: -------------------------------------------------------------------------------- 1 | [flake8] 2 | ignore = 3 | E501 4 | W503 5 | E302 6 | # Conflicts with black https://github.com/PyCQA/flake8/issues/1921 7 | E704 8 | [mypy] 9 | ignore_missing_imports = True 10 | python_version = 3.9 11 | warn_unused_ignores = False 12 | warn_redundant_casts = True 13 | warn_unused_configs = True 14 | check_untyped_defs = True 15 | disallow_untyped_defs = True 16 | [tool:pytest] 17 | addopts = -p no:asyncio -p no:playwright -p no:playwright-asyncio --runpytest subprocess -vv 18 | testpaths = 19 | tests 20 | -------------------------------------------------------------------------------- /tests/assets/django/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/microsoft/playwright-pytest/364145f3b56749a72ffa57efc9804768d84291f8/tests/assets/django/__init__.py -------------------------------------------------------------------------------- /tests/assets/django/settings.py: -------------------------------------------------------------------------------- 1 | import os 2 | 3 | # Build paths inside the project like this: os.path.join(BASE_DIR, ...) 4 | BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) 5 | 6 | 7 | # Quick-start development settings - unsuitable for production 8 | # See https://docs.djangoproject.com/en/2.2/howto/deployment/checklist/ 9 | 10 | # SECURITY WARNING: keep the secret key used in production secret! 11 | SECRET_KEY = "123" 12 | 13 | # SECURITY WARNING: don't run with debug turned on in production! 14 | DEBUG = True 15 | 16 | ALLOWED_HOSTS = ["*"] 17 | 18 | 19 | # Application definition 20 | 21 | INSTALLED_APPS = [ 22 | "django.contrib.admin", 23 | "django.contrib.auth", 24 | "django.contrib.contenttypes", 25 | "django.contrib.sessions", 26 | "django.contrib.messages", 27 | "django.contrib.staticfiles", 28 | ] 29 | 30 | MIDDLEWARE = [ 31 | "django.middleware.security.SecurityMiddleware", 32 | "django.contrib.sessions.middleware.SessionMiddleware", 33 | "django.middleware.common.CommonMiddleware", 34 | "django.middleware.csrf.CsrfViewMiddleware", 35 | "django.contrib.auth.middleware.AuthenticationMiddleware", 36 | "django.contrib.messages.middleware.MessageMiddleware", 37 | "django.middleware.clickjacking.XFrameOptionsMiddleware", 38 | ] 39 | 40 | ROOT_URLCONF = "proj1.urls" 41 | 42 | TEMPLATES = [ 43 | { 44 | "BACKEND": "django.template.backends.django.DjangoTemplates", 45 | "DIRS": [], 46 | "APP_DIRS": True, 47 | "OPTIONS": { 48 | "context_processors": [ 49 | "django.template.context_processors.debug", 50 | "django.template.context_processors.request", 51 | "django.contrib.auth.context_processors.auth", 52 | "django.contrib.messages.context_processors.messages", 53 | ], 54 | }, 55 | }, 56 | ] 57 | 58 | WSGI_APPLICATION = "proj1.wsgi.application" 59 | 60 | 61 | # Database 62 | # https://docs.djangoproject.com/en/2.2/ref/settings/#databases 63 | 64 | DATABASES = { 65 | "default": { 66 | "ENGINE": "django.db.backends.sqlite3", 67 | "NAME": ":memory:", 68 | } 69 | } 70 | 71 | 72 | # Password validation 73 | # https://docs.djangoproject.com/en/2.2/ref/settings/#auth-password-validators 74 | 75 | AUTH_PASSWORD_VALIDATORS = [ 76 | { 77 | "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator", 78 | }, 79 | {"NAME": "django.contrib.auth.password_validation.MinimumLengthValidator"}, 80 | {"NAME": "django.contrib.auth.password_validation.CommonPasswordValidator"}, 81 | {"NAME": "django.contrib.auth.password_validation.NumericPasswordValidator"}, 82 | ] 83 | 84 | 85 | # Internationalization 86 | # https://docs.djangoproject.com/en/2.2/topics/i18n/ 87 | 88 | LANGUAGE_CODE = "en-us" 89 | 90 | TIME_ZONE = "UTC" 91 | 92 | USE_I18N = True 93 | 94 | USE_TZ = True 95 | 96 | 97 | # Static files (CSS, JavaScript, Images) 98 | # https://docs.djangoproject.com/en/2.2/howto/static-files/ 99 | 100 | STATIC_URL = "/static/" 101 | -------------------------------------------------------------------------------- /tests/assets/django/urls.py: -------------------------------------------------------------------------------- 1 | from django.contrib import admin 2 | from django.urls import path # type:ignore 3 | 4 | urlpatterns = [ 5 | path("admin/", admin.site.urls), 6 | ] 7 | -------------------------------------------------------------------------------- /tests/conftest.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) Microsoft Corporation. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | import sys 16 | import os 17 | 18 | pytest_plugins = ["pytester"] 19 | 20 | # The testdir fixture which we use to perform unit tests will set the home directory 21 | # To a temporary directory of the created test. This would result that the browsers will 22 | # be re-downloaded each time. By setting the pw browser path directory we can prevent that. 23 | if sys.platform == "darwin": 24 | playwright_browser_path = os.path.expanduser("~/Library/Caches/ms-playwright") 25 | elif sys.platform == "linux": 26 | playwright_browser_path = os.path.expanduser("~/.cache/ms-playwright") 27 | elif sys.platform == "win32": 28 | user_profile = os.environ["USERPROFILE"] 29 | playwright_browser_path = f"{user_profile}\\AppData\\Local\\ms-playwright" 30 | 31 | os.environ["PLAYWRIGHT_BROWSERS_PATH"] = playwright_browser_path 32 | -------------------------------------------------------------------------------- /tests/test_asyncio.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) Microsoft Corporation. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | import os 16 | import signal 17 | import subprocess 18 | import sys 19 | 20 | import pytest 21 | 22 | 23 | @pytest.fixture 24 | def pytester(pytester: pytest.Pytester) -> pytest.Pytester: 25 | # Pytester internally in their constructor overrides the HOME and USERPROFILE env variables. This confuses Chromium hence we unset them. 26 | # See https://github.com/pytest-dev/pytest/blob/83536b4b0074ca35d90933d3ad46cb6efe7f5145/src/_pytest/pytester.py#L704-L705 27 | os.environ.pop("HOME", None) 28 | os.environ.pop("USERPROFILE", None) 29 | return pytester 30 | 31 | 32 | @pytest.fixture(autouse=True) 33 | def _add_async_marker(testdir: pytest.Testdir) -> None: 34 | testdir.makefile( 35 | ".ini", 36 | pytest=""" 37 | [pytest] 38 | addopts = -p no:playwright 39 | asyncio_default_test_loop_scope = session 40 | asyncio_default_fixture_loop_scope = session 41 | """, 42 | ) 43 | 44 | 45 | def test_default(testdir: pytest.Testdir) -> None: 46 | testdir.makepyfile( 47 | """ 48 | import pytest 49 | 50 | @pytest.mark.asyncio 51 | async def test_default(page, browser_name): 52 | assert browser_name == "chromium" 53 | user_agent = await page.evaluate("window.navigator.userAgent") 54 | assert "HeadlessChrome" in user_agent 55 | await page.set_content('bar') 56 | assert await page.query_selector("#foo") 57 | """ 58 | ) 59 | result = testdir.runpytest() 60 | result.assert_outcomes(passed=1) 61 | 62 | 63 | def test_slowmo(testdir: pytest.Testdir) -> None: 64 | testdir.makepyfile( 65 | """ 66 | from time import monotonic 67 | import pytest 68 | @pytest.mark.asyncio 69 | async def test_slowmo(page): 70 | email = "test@test.com" 71 | await page.set_content("") 72 | start_time = monotonic() 73 | await page.type("input", email) 74 | end_time = monotonic() 75 | assert end_time - start_time >= 1 76 | assert end_time - start_time < 2 77 | """ 78 | ) 79 | result = testdir.runpytest("--browser", "chromium", "--slowmo", "1000") 80 | result.assert_outcomes(passed=1) 81 | 82 | 83 | @pytest.mark.parametrize( 84 | "channel", 85 | [ 86 | "chrome", 87 | "msedge", 88 | ], 89 | ) 90 | def test_browser_channel(channel: str, testdir: pytest.Testdir) -> None: 91 | if channel == "msedge" and sys.platform == "linux": 92 | pytest.skip("msedge not supported on linux") 93 | testdir.makepyfile( 94 | f""" 95 | import pytest 96 | 97 | @pytest.mark.asyncio 98 | async def test_browser_channel(page, browser_name, browser_channel): 99 | assert browser_name == "chromium" 100 | assert browser_channel == "{channel}" 101 | """ 102 | ) 103 | result = testdir.runpytest("--browser-channel", channel) 104 | result.assert_outcomes(passed=1) 105 | 106 | 107 | def test_invalid_browser_channel(testdir: pytest.Testdir) -> None: 108 | testdir.makepyfile( 109 | """ 110 | import pytest 111 | 112 | @pytest.mark.asyncio 113 | async def test_browser_channel(page, browser_name, browser_channel): 114 | assert browser_name == "chromium" 115 | """ 116 | ) 117 | result = testdir.runpytest("--browser-channel", "not-exists") 118 | result.assert_outcomes(errors=1) 119 | assert "Unsupported chromium channel" in "\n".join(result.outlines) 120 | 121 | 122 | def test_multiple_browsers(testdir: pytest.Testdir) -> None: 123 | testdir.makepyfile( 124 | """ 125 | import pytest 126 | @pytest.mark.asyncio 127 | async def test_multiple_browsers(page): 128 | await page.set_content('bar') 129 | assert page.query_selector("#foo") 130 | """ 131 | ) 132 | result = testdir.runpytest( 133 | "--browser", "chromium", "--browser", "firefox", "--browser", "webkit" 134 | ) 135 | result.assert_outcomes(passed=3) 136 | 137 | 138 | def test_browser_context_args(testdir: pytest.Testdir) -> None: 139 | testdir.makeconftest( 140 | """ 141 | import pytest 142 | @pytest.fixture(scope="session") 143 | def browser_context_args(): 144 | return {"user_agent": "foobar"} 145 | """, 146 | ) 147 | testdir.makepyfile( 148 | """ 149 | import pytest 150 | @pytest.mark.asyncio 151 | async def test_browser_context_args(page): 152 | assert await page.evaluate("window.navigator.userAgent") == "foobar" 153 | """ 154 | ) 155 | result = testdir.runpytest() 156 | result.assert_outcomes(passed=1) 157 | 158 | 159 | def test_user_defined_browser_context_args(testdir: pytest.Testdir) -> None: 160 | testdir.makeconftest( 161 | """ 162 | import pytest 163 | 164 | @pytest.fixture(scope="session") 165 | def browser_context_args(): 166 | return {"user_agent": "foobar"} 167 | """, 168 | ) 169 | testdir.makepyfile( 170 | """ 171 | import pytest 172 | 173 | @pytest.mark.browser_context_args(user_agent="overwritten", locale="new-locale") 174 | @pytest.mark.asyncio 175 | async def test_browser_context_args(page): 176 | assert await page.evaluate("window.navigator.userAgent") == "overwritten" 177 | assert await page.evaluate("window.navigator.languages") == ["new-locale"] 178 | """ 179 | ) 180 | result = testdir.runpytest() 181 | result.assert_outcomes(passed=1) 182 | 183 | 184 | def test_user_defined_browser_context_args_clear_again(testdir: pytest.Testdir) -> None: 185 | testdir.makeconftest( 186 | """ 187 | import pytest 188 | 189 | @pytest.fixture(scope="session") 190 | def browser_context_args(): 191 | return {"user_agent": "foobar"} 192 | """, 193 | ) 194 | testdir.makepyfile( 195 | """ 196 | import pytest 197 | 198 | @pytest.mark.browser_context_args(user_agent="overwritten") 199 | @pytest.mark.asyncio 200 | async def test_browser_context_args(page): 201 | assert await page.evaluate("window.navigator.userAgent") == "overwritten" 202 | 203 | @pytest.mark.asyncio 204 | async def test_browser_context_args2(page): 205 | assert await page.evaluate("window.navigator.userAgent") == "foobar" 206 | """ 207 | ) 208 | result = testdir.runpytest() 209 | result.assert_outcomes(passed=2) 210 | 211 | 212 | def test_chromium(testdir: pytest.Testdir) -> None: 213 | testdir.makepyfile( 214 | """ 215 | import pytest 216 | @pytest.mark.asyncio 217 | async def test_is_chromium(page, browser_name, is_chromium, is_firefox, is_webkit): 218 | assert browser_name == "chromium" 219 | assert is_chromium 220 | assert is_firefox is False 221 | assert is_webkit is False 222 | """ 223 | ) 224 | result = testdir.runpytest() 225 | result.assert_outcomes(passed=1) 226 | 227 | 228 | def test_firefox(testdir: pytest.Testdir) -> None: 229 | testdir.makepyfile( 230 | """ 231 | import pytest 232 | @pytest.mark.asyncio 233 | async def test_is_firefox(page, browser_name, is_chromium, is_firefox, is_webkit): 234 | assert browser_name == "firefox" 235 | assert is_chromium is False 236 | assert is_firefox 237 | assert is_webkit is False 238 | """ 239 | ) 240 | result = testdir.runpytest("--browser", "firefox") 241 | result.assert_outcomes(passed=1) 242 | 243 | 244 | def test_webkit(testdir: pytest.Testdir) -> None: 245 | testdir.makepyfile( 246 | """ 247 | import pytest 248 | @pytest.mark.asyncio 249 | async def test_is_webkit(page, browser_name, is_chromium, is_firefox, is_webkit): 250 | assert browser_name == "webkit" 251 | assert is_chromium is False 252 | assert is_firefox is False 253 | assert is_webkit 254 | """ 255 | ) 256 | result = testdir.runpytest("--browser", "webkit") 257 | result.assert_outcomes(passed=1) 258 | 259 | 260 | def test_goto(testdir: pytest.Testdir) -> None: 261 | testdir.makepyfile( 262 | """ 263 | import pytest 264 | @pytest.mark.asyncio 265 | async def test_base_url(page, base_url): 266 | assert base_url == "https://example.com" 267 | await page.goto("/foobar") 268 | assert page.url == "https://example.com/foobar" 269 | await page.goto("https://example.org") 270 | assert page.url == "https://example.org/" 271 | """ 272 | ) 273 | result = testdir.runpytest("--base-url", "https://example.com") 274 | result.assert_outcomes(passed=1) 275 | 276 | 277 | def test_base_url_via_fixture(testdir: pytest.Testdir) -> None: 278 | testdir.makepyfile( 279 | """ 280 | import pytest 281 | 282 | @pytest.fixture(scope="session") 283 | def base_url(): 284 | return "https://example.com" 285 | 286 | @pytest.mark.asyncio 287 | async def test_base_url(page, base_url): 288 | assert base_url == "https://example.com" 289 | await page.goto("/foobar") 290 | assert page.url == "https://example.com/foobar" 291 | """ 292 | ) 293 | result = testdir.runpytest() 294 | result.assert_outcomes(passed=1) 295 | 296 | 297 | def test_skip_browsers(testdir: pytest.Testdir) -> None: 298 | testdir.makepyfile( 299 | """ 300 | import pytest 301 | 302 | @pytest.mark.skip_browser("firefox") 303 | @pytest.mark.asyncio 304 | async def test_base_url(page, browser_name): 305 | assert browser_name in ["chromium", "webkit"] 306 | """ 307 | ) 308 | result = testdir.runpytest( 309 | "--browser", "chromium", "--browser", "firefox", "--browser", "webkit" 310 | ) 311 | result.assert_outcomes(passed=2, skipped=1) 312 | 313 | 314 | def test_only_browser(testdir: pytest.Testdir) -> None: 315 | testdir.makepyfile( 316 | """ 317 | import pytest 318 | 319 | @pytest.mark.only_browser("firefox") 320 | @pytest.mark.asyncio 321 | async def test_base_url(page, browser_name): 322 | assert browser_name == "firefox" 323 | """ 324 | ) 325 | result = testdir.runpytest( 326 | "--browser", "chromium", "--browser", "firefox", "--browser", "webkit" 327 | ) 328 | result.assert_outcomes(passed=1, skipped=2) 329 | 330 | 331 | def test_parameterization(testdir: pytest.Testdir) -> None: 332 | testdir.makepyfile( 333 | """ 334 | import pytest 335 | @pytest.mark.asyncio 336 | async def test_all_browsers(page): 337 | pass 338 | 339 | @pytest.mark.asyncio 340 | async def test_without_browser(): 341 | pass 342 | """ 343 | ) 344 | result = testdir.runpytest( 345 | "--verbose", 346 | "--browser", 347 | "chromium", 348 | "--browser", 349 | "firefox", 350 | "--browser", 351 | "webkit", 352 | ) 353 | result.assert_outcomes(passed=4) 354 | assert "test_without_browser PASSED" in "\n".join(result.outlines) 355 | 356 | 357 | def test_xdist(testdir: pytest.Testdir) -> None: 358 | testdir.makepyfile( 359 | """ 360 | import pytest 361 | @pytest.mark.asyncio 362 | async def test_a(page): 363 | await page.set_content('a') 364 | await page.wait_for_timeout(200) 365 | assert page.query_selector("#foo") 366 | 367 | @pytest.mark.asyncio 368 | async def test_b(page): 369 | await page.wait_for_timeout(2000) 370 | await page.set_content('a') 371 | assert page.query_selector("#foo") 372 | 373 | @pytest.mark.asyncio 374 | async def test_c(page): 375 | await page.set_content('a') 376 | await page.wait_for_timeout(200) 377 | assert page.query_selector("#foo") 378 | 379 | @pytest.mark.asyncio 380 | async def test_d(page): 381 | await page.set_content('a') 382 | await page.wait_for_timeout(200) 383 | assert page.query_selector("#foo") 384 | """ 385 | ) 386 | result = testdir.runpytest( 387 | "--verbose", 388 | "--browser", 389 | "chromium", 390 | "--browser", 391 | "firefox", 392 | "--browser", 393 | "webkit", 394 | "--numprocesses", 395 | "2", 396 | ) 397 | result.assert_outcomes(passed=12) 398 | assert "gw0" in "\n".join(result.outlines) 399 | assert "gw1" in "\n".join(result.outlines) 400 | 401 | 402 | def test_xdist_should_not_print_any_warnings(testdir: pytest.Testdir) -> None: 403 | original = os.environ.get("PYTHONWARNINGS") 404 | os.environ["PYTHONWARNINGS"] = "always" 405 | try: 406 | testdir.makepyfile( 407 | """ 408 | import pytest 409 | 410 | @pytest.mark.asyncio 411 | async def test_default(page): 412 | pass 413 | """ 414 | ) 415 | result = testdir.runpytest( 416 | "--numprocesses", 417 | "2", 418 | ) 419 | result.assert_outcomes(passed=1) 420 | assert "ResourceWarning" not in "".join(result.stderr.lines) 421 | finally: 422 | if original is not None: 423 | os.environ["PYTHONWARNINGS"] = original 424 | else: 425 | del os.environ["PYTHONWARNINGS"] 426 | 427 | 428 | def test_headed(testdir: pytest.Testdir) -> None: 429 | testdir.makepyfile( 430 | """ 431 | import pytest 432 | @pytest.mark.asyncio 433 | async def test_base_url(page, browser_name): 434 | user_agent = await page.evaluate("window.navigator.userAgent") 435 | assert "HeadlessChrome" not in user_agent 436 | """ 437 | ) 438 | result = testdir.runpytest("--browser", "chromium", "--headed") 439 | result.assert_outcomes(passed=1) 440 | 441 | 442 | def test_invalid_browser_name(testdir: pytest.Testdir) -> None: 443 | testdir.makepyfile( 444 | """ 445 | async def test_base_url(page): 446 | pass 447 | """ 448 | ) 449 | result = testdir.runpytest("--browser", "test123") 450 | assert any(["--browser: invalid choice" in line for line in result.errlines]) 451 | 452 | 453 | def test_browser_context_args_device(testdir: pytest.Testdir) -> None: 454 | testdir.makeconftest( 455 | """ 456 | import pytest 457 | 458 | @pytest.fixture(scope="session") 459 | def browser_context_args(browser_context_args, playwright): 460 | iphone_11 = playwright.devices['iPhone 11 Pro'] 461 | return {**browser_context_args, **iphone_11} 462 | """, 463 | ) 464 | testdir.makepyfile( 465 | """ 466 | import pytest 467 | @pytest.mark.asyncio 468 | async def test_browser_context_args(page): 469 | assert "iPhone" in await page.evaluate("window.navigator.userAgent") 470 | """ 471 | ) 472 | result = testdir.runpytest() 473 | result.assert_outcomes(passed=1) 474 | 475 | 476 | def test_launch_persistent_context_session(testdir: pytest.Testdir) -> None: 477 | testdir.makeconftest( 478 | """ 479 | import pytest_asyncio 480 | from playwright.sync_api import BrowserType 481 | from typing import Dict 482 | 483 | @pytest_asyncio.fixture(scope="session") 484 | async def context( 485 | browser_type: BrowserType, 486 | browser_type_launch_args: Dict, 487 | browser_context_args: Dict 488 | ): 489 | context = await browser_type.launch_persistent_context("./foobar", **{ 490 | **browser_type_launch_args, 491 | **browser_context_args, 492 | "locale": "de-DE", 493 | }) 494 | yield context 495 | await context.close() 496 | """, 497 | ) 498 | testdir.makepyfile( 499 | """ 500 | import pytest 501 | @pytest.mark.asyncio 502 | async def test_browser_context_args(page): 503 | assert await page.evaluate("navigator.language") == "de-DE" 504 | """ 505 | ) 506 | result = testdir.runpytest() 507 | result.assert_outcomes(passed=1) 508 | 509 | 510 | def test_context_page_on_session_level(testdir: pytest.Testdir) -> None: 511 | testdir.makeconftest( 512 | """ 513 | import pytest 514 | from playwright.sync_api import Browser, BrowserContext 515 | from typing import Dict 516 | import pytest_asyncio 517 | 518 | @pytest_asyncio.fixture(scope="session") 519 | async def context( 520 | browser: Browser, 521 | browser_context_args: Dict 522 | ): 523 | context = await browser.new_context(**{ 524 | **browser_context_args, 525 | }) 526 | yield context 527 | await context.close() 528 | 529 | @pytest_asyncio.fixture(scope="session") 530 | async def page( 531 | context: BrowserContext, 532 | ): 533 | page = await context.new_page() 534 | yield page 535 | """, 536 | ) 537 | testdir.makepyfile( 538 | """ 539 | import pytest 540 | @pytest.mark.asyncio 541 | async def test_a(page): 542 | await page.goto("data:text/html,
B
") 543 | assert await page.text_content("div") == "B" 544 | 545 | @pytest.mark.asyncio 546 | async def test_b(page): 547 | assert await page.text_content("div") == "B" 548 | """ 549 | ) 550 | result = testdir.runpytest() 551 | result.assert_outcomes(passed=2) 552 | 553 | 554 | def test_launch_persistent_context_function(testdir: pytest.Testdir) -> None: 555 | testdir.makeconftest( 556 | """ 557 | import pytest 558 | from playwright.sync_api import BrowserType 559 | import pytest_asyncio 560 | from typing import Dict 561 | 562 | @pytest_asyncio.fixture 563 | async def context( 564 | browser_type: BrowserType, 565 | browser_type_launch_args: Dict, 566 | browser_context_args: Dict 567 | ): 568 | context = await browser_type.launch_persistent_context("./foobar", **{ 569 | **browser_type_launch_args, 570 | **browser_context_args, 571 | "locale": "de-DE", 572 | }) 573 | yield context 574 | await context.close() 575 | """, 576 | ) 577 | testdir.makepyfile( 578 | """ 579 | import pytest 580 | @pytest.mark.asyncio 581 | async def test_browser_context_args(page): 582 | assert await page.evaluate("navigator.language") == "de-DE" 583 | """ 584 | ) 585 | result = testdir.runpytest() 586 | result.assert_outcomes(passed=1) 587 | 588 | 589 | def test_device_emulation(testdir: pytest.Testdir) -> None: 590 | testdir.makepyfile( 591 | """ 592 | import pytest 593 | @pytest.mark.asyncio 594 | async def test_device_emulation(page, device): 595 | assert device == 'iPhone 11 Pro' 596 | assert "iPhone" in await page.evaluate("window.navigator.userAgent") 597 | """ 598 | ) 599 | result = testdir.runpytest("--device", "iPhone 11 Pro") 600 | result.assert_outcomes(passed=1) 601 | 602 | 603 | def test_rep_call_keyboard_interrupt(testdir: pytest.Testdir) -> None: 604 | testdir.makepyfile( 605 | """ 606 | import pytest 607 | 608 | @pytest.mark.asyncio 609 | async def test_rep_call(page): 610 | assert await page.evaluate("1 + 1") == 2 611 | raise KeyboardInterrupt 612 | """ 613 | ) 614 | result = testdir.runpytest() 615 | result.assert_outcomes(passed=0, failed=0, skipped=0) 616 | 617 | 618 | def test_artifacts_by_default_it_should_not_store_anything( 619 | testdir: pytest.Testdir, 620 | ) -> None: 621 | testdir.makepyfile( 622 | """ 623 | import pytest 624 | pytest.mark.asyncio 625 | @pytest.mark.asyncio 626 | async def test_passing(page): 627 | assert 2 == await page.evaluate("1 + 1") 628 | 629 | @pytest.mark.asyncio 630 | async def test_failing(page): 631 | raise Exception("Failed") 632 | """ 633 | ) 634 | result = testdir.runpytest() 635 | result.assert_outcomes(passed=1, failed=1) 636 | for dir in testdir.tmpdir.listdir(): 637 | assert dir.basename != "test-results" 638 | 639 | 640 | def test_artifacts_new_folder_on_run( 641 | testdir: pytest.Testdir, 642 | ) -> None: 643 | test_results_dir = os.path.join(testdir.tmpdir, "test-results") 644 | os.mkdir(os.path.join(test_results_dir)) 645 | with open(os.path.join(test_results_dir, "example.json"), "w") as f: 646 | f.write("foo") 647 | 648 | testdir.makepyfile( 649 | """ 650 | import pytest 651 | @pytest.mark.asyncio 652 | async def test_passing(page): 653 | assert 2 == await page.evaluate("1 + 1") 654 | """ 655 | ) 656 | result = testdir.runpytest() 657 | result.assert_outcomes(passed=1) 658 | for dir in testdir.tmpdir.listdir(): 659 | assert dir.basename != "test-results" 660 | 661 | 662 | def test_artifacts_should_store_everything_if_on(testdir: pytest.Testdir) -> None: 663 | testdir.makepyfile( 664 | """ 665 | import pytest 666 | @pytest.mark.asyncio 667 | async def test_passing(page, output_path): 668 | print(f"\\n\\noutput_path = {output_path}\\n\\n") 669 | assert 2 == await page.evaluate("1 + 1") 670 | 671 | @pytest.mark.asyncio 672 | async def test_failing(page, output_path): 673 | print(f"\\n\\noutput_path = {output_path}\\n\\n") 674 | raise Exception("Failed") 675 | """ 676 | ) 677 | result = testdir.runpytest( 678 | "--screenshot", "on", "--video", "on", "--tracing", "on", "-s" 679 | ) 680 | result.assert_outcomes(passed=1, failed=1) 681 | test_results_dir = os.path.join(testdir.tmpdir, "test-results") 682 | _assert_folder_structure( 683 | test_results_dir, 684 | """ 685 | - test-artifacts-should-store-everything-if-on-py-test-failing-chromium: 686 | - test-failed-1.png 687 | - trace.zip 688 | - video.webm 689 | - test-artifacts-should-store-everything-if-on-py-test-passing-chromium: 690 | - test-finished-1.png 691 | - trace.zip 692 | - video.webm 693 | """, 694 | ) 695 | output_path = str(testdir.tmpdir) 696 | output_paths = [ 697 | line[14:] for line in result.outlines if f"output_path = {output_path}" in line 698 | ] 699 | assert output_paths == [ 700 | testdir.tmpdir.join( 701 | "test-results/test-artifacts-should-store-everything-if-on-py-test-passing-chromium" 702 | ).strpath, 703 | testdir.tmpdir.join( 704 | "test-results/test-artifacts-should-store-everything-if-on-py-test-failing-chromium" 705 | ).strpath, 706 | ] 707 | 708 | 709 | def test_artifacts_retain_on_failure(testdir: pytest.Testdir) -> None: 710 | testdir.makepyfile( 711 | """ 712 | import pytest 713 | @pytest.mark.asyncio 714 | async def test_passing(page): 715 | assert 2 == await page.evaluate("1 + 1") 716 | 717 | @pytest.mark.asyncio 718 | async def test_failing(page): 719 | raise Exception("Failed") 720 | """ 721 | ) 722 | result = testdir.runpytest( 723 | "--screenshot", 724 | "only-on-failure", 725 | "--video", 726 | "retain-on-failure", 727 | "--tracing", 728 | "retain-on-failure", 729 | ) 730 | result.assert_outcomes(passed=1, failed=1) 731 | test_results_dir = os.path.join(testdir.tmpdir, "test-results") 732 | _assert_folder_structure( 733 | test_results_dir, 734 | """ 735 | - test-artifacts-retain-on-failure-py-test-failing-chromium: 736 | - test-failed-1.png 737 | - trace.zip 738 | - video.webm 739 | """, 740 | ) 741 | 742 | 743 | def test_should_work_with_test_names_which_exceeds_256_characters( 744 | testdir: pytest.Testdir, 745 | ) -> None: 746 | long_test_name = "abcdefghijklmnopqrstuvwxyz" * 100 747 | testdir.makepyfile( 748 | f""" 749 | import pytest 750 | @pytest.mark.asyncio 751 | async def test_{long_test_name}(page): 752 | pass 753 | """ 754 | ) 755 | result = testdir.runpytest("--tracing", "on") 756 | result.assert_outcomes(passed=1, failed=0) 757 | test_results_dir = os.path.join(testdir.tmpdir, "test-results") 758 | _assert_folder_structure( 759 | test_results_dir, 760 | """ 761 | - test-should-work-with-test-names-which-exceeds-256-characters-py-test-abcdefghijklmnopqrstuvwxyzabcd-23f2441-nopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz-chromium: 762 | - trace.zip 763 | """, 764 | ) 765 | 766 | 767 | def _make_folder_list(root: str, level: int = 0) -> str: 768 | if not os.path.exists(root): 769 | return "" 770 | tree = [] 771 | for entry in sorted(os.scandir(root), key=lambda e: e.name): 772 | prefix = f"{' ' * level}- " 773 | if entry.is_dir(): 774 | tree.append(f"{prefix}{entry.name}:\n") 775 | tree.append(_make_folder_list(entry.path, level + 1)) 776 | else: 777 | tree.append(f"{prefix}{entry.name}\n") 778 | return "".join(tree) 779 | 780 | 781 | def _assert_folder_structure(root: str, expected: str) -> None: 782 | __tracebackhide__ = True 783 | actual = _make_folder_list(root) 784 | if actual.strip() != expected.strip(): 785 | print("Actual:") 786 | print(actual) 787 | print("Expected:") 788 | print(expected) 789 | raise AssertionError("Actual tree does not match expected tree") 790 | 791 | 792 | def test_is_able_to_set_expect_timeout_via_conftest(testdir: pytest.Testdir) -> None: 793 | testdir.makeconftest( 794 | """ 795 | from playwright.async_api import expect 796 | expect.set_options(timeout=1111) 797 | """, 798 | ) 799 | testdir.makepyfile( 800 | """ 801 | from playwright.async_api import expect 802 | import pytest 803 | 804 | @pytest.mark.asyncio 805 | async def test_small_timeout(page): 806 | await page.goto("data:text/html,") 807 | await expect(page.locator("#A")).to_be_visible() 808 | """ 809 | ) 810 | result = testdir.runpytest() 811 | result.assert_outcomes(passed=0, failed=1, skipped=0) 812 | result.stdout.fnmatch_lines("*AssertionError: Locator expected to be visible*") 813 | result.stdout.fnmatch_lines("*LocatorAssertions.to_be_visible with timeout 1111ms*") 814 | 815 | 816 | def test_artifact_collection_should_work_for_manually_created_contexts_keep_open( 817 | testdir: pytest.Testdir, 818 | ) -> None: 819 | testdir.makepyfile( 820 | """ 821 | import pytest 822 | from pytest_playwright_asyncio import CreateContextCallback 823 | 824 | @pytest.mark.asyncio 825 | async def test_artifact_collection(browser, page, new_context: CreateContextCallback): 826 | await page.goto("data:text/html,
hello
") 827 | 828 | other_context = await new_context() 829 | other_context_page = await other_context.new_page() 830 | await other_context_page.goto("data:text/html,
hello
") 831 | await other_context_page.evaluate("new Promise(fulfill => requestAnimationFrame(() => requestAnimationFrame(fulfill)))") 832 | """ 833 | ) 834 | result = testdir.runpytest("--screenshot", "on", "--video", "on", "--tracing", "on") 835 | result.assert_outcomes(passed=1) 836 | test_results_dir = os.path.join(testdir.tmpdir, "test-results") 837 | _assert_folder_structure( 838 | test_results_dir, 839 | """ 840 | - test-artifact-collection-should-work-for-manually-created-contexts-keep-open-py-test-artifact-collection-chromium: 841 | - test-finished-1.png 842 | - test-finished-2.png 843 | - trace-1.zip 844 | - trace-2.zip 845 | - video-1.webm 846 | - video-2.webm 847 | """, 848 | ) 849 | 850 | 851 | def test_artifact_collection_should_work_for_manually_created_contexts_get_closed( 852 | testdir: pytest.Testdir, 853 | ) -> None: 854 | testdir.makepyfile( 855 | """ 856 | import pytest 857 | 858 | @pytest.mark.asyncio 859 | async def test_artifact_collection(browser, page, new_context): 860 | await page.goto("data:text/html,
hello
") 861 | 862 | other_context = await new_context() 863 | other_context_page = await other_context.new_page() 864 | await other_context_page.goto("data:text/html,
hello
") 865 | await other_context_page.evaluate("new Promise(fulfill => requestAnimationFrame(() => requestAnimationFrame(fulfill)))") 866 | await other_context.close() 867 | """ 868 | ) 869 | result = testdir.runpytest("--video", "on", "--tracing", "on") 870 | result.assert_outcomes(passed=1) 871 | test_results_dir = os.path.join(testdir.tmpdir, "test-results") 872 | _assert_folder_structure( 873 | test_results_dir, 874 | """ 875 | - test-artifact-collection-should-work-for-manually-created-contexts-get-closed-py-test-artifact-collection-chromium: 876 | - trace-1.zip 877 | - trace-2.zip 878 | - video-1.webm 879 | - video-2.webm 880 | """, 881 | ) 882 | 883 | 884 | def test_artifact_collection_should_work_for_manually_created_contexts_retain_on_failure_failed( 885 | testdir: pytest.Testdir, 886 | ) -> None: 887 | testdir.makepyfile( 888 | """ 889 | import pytest 890 | 891 | @pytest.mark.asyncio 892 | async def test_artifact_collection(browser, page, new_context): 893 | await page.goto("data:text/html,
hello
") 894 | 895 | other_context = await new_context() 896 | other_context_page = await other_context.new_page() 897 | await other_context_page.goto("data:text/html,
hello
") 898 | 899 | raise Exception("Failed") 900 | """ 901 | ) 902 | result = testdir.runpytest( 903 | "--video", "retain-on-failure", "--tracing", "retain-on-failure" 904 | ) 905 | result.assert_outcomes(failed=1) 906 | test_results_dir = os.path.join(testdir.tmpdir, "test-results") 907 | _assert_folder_structure( 908 | test_results_dir, 909 | """ 910 | - test-artifact-collection-should-work-for-manually-created-contexts-retain-on-failure-failed-py-test-artifact-collection-chromium: 911 | - trace-1.zip 912 | - trace-2.zip 913 | - video-1.webm 914 | - video-2.webm 915 | """, 916 | ) 917 | 918 | 919 | def test_artifact_collection_should_work_for_manually_created_contexts_retain_on_failure_pass( 920 | testdir: pytest.Testdir, 921 | ) -> None: 922 | testdir.makepyfile( 923 | """ 924 | import pytest 925 | 926 | @pytest.mark.asyncio 927 | async def test_artifact_collection(browser, page, new_context): 928 | await page.goto("data:text/html,
hello
") 929 | 930 | other_context = await new_context() 931 | other_context_page = await other_context.new_page() 932 | await other_context_page.goto("data:text/html,
hello
") 933 | """ 934 | ) 935 | result = testdir.runpytest( 936 | "--video", "retain-on-failure", "--tracing", "retain-on-failure" 937 | ) 938 | result.assert_outcomes(passed=1) 939 | test_results_dir = os.path.join(testdir.tmpdir, "test-results") 940 | _assert_folder_structure(test_results_dir, "") 941 | 942 | 943 | def test_new_context_allow_passing_args( 944 | testdir: pytest.Testdir, 945 | ) -> None: 946 | testdir.makepyfile( 947 | """ 948 | import pytest 949 | 950 | @pytest.mark.asyncio 951 | async def test_artifact_collection(new_context): 952 | context1 = await new_context(user_agent="agent1") 953 | page1 = await context1.new_page() 954 | assert await page1.evaluate("window.navigator.userAgent") == "agent1" 955 | await context1.close() 956 | 957 | context2 = await new_context(user_agent="agent2") 958 | page2 = await context2.new_page() 959 | assert await page2.evaluate("window.navigator.userAgent") == "agent2" 960 | await context2.close() 961 | """ 962 | ) 963 | result = testdir.runpytest() 964 | result.assert_outcomes(passed=1) 965 | 966 | 967 | def test_output_path_via_pytest_runtest_makereport_hook( 968 | testdir: pytest.Testdir, 969 | ) -> None: 970 | testdir.makeconftest( 971 | """ 972 | import pytest 973 | 974 | @pytest.hookimpl(hookwrapper=True) 975 | def pytest_runtest_makereport(item, call): 976 | outcome = yield 977 | report = outcome.get_result() 978 | 979 | if report.when == "call": 980 | output_path = item.funcargs.get("output_path") 981 | print("\\n\\noutput_path = {}".format(output_path)) 982 | """ 983 | ) 984 | 985 | testdir.makepyfile( 986 | """ 987 | def test_without_output_path(): 988 | pass 989 | 990 | def test_with_page(page): 991 | pass 992 | """ 993 | ) 994 | 995 | result = testdir.runpytest("--screenshot", "on", "-s") 996 | result.assert_outcomes(passed=2) 997 | output_paths = [line[14:] for line in result.outlines if "output_path = " in line] 998 | assert output_paths == [ 999 | "None", 1000 | testdir.tmpdir.join( 1001 | "test-results/test-output-path-via-pytest-runtest-makereport-hook-py-test-with-page-chromium" 1002 | ).strpath, 1003 | ] 1004 | 1005 | 1006 | def test_connect_options_should_work(testdir: pytest.Testdir) -> None: 1007 | server_process = None 1008 | try: 1009 | testdir.makeconftest( 1010 | """ 1011 | import pytest 1012 | 1013 | @pytest.fixture(scope="session") 1014 | def connect_options(): 1015 | return { 1016 | "ws_endpoint": "ws://localhost:1234", 1017 | } 1018 | """ 1019 | ) 1020 | testdir.makepyfile( 1021 | """ 1022 | import pytest 1023 | 1024 | @pytest.mark.asyncio() 1025 | async def test_connect_options(page): 1026 | assert await page.evaluate("1 + 1") == 2 1027 | """ 1028 | ) 1029 | result = testdir.runpytest() 1030 | assert "connect ECONNREFUSED" in "".join(result.outlines) 1031 | server_process = subprocess.Popen( 1032 | ["playwright", "run-server", "--port=1234"], 1033 | stdout=subprocess.PIPE, 1034 | stderr=subprocess.PIPE, 1035 | ) 1036 | while True: 1037 | stdout = server_process.stdout 1038 | assert stdout 1039 | if "Listening on" in str(stdout.readline()): 1040 | break 1041 | result = testdir.runpytest() 1042 | result.assert_outcomes(passed=1) 1043 | finally: 1044 | assert server_process 1045 | # TODO: Playwright CLI on Windows via Python does not forward the signal 1046 | # hence we need to send it to the whole process group. 1047 | if sys.platform == "win32": 1048 | subprocess.run(["taskkill", "/F", "/T", "/PID", str(server_process.pid)]) 1049 | else: 1050 | os.kill(server_process.pid, signal.SIGINT) 1051 | server_process.wait() 1052 | -------------------------------------------------------------------------------- /tests/test_sync.py: -------------------------------------------------------------------------------- 1 | # Copyright (c) Microsoft Corporation. 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # http://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | 15 | import os 16 | from pathlib import Path 17 | import signal 18 | import subprocess 19 | import sys 20 | 21 | import pytest 22 | 23 | 24 | @pytest.fixture 25 | def pytester(pytester: pytest.Pytester) -> pytest.Pytester: 26 | # Pytester internally in their constructor overrides the HOME and USERPROFILE env variables. This confuses Chromium hence we unset them. 27 | # See https://github.com/pytest-dev/pytest/blob/83536b4b0074ca35d90933d3ad46cb6efe7f5145/src/_pytest/pytester.py#L704-L705 28 | os.environ.pop("HOME", None) 29 | os.environ.pop("USERPROFILE", None) 30 | return pytester 31 | 32 | 33 | @pytest.fixture(autouse=True) 34 | def _add_ini(testdir: pytest.Testdir) -> None: 35 | testdir.makefile( 36 | ".ini", 37 | pytest=""" 38 | [pytest] 39 | addopts = -p no:playwright-asyncio 40 | """, 41 | ) 42 | 43 | 44 | def test_default(testdir: pytest.Testdir) -> None: 45 | testdir.makepyfile( 46 | """ 47 | import pytest 48 | 49 | def test_default(page, browser_name): 50 | assert browser_name == "chromium" 51 | user_agent = page.evaluate("window.navigator.userAgent") 52 | assert "HeadlessChrome" in user_agent 53 | page.set_content('bar') 54 | assert page.query_selector("#foo") 55 | """ 56 | ) 57 | result = testdir.runpytest() 58 | result.assert_outcomes(passed=1) 59 | 60 | 61 | def test_slowmo(testdir: pytest.Testdir) -> None: 62 | testdir.makepyfile( 63 | """ 64 | from time import monotonic 65 | def test_slowmo(page): 66 | email = "test@test.com" 67 | page.set_content("") 68 | start_time = monotonic() 69 | page.type("input", email) 70 | end_time = monotonic() 71 | assert end_time - start_time >= 1 72 | assert end_time - start_time < 2 73 | """ 74 | ) 75 | result = testdir.runpytest("--browser", "chromium", "--slowmo", "1000") 76 | result.assert_outcomes(passed=1) 77 | 78 | 79 | @pytest.mark.parametrize( 80 | "channel", 81 | [ 82 | "chrome", 83 | "msedge", 84 | ], 85 | ) 86 | def test_browser_channel(channel: str, testdir: pytest.Testdir) -> None: 87 | if channel == "msedge" and sys.platform == "linux": 88 | pytest.skip("msedge not supported on linux") 89 | testdir.makepyfile( 90 | f""" 91 | import pytest 92 | 93 | def test_browser_channel(page, browser_name, browser_channel): 94 | assert browser_name == "chromium" 95 | assert browser_channel == "{channel}" 96 | """ 97 | ) 98 | result = testdir.runpytest("--browser-channel", channel) 99 | result.assert_outcomes(passed=1) 100 | 101 | 102 | def test_invalid_browser_channel(testdir: pytest.Testdir) -> None: 103 | testdir.makepyfile( 104 | """ 105 | import pytest 106 | 107 | def test_browser_channel(page, browser_name, browser_channel): 108 | assert browser_name == "chromium" 109 | """ 110 | ) 111 | result = testdir.runpytest("--browser-channel", "not-exists") 112 | result.assert_outcomes(errors=1) 113 | assert "Unsupported chromium channel" in "\n".join(result.outlines) 114 | 115 | 116 | def test_unittest_class(testdir: pytest.Testdir) -> None: 117 | testdir.makepyfile( 118 | """ 119 | import pytest 120 | import unittest 121 | from playwright.sync_api import Page 122 | 123 | 124 | class MyTest(unittest.TestCase): 125 | @pytest.fixture(autouse=True) 126 | def setup(self, page: Page): 127 | self.page = page 128 | 129 | def test_foobar(self): 130 | assert self.page.evaluate("1 + 1") == 2 131 | """ 132 | ) 133 | result = testdir.runpytest("--browser", "chromium") 134 | result.assert_outcomes(passed=1) 135 | 136 | 137 | def test_unittest_class_multiple_browsers(testdir: pytest.Testdir) -> None: 138 | testdir.makepyfile( 139 | """ 140 | import pytest 141 | import unittest 142 | from playwright.sync_api import Page 143 | 144 | 145 | class MyTest(unittest.TestCase): 146 | @pytest.fixture(autouse=True) 147 | def setup(self, page: Page): 148 | self.page = page 149 | 150 | def test_foobar(self): 151 | assert "Firefox" in self.page.evaluate("navigator.userAgent") 152 | assert self.page.evaluate("1 + 1") == 2 153 | """ 154 | ) 155 | result = testdir.runpytest("--browser", "firefox", "--browser", "webkit") 156 | result.assert_outcomes(passed=1) 157 | assert any("multiple browsers is not supported" in line for line in result.outlines) 158 | 159 | 160 | def test_multiple_browsers(testdir: pytest.Testdir) -> None: 161 | testdir.makepyfile( 162 | """ 163 | def test_multiple_browsers(page): 164 | page.set_content('bar') 165 | assert page.query_selector("#foo") 166 | """ 167 | ) 168 | result = testdir.runpytest( 169 | "--browser", "chromium", "--browser", "firefox", "--browser", "webkit" 170 | ) 171 | result.assert_outcomes(passed=3) 172 | 173 | 174 | def test_browser_context_args(testdir: pytest.Testdir) -> None: 175 | testdir.makeconftest( 176 | """ 177 | import pytest 178 | 179 | @pytest.fixture(scope="session") 180 | def browser_context_args(): 181 | return {"user_agent": "foobar"} 182 | """ 183 | ) 184 | testdir.makepyfile( 185 | """ 186 | def test_browser_context_args(page): 187 | assert page.evaluate("window.navigator.userAgent") == "foobar" 188 | """ 189 | ) 190 | result = testdir.runpytest() 191 | result.assert_outcomes(passed=1) 192 | 193 | 194 | def test_user_defined_browser_context_args(testdir: pytest.Testdir) -> None: 195 | testdir.makeconftest( 196 | """ 197 | import pytest 198 | 199 | @pytest.fixture(scope="session") 200 | def browser_context_args(): 201 | return {"user_agent": "foobar"} 202 | """ 203 | ) 204 | testdir.makepyfile( 205 | """ 206 | import pytest 207 | 208 | @pytest.mark.browser_context_args(user_agent="overwritten", locale="new-locale") 209 | def test_browser_context_args(page): 210 | assert page.evaluate("window.navigator.userAgent") == "overwritten" 211 | assert page.evaluate("window.navigator.languages") == ["new-locale"] 212 | """ 213 | ) 214 | result = testdir.runpytest() 215 | result.assert_outcomes(passed=1) 216 | 217 | 218 | def test_user_defined_browser_context_args_clear_again(testdir: pytest.Testdir) -> None: 219 | testdir.makeconftest( 220 | """ 221 | import pytest 222 | 223 | @pytest.fixture(scope="session") 224 | def browser_context_args(): 225 | return {"user_agent": "foobar"} 226 | """ 227 | ) 228 | testdir.makepyfile( 229 | """ 230 | import pytest 231 | 232 | @pytest.mark.browser_context_args(user_agent="overwritten") 233 | def test_browser_context_args(page): 234 | assert page.evaluate("window.navigator.userAgent") == "overwritten" 235 | 236 | def test_browser_context_args2(page): 237 | assert page.evaluate("window.navigator.userAgent") == "foobar" 238 | """ 239 | ) 240 | result = testdir.runpytest() 241 | result.assert_outcomes(passed=2) 242 | 243 | 244 | def test_chromium(testdir: pytest.Testdir) -> None: 245 | testdir.makepyfile( 246 | """ 247 | def test_is_chromium(page, browser_name, is_chromium, is_firefox, is_webkit): 248 | assert browser_name == "chromium" 249 | assert is_chromium 250 | assert is_firefox is False 251 | assert is_webkit is False 252 | """ 253 | ) 254 | result = testdir.runpytest() 255 | result.assert_outcomes(passed=1) 256 | 257 | 258 | def test_firefox(testdir: pytest.Testdir) -> None: 259 | testdir.makepyfile( 260 | """ 261 | def test_is_firefox(page, browser_name, is_chromium, is_firefox, is_webkit): 262 | assert browser_name == "firefox" 263 | assert is_chromium is False 264 | assert is_firefox 265 | assert is_webkit is False 266 | """ 267 | ) 268 | result = testdir.runpytest("--browser", "firefox") 269 | result.assert_outcomes(passed=1) 270 | 271 | 272 | def test_webkit(testdir: pytest.Testdir) -> None: 273 | testdir.makepyfile( 274 | """ 275 | def test_is_webkit(page, browser_name, is_chromium, is_firefox, is_webkit): 276 | assert browser_name == "webkit" 277 | assert is_chromium is False 278 | assert is_firefox is False 279 | assert is_webkit 280 | """ 281 | ) 282 | result = testdir.runpytest("--browser", "webkit") 283 | result.assert_outcomes(passed=1) 284 | 285 | 286 | def test_goto(testdir: pytest.Testdir) -> None: 287 | testdir.makepyfile( 288 | """ 289 | def test_base_url(page, base_url): 290 | assert base_url == "https://example.com" 291 | page.goto("/foobar") 292 | assert page.url == "https://example.com/foobar" 293 | page.goto("https://example.org") 294 | assert page.url == "https://example.org/" 295 | """ 296 | ) 297 | result = testdir.runpytest("--base-url", "https://example.com") 298 | result.assert_outcomes(passed=1) 299 | 300 | 301 | def test_base_url_via_fixture(testdir: pytest.Testdir) -> None: 302 | testdir.makepyfile( 303 | """ 304 | import pytest 305 | 306 | @pytest.fixture(scope="session") 307 | def base_url(): 308 | return "https://example.com" 309 | 310 | def test_base_url(page, base_url): 311 | assert base_url == "https://example.com" 312 | page.goto("/foobar") 313 | assert page.url == "https://example.com/foobar" 314 | """ 315 | ) 316 | result = testdir.runpytest() 317 | result.assert_outcomes(passed=1) 318 | 319 | 320 | def test_skip_browsers(testdir: pytest.Testdir) -> None: 321 | testdir.makepyfile( 322 | """ 323 | import pytest 324 | 325 | @pytest.mark.skip_browser("firefox") 326 | def test_base_url(page, browser_name): 327 | assert browser_name in ["chromium", "webkit"] 328 | """ 329 | ) 330 | result = testdir.runpytest( 331 | "--browser", "chromium", "--browser", "firefox", "--browser", "webkit" 332 | ) 333 | result.assert_outcomes(passed=2, skipped=1) 334 | 335 | 336 | def test_only_browser(testdir: pytest.Testdir) -> None: 337 | testdir.makepyfile( 338 | """ 339 | import pytest 340 | 341 | @pytest.mark.only_browser("firefox") 342 | def test_base_url(page, browser_name): 343 | assert browser_name == "firefox" 344 | """ 345 | ) 346 | result = testdir.runpytest( 347 | "--browser", "chromium", "--browser", "firefox", "--browser", "webkit" 348 | ) 349 | result.assert_outcomes(passed=1, skipped=2) 350 | 351 | 352 | def test_parameterization(testdir: pytest.Testdir) -> None: 353 | testdir.makepyfile( 354 | """ 355 | def test_all_browsers(page): 356 | pass 357 | 358 | def test_without_browser(): 359 | pass 360 | """ 361 | ) 362 | result = testdir.runpytest( 363 | "--verbose", 364 | "--browser", 365 | "chromium", 366 | "--browser", 367 | "firefox", 368 | "--browser", 369 | "webkit", 370 | ) 371 | result.assert_outcomes(passed=4) 372 | assert "test_without_browser PASSED" in "\n".join(result.outlines) 373 | 374 | 375 | def test_xdist(testdir: pytest.Testdir) -> None: 376 | testdir.makepyfile( 377 | """ 378 | def test_a(page): 379 | page.set_content('a') 380 | page.wait_for_timeout(200) 381 | assert page.query_selector("#foo") 382 | 383 | def test_b(page): 384 | page.wait_for_timeout(2000) 385 | page.set_content('a') 386 | assert page.query_selector("#foo") 387 | 388 | def test_c(page): 389 | page.set_content('a') 390 | page.wait_for_timeout(200) 391 | assert page.query_selector("#foo") 392 | 393 | def test_d(page): 394 | page.set_content('a') 395 | page.wait_for_timeout(200) 396 | assert page.query_selector("#foo") 397 | """ 398 | ) 399 | result = testdir.runpytest( 400 | "--verbose", 401 | "--browser", 402 | "chromium", 403 | "--browser", 404 | "firefox", 405 | "--browser", 406 | "webkit", 407 | "--numprocesses", 408 | "2", 409 | ) 410 | result.assert_outcomes(passed=12) 411 | assert "gw0" in "\n".join(result.outlines) 412 | assert "gw1" in "\n".join(result.outlines) 413 | 414 | 415 | def test_xdist_should_not_print_any_warnings(testdir: pytest.Testdir) -> None: 416 | original = os.environ.get("PYTHONWARNINGS") 417 | os.environ["PYTHONWARNINGS"] = "always" 418 | try: 419 | testdir.makepyfile( 420 | """ 421 | import pytest 422 | 423 | def test_default(page): 424 | pass 425 | """ 426 | ) 427 | result = testdir.runpytest( 428 | "--numprocesses", 429 | "2", 430 | ) 431 | result.assert_outcomes(passed=1) 432 | assert "ResourceWarning" not in "".join(result.stderr.lines) 433 | finally: 434 | if original is not None: 435 | os.environ["PYTHONWARNINGS"] = original 436 | else: 437 | del os.environ["PYTHONWARNINGS"] 438 | 439 | 440 | def test_headed(testdir: pytest.Testdir) -> None: 441 | testdir.makepyfile( 442 | """ 443 | def test_base_url(page, browser_name): 444 | user_agent = page.evaluate("window.navigator.userAgent") 445 | assert "HeadlessChrome" not in user_agent 446 | """ 447 | ) 448 | result = testdir.runpytest("--browser", "chromium", "--headed") 449 | result.assert_outcomes(passed=1) 450 | 451 | 452 | def test_invalid_browser_name(testdir: pytest.Testdir) -> None: 453 | testdir.makepyfile( 454 | """ 455 | def test_base_url(page): 456 | pass 457 | """ 458 | ) 459 | result = testdir.runpytest("--browser", "test123") 460 | assert any(["--browser: invalid choice" in line for line in result.errlines]) 461 | 462 | 463 | def test_django(testdir: pytest.Testdir) -> None: 464 | # Workaround for https://github.com/pytest-dev/pytest/issues/10651 465 | os.environ.setdefault("PYTHONPATH", str(Path(__file__).parent.parent)) 466 | os.environ.setdefault("DJANGO_SETTINGS_MODULE", "tests.assets.django.settings") 467 | testdir.makepyfile( 468 | """ 469 | from django.test import TestCase 470 | class Proj1Test(TestCase): 471 | def test_one(self): 472 | self.assertTrue(True) 473 | 474 | """ 475 | ) 476 | result = testdir.runpytest() 477 | result.assert_outcomes(passed=1) 478 | 479 | 480 | def test_browser_context_args_device(testdir: pytest.Testdir) -> None: 481 | testdir.makeconftest( 482 | """ 483 | import pytest 484 | 485 | @pytest.fixture(scope="session") 486 | def browser_context_args(browser_context_args, playwright): 487 | iphone_11 = playwright.devices['iPhone 11 Pro'] 488 | return {**browser_context_args, **iphone_11} 489 | """ 490 | ) 491 | testdir.makepyfile( 492 | """ 493 | def test_browser_context_args(page): 494 | assert "iPhone" in page.evaluate("window.navigator.userAgent") 495 | """ 496 | ) 497 | result = testdir.runpytest() 498 | result.assert_outcomes(passed=1) 499 | 500 | 501 | def test_launch_persistent_context_session(testdir: pytest.Testdir) -> None: 502 | testdir.makeconftest( 503 | """ 504 | import pytest 505 | from playwright.sync_api import BrowserType 506 | from typing import Dict 507 | 508 | @pytest.fixture(scope="session") 509 | def context( 510 | browser_type: BrowserType, 511 | browser_type_launch_args: Dict, 512 | browser_context_args: Dict 513 | ): 514 | context = browser_type.launch_persistent_context("./foobar", **{ 515 | **browser_type_launch_args, 516 | **browser_context_args, 517 | "locale": "de-DE", 518 | }) 519 | yield context 520 | context.close() 521 | """ 522 | ) 523 | testdir.makepyfile( 524 | """ 525 | def test_browser_context_args(page): 526 | assert page.evaluate("navigator.language") == "de-DE" 527 | """ 528 | ) 529 | result = testdir.runpytest() 530 | result.assert_outcomes(passed=1) 531 | 532 | 533 | def test_context_page_on_session_level(testdir: pytest.Testdir) -> None: 534 | testdir.makeconftest( 535 | """ 536 | import pytest 537 | from playwright.sync_api import Browser, BrowserContext 538 | from typing import Dict 539 | 540 | @pytest.fixture(scope="session") 541 | def context( 542 | browser: Browser, 543 | browser_context_args: Dict 544 | ): 545 | context = browser.new_context(**{ 546 | **browser_context_args, 547 | }) 548 | yield context 549 | context.close() 550 | 551 | @pytest.fixture(scope="session") 552 | def page( 553 | context: BrowserContext, 554 | ): 555 | page = context.new_page() 556 | yield page 557 | """ 558 | ) 559 | testdir.makepyfile( 560 | """ 561 | def test_a(page): 562 | page.goto("data:text/html,
B
") 563 | assert page.text_content("div") == "B" 564 | 565 | def test_b(page): 566 | assert page.text_content("div") == "B" 567 | """ 568 | ) 569 | result = testdir.runpytest() 570 | result.assert_outcomes(passed=2) 571 | 572 | 573 | def test_launch_persistent_context_function(testdir: pytest.Testdir) -> None: 574 | testdir.makeconftest( 575 | """ 576 | import pytest 577 | from playwright.sync_api import BrowserType 578 | from typing import Dict 579 | 580 | @pytest.fixture() 581 | def context( 582 | browser_type: BrowserType, 583 | browser_type_launch_args: Dict, 584 | browser_context_args: Dict 585 | ): 586 | context = browser_type.launch_persistent_context("./foobar", **{ 587 | **browser_type_launch_args, 588 | **browser_context_args, 589 | "locale": "de-DE", 590 | }) 591 | yield context 592 | context.close() 593 | """ 594 | ) 595 | testdir.makepyfile( 596 | """ 597 | def test_browser_context_args(page): 598 | assert page.evaluate("navigator.language") == "de-DE" 599 | """ 600 | ) 601 | result = testdir.runpytest() 602 | result.assert_outcomes(passed=1) 603 | 604 | 605 | def test_device_emulation(testdir: pytest.Testdir) -> None: 606 | testdir.makepyfile( 607 | """ 608 | import pytest 609 | def test_device_emulation(page, device): 610 | assert device == 'iPhone 11 Pro' 611 | assert "iPhone" in page.evaluate("window.navigator.userAgent") 612 | """ 613 | ) 614 | result = testdir.runpytest("--device", "iPhone 11 Pro") 615 | result.assert_outcomes(passed=1) 616 | 617 | 618 | def test_rep_call_keyboard_interrupt(testdir: pytest.Testdir) -> None: 619 | testdir.makepyfile( 620 | """ 621 | import pytest 622 | 623 | def test_rep_call(page): 624 | assert page.evaluate("1 + 1") == 2 625 | raise KeyboardInterrupt 626 | """ 627 | ) 628 | result = testdir.runpytest() 629 | result.assert_outcomes(passed=0, failed=0, skipped=0) 630 | 631 | 632 | def test_artifacts_by_default_it_should_not_store_anything( 633 | testdir: pytest.Testdir, 634 | ) -> None: 635 | testdir.makepyfile( 636 | """ 637 | def test_passing(page): 638 | assert 2 == page.evaluate("1 + 1") 639 | 640 | def test_failing(page): 641 | raise Exception("Failed") 642 | """ 643 | ) 644 | result = testdir.runpytest() 645 | result.assert_outcomes(passed=1, failed=1) 646 | for dir in testdir.tmpdir.listdir(): 647 | assert dir.basename != "test-results" 648 | 649 | 650 | def test_artifacts_new_folder_on_run( 651 | testdir: pytest.Testdir, 652 | ) -> None: 653 | test_results_dir = os.path.join(testdir.tmpdir, "test-results") 654 | os.mkdir(os.path.join(test_results_dir)) 655 | with open(os.path.join(test_results_dir, "example.json"), "w") as f: 656 | f.write("foo") 657 | 658 | testdir.makepyfile( 659 | """ 660 | def test_passing(page): 661 | assert 2 == page.evaluate("1 + 1") 662 | """ 663 | ) 664 | result = testdir.runpytest() 665 | result.assert_outcomes(passed=1) 666 | for dir in testdir.tmpdir.listdir(): 667 | assert dir.basename != "test-results" 668 | 669 | 670 | def test_artifacts_should_store_everything_if_on(testdir: pytest.Testdir) -> None: 671 | testdir.makepyfile( 672 | """ 673 | def test_passing(page, output_path): 674 | print(f"\\n\\noutput_path = {output_path}\\n\\n") 675 | assert 2 == page.evaluate("1 + 1") 676 | 677 | def test_failing(page, output_path): 678 | print(f"\\n\\noutput_path = {output_path}\\n\\n") 679 | raise Exception("Failed") 680 | """ 681 | ) 682 | result = testdir.runpytest( 683 | "--screenshot", "on", "--video", "on", "--tracing", "on", "-s" 684 | ) 685 | result.assert_outcomes(passed=1, failed=1) 686 | test_results_dir = os.path.join(testdir.tmpdir, "test-results") 687 | _assert_folder_structure( 688 | test_results_dir, 689 | """ 690 | - test-artifacts-should-store-everything-if-on-py-test-failing-chromium: 691 | - test-failed-1.png 692 | - trace.zip 693 | - video.webm 694 | - test-artifacts-should-store-everything-if-on-py-test-passing-chromium: 695 | - test-finished-1.png 696 | - trace.zip 697 | - video.webm 698 | """, 699 | ) 700 | output_path = str(testdir.tmpdir) 701 | output_paths = [ 702 | line[14:] for line in result.outlines if f"output_path = {output_path}" in line 703 | ] 704 | assert output_paths == [ 705 | testdir.tmpdir.join( 706 | "test-results/test-artifacts-should-store-everything-if-on-py-test-passing-chromium" 707 | ).strpath, 708 | testdir.tmpdir.join( 709 | "test-results/test-artifacts-should-store-everything-if-on-py-test-failing-chromium" 710 | ).strpath, 711 | ] 712 | 713 | 714 | def test_artifacts_retain_on_failure(testdir: pytest.Testdir) -> None: 715 | testdir.makepyfile( 716 | """ 717 | def test_passing(page): 718 | assert 2 == page.evaluate("1 + 1") 719 | 720 | def test_failing(page): 721 | raise Exception("Failed") 722 | """ 723 | ) 724 | result = testdir.runpytest( 725 | "--screenshot", 726 | "only-on-failure", 727 | "--video", 728 | "retain-on-failure", 729 | "--tracing", 730 | "retain-on-failure", 731 | ) 732 | result.assert_outcomes(passed=1, failed=1) 733 | test_results_dir = os.path.join(testdir.tmpdir, "test-results") 734 | _assert_folder_structure( 735 | test_results_dir, 736 | """ 737 | - test-artifacts-retain-on-failure-py-test-failing-chromium: 738 | - test-failed-1.png 739 | - trace.zip 740 | - video.webm 741 | """, 742 | ) 743 | 744 | 745 | def test_should_work_with_test_names_which_exceeds_256_characters( 746 | testdir: pytest.Testdir, 747 | ) -> None: 748 | long_test_name = "abcdefghijklmnopqrstuvwxyz" * 100 749 | testdir.makepyfile( 750 | f""" 751 | def test_{long_test_name}(page): 752 | pass 753 | """ 754 | ) 755 | result = testdir.runpytest("--tracing", "on") 756 | result.assert_outcomes(passed=1, failed=0) 757 | test_results_dir = os.path.join(testdir.tmpdir, "test-results") 758 | _assert_folder_structure( 759 | test_results_dir, 760 | """ 761 | - test-should-work-with-test-names-which-exceeds-256-characters-py-test-abcdefghijklmnopqrstuvwxyzabcd-23f2441-nopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyzabcdefghijklmnopqrstuvwxyz-chromium: 762 | - trace.zip 763 | """, 764 | ) 765 | 766 | 767 | def _make_folder_list(root: str, level: int = 0) -> str: 768 | if not os.path.exists(root): 769 | return "" 770 | tree = [] 771 | for entry in sorted(os.scandir(root), key=lambda e: e.name): 772 | prefix = f"{' ' * level}- " 773 | if entry.is_dir(): 774 | tree.append(f"{prefix}{entry.name}:\n") 775 | tree.append(_make_folder_list(entry.path, level + 1)) 776 | else: 777 | tree.append(f"{prefix}{entry.name}\n") 778 | return "".join(tree) 779 | 780 | 781 | def _assert_folder_structure(root: str, expected: str) -> None: 782 | __tracebackhide__ = True 783 | actual = _make_folder_list(root) 784 | if actual.strip() != expected.strip(): 785 | print("Actual:") 786 | print(actual) 787 | print("Expected:") 788 | print(expected) 789 | raise AssertionError("Actual tree does not match expected tree") 790 | 791 | 792 | def test_is_able_to_set_expect_timeout_via_conftest(testdir: pytest.Testdir) -> None: 793 | testdir.makeconftest( 794 | """ 795 | from playwright.sync_api import expect 796 | expect.set_options(timeout=1111) 797 | """ 798 | ) 799 | testdir.makepyfile( 800 | """ 801 | from playwright.sync_api import expect 802 | 803 | def test_small_timeout(page): 804 | page.goto("data:text/html,") 805 | expect(page.locator("#A")).to_be_visible() 806 | """ 807 | ) 808 | result = testdir.runpytest() 809 | result.assert_outcomes(passed=0, failed=1, skipped=0) 810 | result.stdout.fnmatch_lines("*AssertionError: Locator expected to be visible*") 811 | result.stdout.fnmatch_lines("*LocatorAssertions.to_be_visible with timeout 1111ms*") 812 | 813 | 814 | def test_artifact_collection_should_work_for_manually_created_contexts_keep_open( 815 | testdir: pytest.Testdir, 816 | ) -> None: 817 | testdir.makepyfile( 818 | """ 819 | import pytest 820 | from pytest_playwright.pytest_playwright import CreateContextCallback 821 | 822 | def test_artifact_collection(browser, page, new_context: CreateContextCallback): 823 | page.goto("data:text/html,
hello
") 824 | 825 | other_context = new_context() 826 | other_context_page = other_context.new_page() 827 | other_context_page.goto("data:text/html,
hello
") 828 | """ 829 | ) 830 | result = testdir.runpytest("--screenshot", "on", "--video", "on", "--tracing", "on") 831 | result.assert_outcomes(passed=1) 832 | test_results_dir = os.path.join(testdir.tmpdir, "test-results") 833 | _assert_folder_structure( 834 | test_results_dir, 835 | """ 836 | - test-artifact-collection-should-work-for-manually-created-contexts-keep-open-py-test-artifact-collection-chromium: 837 | - test-finished-1.png 838 | - test-finished-2.png 839 | - trace-1.zip 840 | - trace-2.zip 841 | - video-1.webm 842 | - video-2.webm 843 | """, 844 | ) 845 | 846 | 847 | def test_artifact_collection_should_work_for_manually_created_contexts_get_closed( 848 | testdir: pytest.Testdir, 849 | ) -> None: 850 | testdir.makepyfile( 851 | """ 852 | import pytest 853 | 854 | def test_artifact_collection(browser, page, new_context): 855 | page.goto("data:text/html,
hello
") 856 | 857 | other_context = new_context() 858 | other_context_page = other_context.new_page() 859 | other_context_page.goto("data:text/html,
hello
") 860 | other_context_page.evaluate("new Promise(fulfill => requestAnimationFrame(() => requestAnimationFrame(fulfill)))") 861 | other_context.close() 862 | """ 863 | ) 864 | result = testdir.runpytest("--video", "on", "--tracing", "on") 865 | result.assert_outcomes(passed=1) 866 | test_results_dir = os.path.join(testdir.tmpdir, "test-results") 867 | _assert_folder_structure( 868 | test_results_dir, 869 | """ 870 | - test-artifact-collection-should-work-for-manually-created-contexts-get-closed-py-test-artifact-collection-chromium: 871 | - trace-1.zip 872 | - trace-2.zip 873 | - video-1.webm 874 | - video-2.webm 875 | """, 876 | ) 877 | 878 | 879 | def test_artifact_collection_should_work_for_manually_created_contexts_retain_on_failure_failed( 880 | testdir: pytest.Testdir, 881 | ) -> None: 882 | testdir.makepyfile( 883 | """ 884 | import pytest 885 | 886 | def test_artifact_collection(browser, page, new_context): 887 | page.goto("data:text/html,
hello
") 888 | 889 | other_context = new_context() 890 | other_context_page = other_context.new_page() 891 | other_context_page.goto("data:text/html,
hello
") 892 | 893 | raise Exception("Failed") 894 | """ 895 | ) 896 | result = testdir.runpytest( 897 | "--video", "retain-on-failure", "--tracing", "retain-on-failure" 898 | ) 899 | result.assert_outcomes(failed=1) 900 | test_results_dir = os.path.join(testdir.tmpdir, "test-results") 901 | _assert_folder_structure( 902 | test_results_dir, 903 | """ 904 | - test-artifact-collection-should-work-for-manually-created-contexts-retain-on-failure-failed-py-test-artifact-collection-chromium: 905 | - trace-1.zip 906 | - trace-2.zip 907 | - video-1.webm 908 | - video-2.webm 909 | """, 910 | ) 911 | 912 | 913 | def test_artifact_collection_should_work_for_manually_created_contexts_retain_on_failure_pass( 914 | testdir: pytest.Testdir, 915 | ) -> None: 916 | testdir.makepyfile( 917 | """ 918 | import pytest 919 | 920 | def test_artifact_collection(browser, page, new_context): 921 | page.goto("data:text/html,
hello
") 922 | 923 | other_context = new_context() 924 | other_context_page = other_context.new_page() 925 | other_context_page.goto("data:text/html,
hello
") 926 | """ 927 | ) 928 | result = testdir.runpytest( 929 | "--video", "retain-on-failure", "--tracing", "retain-on-failure" 930 | ) 931 | result.assert_outcomes(passed=1) 932 | test_results_dir = os.path.join(testdir.tmpdir, "test-results") 933 | _assert_folder_structure(test_results_dir, "") 934 | 935 | 936 | def test_new_context_allow_passing_args( 937 | testdir: pytest.Testdir, 938 | ) -> None: 939 | testdir.makepyfile( 940 | """ 941 | import pytest 942 | 943 | def test_artifact_collection(new_context): 944 | context1 = new_context(user_agent="agent1") 945 | page1 = context1.new_page() 946 | assert page1.evaluate("window.navigator.userAgent") == "agent1" 947 | context1.close() 948 | 949 | context2 = new_context(user_agent="agent2") 950 | page2 = context2.new_page() 951 | assert page2.evaluate("window.navigator.userAgent") == "agent2" 952 | context2.close() 953 | """ 954 | ) 955 | result = testdir.runpytest() 956 | result.assert_outcomes(passed=1) 957 | 958 | 959 | def test_output_path_via_pytest_runtest_makereport_hook( 960 | testdir: pytest.Testdir, 961 | ) -> None: 962 | testdir.makeconftest( 963 | """ 964 | import pytest 965 | 966 | @pytest.hookimpl(hookwrapper=True) 967 | def pytest_runtest_makereport(item, call): 968 | outcome = yield 969 | report = outcome.get_result() 970 | 971 | if report.when == "call": 972 | output_path = item.funcargs.get("output_path") 973 | print("\\n\\noutput_path = {}".format(output_path)) 974 | """ 975 | ) 976 | 977 | testdir.makepyfile( 978 | """ 979 | def test_without_output_path(): 980 | pass 981 | 982 | def test_with_page(page): 983 | pass 984 | """ 985 | ) 986 | 987 | result = testdir.runpytest("--screenshot", "on", "-s") 988 | result.assert_outcomes(passed=2) 989 | output_paths = [line[14:] for line in result.outlines if "output_path = " in line] 990 | assert output_paths == [ 991 | "None", 992 | testdir.tmpdir.join( 993 | "test-results/test-output-path-via-pytest-runtest-makereport-hook-py-test-with-page-chromium" 994 | ).strpath, 995 | ] 996 | 997 | 998 | def test_connect_options_should_work(testdir: pytest.Testdir) -> None: 999 | server_process = None 1000 | try: 1001 | testdir.makeconftest( 1002 | """ 1003 | import pytest 1004 | 1005 | @pytest.fixture(scope="session") 1006 | def connect_options(): 1007 | return { 1008 | "ws_endpoint": "ws://localhost:1234", 1009 | } 1010 | """ 1011 | ) 1012 | testdir.makepyfile( 1013 | """ 1014 | def test_connect_options(page): 1015 | assert page.evaluate("1 + 1") == 2 1016 | """ 1017 | ) 1018 | result = testdir.runpytest() 1019 | assert "connect ECONNREFUSED" in "".join(result.outlines) 1020 | server_process = subprocess.Popen( 1021 | ["playwright", "run-server", "--port=1234"], 1022 | stdout=subprocess.PIPE, 1023 | ) 1024 | while True: 1025 | stdout = server_process.stdout 1026 | assert stdout 1027 | if "Listening on" in str(stdout.readline()): 1028 | break 1029 | result = testdir.runpytest() 1030 | result.assert_outcomes(passed=1) 1031 | finally: 1032 | assert server_process 1033 | # TODO: Playwright CLI on Windows via Python does not forward the signal 1034 | # hence we need to send it to the whole process group. 1035 | if sys.platform == "win32": 1036 | subprocess.run(["taskkill", "/F", "/T", "/PID", str(server_process.pid)]) 1037 | else: 1038 | os.kill(server_process.pid, signal.SIGINT) 1039 | server_process.wait() 1040 | --------------------------------------------------------------------------------