Merge pull request #21 from WURFL/2.1.6

2.1.6

Author: andreacastello

example/pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.scientiamobile.wurfl</groupId>
     <artifactId>wmclient-example</artifactId>
-    <version>2.1.5</version>
+    <version>2.1.6</version>
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -48,7 +48,7 @@
         <dependency>
             <groupId>com.scientiamobile.wurflmicroservice</groupId>
             <artifactId>wurfl-microservice</artifactId>
-            <version>2.1.5</version>
+            <version>2.1.6</version>
         </dependency>
 
     </dependencies>

wmclient/CHANGELOG.txt

@@ -1,3 +1,9 @@
+2.1.6
+-------------------------------------
+IMPORTANT: dependency commons-lang (v2.6) has been replaced with commons-lang3 (v3.12.0).
+You shouldn't experience any difference between version 2.1.6 and 2.1.5
+- Some code refactoring and test improvement
+
 2.1.5
 -------------------------------------
 - Updated Gson to version 2.9.0 to solve vulnerability issue

wmclient/FOSS_THIRD_PARTY_LICENSES.txt

@@ -6,7 +6,7 @@ Apache commons-io
 Apache Software License Version 2.0
 http://www.apache.org/licenses/LICENSE-2.0
 
-Apache commons-lang
+Apache commons-lang3
 Apache Software License Version 2.0
 http://www.apache.org/licenses/LICENSE-2.0
 

wmclient/pom.xml

@@ -4,7 +4,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.scientiamobile.wurflmicroservice</groupId>
     <artifactId>wurfl-microservice</artifactId>
-    <version>2.1.5</version>
+    <version>2.1.6</version>
     <packaging>jar</packaging>
 
     <name>wurfl-microservice</name>
@@ -68,9 +68,9 @@
         </dependency>
         <!-- Apache Commons Lang -->
         <dependency>
-            <groupId>commons-lang</groupId>
-            <artifactId>commons-lang</artifactId>
-            <version>2.6</version>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+            <version>3.12.0</version>
         </dependency>
         <!-- Apache Commons IO -->
         <dependency>

wmclient/src/main/java/com/scientiamobile/wurfl/wmclient/LRUCache.java

@@ -28,7 +28,7 @@ class LRUCache<K, E> {
     // We'll use this object to lock
     private final Object mutex;
 
-    private int size;
+    private final int size;
 
     private final ConcurrentHashMap<K, Node> cache;
     private Node head;

wmclient/src/main/java/com/scientiamobile/wurfl/wmclient/Model.java

@@ -24,17 +24,20 @@
  */
 public class Model {
 
+    private Model(){}
+    static Model m = new Model();
+
     // Factory methods
     static Request newRequest(Map<String, String> lookupHeaders, String[] requestedCaps, String[] requestedVcaps, String wurflId) {
-        return new Model().new Request(lookupHeaders, requestedCaps, requestedVcaps, wurflId);
+        return m.new Request(lookupHeaders, requestedCaps, requestedVcaps, wurflId);
     }
 
     static JSONModelMktName newJSONModelMktName(String modelName, String mktName){
-        return new Model().new JSONModelMktName(modelName, mktName);
+        return m.new JSONModelMktName(modelName, mktName);
     }
 
     /**
-     * Holds informations about wurfl microservice server and API
+     * Holds information about wurfl microservice server and API
      * <p>
      * Created by Andrea Castello on 19/07/2017.
      */

wmclient/src/main/java/com/scientiamobile/wurfl/wmclient/WmClient.java

@@ -18,8 +18,8 @@
 import com.google.gson.Gson;
 import com.scientiamobile.wurfl.wmclient.Model.Request;
 import org.apache.commons.collections.CollectionUtils;
-import org.apache.commons.lang.ArrayUtils;
-import org.apache.commons.lang.StringUtils;
+import org.apache.commons.lang3.ArrayUtils;
+import org.apache.commons.lang3.StringUtils;
 import org.apache.http.HttpEntity;
 import org.apache.http.HttpResponse;
 import org.apache.http.client.ClientProtocolException;
@@ -591,7 +591,7 @@ public void setCacheSize(int uaMaxEntries) {
      * @return This client API version
      */
     public String getApiVersion() {
-        return "2.1.5";
+        return "2.1.6";
     }
 
     private void clearCaches() {
@@ -623,20 +623,22 @@ private void clearCachesIfNeeded(String ltime) {
     }
 
     private String getUserAgentCacheKey(Map<String, String> headers, String cacheType) throws WmException {
-        String key = "";
+        StringBuilder key = new StringBuilder("");
 
         if (headers == null && USERAGENT_CACHE_TYPE.equals(cacheType)) {
             throw new WmException("No User-Agent provided");
         }
 
         // Using important headers array preserves header name order
-        for (String h : importantHeaders) {
-            String hval = headers.get(h);
-            if (hval != null) {
-                key += hval;
+        if(headers!=null) {
+            for (String h : importantHeaders) {
+                String headerValue = headers.get(h);
+                if (headerValue != null) {
+                    key.append(headerValue);
+                }
             }
         }
-        return key;
+        return key.toString();
     }
 
     private void safePutDevice(LRUCache<String, Model.JSONDeviceData> cache, String key, Model.JSONDeviceData device) {
@@ -662,7 +664,7 @@ public int[] getActualCacheSizes() {
 
 class WmDataHandler<T> implements ResponseHandler<T> {
 
-    private Class<T> type;
+    private final Class<T> type;
 
     WmDataHandler(Class<T> type) {
         this.type = type;

wmclient/src/test/java/com/scientiamobile/wurfl/wmclient/WmClientTest.java

@@ -18,7 +18,9 @@
 import org.apache.commons.collections.MapUtils;
 import org.apache.commons.collections.iterators.EmptyIterator;
 import org.apache.commons.collections.iterators.IteratorEnumeration;
-import org.apache.commons.lang.StringUtils;
+import org.apache.commons.lang3.JavaVersion;
+import org.apache.commons.lang3.StringUtils;
+import org.apache.commons.lang3.SystemUtils;
 import org.testng.Assert;
 import org.testng.annotations.BeforeClass;
 import org.testng.annotations.Test;
@@ -50,6 +52,7 @@ public class WmClientTest {
 
     @BeforeClass
     public void createTestClient() throws WmException {
+        System.out.println("Running on Java version: " + SystemUtils.JAVA_VERSION);
         String host = "localhost";
         String port = "8080";
         String envHost = System.getenv("WM_HOST");
@@ -64,6 +67,12 @@ public void createTestClient() throws WmException {
 
     }
 
+    @Test
+    public void javaVersionTest(){
+        boolean isJava8min = SystemUtils.isJavaVersionAtLeast(JavaVersion.JAVA_1_8);
+        assertTrue(isJava8min, "Java 8 is the minimum version required to run WMClient and its tests");
+    }
+
 
     public WmClient createCachedTestClient(int csize) throws WmException {
         String host = "localhost";
@@ -173,7 +182,6 @@ public void lookupUseragentEmptyUaTest() {
 
     @Test
     public void testLookupUseragentNullUa() {
-        boolean exc = false;
         try {
             Model.JSONDeviceData device = _client.lookupUseragent(null);
             assertNotNull(device);
@@ -754,6 +762,7 @@ public void realCacheUsageTest() throws WmException {
 
     @Test
     public void realCacheUsageTest_2() throws WmException {
+
         String host = "localhost";
         String port = "8080";
         String envHost = System.getenv("WM_HOST");
@@ -765,13 +774,20 @@ public void realCacheUsageTest_2() throws WmException {
             port = envPort;
         }
         WmClient client = WmClient.create("http", host, port, "");
+
+        // We create a set of 10K elements
+        List<String> testUserAgents = new ArrayList<>();
+        for(int i=0; i<100;i++){
+            testUserAgents.addAll(Arrays.asList(TestData.USER_AGENTS));
+        }
+
         try {
             long start = System.nanoTime();
-            for (String ua: TestData.USER_AGENTS){
+            for (String ua: testUserAgents){
                 client.lookupUseragent(ua);
             }
             long elapsedNoCache = System.nanoTime() - start;
-            double avgNoCache = (double)elapsedNoCache/(double)TestData.USER_AGENTS.length;
+            double avgNoCache = (double)elapsedNoCache/(double)testUserAgents.size();
 
             // Now, let's add a cache layer
             client.setCacheSize(100000);
@@ -783,14 +799,14 @@ public void realCacheUsageTest_2() throws WmException {
 
             // now use it
             long nu_start = System.nanoTime();
-            for (String ua: TestData.USER_AGENTS){
+            for (String ua: testUserAgents){
                 client.lookupUseragent(ua);
             }
             long elapsedWithCache = System.nanoTime() - nu_start;
-            double avgWithCache = (double)elapsedWithCache/(double)TestData.USER_AGENTS.length;
+            double avgWithCache = (double)elapsedWithCache/(double)testUserAgents.size();
 
             // Cache must be at least an order of magnitude faster
-            assertTrue(avgNoCache > avgWithCache * 10);
+            assertTrue(avgNoCache > avgWithCache * 100);
 
         }
         finally {
@@ -865,7 +881,7 @@ public WmClient createTestCachedClient(int csize) throws WmException {
     // Uses reflection to force invoke of private method clearCacheIfNeeded for testing purposes
     private void invokeClearCacheIfNeeded(WmClient client, String ltime) throws ClassNotFoundException, NoSuchMethodException,
             InvocationTargetException, IllegalAccessException {
-        Class clientClass = Class.forName("com.scientiamobile.wurfl.wmclient.WmClient");
+        Class<?> clientClass = Class.forName("com.scientiamobile.wurfl.wmclient.WmClient");
         Method ms = clientClass.getDeclaredMethod("clearCachesIfNeeded", String.class);
         ms.setAccessible(true);
         ms.invoke(client, ltime);
@@ -876,9 +892,9 @@ private HttpServletRequest createTestRequest(final boolean provideHeaders) {
         return new HttpServletRequest() {
 
             private final Map<String, String> headers = new HashMap<>();
-            private String ua = "Mozilla/5.0 (Nintendo Switch; WebApplet) AppleWebKit/601.6 (KHTML, like Gecko) NF/4.0.0.5.9 NintendoBrowser/5.1.0.13341";
-            private String xucbr = "Mozilla/5.0 (Nintendo Switch; ShareApplet) AppleWebKit/601.6 (KHTML, like Gecko) NF/4.0.0.5.9 NintendoBrowser/5.1.0.13341";
-            private String dstkUa = "Mozilla/5.0 (Nintendo Switch; WifiWebAuthApplet) AppleWebKit/601.6 (KHTML, like Gecko) NF/4.0.0.5.9 NintendoBrowser/5.1.0.13341";
+            private final String ua = "Mozilla/5.0 (Nintendo Switch; WebApplet) AppleWebKit/601.6 (KHTML, like Gecko) NF/4.0.0.5.9 NintendoBrowser/5.1.0.13341";
+            private final String xucbr = "Mozilla/5.0 (Nintendo Switch; ShareApplet) AppleWebKit/601.6 (KHTML, like Gecko) NF/4.0.0.5.9 NintendoBrowser/5.1.0.13341";
+            private final String dstkUa = "Mozilla/5.0 (Nintendo Switch; WifiWebAuthApplet) AppleWebKit/601.6 (KHTML, like Gecko) NF/4.0.0.5.9 NintendoBrowser/5.1.0.13341";
 
 
             @Override