github/azure-sdk-for-cpp
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Sync eng/common directory with azure-sdk-tools repository (#72)

Browse Source
This commit is contained in:
Azure SDK Bot 2020-04-14 13:33:32 -07:00 committed by GitHub
parent 3370f252d3
commit 110110a43f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
eng/common/TestResources/README.md
View File

@ -1,7 +1,7 @@
# Live Test Resource Management
Running and recording live tests often requires first creating some resources
in Azure. Service directories that include a test-resources.yml file require
in Azure. Service directories that include a test-resources.json file require
running [New-TestResources.ps1][] to create these resources and output
environment variables you must set.
@ -11,6 +11,11 @@ scenarios as well as on hosted agents for continuous integration testing.
* [New-TestResources.ps1][] - Creates new test resources for a given service.
* [Remove-TestResources.ps1][] - Deletes previously created resources.
## Prerequisites
1. Install [PowerShell][] version 7.0 or newer.
2. Install the [Azure PowerShell][PowerShellAz].
## On the Desktop
To set up your Azure account to run live tests, you'll need to log into Azure,
@ -68,13 +73,20 @@ setx AZURE_SEARCH_STORAGE_KEY $env:AZURE_SEARCH_STORAGE_KEY
```
After running or recording live tests, if you do not plan on further testing
you can remove the test resources you created above by running
you can remove the test resources you created above by running:
[Remove-TestResources.ps1][]:
```powershell
Remove-TestResources.ps1 -BaseName 'myusername' -Force
```
If you created a new service principal as shown above, you might also remove it:
```powershell
Remove-AzADServicePrincipal -ApplicationId $sp.ApplicationId -Force
```
If you persisted environment variables, you should also remove those as well.
## In CI
@ -109,4 +121,6 @@ PowerShell markdown documentation created with [platyPS][].
[New-TestResources.ps1]: ./New-TestResources.ps1.md
[Remove-TestResources.ps1]: ./Remove-TestResources.ps1.md
[PowerShell]: https://github.com/PowerShell/PowerShell
[PowerShellAz]: https://docs.microsoft.com/powershell/azure/install-az-ps
[platyPS]: https://github.com/PowerShell/platyPS