Allow for an edition SPI.

The edition modules can expose various top-level functionality which make integration tests cleaner.
neo4j · Mar 14, 2016 · 067d879 · 067d879
1 parent 78fe029
commit 067d879
Show file tree

Hide file tree

Showing 19 changed files with 50 additions and 28 deletions.
diff --git a/community/kernel/src/main/java/org/neo4j/kernel/impl/factory/CommunityFacadeFactory.java b/community/kernel/src/main/java/org/neo4j/kernel/impl/factory/CommunityFacadeFactory.java
@@ -34,10 +34,10 @@
 public class CommunityFacadeFactory extends GraphDatabaseFacadeFactory
 {
     @Override
-    public GraphDatabaseFacade newFacade( File storeDir, Map<String,String> params, Dependencies dependencies,
+    public GraphDatabaseFacade initFacade( File storeDir, Map<String,String> params, Dependencies dependencies,
             GraphDatabaseFacade graphDatabaseFacade )
     {
-        return super.newFacade( storeDir, params, newDependencies( dependencies ).settingsClasses(
+        return super.initFacade( storeDir, params, newDependencies( dependencies ).settingsClasses(
                 asList( append( GraphDatabaseSettings.class, dependencies.settingsClasses() ) ) ),
                 graphDatabaseFacade );
     }

diff --git a/community/kernel/src/main/java/org/neo4j/kernel/impl/factory/EditionModule.java b/community/kernel/src/main/java/org/neo4j/kernel/impl/factory/EditionModule.java
@@ -54,6 +54,10 @@
  */
 public abstract class EditionModule
 {
+    public interface SPI
+    {
+    }
+
     public IdGeneratorFactory idGeneratorFactory;
 
     public LabelTokenHolder labelTokenHolder;
@@ -111,4 +115,9 @@ protected AuthManager createAuthManager(Config config, LifeSupport life, LogProv
         }
 
     }
+
+    protected EditionModule.SPI spi()
+    {
+        return null;
+    }
 }
diff --git a/community/kernel/src/main/java/org/neo4j/kernel/impl/factory/GraphDatabaseFacade.java b/community/kernel/src/main/java/org/neo4j/kernel/impl/factory/GraphDatabaseFacade.java
@@ -112,6 +112,7 @@ public class GraphDatabaseFacade implements GraphDatabaseAPI
     private NodeProxy.NodeActions nodeActions;
     private RelationshipProxy.RelationshipActions relActions;
     private SPI spi;
+    private EditionModule.SPI editionSPI;
 
     /**
      * This is what you need to implemenent to get your very own {@link GraphDatabaseFacade}. This SPI exists as a thin
@@ -184,14 +185,21 @@ public GraphDatabaseFacade()
     {
     }
 
+    public void init( SPI spi )
+    {
+        init( spi, null );
+    }
+
     /**
      * Create a new Core API facade, backed by the given SPI.
      */
-    public void init( SPI spi )
+    public void init( SPI spi, EditionModule.SPI editionSPI )
     {
         IndexProviderImpl idxProvider = new IndexProviderImpl( this, spi::currentStatement );
 
         this.spi = spi;
+        this.editionSPI = editionSPI;
+
         this.relActions = new StandardRelationshipActions( spi::currentStatement, spi::currentTransaction,
                 this::assertTransactionOpen, ( id ) -> new NodeProxy( nodeActions, id ), this );
         this.nodeActions =
@@ -591,6 +599,11 @@ public StoreId storeId()
         return spi.storeId();
     }
 
+    public EditionModule.SPI editionSPI()
+    {
+        return editionSPI;
+    }
+
     @Override
     public URL validateURLAccess( URL url ) throws URLAccessValidationError
     {

diff --git a/community/kernel/src/main/java/org/neo4j/kernel/impl/factory/GraphDatabaseFacadeFactory.java b/community/kernel/src/main/java/org/neo4j/kernel/impl/factory/GraphDatabaseFacadeFactory.java
@@ -47,7 +47,7 @@
  * <p/>
  * It is abstract in order for subclasses to specify their own {@link org.neo4j.kernel.impl.factory.EditionModule}
  * implementations. Subclasses also have to set the edition name
- * in overridden version of {@link #newFacade(File, Map, GraphDatabaseFacadeFactory.Dependencies, GraphDatabaseFacade)},
+ * in overridden version of {@link #initFacade(File, Map, GraphDatabaseFacadeFactory.Dependencies, GraphDatabaseFacade)},
  * which is used for logging and similar.
  * <p/>
  * To create test versions of databases, override an edition factory (e.g. {@link org.neo4j.kernel.impl.factory
@@ -105,7 +105,7 @@ public static class Configuration
      */
     public GraphDatabaseFacade newFacade( File storeDir, Map<String, String> params, final Dependencies dependencies )
     {
-        return newFacade( storeDir, params, dependencies, new GraphDatabaseFacade() );
+        return initFacade( storeDir, params, dependencies, new GraphDatabaseFacade() );
     }
 
     /**
@@ -118,7 +118,7 @@ public GraphDatabaseFacade newFacade( File storeDir, Map<String, String> params,
      * @param graphDatabaseFacade the already created facade which needs initialisation
      * @return the initialised {@link GraphDatabaseFacade}
      */
-    public GraphDatabaseFacade newFacade( File storeDir, Map<String, String> params, final Dependencies dependencies,
+    public GraphDatabaseFacade initFacade( File storeDir, Map<String, String> params, final Dependencies dependencies,
                                           final GraphDatabaseFacade graphDatabaseFacade )
     {
         PlatformModule platform = createPlatform( storeDir, params, dependencies, graphDatabaseFacade );
@@ -128,7 +128,7 @@ public GraphDatabaseFacade newFacade( File storeDir, Map<String, String> params,
         CoreAPIAvailabilityGuard coreAPIAvailabilityGuard = edition.coreAPIAvailabilityGuard;
 
         // Start it
-        graphDatabaseFacade.init( new ClassicCoreSPI( platform, dataSource, msgLog, coreAPIAvailabilityGuard ) );
+        graphDatabaseFacade.init( new ClassicCoreSPI( platform, dataSource, msgLog, coreAPIAvailabilityGuard ), edition.spi() );
 
         Throwable error = null;
         try

diff --git a/community/kernel/src/main/java/org/neo4j/kernel/internal/EmbeddedGraphDatabase.java b/community/kernel/src/main/java/org/neo4j/kernel/internal/EmbeddedGraphDatabase.java
@@ -68,6 +68,6 @@ public EmbeddedGraphDatabase( File storeDir,
     protected void create( File storeDir, Map<String, String> params,
                                       GraphDatabaseFacadeFactory.Dependencies dependencies)
     {
-        new CommunityFacadeFactory().newFacade( storeDir, params, dependencies, this );
+        new CommunityFacadeFactory().initFacade( storeDir, params, dependencies, this );
     }
 }
diff --git a/community/kernel/src/test/java/org/neo4j/graphdb/LabelsAcceptanceTest.java b/community/kernel/src/test/java/org/neo4j/graphdb/LabelsAcceptanceTest.java
@@ -645,7 +645,7 @@ protected PlatformModule createPlatform( File storeDir, Map<String, String> para
                                     {
                                         return new ImpermanentPlatformModule( storeDir, params, databaseInfo(), dependencies, graphDatabaseFacade );
                                     }
-                                }.newFacade( storeDir, params, dependencies, this );
+                                }.initFacade( storeDir, params, dependencies, this );
                             }
                         };
                     }

diff --git a/community/kernel/src/test/java/org/neo4j/kernel/GraphDatabaseFacadeFactoryTest.java b/community/kernel/src/test/java/org/neo4j/kernel/GraphDatabaseFacadeFactoryTest.java
@@ -78,7 +78,7 @@ public void shouldThrowAppropriateExceptionIfStartFails()
         try
         {
             // When
-            db.newFacade( dir.graphDbDir(), Collections.<String,String>emptyMap(), deps, mockFacade );
+            db.initFacade( dir.graphDbDir(), Collections.<String,String>emptyMap(), deps, mockFacade );
             fail( "Should have thrown " + RuntimeException.class );
         }
         catch ( RuntimeException exception )
@@ -100,7 +100,7 @@ public void shouldThrowAppropriateExceptionIfBothStartAndShutdownFail()
         try
         {
             // When
-            db.newFacade( dir.graphDbDir(), Collections.<String,String>emptyMap(), deps, mockFacade );
+            db.initFacade( dir.graphDbDir(), Collections.<String,String>emptyMap(), deps, mockFacade );
             fail( "Should have thrown " + RuntimeException.class );
         }
         catch ( RuntimeException exception )

diff --git a/community/kernel/src/test/java/org/neo4j/kernel/impl/api/KernelTest.java b/community/kernel/src/test/java/org/neo4j/kernel/impl/api/KernelTest.java
@@ -105,7 +105,7 @@ public void assertSchemaWritesAllowed() throws InvalidTransactionTypeKernelExcep
                         }
                     };
                 }
-            }.newFacade( storeDir, params, dependencies, this );
+            }.initFacade( storeDir, params, dependencies, this );
         }
     }
 }
diff --git a/...nel/src/test/java/org/neo4j/kernel/impl/store/IdGeneratorRebuildFailureEmulationTest.java b/...nel/src/test/java/org/neo4j/kernel/impl/store/IdGeneratorRebuildFailureEmulationTest.java
@@ -247,7 +247,7 @@ protected FileSystemAbstraction createFileSystemAbstraction()
                         }
                     };
                 }
-            }.newFacade( storeDir, params, dependencies, this );
+            }.initFacade( storeDir, params, dependencies, this );
         }
 
     }

diff --git a/...y/kernel/src/test/java/org/neo4j/kernel/impl/transaction/PartialTransactionFailureIT.java b/...y/kernel/src/test/java/org/neo4j/kernel/impl/transaction/PartialTransactionFailureIT.java
@@ -97,7 +97,7 @@ protected FileSystemAbstraction createFileSystemAbstraction()
                             }
                         };
                     }
-                }.newFacade( storeDir, params, dependencies, this );
+                }.initFacade( storeDir, params, dependencies, this );
             }
         };
 

diff --git a/community/kernel/src/test/java/org/neo4j/test/ImpermanentGraphDatabase.java b/community/kernel/src/test/java/org/neo4j/test/ImpermanentGraphDatabase.java
@@ -146,7 +146,7 @@ protected PlatformModule createPlatform( File storeDir, Map<String, String> para
             {
                 return new ImpermanentPlatformModule( storeDir, params, databaseInfo(), dependencies, graphDatabaseFacade );
             }
-        }.newFacade( storeDir, new HashMap<>( params ), dependencies, this );
+        }.initFacade( storeDir, new HashMap<>( params ), dependencies, this );
     }
 
     private void trackUnclosedUse( File storeDir )

diff --git a/community/kernel/src/test/java/org/neo4j/test/LimitedFileSystemGraphDatabase.java b/community/kernel/src/test/java/org/neo4j/test/LimitedFileSystemGraphDatabase.java
@@ -55,7 +55,7 @@ protected FileSystemAbstraction createFileSystemAbstraction()
                     }
                 };
             }
-        }.newFacade( storeDir, params, dependencies, this );
+        }.initFacade( storeDir, params, dependencies, this );
     }
 
 

diff --git a/...se/core-edge/src/main/java/org/neo4j/coreedge/server/EnterpriseCoreEdgeFacadeFactory.java b/...se/core-edge/src/main/java/org/neo4j/coreedge/server/EnterpriseCoreEdgeFacadeFactory.java
@@ -32,18 +32,18 @@
 abstract class EnterpriseCoreEdgeFacadeFactory extends GraphDatabaseFacadeFactory
 {
     @Override
-    public GraphDatabaseFacade newFacade( File storeDir, Map<String, String> params, Dependencies dependencies,
+    public GraphDatabaseFacade initFacade( File storeDir, Map<String, String> params, Dependencies dependencies,
                                           GraphDatabaseFacade graphDatabaseFacade )
     {
-        return super.newFacade( storeDir, params, dependencies, graphDatabaseFacade );
+        return super.initFacade( storeDir, params, dependencies, graphDatabaseFacade );
     }
 
     protected void makeHazelcastQuiet( PlatformModule platformModule )
     {
         // Make hazelcast quiet for core and edge servers
         if ( platformModule.config.get( CoreEdgeClusterSettings.disable_middleware_logging ) )
         {
-            // This is clunky, but the documented programmtic way doesn't seem to work
+            // This is clunky, but the documented programmatic way doesn't seem to work
             System.setProperty( "hazelcast.logging.type", "none" );
         }
     }

diff --git a/enterprise/core-edge/src/main/java/org/neo4j/coreedge/server/core/CoreGraphDatabase.java b/enterprise/core-edge/src/main/java/org/neo4j/coreedge/server/core/CoreGraphDatabase.java
@@ -39,7 +39,7 @@ public CoreGraphDatabase( File storeDir, Map<String, String> params,
                               GraphDatabaseFacadeFactory.Dependencies dependencies,
                               DiscoveryServiceFactory discoveryServiceFactory )
     {
-        new EnterpriseCoreFacadeFactory( discoveryServiceFactory ).newFacade( storeDir, params, dependencies, this );
+        new EnterpriseCoreFacadeFactory( discoveryServiceFactory ).initFacade( storeDir, params, dependencies, this );
 
         // See same thing in HighlyAvailableGraphDatabase for details
         raft = getDependencyResolver().resolveDependency( RaftInstance.class );

diff --git a/enterprise/core-edge/src/main/java/org/neo4j/coreedge/server/edge/EdgeGraphDatabase.java b/enterprise/core-edge/src/main/java/org/neo4j/coreedge/server/edge/EdgeGraphDatabase.java
@@ -38,6 +38,6 @@ public EdgeGraphDatabase( File storeDir, Map<String, String> params, Dependencie
     public EdgeGraphDatabase( File storeDir, Map<String, String> params, Dependencies
             dependencies, DiscoveryServiceFactory discoveryServiceFactory )
     {
-        new EnterpriseEdgeFacadeFactory( discoveryServiceFactory ).newFacade( storeDir, params, dependencies, this );
+        new EnterpriseEdgeFacadeFactory( discoveryServiceFactory ).initFacade( storeDir, params, dependencies, this );
     }
 }
diff --git a/enterprise/ha/src/main/java/org/neo4j/kernel/ha/HighlyAvailableGraphDatabase.java b/enterprise/ha/src/main/java/org/neo4j/kernel/ha/HighlyAvailableGraphDatabase.java
@@ -38,7 +38,7 @@ public class HighlyAvailableGraphDatabase extends GraphDatabaseFacade
 {
     public HighlyAvailableGraphDatabase( File storeDir, Map<String,String> params, GraphDatabaseFacadeFactory.Dependencies dependencies )
     {
-        newHighlyAvailableFacadeFactory().newFacade( storeDir, params, dependencies, this );
+        newHighlyAvailableFacadeFactory().initFacade( storeDir, params, dependencies, this );
     }
 
     protected HighlyAvailableFacadeFactory newHighlyAvailableFacadeFactory()

diff --git a/enterprise/ha/src/main/java/org/neo4j/kernel/ha/factory/HighlyAvailableFacadeFactory.java b/enterprise/ha/src/main/java/org/neo4j/kernel/ha/factory/HighlyAvailableFacadeFactory.java
@@ -36,10 +36,10 @@
 public class HighlyAvailableFacadeFactory extends GraphDatabaseFacadeFactory
 {
     @Override
-    public GraphDatabaseFacade newFacade( File storeDir, Map<String, String> params, Dependencies dependencies,
+    public GraphDatabaseFacade initFacade( File storeDir, Map<String, String> params, Dependencies dependencies,
             GraphDatabaseFacade graphDatabaseFacade )
     {
-        return super.newFacade( storeDir, params, dependencies, graphDatabaseFacade );
+        return super.initFacade( storeDir, params, dependencies, graphDatabaseFacade );
     }
 
     @Override

diff --git a/enterprise/kernel/src/main/java/org/neo4j/graphdb/EnterpriseGraphDatabase.java b/enterprise/kernel/src/main/java/org/neo4j/graphdb/EnterpriseGraphDatabase.java
@@ -54,6 +54,6 @@ public EnterpriseGraphDatabase( File storeDir, Map<String,String> params,
     public EnterpriseGraphDatabase( File storeDir, Map<String,String> params,
             GraphDatabaseFacadeFactory.Dependencies dependencies )
     {
-        new EnterpriseFacadeFactory().newFacade( storeDir, params, dependencies, this );
+        new EnterpriseFacadeFactory().initFacade( storeDir, params, dependencies, this );
     }
-}
+}
diff --git a/...rprise/kernel/src/main/java/org/neo4j/kernel/impl/enterprise/EnterpriseFacadeFactory.java b/...rprise/kernel/src/main/java/org/neo4j/kernel/impl/enterprise/EnterpriseFacadeFactory.java
@@ -36,10 +36,10 @@
 public class EnterpriseFacadeFactory extends GraphDatabaseFacadeFactory
 {
     @Override
-    public GraphDatabaseFacade newFacade( File storeDir, Map<String,String> params, Dependencies dependencies,
+    public GraphDatabaseFacade initFacade( File storeDir, Map<String,String> params, Dependencies dependencies,
             GraphDatabaseFacade graphDatabaseFacade )
     {
-        return super.newFacade( storeDir, params, dependencies, graphDatabaseFacade );
+        return super.initFacade( storeDir, params, dependencies, graphDatabaseFacade );
     }
 
     @Override