You need docker to be installed on your machine. Tested both on Windows and Linux.
Run this in your package manager console:
Install-Package TestEnvironment.Docker
To add container specific functionality for MSSQL, Elasticsearch or MongoDB:
Install-Package TestEnvironment.Docker.Containers.Elasticsearch
Install-Package TestEnvironment.Docker.Containers.Mssql
Install-Package TestEnvironment.Docker.Containers.Mongo
Install-Package TestEnvironment.Docker.Containers.Mail
Install-Package TestEnvironment.Docker.Containers.Ftp
Install-Package TestEnvironment.Docker.Containers.MariaDB
Install-Package TestEnvironment.Docker.Containers.Postgres
Install-Package TestEnvironment.Docker.Containers.Kafka
Install-Package TestEnvironment.Docker.Containers.Redis
Install-Package TestEnvironment.Docker.Containers.RabbitMQ
Latest version is heavily using C# 9 records feature. Please make sure you are targeting net5.0
and above.
// Create the environment using builder pattern.
await using var environment = new DockerEnvironmentBuilder()
.AddContainer(p => p with
{
Name = "my-nginx",
ImageName = "nginx"
})
.AddElasticsearchContainer(p => p with
{
Name = "my-elastic"
})
.AddMssqlContainer(p => p with
{
Name = "my-mssql",
SAPassword = "HelloK11tt_0"
})
.AddPostgresContainer(p => p with
{
Name = "my-postgres"
})
.AddFromDockerfile(p => p with
{
Name = "from-file",
Dockerfile = "Dockerfile",
ContainerWaiter = new HttpContainerWaiter("/", port: 8080)
})
.Build();
// Up it.
await environment.UpAsync();
// Play with containers.
var mssql = environment.GetContainer<MssqlContainer>("my-mssql");
var elastic = environment.GetContainer<ElasticsearchContainer>("my-elastic");
var postgres = environment.GetContainer<PostgresContainer>("my-postgres");
As you may know, Docker announced subscription changes. So you can not use Docker Desktop for free anymore (except for personal purposes). Good news is that Docker for Linux is still free (including Docker Engine, Docker Daemon, Docker CLI, Docker Compose, BuildKit, libraries, etc). So we have several options:
You can setup WSL2 on your Windows machine, install .NET and Docker (also, full instruction for Docker setup could be found here). Then just navigate to your source code and simply run:
dotnet test
Ok, you still want to use Visual Studio to run and debug your tests. So this is still possible. First, you need to expose your Docker Daemon installed to WSL2. For this, go to /etc/docker/
and create/edit daemon.js
file:
{
"hosts": ["tcp://0.0.0.0:2375", "unix:///var/run/docker.sock"]
}
Then add UseWsl2()
option to your tests:
await using var environment = new DockerEnvironmentBuilder()
.UseWsl2()
.AddMssqlContainer(p => p with
{
Name = "my-mssql",
SAPassword = "HelloK11tt_0"
})
And that's it!
Official instruction regarding Docker remote access are here.
As a container engine you can use Podman instead of docker. It works the same and even has the same api. To install podman on Windows and use it follow this instruction (Super easy).
In case of unpredictable behaviour try to remove the containers manually via command line:
docker rm -f (docker ps -a -q)
If you use AddFromDockerfile() then it is recommended to prune images time to time:
docker image prune -f
Ideally, use the --filter
option on the docker image prune
commandline task. Simply add LABEL "CI_BUILD=True"
in your Dockerfile, and force delete all images with that LABEL:
docker image prune -f --filter "CI_BUILD=True"
net5.0
framework. Please reference 1.x.x packages if you need netstandard2.0
support. This version will continue getting critical fixes in branch.