org.opengis.cite.iso19142.basic.BasicGetFeatureTests Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ets-wfs20 Show documentation
Checks WFS 2.0 implementations for conformance to ISO 19142:2010.
There is a newer version: 2.0-r18
package org.opengis.cite.iso19142.basic;

import java.net.URI;
import java.util.logging.Level;

import javax.xml.XMLConstants;
import javax.xml.namespace.QName;
import javax.xml.transform.dom.DOMSource;
import javax.xml.validation.Schema;
import javax.xml.validation.SchemaFactory;
import javax.xml.validation.Validator;

import org.opengis.cite.iso19142.BaseFixture;
import org.opengis.cite.iso19142.ETSAssert;
import org.opengis.cite.iso19142.ErrorMessage;
import org.opengis.cite.iso19142.ErrorMessageKeys;
import org.opengis.cite.iso19142.FeatureTypeInfo;
import org.opengis.cite.iso19142.Namespaces;
import org.opengis.cite.iso19142.ProtocolBinding;
import org.opengis.cite.iso19142.WFS2;
import org.opengis.cite.iso19142.util.ServiceMetadataUtils;
import org.opengis.cite.iso19142.util.TestSuiteLogger;
import org.opengis.cite.iso19142.util.ValidationUtils;
import org.opengis.cite.iso19142.util.WFSRequest;
import org.testng.Assert;
import org.testng.annotations.AfterMethod;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.BeforeMethod;
import org.testng.annotations.Test;
import org.w3c.dom.Document;
import org.w3c.dom.NodeList;
import org.w3c.dom.ls.LSResourceResolver;
import org.xml.sax.SAXException;

import com.sun.jersey.api.client.ClientResponse;

/**
 * Tests the response to a GetFeature request that returns a selection of
 * features matching specified criteria. The request must include one or more
 * stored query (wfs:StoredQuery) or ad hoc query (wfs:Query) expressions. An ad
 * hoc query element may contain projection clauses (wfs:PropertyName), a
 * selection clause (fes:Filter), or a sorting clause (fes:SortBy).
 * 
 * A successful response entity must include a schema reference (using the
 * xsi:schemaLocation attribute) that is sufficient to validate the response.
 * 
 * @see "ISO 19142:2010, cl. 11: GetFeature operation"
 * @see "ISO 19142:2010, cl. 7.8:  Use of the schemaLocation attribute"
 * @see "ISO 19143:2010, Geographic information -- Filter encoding"
 */
public class BasicGetFeatureTests extends BaseFixture {

    private static final QName FEATURE_COLL = new QName(Namespaces.WFS,
            WFS2.FEATURE_COLLECTION);
    Validator hintsValidator;

    /**
     * Creates a special XML Schema validator that uses schema location hints
     * specified in an XML instance document. Beware that this can introduce a
     * vulnerability to denial-of-service attacks, even though local copies of
     * standard schemas will be used.
     */
    @BeforeClass
    public void buildValidator() {
        SchemaFactory factory = SchemaFactory
                .newInstance(XMLConstants.W3C_XML_SCHEMA_NS_URI);
        try {
            Schema schema = factory.newSchema();
            this.hintsValidator = schema.newValidator();
            LSResourceResolver resolver = ValidationUtils
                    .createSchemaResolver(Namespaces.XSD);
            this.hintsValidator.setResourceResolver(resolver);
        } catch (SAXException e) {
            // very unlikely to occur with no schema to process
            TestSuiteLogger
                    .log(Level.WARNING,
                            "Failed to build XML Schema Validator that heeds location hints.",
                            e);
        }
    }

    /**
     * Builds a DOM Document node representing the entity body for a GetFeature
     * request. A minimal XML representation is read from the classpath
     * ("GetFeature-Minimal.xml").
     */
    @BeforeMethod
    public void buildRequestEntity() {
        String resourceName = "GetFeature-Minimal.xml";
        try {
            this.reqEntity = this.docBuilder.parse(getClass()
                    .getResourceAsStream(resourceName));
        } catch (Exception x) {
            TestSuiteLogger.log(Level.WARNING,
                    "Failed to parse request entity from classpath: "
                            + resourceName, x);
        }
    }

    /**
     * Resets the validator to its original configuration.
     */
    @AfterMethod
    public void resetValidator() {
        this.hintsValidator.reset();
    }

    /**
     * Submits a minimal GetFeature request (without a filter predicate) for
     * feature types listed in the WFS the capabilities document. The test is
     * run for all supported protocol bindings and feature types. The response
     * entity (wfs:FeatureCollection) must be schema-valid and contain only
     * instances of the requested type as members.
     * 
     * @param binding
     *            A supported message binding.
     * @param featureType
     *            A QName representing the qualified name of some feature type.
     */
    @Test(description = "See ISO 19142: 11.2.2, 11.2.3", dataProvider = "all-protocols-featureTypes")
    public void getFeaturesByType(ProtocolBinding binding, QName featureType) {
        WFSRequest.appendSimpleQuery(this.reqEntity, featureType);
        URI endpoint = ServiceMetadataUtils.getOperationEndpoint(
                this.wfsMetadata, WFS2.GET_FEATURE, binding);
        ClientResponse rsp = wfsClient.submitRequest(new DOMSource(reqEntity),
                binding, endpoint);
        Assert.assertEquals(rsp.getStatus(),
                ClientResponse.Status.OK.getStatusCode(),
                ErrorMessage.get(ErrorMessageKeys.UNEXPECTED_STATUS));
        Document entity = extractBodyAsDocument(rsp, binding);
        ETSAssert
                .assertQualifiedName(entity.getDocumentElement(), FEATURE_COLL);
        ETSAssert.assertSchemaValid(
                this.hintsValidator,
                new DOMSource(entity.getDocumentElement(), entity
                        .getDocumentURI()));
    }

    /**
     * Sets the availability status of instances of a given feature type
     * according to the content of a GetFeature response entity. Availability is
     * set to {@code true} if the response entity contains at least one
     * instance.
     * 
     * @param featureInfo
     *            A FeatureTypeInfo object that provides information about a
     *            feature type.
     * @param entity
     *            A GetFeature response entity (wfs:FeatureCollection).
     */
    void setFeatureAvailability(FeatureTypeInfo featureInfo, Document entity) {
        QName typeName = featureInfo.getTypeName();
        NodeList features = entity.getElementsByTagNameNS(
                typeName.getNamespaceURI(), typeName.getLocalPart());
        featureInfo.setInstantiated(features.getLength() > 0);
    }
}