Skip to content

Commit f977fcc

Browse files
committed
docs: Add Testing section
Signed-off-by: Qasim Sarfraz <qasimsarfraz@microsoft.com>
1 parent 576905e commit f977fcc

1 file changed

Lines changed: 29 additions & 0 deletions

File tree

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -123,6 +123,35 @@ roles e.g Contributor, you should have the above permissions. However, if you ar
123123
using [custom roles](https://learn.microsoft.com/en-us/azure/role-based-access-control/custom-roles-portal) for a
124124
service principal, you need to make sure that the permissions are granted.
125125
126+
## Testing
127+
128+
### integration tests
129+
130+
The integration test needs an AKS cluster to run against. You can create one and use following command to run the integration test:
131+
132+
```
133+
make integration-test
134+
```
135+
136+
You will need to set `AZURE_RESOURCE_GROUP` and `AZURE_CLUSTER_NAME` environment variables to specify the AKS cluster to run against.
137+
138+
### documentation tests
139+
140+
The documentation tests are used to validate the documentation examples. You can run the documentation tests with the following command:
141+
142+
```
143+
make documentation-test
144+
```
145+
146+
or
147+
148+
```
149+
DOCUMENTATION_TEST_FILES=README.md make documentation-test -o install
150+
```
151+
152+
An INI file with all the required variables needs to be created to run the documentation tests. A sample INI file for [docs/run-command.md](docs/run-command.md)
153+
is available [here](docs/run-command.ini.sample).
154+
126155
## Contributing
127156
128157
This project welcomes contributions and suggestions. Most contributions require

0 commit comments

Comments
 (0)