#279 Improve database.properties configuration for tests

Author: Igor Polevoy

activeweb/src/main/java/org/javalite/activeweb/AbstractDBConfig.java

@@ -145,9 +145,7 @@ public void configFile(String file) {
                     String userName = props.getProperty(env + ".username");
                     String password = props.getProperty(env + ".password");
                     String url = props.getProperty(env + ".url");
-                    if (driver == null || userName == null || password == null || url == null) {
-                        throw new InitException("Four JDBC properties are expected: driver, username, password, url for environment: " + env);
-                    }
+                    checkProps(driver, userName, password, url, env);
                     createJdbcWrapper(env, driver, url, userName, password);
                 }
             }
@@ -158,11 +156,20 @@ public void configFile(String file) {
         }
     }
 
+    private void checkProps(String driver, String userName, String password, String url, String env){
+        if (driver == null || userName == null || password == null || url == null){
+            throw new InitException("Four JDBC properties are expected: driver, username, password, url for environment: " + env);
+        }
+    }
+
     private void createJdbcWrapper(String env, String driver, String url, String userName, String password) {
         ConnectionSpecWrapper wrapper = new ConnectionSpecWrapper();
         if(env.equals("test")){
             wrapper.setEnvironment("development");
             wrapper.setTesting(true);
+        } else if(env.endsWith(".test")) {
+            wrapper.setEnvironment(env.split("\\.")[0]);
+            wrapper.setTesting(true);
         }else{
             wrapper.setEnvironment(env);
         }
@@ -181,12 +188,18 @@ private void createJndiWrapper(String env, String jndiName) {
 
 
     private Set<String> getEnvironments(Properties props) {
-        Set<String> environments = new HashSet<String>();
-        for (Object k : props.keySet()) {
-            String environment = k.toString().split("\\.")[0];
-            environments.add(environment);
+        Set<String> environments = new HashSet<>();
+        for (String prop : props.stringPropertyNames()) {
+            String[] parts =  prop.split("\\.");
+            if(parts.length == 2){
+                environments.add(parts[0]);
+            }else if(parts.length == 3 && parts[1].equals("test")){
+                environments.add(parts[0] + ".test");
+            }else {
+                throw new ConfigurationException("Incorrect property: " + prop);
+            }
         }
-        return new TreeSet<String>(environments);
+        return environments;
     }
 
     private Properties readPropertyFile(String file) throws IOException {

activeweb/src/main/java/org/javalite/activeweb/Configuration.java

@@ -39,10 +39,9 @@ enum Params {
         freeMarkerConfig, route_config, maxUploadSize
     }
 
-    private static final Configuration instance = new Configuration();
     private static Properties props = new Properties();
     private static TemplateManager templateManager;
-    private static HashMap<String, List<ConnectionSpecWrapper>> connectionWrappers = new HashMap<String, List<ConnectionSpecWrapper>>();
+    private static HashMap<String, List<ConnectionSpecWrapper>> connectionWrappers = new HashMap<>();
     private static boolean testing = false;
     private static String ENV;
     private static boolean activeReload = !blank(System.getProperty("active_reload")) && System.getProperty("active_reload").equals("true");
@@ -254,7 +253,7 @@ protected static void addConnectionWrapper(ConnectionSpecWrapper connectionWrapp
         String connectionWrapperEnv = connectionWrapper.getEnvironment();
         List<ConnectionSpecWrapper> envConnectionWrappers = connectionWrappers.get(connectionWrapperEnv);
         if(envConnectionWrappers == null || override) {
-            envConnectionWrappers = new ArrayList<ConnectionSpecWrapper>();
+            envConnectionWrappers = new ArrayList<>();
             connectionWrappers.put(connectionWrapperEnv, envConnectionWrappers);
         }
         envConnectionWrappers.add(connectionWrapper);
@@ -286,7 +285,7 @@ protected static void clearConnectionWrappers() {
 
     //for tests only
     protected static void resetConnectionWrappers() {
-        connectionWrappers = new HashMap<String, List<ConnectionSpecWrapper>>();
+        connectionWrappers = new HashMap<>();
     }
 
     protected static void clearConnectionWrappers(String env) {
@@ -306,6 +305,4 @@ public static File getTmpDir() {
         return new File(System.getProperty("java.io.tmpdir"));
     }
 
-    private static List<IgnoreSpec> ignoreSpecs = new ArrayList<IgnoreSpec>();
-
 }

activeweb/src/test/java/org/javalite/activeweb/AbstractConnectionBuilderSpec.java

@@ -135,7 +135,7 @@ public void shouldOverrideConnectionSpecForTheSameEnvironment(){
 
         class DBConfig extends AbstractDBConfig{
             public void init(AppContext appContext) {
-                configFile("/database_new.properties");
+                configFile("/database1.properties");
                 environment("production", true).jndi("java:comp/env/jdbc/prod_new");
             }
         }
@@ -145,10 +145,51 @@ public void init(AppContext appContext) {
 
         List<ConnectionSpecWrapper> wrappers = Configuration.getConnectionSpecWrappers("production");
 
-        //we configured two, one in file, one in class. But the class config overrides one in file.
+        //we configured two for production, one in file, one in class. But the class config overrides one in file.
         the(wrappers.size()).shouldBeEqual(1);
 
         ConnectionJndiSpec connectionSpec = (ConnectionJndiSpec)  wrappers.get(0).getConnectionSpec();
         the(connectionSpec.getDataSourceJndiName()).shouldBeEqual("java:comp/env/jdbc/prod_new");
     }
+
+
+    /**
+     * This feature is needed because often times, you have different configuration locally vs another
+     * environment where you need to run tests. It is possible to achieve with Maven profiles, but kind of hacky.
+     * Example: development env requires to connect to localhost. Jenkins when running tests, requires to connect to jenkins_db host.
+     * This feature is not specific to Jenkins :)
+     *
+     * The new solution is clean.
+     */
+    @Test
+    public void should_configure_different_test_configs_for_development_and_jenkins(){
+
+        class DBConfig extends AbstractDBConfig{
+            public void init(AppContext appContext) {
+                configFile("/database2.properties");
+            }
+        }
+
+        DBConfig config = new DBConfig();
+        config.init(null);
+
+        List<ConnectionSpecWrapper> wrappers = Configuration.getConnectionSpecWrappers("development");
+
+        the(wrappers.size()).shouldBeEqual(2);
+
+
+        ConnectionSpecWrapper dev = null;
+        ConnectionSpecWrapper test = null;
+
+        //have to do this because the order of specs is not deterministic
+        for (ConnectionSpecWrapper connectionSpecWrapper : wrappers) {
+            if(connectionSpecWrapper.isTesting()){
+                test = connectionSpecWrapper;
+            }else {
+                dev = connectionSpecWrapper;
+            }
+        }
+        the(((ConnectionJdbcSpec)test.getConnectionSpec()).getUrl()).shouldBeEqual("jdbc:mysql://localhost/test");
+        the(((ConnectionJdbcSpec)dev.getConnectionSpec()).getUrl()).shouldBeEqual("jdbc:mysql://localhost/dev");
+    }
 }

activeweb/src/test/resources/database_new.properties renamed to activeweb/src/test/resources/database1.properties

@@ -0,0 +1,20 @@
+development.driver=com.mysql.jdbc.Driver
+development.username=localdev
+development.password=pwd
+development.url=jdbc:mysql://localhost/dev
+
+
+development.test.driver=com.mysql.jdbc.Driver
+development.test.username=localtest
+development.test.password=pwd1
+development.test.url=jdbc:mysql://localhost/test
+
+jenkins.test.driver=com.mysql.jdbc.Driver
+jenkins.test.username=jenkins
+jenkins.test.password=pwd1
+jenkins.test.url=jdbc:mysql://localhost/test_jenkins
+
+production.driver=com.mysql.jdbc.Driver
+production.username=mary
+production.password=pwd1
+production.url=jdbc:mysql://localhost/prod