Merge pull request #56 from spacecowboy/neo4jversionprint

Added version of connected Neo4j to welcome message

Author: benbc

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

@@ -10,7 +10,6 @@
 public interface Connector {
 
     /**
-     *
      * @return true if connected, false otherwise
      */
     boolean isConnected();
@@ -20,4 +19,13 @@ public interface Connector {
      * @throws CommandException if connection failed
      */
     void connect(@Nonnull ConnectionConfig connectionConfig) throws CommandException;
+
+    /**
+     * Returns the version of Neo4j which the shell is connected to. If the version is before 3.1.0-M09, or we are not
+     * connected yet, this returns the empty string.
+     *
+     * @return the version of neo4j (like '3.1.0') if connected and available, an empty string otherwise
+     */
+    @Nonnull
+    String getServerVersion();
 }

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

@@ -123,6 +123,12 @@ public void connect(@Nonnull ConnectionConfig connectionConfig) throws CommandEx
         boltStateHandler.connect(connectionConfig);
     }
 
+    @Nonnull
+    @Override
+    public String getServerVersion() {
+        return boltStateHandler.getServerVersion();
+    }
+
     @Override
     public void beginTransaction() throws CommandException {
         boltStateHandler.beginTransaction();

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

@@ -48,8 +48,15 @@ public static void main(String[] args) {
     }
 
     private static void printWelcomeMessage(@Nonnull Logger logger,
-                                            @Nonnull ConnectionConfig connectionConfig) {
-        AnsiFormattedText welcomeMessage = AnsiFormattedText.from("Connected to Neo4j at ")
+                                            @Nonnull ConnectionConfig connectionConfig,
+                                            @Nonnull String serverVersion) {
+        String neo4j = "Neo4j";
+        if (!serverVersion.isEmpty()) {
+            neo4j += " " + serverVersion;
+        }
+        AnsiFormattedText welcomeMessage = AnsiFormattedText.from("Connected to ")
+                                                            .append(neo4j)
+                                                            .append(" at ")
                                                             .bold().append(connectionConfig.driverUrl()).boldOff();
 
         if (!connectionConfig.username().isEmpty()) {
@@ -90,7 +97,7 @@ void startShell(@Nonnull CliArgs cliArgs) {
 
             shell.setCommandHelper(commandHelper);
 
-            printWelcomeMessage(logger, connectionConfig);
+            printWelcomeMessage(logger, connectionConfig, shell.getServerVersion());
 
             int code = shellRunner.runUntilEnd();
             System.exit(code);

cypher-shell/src/main/java/org/neo4j/shell/state/BoltStateHandler.java

@@ -114,6 +114,24 @@ public void connect(@Nonnull ConnectionConfig connectionConfig) throws CommandEx
         }
     }
 
+    @Nonnull
+    @Override
+    public String getServerVersion() {
+        if (isConnected()) {
+            String version = session.server();
+            if (version == null) {
+                // On versions before 3.1.0-M09
+                version = "";
+            }
+            if (version.startsWith("Neo4j/")) {
+                // Want to return '3.1.0' and not 'Neo4j/3.1.0'
+                version = version.substring(6);
+            }
+            return version;
+        }
+        return "";
+    }
+
     @Nonnull
     public Optional<BoltResult> runCypher(@Nonnull String cypher,
                                           @Nonnull Map<String, Object> queryParams) throws CommandException {
@@ -181,8 +199,8 @@ private StatementRunner getStatementRunner() throws CommandException {
 
     private Driver getDriver(@Nonnull ConnectionConfig connectionConfig, @Nullable AuthToken authToken) {
         Config config = Config.build()
-                .withLogging(new ConsoleLogging(Level.OFF))
-                .withEncryptionLevel(connectionConfig.encryption()).toConfig();
+                              .withLogging(new ConsoleLogging(Level.OFF))
+                              .withEncryptionLevel(connectionConfig.encryption()).toConfig();
         return driverProvider.apply(connectionConfig.driverUrl(), authToken, config);
     }
 }

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

@@ -74,6 +74,22 @@ public void verifyDelegationOfResetMethod() throws CommandException {
         verify(mockedBoltStateHandler).reset();
     }
 
+    @Test
+    public void verifyDelegationOfGetServerVersionMethod() throws CommandException {
+        CypherShell shell = new CypherShell(logger, mockedBoltStateHandler, mockedPrettyPrinter);
+
+        shell.getServerVersion();
+        verify(mockedBoltStateHandler).getServerVersion();
+    }
+
+    @Test
+    public void verifyDelegationOfIsTransactionOpenMethod() throws CommandException {
+        CypherShell shell = new CypherShell(logger, mockedBoltStateHandler, mockedPrettyPrinter);
+
+        shell.isTransactionOpen();
+        verify(mockedBoltStateHandler).isTransactionOpen();
+    }
+
     @Test
     public void verifyDelegationOfTransactionMethods() throws CommandException {
         CypherShell shell = new CypherShell(logger, mockedBoltStateHandler, mockedPrettyPrinter);

cypher-shell/src/test/java/org/neo4j/shell/state/BoltStateHandlerTest.java

@@ -38,6 +38,64 @@ public void setup() {
         doReturn(System.out).when(logger).getOutputStream();
     }
 
+    @Test
+    public void versionIsEmptyBeforeConnect() throws CommandException {
+        assertFalse(boltStateHandler.isConnected());
+        assertEquals("", boltStateHandler.getServerVersion());
+    }
+
+    @Test
+    public void versionIsEmptyIfDriverReturnsNull() throws CommandException {
+        RecordingDriverProvider provider = new RecordingDriverProvider() {
+            @Override
+            public Driver apply(String uri, AuthToken authToken, Config config) {
+                super.apply(uri, authToken, config);
+                return new FakeDriver() {
+                    @Override
+                    public Session session() {
+                        return new FakeSession() {
+                            @Override
+                            public String server() {
+                                return null;
+                            }
+                        };
+                    }
+                };
+            }
+        };
+        BoltStateHandler handler = new BoltStateHandler(provider);
+        ConnectionConfig config = new ConnectionConfig("", -1, "", "", false);
+        handler.connect(config);
+
+        assertEquals("", handler.getServerVersion());
+    }
+
+    @Test
+    public void versionIsNotEmptyAfterConnect() throws CommandException {
+        RecordingDriverProvider provider = new RecordingDriverProvider() {
+            @Override
+            public Driver apply(String uri, AuthToken authToken, Config config) {
+                super.apply(uri, authToken, config);
+                return new FakeDriver() {
+                    @Override
+                    public Session session() {
+                        return new FakeSession() {
+                            @Override
+                            public String server() {
+                                return "Neo4j/9.4.1-ALPHA";
+                            }
+                        };
+                    }
+                };
+            }
+        };
+        BoltStateHandler handler = new BoltStateHandler(provider);
+        ConnectionConfig config = new ConnectionConfig("", -1, "", "", false);
+        handler.connect(config);
+
+        assertEquals("9.4.1-ALPHA", handler.getServerVersion());
+    }
+
     @Test
     public void closeTransactionAfterRollback() throws CommandException {
         boltStateHandler.connect();