Java tutorial
/* Copyright (c) 2001 - 2007 TOPP - www.openplans.org. All rights reserved. * This code is licensed under the GPL 2.0 license, availible at the root * application directory. */ package org.geoserver.wms; import java.awt.Color; import java.awt.Frame; import java.awt.Graphics; import java.awt.Panel; import java.awt.event.WindowAdapter; import java.awt.event.WindowEvent; import java.awt.image.BufferedImage; import java.io.ByteArrayInputStream; import java.io.ByteArrayOutputStream; import java.io.File; import java.io.IOException; import java.io.StringReader; import java.util.ArrayList; import java.util.HashMap; import java.util.List; import java.util.Map; import javax.imageio.ImageIO; import javax.xml.namespace.QName; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; import org.apache.commons.io.FileUtils; import org.custommonkey.xmlunit.SimpleNamespaceContext; import org.custommonkey.xmlunit.XMLUnit; import org.geoserver.catalog.Catalog; import org.geoserver.catalog.LayerInfo; import org.geoserver.data.test.MockData; import org.geoserver.platform.GeoServerResourceLoader; import org.geoserver.test.GeoServerTestSupport; import org.geotools.data.FeatureSource; import org.geotools.map.FeatureSourceMapLayer; import org.geotools.map.MapLayer; import org.geotools.referencing.crs.DefaultGeographicCRS; import org.geotools.styling.Style; import org.geotools.xml.transform.TransformerBase; import org.opengis.feature.Feature; import org.opengis.feature.type.FeatureType; import org.vfny.geoserver.Request; import org.w3c.dom.Document; import org.xml.sax.InputSource; import com.mockrunner.mock.web.MockHttpServletResponse; import com.vividsolutions.jts.geom.Envelope; /** * Base support class for wms tests. * <p> * Deriving from this test class provides the test case with preconfigured geoserver and wms * objects. * </p> * * @author Justin Deoliveira, The Open Planning Project, jdeolive@openplans.org * */ public abstract class WMSTestSupport extends GeoServerTestSupport { protected static final int SHOW_TIMEOUT = 2000; protected static final boolean INTERACTIVE = false; protected static final Color BG_COLOR = Color.white; /** * @return The global wms singleton from the application context. */ protected WMS getWMS() { WMS wms = (WMS) applicationContext.getBean("wms"); // WMS wms = new WMS(getGeoServer()); // wms.setApplicationContext(applicationContext); return wms; } @Override protected void oneTimeSetUp() throws Exception { super.oneTimeSetUp(); Map<String, String> namespaces = new HashMap<String, String>(); namespaces.put("xlink", "http://www.w3.org/1999/xlink"); namespaces.put("wfs", "http://www.opengis.net/wfs"); namespaces.put("wcs", "http://www.opengis.net/wcs/1.1.1"); namespaces.put("gml", "http://www.opengis.net/gml"); namespaces.put("sf", "http://cite.opengeospatial.org/gmlsf"); getTestData().registerNamespaces(namespaces); XMLUnit.setXpathNamespaceContext(new SimpleNamespaceContext(namespaces)); //copy over some schema files copySchemaFile("gml/2.1.2.1/geometry.xsd"); copySchemaFile("gml/2.1.2.1/feature.xsd"); copySchemaFile("xlink/1.0.0/xlinks.xsd"); copySchemaFile("filter/1.0.0/expr.xsd"); copySchemaFile("filter/1.0.0/filter.xsd"); copySchemaFile("sld/StyledLayerDescriptor.xsd"); } protected void copySchemaFile(String file) throws IOException { File f = new File("../web/app/src/main/webapp/schemas/" + file); FileUtils.copyFile(f, getResourceLoader().createFile("WEB-INF/schemas/" + file)); } @Override protected void populateDataDirectory(MockData dataDirectory) throws Exception { super.populateDataDirectory(dataDirectory); dataDirectory.addStyle("default", MockData.class.getResource("Default.sld")); } /** * Convenience method for subclasses to create a map layer from a layer name. * <p> * The map layer is created with the default style for the layer. * </p> * * @param layerName * The name of the layer. * * @return A new map layer. */ protected MapLayer createMapLayer(QName layerName) throws IOException { return createMapLayer(layerName, null); } /** * Convenience method for subclasses to create a map layer from a layer name and a style name. * <p> * The map layer is created with the default style for the layer. * </p> * * @param layerName * The name of the layer. * @param a * style in the catalog (or null if you want to use the default style) * * @return A new map layer. */ protected MapLayer createMapLayer(QName layerName, String styleName) throws IOException { // TODO: support coverages Catalog catalog = getCatalog(); org.geoserver.catalog.FeatureTypeInfo info = catalog.getFeatureTypeByName(layerName.getNamespaceURI(), layerName.getLocalPart()); LayerInfo layerInfo = catalog.getLayerByName(layerName.getLocalPart()); Style style = layerInfo.getDefaultStyle().getStyle(); if (styleName != null) { style = catalog.getStyleByName(styleName).getStyle(); } FeatureSource<? extends FeatureType, ? extends Feature> featureSource; featureSource = info.getFeatureSource(null, null); MapLayer layer = new FeatureSourceMapLayer(featureSource, style); layer.setTitle(layer.getTitle()); return layer; } /** * Calls through to {@link #createGetMapRequest(QName[])}. * */ protected GetMapRequest createGetMapRequest(QName layerName) { return createGetMapRequest(new QName[] { layerName }); } /** * Convenience method for subclasses to create a new GetMapRequest object. * <p> * The returned object has the following properties: * <ul> * <li>styles set to default styles for layers specified * <li>bbox set to (-180,-90,180,180 ) * <li>crs set to epsg:4326 * </ul> * Caller must set additional parameters of request as need be. * </p> * * @param The * layer names of the request. * * @return A new GetMapRequest object. */ protected GetMapRequest createGetMapRequest(QName[] layerNames) { GetMapRequest request = new GetMapRequest(); request.setBaseUrl("http://localhost:8080/geoserver"); List<MapLayerInfo> layers = new ArrayList<MapLayerInfo>(layerNames.length); List styles = new ArrayList(); for (int i = 0; i < layerNames.length; i++) { LayerInfo layerInfo = getCatalog().getLayerByName(layerNames[i].getLocalPart()); try { styles.add(layerInfo.getDefaultStyle().getStyle()); } catch (IOException e) { throw new RuntimeException(e); } layers.add(new MapLayerInfo(layerInfo)); } request.setLayers(layers); request.setStyles(styles); request.setBbox(new Envelope(-180, -90, 180, 90)); request.setCrs(DefaultGeographicCRS.WGS84); request.setSRS("EPSG:4326"); request.setRawKvp(new HashMap()); return request; } /** * Asserts that the image is not blank, in the sense that there must be pixels different from * the passed background color. * * @param testName * the name of the test to throw meaningfull messages if something goes wrong * @param image * the imgage to check it is not "blank" * @param bgColor * the background color for which differing pixels are looked for */ protected void assertNotBlank(String testName, BufferedImage image, Color bgColor) { int pixelsDiffer = countNonBlankPixels(testName, image, bgColor); assertTrue(testName + " image is comlpetely blank", 0 < pixelsDiffer); } /** * Counts the number of non black pixels * * @param testName * @param image * @param bgColor * @return */ protected int countNonBlankPixels(String testName, BufferedImage image, Color bgColor) { int pixelsDiffer = 0; for (int y = 0; y < image.getHeight(); y++) { for (int x = 0; x < image.getWidth(); x++) { if (image.getRGB(x, y) != bgColor.getRGB()) { ++pixelsDiffer; } } } LOGGER.fine(testName + ": pixel count=" + (image.getWidth() * image.getHeight()) + " non bg pixels: " + pixelsDiffer); return pixelsDiffer; } /** * Utility method to run the transformation on tr with the provided request and returns the * result as a DOM. * <p> * Parsing the response is done in a namespace aware way. * </p> * * @param req * , the Object to run the xml transformation against with {@code tr}, usually an * instance of a {@link Request} subclass * @param tr * , the transformer to run the transformation with and produce the result as a DOM */ public static Document transform(Object req, TransformerBase tr) throws Exception { return transform(req, tr, true); } /** * Utility method to run the transformation on tr with the provided request and returns the * result as a DOM * * @param req * , the Object to run the xml transformation against with {@code tr}, usually an * instance of a {@link Request} subclass * @param tr * , the transformer to run the transformation with and produce the result as a DOM * @param namespaceAware * whether to use a namespace aware parser for the response or not */ public static Document transform(Object req, TransformerBase tr, boolean namespaceAware) throws Exception { ByteArrayOutputStream out = new ByteArrayOutputStream(); tr.transform(req, out); DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance(); dbf.setNamespaceAware(namespaceAware); DocumentBuilder db = dbf.newDocumentBuilder(); /** * Resolves everything to an empty xml document, useful for skipping errors due to missing * dtds and the like * * @author Andrea Aime - TOPP */ class EmptyResolver implements org.xml.sax.EntityResolver { public InputSource resolveEntity(String publicId, String systemId) throws org.xml.sax.SAXException, IOException { StringReader reader = new StringReader("<?xml version=\"1.0\" encoding=\"UTF-8\"?>"); InputSource source = new InputSource(reader); source.setPublicId(publicId); source.setSystemId(systemId); return source; } } db.setEntityResolver(new EmptyResolver()); // System.out.println(out.toString()); Document doc = db.parse(new ByteArrayInputStream(out.toByteArray())); return doc; } /** * Checks that the image generated by the map producer is not blank. * * @param testName * @param producer */ protected void assertNotBlank(String testName, BufferedImage image) { assertNotBlank(testName, image, BG_COLOR); showImage(testName, image); } public static void showImage(String frameName, final BufferedImage image) { showImage(frameName, SHOW_TIMEOUT, image); } /** * Shows <code>image</code> in a Frame. * * @param frameName * @param timeOut * @param image */ public static void showImage(String frameName, long timeOut, final BufferedImage image) { int width = image.getWidth(); int height = image.getHeight(); if (((System.getProperty("java.awt.headless") == null) || !System.getProperty("java.awt.headless").equals("true")) && INTERACTIVE) { Frame frame = new Frame(frameName); frame.addWindowListener(new WindowAdapter() { public void windowClosing(WindowEvent e) { e.getWindow().dispose(); } }); Panel p = new Panel(null) { // no layout manager so it respects // setSize public void paint(Graphics g) { g.drawImage(image, 0, 0, this); } }; frame.add(p); p.setSize(width, height); frame.pack(); frame.setVisible(true); try { Thread.sleep(timeOut); } catch (InterruptedException e) { e.printStackTrace(); } frame.dispose(); } } /** * Performs some checks on an image response assuming the image is a png. * @see #checkImage(MockHttpServletResponse, String) */ protected void checkImage(MockHttpServletResponse response) { checkImage(response, "image/png"); } /** * Performs some checks on an image response such as the mime type and attempts to read the * actual image into a buffered image. * */ protected void checkImage(MockHttpServletResponse response, String mimeType) { assertEquals(mimeType, response.getContentType()); try { BufferedImage image = ImageIO.read(getBinaryInputStream(response)); assertNotNull(image); assertEquals(image.getWidth(), 550); assertEquals(image.getHeight(), 250); } catch (Throwable t) { t.printStackTrace(); fail("Could not read image returned from GetMap:" + t.getLocalizedMessage()); } } }