Bicep testing framework

This is a testing framework for Azure deployments using Bicep.

In order to see how you can work with this framework you can find one sample bicep file in the folder samples that will be deployed by using one PowerShell script.

An example of how to use this framework can be found in the Powershell Test Sample guide.

The process of the tests is the following:

flowchart LR

A[Creation] -->|Bicep| B[Verification]
B --> C[Remove]

Creation: New Features are deployed using Bicep files Verification: Tests confirm that the resource exists and that it matches the expected values Remove: Optionally, resources can be removed after being tested

Benchpress Architecture

BenchPress uses gRPC to create a multi-language testing framework.

The BenchPress Test Engine is a C# gRPC Server located under /engine/BenchPress.TestEngine. The Test Engine is responsible for the business logic of deploying Bicep files, obtaining information about deployed resources in Azure, and cleaning up the deployment afterward.

The BenchPress Test Frameworks (located under /framework/) are gRPC Clients of multiple languages. The Test Frameworks are responsible interfacing between the user's tests (written in their chosen language) and the Test Engine. They are also responsible for managing the life cycle of the Test Engine.

gRPC uses protocol buffers. The /protos/ folder contains BenchPress's .proto files. These define the API that the gRPC Server and Clients use to communicate.

Getting started

See Getting Started guide on how to start development on Benchpress.

Deveplopment Tips

See Github Actions Lint Workflow for how to maintain the CI/CD pipeline.

See Manually Testing the Test Engine for guidance on exploring the gRPC endpoints.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Trademarks

This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft's Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party's policies.