library neo4j-graphunit {🖫 374, ⚐ 10, ★ 5}

graphaware/neo4j-graphunit

Graph Database Assertion Tool for Neo4j

Wednesday, August 5, 2015
by ikwattro
Repository
2 Watchers
5 Stars
374 Installations

PHP
5 Dependents
0 Suggesters
1 Forks
1 Open issues
10 Versions
1 % Grown

The README.md

Neo4j GraphUnit for PHP

Neo4j Graph Database Assertion Tool., _(*1)

, _(*2)

Usage

Require the library in your dev dependencies :, _(*3)

composer require --dev graphaware/neo4j-graphunit

Create your BaseTestCase that will extend GraphAware\Neo4j\GraphUnit\Neo4jGraphDatabaseTestCase and declare the getConnection method that should return a Client instance., _(*4)

To make things easier, you can just call the createConnection method of the parent class to bootstrap the connection., _(*5)


namespace MyVendor\MyApp\Tests;

use GraphAware\Neo4j\GraphUnit\Neo4jGraphDatabaseTestCase;

abstract class MyAppBaseTestCase extends Neo4jGraphDatabaseTestCase
{
    public function getConnection()
    {
        return $this->createConnection('localhost', 7474, 'neo4j', 'password');
    }
}

Assertions

assertNodeWithLabelExist

public function testNodeWillExist()
    {
        $q = 'CREATE (n:TestNode)';
        $this->getConnection()->sendCypherQuery($q);

        $this->assertNodeWithLabelExist('TestNode');
    }

assertNodesWithLabelCount

public function testMultipleNodesAreCreated()
    {
        $q = 'CREATE (n:TestNode), (n2:TestNode);
        $this->getConnection()->sendCypherQuery($q);

        $this->assertNodesWithLabelCount(2, 'TestNode');
    }

assertNodesCount

public function testMultipleNodesAreCreated()
    {
        $q = 'CREATE (n:TestNode), (n2:TestNode);
        $this->getConnection()->sendCypherQuery($q);

        $this->assertNodesCount(2);
    }

assertNodeHasRelationship

public function testMultipleNodesAreCreated()
    {
        $q = 'CREATE (n:User {name: "john"}), (n2:User {name: "mary"})-[:WORKS_AT]->(:Company {name:"Acme"}) RETURN n2;
        $result = $this->getConnection()->sendCypherQuery($q);

        $this->assertNodeHasRelationship($result->get('n2'), 'WORKS_AT', 'OUT');
    }

Reseting database states

You can easily reset the database state (deleting all nodes, relationships, schema indexes and constraints) during your setUp events :, _(*6)

public function setUp()
{
    $this->resetDatabase();
}

If you don't want to delete the schema indexes and constraints, just call the emptyDatabase method :, _(*7)

public function setUp()
{
    $this->emptyDatabase();
}

Preparing database states

You can just pass a Cypher pattern for preparing your database :, _(*8)

public function setUp()
{
    $state = "(a:User {name:'Abed'})-[:WORKS_AT]->(:Company {name:'Vinelab'})
    (c:User {name:'Chris'})-[:WORKS_AT]->(:Company {name:'GraphAware'})
    (a)-[:FRIEND]->(c)";
    $this->prepareDatabase($state);
}

Asserting same graphs

The library can assert that the actual graph in the database matches a graph you pass as a Cypher pattern, example :, _(*9)


public function testMyGraphIsGood()
{
    $this->assertSameGraph("(:User {name:'John'})-[:WORKS_AT]->(c:Company {name:'Acme'})");
}

// Returns true if the actual graph is identical, otherwise show errors in PHPUnit

//1) GraphAware\Neo4j\GraphUnit\Tests\Integration\SimpleIntegrationTest::testAssertSame
//Failed asserting that the expected graph is the same as the actual graph.