Microsoft MVP성태의 닷넷 이야기
.NET Framework: 1084. C# - .NET Core Web API 단위 테스트 방법 [링크 복사], [링크+제목 복사]
조회: 571
글쓴 사람
정성태 (techsharer at outlook.com)
홈페이지
첨부 파일

C# - .NET Core Web API 단위 테스트 방법

다음과 같은 글이 있군요. ^^

C# Web API: How to call your endpoint through integration tests
; https://dev.to/willianantunes/c-web-api-how-to-call-your-endpoint-through-integration-tests-li1

위의 글은 xUnit으로 설명하고 있는데, 그대로 하면 재미가 없으니 저는 위의 설명을 MSTest로 바꿔서 정리해 보겠습니다. ^^




우선 ASP.NET Core Web API 프로젝트를 하나 생성하고, "C# Web API: How to call your endpoint through integration tests" 글에서 공개한 예제 코드를 다음과 같이 적용해 보겠습니다.

using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Logging;
using System;

namespace WebApplication1.Controllers
{
    [ApiController]
    [Route("api/v1/[controller]")]
    public class MoviesController : ControllerBase
    {
        private readonly IFilmSpecialist _filmSpecialist;
        private readonly ILogger<WeatherForecastController> _logger;

        public MoviesController(ILogger<WeatherForecastController> logger, IFilmSpecialist filmSpecialist)
        {
            _logger = logger;
            _filmSpecialist = filmSpecialist;
        }

        [HttpGet]
        public Movie Get()
        {
            _logger.Log(LogLevel.Information, "Let me ask the film specialist...");
            var movie = _filmSpecialist.SuggestSomeMovie();
            _logger.Log(LogLevel.Information, "Suggested movie: {Movie}", movie);
            return movie;
        }
    }

    public interface IFilmSpecialist
    {
        Movie SuggestSomeMovie();
    }

    public class Movie
    {
        public string Title { get; }
        public string Release { get; }
        public string[] Genres { get; }
        public string Duration { get; }

        public Movie(string title, string release, string[] genres, string duration)
        {
            Title = title;
            Release = release;
            Genres = genres;
            Duration = duration;
        }
    }
}

실제 업무에서는 _filmSpecialist.SuggestSomeMovie()의 호출은 Startup.cs의 ConfigureServices에서 설정한 IFilmSpecialist 구현체가 주입이 될 것이므로 대개의 경우 DB와 같은 storage와 연계가 될 것입니다. 그리고 그렇게 구현이 완료되면 "http://localhost:7732/api/v1/Movies"라는 호출에 대해 영화 추천 결과가 하나 나올 것입니다.




자, 그럼 이제부터 단위 테스트를 작성해 볼까요? 가장 먼저 처리해야 할 것은 "_filmSpecialist.SuggestSomeMovie()" 호출에서 storage를 직접 접근하는 것이 아닌, fake 동작을 수행할 타입을 마련하는 것입니다.

public class FilmSpecialist : IFilmSpecialist
{
    private static readonly Movie[] Films =
    {
        new("RoboCop", "10/08/1987", new[] {"Action", "Thriller", "Science Fiction"}, "1h 42m"),
        new("The Matrix", "05/21/1999", new[] {"Action", "Science Fiction"}, "2h 16m"),
        new("Soul", "12/25/2020", new[] {"Family", "Animation", "Comedy", "Drama", "Music", "Fantasy"}, "1h 41m"),
        new("Space Jam", "12/25/1996", new[] {"Adventure", "Animation", "Comedy", "Family"}, "1h 28m"),
        new("Aladdin", "07/03/1993", new[] {"Animation", "Family", "Adventure", "Fantasy", "Romance"}, "1h 28m"),
        new("The World of Dragon Ball Z", "01/21/2000", new[] {"Action"}, "20m"),
    };

    public Movie SuggestSomeMovie()
    {
        Random random = new();
        var filmIndexThatIWillSuggest = random.Next(0, Films.Length);

        return Films[filmIndexThatIWillSuggest];
    }
}

그리고 이 상태에서 Web API가 아닌, MoviesController.Get 내부의 _filmSpecialist.SuggestSomeMovie(); 메서드를 단위 테스트 하는 것이라면 다음과 같은 식으로 처리하게 될 것입니다.

[TestClass]
public class MoviesControllerTests
{
    private readonly IFilmSpecialist _filmSpecialist = new FilmSpecialist();

    [TestMethod()]
    public void GetTest()
    {
        var suggestedMovie = _filmSpecialist.SuggestSomeMovie();

        var expectedTiles = new[]
        {
            "RoboCop", "The Matrix", "Soul", "Space Jam", "Aladdin", "The World of Dragon Ball Z"
        };

        CollectionAssert.Contains(expectedTiles, suggestedMovie.Title);
    }
}

하지만, 우리가 원하는 것은 해당 Web API의 [Route("api/v1/[controller]")] 설정까지 반영된 MoviesController.Get 메서드가 호출되는 것을 단위 테스트 범위로 넣고 싶은 것입니다.

이를 위해 Microsoft는 WebApplicationFactory 타입을 제공하고 있으며 그 방법도 아래의 문서에서 자세하게 소개하고 있습니다.

ASP.NET Core MVC 앱 테스트
; https://docs.microsoft.com/ko-kr/dotnet/architecture/modern-web-apps-azure/test-asp-net-core-mvc-apps

Integration tests in ASP.NET Core
; https://docs.microsoft.com/en-us/aspnet/core/test/integration-tests

해당 타입을 사용하려면 우선 Microsoft.AspNetCore.Mvc.Testing 패키지를 참조 추가하고,

Install-Package Microsoft.AspNetCore.Mvc.Testing

이후, ClassInitialize로 WebApplicationFactory<Startup> 인스턴스를 생성해 테스트 대상인 Web API와 유사한 환경을 제공한 후,

static WebApplicationFactory<Startup> _factory;
static HttpClient _httpClient;

[ClassInitialize]
public static void TestInitialize(TestContext _)
{
    _factory = new WebApplicationFactory<Startup>();
    _httpClient = _factory.WithWebHostBuilder(builder =>
    {
        builder.ConfigureTestServices(services =>
        {
            services.AddScoped(typeof(IFilmSpecialist), typeof(FilmSpecialist));
        });
    }).CreateClient();
}

다음과 같이 Web API를 HttpClient로 호출하면서 실제 Web Server에서 호스팅 중인 Web API를 접근하는 것처럼 단위 테스트를 만들 수 있습니다.

[TestMethod()]
public async Task GetTest()
{
    var requestPath = "/api/v1/movies";
    var response = await _httpClient.GetAsync(requestPath);
    Assert.AreEqual(HttpStatusCode.OK, response.StatusCode);

    var movie = await response.Content.ReadFromJsonAsync<Movie>();

    var expectedTiles = new[]
    {
        "RoboCop", "The Matrix", "Soul", "Space Jam", "Aladdin", "The World of Dragon Ball Z"
    };

    CollectionAssert.Contains(expectedTiles, movie.Title);
}




"C# Web API: How to call your endpoint through integration tests" 글을 보면 Mock을 사용해,

Install-Package Moq

class FilmSpecialist 정의까지 없애고 있는데요, 이것 역시 동일하게 MSTest에서도 적용할 수 있습니다. 아래는 이를 반영한 단위 테스트 전체 소스 코드입니다.

using Microsoft.VisualStudio.TestTools.UnitTesting;
using WebApplication1.Controllers;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc.Testing;
using Microsoft.AspNetCore.TestHost;
using System.Net.Http;
using Microsoft.Extensions.DependencyInjection;
using System.Net.Http.Json;
using System.Net;
using Moq;
using Microsoft.Extensions.DependencyInjection.Extensions;

namespace WebApplication1.Controllers.Tests
{
    [TestClass]
    public class MoviesControllerTests
    {
        static IFilmSpecialist _filmSpecialist;
        static WebApplicationFactory<Startup> _factory;
        static HttpClient _httpClient;

        [ClassInitialize]
        public static void TestInitialize(TestContext _)
        {
            _filmSpecialist = Mock.Of<IFilmSpecialist>();

            _factory = new WebApplicationFactory<Startup>();
            _httpClient = _factory.WithWebHostBuilder(builder =>
            {
                builder.ConfigureTestServices(services =>
                {
                    services.RemoveAll<IFilmSpecialist>();
                    services.TryAddTransient(_ => _filmSpecialist);
                });
            }).CreateClient();
        }


        [TestMethod()]
        public async Task GetTestWithMock()
        {
            var requestPath = "/api/v1/movies";
            var movieToBeSuggested = new Movie("Schindler's List", "12/31/1993", new[] { "Drama", "History", "War" }, "3h 15m");
            Mock.Get(_filmSpecialist)
                .Setup(f => f.SuggestSomeMovie())
                .Returns(movieToBeSuggested)
                .Verifiable();

            var response = await _httpClient.GetAsync(requestPath);
            Assert.AreEqual(HttpStatusCode.OK, response.StatusCode);

            var movie = await response.Content.ReadFromJsonAsync<Movie>();
            Assert.AreEqual(movieToBeSuggested, movie);
        }
    }
}

(첨부 파일은 이 글의 예제 코드를 포함합니다.)

그러니까, 결국 이 글 하나를 쓰려고 했는데 어쩌다가 글 타래가 엮여 다음의 글들까지 써진 것입니다. ^^;

비주얼 스튜디오 - 단위 테스트 선택 시 MSTestv2 외의 xUnit, NUnit 사용법
; https://www.sysnet.pe.kr/2/0/12726

MSTestv2 단위 테스트에 메서드/클래스/어셈블리 수준의 문맥 제공
; https://www.sysnet.pe.kr/2/0/12728

xUnit 단위 테스트에 메서드/클래스 수준의 문맥 제공 - Fixture
; https://www.sysnet.pe.kr/2/0/12729

C# 단위 테스트 - MSTestv2/NUnit의 Assert.Inconclusive 사용법(?)
; https://www.sysnet.pe.kr/2/0/12727

Visual Studio 2017부터 단위 테스트에 DataRow 특성 지원
; https://www.sysnet.pe.kr/2/0/12749

MSTest - 단위 테스트에 static/instance 유형의 private 멤버 접근 방법
; https://www.sysnet.pe.kr/2/0/12755




참고로, 단위 테스트 메서드를 비동기로 하려는 경우 단순히 async로만 지정하면 안 됩니다.

[TestMethod()]
public async void GetTestWithMock()
{
    // ...[생략]...
}

저렇게 하면 단위 테스트의 Run/Debug 시에 아예 해당 메서드가 실행조차 안 되는 것을 확인할 수 있습니다. 반드시 "async Task"로 해줘야 합니다. ^^

[TestMethod()]
public async Task GetTestWithMock()
{
    // ...[생략]...
}





[이 글에 대해서 여러분들과 의견을 공유하고 싶습니다. 틀리거나 미흡한 부분 또는 의문 사항이 있으시면 언제든 댓글 남겨주십시오.]



donaricano-btn



[최초 등록일: ]
[최종 수정일: 8/7/2021]

Creative Commons License
이 저작물은 크리에이티브 커먼즈 코리아 저작자표시-비영리-변경금지 2.0 대한민국 라이센스에 따라 이용하실 수 있습니다.
by SeongTae Jeong, mailto:techsharer at outlook.com

비밀번호

댓글 쓴 사람
 




[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...
NoWriterDateCnt.TitleFile(s)
12936정성태1/22/202223.NET Framework: 1138. C# - ffmpeg(FFmpeg.AutoGen)를 이용해 멀티미디어 파일의 메타데이터를 보여주는 예제(metadata.c)파일 다운로드1
12935정성태1/22/202218.NET Framework: 1137. ffmpeg의 파일 해시 예제(ffhash.c)를 C#으로 포팅파일 다운로드1
12934정성태1/22/202212오류 유형: 788. Warning C6262 Function uses '65564' bytes of stack: exceeds /analyze:stacksize '16384'. Consider moving some data to heap.
12933정성태1/21/202226.NET Framework: 1136. C# - ffmpeg(FFmpeg.AutoGen)를 이용해 MP2 오디오 파일 디코딩 예제(decode_audio.c)파일 다운로드1
12932정성태1/20/202265.NET Framework: 1135. C# - ffmpeg(FFmpeg.AutoGen)로 하드웨어 가속기를 이용한 비디오 디코딩 예제(hw_decode.c) [2]파일 다운로드1
12931정성태1/20/202270개발 환경 구성: 632. ASP.NET Core 프로젝트를 AKS/k8s에 올리는 과정
12930정성태1/19/202234개발 환경 구성: 631. AKS/k8s의 Volume에 파일 복사하는 방법
12929정성태1/19/202254개발 환경 구성: 630. AKS/k8s의 Pod에 Volume 연결하는 방법
12928정성태1/18/202246개발 환경 구성: 629. AKS/Kubernetes에서 호스팅 중인 pod에 shell(/bin/bash)로 진입하는 방법
12927정성태1/18/202251개발 환경 구성: 628. AKS 환경에 응용 프로그램 배포 방법
12926정성태1/17/202226오류 유형: 787. AKS - pod 배포 시 ErrImagePull/ImagePullBackOff 오류
12925정성태1/17/202266개발 환경 구성: 627. AKS의 준비 단계 - ACR(Azure Container Registry)에 docker 이미지 배포
12924정성태1/15/2022138.NET Framework: 1134. C# - ffmpeg(FFmpeg.AutoGen)를 이용한 비디오 디코딩 예제(decode_video.c) [2]파일 다운로드1
12923정성태1/15/202275개발 환경 구성: 626. ffmpeg.exe를 사용해 비디오 파일을 MPEG1 포맷으로 변경하는 방법
12922정성태1/14/202277개발 환경 구성: 625. AKS - Azure Kubernetes Service 생성 및 SLO/SLA 변경 방법
12921정성태1/14/202255개발 환경 구성: 624. Docker Desktop에서 별도 서버에 설치한 docker registry에 이미지 올리는 방법
12920정성태1/14/202223오류 유형: 786. Camtasia - An error occurred with the camera: Failed to Add Video Sampler.
12919정성태1/13/202280Windows: 199. Host Network Service (HNS)에 의해서 점유되는 포트
12918정성태1/13/202277Linux: 47. WSL - shell script에서 설정한 환경 변수가 스크립트 실행 후 반영되지 않는 문제
12917정성태1/12/202243오류 유형: 785. C# - The type or namespace name '...' could not be found (are you missing a using directive or an assembly reference?)
12916정성태1/12/202228오류 유형: 784. TFS - One or more source control bindings for this solution are not valid and are listed below.
12915정성태1/11/202259오류 유형: 783. Visual Studio - We didn't find any interpreters
12914정성태1/11/2022165VS.NET IDE: 172. 비주얼 스튜디오 2022의 파이선 개발 환경 지원
12913정성태1/11/2022131.NET Framework: 1133. C# - byte * (바이트 포인터)를 FileStream으로 쓰는 방법
12912정성태1/11/2022119개발 환경 구성: 623. ffmpeg.exe를 사용해 비디오 파일의 이미지를 PGM(Portable Gray Map) 파일 포맷으로 출력하는 방법
[1]  2  3  4  5  6  7  8  9  10  11  12  13  14  15  ...