// License: GPL. For details, see LICENSE file. package org.openstreetmap.josm.io; import static com.github.tomakehurst.wiremock.client.WireMock.aResponse; import static com.github.tomakehurst.wiremock.client.WireMock.get; import static com.github.tomakehurst.wiremock.client.WireMock.urlEqualTo; import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.options; import static org.junit.Assert.assertEquals; import static org.junit.Assert.assertNotNull; import static org.junit.Assert.assertNull; import static org.junit.Assert.assertTrue; import java.time.LocalDateTime; import java.util.regex.Matcher; import org.junit.Before; import org.junit.Rule; import org.junit.Test; import org.openstreetmap.josm.TestUtils; import org.openstreetmap.josm.data.Bounds; import org.openstreetmap.josm.io.OverpassDownloadReader.OverpassOutpoutFormat; import org.openstreetmap.josm.testutils.JOSMTestRules; import org.openstreetmap.josm.tools.OverpassTurboQueryWizard; import org.openstreetmap.josm.tools.Utils; import org.openstreetmap.josm.tools.date.DateUtils; import com.github.tomakehurst.wiremock.junit.WireMockRule; import edu.umd.cs.findbugs.annotations.SuppressFBWarnings; /** * Unit tests of {@link OverpassDownloadReader} class. */ public class OverpassDownloadReaderTest { /** * Base test environment is enough */ @Rule @SuppressFBWarnings(value = "URF_UNREAD_PUBLIC_OR_PROTECTED_FIELD") public JOSMTestRules test = new JOSMTestRules().preferences(); /** * HTTP mock. */ @Rule public WireMockRule wireMockRule = new WireMockRule(options().dynamicPort().usingFilesUnderDirectory(TestUtils.getTestDataRoot())); private static final String NOMINATIM_URL_PATH = "/search?format=xml&q="; /** * Setup test. */ @Before public void setUp() { NameFinder.NOMINATIM_URL_PROP.put("http://localhost:" + wireMockRule.port() + NOMINATIM_URL_PATH); } private String getExpandedQuery(String search) { final String query = OverpassTurboQueryWizard.getInstance().constructQuery(search); final String request = new OverpassDownloadReader(new Bounds(1, 2, 3, 4), null, query) .getRequestForBbox(1, 2, 3, 4) .substring("interpreter?data=".length()); return Utils.decodeUrl(request); } /** * Tests evaluating the extended query feature {@code bbox}. */ @Test public void testBbox() { final String query = getExpandedQuery("amenity=drinking_water"); assertEquals("" + "[out:xml][timeout:25][bbox:2.0,1.0,4.0,3.0];\n" + "(\n" + " node[\"amenity\"=\"drinking_water\"];\n" + " way[\"amenity\"=\"drinking_water\"];\n" + " relation[\"amenity\"=\"drinking_water\"];\n" + ");\n" + "(._;>;);\n" + "out meta;", query); } private void stubNominatim(String query) { wireMockRule.stubFor(get(urlEqualTo(NOMINATIM_URL_PATH + query)) .willReturn(aResponse() .withStatus(200) .withHeader("Content-Type", "text/xml") .withBodyFile("nominatim/" + query + ".xml"))); } /** * Tests evaluating the extended query feature {@code date}. */ @Test public void testDate() { LocalDateTime from = LocalDateTime.of(2017, 7, 14, 2, 40); assertEquals("2016-07-14T02:40:00Z", OverpassDownloadReader.date("1 year", from)); assertEquals("2007-07-14T02:40:00Z", OverpassDownloadReader.date("10years", from)); assertEquals("2017-06-14T02:40:00Z", OverpassDownloadReader.date("1 month", from)); assertEquals("2016-09-14T02:40:00Z", OverpassDownloadReader.date("10months", from)); assertEquals("2017-07-07T02:40:00Z", OverpassDownloadReader.date("1 week", from)); assertEquals("2017-05-05T02:40:00Z", OverpassDownloadReader.date("10weeks", from)); assertEquals("2017-07-13T02:40:00Z", OverpassDownloadReader.date("1 day", from)); assertEquals("2017-07-04T02:40:00Z", OverpassDownloadReader.date("10days", from)); assertEquals("2017-07-14T01:40:00Z", OverpassDownloadReader.date("1 hour", from)); assertEquals("2017-07-13T16:40:00Z", OverpassDownloadReader.date("10hours", from)); assertEquals("2017-07-14T02:39:00Z", OverpassDownloadReader.date("1 minute", from)); assertEquals("2017-07-14T02:30:00Z", OverpassDownloadReader.date("10minutes", from)); assertEquals("2017-07-14T02:39:59Z", OverpassDownloadReader.date("1 second", from)); assertEquals("2017-07-14T02:39:50Z", OverpassDownloadReader.date("10seconds", from)); assertEquals("2016-07-13T02:40:00Z", OverpassDownloadReader.date("1 year 1 day", from)); assertEquals("2016-07-14T02:38:20Z", OverpassDownloadReader.date("1 year 100 seconds", from)); assertEquals("2017-07-13T02:38:20Z", OverpassDownloadReader.date("1 day 100 seconds", from)); } /** * Tests evaluating the extended query feature {@code date} through {@code newer:} operator. */ @Test public void testDateNewer() { final String query = getExpandedQuery("type:node and newer:3minutes"); String statement = query.substring(query.indexOf("node(newer:\"") + 12, query.lastIndexOf("\");")); assertNotNull(DateUtils.fromString(statement)); } /** * Tests evaluating the extended query feature {@code geocodeArea}. */ @Test public void testGeocodeArea() { stubNominatim("London"); final String query = getExpandedQuery("amenity=drinking_water in London"); assertEquals("" + "[out:xml][timeout:25];\n" + "area(3600065606)->.searchArea;\n" + "(\n" + " node[\"amenity\"=\"drinking_water\"](area.searchArea);\n" + " way[\"amenity\"=\"drinking_water\"](area.searchArea);\n" + " relation[\"amenity\"=\"drinking_water\"](area.searchArea);\n" + ");\n" + "(._;>;);\n" + "out meta;", query); } /** * Tests evaluating the extended query feature {@code geocodeArea}. */ @Test public void testGeocodeUnknownArea() { stubNominatim("foo-bar-baz-does-not-exist"); final String query = OverpassDownloadReader.expandExtendedQueries("{{geocodeArea:foo-bar-baz-does-not-exist}}"); assertEquals("// Failed to evaluate {{geocodeArea:foo-bar-baz-does-not-exist}}\n", query); } /** * Tests evaluating the overpass output format statements. */ @Test public void testOutputFormatStatement() { for (OverpassOutpoutFormat oof : OverpassOutpoutFormat.values()) { Matcher m = OverpassDownloadReader.OUTPUT_FORMAT_STATEMENT.matcher("[out:"+oof.getDirective()+"]"); assertTrue(m.matches()); assertEquals(oof.getDirective(), m.group(1)); } assertTrue(OverpassDownloadReader.OUTPUT_FORMAT_STATEMENT.matcher( "[out:pbf][timeout:25][bbox:{{bbox}}];\n" + "(\n" + " node[\"amenity\"=\"pharmacy\"];\n" + " way[\"amenity\"=\"pharmacy\"];\n" + " relation[\"amenity\"=\"pharmacy\"];\n" + ");\n" + "(._;>;);\n" + "out meta;").matches()); } /** * Test {@link OverpassDownloadReader#fixQuery(String)}. */ @Test public void testFixQuery() { assertNull(OverpassDownloadReader.fixQuery(null)); assertEquals("out meta;", OverpassDownloadReader.fixQuery("out;")); assertEquals("out meta;", OverpassDownloadReader.fixQuery("out body;")); assertEquals("out meta;", OverpassDownloadReader.fixQuery("out skel;")); assertEquals("out meta;", OverpassDownloadReader.fixQuery("out ids;")); assertEquals("out meta id;", OverpassDownloadReader.fixQuery("out id;")); assertEquals("out meta id;", OverpassDownloadReader.fixQuery("out body id;")); assertEquals("out meta id;", OverpassDownloadReader.fixQuery("out skel id;")); assertEquals("out meta id;", OverpassDownloadReader.fixQuery("out ids id;")); assertEquals("out meta qt;", OverpassDownloadReader.fixQuery("out qt;")); assertEquals("out meta qt;", OverpassDownloadReader.fixQuery("out body qt;")); assertEquals("out meta qt;", OverpassDownloadReader.fixQuery("out skel qt;")); assertEquals("out meta qt;", OverpassDownloadReader.fixQuery("out ids qt;")); assertEquals("[out:xml]", OverpassDownloadReader.fixQuery("[out:json]")); assertEquals("[out:xml]", OverpassDownloadReader.fixQuery("[out:csv(\n" + " ::\"id\", amenity, name, operator, opening_hours, \"contact:website\", \"contact:phone\", brand, dispensing, lastcheck\n" + " )]")); assertEquals("[out:xml][timeout:25];\n" + "(\n" + " node[\"historic\"=\"ringfort\"];\n" + " way[\"historic\"=\"ringfort\"];\n" + ");\n" + "out meta;", OverpassDownloadReader.fixQuery("[out:json][timeout:25];\n" + "(\n" + " node[\"historic\"=\"ringfort\"];\n" + " way[\"historic\"=\"ringfort\"];\n" + ");\n" + "out body;")); } }