blazetest-beta 0.0.0.41

Blazetest is a CLI tool to run your selenium tests faster and more effectively.

Blazetest

Introduction

CLI tool which allows developers to deploy their pytest tests to AWS Lambda and run them in parallel.

It automates the deployment process and makes it easier to run tests on the number of Lambda function instances in an efficient and cost-effective manner.

CLI supports parallel execution of tests, as well as customizing the number of concurrent Lambda functions that can be used for your tests (up to 1000 unreserved concurrency).

Additionally, it provides real-time feedback on the progress of your tests, making it easy to know when the tests have finished running.

Whenever the testing have been finished, you can get your junit-xml reports in the S3 bucket, allowing you to easily integrate it with any CI/CD workflow.

Installation

In order to install the CLI, use pip:

pip install blazetest

Installation requires following packages to be installed:

click
pytest
PyYAML
toml
dacite
boto3
licensing
pyopenssl>=23.0.0; python_version >= '3.7'
python-logging-loki

Configuration

In order to configure the CLI, the TOML file is used. By default, blazetest uses blazetest.toml file located at the project root. However, any location can be used with specifying --config-path option while running CLI. Example:

blazetest --config-path /path/to/toml/file.toml -v -s

Here you can see the example blazetest.toml file:

license_key = "ASDSA-ASDSA-ASDSA-ASDSA" # optional, license key to use when using blazetest CLI
failed_test_retry = 1 # optional and given by special license, number of retries for failed tests

[aws]
region = "eu-west-1" # required, AWS region, which is used to deploy the application 
ecr_repository_name = "my-example-repository" # optional, ECR repository name, used to create ECR repository, where the Docker image with tests is deployed, otherwise "blazetest-repo" will be used
stack_name = "example-stack-name" # optional, CloudFormation stack name, which is used for deployment, will be part of the names of the created stacks, otherwise "blazetest-stack" will be used
s3_bucket = "example-bucket" # optional, S3 Bucket which will be used for deploying AWS Lambda, otherwise "blazetest-s3" will be used

[pytest]
collection_args = ["tests/module1", "-m", "feature1"] # these are the arguments which will be used to collect tests, such as the folder name /tests/module1/ and marker feature1
execution_args = ["-s", "-vv", "--durations=10"] # these are the arguments which will be used to execute the tests on Lambda, such as durations, -s for seeing output and verbosity

For pytest args, please see the usage examples in the pytest documentation: https://docs.pytest.org/en/6.2.x/usage.html.
You don't need to indicate --junitxml flag as it will be defined automatically.

To run the CLI tool, AWS credentials should be configured.

The CLI tool uses following AWS services:

AWS Lambda (creates and invokes Lambda)
AWS S3 (creates buckets and uploads files)
AWS ECR (creates repository and uses it for Lambda invocations)

Usage

In order to use the CLI tool, following format should be used:

blazetest [OPTIONS]

For example:

blazetest --config-path --license-key license-key-1234 /path/to/toml/file.toml

Available options:

--config-path: configuration file path, defaults to blazetest.toml file which is located at project root folder.
--license-key: license key, should be set if license-file not specified
--license-file: license file, should be set if license-key not specified
--aws-access-key-id: AWS access key ID
--aws-secret-access-key: AWS secret access key

Workflow

Whole workflow consists of five main parts: build, deployment, collecting tests, AWS Lambda parallel invocation, collecting results.

1. The Docker image is built, local project files copied to image. [1]
2. Image is deployed to ECR repository. AWS Lambda function, S3 bucket (for test reports) are created using Pulumi.
3. Tests are collected locally.
4. Each test invokes separate AWS Lambda function in parallel.
5. All test XML reports are saved to S3 bucket.

[1] - Local projects are collected at the root folder of the project. Every file and folder will be copied. If you don't want certain files to be deployed to Lambda, please include them in .dockerignore in the root directory

There is 1000 unreserved concurrency by default in AWS Lambda, so we can have 1000 AWS Lambda instances running at the same time by default. To gain more concurrent runs, you can:

1. Visit https://console.aws.amazon.com/servicequotas/home
2. Go to AWS Lambda -> Concurrent executions -> Request quota increase
3. For more information: https://docs.aws.amazon.com/servicequotas/latest/userguide/request-quota-increase.html

Selenium and WebDriver

To initialize webdriver, please use the indicated binary location and flags.

options = webdriver.ChromeOptions()

options.binary_location = "/usr/bin/chromium-1033/chrome-linux/chrome"

options.add_argument("--no-sandbox")
options.add_argument("--headless")
options.add_argument("--disable-dev-shm-usage")
options.add_argument("--single-process")

web_driver = webdriver.Chrome(options=options)

Above mentioned flags are required to have tests using selenium run smoothly on AWS Lambda instance.