Add Custom Annotation to Parameterize Tests with more Complex Scenarios

[alzimmermsft]

Fixes #21171

This PR adds the AzureTestMethod and TestingServiceVersions annotations which allows for configuring a test class and test method to be parameterized by the following:

• Ability to parameterize a test by HttpClient.
• Ability to parameterize a test by ServiceVersion.
• Ability to parameterize a test by test value.
• Ability to parameterize a test by combining any of the above.

TestingServiceVersions is a class level annotation which configures all ServiceVersions that tests methods annotated by AzureTestMethod could be ran against. AzureTestMethod also provides the ability to set a minimum ServiceVersion to run against, used in cases for when new feature functionality is added. TestingServiceVersions only applies when running in TestMode.LIVE as TestMode.PLAYBACK and TestMode.RECORD only support a single ServiceVersion.

The following are example:

This is the ServiceVersion class:

public enum ExampleServiceVersion implements ServiceVersion {
    V1("V1"),
    V2("V2");

    private final String version;

    ExampleServiceVersion(String version) {
        this.version = version;
    }

    @Override
    public String getVersion() {
        return this.version;
    }

    public static ExampleServiceVersion getLatest() {
        return V2;
    }
}

Test that supports all ServiceVersions

@ParameterizedTest
@AzureMethoudSource(serviceVersionType = ExampleServiceVersion.class)
public void testAllServiceVersions(ExampleServiceVersion exampleServiceVersion) {
  // Test code
}

This will run two tests using service versions V1 and V2.

Test that only supports certain SeviceVersions

@ParameterizedTest
@AzureMethoudSource(serviceVersionType = ExampleServiceVersion.class, minimumServiceVersion = "V2")
public void testSomeServiceVersions(ExampleServiceVersion exampleServiceVersion) {
  // Test code
}

This will only run against service version V2.

[check-enforcer]

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run java - [service] - ci

[srnagar]

LGTM!