使用django构建表单测试

本文涉及的产品
服务治理 MSE Sentinel/OpenSergo,Agent数量 不受限
可观测可视化 Grafana 版,10个用户账号 1个月
简介: 【6月更文挑战第14天】该文档介绍了如何对本地库进行自动化测试,特别是关注于代码结构和模型测试。作者鼓励为其他模型和表单创建类似的测试,并提及测试应避免对底层框架的重复验证。

1 本地库的测试

**一个完整的测试过程,应该包括测试方法、测试工具、测试范围、测试种类、测试的软件硬件环境、测试进度、测试人员的分工和职责以及测试流程进行详细的定义和整体的描述。

包括测试资源,工具,环境,风险评估,缺陷跟踪方式的说明。**

mandala曼德罗符号.png

但是这里只表达自动化测试代码的结构。表单测试可覆盖模型的各个部分,包括字段标签和长度等。

本文提供了一个Owner模型的测试示例,展示了如何创建测试用例,如测试字段标签和方法。表单测试遵循相似理念,确保字段、标签和帮助文本正确,同时验证输入的有效性。

我们已经知道了如何运行我们的测试以及我们需要测试什么样的东西,如果不清楚请查看文末的参考链接,
让我们看一些实际的例子。

这应该可以让您了解测试的工作原理,以及您还能做什么。

2 模型

如上所述,我们应该测试任何属于我们设计的一部分或由我们编写的代码定义的内容,而不是已经由 Django 或 Python 开发团队测试过的库/代码。

例如,考虑下面的模型。在这里,我们应该测试所有字段的标签,因为即使我们没有明确指定其中的大多数,我们有一个设计来说明这些值应该是什么。

如果我们不测试这些值,那么我们就不知道字段标签是否具有其预期值。
同样,虽然我们相信 Django会创建一个指定长度的字段Author,但值得为此长度指定一个测试以确保它按计划实现。

 class Owner(models.Model):
            first_name = models.CharField(max_length=100)
            last_name = models.CharField(max_length=100)
            date_of_birth = models.DateField(null=True, blank=True)
            date_of_death = models.DateField('Died', null=True, blank=True)

            def get_absolute_url(self):
                return reverse('author-detail', args=[str(self.id)])

            def __str__(self):
                return f'{self.last_name}, {self.first_name}'

打开我们的 /blog/tests/test_models.py,并将任何现有代码替换为模型的以下Owner测试代码。

在这里,您将看到我们首先使用描述性名称从中导入TestCase并派生我们的测试类 (AuthorModel),以便我们可以轻松识别测试输出中的任何失败测试。

然后,我们调用setUpTestData()创建一个作者对象,我们将在任何测试中使用但不会修改该对象。

    from django.test import TestCase

    from blog.models import Author

    class OwnerModelTest(TestCase):
        @classmethod
        def setUpTestData(cls):
            # Set up non-modified objects used by all test methods
            Author.objects.create(first_name='Big', last_name='Bob')

        def test_first_name_label(self):
            author = Owner.objects.get(id=1)
            field_label = author._meta.get_field('first_name').verbose_name
            self.assertEqual(field_label, 'first name')

        def test_date_of_death_label(self):
            author = Owner.objects.get(id=1)
            field_label = author._meta.get_field('date_of_death').verbose_name
            self.assertEqual(field_label, 'died')

        def test_first_name_max_length(self):
            author = Owner.objects.get(id=1)
            max_length = author._meta.get_field('first_name').max_length
            self.assertEqual(max_length, 100)

        def test_object_name_is_last_name_comma_first_name(self):
            author = Owner.objects.get(id=1)
            expected_object_name = f'{author.last_name}, {author.first_name}'
            self.assertEqual(str(author), expected_object_name)

        def test_get_absolute_url(self):
            author = Owner.objects.get(id=1)
            # This will also fail if the urlconf is not defined.
            self.assertEqual(author.get_absolute_url(), '/blog/author/1')

字段测试检查字段标签 (verbose_name) 的值以及字符字段的大小是否符合预期。这些方法都有描述性名称,并遵循相同的模式:

获取一个测试对象

    author = Owner.objects.get(id=1)

获取必填字段的元数据并使用它来查询必填字段数据

    field_label = author._meta.get_field('first_name').verbose_name

将值与预期结果进行比较

      self.assertEqual(field_label, 'first name')

需要注意的有趣事情是:

我们不能直接使用 author.first_name.verbose_name ,因为是一个字符串verbose_name(不是我们可以用来访问其属性的对象的句柄)。

相反,我们需要使用作者的属性来获取字段的实例,并使用它来查询其他信息。

    author.first_name
    first_name_meta

我们选择使用 .而不是这样做的原因是,如果测试失败,前者的输出会告诉您标签的实际内容,这使得调试问题变得更加容易。

    assertEqual(field_label,'first name')
    assertTrue(field_label == 'first name')

省略了对last_name 和 date_of_birth标签的测试以及对字段长度的测试。
按照上面显示的命名约定和方法,立即添加last_name到您自己的测试集。

我们还需要测试我们的自定义方法。

这些本质上只是检查对象名称是否按照我们的预期使用“姓氏”、“名字”格式构造,以及我们获得的Author项目的 URL 是否符合我们的预期。

    def test_object_name_is_last_name_comma_first_name(self):
        author = Author.objects.get(id=1)
        expected_object_name = f'{author.last_name}, {author.first_name}'
        self.assertEqual(str(author), expected_object_name)

如果urlconf没有被提前定义,这个用例将会失败。

    def test_get_absolute_url(self):
        author = Author.objects.get(id=1)
        # 测试点
        self.assertEqual(author.get_absolute_url(), '/blog/author/1')

立即运行测试。

如果按照模型教程中所述创建了作者模型,则很可能会收到如下所示的date_of_death标签错误。

测试失败了,因为它是期望标签定义遵循 Django的约定,即不大写标签的第一个字母(Django 为你这样做)。

        ======================================================================
    FAIL: test_date_of_death_label (blog.tests.test_models.AuthorModelTest)
    ----------------------------------------------------------------------
    Traceback (most recent call last):
      File "D:\...\blog\tests\test_models.py", line 32, in test_date_of_death_label
        self.assertEqual(field_label,'died')
    AssertionError: 'Died' != 'died'
    - Died
    ? ^
    + died
    ? ^

这是一个非常小的错误,但它确实强调了编写测试如何更彻底地检查您可能所做的任何假设。

将字段 (/blog/models.py) 的date_of_death标签更改为“Died”,然后重新运行测试。

测试其他模型的模式类似,因此我们不会继续进一步讨论这些模式。请随意为我们的其他模型创建自己的测试。

3 表单测试

测试表单的理念与测试模型的理念相同;
您需要测试已编码或设计指定的任何内容,但不需要测试底层框架和其他第三方库的行为。

通常,这意味着您应该测试表单是否具有所需的字段,并且这些字段是否以适当的标签和帮助文本显示。

你不需要验证 Django 是否正确验证了字段类型(除非你创建了自己的自定义字段和验证)——也就是说,你不需要测试电子邮件字段是否只接受电子邮件。

但是,您需要测试您希望对字段执行的任何其他验证以及代码将针对错误生成的任何消息。

考虑我们更新书籍的形式。这只有一个用于续订日期的字段,该字段将具有我们需要验证的标签和帮助文本。

图书管理员更新书籍的表格。检查日期是否不是过去的日期。

    class RenewBookForm(forms.Form):

        renewal_date = forms.DateField(help_text="Enter a date between now and 4 weeks (default 3).")

        def clean_renewal_date(self):
            data = self.cleaned_data['renewal_date']

检查日期是否不是过去的日期。

            if data < datetime.date.today():
                raise ValidationError(_('Invalid date - renewal in past'))

检查日期是否在允许的范围内(+从今天起 4 周).

            if data > datetime.date.today() + datetime.timedelta(weeks=4):
                raise ValidationError(_('Invalid date - renewal more than 4 weeks ahead'))

请记住始终返回清理后的数据。

            return data

打开我们的 /blog/tests/test_forms.py 文件,并将任何现有代码替换为表单的以下测试代码。

我们首先导入我们的表单以及一些 Python 和 Django 库来帮助测试与时间相关的功能。

然后,我们以与模型相同的方式声明表单测试类RenewBookForm,为派生的测试类使用描述性名称。

    import datetime

    from django.test import TestCase
    from django.utils import timezone

    from blog.forms import RenewBookForm

    class RenewBookFormTest(TestCase):
        def test_renew_form_date_field_label(self):
            form = RenewBookForm()
            self.assertTrue(form.fields['renewal_date'].label is None or form.fields['renewal_date'].label == 'renewal date')

        def test_renew_form_date_field_help_text(self):
            form = RenewBookForm()
            self.assertEqual(form.fields['renewal_date'].help_text, 'Enter a date between now and 4 weeks (default 3).')

        def test_renew_form_date_in_past(self):
            date = datetime.date.today() - datetime.timedelta(days=1)
            form = RenewBookForm(data={'renewal_date': date})
            self.assertFalse(form.is_valid())

        def test_renew_form_date_too_far_in_future(self):
            date = datetime.date.today() + datetime.timedelta(weeks=4) + datetime.timedelta(days=1)
            form = RenewBookForm(data={'renewal_date': date})
            self.assertFalse(form.is_valid())

        def test_renew_form_date_today(self):
            date = datetime.date.today()
            form = RenewBookForm(data={'renewal_date': date})
            self.assertTrue(form.is_valid())

        def test_renew_form_date_max(self):
            date = timezone.localtime() + datetime.timedelta(weeks=4)
            form = RenewBookForm(data={'renewal_date': date})
            self.assertTrue(form.is_valid())

前两个函数测试字段是否与预期一致。
我们必须使用字段字典访问字段(例如label)。

请注意,我们还必须测试标签值help_text 是否为form.fields['renewal_date'],
因为即使 Django 会渲染正确的标签,如果没有显式设置值,它也会返回 None

其余函数测试表单是否对可接受范围内的续订日期有效,而对范围之外的值无效。

请注意我们如何围绕当前日期 (datetime.date.today()) 构建测试日期值(在本例中指定天数或周数)。
然后,我们只需创建表单,传入我们的数据,并测试它是否有效。datetime.timedelta()

4 小结

在这里,我们实际上并不使用数据库或测试客户端。请考虑修改SimpleTestCase这些测试以使用 。

如果表单无效,我们还需要验证是否引发正确的错误,但这通常是作为视图处理的一部分完成的,因此我们将在下一节中处理这个问题。

如果ModelForm 使用 RenewBookForm(forms.Form)类而不是RenewBookModelForm(forms.ModelForm)类,
则表单字段名称将为“due_back”而不是“renewal_date”。

这就是表格的全部内容;我们确实有一些其他的,但它们是由我们通用的基于类的编辑视图自动创建的,应该在那里进行测试!运行测试并确认我们的代码仍然通过!

如果有兴趣可以参考 测试模块的结构说明

    https://juejin.cn/post/7243060470863953976
目录
相关文章
|
12天前
|
存储 数据库 文件存储
掌握Django文件处理:一步步构建上传功能
文件上传算是一种很常见的需求,几乎构建很多项目系统,以及插件都需要用到。 通过上面例子可以看到django通过forms表单的形式灵活定义文件上传的页面,字段,以及数据库存储。 在实际项目中我们还要考虑到安全性,包括检查文件大小(可通过FileField的max_length属性设置)、防止路径遍历攻击。 还需注意服务器端的验证,比如检查文件类型、内容安全等。
|
3天前
|
存储 流计算 Python
使用Django构建即时通讯应用的最简单方法
使用Django构建即时通讯应用的最简单方法
|
5天前
|
Python
Django表单
【6月更文挑战第13天】Django表单。
12 5
|
5天前
|
存储 测试技术 数据库
在django中的测试架构
【6月更文挑战第13天】该文主要讨论Django项目的测试数据查询和测试架构。文中展示了如何创建`TestCase`子类进行测试,并提供了执行测试的不同选项,如增加详细信息、并行运行和选择性运行特定测试。
29 2
在django中的测试架构
|
11天前
|
XML Java 测试技术
Maven 构建 & 项目测试
在本节中,我们学习了如何使用Maven构建和测试Java应用。在`C:/MVN/consumerBanking`项目中,`pom.xml`配置了JUnit为测试框架。通过命令行运行`mvn clean package`,Maven执行清理、编译、运行测试和打包成`consumerBanking-1.0-SNAPSHOT.jar`。测试报告位于`target/surefire-reports`。新增`Util.java`类后,更新`App.java`以调用它。执行`mvn clean compile`后,运行结果显示&quot;Hello World!&quot;。
|
14天前
|
前端开发 JavaScript Linux
分离前后端react和django3构建的应用
【6月更文挑战第4天】在本文中,我们介绍了如何设置React前端并连接到Django后端。并讨论了前后端分离的好处,并计划扩展API以支持更多HTTP操作和用户身份验证功能。
51 5
分离前后端react和django3构建的应用
|
14天前
|
Python
Django表单
【6月更文挑战第3天】Django表单。
10 1
|
14天前
|
Python
Django表单
【6月更文挑战第3天】Django表单。
6 1
|
15天前
|
存储 数据管理 测试技术
构建Python构建自动化测试框架(原理与实践)
当谈到软件质量保证时,自动化测试是一个不可或缺的步骤。Python作为一种简单易学的编程语言,具有丰富的测试框架和库,使得构建自动化测试框架变得相对简单。本文将介绍如何使用Python构建自动化测试框架,包括选择合适的测试框架、编写测试用例、执行测试和生成报告等方面。
构建Python构建自动化测试框架(原理与实践)
|
10天前
|
Linux 数据库管理 Python
CentOS7编译安装Python3.10(含OpenSSL1.1.1安装),创建虚拟环境,运行Django项目(含sqlite版本报错)
CentOS7编译安装Python3.10(含OpenSSL1.1.1安装),创建虚拟环境,运行Django项目(含sqlite版本报错)
75 4