public async Task CreateListUpdateDelete()
{
Environment.SetEnvironmentVariable("AZURE_TEST_MODE", "Playback");
using (MockContext context = MockContext.Start(this.GetType().FullName))
{
var testBase = new ApiManagementTestBase(context);
testBase.TryCreateApiManagementService();
// add new api
const string swaggerPath = "./Resources/SwaggerPetStoreV2.json";
const string path = "swaggerApi";
string newApiId = TestUtilities.GenerateName("apiid");
string newReleaseId = TestUtilities.GenerateName("apireleaseid");
try
{
// import API
string swaggerApiContent;
using (StreamReader reader = File.OpenText(swaggerPath))
{
swaggerApiContent = reader.ReadToEnd();
}
var apiCreateOrUpdate = new ApiCreateOrUpdateParameter()
{
Path = path,
Format = ContentFormat.SwaggerJson,
Value = swaggerApiContent
};
var swaggerApiResponse = testBase.client.Api.CreateOrUpdate(
testBase.rgName,
testBase.serviceName,
newApiId,
apiCreateOrUpdate);
Assert.NotNull(swaggerApiResponse);
// get new api to check it was added
var petstoreApiContract = testBase.client.Api.Get(testBase.rgName, testBase.serviceName, newApiId);
Assert.NotNull(petstoreApiContract);
Assert.Equal(path, petstoreApiContract.Path);
Assert.Equal("Swagger Petstore Extensive", petstoreApiContract.DisplayName);
Assert.Equal("http://petstore.swagger.wordnik.com/api", petstoreApiContract.ServiceUrl);
// test the number of operations it has
var petstoreApiOperations = testBase.client.ApiOperation.ListByApi(
testBase.rgName,
testBase.serviceName,
newApiId);
Assert.NotNull(petstoreApiOperations);
Assert.NotEmpty(petstoreApiOperations);
// get the API Entity Tag
ApiGetEntityTagHeaders apiTag = testBase.client.Api.GetEntityTag(
testBase.rgName,
testBase.serviceName,
newApiId);
Assert.NotNull(apiTag);
Assert.NotNull(apiTag.ETag);
// add an api revision
string revisionNumber = "2";
// create a revision of Petstore.
// Please note we can change the following properties when creating a revision
// DisplayName, Description, Path, Protocols, ApiVersion, ApiVersionDescription and ApiVersionSetId
var revisionDescription = "Petstore second revision";
var petstoreRevisionContract = new ApiCreateOrUpdateParameter()
{
Path = petstoreApiContract.Path,
DisplayName = petstoreApiContract.DisplayName,
ServiceUrl = petstoreApiContract.ServiceUrl + revisionNumber,
Protocols = petstoreApiContract.Protocols,
SubscriptionKeyParameterNames = petstoreApiContract.SubscriptionKeyParameterNames,
AuthenticationSettings = petstoreApiContract.AuthenticationSettings,
Description = petstoreApiContract.Description,
ApiRevisionDescription = revisionDescription,
IsCurrent = false,
SourceApiId = petstoreApiContract.Id // with this we ensure to copy all operations, tags, product association.
};
var petStoreSecondRevision = await testBase.client.Api.CreateOrUpdateAsync(
testBase.rgName,
testBase.serviceName,
newApiId.ApiRevisionIdentifier(revisionNumber),
petstoreRevisionContract);
Assert.NotNull(petStoreSecondRevision);
Assert.Equal(petstoreApiContract.Path, petStoreSecondRevision.Path);
Assert.Equal(petstoreRevisionContract.ServiceUrl, petStoreSecondRevision.ServiceUrl);
Assert.Equal(revisionNumber, petStoreSecondRevision.ApiRevision);
Assert.Equal(petstoreApiContract.DisplayName, petStoreSecondRevision.DisplayName);
Assert.Equal(petstoreApiContract.Description, petStoreSecondRevision.Description);
Assert.Equal(revisionDescription, petStoreSecondRevision.ApiRevisionDescription);
// add an operation to this revision
var newOperationId = TestUtilities.GenerateName("firstOpRev");
var firstOperationContract = testBase.CreateOperationContract("POST");
var firstOperation = await testBase.client.ApiOperation.CreateOrUpdateAsync(
testBase.rgName,
testBase.serviceName,
newApiId.ApiRevisionIdentifier(revisionNumber),
newOperationId,
firstOperationContract);
Assert.NotNull(firstOperation);
Assert.Equal("POST", firstOperation.Method);
// now test out list operation on the revision api
var allRevisionOperations = await testBase.client.ApiOperation.ListByApiAsync(
testBase.rgName,
testBase.serviceName,
newApiId.ApiRevisionIdentifier(revisionNumber));
Assert.NotNull(allRevisionOperations);
// we copied the revision and added an extra "POST" operation to second revision
Assert.Equal(allRevisionOperations.Count(), petstoreApiOperations.Count() + 1);
// now test out list operation on the revision api
var firstOperationOfSecondRevision = await testBase.client.ApiOperation.ListByApiAsync(
testBase.rgName,
testBase.serviceName,
newApiId.ApiRevisionIdentifier(revisionNumber),
new Microsoft.Rest.Azure.OData.ODataQuery <OperationContract>
{
Top = 1
});
Assert.NotNull(firstOperationOfSecondRevision);
Assert.Single(firstOperationOfSecondRevision);
Assert.NotEmpty(firstOperationOfSecondRevision.NextPageLink);
// now test whether the next page link works
var secondOperationOfSecondRevision = await testBase.client.ApiOperation.ListByApiNextAsync(
firstOperationOfSecondRevision.NextPageLink);
Assert.NotNull(secondOperationOfSecondRevision);
Assert.Single(secondOperationOfSecondRevision);
Assert.NotEmpty(secondOperationOfSecondRevision.NextPageLink);
// list apiRevision
IPage <ApiRevisionContract> apiRevisions = await testBase.client.ApiRevision.ListByServiceAsync(
testBase.rgName,
testBase.serviceName,
newApiId);
Assert.NotNull(apiRevisions);
Assert.Equal(2, apiRevisions.GetEnumerator().ToIEnumerable <ApiRevisionContract>().Count());
Assert.NotEmpty(apiRevisions.GetEnumerator().ToIEnumerable().Single(d => d.ApiRevision.Equals(revisionNumber)).ApiRevision);
Assert.Single(apiRevisions.GetEnumerator().ToIEnumerable().Where(a => a.IsCurrent.HasValue && a.IsCurrent.Value)); // there is only one revision which is current
// get the etag of the revision
var apiSecondRevisionTag = await testBase.client.Api.GetEntityTagAsync(
testBase.rgName,
testBase.serviceName,
newApiId.ApiRevisionIdentifier(revisionNumber));
var apiOnlineRevisionTag = await testBase.client.Api.GetEntityTagAsync(
testBase.rgName,
testBase.serviceName,
newApiId);
Assert.NotNull(apiSecondRevisionTag);
Assert.NotNull(apiOnlineRevisionTag);
Assert.NotEqual(apiOnlineRevisionTag.ETag, apiSecondRevisionTag.ETag);
//there should be no release intially
var apiReleases = await testBase.client.ApiRelease.ListByServiceAsync(
testBase.rgName,
testBase.serviceName,
newApiId);
Assert.Empty(apiReleases);
// lets create a release now and make the second revision as current
var apiReleaseContract = new ApiReleaseContract()
{
ApiId = newApiId.ApiRevisionIdentifierFullPath(revisionNumber),
Notes = TestUtilities.GenerateName("revision_description")
};
var newapiBackendRelease = await testBase.client.ApiRelease.CreateOrUpdateAsync(
testBase.rgName,
testBase.serviceName,
newApiId,
newReleaseId,
apiReleaseContract);
Assert.NotNull(newapiBackendRelease);
Assert.Equal(newReleaseId, newapiBackendRelease.Name);
Assert.Equal(apiReleaseContract.Notes, newapiBackendRelease.Notes);
// get the release eta
var releaseTag = await testBase.client.ApiRelease.GetEntityTagAsync(
testBase.rgName,
testBase.serviceName,
newApiId,
newReleaseId);
Assert.NotNull(releaseTag);
// update the release details
apiReleaseContract.Notes = TestUtilities.GenerateName("update_desc");
await testBase.client.ApiRelease.UpdateAsync(
testBase.rgName,
testBase.serviceName,
newApiId,
newReleaseId,
apiReleaseContract,
releaseTag.ETag);
// get the release detaild
newapiBackendRelease = await testBase.client.ApiRelease.GetAsync(
testBase.rgName,
testBase.serviceName,
newApiId,
newReleaseId);
Assert.NotNull(newapiBackendRelease);
Assert.Equal(newapiBackendRelease.Notes, apiReleaseContract.Notes);
// list the revision
apiReleases = await testBase.client.ApiRelease.ListByServiceAsync(
testBase.rgName,
testBase.serviceName,
newApiId);
Assert.NotNull(apiReleases);
Assert.Single(apiReleases);
// find the revision which is not online
var revisions = await testBase.client.ApiRevision.ListByServiceAsync(
testBase.rgName,
testBase.serviceName,
newApiId,
new Microsoft.Rest.Azure.OData.ODataQuery <ApiRevisionContract> {
Top = 1
});
Assert.NotNull(revisions);
Assert.Single(revisions);
// delete the api
await testBase.client.Api.DeleteAsync(
testBase.rgName,
testBase.serviceName,
newApiId,
"*",
deleteRevisions : true);
// get the deleted api to make sure it was deleted
try
{
testBase.client.Api.Get(testBase.rgName, testBase.serviceName, newApiId);
throw new Exception("This code should not have been executed.");
}
catch (ErrorResponseException ex)
{
Assert.Equal(HttpStatusCode.NotFound, ex.Response.StatusCode);
}
}
finally
{
// delete authorization server
testBase.client.Api.Delete(
testBase.rgName,
testBase.serviceName,
newApiId,
"*",
deleteRevisions: true);
testBase.client.ApiRelease.Delete(
testBase.rgName,
testBase.serviceName,
newApiId,
newReleaseId,
"*");
}
}
}
/// <summary>
/// Updates the details of the release of the API specified by its identifier.
/// </summary>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='resourceGroupName'>
/// The name of the resource group.
/// </param>
/// <param name='serviceName'>
/// The name of the API Management service.
/// </param>
/// <param name='apiId'>
/// API identifier. Must be unique in the current API Management service
/// instance.
/// </param>
/// <param name='releaseId'>
/// Release identifier within an API. Must be unique in the current API
/// Management service instance.
/// </param>
/// <param name='parameters'>
/// API Release Update parameters.
/// </param>
/// <param name='ifMatch'>
/// ETag of the Entity. ETag should match the current entity state from the
/// header response of the GET request or it should be * for unconditional
/// update.
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task UpdateAsync(this IApiReleaseOperations operations, string resourceGroupName, string serviceName, string apiId, string releaseId, ApiReleaseContract parameters, string ifMatch, CancellationToken cancellationToken = default(CancellationToken))
{
(await operations.UpdateWithHttpMessagesAsync(resourceGroupName, serviceName, apiId, releaseId, parameters, ifMatch, null, cancellationToken).ConfigureAwait(false)).Dispose();
}
/// <summary>
/// Creates a new Release for the API.
/// </summary>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='resourceGroupName'>
/// The name of the resource group.
/// </param>
/// <param name='serviceName'>
/// The name of the API Management service.
/// </param>
/// <param name='apiId'>
/// API identifier. Must be unique in the current API Management service
/// instance.
/// </param>
/// <param name='releaseId'>
/// Release identifier within an API. Must be unique in the current API
/// Management service instance.
/// </param>
/// <param name='parameters'>
/// Create parameters.
/// </param>
/// <param name='ifMatch'>
/// ETag of the Entity. Not required when creating an entity, but required when
/// updating an entity.
/// </param>
/// <param name='cancellationToken'>
/// The cancellation token.
/// </param>
public static async Task <ApiReleaseContract> CreateOrUpdateAsync(this IApiReleaseOperations operations, string resourceGroupName, string serviceName, string apiId, string releaseId, ApiReleaseContract parameters, string ifMatch = default(string), CancellationToken cancellationToken = default(CancellationToken))
{
using (var _result = await operations.CreateOrUpdateWithHttpMessagesAsync(resourceGroupName, serviceName, apiId, releaseId, parameters, ifMatch, null, cancellationToken).ConfigureAwait(false))
{
return(_result.Body);
}
}
/// <summary>
/// Updates the details of the release of the API specified by its identifier.
/// </summary>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='resourceGroupName'>
/// The name of the resource group.
/// </param>
/// <param name='serviceName'>
/// The name of the API Management service.
/// </param>
/// <param name='apiId'>
/// API identifier. Must be unique in the current API Management service
/// instance.
/// </param>
/// <param name='releaseId'>
/// Release identifier within an API. Must be unique in the current API
/// Management service instance.
/// </param>
/// <param name='parameters'>
/// API Release Update parameters.
/// </param>
/// <param name='ifMatch'>
/// ETag of the Entity. ETag should match the current entity state from the
/// header response of the GET request or it should be * for unconditional
/// update.
/// </param>
public static void Update(this IApiReleaseOperations operations, string resourceGroupName, string serviceName, string apiId, string releaseId, ApiReleaseContract parameters, string ifMatch)
{
operations.UpdateAsync(resourceGroupName, serviceName, apiId, releaseId, parameters, ifMatch).GetAwaiter().GetResult();
}
/// <summary>
/// Creates a new Release for the API.
/// </summary>
/// <param name='operations'>
/// The operations group for this extension method.
/// </param>
/// <param name='resourceGroupName'>
/// The name of the resource group.
/// </param>
/// <param name='serviceName'>
/// The name of the API Management service.
/// </param>
/// <param name='apiId'>
/// API identifier. Must be unique in the current API Management service
/// instance.
/// </param>
/// <param name='releaseId'>
/// Release identifier within an API. Must be unique in the current API
/// Management service instance.
/// </param>
/// <param name='parameters'>
/// Create parameters.
/// </param>
/// <param name='ifMatch'>
/// ETag of the Entity. Not required when creating an entity, but required when
/// updating an entity.
/// </param>
public static ApiReleaseContract CreateOrUpdate(this IApiReleaseOperations operations, string resourceGroupName, string serviceName, string apiId, string releaseId, ApiReleaseContract parameters, string ifMatch = default(string))
{
return(operations.CreateOrUpdateAsync(resourceGroupName, serviceName, apiId, releaseId, parameters, ifMatch).GetAwaiter().GetResult());
}
