大家好,今天我来给大家介绍一个新的单元测试库,叫做sheepy,不过首先我们来说说单元测试的重要性。这个库不适合初学者,要使用它进行单元测试,您需要额外注意。它仅具有用于使用端点和 http 错误检查模块进行 API 测试的断言。
Github链接:github
PyPi 链接:pypi
生产中所有成熟、有自尊的软件都有单元测试,无论是为了了解代码中已有的内容是否仍然有效,为了防止之前已经报告和修复的错误,还是为了测试新功能,它很好地表明他们正在向前推进,并且没有积累技术债务。我们以火狐浏览器为例,每个目录下有一个tests子目录,针对已经报告的bug进行专门的测试,这样就保证了已经修复的bug不会再凭空出现,已经修复的bug就会出现又无处可去 这叫扔钱。随着时间的推移,您将失去时间、金钱、效率和市场份额,而竞争对手却比您做得更好,资源更少。
每个感觉自己无能为力的人都会试图诽谤那件事,单元测试也不例外。创建覆盖每个用例的更好的单元测试需要时间,就像生活中的一切一样,你的后端我怀疑你只阅读了一个教程并做出了完美的 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类中,定义了五个测试方法:
test_success:此测试检查传递给assertTrue方法的表达式是否为true。由于 True 值已显式传递,因此此测试将成功。
test_failure:此测试使用assertEqual方法检查两个值之间的相等性。然而,比较值1和2不同,导致测试失败。这演示了预期失败的情况,其中测试必须检测到不一致。
test_error:此方法会引发一个有目的的异常,并显示消息“强制错误”。目标是测试系统在处理测试执行期间发生的错误时的行为。由于该方法抛出异常而不对其进行处理,因此测试中将出现错误。
test_skipped:此测试已使用 SheepyTestCase 类的 Skip 方法进行修饰,这意味着在运行测试时将跳过该测试。跳过测试的原因被提供为“忽略的原因”,并且此理由可以显示在最终的测试报告中。
test_expected_failure:该方法使用expectedFailure装饰器,表示预计会发生失败。在方法内部,在 1 和 2 之间存在相等性检查,这通常会导致失败,但是随着装饰器的应用,框架认为这种失败是预期行为的一部分,不会被视为错误,但是作为“预期的失败”。
输出
测试结果:
ExampleTest.test_error:失败 - 强制错误
ExampleTest.test_expected_failure: 预期失败
ExampleTest.test_failure: FAIL - 1 != 2
ExampleTest.test_skipped: 跳过 -
ExampleTest.test_success: OK
API测试用例
Sheepy 测试框架中的 API 测试被设计得简单而强大,允许测试人员使用常见的 HTTP 方法(如 GET、POST、PUT 和 DELETE)与 API 进行交互。该框架提供了一个专用类 ApiRequests 来简化发送请求和处理响应,并通过 HttpError 异常类进行内置错误管理。
测试API时,测试类继承自SheepyTestCase,它配备了各种断言方法来验证API的行为。其中包括用于验证 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测试的模块,在我看来,它不是一个适合初学者的库,它需要面向对象编程的基础知识例如方法、类和继承。
免责声明: 提供的所有资源部分来自互联网,如果有侵犯您的版权或其他权益,请说明详细缘由并提供版权或权益证明然后发到邮箱:[email protected] 我们会第一时间内为您处理。
Copyright© 2022 湘ICP备2022001581号-3