안녕하세요 여러분 오늘은 sheepy라는 새로운 단위 테스트 라이브러리를 소개해드리려고 왔습니다. 먼저 단위 테스트의 중요성에 대해 말씀드리겠습니다. 이 라이브러리는 초보자용이 아닙니다. 단위 테스트를 수행하려면 약간의 주의가 필요합니다. 엔드포인트 및 http 오류 검사 모듈을 사용한 API 테스트에 대해서만 어설션이 있습니다.

Github 링크: github
PyPi 링크: pypi

프로덕션에 있는 모든 성숙하고 자존심 있는 소프트웨어에는 이미 코드에 있던 내용이 계속 작동하는지 확인하기 위해, 이전에 이미 보고 및 수정된 버그를 방지하기 위해, 또는 새로운 기능을 테스트하기 위해 단위 테스트가 있습니다. 이는 그들이 앞으로 나아가고 있으며 기술적 부채가 축적되지 않았음을 나타내는 좋은 표시입니다. 예를 들어 Firefox 브라우저를 사용하겠습니다. 모든 디렉토리에는 이미 보고된 버그에 대한 특정 테스트가 포함된 테스트 하위 디렉토리가 있습니다. 이렇게 하면 수정된 버그가 갑자기 다시 나타나지 않고 이미 수정된 버그가 나타나는 것을 보장합니다. 다시는 돈을 버리는 일이라고 합니다. 시간이 지남에 따라 귀하는 더 적은 리소스로 귀하보다 더 나은 성과를 거두는 경쟁사에게 시간, 비용, 효율성 및 시장 점유율을 잃게 됩니다.

무언가를 할 수 없다고 느끼는 사람은 누구나 그 일을 훼손하려고 하며, 단위 테스트도 다르지 않습니다. 인생의 모든 것과 마찬가지로 각 사용 사례를 다루는 더 나은 단위 테스트를 만들려면 시간이 걸립니다. 백엔드 단 하나의 튜토리얼을 읽고 완벽한 API를 만들었을지 의심스럽습니다. 프론트 엔드에도 마찬가지입니다. 강좌를 보고 왔을지 의심스럽습니다. 인터페이스를 완벽하게 만드는 것입니다. 그러니 단위 테스트를 하면 달라질 것이라고 생각하지 마세요!

어설션 방법

 ----------------------- ------------------------------------------------------- 
| Assertion Method       | Description                                           |
 ----------------------- ------------------------------------------------------- 
| assertEqual(a, b)      | Checks if two values are equal.                       |
| assertNotEqual(a, b)   | Checks if two values are not equal.                   |
| assertTrue(expr)       | Verifies that the expression is True.                 |
| assertFalse(expr)      | Verifies that the expression is False.                |
| assertRaises(exc, fn)  | Asserts that a function raises a specific exception.  |
| assertStatusCode(resp) | Verifies if the response has the expected status code.|
| assertJsonResponse(resp)| Confirms the response is in JSON format.             |
| assertResponseContains(resp, key) | Ensures the response contains a given key. |
 ----------------------- ------------------------------------------------------- 

설치

설치는 매우 간단합니다. pip가 설치된 터미널을 열고 pip install sheepy를 입력하면 됩니다.

사용 예

from sheepy.sheeptest import SheepyTestCase

class ExampleTest(SheepyTestCase):
    def test_success(self):
        self.assertTrue(True)

    def test_failure(self):
        self.assertEqual(1, 2)

    def test_error(self):
        raise Exception("Forced error")

    @SheepyTestCase.skip("Reason to ignore")
    def test_skipped(self):
        pass

    @SheepyTestCase.expectedFailure
    def test_expected_failure(self):
        self.assertEqual(1, 2)

SheepyTestCase 클래스는 테스트 건너뛰기 또는 예상되는 실패 처리와 같은 특수 동작을 구성하기 위한 주장성 메서드 및 메커니즘을 포함하여 단위 테스트를 생성하고 실행하기 위한 여러 기능을 제공합니다.

ExampleTest 클래스 내에는 5개의 테스트 메서드가 정의되어 있습니다.

test_success: 이 테스트는 AssertTrue 메소드에 전달된 표현식이 true인지 확인합니다. True 값이 명시적으로 전달되므로 이 테스트는 성공합니다.

test_failure: 이 테스트는 AssertEqual 메소드를 사용하여 두 값 사이의 동등성을 확인합니다. 그러나 비교된 값인 1과 2가 다르기 때문에 테스트 실패가 발생합니다. 이는 테스트가 불일치를 감지해야 하는 예상된 실패 사례를 보여줍니다.

test_error: 이 메서드는 "강제 오류" 메시지와 함께 의도적인 예외를 발생시킵니다. 목표는 테스트 실행 중에 발생하는 오류를 처리할 때 시스템의 동작을 테스트하는 것입니다. 메소드가 이를 처리하지 않고 예외를 발생시키므로 결과는 테스트에서 오류가 됩니다.

test_skipped: 이 테스트는 SheepyTestCase 클래스의 건너뛰기 메소드로 장식되었습니다. 즉, 테스트를 실행하는 동안 건너뛰게 됩니다. 테스트를 건너뛰는 이유는 "무시 이유"로 제공되었으며, 이 근거는 최종 테스트 보고서에 표시될 수 있습니다.

test_expected_failure: 이 메소드는 ExpectFailure 데코레이터를 사용하여 실패가 예상됨을 나타냅니다. 메서드 내부에는 1과 2 사이의 동등성 검사가 있는데, 이는 일반적으로 실패를 초래하지만 데코레이터가 적용됨에 따라 프레임워크는 이 실패를 예상되는 동작의 일부로 간주하고 오류로 처리되지 않습니다. "예상된 실패"로 간주됩니다.

산출

테스트 결과:
예Test.test_error: FAIL - 강제 오류
예Test.test_expected_failure: 예상된 실패
예Test.test_failure: FAIL - 1 != 2
예제Test.test_skipped: 생략됨 -
예Test.test_success: 확인

Api 테스트 케이스

Sheepy 테스트 프레임워크의 API 테스트는 간단하면서도 강력하도록 설계되어 테스터가 GET, POST, PUT 및 DELETE와 같은 일반적인 HTTP 메서드를 사용하여 API와 상호 작용할 수 있습니다. 프레임워크는 HttpError 예외 클래스를 통해 내장된 오류 관리 기능을 통해 요청 보내기 및 응답 처리를 단순화하기 위한 전용 클래스인 ApiRequests를 제공합니다.

API를 테스트할 때 테스트 클래스는 API의 동작을 확인하기 위한 다양한 어설션 메서드를 갖춘 SheepyTestCase를 상속합니다. 여기에는 HTTP 상태 코드를 검증하는 AssertStatusCode, 응답이 JSON 형식인지 확인하는 AssertJsonResponse, 응답 본문에 특정 키가 있는지 확인하는 AssertResponseContains가 포함됩니다.

예를 들어, 프레임워크를 사용하면 API에 POST 요청을 보내고, 상태 코드가 예상 값과 일치하는지 확인하고, JSON 응답에 올바른 데이터가 포함되어 있는지 확인할 수 있습니다. API 요청은 요청 구성 및 전송을 관리하는 ApiRequests 클래스를 통해 처리되며, 서버가 예상치 못한 상태 코드를 반환할 때 HTTP 관련 오류를 발생시켜 오류 처리가 간소화됩니다.

내장된 어설션 및 오류 처리를 제공함으로써 프레임워크는 API 테스트에서 반복적인 작업의 대부분을 자동화하여 테스트 작성의 정확성과 단순성을 모두 보장합니다. 이 시스템을 통해 개발자는 API 동작과 논리를 확인하는 데 집중할 수 있으므로 API 상호 작용의 안정성을 보장하는 효율적인 도구가 됩니다.

from sheepy.sheeptest import SheepyTestCase  

class TestHttpBinApi(SheepyTestCase):
    def __init__(self):

        super().__init__(base_url="https://httpbin.org")

    def test_get_status(self):

        response = self.api.get("/status/200")
        self.assertStatusCode(response, 200)  

    def test_get_json(self):

        response = self.api.get("/json")
        self.assertStatusCode(response, 200)  
        self.assertJsonResponse(response)  
        self.assertResponseContains(response, "slideshow")  

    def test_post_data(self):

        payload = {"name": "SheepyTest", "framework": "unittest"}
        response = self.api.post("/post", json=payload)
        self.assertStatusCode(response, 200)  
        self.assertJsonResponse(response)  
        self.assertResponseContains(response, "json") 
        self.assertEqual(response.json()["json"], payload)  

    def test_put_data(self):

        payload = {"key": "value"}
        response = self.api.put("/put", json=payload)
        self.assertStatusCode(response, 200)  
        self.assertJsonResponse(response)  
        self.assertResponseContains(response, "json")  
        self.assertEqual(response.json()["json"], payload)  

    def test_delete_resource(self):

        response = self.api.delete("/delete")
        self.assertStatusCode(response, 200)  
        self.assertJsonResponse(response)  

출력 예시

Test Results:
TestHttpBinApi.test_delete_resource: OK
TestHttpBinApi.test_get_json: OK
TestHttpBinApi.test_get_status: OK
TestHttpBinApi.test_post_data: OK
TestHttpBinApi.test_put_data: OK

요약:

새로운 sheepy 라이브러리는 API 테스트 전용 모듈을 포함하여 여러 테스트 액세스 방법을 갖춘 놀라운 단위 테스트 라이브러리입니다. 제 생각에는 초보자를 위한 라이브러리가 아니며 객체 지향 프로그래밍에 대한 기본 지식이 필요합니다. 메소드, 클래스, 상속 등이 있습니다.