Merge pull request neo4j#176 from zhenlineo/1.0-move-server-control-to-py

Change the java driver to use neokit to manage server start

Author: pontusmelke

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "neokit"]
+	path = neokit
+	url = https://github.com/neo-technology/neokit.git

README.md

@@ -1,6 +1,7 @@
 # Neo4j Java Driver
 
-A database driver for a new Neo4j remoting protocol. 
+This is the first official Neo4j java driver for connecting to Neo4j-the-database via the newly designed remoting
+protocol BOLT.
 
 ## Minimum viable snippet
 
@@ -10,27 +11,37 @@ Add the driver to your project:
         <dependency>
             <groupId>org.neo4j.driver</groupId>
             <artifactId>neo4j-java-driver</artifactId>
-            <version>1.0.0-RC1</version>
+            <version>x.y.z</version>
         </dependency>
     </dependencies>
 
-Connect to a Neo4j 3.0.0+ database
+*Please check the [Releases](https://github.com/neo4j/neo4j-java-driver/releases) for the newest driver version
+available.
 
-    Driver driver = GraphDatabase.driver( "bolt://localhost" );
+Connect to a Neo4j 3.0.0+ database:
+
+    Driver driver = ( "bolt://localhost", AuthTokens.basic( "neo4j", "neo4j" ) );
 
     Session session = driver.session();
 
-    StatementResult rs = session.run("CREATE (n) RETURN n");
+    StatementResult rs = session.run( "CREATE (n) RETURN n" );
 
     session.close();
 
     driver.close();
 
-# Building
+For more examples and details of usage, please refer to the [Driver Manual] (http://neo4j.com/docs/developer-manual/3
+.0/index.html#driver-manual-index).
+
+## Binding
 
-## Java version
+The source code here reflects the current development status of a new driver version.
+If you want to use the driver in your products, please use the released driver via maven central or check out the
+code with git tags instead.
 
-If you are running Java 8:
+### Java version
+
+To compile the code and run all tests, if you are running Java 8:
 
     mvn clean install
 
@@ -43,7 +54,15 @@ Java 8, because Neo4j-the-database needs it to run.
     # For instance
     export NEO4J_JAVA=$(/usr/libexec/java_home -v 1.8)
 
-## Windows
+### Windows
+
+If you are building on windows, you need to have Python (v2.7) installed and have Python.exe to be added in your system `PATH` variables.
+Then run install as admin, so that Neo4j-the-database could be installed and started with Python scripts for integration tests.
+
+Or you could choose to ignore integration tests by running:
+
+    mvn clean install -DskipITs 
+
+Without integration tests, there is no need to install Python or run as admin.
 
-If you are building on windows, you need to run install as admin so that Neo4j-the-database could be registered as a
-windows service and then be started and stopped correctly using its powershell scripts for windows.
+For more information such as manual, driver API documentations, changelogs, please refer to [wiki](https://github.com/neo4j/neo4j-java-driver/wiki).

driver/src/test/java/org/neo4j/driver/v1/integration/CredentialsIT.java

@@ -87,7 +87,7 @@ public void shouldGetHelpfulErrorOnInvalidCredentials() throws Throwable
 
     private void enableAuth( String password ) throws Exception
     {
-        neo4j.restartServerOnEmptyDatabase( Neo4jSettings.DEFAULT
+        neo4j.restart( Neo4jSettings.TEST_SETTINGS
                 .updateWith( Neo4jSettings.AUTH_ENABLED, "true" )
                 .updateWith( Neo4jSettings.DATA_DIR, tempDir.getRoot().getAbsolutePath().replace("\\", "/") ));
 

driver/src/test/java/org/neo4j/driver/v1/integration/LoadCSVIT.java

@@ -38,7 +38,7 @@
 public class LoadCSVIT
 {
     @Rule
-    public TestNeo4j neo4j = new TestNeo4j( Neo4jSettings.DEFAULT.without( Neo4jSettings.IMPORT_DIR ));
+    public TestNeo4j neo4j = new TestNeo4j( Neo4jSettings.TEST_SETTINGS.without( Neo4jSettings.IMPORT_DIR ));
 
     @Test
     public void shouldLoadCSV() throws Throwable

driver/src/test/java/org/neo4j/driver/v1/integration/TLSSocketChannelIT.java

@@ -138,7 +138,7 @@ public void shouldPerformTLSHandshakeWithTrustedCert() throws Throwable
         finally
         {
             // always restore the db default settings
-            neo4j.restartServerOnEmptyDatabase( Neo4jSettings.DEFAULT );
+            neo4j.restart();
         }
     }
 
@@ -197,8 +197,8 @@ private void createFakeServerCertPairInKnownCerts( String host, int port, File k
     public void shouldFailTLSHandshakeDueToServerCertNotSignedByKnownCA() throws Throwable
     {
         // Given
-        neo4j.restartServerOnEmptyDatabase(
-                Neo4jSettings.DEFAULT.updateWith(
+        neo4j.restart(
+                Neo4jSettings.TEST_SETTINGS.updateWith(
                         Neo4jSettings.CERT_DIR,
                         folder.getRoot().getAbsolutePath().replace("\\", "/") ) );
         SocketChannel channel = SocketChannel.open();

driver/src/test/java/org/neo4j/driver/v1/stress/DriverStresser.java

@@ -57,7 +57,7 @@ public static void main( String... args ) throws Throwable
     public static void setup() throws Exception
     {
         server = Neo4jRunner.getOrCreateGlobalRunner();
-        server.ensureRunning( Neo4jSettings.DEFAULT );
+        server.ensureRunning( Neo4jSettings.TEST_SETTINGS );
         driver = GraphDatabase.driver( "bolt://localhost" );
     }
 
@@ -88,7 +88,7 @@ public int operation()
     public static void tearDown() throws Exception
     {
         driver.close();
-        server.stop();
+        server.stopNeo4j();
     }
 
 

driver/src/test/java/org/neo4j/driver/v1/tck/DriverAuthSteps.java

@@ -63,7 +63,7 @@ public void reset()
             {
                 driver.close();
             }
-            neo4j.useDefaultEncryptionKeyAndCert();
+            neo4j.restart();
         }
         catch ( Exception e )
         {
@@ -121,7 +121,7 @@ public void aProtocolErrorIsRaised() throws Throwable
 
     private Driver configureCredentials( String name, String oldPassword, String newPassword ) throws Exception
     {
-        neo4j.restartServerOnEmptyDatabase( Neo4jSettings.DEFAULT
+        neo4j.restart( Neo4jSettings.TEST_SETTINGS
                 .updateWith( Neo4jSettings.AUTH_ENABLED, "true" )
                 .updateWith( Neo4jSettings.DATA_DIR, tempDir.getAbsolutePath().replace("\\", "/") ));
 

driver/src/test/java/org/neo4j/driver/v1/tck/DriverSecurityComplianceSteps.java

@@ -268,7 +268,7 @@ public void clearAfterEachScenario() throws Throwable
     @After("@modifies_db_config")
     public void resetDbWithDefaultSettings() throws Throwable
     {
-        neo4j.useDefaultEncryptionKeyAndCert();
+        neo4j.restart();
     }
 
     private File tempFile(String prefix, String suffix) throws Throwable