Skip to content

Commit

Permalink
Updated README.
Browse files Browse the repository at this point in the history
  • Loading branch information
johncollinson2001 committed Sep 13, 2024
1 parent 7c8e89e commit 06295cc
Showing 1 changed file with 5 additions and 17 deletions.
22 changes: 5 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,23 +175,13 @@ Take the following steps to get started in configuring and verify the infrastruc

### Running the Tests

The test suite consists of a number Terraform HCL tests.
The test suite consists of a number Terraform HCL tests that use a mock azurerm provider.

[See this link for more information.](https://developer.hashicorp.com/terraform/language/tests)

Take the following steps to run the test suite:

1. Login to Azure

Use the Azure CLI to login to Azure by running the following command:

```pwsh
az login
```

> NOTE: You can skip this step if you've already logged in (e.g. by following the steps above in the [Getting Started](#getting-started) guide).
2. Initialise Terraform
1. Initialise Terraform

Change the working directory to `./tests`.

Expand All @@ -201,18 +191,16 @@ Take the following steps to run the test suite:
terraform init -backend=false
````

> NOTE: There's no need to initialise a backend for the purposes of running the tests).
> NOTE: There's no need to initialise a backend for the purposes of running the tests.
3. Run the Tests
2. Run the Tests

Run the tests with the following command:

````pwsh
terraform test
````

> NOTE: There's no need to initialise a backend for the purposes of running the tests).
### Contributing

If you want to contribute to the project, raise a PR on GitHub.
Expand All @@ -231,4 +219,4 @@ We use pre-commit to run analysis and checks on the changes being committed. Tak
* Install pre-commit within the repository with the following command: `pre-commit install`
* Run `pre-commit run --all-files` to check pre-commit is working

> For full details [see this link](https://pre-commit.com/#installation)
> For full details [see this link](https://pre-commit.com/#installation)

0 comments on commit 06295cc

Please sign in to comment.