org.opengis.cite.ogcapiedr10.conformance.ApiDefinition Maven / Gradle / Ivy

Go to download
package org.opengis.cite.ogcapiedr10.conformance;

import static io.restassured.http.ContentType.JSON;
import static io.restassured.http.Method.GET;
import static org.opengis.cite.ogcapiedr10.EtsAssert.assertTrue;
import static org.opengis.cite.ogcapiedr10.OgcApiEdr10.OPEN_API_MIME_TYPE;
import static org.opengis.cite.ogcapiedr10.SuiteAttribute.API_MODEL;

import java.net.MalformedURLException;
import java.net.URI;

import org.opengis.cite.ogcapiedr10.CommonFixture;
import org.opengis.cite.ogcapiedr10.SuiteAttribute;
import org.opengis.cite.ogcapiedr10.openapi3.OpenApiUtils;
import org.opengis.cite.ogcapiedr10.util.Link;
import org.testng.ITestContext;
import org.testng.SkipException;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Test;

import com.reprezen.kaizen.oasparser.model3.OpenApi3;
import com.reprezen.kaizen.oasparser.val.ValidationResults;

import io.restassured.path.json.JsonPath;
import io.restassured.response.Response;

/**
 * A.2.3. API Definition Path {root}/api (link)
 *
 * @author Lyn Goltz 
 */
public class ApiDefinition extends CommonFixture {

	private String response;

	private Link apiUrl = null;

	@BeforeClass(dependsOnMethods = "initCommonFixture")
	public void retrieveApiUrl() {
		Response request = init().baseUri(rootUri.toString()).accept(JSON).when().request(GET);
		JsonPath jsonPath = request.jsonPath();

		this.apiUrl = OpenApiUtils.parseApiUrl(jsonPath);
	}

	/**
	 * 	 * Abstract Test 4: Test Purpose: Validate that the API Definition document can be retrieved from the expected location.
	 * 
	 */
	@Test(description = "Implements Abstract Test 4 (/conf/core/api-definition)", groups = "apidefinition",
			dependsOnGroups = "landingpage")
	public void openapiDocumentRetrieval() {

		if (apiUrl == null || apiUrl.getHref().isEmpty())
			throw new AssertionError("Path to the API Definition could not be constructed from the landing page");
		Response request = init().baseUri(apiUrl.getHref()).accept(apiUrl.getType()).when().request(GET);
		request.then().statusCode(200);
		response = request.asString();
	}

	/**
	 * 	 * Abstract Test 5: Validate that the API Definition complies with the required structure and contents.
	 * 
	 * @param testContext never null
	 * @throws MalformedURLException if the apiUrl is malformed
	 */
	@Test(description = "Implements Abstract Test 5 (/conf/core/api-definition-success)", groups = "apidefinition",
			dependsOnMethods = "openapiDocumentRetrieval")
	public void apiDefinitionValidation(ITestContext testContext) throws MalformedURLException {

		OpenApi3 apiModel = (OpenApi3) testContext.getSuite().getAttribute(API_MODEL.getName());

		if (apiModel == null) {
			URI apiDefinitionLocation = (URI) testContext.getSuite()
				.getAttribute(SuiteAttribute.API_DEFINITION.getName());
			throw new AssertionError("Could not create API model from URI: " + apiDefinitionLocation);
		}

		if (apiModel.isValid() && (!apiUrl.getType().equals(OPEN_API_MIME_TYPE))) {
			throw new SkipException(
					"The API Definition was found to be valid. However, the Media Type identified by the Link to the API Definition document was not "
							+ OPEN_API_MIME_TYPE);
		}

		assertTrue(apiModel.isValid(), createValidationMsg(apiModel));

	}

	private String createValidationMsg(OpenApi3 model) {
		StringBuilder sb = new StringBuilder();
		sb.append("API definition is not valid. Found following validation items:");
		if (!model.isValid()) {
			for (ValidationResults.ValidationItem item : model.getValidationItems()) {
				sb.append("  @ ")
					.append(item.getPositionInfo())
					.append("  - ")
					.append(item.getSeverity())
					.append(": ")
					.append(item.getMsg());

			}
		}
		return sb.toString();
	}

}