org.opengis.cite.iso19136.data.SchematronTests Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ets-gml32 Show documentation
Show all versions of ets-gml32 Show documentation
Checks GML application schemas or data sets for conformance to ISO 19136:2007.
package org.opengis.cite.iso19136.data;
import java.io.File;
import java.io.FileInputStream;
import java.net.URI;
import java.net.URL;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import java.util.logging.Level;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamReader;
import javax.xml.transform.Source;
import javax.xml.transform.dom.DOMResult;
import javax.xml.transform.stream.StreamSource;
import org.opengis.cite.iso19136.ETSAssert;
import org.opengis.cite.iso19136.ErrorMessage;
import org.opengis.cite.iso19136.ErrorMessageKeys;
import org.opengis.cite.iso19136.Namespaces;
import org.opengis.cite.iso19136.SuiteAttribute;
import org.opengis.cite.iso19136.TestRunArg;
import org.opengis.cite.iso19136.util.XMLUtils;
import org.opengis.cite.iso19136.util.TestSuiteLogger;
import org.opengis.cite.validation.SchematronValidator;
import org.testng.Assert;
import org.testng.ITestContext;
import org.testng.SkipException;
import org.testng.annotations.BeforeClass;
import org.testng.annotations.Test;
import org.testng.log4testng.Logger;
/**
* Verifies that a GML instance document adheres to the constraints defined in
* Schematron schemas. An application-specific schema may be associated with the
* instance document by either of the following means:
*
*
* - Specify the schema location using the
xml-model processing
* instruction, where the value of the "schematypens" data item is the name of
* the Schematron namespace (see sample listing below).
* - Specify the schema location as the value of the {@link TestRunArg#SCH
* sch} test run argument;
*
*
*
*
Using the xml-model PI to refer to a Schematron schema
*
*
* {@code
*
*
* }
*
*
*
*
* The processing instruction takes precedence if multiple schema references are
* found.
*
* Sources
*
*
*/
public class SchematronTests extends DataFixture {
private SchematronValidator dataValidator;
/**
* Attempts to construct a Schematron validator from a schema reference
* given in (a) the GML data file, or (b) a test run argument (in the ISuite
* context).
*
* @param testContext
* The test set context.
*/
@BeforeClass
public void createSchematronValidator(ITestContext testContext) {
Map piData = getXmlModelPIData(this.dataFile);
String phase = "#ALL";
URI schematronURI;
Source schema = null;
if (isSchematronReference(piData)) {
schematronURI = URI.create(piData.get("href"));
if (!schematronURI.isAbsolute()) {
// resolve relative URI against location of GML data
String dataURI = testContext.getSuite().getParameter(
TestRunArg.GML.toString());
URI baseURI = URI.create(dataURI);
schematronURI = baseURI.resolve(schematronURI);
}
schema = new StreamSource(schematronURI.toString());
if (piData.containsKey("phase"))
phase = piData.get("phase");
} else { // look for suite attribute (test run argument)
Set suiteAttrs = testContext.getSuite().getAttributeNames();
if (suiteAttrs.contains(SuiteAttribute.SCHEMATRON.getName())) {
schematronURI = (URI) testContext.getSuite().getAttribute(
SuiteAttribute.SCHEMATRON.getName());
schema = new StreamSource(schematronURI.toString());
}
}
if (null != schema) {
try {
this.dataValidator = new SchematronValidator(schema, phase);
} catch (Exception e) {
Logger.getLogger(getClass()).warn(
"Failed to create SchematronValidator.\n", e);
}
}
}
/**
* [{@code Test}] Verifies that a GML instance satisfies the additional
* Schematron constraints specified in ISO 19136.
*
* Sources
*
*/
@Test(description = "Checks general Schematron rules specified in ISO 19136")
public void checkGMLSchematronConstraints() {
URL schRef = this.getClass().getResource(
"/org/opengis/cite/iso19136/sch/gml-3.2.1.sch");
ETSAssert
.assertSchematronValid(schRef, new StreamSource(this.dataFile));
}
/**
* [{@code Test}] Checks for the presence of any deprecated GML elements. A
* warning is issued for each occurrence.
*
* @see "ISO 19136, Annex I: Backwards compatibility with earlier versions of GML"
*/
@Test(description = "See ISO 19136: Annex I")
public void checkForDeprecatedGMLElements() {
URL schRef = this.getClass().getResource(
"/org/opengis/cite/iso19136/sch/gml-deprecated-3.2.1.sch");
ETSAssert
.assertSchematronValid(schRef, new StreamSource(this.dataFile));
}
/**
* [{@code Test}] Validates a GML document against a set of Schematron
* constraints associated with it using either the {@code xml-model}
* processing instruction or the {@code sch} test run argument.
*/
@Test(description = "Checks application-specific Schematron rules")
public void checkSchematronConstraints() {
if (null == this.dataValidator) {
throw new SkipException("Schematron schema reference not found.");
}
Source gmlSource = new StreamSource(this.dataFile);
DOMResult result = dataValidator.validate(gmlSource);
Assert.assertFalse(dataValidator.ruleViolationsDetected(), ErrorMessage
.format(ErrorMessageKeys.NOT_SCHEMA_VALID,
dataValidator.getRuleViolationCount(),
XMLUtils.writeNodeToString(result.getNode())));
}
/**
* Indicates whether or not the given PI data includes a Schematron schema
* reference.
*
* @param piData
* A Map containing PI data (pseudo-attributes).
* @return {@code true} if the "schematypens" pseudo-attribute has the value
* {@value org.opengis.cite.iso19136.Namespaces#SCH}; {@code false}
* otherwise;
*/
boolean isSchematronReference(Map piData) {
if (null != piData && null != piData.get("schematypens")) {
return piData.get("schematypens").equals(Namespaces.SCH);
}
return false;
}
/**
* Extracts the data items from the {@code xml-model} processing
* instruction. The PI must appear before the document element.
*
* @param dataFile
* A File containing the GML instance.
* @return A Map containing the supplied pseudo-attributes, or {@code null}
* if the PI is not present.
*/
Map getXmlModelPIData(File dataFile) {
Map piData = null;
XMLStreamReader reader = null;
FileInputStream input = null;
try {
input = new FileInputStream(dataFile);
XMLInputFactory factory = XMLInputFactory.newInstance();
reader = factory.createXMLStreamReader(input);
int event = reader.getEventType();
// Now in START_DOCUMENT state. Stop at document element.
while (event != XMLStreamReader.START_ELEMENT) {
event = reader.next();
if (event == XMLStreamReader.PROCESSING_INSTRUCTION) {
if (reader.getPITarget().equals("xml-model")) {
String[] pseudoAttrs = reader.getPIData().split("\\s+");
piData = new HashMap();
for (String pseudoAttr : pseudoAttrs) {
String[] nv = pseudoAttr.split("=");
piData.put(nv[0].trim(), nv[1].replace('"', ' ')
.trim());
}
break;
}
}
}
} catch (Exception e) {
TestSuiteLogger.log(Level.WARNING, "Failed to parse document at "
+ dataFile.getAbsolutePath(), e);
return null; // not an XML document
} finally {
try {
if (null != reader)
reader.close();
if (null != input)
input.close();
} catch (Exception x) {
TestSuiteLogger.log(Level.INFO, x.getMessage());
}
}
return piData;
}
}