org.opengis.cite.cat30.opensearch.OpenSearchDescriptionTests Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ets-cat30 Show documentation
Checks a catalogue service implementation for conformance to "OGC Catalogue Services 3.0 Specification -- HTTP Protocol Binding" (OGC 12-176r6) and related specifications.
The newest version!
package org.opengis.cite.cat30.opensearch;

import java.io.IOException;
import java.net.URI;
import java.net.URL;
import java.util.Set;
import java.util.logging.Level;

import javax.xml.namespace.QName;
import javax.xml.transform.Source;

import org.opengis.cite.cat30.CAT3;
import org.opengis.cite.cat30.CommonFixture;
import org.opengis.cite.cat30.ETSAssert;
import org.opengis.cite.cat30.ErrorMessage;
import org.opengis.cite.cat30.ErrorMessageKeys;
import org.opengis.cite.cat30.Namespaces;
import org.opengis.cite.cat30.util.CSWClient;
import org.opengis.cite.cat30.util.ClientUtils;
import org.opengis.cite.cat30.util.ServiceMetadataUtils;
import org.opengis.cite.cat30.util.TestSuiteLogger;
import org.opengis.cite.cat30.util.XMLUtils;
import org.opengis.cite.validation.RelaxNGValidator;
import org.opengis.cite.validation.ValidationErrorHandler;
import org.testng.Assert;
import org.testng.ITestContext;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Test;
import org.w3c.dom.Document;
import org.xml.sax.SAXException;

import jakarta.ws.rs.HttpMethod;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;

/**
 * Verifies the structure and content of the OpenSearch description document obtained from
 * the SUT. The document is obtained in response to a GET request submitted to the base
 * service endpoint where the Accept request header expresses a preference
 * for any of the following media types:
 *
 * 
 * application/vnd.a9.opensearchdescription+xml
 * application/opensearchdescription+xml
 * 
 *
 * 
 * Note: None of the media types listed above appear in the IANA
 * media type registry. Registrations in the standards tree must be approved
 * by the IESG or originate from a recognized standards-related organization (see
 * RFC 6838);
 * third-party registrations are allowed in the vendor tree.
 * 
 *
 * 
 * Sources
 * 
 * 
 * OGC 12-176r5, 6.4: Obtaining service metadata
 * OGC 12-176r5, 6.5.6: Enabling OpenSearch
 * OpenSearch description elements
 * 
 *
 */
public class OpenSearchDescriptionTests extends CommonFixture {

	private RelaxNGValidator osdValidator;

	private URI baseUri;

	private static final String SCHEMATRON_OPENSEARCH_DESCR = CommonFixture.ROOT_PKG_PATH + "sch/opensearch-1.1.sch";

	/** Constant OPENSEARCH_CONSTRAINT="OpenSearchDescriptionDocument" */
	public static final String OPENSEARCH_CONSTRAINT = "OpenSearchDescriptionDocument";

	/**
	 * Initializes the test fixture by:
	 * 
	 * building a Relax NG schema validator for an OpenSearch description document;
	 * the schema resource is located on the classpath at this location:
	 * /org/opengis/cite/cat30/rnc/osd-1.1-draft5.rnc
	 * extracting the base GetCapabilities URL (for the GET method binding) from the
	 * capabilities document
	 * 
	 * @param testContext The test context containing various suite attributes.
	 */
	@BeforeClass
	public void initFixture(ITestContext testContext) {
		URL rncSchema = getClass().getResource(CommonFixture.ROOT_PKG_PATH + "rnc/osd-1.1-draft5.rnc");
		try {
			this.osdValidator = new RelaxNGValidator(rncSchema);
		}
		catch (SAXException | IOException ex) {
			TestSuiteLogger.log(Level.WARNING, getClass().getName(), ex);
		}
		this.baseUri = ServiceMetadataUtils.getOperationEndpoint(this.cswCapabilities, CAT3.GET_CAPABILITIES,
				HttpMethod.GET);
	}

	/**
	 * [Test] Requests an OpenSearch description document as the most preferred media
	 * type. The generic XML media type is included in the Accept header with a q
	 * parameter value < 1:
	 *
	 * Accept: application/xml; q=0.5, application/opensearchdescription+xml
	 */
	@Test(description = "Requirements: 008; Tests: 008")
	public void preferOpenSearchDescription() {
		String xmlNotPreferred = MediaType.APPLICATION_XML + "; q=0.5";
		response = ClientUtils.buildGetRequest(this.baseUri, null, MediaType.valueOf(xmlNotPreferred),
				MediaType.valueOf(CAT3.APP_OPENSEARCH_XML));
		Assert.assertEquals(response.getStatus(), Response.Status.OK.getStatusCode(),
				ErrorMessage.get(ErrorMessageKeys.UNEXPECTED_STATUS));
		Assert.assertTrue(XMLUtils.isXML(response.getMediaType()),
				ErrorMessage.format(ErrorMessageKeys.NOT_XML, response.getMediaType()));
		Document entity = ClientUtils.getResponseEntityAsDocument(response, null);
		QName osdDocElemName = new QName(Namespaces.OSD11, "OpenSearchDescription");
		ETSAssert.assertQualifiedName(entity.getDocumentElement(), osdDocElemName);
	}

	/**
	 * [Test] Validates the OpenSearch description document obtained from the IUT. The
	 * document is checked against the constraints in the OpenSearch 1.1 draft 5
	 * specification.
	 * @throws org.xml.sax.SAXException If the document cannot be read.
	 * @throws java.io.IOException If an I/O error occurs while trying to access the
	 * document.
	 * @see "[CAT-HTTP], 6.5.6.5: Requirements for an OpenSearch enabled CSW"
	 */
	@Test(description = "Requirements: 021; Tests: 021")
	public void validOpenSearchDescription() throws SAXException, IOException {
		response = ClientUtils.buildGetRequest(this.baseUri, null, MediaType.valueOf(CAT3.APP_VND_OPENSEARCH_XML),
				MediaType.valueOf(CAT3.APP_OPENSEARCH_XML));
		Assert.assertTrue(XMLUtils.isXML(response.getMediaType()),
				ErrorMessage.format(ErrorMessageKeys.NOT_XML, response.getMediaType()));
		Source entity = ClientUtils.getResponseEntityAsSource(response, null);
		this.osdValidator.validate(entity);
		ValidationErrorHandler err = osdValidator.getErrorHandler();
		Assert.assertFalse(err.errorsDetected(),
				ErrorMessage.format(ErrorMessageKeys.NOT_SCHEMA_VALID, err.getErrorCount(), err.toString()));
		URL schemaUrl = getClass().getResource(SCHEMATRON_OPENSEARCH_DESCR);
		ETSAssert.assertSchematronValid(schemaUrl, entity);
	}

	/**
	 * [Test] Attempts to retrieve an OpenSearch description document using the URI
	 * presented in the capabilities document as the value of the
	 * {@value #OPENSEARCH_CONSTRAINT} constraint.
	 *
	 * @see "[CAT-HTTP], 6.5.6.2, Table 16"
	 */
	@Test(description = "[CAT-HTTP]: 6.5.6.2, Table 16")
	public void getOpenSearchDescriptionFromCapabilities() {
		URI getCapabilitiesEndpoint = ServiceMetadataUtils.getOperationEndpoint(this.cswCapabilities,
				CAT3.GET_CAPABILITIES, HttpMethod.GET);
		CSWClient cswClient = new CSWClient();
		Document capabilitiesDoc = cswClient.getCapabilities(getCapabilitiesEndpoint);
		Assert.assertNotNull(capabilitiesDoc,
				"Failed to retrieve capabilities document as 'application/xml' from " + getCapabilitiesEndpoint);
		Set values = ServiceMetadataUtils.getConstraintValues(capabilitiesDoc, OPENSEARCH_CONSTRAINT);
		if (null == values || values.isEmpty()) {
			throw new AssertionError(ErrorMessage.format(ErrorMessageKeys.NAMED_ITEM_NOT_FOUND, OPENSEARCH_CONSTRAINT));
		}
		URI uri = URI.create(values.iterator().next());
		response = ClientUtils.buildGetRequest(uri, null, MediaType.valueOf(CAT3.APP_VND_OPENSEARCH_XML),
				MediaType.valueOf(CAT3.APP_OPENSEARCH_XML));
		Assert.assertEquals(response.getStatus(), Response.Status.OK.getStatusCode(),
				ErrorMessage.get(ErrorMessageKeys.UNEXPECTED_STATUS));
		Assert.assertTrue(XMLUtils.isXML(response.getMediaType()),
				ErrorMessage.format(ErrorMessageKeys.NOT_XML, response.getMediaType()));
		Document entity = ClientUtils.getResponseEntityAsDocument(response, null);
		QName osdDocElemName = new QName(Namespaces.OSD11, "OpenSearchDescription");
		ETSAssert.assertQualifiedName(entity.getDocumentElement(), osdDocElemName);
	}

}