Skip to content

Latest commit

 

History

History
84 lines (67 loc) · 3.61 KB

README.md

File metadata and controls

84 lines (67 loc) · 3.61 KB
Raw

neo4j-spock-extension

purpose

provide a convenience jar file to be used for testing Neo4j applications using Spock.

license

GPL v3

build & install

neo4j-spock-extension uses Gradle as build system. To build on your own, use ./gradlew test assemble. This project uses travis CI, current status: Build Status

usage

Depending on your project's used build system, use one of the alternatives below. � In case of Gradle, embed into your project's build.gradle the following repository and dependency:

repositories {
    mavenCentral()
    maven {url "https://raw.github.com/neo4j-contrib/m2/master/releases" }
}
....
dependencies {
    ....
    testCompile group: 'org.neo4j.contrib', name: 'neo4j-spock-extension', version: theNewestVersionSeeBelow
}

If Maven is used:

 <repositories>
    <repository>
        <id>neo4j-contrib-releases</id>
        <url>https://raw.github.com/neo4j-contrib/m2/master/releases</url>
        <releases>
            <enabled>true</enabled>
        </releases>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
</repositories>
....
<dependency>
    <groupId>org.neo4j.contrib</groupId>
    <artifactId>neo4j-spock-extension</artifactId>
    <version>theNewestVersionSeeBelow</version>
    <scope>test</scope>
</dependency>

how to use

neo4j-spock-extension supports two different types of tests:

  1. unit tests: these use internally a embedded Neo4j instance
  2. server tests: these require a full Neo4j server

For unit tests, see SampleNeo4jSpec as an example. The following noteworthy features:

  • A Neo4jResource is used with a @Rule and @Delegate annotation. Neo4jResource creates a new Neo4j embedded instance for each test case. Note that internally Neo4j's TestGraphDatabaseFactory is used.

  • The optional constructor argument for Neo4jResource might pass in config parameters used when creating the Neo4j instance

  • Since @Delegate is used, any fields and methods exposed by Neo4jResource are directly accessible

  • Neo4jResource exposes a graphDatabaseService and an executionEngine to be used in your test cases.

  • By default, there is no transactional context spawned for your test methods.

  • If a test case is annotated with @WithNeo4jTransaction, a transactional context is spawned.

  • The String class is enriched by a cypher method. The cypher method can be used with and without parameters:

     "MATCH (n) RETURN n LIMIT 10".cypher()
 "MATCH (n) RETURN n LIMIT {limit}".cypher(limit:10  )

For server tests, see SampleNeo4jServerSpec.

version compatibility

See the table below to understand which version of neo4j-spock-extension supports which version of Neo4j:

version Neo4j versions
0.3 2.0.x
0.4 2.1.x
0.5 2.2.x
0.6 2.3.x
0.7 3.0.x
0.8 3.1.x
0.9 3.2.x