Neo4jRule (Neo4j - Test Harness 3.3.0 API)

java.lang.Object
- org.neo4j.harness.junit.Neo4jRule

All Implemented Interfaces:

org.junit.rules.TestRule, TestServerBuilder
```
public class Neo4jRule
extends Object
implements org.junit.rules.TestRule, TestServerBuilder
```
A convenience wrapper around TestServerBuilder, exposing it as a JUnit rule. Note that it will try to start the web server on the standard 7474 port, but if that is not available (typically because you already have an instance of Neo4j running) it will try other ports. Therefore it is necessary for the test code to use httpURI() and then URI.resolve(String) to create the URIs to be invoked.

Constructor Summary

Constructors
Constructor and Description

Neo4jRule()

Neo4jRule(File workingDirectory)

Constructors
Constructor and Description
`Neo4jRule()`
`Neo4jRule(File workingDirectory)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`org.junit.runners.model.Statement`	`apply(org.junit.runners.model.Statement base, org.junit.runner.Description description)`
`URI`	`boltURI()`
`Neo4jRule`	`copyFrom(File sourceDirectory)` Pre-populate the server with a database copied from the specified directory
`org.neo4j.graphdb.config.Configuration`	`getConfig()`
`org.neo4j.graphdb.GraphDatabaseService`	`getGraphDatabaseService()`
`URI`	`httpsURI()`
`URI`	`httpURI()`
`ServerControls`	`newServer()` Start a new server.
`Neo4jRule`	`withAggregationFunction(Class<?> functionClass)` Configure the server to load the specified aggregation function definition class.
`Neo4jRule`	`withConfig(org.neo4j.graphdb.config.Setting<?> key, String value)` Configure the Neo4j instance.
`Neo4jRule`	`withConfig(String key, String value)`
`Neo4jRule`	`withExtension(String mountPath, Class<?> extension)` Shortcut for configuring the server to use an unmanaged extension.
`Neo4jRule`	`withExtension(String mountPath, String packageName)` Shortcut for configuring the server to find and mount all unmanaged extensions in the given package.
`Neo4jRule`	`withFixture(File cypherFileOrDirectory)` Data fixtures to inject upon server start.
`Neo4jRule`	`withFixture(Function<org.neo4j.graphdb.GraphDatabaseService,Void> fixtureFunction)` Data fixture to inject upon server start.
`Neo4jRule`	`withFixture(String fixtureStatement)` Data fixture to inject upon server start.
`Neo4jRule`	`withFunction(Class<?> functionClass)` Configure the server to load the specified function definition class.
`Neo4jRule`	`withProcedure(Class<?> procedureClass)` Configure the server to load the specified procedure definition class.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Neo4jRule
```
public Neo4jRule()
```
  - Neo4jRule
```
public Neo4jRule(File workingDirectory)
```
- Method Detail
  - apply
```
public org.junit.runners.model.Statement apply(org.junit.runners.model.Statement base,
                                               org.junit.runner.Description description)
```
    Specified by:
    
    apply in interface org.junit.rules.TestRule
  - newServer
```
public ServerControls newServer()
```
    Description copied from interface: TestServerBuilder
    
    Start a new server. By default, the server will listen to a random free port, and you can determine where to connect using the ServerControls.httpURI() method. You could also specify explicit ports using the TestServerBuilder.withConfig(org.neo4j.graphdb.config.Setting, String) method. Please refer to the Neo4j Manual for details on available configuration options. When the returned controls are closed, the temporary directory the server used will be removed as well.
    
    Specified by:
    
    newServer in interface TestServerBuilder
  - withConfig
```
public Neo4jRule withConfig(org.neo4j.graphdb.config.Setting<?> key,
                            String value)
```
    Description copied from interface: TestServerBuilder
    
    Configure the Neo4j instance. Configuration here can be both configuration aimed at the server as well as the database tuning options. Please refer to the Neo4j Manual for details on available configuration options.
    
    Specified by:
    
    withConfig in interface TestServerBuilder
    
    Parameters:
    
    key - the config key
    
    value - the config value
    
    Returns:
    
    this builder instance
  - withConfig
```
public Neo4jRule withConfig(String key,
                            String value)
```
    Specified by:
    
    withConfig in interface TestServerBuilder
    
    See Also:
    
    TestServerBuilder.withConfig(org.neo4j.graphdb.config.Setting, String)
  - withExtension
```
public Neo4jRule withExtension(String mountPath,
                               Class<?> extension)
```
    Description copied from interface: TestServerBuilder
    
    Shortcut for configuring the server to use an unmanaged extension. Please refer to the Neo4j Manual on how to write unmanaged extensions.
    
    Specified by:
    
    withExtension in interface TestServerBuilder
    
    Parameters:
    
    mountPath - the http path, relative to the server base URI, that this extension should be mounted at.
    
    extension - the extension class.
    
    Returns:
    
    this builder instance
  - withExtension
```
public Neo4jRule withExtension(String mountPath,
                               String packageName)
```
    Description copied from interface: TestServerBuilder
    
    Shortcut for configuring the server to find and mount all unmanaged extensions in the given package.
    
    Specified by:
    
    withExtension in interface TestServerBuilder
    
    Parameters:
    
    mountPath - the http path, relative to the server base URI, that this extension should be mounted at.
    
    packageName - a java package with extension classes.
    
    Returns:
    
    this builder instance
    
    See Also:
    
    TestServerBuilder.withExtension(String, Class)
  - withFixture
```
public Neo4jRule withFixture(File cypherFileOrDirectory)
```
    Description copied from interface: TestServerBuilder
    
    Data fixtures to inject upon server start. This can be either a file with a plain-text cypher query (for example, myFixture.cyp), or a directory containing such files with the suffix ".cyp".
    
    Specified by:
    
    withFixture in interface TestServerBuilder
    
    Parameters:
    
    cypherFileOrDirectory - file with cypher statement, or directory containing ".cyp"-suffixed files.
    
    Returns:
    
    this builder instance
  - withFixture
```
public Neo4jRule withFixture(String fixtureStatement)
```
    Description copied from interface: TestServerBuilder
    
    Data fixture to inject upon server start. This should be a valid Cypher statement.
    
    Specified by:
    
    withFixture in interface TestServerBuilder
    
    Parameters:
    
    fixtureStatement - a cypher statement
    
    Returns:
    
    this builder instance
  - withFixture
```
public Neo4jRule withFixture(Function<org.neo4j.graphdb.GraphDatabaseService,Void> fixtureFunction)
```
    Description copied from interface: TestServerBuilder
    
    Data fixture to inject upon server start. This should be a user implemented fixture function operating on a GraphDatabaseService instance
    
    Specified by:
    
    withFixture in interface TestServerBuilder
    
    Parameters:
    
    fixtureFunction - a fixture function
    
    Returns:
    
    this builder instance
  - copyFrom
```
public Neo4jRule copyFrom(File sourceDirectory)
```
    Description copied from interface: TestServerBuilder
    
    Pre-populate the server with a database copied from the specified directory
    
    Specified by:
    
    copyFrom in interface TestServerBuilder
    
    Parameters:
    
    sourceDirectory - the directory to copy from
    
    Returns:
    
    this builder instance
  - withProcedure
```
public Neo4jRule withProcedure(Class<?> procedureClass)
```
    Description copied from interface: TestServerBuilder
    
    Configure the server to load the specified procedure definition class. The class should contain one or more methods annotated with Procedure, these will become available to call through cypher.
    
    Specified by:
    
    withProcedure in interface TestServerBuilder
    
    Parameters:
    
    procedureClass - a class containing one or more procedure definitions
    
    Returns:
    
    this builder instance
  - withFunction
```
public Neo4jRule withFunction(Class<?> functionClass)
```
    Description copied from interface: TestServerBuilder
    
    Configure the server to load the specified function definition class. The class should contain one or more methods annotated with UserFunction, these will become available to call through cypher.
    
    Specified by:
    
    withFunction in interface TestServerBuilder
    
    Parameters:
    
    functionClass - a class containing one or more function definitions
    
    Returns:
    
    this builder instance
  - withAggregationFunction
```
public Neo4jRule withAggregationFunction(Class<?> functionClass)
```
    Description copied from interface: TestServerBuilder
    
    Configure the server to load the specified aggregation function definition class. The class should contain one or more methods annotated with UserAggregationFunction, these will become available to call through cypher.
    
    Specified by:
    
    withAggregationFunction in interface TestServerBuilder
    
    Parameters:
    
    functionClass - a class containing one or more function definitions
    
    Returns:
    
    this builder instance
  - boltURI
```
public URI boltURI()
```
  - httpURI
```
public URI httpURI()
```
  - httpsURI
```
public URI httpsURI()
```
  - getGraphDatabaseService
```
public org.neo4j.graphdb.GraphDatabaseService getGraphDatabaseService()
```
  - getConfig
```
public org.neo4j.graphdb.config.Configuration getConfig()
```

Class Neo4jRule

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Neo4jRule

Neo4jRule

Method Detail

apply

newServer

withConfig

withConfig

withExtension

withExtension

withFixture

withFixture

withFixture

copyFrom

withProcedure

withFunction

withAggregationFunction

boltURI

httpURI

httpsURI

getGraphDatabaseService

getConfig