”工欲善其事,必先利其器。“—孔子《论语.录灵公》
首页 > 编程 > 使用 Sheepy 在 Python 中进行单元测试

使用 Sheepy 在 Python 中进行单元测试

发布于2024-11-08
浏览:174

Unit testing in Python with sheepy

大家好,今天我来给大家介绍一个新的单元测试库,叫做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测试的模块,在我看来,它不是一个适合初学者的库,它需要面向对象编程的基础知识例如方法、类和继承。

版本声明 本文转载于:https://dev.to/brunociccarino/unit-testing-in-python-with-sheepy-b93?1如有侵犯,请联系[email protected]删除
最新教程 更多>
  • 除了“if”语句之外:还有什么地方可以在不进行强制转换的情况下使用具有显式“bool”转换的类型?
    除了“if”语句之外:还有什么地方可以在不进行强制转换的情况下使用具有显式“bool”转换的类型?
    无需强制转换即可上下文转换为 bool您的类定义了对 bool 的显式转换,使您能够在条件语句中直接使用其实例“t”。然而,这种显式转换提出了一个问题:“t”在哪里可以在不进行强制转换的情况下用作 bool?上下文转换场景C 标准指定了四种值可以根据上下文转换为的主要场景bool:语句:if、whi...
    编程 发布于2024-12-26
  • 如何在 PHP 中组合两个关联数组,同时保留唯一 ID 并处理重复名称?
    如何在 PHP 中组合两个关联数组,同时保留唯一 ID 并处理重复名称?
    在 PHP 中组合关联数组在 PHP 中,将两个关联数组组合成一个数组是一项常见任务。考虑以下请求:问题描述:提供的代码定义了两个关联数组,$array1 和 $array2。目标是创建一个新数组 $array3,它合并两个数组中的所有键值对。 此外,提供的数组具有唯一的 ID,而名称可能重合。要求...
    编程 发布于2024-12-26
  • 尽管代码有效,为什么 POST 请求无法捕获 PHP 中的输入?
    尽管代码有效,为什么 POST 请求无法捕获 PHP 中的输入?
    解决 PHP 中的 POST 请求故障在提供的代码片段中:action=''而不是:action="<?php echo $_SERVER['PHP_SELF'];?>";?>"检查 $_POST数组:表单提交后使用 var_dump 检查 $_POST 数...
    编程 发布于2024-12-26
  • 插入数据时如何修复“常规错误:2006 MySQL 服务器已消失”?
    插入数据时如何修复“常规错误:2006 MySQL 服务器已消失”?
    插入记录时如何解决“一般错误:2006 MySQL 服务器已消失”介绍:将数据插入 MySQL 数据库有时会导致错误“一般错误:2006 MySQL 服务器已消失”。当与服务器的连接丢失时会出现此错误,通常是由于 MySQL 配置中的两个变量之一所致。解决方案:解决此错误的关键是调整wait_tim...
    编程 发布于2024-12-26
  • HTML 格式标签
    HTML 格式标签
    HTML 格式化元素 **HTML Formatting is a process of formatting text for better look and feel. HTML provides us ability to format text without us...
    编程 发布于2024-12-26
  • 如何使用 MySQL 查找今天生日的用户?
    如何使用 MySQL 查找今天生日的用户?
    如何使用 MySQL 识别今天生日的用户使用 MySQL 确定今天是否是用户的生日涉及查找生日匹配的所有行今天的日期。这可以通过一个简单的 MySQL 查询来实现,该查询将存储为 UNIX 时间戳的生日与今天的日期进行比较。以下 SQL 查询将获取今天有生日的所有用户: FROM USERS ...
    编程 发布于2024-12-26
  • Bootstrap 4 Beta 中的列偏移发生了什么?
    Bootstrap 4 Beta 中的列偏移发生了什么?
    Bootstrap 4 Beta:列偏移的删除和恢复Bootstrap 4 在其 Beta 1 版本中引入了重大更改柱子偏移了。然而,随着 Beta 2 的后续发布,这些变化已经逆转。从 offset-md-* 到 ml-auto在 Bootstrap 4 Beta 1 中, offset-md-*...
    编程 发布于2024-12-26
  • 如何修复 macOS 上 Django 中的“配置不正确:加载 MySQLdb 模块时出错”?
    如何修复 macOS 上 Django 中的“配置不正确:加载 MySQLdb 模块时出错”?
    MySQL配置不正确:相对路径的问题在Django中运行python manage.py runserver时,可能会遇到以下错误:ImproperlyConfigured: Error loading MySQLdb module: dlopen(/Library/Python/2.7/site-...
    编程 发布于2024-12-26
  • 在 Go 中使用 WebSocket 进行实时通信
    在 Go 中使用 WebSocket 进行实时通信
    构建需要实时更新的应用程序(例如聊天应用程序、实时通知或协作工具)需要比传统 HTTP 更快、更具交互性的通信方法。这就是 WebSockets 发挥作用的地方!今天,我们将探讨如何在 Go 中使用 WebSocket,以便您可以向应用程序添加实时功能。 在这篇文章中,我们将介绍: WebSocke...
    编程 发布于2024-12-26
  • 大批
    大批
    方法是可以在对象上调用的 fns 数组是对象,因此它们在 JS 中也有方法。 slice(begin):将数组的一部分提取到新数组中,而不改变原始数组。 let arr = ['a','b','c','d','e']; // Usecase: Extract till index p...
    编程 发布于2024-12-26
  • 如何在 HTML 表格中有效地使用 Calc() 和基于百分比的列?
    如何在 HTML 表格中有效地使用 Calc() 和基于百分比的列?
    在表格中使用 Calc():克服百分比困境创建具有固定宽度列和可变宽度列的表格可能具有挑战性,尤其是在尝试在其中使用 calc() 函数。在 HTML 中,使用 px 或 em 设置固定列宽非常简单。但是,对于可变宽度列,通常使用百分比 (%) 单位。然而,当在表中使用 calc() 时,百分比似乎...
    编程 发布于2024-12-26
  • 如何在PHP中通过POST提交和处理多维数组?
    如何在PHP中通过POST提交和处理多维数组?
    在 PHP 中通过 POST 提交多维数组当使用具有可变长度的多列和行的 PHP 表单时,有必要进行转换输入到多维数组中。这是解决这一挑战的方法。首先,为每列分配唯一的名称,例如:<input name="topdiameter[' current ']" type=&qu...
    编程 发布于2024-12-26
  • for(;;) 循环到底是什么以及它是如何工作的?
    for(;;) 循环到底是什么以及它是如何工作的?
    揭秘神秘的 for(;;) 循环在古老的代码库深处,你偶然发现了一个令人困惑的奇特 for 循环你的理解。其显示如下:for (;;) { //Some stuff }您深入研究在线资源,但发现自己陷入沉默。让我们剖析这个神秘的构造。for 循环的结构Java 中的 for 循环遵循特定的语...
    编程 发布于2024-12-25
  • Java 的 Scanner.useDelimiter() 如何使用正则表达式?
    Java 的 Scanner.useDelimiter() 如何使用正则表达式?
    Java 中使用 Scanner.useDelimiter 了解分隔符Java 中的 Scanner 类提供了 useDelimiter 方法,允许您指定分隔符(字符或模式)来分隔代币。然而,使用分隔符可能会让初学者感到困惑。让我们用更简单的术语来分解它。考虑片段:sc = new Scanner(...
    编程 发布于2024-12-25
  • 如何在 Android 中显示动画 GIF?
    如何在 Android 中显示动画 GIF?
    在 Android 中显示动画 GIF尽管最初误解 Android 不支持动画 GIF,但实际上它具有解码和显示动画的能力显示它们。这是通过利用 android.graphics.Movie 类来实现的,尽管这方面没有广泛记录。要分解动画 GIF 并将每个帧作为可绘制对象合并到 AnimationD...
    编程 发布于2024-12-25

免责声明: 提供的所有资源部分来自互联网,如果有侵犯您的版权或其他权益,请说明详细缘由并提供版权或权益证明然后发到邮箱:[email protected] 我们会第一时间内为您处理。

Copyright© 2022 湘ICP备2022001581号-3