Merge pull request #39 from evolvedbinary/sys-props

duncdrum · web-flow · commit 6501b4767bdd · 2021-04-07T09:33:54.000+02:00
Prefer system properties over environment variables for test config
diff --git a/.travis.yml b/.travis.yml
@@ -14,38 +14,33 @@ jobs:
     - name: Linux / FusionDB Server Nightly
       os: linux
       env:
-        - FS_API_PORT=4059
-        - DOCKER_TEST_IMAGE=repo.evolvedbinary.com:9543/evolvedbinary/fusiondb-server:nightly
-      script: mvn verify -Ddocker.username=$FDB_NIGHTLY_DOCKER_USER -Ddocker.password=$FDB_NIGHTLY_DOCKER_PASS -Ddocker.test.port=$FS_API_PORT -Ddocker.test.image=$DOCKER_TEST_IMAGE -B
+        - DOCKER_DB_IMAGE=repo.evolvedbinary.com:9543/evolvedbinary/fusiondb-server:nightly
+      script: mvn verify -Ddocker.username=$FDB_NIGHTLY_DOCKER_USER -Ddocker.password=$FDB_NIGHTLY_DOCKER_PASS -Dapi.port=4059 -Ddocker.db.image=$DOCKER_DB_IMAGE -B
 
     - name: Linux / FusionDB Server 1.0.0-ALPHA3
       os: linux
       env:
-        - FS_API_PORT=4059
-        - DOCKER_TEST_IMAGE=repo.evolvedbinary.com:9443/evolvedbinary/fusiondb-server:1.0.0-ALPHA3
-      script: mvn verify -Ddocker.username=$FDB_DOCKER_USER -Ddocker.password=$FDB_DOCKER_PASS -Ddocker.test.port=$FS_API_PORT -Ddocker.test.image=$DOCKER_TEST_IMAGE -B
+        - DOCKER_DB_IMAGE=repo.evolvedbinary.com:9443/evolvedbinary/fusiondb-server:1.0.0-ALPHA3
+      script: mvn verify -Ddocker.username=$FDB_DOCKER_USER -Ddocker.password=$FDB_DOCKER_PASS -Dapi.port=4059 -Ddocker.db.image=$DOCKER_DB_IMAGE -B
 
     - name: Linux / eXist-db 5.0.0
       os: linux
       env:
-        - FS_API_PORT=8080
-        - DOCKER_TEST_IMAGE=existdb/existdb:5.0.0
+        - DOCKER_DB_IMAGE=existdb/existdb:5.0.0
 
     - name: Linux / eXist-db 5.2.0
       os: linux
       env:
-        - FS_API_PORT=8080
-        - DOCKER_TEST_IMAGE=existdb/existdb:5.2.0
+        - DOCKER_DB_IMAGE=existdb/existdb:5.2.0
 
     - name: Linux / eXist-db Latest
       os: linux
       env:
-        - FS_API_PORT=8080
-        - DOCKER_TEST_IMAGE=existdb/existdb:latest
+        - DOCKER_DB_IMAGE=existdb/existdb:latest
 
 install: mvn install -Ddocker.skip=true -Dexec.skip=true -DskipTests=true -Dmaven.javadoc.skip=true -B -V
 
-script: mvn verify -Ddocker.test.port=$FS_API_PORT -Ddocker.test.image=$DOCKER_TEST_IMAGE -B
+script: mvn verify -Dapi.port=8080 -Ddocker.db.image=$DOCKER_DB_IMAGE -B
 
 cache:
   directories:
diff --git a/README.md b/README.md
@@ -23,3 +23,47 @@ $ mvn clean package
 ```
 
 This will create an EXPath package in `target/fusion-studio-api-x.y.z.xar`, which can be deployed to FusionDB (or eXist-db). 
+
+## Test Instructions
+By default tests are executed against the latest FusionDB nightly build running as a Docker Container.
+For development purposes, it is also possible to execute the tests from an IDE such as IntelliJ against a locally installed FusionDB (or eXist-db) server.
+
+Requirements:
+* Docker
+* Username/Password for accessing the FusionDB nightly build Docker repository.
+
+Various settings of the build can be overridden using the following System Properties and Environment Variables:
+| Purpose | System Property | Environment Variable |
+|---------|-----------------|----------------------|
+| Docker Repo Username | `docker.username` | N/A |
+| Docker Repo Password | `docker.password` | N/A |
+| Docker Database Image | `docker.db.image` | N/A |
+| Host for Fusion Studio API | `api.host` | `API_HOST` |
+| Port for Fusion Studio API | `api.port` | `API_PORT` |
+
+**NOTE:** If you wish to use the FusionDB Nightly Build Docker Container, you must configure your username and password for the
+repository in either your Maven Settings file (`~/.m2/settings.xml`), or provide the values via System Properties (see above).
+For the Maven Settings file, the following should be added to the `<servers>` section:
+```xml
+<server>
+    <id>repo.evolvedbinary.com:9543</id>
+    <username>your-username</username>
+    <password>your-password</password>
+</server>
+```
+
+You can also alternatively test the latest release version of FusionDB by setting the system properties for the Docker image: `repo.evolvedbinary.com:9443/evolvedbinary/fusiondb-server:latest`. 
+
+**NOTE:** If you wish to perform the tests against eXist-db as opposed to FusionDB, you need to set the Docker Image, and then the Host and Port
+for the API via System Properties of Environment Variables, as by default it is configured for FusionDB.
+
+### Running tests with Docker
+Just execute the following:
+```
+$ mvn clean verify
+```
+
+or, if you need to set system properties you can do so like (e.g. for testing against eXist-db 5.2.0):
+```
+$ mvn clean verify -Dapi.port=8080 -Ddocker.db.image=existdb/existdb:5.2.0
+```
diff --git a/pom.xml b/pom.xml
@@ -54,8 +54,9 @@
         <exist.version>5.0.0</exist.version>
 
         <!-- used for integration-test -->
-        <docker.test.image>repo.evolvedbinary.com:9543/evolvedbinary/fusiondb-server:nightly</docker.test.image>
-        <docker.test.port>4059</docker.test.port>
+        <docker.db.image>repo.evolvedbinary.com:9543/evolvedbinary/fusiondb-server:nightly</docker.db.image>
+        <api.host>localhost</api.host>
+        <api.port>4059</api.port>
 
         <!-- used in the EXPath Package Descriptor -->
         <package-name>https://fusiondb.com/studio/api</package-name>
@@ -186,9 +187,11 @@
                     <images>
                         <image>
                             <alias>db-with-api</alias>
-                            <name>${docker.test.image}</name>
+                            <name>${docker.db.image}</name>
                             <run>
-                                <ports>${docker.test.port}:${docker.test.port}</ports>
+                                <ports>
+                                    <port>${api.port}:${api.port}</port>
+                                </ports>
                                 <wait>
                                     <log>Server has started, listening on</log>
                                     <time>120000</time>
@@ -238,7 +241,7 @@
                                 <argument>Content-Type: application/octet-stream</argument>
                                 <argument>--data-binary</argument>
                                 <argument>@${project.build.directory}/${package-final-name}.xar</argument>
-                                <argument>http://admin:@localhost:${docker.test.port}/exist/rest/db/${package-final-name}.xar</argument>
+                                <argument>http://admin:@${api.host}:${api.port}/exist/rest/db/${package-final-name}.xar</argument>
                             </arguments>
                         </configuration>
                     </execution>
@@ -259,7 +262,7 @@
                                 <argument>Content-Type: application/xml</argument>
                                 <argument>--data-binary</argument>
                                 <argument>@${project.build.testOutputDirectory}/deploy-xar.xq.xml</argument>
-                                <argument>http://admin:@localhost:${docker.test.port}/exist/rest/db/</argument>
+                                <argument>http://admin:@${api.host}:${api.port}/exist/rest/db/</argument>
                             </arguments>
                         </configuration>
                     </execution>
@@ -277,6 +280,9 @@
                         <goals>
                             <goal>integration-test</goal>
                         </goals>
+                        <configuration>
+                            <argLine>-Dapi.port=@{api.port}</argLine>
+                        </configuration>
                     </execution>
                     <execution>
                         <id>verify-integration-tests-result</id>
diff --git a/src/test/java/com/fusiondb/studio/api/API.java b/src/test/java/com/fusiondb/studio/api/API.java
@@ -51,34 +51,54 @@ public class API {
      */
     public static String DEFAULT_ENDPOINT = "fusiondb";
 
+    /**
+     * System Property for setting the API Host
+     */
+    public static String SYS_PROP_NAME_API_HOST = "api.host";
+
     /**
      * Environment variable name for setting the API Host
      */
-    public static String ENV_VAR_FS_API_HOST = "FS_API_HOST";
+    public static String ENV_VAR_API_HOST = "API_HOST";
+
+    /**
+     * System Property for setting the API Port
+     */
+    public static String SYS_PROP_NAME_API_PORT = "api.port";
 
     /**
      * Environment variable name for setting the API Port
      */
-    public static String ENV_VAR_FS_API_PORT = "FS_API_PORT";
+    public static String ENV_VAR_API_PORT = "API_PORT";
+
+    /**
+     * System Property for setting the Docker DB Image
+     */
+    public static String SYS_PROP_NAME_DOCKER_DB_IMAGE = "docker.db.image";
 
-    private static String ENV_VAR_DOCKER_TEST_IMAGE = "DOCKER_TEST_IMAGE";
+    /**
+     * Environment Variable for setting the Docker DB Image
+     */
+    private static String ENV_VAR_DOCKER_DB_IMAGE = "DOCKER_DB_IMAGE";
 
     /**
      * Get the Base URI for the Fusion Studio API.
      *
-     * The URI can be overridden by environment variables
-     * see {@link #ENV_VAR_FS_API_HOST} and {@link #ENV_VAR_FS_API_PORT}.
+     * The URI can be overridden by System Properties firstly,
+     * or Environment Variables secondly.
+     * See {@link #SYS_PROP_NAME_API_HOST} {@link #SYS_PROP_NAME_API_PORT}
+     * {@link #ENV_VAR_API_HOST} and {@link #ENV_VAR_API_PORT}.
      *
      * @return the base URI
      */
     public static String getApiBaseUri() {
-        final String host = envVarOrDefault(ENV_VAR_FS_API_HOST, DEFAULT_HOST, envVarValue -> envVarValue);
-        final int port = envVarOrDefault(ENV_VAR_FS_API_PORT, DEFAULT_PORT, envVarValue -> {
+        final String host = sysPropOrEnvVarOrDefault(SYS_PROP_NAME_API_HOST, ENV_VAR_API_HOST, DEFAULT_HOST, envVarValue -> envVarValue);
+        final int port = sysPropOrEnvVarOrDefault(SYS_PROP_NAME_API_PORT, ENV_VAR_API_PORT, DEFAULT_PORT, envVarValue -> {
             try {
                 return Integer.parseInt(envVarValue);
             } catch (final NumberFormatException e) {
                 // invalid number
-                System.err.println("ENV.FS_API_PORT=" + envVarValue + ", is not a valid TCP port number. Using default: " + DEFAULT_PORT);
+                System.err.println("Port " + envVarValue + " is not a valid TCP port number. Using default: " + DEFAULT_PORT);
                 e.printStackTrace();
                 return DEFAULT_PORT;
             }
@@ -90,19 +110,21 @@ public static String getApiBaseUri() {
     /**
      * Get the Base URI for the eXist-db REST API.
      *
-     * The URI can be overridden by environment variables
-     * see {@link #ENV_VAR_FS_API_HOST} and {@link #ENV_VAR_FS_API_PORT}.
+     * The URI can be overridden by System Properties firstly,
+     * or Environment Variables secondly.
+     * See {@link #SYS_PROP_NAME_API_HOST} {@link #SYS_PROP_NAME_API_PORT}
+     * {@link #ENV_VAR_API_HOST} and {@link #ENV_VAR_API_PORT}.
      *
      * @return the REST base URI
      */
     public static String getRestApiBaseUri() {
-        final String host = envVarOrDefault(ENV_VAR_FS_API_HOST, DEFAULT_HOST, envVarValue -> envVarValue);
-        final int port = envVarOrDefault(ENV_VAR_FS_API_PORT, DEFAULT_PORT, envVarValue -> {
+        final String host = sysPropOrEnvVarOrDefault(SYS_PROP_NAME_API_HOST, ENV_VAR_API_HOST, DEFAULT_HOST, envVarValue -> envVarValue);
+        final int port = sysPropOrEnvVarOrDefault(SYS_PROP_NAME_API_PORT, ENV_VAR_API_PORT, DEFAULT_PORT, envVarValue -> {
             try {
                 return Integer.parseInt(envVarValue);
             } catch (final NumberFormatException e) {
                 // invalid number
-                System.err.println("ENV.FS_API_PORT=" + envVarValue + ", is not a valid TCP port number. Using default: " + DEFAULT_PORT);
+                System.err.println("Port " + envVarValue + " is not a valid TCP port number. Using default: " + DEFAULT_PORT);
                 e.printStackTrace();
                 return DEFAULT_PORT;
             }
@@ -131,6 +153,48 @@ private static <T> T envVarOrDefault(final String envVarName, final T defaultVal
         }
     }
 
+    /**
+     * Gets a value from a System Property or uses the default
+     * if there is no such variable.
+     *
+     * @param sysPropName the name of the system property.
+     * @param defaultValue the default value to use if there is no system property
+     * @param typeConverter a function for converting the value of the system
+     *     property (if present) to the desired type
+     *
+     * @return the value from the system property, or the default value
+     */
+    private static <T> T sysPropOrDefault(final String sysPropName, final T defaultValue, final Function<String, T> typeConverter) {
+        final String sysPropValue = System.getProperty(sysPropName);
+        if (sysPropValue != null && !sysPropValue.isEmpty()) {
+            return typeConverter.apply(sysPropValue);
+        } else {
+            return defaultValue;
+        }
+    }
+
+    /**
+     * Gets a value from a System Property, or an Environment Variable if there
+     * is not such system property. If there is no environment variable, then
+     * the default value is returned.
+     *
+     * @param sysPropName the name of the system property.
+     * @param envVarName the name of the environment variable if there is no system property.
+     * @param defaultValue the default value to use if there is no system property or environment variable.
+     * @param typeConverter a function for converting the value of the system
+     *     property or environment variable (if present) to the desired type
+     *
+     * @return the value from the system property, environment variable, or the default value
+     */
+    private static <T> T sysPropOrEnvVarOrDefault(final String sysPropName, final String envVarName,
+            final T defaultValue, final Function<String, T> typeConverter) {
+        final T sysPropValue = sysPropOrDefault(sysPropName, null, typeConverter);
+        if (sysPropValue != null) {
+            return sysPropValue;
+        }
+        return envVarOrDefault(envVarName, defaultValue, typeConverter);
+    }
+
     static <K, V> Map<K, V> mapOf(final Tuple2<K, V>... entries) {
         if (entries == null) {
             return Collections.emptyMap();
@@ -157,7 +221,7 @@ static <K, V>  Map<K, V>[] arrayOf(final Map<K, V>... entries) {
     }
 
     static boolean testServerHasBadJsonSerialization() {
-        final String dockerTestImage = envVarOrDefault(ENV_VAR_DOCKER_TEST_IMAGE, null, envVarValue -> envVarValue);
+        final String dockerTestImage = sysPropOrEnvVarOrDefault(SYS_PROP_NAME_DOCKER_DB_IMAGE, ENV_VAR_DOCKER_DB_IMAGE, null, envVarValue -> envVarValue);
         if (dockerTestImage == null || dockerTestImage.isEmpty()) {
             return false;
         }
@@ -168,7 +232,7 @@ static boolean testServerHasBadJsonSerialization() {
     }
 
     static boolean testServerHasBadXmldbSetMimeType() {
-        final String dockerTestImage = envVarOrDefault(ENV_VAR_DOCKER_TEST_IMAGE, null, envVarValue -> envVarValue);
+        final String dockerTestImage = sysPropOrEnvVarOrDefault(SYS_PROP_NAME_DOCKER_DB_IMAGE, ENV_VAR_DOCKER_DB_IMAGE, null, envVarValue -> envVarValue);
         if (dockerTestImage == null || dockerTestImage.isEmpty()) {
             return false;
         }
