#109 Updated UV Tracks test to v3

UVHubTest/src/main/java/com/envirover/TestRunner.java

@@ -2,7 +2,7 @@
 
 import com.envirover.uvhub.UVHubTest;
 import com.envirover.uvtracks.UVTracksTest;
-import com.envirover.uvtracks.UVTracksV2Test;
+import com.envirover.uvtracks.UVTracksV3Test;
 
 import org.junit.runner.JUnitCore;
 import org.junit.runner.Result;
@@ -12,7 +12,7 @@ class TestRunner {
     public static void main(String[] args) {
         System.out.println("UV Hub and UV Tracks integration test.");
 
-        Result result = JUnitCore.runClasses(UVHubTest.class, UVTracksTest.class, UVTracksV2Test.class);
+        Result result = JUnitCore.runClasses(UVHubTest.class, UVTracksTest.class, UVTracksV3Test.class);
 
         if (result.wasSuccessful()) {
             System.out.println(
@@ -26,4 +26,4 @@ public static void main(String[] args) {
 
         System.exit(result.getFailureCount());
     }
-}
+}

UVHubTest/src/main/java/com/envirover/uvtracks/UVTracksV3Client.java

@@ -0,0 +1,237 @@
+/*
+ * Copyright 2016-2021 Pavel Bobov
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.envirover.uvtracks;
+
+import com.envirover.geojson.FeatureCollection;
+import org.apache.http.HttpResponse;
+import org.apache.http.NameValuePair;
+import org.apache.http.client.ClientProtocolException;
+import org.apache.http.client.HttpClient;
+import org.apache.http.client.methods.HttpGet;
+import org.apache.http.client.utils.URIBuilder;
+import org.apache.http.impl.client.HttpClients;
+import org.apache.http.message.BasicNameValuePair;
+import org.codehaus.jackson.JsonParseException;
+import org.codehaus.jackson.map.JsonMappingException;
+import org.codehaus.jackson.map.ObjectMapper;
+import org.codehaus.jackson.type.TypeReference;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URI;
+import java.net.URISyntaxException;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Client class for v3 version of UV Tracks web service.
+ */
+class UVTracksV3Client {
+    // Environment variables
+    private static final String UVTRACKS_PROTOCOL = "UVTRACKS_PROTOCOL";
+    private static final String UVTRACKS_HOSTNAME = "UVTRACKS_HOSTNAME";
+    private static final String UVTRACKS_PORT = "UVTRACKS_PORT";
+
+    private String protocol = "http";
+    private String hostname = "localhost";
+    private int port = 8080;
+
+    private static final ObjectMapper mapper = new ObjectMapper();
+
+    private HttpClient httpclient = HttpClients.createDefault();
+
+    /**
+     * Constructs UVTracksClient.
+     */
+    public UVTracksV3Client() {
+        if (System.getenv(UVTRACKS_PROTOCOL) != null) {
+            this.protocol = System.getenv(UVTRACKS_PROTOCOL);
+        }
+
+        if (System.getenv(UVTRACKS_HOSTNAME) != null) {
+            this.hostname = System.getenv(UVTRACKS_HOSTNAME);
+        }
+
+        if (System.getenv(UVTRACKS_PORT) != null) {
+            this.port = Integer.parseInt(System.getenv(UVTRACKS_PORT));
+        }
+    }
+
+    /**
+     * Constructs UVTracksClient with the specified URI attributes.
+     *
+     * @param protocol UV Tracks service protocol (http|https)
+     * @param hostname UVTracks service hostname
+     * @param port     UVTracks service port
+     */
+    public UVTracksV3Client(String protocol, String hostname, int port) {
+        this.protocol = protocol;
+        this.hostname = hostname;
+        this.port = port;
+    }
+
+    /**
+     * Returns reported positions and state information of the vehicle in GeoJSON
+     * format.
+     *
+     * @param sysId        System ID. The default value is 1.
+     * @param startTime    Start of time range query as UNIX epoch time.
+     * @param endTime      End of time range query as UNIX epoch time.
+     * @param top          Maximum number of returned entries. The default value is
+     *                     100.
+     * @param geometryType Geometry type <point|line>.
+     * @return reported positions and state information of the vehicle in GeoJSON
+     *         format.
+     * @throws URISyntaxException      invalid URI syntax
+     * @throws ClientProtocolException in case of a problem or the connection was
+     *                                 aborted
+     * @throws IOException             in case of an http protocol error
+     */
+    public FeatureCollection getTracks(Integer sysId, Long startTime, Long endTime, Integer top, String geometryType)
+            throws URISyntaxException, ClientProtocolException, IOException {
+
+        List<NameValuePair> parameters = new ArrayList<NameValuePair>();
+
+        if (sysId != null) {
+            parameters.add(new BasicNameValuePair("sysid", Integer.toString(sysId)));
+        }
+
+        if (startTime != null) {
+            parameters.add(new BasicNameValuePair("startTime", Long.toString(startTime)));
+        }
+
+        if (endTime != null) {
+            parameters.add(new BasicNameValuePair("endTime", Long.toString(endTime)));
+        }
+
+        if (top != null) {
+            parameters.add(new BasicNameValuePair("top", Integer.toString(top)));
+        }
+
+        if (geometryType != null) {
+            parameters.add(new BasicNameValuePair("geometryType", geometryType));
+        }
+
+        URI uri = new URIBuilder().setScheme(this.protocol).setHost(this.hostname).setPort(this.port)
+                .setPath("/uvtracks/api/v3/tracks").setParameters(parameters).build();
+
+        HttpGet request = new HttpGet(uri);
+
+        HttpResponse response = httpclient.execute(request);
+
+        try (InputStream content = response.getEntity().getContent()) {
+            return mapper.readValue(content, FeatureCollection.class);
+        }
+    }
+
+    /**
+     * Returns the last reported state of the vehicle.
+     *
+     * @param sysId system Id. The default value is 1.
+     * @return the last reported state of the vehicle.
+     * @throws URISyntaxException      invalid URI syntax
+     * @throws ClientProtocolException in case of a problem or the connection was
+     *                                 aborted
+     * @throws IOException             in case of an http protocol error
+     */
+    public FeatureCollection getState(Integer sysId) throws URISyntaxException, ClientProtocolException, IOException {
+        List<NameValuePair> parameters = new ArrayList<NameValuePair>();
+
+        if (sysId != null) {
+            parameters.add(new BasicNameValuePair("sysid", Integer.toString(sysId)));
+        }
+
+        URI uri = new URIBuilder().setScheme(this.protocol).setHost(this.hostname).setPort(this.port)
+                .setPath("/uvtracks/api/v3/state").setParameters(parameters).build();
+
+        HttpGet request = new HttpGet(uri);
+
+        HttpResponse response = httpclient.execute(request);
+
+        try (InputStream content = response.getEntity().getContent()) {
+            return mapper.readValue(content, FeatureCollection.class);
+        }
+    }
+
+    /**
+     * Returns missions of the vehicle.
+     *
+     * @param sysId        System ID. The default value is 1.
+     * @param geometryType Geometry type <point|line>
+     * @return mission plan of the vehicle.
+     * @throws URISyntaxException      invalid URI syntax
+     * @throws ClientProtocolException in case of a problem or the connection was
+     *                                 aborted
+     * @throws IOException             in case of an http protocol error
+     */
+    public FeatureCollection getMissions(Integer sysId, String geometryType)
+            throws URISyntaxException, ClientProtocolException, IOException {
+        List<NameValuePair> parameters = new ArrayList<NameValuePair>();
+
+        if (sysId != null) {
+            parameters.add(new BasicNameValuePair("sysid", Integer.toString(sysId)));
+        }
+
+        if (geometryType != null) {
+            parameters.add(new BasicNameValuePair("geometryType", geometryType));
+        }
+
+        URI uri = new URIBuilder().setScheme(this.protocol).setHost(this.hostname).setPort(this.port)
+                .setPath("/uvtracks/api/v3/missions").setParameters(parameters).build();
+
+        HttpGet request = new HttpGet(uri);
+
+        HttpResponse response = httpclient.execute(request);
+
+        try (InputStream content = response.getEntity().getContent()) {
+            return mapper.readValue(content, FeatureCollection.class);
+        }
+    }
+
+    /**
+     * Returns on-board parameters of the specified vehicle.
+     *
+     * @param sysId System ID. The default value is 1.
+     * @return on-board parameters
+     * @throws IOException
+     * @throws JsonMappingException
+     * @throws JsonParseException
+     * @throws URISyntaxException
+     */
+    public Map<String, Double> getParameters(Integer sysId)
+            throws JsonParseException, JsonMappingException, IOException, URISyntaxException {
+        List<NameValuePair> parameters = new ArrayList<NameValuePair>();
+
+        if (sysId != null) {
+            parameters.add(new BasicNameValuePair("sysid", Integer.toString(sysId)));
+        }
+
+        URI uri = new URIBuilder().setScheme(this.protocol).setHost(this.hostname).setPort(this.port)
+                .setPath("/uvtracks/api/v3/parameters").setParameters(parameters).build();
+
+        HttpGet request = new HttpGet(uri);
+
+        HttpResponse response = httpclient.execute(request);
+
+        try (InputStream content = response.getEntity().getContent()) {
+            return mapper.readValue(content, new TypeReference<Map<String, Double>>() {
+            });
+        }
+    }
+
+}

UVHubTest/src/main/java/com/envirover/uvtracks/UVTracksV3Test.java

@@ -0,0 +1,84 @@
+/*
+ * Copyright 2016-2020 Pavel Bobov
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.envirover.uvtracks;
+
+import com.envirover.geojson.FeatureCollection;
+import org.apache.http.client.ClientProtocolException;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import org.junit.Test;
+
+import java.io.IOException;
+import java.net.URISyntaxException;
+import java.util.Map;
+
+import static org.junit.Assert.assertEquals;
+
+// UV Tracks v2 web service integration test
+public class UVTracksV3Test {
+
+    private final static Logger logger = LogManager.getLogger(UVTracksV3Test.class);
+
+    UVTracksV3Client uvTracks = new UVTracksV3Client();
+
+    @BeforeClass
+    public static void setUpClass() throws Exception {
+    }
+
+    @AfterClass
+    public static void tearDownClass() throws Exception {
+    }
+
+    @Test
+    public void testGetTracks() throws ClientProtocolException, URISyntaxException, IOException {
+        logger.info("UVTracks TEST: GET /uvtracks/api/v3/tracks");
+
+        FeatureCollection tracks = this.uvTracks.getTracks(null, null, null, null, null);
+
+        assertEquals("FeatureCollection", tracks.getType());
+    }
+
+    @Test
+    public void testGetState() throws ClientProtocolException, URISyntaxException, IOException {
+        logger.info("UVTracks TEST: GET /uvtracks/api/v3/state");
+
+        FeatureCollection tracks = this.uvTracks.getState(null);
+
+        assertEquals("FeatureCollection", tracks.getType());
+    }
+
+    @Test
+    public void testGetMissions() throws ClientProtocolException, URISyntaxException, IOException {
+        logger.info("UVTracks TEST: GET /uvtracks/api/v3/missions");
+
+        FeatureCollection missions = this.uvTracks.getMissions(null, null);
+
+        assertEquals("FeatureCollection", missions.getType());
+    }
+
+    @Test
+    public void testGetParameters() throws ClientProtocolException, URISyntaxException, IOException {
+        logger.info("UVTracks TEST: GET /uvtracks/api/v3/parameters");
+
+        Map<String, Double> parameters = this.uvTracks.getParameters(null);
+
+        assert(parameters.size() > 0);
+    }
+
+}