Merge pull request #142 from henriknyman/2.0-use-database

Support database selection with 2.x driver

Author: henriknyman

build.gradle

@@ -72,7 +72,7 @@ ext {
     argparse4jVersion = '0.7.0'
     junitVersion = '4.12'
     evaluatorVersion = '3.5.4'
-    neo4jJavaDriverVersion = '1.7.0'
+    neo4jJavaDriverVersion = '2.0.0-alpha01'
     findbugsVersion = '3.0.0'
     jansiVersion = '1.13'
     jlineVersion = '2.14.6'

cypher-shell/src/integration-test/java/org/neo4j/shell/MainIntegrationTest.java

@@ -40,7 +40,8 @@ public void connectInteractivelyPromptsOnWrongAuthentication() throws Exception
                 cliArgs.getPort(),
                 cliArgs.getUsername(),
                 cliArgs.getPassword(),
-                cliArgs.getEncryption());
+                cliArgs.getEncryption(),
+                cliArgs.getDatabase());
 
         CypherShell shell = new CypherShell(logger, prettyConfig);
 

cypher-shell/src/integration-test/java/org/neo4j/shell/commands/CypherShellFailureIntegrationTest.java

@@ -5,14 +5,17 @@
 import org.junit.Rule;
 import org.junit.Test;
 import org.junit.rules.ExpectedException;
-import org.neo4j.driver.v1.exceptions.AuthenticationException;
+
+import org.neo4j.driver.exceptions.AuthenticationException;
 import org.neo4j.shell.ConnectionConfig;
 import org.neo4j.shell.CypherShell;
 import org.neo4j.shell.StringLinePrinter;
 import org.neo4j.shell.cli.Format;
 import org.neo4j.shell.exception.CommandException;
 import org.neo4j.shell.prettyprint.PrettyConfig;
 
+import static org.neo4j.driver.internal.messaging.request.MultiDatabaseUtil.ABSENT_DB_NAME;
+
 public class CypherShellFailureIntegrationTest {
     @Rule
     public final ExpectedException thrown = ExpectedException.none();
@@ -28,9 +31,9 @@ public void setUp() throws Exception {
 
     @Test
     public void cypherWithNoPasswordShouldReturnValidError() throws CommandException {
-        thrown.expect( AuthenticationException.class );
+        thrown.expect(AuthenticationException.class);
         thrown.expectMessage("The client is unauthorized due to authentication failure.");
 
-        shell.connect(new ConnectionConfig("bolt://", "localhost", 7687, "neo4j", "", true));
+        shell.connect(new ConnectionConfig("bolt://", "localhost", 7687, "neo4j", "", true, ABSENT_DB_NAME));
     }
 }

cypher-shell/src/integration-test/java/org/neo4j/shell/commands/CypherShellMultiDatabaseIntegrationTest.java

@@ -0,0 +1,94 @@
+package org.neo4j.shell.commands;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.ExpectedException;
+
+import org.neo4j.driver.exceptions.ClientException;
+import org.neo4j.shell.ConnectionConfig;
+import org.neo4j.shell.CypherShell;
+import org.neo4j.shell.StringLinePrinter;
+import org.neo4j.shell.cli.Format;
+import org.neo4j.shell.exception.CommandException;
+import org.neo4j.shell.prettyprint.PrettyConfig;
+
+import static org.hamcrest.CoreMatchers.is;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.junit.Assume.assumeTrue;
+import static org.neo4j.driver.internal.messaging.request.MultiDatabaseUtil.ABSENT_DB_NAME;
+import static org.neo4j.shell.DatabaseManager.DEFAULT_DEFAULT_DB_NAME;
+import static org.neo4j.shell.DatabaseManager.SYSTEM_DB_NAME;
+import static org.neo4j.shell.Versions.majorVersion;
+
+public class CypherShellMultiDatabaseIntegrationTest
+{
+    @Rule
+    public final ExpectedException thrown = ExpectedException.none();
+
+    private StringLinePrinter linePrinter = new StringLinePrinter();
+    private Command useCommand;
+    private Command beginCommand;
+    private Command rollbackCommand;
+    private CypherShell shell;
+
+    @Before
+    public void setUp() throws Exception {
+        linePrinter.clear();
+        shell = new CypherShell(linePrinter, new PrettyConfig(Format.PLAIN, true, 1000));
+        useCommand = new Use(shell);
+        beginCommand = new Begin(shell);
+        rollbackCommand = new Rollback(shell);
+
+        shell.connect(new ConnectionConfig("bolt://", "localhost", 7687, "neo4j", "neo", true, ABSENT_DB_NAME));
+
+        // Multiple databases are only available from 4.0
+        assumeTrue( majorVersion( shell.getServerVersion() ) >= 4 );
+    }
+
+    @After
+    public void tearDown() throws Exception {
+    }
+
+    @Test
+    public void switchingToSystemDatabaseWorks() throws CommandException {
+        useCommand.execute(SYSTEM_DB_NAME);
+
+        assertThat(linePrinter.output(), is(""));
+    }
+
+    @Test
+    public void switchingToSystemDatabaseAndBackToDefaultWorks() throws CommandException {
+        useCommand.execute(SYSTEM_DB_NAME);
+        useCommand.execute(DEFAULT_DEFAULT_DB_NAME);
+
+        assertThat(linePrinter.output(), is(""));
+    }
+
+    @Test
+    public void switchingDatabaseInOpenTransactionShouldFail() throws CommandException {
+        thrown.expect(CommandException.class);
+        thrown.expectMessage("There is an open transaction.");
+
+        beginCommand.execute("");
+        useCommand.execute("another_database");
+    }
+
+    @Test
+    public void switchingDatabaseAfterRollbackTransactionWorks() throws CommandException {
+        beginCommand.execute("");
+        rollbackCommand.execute("");
+        useCommand.execute(SYSTEM_DB_NAME);
+
+        assertThat(linePrinter.output(), is(""));
+    }
+
+    @Test
+    public void switchingToNonExistingDatabaseShouldGiveErrorResponseFromServer() throws CommandException {
+        thrown.expect(ClientException.class);
+        thrown.expectMessage("The database requested does not exist.");
+
+        useCommand.execute("this_database_name_does_not_exist_in_test_container");
+    }
+}

cypher-shell/src/integration-test/java/org/neo4j/shell/commands/CypherShellPlainIntegrationTest.java

@@ -15,6 +15,7 @@
 
 import static org.hamcrest.CoreMatchers.containsString;
 import static org.hamcrest.MatcherAssert.assertThat;
+import static org.neo4j.driver.internal.messaging.request.MultiDatabaseUtil.ABSENT_DB_NAME;
 import static org.neo4j.shell.prettyprint.OutputFormatter.NEWLINE;
 
 public class CypherShellPlainIntegrationTest {
@@ -28,7 +29,7 @@ public class CypherShellPlainIntegrationTest {
     public void setUp() throws Exception {
         linePrinter.clear();
         shell = new CypherShell(linePrinter, new PrettyConfig(Format.PLAIN, true, 1000));
-        shell.connect(new ConnectionConfig("bolt://", "localhost", 7687, "neo4j", "neo", true));
+        shell.connect(new ConnectionConfig("bolt://", "localhost", 7687, "neo4j", "neo", true, ABSENT_DB_NAME));
     }
 
     @After

cypher-shell/src/integration-test/java/org/neo4j/shell/commands/CypherShellVerboseIntegrationTest.java

@@ -17,6 +17,7 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assume.assumeTrue;
+import static org.neo4j.driver.internal.messaging.request.MultiDatabaseUtil.ABSENT_DB_NAME;
 import static org.neo4j.shell.Versions.majorVersion;
 import static org.neo4j.shell.Versions.minorVersion;
 
@@ -38,7 +39,7 @@ public void setUp() throws Exception {
         commitCommand = new Commit(shell);
         beginCommand = new Begin(shell);
 
-        shell.connect(new ConnectionConfig("bolt://", "localhost", 7687, "neo4j", "neo", true));
+        shell.connect(new ConnectionConfig("bolt://", "localhost", 7687, "neo4j", "neo", true, ABSENT_DB_NAME));
     }
 
     @After
@@ -72,7 +73,7 @@ public void connectTwiceThrows() throws CommandException {
         thrown.expect(CommandException.class);
         thrown.expectMessage("Already connected");
 
-        ConnectionConfig config = new ConnectionConfig("bolt://", "localhost", 7687, "neo4j", "neo", true);
+        ConnectionConfig config = new ConnectionConfig("bolt://", "localhost", 7687, "neo4j", "neo", true, ABSENT_DB_NAME);
         assertTrue("Shell should already be connected", shell.isConnected());
         shell.connect(config);
     }

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

@@ -1,25 +1,28 @@
 package org.neo4j.shell;
 
-import org.neo4j.driver.v1.Config;
+import org.neo4j.driver.Config;
 
 import javax.annotation.Nonnull;
 
 public class ConnectionConfig {
     private final String scheme;
     private final String host;
     private final int port;
-    private final Config.EncryptionLevel encryption;
+    private final boolean encryption;
     private String username;
     private String password;
+    private String database;
 
     public ConnectionConfig(@Nonnull String scheme, @Nonnull String host, int port,
-                            @Nonnull String username, @Nonnull String password, boolean encryption) {
+                            @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.encryption = encryption ? Config.EncryptionLevel.REQUIRED : Config.EncryptionLevel.NONE;
+        this.encryption = encryption;
         this.scheme = scheme;
+        this.database = database;
     }
 
     /**
@@ -64,10 +67,15 @@ public String driverUrl() {
     }
 
     @Nonnull
-    public Config.EncryptionLevel encryption() {
+    public boolean encryption() {
         return encryption;
     }
 
+    @Nonnull
+    public String database() {
+        return database;
+    }
+
     public void setUsername(@Nonnull String username) {
         this.username = username;
     }

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

@@ -28,7 +28,7 @@
 /**
  * A possibly interactive shell for evaluating cypher statements.
  */
-public class CypherShell implements StatementExecuter, Connector, TransactionHandler, ParameterMap {
+public class CypherShell implements StatementExecuter, Connector, TransactionHandler, ParameterMap, DatabaseManager {
     // Final space to catch newline
     protected static final Pattern cmdNamePattern = Pattern.compile("^\\s*(?<name>[^\\s]+)\\b(?<args>.*)\\s*$");
     protected final Map<String, ParamValue> queryParams = new HashMap<>();
@@ -199,4 +199,15 @@ protected void addRuntimeHookToResetShell() {
         Runtime.getRuntime().addShutdownHook(new Thread(this::reset));
     }
 
+    @Override
+    public void setActiveDatabase(String databaseName) throws CommandException
+    {
+        boltStateHandler.setActiveDatabase(databaseName);
+    }
+
+    @Override
+    public String getActiveDatabase()
+    {
+        return boltStateHandler.getActiveDatabase();
+    }
 }

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

@@ -0,0 +1,16 @@
+package org.neo4j.shell;
+
+import org.neo4j.shell.exception.CommandException;
+
+/**
+ * An object capable of tracking the active database.
+ */
+public interface DatabaseManager
+{
+    String DEFAULT_DEFAULT_DB_NAME = "neo4j";
+    String SYSTEM_DB_NAME = "system";
+
+    void setActiveDatabase(String databaseName) throws CommandException;
+
+    String getActiveDatabase();
+}

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

@@ -1,7 +1,7 @@
 package org.neo4j.shell;
 
 import jline.console.ConsoleReader;
-import org.neo4j.driver.v1.exceptions.AuthenticationException;
+import org.neo4j.driver.exceptions.AuthenticationException;
 import org.neo4j.shell.build.Build;
 import org.neo4j.shell.cli.CliArgHelper;
 import org.neo4j.shell.cli.CliArgs;
@@ -67,7 +67,8 @@ void startShell(@Nonnull CliArgs cliArgs) {
                 cliArgs.getPort(),
                 cliArgs.getUsername(),
                 cliArgs.getPassword(),
-                cliArgs.getEncryption());
+                cliArgs.getEncryption(),
+                cliArgs.getDatabase());
 
         try {
             CypherShell shell = new CypherShell(logger, prettyConfig);