Neo4j Module

Neo4j is a highly scalable, robust native graph database.

Install

npm install @testcontainers/neo4j --save-dev

Examples

Connect and create a node:

it("should create a person node", async () => {
  const container = await new Neo4jContainer().start();
  const driver = neo4j.driver(
    container.getBoltUri(),
    neo4j.auth.basic(container.getUsername(), container.getPassword())
  );

  const session = driver.session();
  const personName = "Chris";
  const result = await session.run("CREATE (a:Person {name: $name}) RETURN a", { name: personName });
  const singleRecord = result.records[0];
  const node = singleRecord.get(0);
  expect(node.properties.name).toBe(personName);

  await session.close();
  await driver.close();
  await container.stop();
});

Set password:

it("should connect with custom password", async () => {
  const container = await new Neo4jContainer().withPassword("xyz1234@!").start();
  const driver = neo4j.driver(
    container.getBoltUri(),
    neo4j.auth.basic(container.getUsername(), container.getPassword())
  );

  const session = driver.session();
  const personName = "Chris";
  const result = await session.run("CREATE (a:Person {name: $name}) RETURN a", { name: personName });
  const singleRecord = result.records[0];
  const node = singleRecord.get(0);
  expect(node.properties.name).toBe(personName);

  await session.close();
  await driver.close();
  await container.stop();
});

Configure APOC:

it("should have APOC plugin installed", async () => {
  const container = await new Neo4jContainer().withApoc().withStartupTimeout(120_000).start();
  const driver = neo4j.driver(
    container.getBoltUri(),
    neo4j.auth.basic(container.getUsername(), container.getPassword())
  );

  const session = driver.session();
  const result = await session.run("CALL apoc.help('text')");
  const singleRecord = result.records[0];
  expect(singleRecord.length).toBeGreaterThan(0);

  await session.close();
  await driver.close();
  await container.stop();
});