Skip to content

Commit d3ede3b

Browse files
authored
Update CONTRIBUTING.md (Azure#36200)
* Update CONTRIBUTING.md Update recordings instructions * Update CONTRIBUTING.md Add Live mode variables
1 parent f1968a0 commit d3ede3b

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

sdk/communication/CONTRIBUTING.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,12 @@ Because in LIVE mode we are hitting an actual resource, we must set the appropri
3030

3131
Depending on which package you are testing, it may need special environment variables to test successfully. All packages have a *TestBase.java file inside their corresponding test folder and each one of these contain the special environment variables the tests need in order to run. Make sure to set these variables before running the tests themselves. You may need to restart your development environment after creating or updating these environment variables.
3232

33-
You can run the `mvn verify` command after setting the `AZURE_TEST_MODE` variable to `LIVE`.
33+
You can run the `mvn verify` command after setting the `AZURE_TEST_MODE` variable to `LIVE`. You will also need to set the `AZURE_TEST_RUN_lIVE` variable to `true`.
3434

3535
### Record mode
3636

37-
RECORD mode is similar to LIVE mode because it also hits an actual resource. In addition to hitting the resource, RECORD mode will also record the successful calls to the service in json format. As mentioned, the recordings are stored in the package root folder under `target/test-classes/session-records`.
38-
39-
These newly generated files will have to be copied to the previously mentioned `resources/session-records` after completion to make sure the PLAYBACK tests run with an updated version of the calls we made. Make sure to change the name of the recording files to match the names of the ones that are already in the `resources/session-records` folder.
37+
RECORD mode is similar to LIVE mode because it also hits an actual resource. In addition to hitting the resource, RECORD mode will also record the successful calls to the service in json format.
38+
To update and run the recordings follow this guide [Azure Core Test shared library for Java](https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/core/azure-core-test/README.md#run-and-record-tests)
4039

4140
If you would like to generate new recordings for a single test, setting `AZURE_TEST_MODE` to `RECORD`, reopen Visual Studio, and run the test in Visual Studio normally.
4241
### Managed Identity Tests

0 commit comments

Comments
 (0)