org.opengis.cite.iso19142.simple.StoredQueryTests Maven / Gradle / Ivy
package org.opengis.cite.iso19142.simple;
import com.sun.jersey.api.client.ClientResponse;
import java.net.URI;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import javax.xml.namespace.QName;
import javax.xml.transform.dom.DOMResult;
import javax.xml.transform.dom.DOMSource;
import javax.xml.validation.Schema;
import javax.xml.xpath.XPathExpressionException;
import org.opengis.cite.iso19142.ConformanceClass;
import org.opengis.cite.iso19142.ErrorMessage;
import org.opengis.cite.iso19142.ErrorMessageKeys;
import org.opengis.cite.iso19142.BaseFixture;
import org.opengis.cite.iso19142.Namespaces;
import org.opengis.cite.iso19142.ProtocolBinding;
import org.opengis.cite.iso19142.SuiteAttribute;
import org.opengis.cite.iso19142.WFS2;
import org.opengis.cite.iso19142.util.XMLUtils;
import org.opengis.cite.iso19142.util.ServiceMetadataUtils;
import org.opengis.cite.iso19142.util.ValidationUtils;
import org.opengis.cite.iso19142.util.WFSRequest;
import org.opengis.cite.validation.SchematronValidator;
import org.testng.Assert;
import org.testng.ITestContext;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Parameters;
import org.testng.annotations.Test;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.NodeList;
/**
* Tests the service response to a GetFeature request that invokes a stored
* query. A WFS implementation is required to support stored queries at this
* conformance level.
*
*
* Sources
*
*
* - ISO 19142:2010, cl. A.1.1: Simple WFS
* - ISO 19142:2010, cl. 11: GetFeature operation
* - ISO 19142:2010, cl. 7.9.3: Stored query expression
*
*
*/
public class StoredQueryTests extends BaseFixture {
private String featureId;
private Schema wfsSchema;
/**
* Initializes the test class fixture. The (pre-compiled) WFS schema and the
* 'fid' parameter are retrieved from the test run context.
*
* @param fid
* A String that identifies an available feature instance (gml:id
* attribute).
* @param testContext
* The test run context.
*/
@BeforeClass
@Parameters("fid")
public void initClassFixture(String fid, ITestContext testContext) {
this.featureId = fid;
this.wfsSchema = (Schema) testContext.getSuite().getAttribute(
SuiteAttribute.WFS_SCHEMA.getName());
Assert.assertNotNull(this.wfsSchema,
"WFS schema not found in suite fixture.");
}
/**
* Builds a DOM Document representing a GetFeature request entity that
* contains no query expressions.
*/
@BeforeMethod
public void buildGetFeatureRequestEntity() {
this.reqEntity = WFSRequest.createRequestEntity("GetFeature");
}
/**
* [{@code Test}] If no stored query matches the given identifier then an
* exception report with exception code "InvalidParameterValue" is expected.
*
* @param binding
* The ProtocolBinding to use.
*
* @see "ISO 19142:2010, cl. 7.9.3.4: Stored query identifier"
*/
@Test(description = "See ISO 19142: 7.9.3.4", dataProvider = "protocol-binding")
public void unknownStoredQuery(ProtocolBinding binding) {
WFSRequest.appendStoredQuery(this.reqEntity,
"http://docbook.org/ns/docbook",
Collections. emptyMap());
URI endpoint = ServiceMetadataUtils.getOperationEndpoint(
this.wfsMetadata, WFS2.GET_FEATURE, binding);
ClientResponse rsp = wfsClient.submitRequest(new DOMSource(
this.reqEntity), binding, endpoint);
this.rspEntity = extractBodyAsDocument(rsp, binding);
Assert.assertTrue(rsp.hasEntity(),
ErrorMessage.get(ErrorMessageKeys.MISSING_XML_ENTITY));
SchematronValidator validator = ValidationUtils
.buildSchematronValidator("ExceptionReport.sch",
"InvalidParameterValuePhase");
DOMResult result = validator.validate(new DOMSource(this.rspEntity));
Assert.assertFalse(validator.ruleViolationsDetected(), ErrorMessage
.format(ErrorMessageKeys.NOT_SCHEMA_VALID,
validator.getRuleViolationCount(),
XMLUtils.writeNodeToString(result.getNode())));
}
/**
* [{@code Test}] Invoking the {@code GetFeatureById} query with an
* {@code id} parameter value that does not match any feature should produce
* an error response with status code 404 (Not Found) or 403 (Forbidden).
*
* Clause 11.4 stipulates that "In the event that a web feature service
* encounters an error processing a GetFeature request, it shall raise an
* OperationProcessingFailed exception as described in 7.5." In Table D.2
* this exception code is mapped to status code 403 for some reason.
*
* @param binding
* The ProtocolBinding to use.
*
* @see "ISO 19142:2010, cl. 7.9.3.6: GetFeatureById stored query"
*/
@Test(description = "See ISO 19142: 7.9.3.6, 11.4", dataProvider = "protocol-binding")
public void invokeGetFeatureByIdWithUnknownID(ProtocolBinding binding) {
String id = "uuid-" + UUID.randomUUID().toString();
WFSRequest.appendStoredQuery(this.reqEntity,
WFS2.QRY_GET_FEATURE_BY_ID,
Collections.singletonMap("id", (Object) id));
URI endpoint = ServiceMetadataUtils.getOperationEndpoint(
this.wfsMetadata, WFS2.GET_FEATURE, binding);
ClientResponse rsp = wfsClient.submitRequest(new DOMSource(
this.reqEntity), binding, endpoint);
this.rspEntity = extractBodyAsDocument(rsp, binding);
int statusCode = rsp.getStatus();
Assert.assertTrue(
statusCode == ClientResponse.Status.NOT_FOUND.getStatusCode()
|| statusCode == ClientResponse.Status.FORBIDDEN
.getStatusCode(),
"Expected status code 403 or 404. Received: " + statusCode);
}
/**
* [{@code Test}] Invoking the {@code GetFeatureById} query with a known
* feature identifier shall produce the matching feature representation
* (@gml:id) as the response entity. If there is no matching feature, an
* error response with a status code 404 (Not Found) is expected.
*
* @param binding
* The ProtocolBinding to use.
*
* @see "ISO 19142:2010, cl. 7.9.3.6: GetFeatureById stored query"
*/
@Test(description = "See ISO 19142: 7.9.3.6", dataProvider = "protocol-binding")
public void invokeGetFeatureById(ProtocolBinding binding) {
if (null == this.featureId || this.featureId.isEmpty()) {
this.featureId = findFeatureIdentifier(this.wfsMetadata);
}
Assert.assertFalse(null == this.featureId || this.featureId.isEmpty(),
ErrorMessage.get(ErrorMessageKeys.FID_NOT_FOUND));
WFSRequest.appendStoredQuery(this.reqEntity,
WFS2.QRY_GET_FEATURE_BY_ID,
Collections.singletonMap("id", (Object) this.featureId));
URI endpoint = ServiceMetadataUtils.getOperationEndpoint(
this.wfsMetadata, WFS2.GET_FEATURE, binding);
ClientResponse rsp = wfsClient.submitRequest(new DOMSource(
this.reqEntity), binding, endpoint);
this.rspEntity = extractBodyAsDocument(rsp, binding);
Assert.assertTrue(rsp.hasEntity(),
ErrorMessage.get(ErrorMessageKeys.MISSING_XML_ENTITY));
Element feature = this.rspEntity.getDocumentElement();
Assert.assertEquals(feature.getAttributeNS(Namespaces.GML, "id"),
this.featureId,
ErrorMessage.get(ErrorMessageKeys.UNEXPECTED_ID));
}
/**
* Attempts to find a feature identifier by (a) querying the SUT if it
* implements the "Basic WFS" conformance class, or (b) invoking the stored
* query GetFeatureByType.
*
* @param wfsMetadata
* A WFS capabilities document (wfs:WFS_Capabilities).
* @return A String representing a feature identifier.
*/
String findFeatureIdentifier(Document wfsMetadata) {
List featureTypeList = ServiceMetadataUtils
.getFeatureTypes(wfsMetadata);
Set claims = ServiceMetadataUtils
.getConformanceClaims(wfsMetadata);
String id = null;
for (QName featureType : featureTypeList) {
NodeList members;
if (claims.contains(ConformanceClass.BASIC_WFS)) {
Document rspEntity = this.wfsClient.getFeatureByType(
featureType, 1, null);
members = rspEntity.getElementsByTagNameNS(
featureType.getNamespaceURI(),
featureType.getLocalPart());
if (members.getLength() == 0)
continue;
Element feature = (Element) members.item(0);
id = feature.getAttributeNS(Namespaces.GML, "id");
break;
}
members = executeGetFeatureByType(featureType, null);
if (members.getLength() == 0)
continue;
Element feature = (Element) members.item(0);
id = feature.getAttributeNS(Namespaces.GML, "id");
break;
}
return id;
}
/**
* Submits a request to execute the GetFeatureByType stored
* query.
*
* @param featureType
* A QName specifying the feature type name.
* @param binding
* The ProtocolBinding to use (if {@code null} any supported
* request message binding will be used).
* @return A NodeList containing feature instances of the specified type (it
* may be empty).
*/
NodeList executeGetFeatureByType(QName featureType, ProtocolBinding binding) {
if (null == binding || binding.equals(ProtocolBinding.ANY)) {
binding = ServiceMetadataUtils
.getOperationBindings(wfsMetadata, WFS2.GET_FEATURE)
.iterator().next();
}
WFSRequest.appendStoredQuery(this.reqEntity,
WFS2.QRY_GET_FEATURE_BY_TYPE,
Collections.singletonMap("typeName", (Object) featureType));
URI endpoint = ServiceMetadataUtils.getOperationEndpoint(
this.wfsMetadata, WFS2.GET_FEATURE, binding);
ClientResponse rsp = wfsClient.submitRequest(new DOMSource(
this.reqEntity), binding, endpoint);
Document entity = extractBodyAsDocument(rsp, binding);
String xpath = "/wfs:FeatureCollection/wfs:member/*";
Map bindings = new HashMap();
bindings.put(Namespaces.WFS, "wfs");
NodeList members;
try {
members = XMLUtils.evaluateXPath(entity, xpath, bindings);
} catch (XPathExpressionException e) {
throw new RuntimeException(e);
}
return members;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy