Merge pull request #155 from sherfert/1.2-database-env-var

Use NEO4J_DATABASE environment variable as the default.

Author: sherfert

build.gradle

@@ -77,4 +77,5 @@ ext {
     jansiVersion = '1.13'
     jlineVersion = '2.14.6'
     mockitoVersion = '1.9.5'
+    systemRulesVersion = '1.19.0'
 }

cypher-shell/build.gradle

@@ -46,5 +46,6 @@ dependencies {
     }
     testCompile "junit:junit:$junitVersion"
     testCompile "org.mockito:mockito-core:$mockitoVersion"
+    testCompile "com.github.stefanbirkner:system-rules:$systemRulesVersion"
     testCompileOnly "com.google.code.findbugs:annotations:$findbugsVersion"
 }

cypher-shell/src/main/java/org/neo4j/shell/ConnectionConfig.java

@@ -1,10 +1,12 @@
 package org.neo4j.shell;
 
-import org.neo4j.driver.Config;
-
 import javax.annotation.Nonnull;
 
 public class ConnectionConfig {
+    public static final String USERNAME_ENV_VAR = "NEO4J_USERNAME";
+    public static final String PASSWORD_ENV_VAR = "NEO4J_PASSWORD";
+    public static final String DATABASE_ENV_VAR = "NEO4J_DATABASE";
+
     private final String scheme;
     private final String host;
     private final int port;
@@ -13,23 +15,27 @@ public class ConnectionConfig {
     private String password;
     private String database;
 
-    public ConnectionConfig(@Nonnull String scheme, @Nonnull String host, int port,
-                            @Nonnull String username, @Nonnull String password, boolean encryption,
+    public ConnectionConfig(@Nonnull String scheme,
+                            @Nonnull String host,
+                            int port,
+                            @Nonnull String username,
+                            @Nonnull String password,
+                            boolean encryption,
                             @Nonnull String database) {
         this.host = host;
         this.port = port;
-        this.username = fallbackToEnvVariable(username, "NEO4J_USERNAME");
-        this.password = fallbackToEnvVariable(password, "NEO4J_PASSWORD");
+        this.username = fallbackToEnvVariable(username, USERNAME_ENV_VAR);
+        this.password = fallbackToEnvVariable(password, PASSWORD_ENV_VAR);
         this.encryption = encryption;
         this.scheme = scheme;
-        this.database = database;
+        this.database = fallbackToEnvVariable(database, DATABASE_ENV_VAR);
     }
 
     /**
      * @return preferredValue if not empty, else the contents of the fallback environment variable
      */
     @Nonnull
-    static String fallbackToEnvVariable(@Nonnull String preferredValue, @Nonnull String fallbackEnvVar) {
+    private static String fallbackToEnvVariable(@Nonnull String preferredValue, @Nonnull String fallbackEnvVar) {
         String result = System.getenv(fallbackEnvVar);
         if (result == null || !preferredValue.isEmpty()) {
             result = preferredValue;

cypher-shell/src/main/java/org/neo4j/shell/cli/CliArgHelper.java

@@ -13,6 +13,8 @@
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 
+import org.neo4j.shell.ConnectionConfig;
+
 import static java.lang.String.format;
 import static org.neo4j.shell.cli.FailBehavior.FAIL_AT_END;
 import static org.neo4j.shell.cli.FailBehavior.FAIL_FAST;
@@ -129,17 +131,17 @@ private static ArgumentParser setupParser()
                 .setDefault("bolt://localhost:7687");
         connGroup.addArgument("-u", "--username")
                 .setDefault("")
-                .help("username to connect as. Can also be specified using environment variable NEO4J_USERNAME");
+                .help("username to connect as. Can also be specified using environment variable " + ConnectionConfig.USERNAME_ENV_VAR);
         connGroup.addArgument("-p", "--password")
                 .setDefault("")
-                .help("password to connect with. Can also be specified using environment variable NEO4J_PASSWORD");
+                .help("password to connect with. Can also be specified using environment variable " + ConnectionConfig.PASSWORD_ENV_VAR);
         connGroup.addArgument("--encryption")
                 .help("whether the connection to Neo4j should be encrypted; must be consistent with Neo4j's " +
                         "configuration")
                 .type(new BooleanArgumentType())
                 .setDefault(true);
         connGroup.addArgument("-d", "--database")
-                .help("database to connect to")
+                .help("database to connect to. Can also be specified using environment variable " + ConnectionConfig.DATABASE_ENV_VAR)
                 .setDefault("");
 
         MutuallyExclusiveGroup failGroup = parser.addMutuallyExclusiveGroup();

cypher-shell/src/test/java/org/neo4j/shell/ConnectionConfigTest.java

@@ -1,5 +1,6 @@
 package org.neo4j.shell;
 
+import org.junit.Rule;
 import org.junit.Test;
 import org.neo4j.shell.log.Logger;
 
@@ -9,38 +10,74 @@
 import static org.mockito.Mockito.mock;
 import static org.neo4j.driver.internal.messaging.request.MultiDatabaseUtil.ABSENT_DB_NAME;
 
+import org.junit.contrib.java.lang.system.EnvironmentVariables;
+
 public class ConnectionConfigTest {
+
+    @Rule
+    public final EnvironmentVariables environmentVariables
+            = new EnvironmentVariables();
+
     private Logger logger = mock(Logger.class);
     private ConnectionConfig config = new ConnectionConfig("bolt://", "localhost", 1, "bob",
-            "pass", false, ABSENT_DB_NAME);
+            "pass", false, "db");
+
 
     @Test
-    public void scheme() throws Exception {
+    public void scheme() {
         assertEquals("bolt://", config.scheme());
     }
 
     @Test
-    public void host() throws Exception {
+    public void host() {
         assertEquals("localhost", config.host());
     }
 
     @Test
-    public void port() throws Exception {
+    public void port() {
         assertEquals(1, config.port());
     }
 
     @Test
-    public void username() throws Exception {
+    public void username() {
         assertEquals("bob", config.username());
     }
 
     @Test
-    public void password() throws Exception {
+    public void usernameDefaultsToEnvironmentVar() {
+        environmentVariables.set(ConnectionConfig.USERNAME_ENV_VAR, "alice");
+        ConnectionConfig configWithEmptyParams = new ConnectionConfig("bolt://", "localhost", 1, "",
+                                                                      "", false, ABSENT_DB_NAME);
+        assertEquals("alice", configWithEmptyParams.username());
+    }
+
+    @Test
+    public void password() {
         assertEquals("pass", config.password());
     }
 
     @Test
-    public void driverUrlDefaultScheme() throws Exception {
+    public void passwordDefaultsToEnvironmentVar() {
+        environmentVariables.set(ConnectionConfig.PASSWORD_ENV_VAR, "ssap");
+        ConnectionConfig configWithEmptyParams = new ConnectionConfig("bolt://", "localhost", 1, "",
+                                                                      "", false, ABSENT_DB_NAME);
+        assertEquals("ssap", configWithEmptyParams.password());
+    }
+
+    @Test
+    public void database() {
+        assertEquals("db", config.database());
+    }
+
+    @Test
+    public void databaseDefaultsToEnvironmentVar() {
+        environmentVariables.set(ConnectionConfig.DATABASE_ENV_VAR, "funnyDB");
+        ConnectionConfig configWithEmptyParams = new ConnectionConfig("bolt://", "localhost", 1, "",
+                                                                      "", false, ABSENT_DB_NAME);
+        assertEquals("funnyDB", configWithEmptyParams.database());
+    }
+    @Test
+    public void driverUrlDefaultScheme() {
         assertEquals("bolt://localhost:1", config.driverUrl());
     }