Golang에서 Mock의 사용법에 대해 토론

Golang은 점점 더 많은 개발자들에게 환영받고 사랑받는 오픈 소스 정적인 유형의 프로그래밍 언어입니다. 테스트 코드를 작성할 때 Mock 데이터를 처리해야 하는 경우가 종종 있습니다. 이 기사에서는 Golang에서 Mock을 사용하는 방법과 다양한 시나리오에서 Mock 데이터를 처리하는 방법을 살펴보겠습니다.

1. 모의가 필요한 이유는 무엇입니까?

테스트 과정에서 타사 서비스(예: API, 데이터베이스, 메시지 대기열 등)에 의존하는 일부 코드를 테스트해야 하는 경우가 종종 있습니다. 이를 위해서는 테스트 코드가 독립적이고 빠르게 실행될 수 있도록 Mocking 기술을 사용하여 이러한 종속 서비스의 응답 결과를 시뮬레이션해야 합니다.

또한 Mocking을 사용하여 코드의 경계 조건(요구 사항을 충족하지 않는 입력 데이터와 같은 비정상적인 상황 등)을 테스트하여 코드의 견고성과 신뢰성을 높일 수도 있습니다.

2. Golang의 모의 도구

Golang에서 선택할 수 있는 모의 도구는 다음과 같습니다.

1. testify: 사용하기 매우 쉬운 모의 및 어설션 기능을 제공합니다. 데이터베이스, HTTP 요청 및 기타 서비스와 같은 일반적인 데이터 소스 및 출력을 시뮬레이션하는 데 사용할 수 있습니다.
2. 조롱: 상대적으로 말하면 이 도구는 더 가볍습니다. 빠르고 정확하게 Mock 코드를 생성할 수 있으며, 런타임 Mocking 기능을 지원합니다. 또한, mockery는 Mock 코드를 생성할 때 템플릿 기반 출력을 지원하므로 사용자에게 더 많은 사용자 정의 옵션을 제공할 수 있습니다.
3. mockery/mockery: 위의 조롱과 비교할 때 이 도구는 Go 언어 개발자의 요구 사항에 더 중점을 둡니다. 코드 테스트 가능성을 가능하게 하는 보다 유연한 API를 제공합니다. 모의 인터페이스 메서드를 지원하는 것 외에도 Mockery는 비침해적인 외부 종속성을 모의할 수도 있습니다.

3. Mocking을 위해 testify를 사용하세요

아래에서는 testify를 Mocking 도구로 사용하고 예제를 사용하여 Mocking 기술을 사용하여 코드를 테스트하는 방법을 보여줍니다.

다음 함수는 데이터를 얻기 위해 외부 HTTP API를 사용한다고 가정합니다.

func getOrderDetail(orderID int) (OrderDetail, error){
    resp, err := http.Get("https://api.example.com/order/"+strconv.Itoa(orderID))
    if err != nil {
        return nil, err
    }
    defer resp.Body.Close()
    
    if resp.StatusCode != http.StatusOK {
        return nil, fmt.Errorf("getOrderDetail API returns error status code: %d", resp.StatusCode)
    }

    var orderDetail OrderDetail
    return orderDetail, json.NewDecoder(resp.Body).Decode(&orderDetail)
}

이 함수를 테스트하려면 HTTP 요청을 모의해야 합니다. testify는 HTTP 요청 모의를 구현하기 위해 MockHTTPServer와 RoundTripper라는 두 가지 메서드를 제공합니다.

먼저 MockHTTPServer 사용 방법을 살펴보겠습니다.

func TestGetOrderDetail(t *testing.T) {
    // 创建一个mock server
    server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        // 按照需要返回数据
        if r.URL.Path == "/order/123" {
            fmt.Fprintln(w, "{\"orderID\":123,\"createDate\":\"2021-01-01\"}")
        } else {
            http.Error(w, "not found", http.StatusNotFound)
        }
    }))
    defer server.Close()

    // 将http client的请求地址指向mock server
    oldClient := http.DefaultClient
    http.DefaultClient = server.Client()
    defer func() { http.DefaultClient = oldClient }()

    // 调用 getOrderDetail() 函数
    orderDetail, err := getOrderDetail(123)

    // 对 getOrderDetail() 的返回结果进行断言
    assert.Nil(t, err)
    assert.Equal(t, 123, orderDetail.OrderID) // 假设OrderDetail中包含了字段 OrderID

    // 按照需要进行其他断言
}

이 예에서는 httptest.NewServer() 메서드를 사용하여 모의 서버를 만든 다음 HTTP 요청의 응답 및 상태 코드 반환을 시뮬레이션합니다. handlerFunc() 입니다.

다음으로, 테스트 중에 getOrderDetail()이 호출되면 모의 서버에 요청을 보낼 수 있도록 http.DefaultClient를 모의 서버에 지정합니다.

마지막으로 testify의 어설션 메서드를 사용하여 반환된 결과를 확인하여 함수의 정확성을 확인합니다.

MockHTTPServer 외에도 testify는 HTTP 요청을 모의하는 RoundTripper 메서드도 제공합니다. 이 메서드는 HTTP 요청을 시뮬레이션하는 보다 유연하고 제어 가능한 방법을 제공합니다. 사용자는 RoundTripper 구현을 사용자 정의하여 언제든지 모의 데이터 소스로 전환하여 테스트 프로세스를 더 효과적으로 제어할 수 있습니다. 독자는 testify 공식 문서를 참조하여 이 방법의 사용에 대해 자세히 알아볼 수 있습니다.

4. 조롱을 위해 조롱을 사용하세요

증언 외에도 조롱을 사용할 수도 있습니다. Mockery는 언어에 내장된 모의 라이브러리(http://golang.org/pkg/mock/)를 기반으로 하며 재사용 가능한 모의 코드를 위한 프레임워크를 생성할 수 있는 코드 생성 도구를 제공합니다. Mockery는 인터페이스 및 외부 종속성 Mock 코드 생성을 지원합니다. 아래 예시로 인터페이스 모드 Mocking을 소개하겠습니다.

먼저 모커리 생성 도구를 설치해야 합니다.

go get github.com/vektra/mockery/v2/.../

다음으로 인터페이스를 정의하고 여기에 메서드를 추가합니다.

type OrderDetailFetcher interface {
    FetchOrderDetail(orderID int) (OrderDetail, error)
}

그런 다음 프로젝트의 루트 디렉터리에서 다음 명령을 실행하여 모의 코드를 생성합니다. :

mockery --name OrderDetailFetcher

이렇게 하면 자동으로 생성된 모의 코드가 이미 포함된 "mock_orderdetailfetcher.go"라는 파일이 자동으로 생성됩니다. 모든 코드에서 이 모의 코드를 사용하여 인터페이스의 모의 데이터를 구현하고 테스트 작업을 완료할 수 있습니다.

마지막으로 모의 코드를 생성하기 위해 모의 코드를 사용하는 방법을 보여주는 구체적인 예를 제공합니다.

type OrderDetail struct {
    OrderID     int
    CreateDate  string
}

type OrderDetailFetcher interface {
    FetchOrderDetail(orderID int) (OrderDetail, error)
}

func GetOrderDetail(fetcher OrderDetailFetcher, orderID int) (OrderDetail, error) {
    orderDetail, err := fetcher.FetchOrderDetail(orderID)
    if err != nil {
        return OrderDetail{}, err
    }

    return orderDetail, nil
}

이 예에서는 "OrderDetailFetcher"라는 인터페이스를 정의하고 GetOrderDetail() 함수를 구현합니다. 이 함수에는 FetchOrderDetail( ) OrderDetailFetcher 인터페이스의 메서드를 사용하여 주문 세부정보를 가져옵니다. mockery 명령을 사용하여 FetchOrderDetail() 메서드에 대한 모의 코드를 자동으로 생성할 수 있습니다:

mockery --name OrderDetailFetcher

이 명령은 자동으로 생성된 모의 코드가 포함된 "mock_orderdetailfetcher.go"라는 파일을 현재 디렉터리에 생성합니다. 기능 테스트 작업을 완료하려면 모의 코드와 테스트 코드를 결합하기만 하면 됩니다.

func TestGetOrderDetail(t *testing.T) {
    orderDetail := OrderDetail{OrderID: 123, CreateDate: "2021-01-01"}

    // 创建一个mock对象
    mockOrderDetailFetcher := &mocks.OrderDetailFetcher{}

    // 设定mock对象的mock调用及对应的返回结果
    mockOrderDetailFetcher.On("FetchOrderDetail", 123).Return(orderDetail, nil)

    // 调用GetOrderDetail()函数
    result, err := GetOrderDetail(mockOrderDetailFetcher, 123)

    // 校验返回结果及错误码
    assert.Nil(t, err)
    assert.Equal(t, orderDetail, result)
}

이 예에서는 mockOrderDetailFetcher 개체를 정의하고 Mock 라이브러리의 On() 메서드를 사용하여 FetchOrderDetail() 메서드에 대한 특정 호출 규칙과 해당 결과를 지정합니다. orderID는 123입니다. 이 경우 orderDetail 개체는 반환됩니다. mockOrderDetailFetcher의 FetchOrderDetail(123)을 가져올 때 테스트 코드는 미리 구성된 orderDetail 개체를 직접 반환합니다. 마지막으로 testify의 Assertion 방식을 사용하여 결과를 검증한다.

요약

이 글에서는 Mocking in Golang 관련 지식과 일반적인 Mocking 도구를 소개하고, testify 및 mockery 도구를 사용하여 Mocking 작업을 수행하고 대상 기능에 대한 Mock 테스트를 완료하는 방법을 소개합니다. Mocking 기술의 합리적이고 올바른 적용을 통해 코드의 가독성, 견고성, 신뢰성 및 기타 측면을 향상시킬 수 있습니다. 동시에 Mocking은 다양한 코드에서 발생할 수 있는 문제를 신속하게 찾아 해결하고 테스트 코드의 적용 범위와 정확성을 향상시키는 데 도움이 될 수 있습니다.

위 내용은 Golang에서 Mock의 사용법에 대해 토론의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!