README.md

Azure core test client library for Java

Library containing core classes used to test Azure SDK client libraries.

• Create live or playback JUnit tests using TestBase and leveraging InterceptorManager to keep track of network calls.
• Record network calls using using pipeline policy, RecordNetworkCallPolicy.
• Playback test session records with PlaybackClient.

Getting started

To use this package, add the following to your pom.xml.

<dependency>
  <groupId>com.azure</groupId>
  <artifactId>azure-core-test</artifactId>
  <version>1.0.0-preview.1</version>
</dependency>

Key concepts

• TestBase: Base test class that creates an InterceptorManager for each unit test and either plays back test session data or records the test session. Each session's file name is determined using the name of the test.
• InterceptorManager: Main class used to record and playback NetworkCallRecords.

Examples

Create a test class to run live or playback tests

Use TestBase to easily create live and playback test cases. Extending from TestBase provides an interceptorManager that keeps track of all network calls.

// Set the AZURE_TEST_MODE environment variable to either PLAYBACK or RECORD to determine if tests are playback or
// live. By default, tests are run in playback mode.
public class SessionTests extends TestBase {
    @Test
    public void fooTest() {
        // Do some network calls.
    }
}

Record network calls

Record network calls using RecordNetworkCallPolicy. Each HTTP request sent from the test client, is persisted to RecordedData.

public class Foo {
    public void recordNetworkCalls() {
        // All network calls are kept in the networkData variable.
        RecordedData networkData = new RecordedData();
        HttpPipeline pipeline = new HttpPipeline(new RecordNetworkCallPolicy(recordedData));
    
        // Send requests through the HttpPipeline.
        pipeline.send(new HttpRequest(HttpMethod.GET, "http://bing.com"));
    
        // Get a record that was sent through the pipeline.
        NetworkCallRecord networkCall = networkData.findFirstAndRemoveNetworkCall(record -> {
            return record.uri().equals("http://bing.com");
        });
    }
}

Playback session records

Playback test session records by creating a RecordedData.

public class Foo {
    public void playbackNetworkCalls() {
        RecordedData recordedData = new RecordedData();
    
        // Add some network calls to be replayed by playbackClient
    
        // Creates a HTTP client that plays back responses in recordedData.
        HttpClient playbackClient = new PlaybackClient(recordedData, null);
    
        // Send an HTTP GET request to http://bing.com. If recordedData contains a NetworkCallRecord with a matching HTTP
        // method and matching URL, it is returned as a response.
        Mono<HttpResponse> response = playbackClient.send(new HttpRequest(HttpMethod.GET, "http://bing.com"));
    }
}

Troubleshooting

If you encounter any bugs with these SDKs, please file issues via Issues or checkout StackOverflow for Azure Java SDK.

Next steps

Other useful packages are:

• azure-core: Contains core classes and functionality used by all client libraries.

Contributing

If you would like to become an active contributor to this project please follow the instructions provided in Microsoft Azure Projects Contribution Guidelines.

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request