Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 6.1 KB

2_Blueprint_File_Breakdown.md

File metadata and controls

76 lines (50 loc) · 6.1 KB
Raw

Getting Started #2: Blueprint File Breakdown

This guide outlines the breakdown of this blueprint, and specifically the files of importance for running Playwright Pytest.

Contents

Directories & Files Directly Impacting Tests

The files in this section cover the files that impact your ability to execute tests.

requirements.txt

This file outlines the packages required from the Python Package Index (PyPI) to execute this project. This should be regularly maintained to ensure that we have the most up-to-date versions of any packages we intend to use.

pytest.ini

This file outlines the configuration of pytest, and ultimately how Playwright also executes. A couple of things to note:

  • The log_cli section covers default logging provided by pytest - we have defaulted this to on at INFO level, but this can be amended as needed.
  • The addopts section will run any commands you want to run by default for each execution and can be overwritten using the appropriate options via the command line. For example, you can override the --tracing level to on by executing pytest using: pytest --tracing=on. The options we have turned on by default are:
    • Do not run the tests marked utils by default (these are the unit tests for this project and do not use Playwright)
    • Generate a HTML report in a single file, and output it in the test-results directory with the name report.html
    • Generate a JSON report, omitting some collection data and then output it in the test-results directory with the name results.json
    • Only generate Playwright stack-trace files when a test fails
  • The pythonpath section just sets the base of this project for the pythonpath system variable utilised by pytest. This is designed to mitigate local configuration issues, see the pytest documentation for more information.
  • The markers section is for organizing any marks (or tags) you want to apply to your tests, for example by a business area or a testing type. If you don't include your marks in this list, pytest will give you a warning until they have either been added here or programmatically within the code.

Any configuration you want to apply to all of your test executions should be placed in this file where possible, to ensure easy maintenance.

users.json

This file outlines the users you may want to use as part of your testing, and is utilised by the User Tools utility. Further information on how this file is used can be found in the User Tools Utility Guide.

tests/

This directory is designed to house all of your tests intended for execution.

Because we want to treat this directory as a Python package, there is a blank __init__.py file present in this directory that should remain present.

pages/

This directory is designed to house all of your page object model classes, to facilitate reusable code and easy to maintain tests.

We want this directory to be treated as a Python package, so there is a blank __init__.py file present in this directory that should remain present.

utils/

This directory is designed to house any utility classes that would assist in test execution. We provide some utility classes as part of this blueprint, but as you begin testing your own applications you may find that these utilities may need to be expanded or you need something different from what has been provided. For example, you may create a utility class for logging into your application - that code should go in this directory.

We want this directory to be treated as a Python package, so there is a blank __init__.py file present in this directory that should remain present.

NOTE: If you write a utility class for your own project that you think other projects may benefit from and can be applied in a generic way, please raise a Feature Request as we welcome any contributions of this fashion.

Directories & Files Specific For This Repository

The following directories and files are specific for this repository, and may require modification or removal if transferring this code into a new repository.

  • .github/: This directory has the code used to manage our repository and pipelines including CI/CD checks. You may find some useful for your own repository, especially if you are using GitHub to manage your code.
  • .vscode/: This directory houses the default recommended configuration and settings for VSCode, if you use it as an IDE.
  • docs/: This directory houses the documentation for this repository (including documents like this one).
  • scripts/: This directory houses the scripts used by this repository, primarily as part of the CI/CD checks.
  • tests_utils/: This directory houses the unit tests for the utilities provided by this repository. You may want to copy these over if you want to ensure utilities are behaving as expected.
  • .editorconfig, .gitattributes, .gitignore, .gitleaks.toml, .gitleaksignore: These files are configuration for git, and quality and security checks provided via the CI/CD checks.
  • Makefile: This file is used to import some of the scripts for CI/CD checks, but can be customised per project if needed. The template this project is based from provides a more comprehensive example here.