diff --git a/_data/toc.yaml b/_data/toc.yaml index a0ef4db5d2..c27f8537c9 100644 --- a/_data/toc.yaml +++ b/_data/toc.yaml @@ -125,6 +125,8 @@ guides: path: /language/dotnet/run-containers/ - title: "Develop your app" path: /language/dotnet/develop/ + - title: "Run your tests" + path: /language/dotnet/run-tests/ - title: "Configure CI/CD" path: /language/dotnet/configure-ci-cd/ - title: "Deploy your app" diff --git a/language/dotnet/configure-ci-cd.md b/language/dotnet/configure-ci-cd.md index 2c9627b7d0..0e9467c049 100644 --- a/language/dotnet/configure-ci-cd.md +++ b/language/dotnet/configure-ci-cd.md @@ -4,7 +4,7 @@ keywords: .net, CI/CD, local, development description: Learn how to Configure CI/CD for your application --- -{% include_relative nav.html selected="4" %} +{% include_relative nav.html selected="5" %} ## Get started with GitHub Actions diff --git a/language/dotnet/deploy.md b/language/dotnet/deploy.md index a7962547c0..3180d4dfec 100644 --- a/language/dotnet/deploy.md +++ b/language/dotnet/deploy.md @@ -4,7 +4,7 @@ keywords: deploy, ACI, ECS, .net, local, development description: Learn how to deploy your application --- -{% include_relative nav.html selected="5" %} +{% include_relative nav.html selected="6" %} {% include deploy.md %} diff --git a/language/dotnet/develop.md b/language/dotnet/develop.md index 7c316e70d8..18bb1d30b8 100644 --- a/language/dotnet/develop.md +++ b/language/dotnet/develop.md @@ -451,9 +451,9 @@ Now let’s test our application. Using a web browser, access `http://localhost: ## Next steps -In the next module, we’ll take a look at how to set up a CI/CD pipeline using GitHub Actions. See: +In the next module, we’ll take a look at how to write containerized tests in Docker. See: -[Configure CI/CD](configure-ci-cd.md){: .button .primary-btn} +[Run your tests](run-tests.md){: .button .primary-btn} ## Feedback diff --git a/language/dotnet/nav.html b/language/dotnet/nav.html index 4c618b39ed..476e06ec91 100644 --- a/language/dotnet/nav.html +++ b/language/dotnet/nav.html @@ -2,6 +2,7 @@
  • Build images
  • Run your image as a container
  • Use containers for development
    • -
  • Configure CI/CD
    • -
  • Deploy your app
    • +
  • Run your tests
    • +
  • Configure CI/CD
    • +
  • Deploy your app
    • diff --git a/language/dotnet/run-tests.md b/language/dotnet/run-tests.md new file mode 100644 index 0000000000..66a9c70d14 --- /dev/null +++ b/language/dotnet/run-tests.md @@ -0,0 +1,125 @@ +--- +title: "Run your tests" +keywords: .NET, build, test +description: How to build and run your tests +--- + +{% include_relative nav.html selected="4" %} + +## Prerequisites + +Work through the steps to build an image and run it as a containerized application in [Use containers for development](develop.md). + +## Introduction + +Testing is an essential part of modern software development. In combination with 3rd party frameworks or services, Docker helps to test applications without mocks or complicated environment configurations fast and reliably. + +## Add .NET test project + +To test our sample application, we create a standalone test project from a template using the .NET CLI. On your local machine, open a terminal, change the directory to the `dotnet-docker` directory and run the following command: + +```console +$ cd /path/to/dotnet-docker +$ dotnet new xunit -n myWebApp.Tests -o tests +``` + +Next, we'll update the test project and add the Testcontainers for .NET package that allows us to run tests against Docker resources. Switch to the `tests` directory and run the following command: + +```console +$ dotnet add package Testcontainers +``` + +## Add a test + +Open the test project in your favorite IDE and replace the contents of `UnitTest1` with the following code: + +```c# +using System.Net; +using DotNet.Testcontainers.Builders; +using DotNet.Testcontainers.Containers; +using DotNet.Testcontainers.Networks; + +public sealed class UnitTest1 : IAsyncLifetime, IDisposable +{ + private const ushort HttpPort = 80; + + private readonly CancellationTokenSource _cts = new(TimeSpan.FromMinutes(1)); + + private readonly IDockerNetwork _network; + + private readonly IDockerContainer _dbContainer; + + private readonly IDockerContainer _appContainer; + + public UnitTest1() + { + _network = new TestcontainersNetworkBuilder() + .WithName(Guid.NewGuid().ToString("D")) + .Build(); + + _dbContainer = new TestcontainersBuilder() + .WithImage("postgres") + .WithNetwork(_network) + .WithNetworkAliases("db") + .WithVolumeMount("postgres-data", "/var/lib/postgresql/data") + .Build(); + + _appContainer = new TestcontainersBuilder() + .WithImage("dotnet-docker") + .WithNetwork(_network) + .WithPortBinding(HttpPort, true) + .WithWaitStrategy(Wait.ForUnixContainer().UntilPortIsAvailable(HttpPort)) + .Build(); + } + + public async Task InitializeAsync() + { + await _network.CreateAsync(_cts.Token) + .ConfigureAwait(false); + + await _dbContainer.StartAsync(_cts.Token) + .ConfigureAwait(false); + + await _appContainer.StartAsync(_cts.Token) + .ConfigureAwait(false); + } + + public Task DisposeAsync() + { + return Task.CompletedTask; + } + + public void Dispose() + { + _cts.Dispose(); + } + + [Fact] + public async Task Test1() + { + using var httpClient = new HttpClient(); + httpClient.BaseAddress = new UriBuilder("http", _appContainer.Hostname, _appContainer.GetMappedPublicPort(HttpPort)).Uri; + + var httpResponseMessage = await httpClient.GetAsync(string.Empty) + .ConfigureAwait(false); + + var body = await httpResponseMessage.Content.ReadAsStringAsync() + .ConfigureAwait(false); + + Assert.Equal(HttpStatusCode.OK, httpResponseMessage.StatusCode); + Assert.Contains("Welcome", body); + } +} +``` + +The test class picks up the configurations and lessons we learned in the previous steps. It connects our application and database through a custom Docker network and runs an HTTP request against our application. As you can see, running containerized tests allows us to test applications without mocks or complicated environment configurations. The tests run on any Docker-API compatible environments including CI. + +## Next steps + +In the next module, we’ll take a look at how to set up a CI/CD pipeline using GitHub Actions. See: + +[Configure CI/CD](configure-ci-cd.md){: .button .primary-btn} + +## Feedback + +Help us improve this topic by providing your feedback. Let us know what you think by creating an issue in the [Docker Docs](https://github.com/docker/docker.github.io/issues/new?title=[dotnet%20docs%20feedback]){:target="_blank" rel="noopener" class="_"} GitHub repository. Alternatively, [create a PR](https://github.com/docker/docker.github.io/pulls){:target="_blank" rel="noopener" class="_"} to suggest updates. \ No newline at end of file