Skip to content

Commit

Permalink
Cleanup and test bolt factory
Browse files Browse the repository at this point in the history
This commit removes an empty life from `LifecycleManagedBoltFactory` and
renames it to `BoltFactoryImpl`. It also adds tests to assert that reference
to `TransactionIdStore` is refreshed when factory is restarted.
  • Loading branch information
lutovich committed Feb 9, 2017
1 parent 3a3e2ea commit bea0bda
Show file tree
Hide file tree
Showing 5 changed files with 153 additions and 27 deletions.
Expand Up @@ -46,24 +46,23 @@
import org.neo4j.bolt.transport.SocketTransport; import org.neo4j.bolt.transport.SocketTransport;
import org.neo4j.bolt.v1.runtime.BoltConnectionDescriptor; import org.neo4j.bolt.v1.runtime.BoltConnectionDescriptor;
import org.neo4j.bolt.v1.runtime.BoltFactory; import org.neo4j.bolt.v1.runtime.BoltFactory;
import org.neo4j.bolt.v1.runtime.BoltFactoryImpl;
import org.neo4j.bolt.v1.runtime.BoltWorker; import org.neo4j.bolt.v1.runtime.BoltWorker;
import org.neo4j.bolt.v1.runtime.LifecycleManagedBoltFactory;
import org.neo4j.bolt.v1.runtime.MonitoredWorkerFactory; import org.neo4j.bolt.v1.runtime.MonitoredWorkerFactory;
import org.neo4j.bolt.v1.runtime.WorkerFactory; import org.neo4j.bolt.v1.runtime.WorkerFactory;
import org.neo4j.bolt.v1.runtime.concurrent.ThreadedWorkerFactory; import org.neo4j.bolt.v1.runtime.concurrent.ThreadedWorkerFactory;
import org.neo4j.bolt.v1.transport.BoltProtocolV1; import org.neo4j.bolt.v1.transport.BoltProtocolV1;
import org.neo4j.configuration.Description; import org.neo4j.configuration.Description;
import org.neo4j.configuration.LoadableConfig;
import org.neo4j.graphdb.GraphDatabaseService; import org.neo4j.graphdb.GraphDatabaseService;
import org.neo4j.graphdb.config.Configuration; import org.neo4j.graphdb.config.Configuration;
import org.neo4j.graphdb.config.Setting; import org.neo4j.graphdb.config.Setting;
import org.neo4j.graphdb.factory.GraphDatabaseSettings; import org.neo4j.graphdb.factory.GraphDatabaseSettings;
import org.neo4j.kernel.configuration.BoltConnector;
import org.neo4j.helpers.AdvertisedSocketAddress; import org.neo4j.helpers.AdvertisedSocketAddress;
import org.neo4j.helpers.ListenSocketAddress; import org.neo4j.helpers.ListenSocketAddress;
import org.neo4j.helpers.Service; import org.neo4j.helpers.Service;
import org.neo4j.kernel.api.bolt.BoltConnectionTracker; import org.neo4j.kernel.api.bolt.BoltConnectionTracker;
import org.neo4j.kernel.api.security.AuthManager; import org.neo4j.kernel.api.security.AuthManager;
import org.neo4j.kernel.configuration.BoltConnector;
import org.neo4j.kernel.configuration.Config; import org.neo4j.kernel.configuration.Config;
import org.neo4j.kernel.configuration.Internal; import org.neo4j.kernel.configuration.Internal;
import org.neo4j.kernel.extension.KernelExtensionFactory; import org.neo4j.kernel.extension.KernelExtensionFactory;
Expand Down Expand Up @@ -156,7 +155,7 @@ public Lifecycle newInstance( KernelContext context, Dependencies dependencies )


Authentication authentication = authentication( dependencies.authManager() ); Authentication authentication = authentication( dependencies.authManager() );


BoltFactory boltFactory = life.add( new LifecycleManagedBoltFactory( api, dependencies.usageData(), BoltFactory boltFactory = life.add( new BoltFactoryImpl( api, dependencies.usageData(),
logService, dependencies.txBridge(), authentication, dependencies.sessionTracker(), config ) ); logService, dependencies.txBridge(), authentication, dependencies.sessionTracker(), config ) );
WorkerFactory workerFactory = createWorkerFactory( boltFactory, scheduler, dependencies, logService, clock ); WorkerFactory workerFactory = createWorkerFactory( boltFactory, scheduler, dependencies, logService, clock );


Expand Down
Expand Up @@ -34,14 +34,12 @@
import org.neo4j.kernel.impl.query.QueryExecutionEngine; import org.neo4j.kernel.impl.query.QueryExecutionEngine;
import org.neo4j.kernel.impl.transaction.log.TransactionIdStore; import org.neo4j.kernel.impl.transaction.log.TransactionIdStore;
import org.neo4j.kernel.internal.GraphDatabaseAPI; import org.neo4j.kernel.internal.GraphDatabaseAPI;
import org.neo4j.kernel.lifecycle.LifeSupport;
import org.neo4j.kernel.lifecycle.LifecycleAdapter; import org.neo4j.kernel.lifecycle.LifecycleAdapter;
import org.neo4j.udc.UsageData; import org.neo4j.udc.UsageData;


public class LifecycleManagedBoltFactory extends LifecycleAdapter implements BoltFactory public class BoltFactoryImpl extends LifecycleAdapter implements BoltFactory
{ {
private final GraphDatabaseAPI gds; private final GraphDatabaseAPI gds;
private final LifeSupport life = new LifeSupport();
private final UsageData usageData; private final UsageData usageData;
private final LogService logging; private final LogService logging;
private final Authentication authentication; private final Authentication authentication;
Expand All @@ -54,7 +52,7 @@ public class LifecycleManagedBoltFactory extends LifecycleAdapter implements Bol
private TransactionIdStore transactionIdStore; private TransactionIdStore transactionIdStore;
private AvailabilityGuard availabilityGuard; private AvailabilityGuard availabilityGuard;


public LifecycleManagedBoltFactory( GraphDatabaseAPI gds, UsageData usageData, LogService logging, public BoltFactoryImpl( GraphDatabaseAPI gds, UsageData usageData, LogService logging,
ThreadToStatementContextBridge txBridge, Authentication authentication, ThreadToStatementContextBridge txBridge, Authentication authentication,
BoltConnectionTracker connectionTracker, Config config ) BoltConnectionTracker connectionTracker, Config config )
{ {
Expand All @@ -67,12 +65,6 @@ public LifecycleManagedBoltFactory( GraphDatabaseAPI gds, UsageData usageData, L
this.config = config; this.config = config;
} }


@Override
public void init() throws Throwable
{
life.init();
}

@Override @Override
public void start() throws Throwable public void start() throws Throwable
{ {
Expand All @@ -81,19 +73,15 @@ public void start() throws Throwable
queryService = dependencyResolver.resolveDependency( GraphDatabaseQueryService.class ); queryService = dependencyResolver.resolveDependency( GraphDatabaseQueryService.class );
transactionIdStore = dependencyResolver.resolveDependency( TransactionIdStore.class ); transactionIdStore = dependencyResolver.resolveDependency( TransactionIdStore.class );
availabilityGuard = dependencyResolver.resolveDependency( AvailabilityGuard.class ); availabilityGuard = dependencyResolver.resolveDependency( AvailabilityGuard.class );
life.start();
} }


@Override @Override
public void stop() throws Throwable public void stop() throws Throwable
{ {
life.stop(); queryExecutionEngine = null;
} queryService = null;

transactionIdStore = null;
@Override availabilityGuard = null;
public void shutdown() throws Throwable
{
life.shutdown();
} }


@Override @Override
Expand Down
Expand Up @@ -38,8 +38,7 @@ class BoltStateMachineSPI implements BoltStateMachine.SPI
private final BoltConnectionTracker connectionTracker; private final BoltConnectionTracker connectionTracker;
private final Authentication authentication; private final Authentication authentication;
private final String version; private final String version;

private final TransactionStateMachine.SPI transactionSpi;
final TransactionStateMachine.SPI transactionSpi;


BoltStateMachineSPI( BoltConnectionDescriptor connectionDescriptor, BoltStateMachineSPI( BoltConnectionDescriptor connectionDescriptor,
UsageData usageData, UsageData usageData,
Expand Down
@@ -0,0 +1,140 @@
/*
* Copyright (c) 2002-2017 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.bolt.v1.runtime;

import org.junit.Test;

import java.net.InetSocketAddress;
import java.time.Clock;

import org.neo4j.bolt.security.auth.Authentication;
import org.neo4j.graphdb.DependencyResolver;
import org.neo4j.kernel.GraphDatabaseQueryService;
import org.neo4j.kernel.api.bolt.BoltConnectionTracker;
import org.neo4j.kernel.configuration.Config;
import org.neo4j.kernel.impl.core.ThreadToStatementContextBridge;
import org.neo4j.kernel.impl.logging.NullLogService;
import org.neo4j.kernel.impl.transaction.log.TransactionIdStore;
import org.neo4j.kernel.internal.GraphDatabaseAPI;
import org.neo4j.test.OnDemandJobScheduler;
import org.neo4j.udc.UsageData;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.fail;
import static org.mockito.Mockito.mock;
import static org.mockito.Mockito.when;

public class BoltFactoryImplTest
{
private static final Clock CLOCK = Clock.systemUTC();
private static final BoltConnectionDescriptor CONNECTION_DESCRIPTOR = new BoltConnectionDescriptor(
new InetSocketAddress( "client", 7474 ),
new InetSocketAddress( "server", 7475 ) );

@Test
public void newMachineThrowsWhenNotStarted()
{
BoltFactoryImpl boltFactory = newBoltFactory();

try
{
boltFactory.newMachine( CONNECTION_DESCRIPTOR, mock( Runnable.class ), CLOCK );
fail( "Exception expected" );
}
catch ( Exception e )
{
// expected
}
}

@Test
public void newMachineThrowsWhenStopped() throws Throwable
{
BoltFactoryImpl boltFactory = newBoltFactory();

boltFactory.start();

BoltStateMachine stateMachine = boltFactory.newMachine( CONNECTION_DESCRIPTOR, mock( Runnable.class ), CLOCK );

assertNotNull( stateMachine );

boltFactory.stop();

try
{
boltFactory.newMachine( CONNECTION_DESCRIPTOR, mock( Runnable.class ), CLOCK );
fail( "Exception expected" );
}
catch ( Exception e )
{
// expected
}
}

@Test
public void txIdStoreRefreshedAfterRestart() throws Throwable
{
GraphDatabaseAPI db = newDbMock();
DependencyResolver dependencyResolver = db.getDependencyResolver();
TransactionIdStore txIdStoreBeforeRestart = mock( TransactionIdStore.class );
when( txIdStoreBeforeRestart.getLastClosedTransactionId() ).thenReturn( 42L );
TransactionIdStore txIdStoreAfterRestart = mock( TransactionIdStore.class );
when( txIdStoreAfterRestart.getLastClosedTransactionId() ).thenReturn( 4242L );
when( dependencyResolver.resolveDependency( TransactionIdStore.class ) )
.thenReturn( txIdStoreBeforeRestart ).thenReturn( txIdStoreAfterRestart );

BoltFactoryImpl boltFactory = newBoltFactory( db );

boltFactory.start();

BoltStateMachine stateMachine1 = boltFactory.newMachine( CONNECTION_DESCRIPTOR, mock( Runnable.class ), CLOCK );
assertEquals( 42, stateMachine1.spi.transactionSpi().newestEncounteredTxId() );

boltFactory.stop();
boltFactory.start();

BoltStateMachine stateMachine2 = boltFactory.newMachine( CONNECTION_DESCRIPTOR, mock( Runnable.class ), CLOCK );
assertEquals( 4242, stateMachine2.spi.transactionSpi().newestEncounteredTxId() );
}

private static BoltFactoryImpl newBoltFactory()
{
return newBoltFactory( newDbMock() );
}

private static BoltFactoryImpl newBoltFactory( GraphDatabaseAPI db )
{
return new BoltFactoryImpl( db, new UsageData( new OnDemandJobScheduler() ), NullLogService.getInstance(),
new ThreadToStatementContextBridge(), mock( Authentication.class ), BoltConnectionTracker.NOOP,
Config.empty() );
}

private static GraphDatabaseAPI newDbMock()
{
GraphDatabaseAPI db = mock( GraphDatabaseAPI.class );
DependencyResolver dependencyResolver = mock( DependencyResolver.class );
when( db.getDependencyResolver() ).thenReturn( dependencyResolver );
GraphDatabaseQueryService queryService = mock( GraphDatabaseQueryService.class );
when( queryService.getDependencyResolver() ).thenReturn( dependencyResolver );
when( dependencyResolver.resolveDependency( GraphDatabaseQueryService.class ) ).thenReturn( queryService );
return db;
}
}
Expand Up @@ -35,8 +35,8 @@
import org.neo4j.bolt.security.auth.Authentication; import org.neo4j.bolt.security.auth.Authentication;
import org.neo4j.bolt.security.auth.BasicAuthentication; import org.neo4j.bolt.security.auth.BasicAuthentication;
import org.neo4j.bolt.v1.runtime.BoltConnectionDescriptor; import org.neo4j.bolt.v1.runtime.BoltConnectionDescriptor;
import org.neo4j.bolt.v1.runtime.BoltFactoryImpl;
import org.neo4j.bolt.v1.runtime.BoltStateMachine; import org.neo4j.bolt.v1.runtime.BoltStateMachine;
import org.neo4j.bolt.v1.runtime.LifecycleManagedBoltFactory;
import org.neo4j.graphdb.DependencyResolver; import org.neo4j.graphdb.DependencyResolver;
import org.neo4j.graphdb.config.Setting; import org.neo4j.graphdb.config.Setting;
import org.neo4j.graphdb.factory.GraphDatabaseSettings; import org.neo4j.graphdb.factory.GraphDatabaseSettings;
Expand All @@ -53,7 +53,7 @@
class SessionRule implements TestRule class SessionRule implements TestRule
{ {
private GraphDatabaseAPI gdb; private GraphDatabaseAPI gdb;
private LifecycleManagedBoltFactory boltFactory; private BoltFactoryImpl boltFactory;
private LinkedList<BoltStateMachine> runningMachines = new LinkedList<>(); private LinkedList<BoltStateMachine> runningMachines = new LinkedList<>();
private boolean authEnabled = false; private boolean authEnabled = false;


Expand All @@ -70,7 +70,7 @@ public void evaluate() throws Throwable
gdb = (GraphDatabaseAPI) new TestGraphDatabaseFactory().newImpermanentDatabase( config ); gdb = (GraphDatabaseAPI) new TestGraphDatabaseFactory().newImpermanentDatabase( config );
DependencyResolver resolver = gdb.getDependencyResolver(); DependencyResolver resolver = gdb.getDependencyResolver();
Authentication authentication = authentication( resolver.resolveDependency( AuthManager.class ) ); Authentication authentication = authentication( resolver.resolveDependency( AuthManager.class ) );
boltFactory = new LifecycleManagedBoltFactory( boltFactory = new BoltFactoryImpl(
gdb, gdb,
new UsageData( null ), new UsageData( null ),
NullLogService.getInstance(), NullLogService.getInstance(),
Expand Down

0 comments on commit bea0bda

Please sign in to comment.