Fix bug with invalid cast while reading non-string setting variables which we override via environment (#41)

Fixed #40 bug in JsonSettingsFile with invalid cast while reading non-string setting variables which we override via environment

Author: mialeska

pom.xml

@@ -5,7 +5,7 @@
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.github.aquality-automation</groupId>
     <artifactId>aquality-selenium-core</artifactId>
-    <version>0.0.2</version>
+    <version>0.0.3</version>
     <packaging>jar</packaging>
     <name>Aquality Selenium Core</name>
     <description>Library with core functions simplifying work with Selenium-controlled applications.</description>

src/main/java/aquality/selenium/core/utilities/JsonSettingsFile.java

@@ -33,20 +33,29 @@ public Object getValue(String jsonPath) {
 
     private Object getEnvValueOrDefault(String jsonPath, boolean throwIfEmpty) {
         String envVar = getEnvValue(jsonPath);
-        if (envVar == null) {
-            JsonNode node = getJsonNode(jsonPath, throwIfEmpty);
-            if (node.isBoolean()) {
-                return node.asBoolean();
-            } else if (node.isLong()) {
-                return node.asLong();
-            } else if (node.isInt()) {
-                return node.asInt();
-            } else {
-                return node.asText();
-            }
-        }
+        JsonNode node = getJsonNode(jsonPath, throwIfEmpty && envVar == null);
+        return !node.isMissingNode()
+                ? castEnvOrDefaulValue(node, envVar)
+                : envVar;
+    }
 
-        return envVar;
+    /**
+     * Casts envVar to type, defined from JsonNode.
+     *
+     * @param node   node from json file
+     * @param envVar value got from environment variable
+     * @return Value, casted to specific type.
+     */
+    private Object castEnvOrDefaulValue(JsonNode node, String envVar) {
+        if (node.isBoolean()) {
+            return envVar == null ? node.asBoolean() : Boolean.parseBoolean(envVar);
+        } else if (node.isLong()) {
+            return envVar == null ? node.asLong() : Long.parseLong(envVar);
+        } else if (node.isInt()) {
+            return envVar == null ? node.asInt() : Integer.parseInt(envVar);
+        } else {
+            return envVar == null ? node.asText() : envVar;
+        }
     }
 
     private String getEnvValue(String jsonPath) {
@@ -109,7 +118,7 @@ private String getFileContent(String filename) {
 
     @Override
     public boolean isValuePresent(String path) {
-        String value = getEnvValueOrDefault(path, false).toString().trim();
-        return !value.isEmpty();
+        Object value = getEnvValueOrDefault(path, false);
+        return value != null && !value.toString().trim().isEmpty();
     }
 }

src/test/java/tests/utilities/SettingsFileTests.java

@@ -12,16 +12,19 @@
 import tests.configurations.BaseProfileTest;
 
 import java.util.*;
+import java.util.function.BooleanSupplier;
 import java.util.function.Consumer;
 
 import static org.testng.Assert.*;
 
 public class SettingsFileTests extends BaseProfileTest {
     private static final String TIMEOUT_POLLING_INTERVAL_PATH = "/timeouts/timeoutPollingInterval";
     private static final String NULLVALUE_PATH = "/nullValue";
+    private static final String ABSENTVALUE_PATH = "/absentvalue";
     private static final String TIMEOUT_POLLING_INTERVAL_KEY = "timeouts.timeoutPollingInterval";
     private static final String LANGUAGE_ENV_KEY = "logger.language";
     private static final String ARGUMENTS_ENV_KEY = "arguments.start";
+    private static final String BOOLEANVALUE_ENV_KEY = "booleanValue";
     private static final String PROFILE = "jsontest";
     private static final String FILE_NAME = String.format("settings.%s.json", PROFILE);
     private ISettingsFile jsonSettingsFile;
@@ -36,6 +39,24 @@ public void before() {
         jsonSettingsFile = CustomAqualityServices.getServiceProvider().getInstance(ISettingsFile.class);
     }
 
+    @Test
+    public void testShouldBePossibleToOverrideBooleanValueViaEnvironmentVariable() {
+        BooleanSupplier getCurrentValue = () -> (Boolean) jsonSettingsFile.getValue("/".concat(BOOLEANVALUE_ENV_KEY));
+        boolean oldValue = getCurrentValue.getAsBoolean();
+        boolean targetValue = !oldValue;
+        System.setProperty(BOOLEANVALUE_ENV_KEY, String.valueOf(targetValue));
+        assertEquals(getCurrentValue.getAsBoolean(), targetValue, "value passed via env var is not used by SettingsFile");
+    }
+
+    @Test
+    public void testShouldBePossibleToSetValueWhichIsAbsentInJsonFile() {
+        Assert.assertFalse(jsonSettingsFile.isValuePresent(ABSENTVALUE_PATH), "value should be absent by default");
+        String targetValue = String.valueOf(true);
+        System.setProperty(ABSENTVALUE_PATH.substring(1), targetValue);
+        Assert.assertTrue(jsonSettingsFile.isValuePresent(ABSENTVALUE_PATH), "value should be present after set");
+        assertEquals(jsonSettingsFile.getValue(ABSENTVALUE_PATH), targetValue, "value passed via env var is not used by SettingsFile");
+    }
+
     @Test
     public void testShouldBePossibleToGetDefaultContent() {
         System.clearProperty(PROFILE_KEY);

src/test/resources/settings.jsontest.json

@@ -15,5 +15,6 @@
   "arguments": {
     "start": ["first","second"]
   },
-  "nullValue": null
+  "nullValue": null,
+  "booleanValue": true
 }