Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Add Neo4j example #1013

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions docs/modules/neo4j.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Neo4j

[Neo4j](https://neo4j.com/product/neo4j-graph-database/) is a graph database designed to work with nodes and edges. It is a ACID-compliant transactional graph database engine, and developers can communicate with it using the HTTP endpoint or by using the **Bolt** protocol.

The following example uses the following NuGet packages:

```console title="Install the NuGet dependencies"
dotnet add package Testcontainers.Neo4j
dotnet add package Neo4j.Driver
dotnet add package xunit
```

IDEs and editors may also require the following packages to run tests: `xunit.runner.visualstudio` and `Microsoft.NET.Test.Sdk`.

Copy and paste the following code into a new `.cs` test file within an existing test project.

```csharp
using Neo4j.Driver;
using Testcontainers.Neo4j;
using Xunit;

namespace TestcontainersModules;

public class Neo4jContainerTest : IAsyncLifetime
{
private readonly Neo4jContainer neo4jContainer
= new Neo4jBuilder()
.Build();

[Fact]
public async Task CanReadNeo4jDatabase()
{
const string database = "neo4j";

await using var client = GraphDatabase.Driver(neo4jContainer.GetConnectionString());

await using var session = client.AsyncSession(cfg => cfg.WithDatabase(database));

Assert.Equal(database, session.SessionConfig.Database);
}

public Task InitializeAsync()
=> neo4jContainer.StartAsync();

public Task DisposeAsync()
=> neo4jContainer.DisposeAsync().AsTask();
}
```

To execute the tests, use the command `dotnet test` from a terminal.

[xunit]: https://xunit.net/