Make the configuration more testable

Author: jeffgbutler

src/main/java/org/mybatis/dynamic/sql/configuration/GlobalConfiguration.java

@@ -19,29 +19,51 @@
 import java.io.InputStream;
 import java.util.Properties;
 
-// TODO - read initial value from a properties file!
 public class GlobalConfiguration {
-    private static boolean isNonRenderingWhereClauseAllowed = false;
-
-    private GlobalConfiguration() {}
-
-    static {
-        String propertyFile = "mybatis-dynamic-sql.properties";
-        try (InputStream is = GlobalConfiguration.class.getResourceAsStream(propertyFile)) {
-            if (is != null) {
-                Properties p = new Properties();
-                p.load(is);
-                String value = p.getProperty("nonRenderingWhereClauseAllowed");
-                if (value != null) {
-                    isNonRenderingWhereClauseAllowed = Boolean.parseBoolean(value);
-                }
-            }
+    public static final String CONFIGURATION_FILE_PROPERTY = "mybatis-dynamic-sql.configurationFile"; //$NON-NLS-1$
+    private static final String DEFAULT_PROPERTY_FILE = "mybatis-dynamic-sql.properties"; //$NON-NLS-1$
+    private boolean isNonRenderingWhereClauseAllowed = false;
+    private final Properties properties = new Properties();
+
+    public GlobalConfiguration() {
+        initialize();
+    }
+
+    private void initialize() {
+        initializeProperties();
+        initializeNonRenderingWhereClauseAllowed();
+    }
+
+    private void initializeProperties(){
+        InputStream inputStream = this.getClass().getClassLoader().getResourceAsStream(getConfigurationFileName());
+        if (inputStream != null) {
+            loadProperties(inputStream);
+        }
+    }
+
+    private String getConfigurationFileName() {
+        String property = System.getProperty(CONFIGURATION_FILE_PROPERTY);
+        if (property == null) {
+            return DEFAULT_PROPERTY_FILE;
+        } else {
+            return property;
+        }
+    }
+
+    private void loadProperties(InputStream inputStream) {
+        try {
+            properties.load(inputStream);
         } catch (IOException e) {
-            // ignore
+            throw new RuntimeException(e);
         }
     }
 
-    public static boolean isIsNonRenderingWhereClauseAllowed() {
+    private void initializeNonRenderingWhereClauseAllowed() {
+        String value = properties.getProperty("nonRenderingWhereClauseAllowed", "false"); //$NON-NLS-1$ //$NON-NLS-2$
+        isNonRenderingWhereClauseAllowed = Boolean.parseBoolean(value);
+    }
+
+    public boolean isIsNonRenderingWhereClauseAllowed() {
         return isNonRenderingWhereClauseAllowed;
     }
 }

src/main/java/org/mybatis/dynamic/sql/configuration/GlobalContext.java

@@ -0,0 +1,29 @@
+/*
+ *    Copyright 2016-2022 the original author or authors.
+ *
+ *    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 org.mybatis.dynamic.sql.configuration;
+
+public class GlobalContext {
+
+    private static final GlobalContext instance = new GlobalContext();
+
+    private final GlobalConfiguration globalConfiguration = new GlobalConfiguration();
+
+    private GlobalContext() {}
+
+    public static GlobalConfiguration getConfiguration() {
+        return instance.globalConfiguration;
+    }
+}

src/main/java/org/mybatis/dynamic/sql/configuration/StatementConfiguration.java

@@ -39,7 +39,8 @@
  * @author Jeff Butler
  */
 public class StatementConfiguration {
-    private boolean isNonRenderingWhereClauseAllowed = GlobalConfiguration.isIsNonRenderingWhereClauseAllowed();
+    private boolean isNonRenderingWhereClauseAllowed =
+            GlobalContext.getConfiguration().isIsNonRenderingWhereClauseAllowed();
 
     public boolean isNonRenderingWhereClauseAllowed() {
         return isNonRenderingWhereClauseAllowed;

src/test/java/org/mybatis/dynamic/sql/configuration/GlobalConfigurationTest.java

@@ -0,0 +1,49 @@
+/*
+ *    Copyright 2016-2022 the original author or authors.
+ *
+ *    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 org.mybatis.dynamic.sql.configuration;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import org.junit.jupiter.api.Test;
+
+class GlobalConfigurationTest {
+    @Test
+    void testAlternateConfigurationFileChangesDefaults() {
+        System.setProperty(GlobalConfiguration.CONFIGURATION_FILE_PROPERTY, "defaultTrue.properties");
+        GlobalConfiguration configuration = new GlobalConfiguration();
+        System.clearProperty(GlobalConfiguration.CONFIGURATION_FILE_PROPERTY);
+
+        assertThat(configuration.isIsNonRenderingWhereClauseAllowed()).isTrue();
+    }
+
+    @Test
+    void testMissingPropertyUsesDefaults() {
+        System.setProperty(GlobalConfiguration.CONFIGURATION_FILE_PROPERTY, "empty.properties");
+        GlobalConfiguration configuration = new GlobalConfiguration();
+        System.clearProperty(GlobalConfiguration.CONFIGURATION_FILE_PROPERTY);
+
+        assertThat(configuration.isIsNonRenderingWhereClauseAllowed()).isFalse();
+    }
+
+    @Test
+    void testMissingPropertyFileUsesDefaults() {
+        System.setProperty(GlobalConfiguration.CONFIGURATION_FILE_PROPERTY, "apfbsglf.properties");
+        GlobalConfiguration configuration = new GlobalConfiguration();
+        System.clearProperty(GlobalConfiguration.CONFIGURATION_FILE_PROPERTY);
+
+        assertThat(configuration.isIsNonRenderingWhereClauseAllowed()).isFalse();
+    }
+}

src/test/resources/defaultTrue.properties

@@ -0,0 +1,17 @@
+#
+#    Copyright 2016-2022 the original author or authors.
+#
+#    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.
+#
+
+nonRenderingWhereClauseAllowed=true

src/test/resources/empty.properties

@@ -0,0 +1,17 @@
+#
+#    Copyright 2016-2022 the original author or authors.
+#
+#    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.
+#
+
+# intentionally empty for testing!

src/test/resources/mybatis-dynamic-sql.properties

@@ -0,0 +1,17 @@
+#
+#    Copyright 2016-2022 the original author or authors.
+#
+#    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.
+#
+
+nonRenderingWhereClauseAllowed=false