コンテナーでの .NET テストの実行

前提条件

本ガイドの .NET アプリケーションのコンテナー化 から始まる前節までを完了していること。

概要

テストというものは、現代のソフトウェア開発においては重要な工程です。 開発チームによって、テストが意味するところはさまざまです。 ユニットテストがあり、インテグレーションテストがあり、エンドツーエンドテストがあります。 本ガイドでは Docker による開発およびビルド時におけるユニットテストの実行方法について見ていくことにします。

ローカルでの開発時におけるテスト実行

サンプルアプリケーションには、テストを実行するための xUnit テストが既に含まれていて、tests ディレクトリにあります。 ローカルにおいて開発を行っているときには Compose を使ってテストを実行することができます。

docker-dotnet-sample ディレクトリにおいて以下のコマンドを入力して、コンテナー内部にてテストを実行します。

$ docker compose run --build --rm server dotnet test /source/tests

以下のような出力が得られるはずです。

Starting test execution, please wait...
A total of 1 test files matched the specified pattern.

Passed!  - Failed:     0, Passed:     1, Skipped:     0, Total:     1, Duration: < 1 ms - /source/tests/bin/Debug/net6.0/tests.dll (net6.0)

コマンドの詳細については docker compose run を参照してください。

ビルド時のテスト実行

ビルド時にテストを実行するには、Dockerfile を修正する必要があります。 テストを実行するためには、新たなテストステージの生成が必要となります。 あるいは既存のビルドステージ内でのテスト実行が必要です。 本ガイドでは Dockerfile を修正して、ビルドステージ内でのテスト実行を行います。

修正した Dockerfile ファイルは以下です。

# syntax=docker/dockerfile:1

FROM --platform=$BUILDPLATFORM mcr.microsoft.com/dotnet/sdk:6.0-alpine AS build
ARG TARGETARCH
COPY . /source
WORKDIR /source/src
RUN --mount=type=cache,id=nuget,target=/root/.nuget/packages \
    dotnet publish -a ${TARGETARCH/amd64/x64} --use-current-runtime --self-contained false -o /app
RUN dotnet test /source/tests

FROM mcr.microsoft.com/dotnet/sdk:6.0-alpine AS development
COPY . /source
WORKDIR /source/src
CMD dotnet run --no-launch-profile

FROM mcr.microsoft.com/dotnet/aspnet:6.0-alpine AS final
WORKDIR /app
COPY --from=build /app .
ARG UID=10001
RUN adduser \
    --disabled-password \
    --gecos "" \
    --home "/nonexistent" \
    --shell "/sbin/nologin" \
    --no-create-home \
    --uid "${UID}" \
    appuser
USER appuser
ENTRYPOINT ["dotnet", "myWebApp.dll"]

以下のコマンドを実行します。 これは、テスト対象としてまたテスト結果を見るためのステージとしてビルドステージを利用し、イメージをビルドするものです。 --progress=plain を加えることでビルド結果を確認します。 --no-cache は常にテストを実行させるためのものです。 --target build はビルドステージをターゲットとします。

$ docker build -t dotnet-docker-image-test --progress=plain --no-cache --target build .

以下のような出力が得られます。

#11 [build 5/5] RUN dotnet test /source/tests
#11 1.564   Determining projects to restore...
#11 3.421   Restored /source/src/myWebApp.csproj (in 1.02 sec).
#11 19.42   Restored /source/tests/tests.csproj (in 17.05 sec).
#11 27.91   myWebApp -> /source/src/bin/Debug/net6.0/myWebApp.dll
#11 28.47   tests -> /source/tests/bin/Debug/net6.0/tests.dll
#11 28.49 Test run for /source/tests/bin/Debug/net6.0/tests.dll (.NETCoreApp,Version=v6.0)
#11 28.67 Microsoft (R) Test Execution Command Line Tool Version 17.3.3 (x64)
#11 28.67 Copyright (c) Microsoft Corporation.  All rights reserved.
#11 28.68
#11 28.97 Starting test execution, please wait...
#11 29.03 A total of 1 test files matched the specified pattern.
#11 32.07
#11 32.08 Passed!  - Failed:     0, Passed:     1, Skipped:     0, Total:     1, Duration: < 1 ms - /source/tests/bin/Debug/net6.0/tests.dll (net6.0)
#11 DONE 32.2s

まとめ

この節では Compose を使ったローカル開発におけるテスト実行方法について学びました。 そしてイメージビルド時にテストを実行する方法についても学びました。

関連情報

次のステップ

次は GitHub アクションをつかって CI/CD パイプラインを設定する方法について学びます。