专题三：接口测试模型

实现接口自动化测试，需要定义的几个模块的模型和序列化。

image.png

模型知识点

1.用户模型

Django工程的用户模型可以通过get_user_model获取，在模型定义中作为外键，代码片段如下

from django.contrib.auth import get_user_model
# 在models.py中通过get_user_model获取工程的User模型
User = get_user_model()

class Project(models.Model):
      #作为外键
      user = models.ForeignKey(User, on_delete=models.CASCADE, null=True, verbose_name="创建人")

2.choices选择框标签

模型字段定义选择标签用choices实现，通过定义二元元组，并在字段的choices赋值二元元组，代码如下

class Project(models.Model):
    """
    项目
    """
    #定义二元元组
    ProjectType = (
        ('web', 'web'),
        ('app', 'app')
    )
    #type字段为选择框类型，设置其属性choices并赋值二元元组
    type = models.CharField(max_length=50, verbose_name="项目类型", choices=ProjectType)

3.related_name反向绑定

当前模型字段有个为另一个模型的外键，可以设置对应外键属性related_name实现反向绑定，简单理解外键对象+related_name反向查询到使用外键的对象。
具体代码如下：

class Project(models.Model):
    """
    项目
    """
    ProjectType = (
        ('web', 'web'),
        ('app', 'app')
    )
    name = models.CharField(max_length=50, verbose_name="项目名称")
    type = models.CharField(max_length=50, verbose_name="项目类型", choices=ProjectType)
    description = models.CharField(max_length=1024, blank=True, null=True, verbose_name="描述")
    last_update_time = models.DateTimeField(auto_now=True, verbose_name="最近修改时间")
    create_time = models.DateTimeField(auto_now_add=True, verbose_name="创建时间")
    user = models.ForeignKey(User, on_delete=models.CASCADE, null=True, verbose_name="创建人")


class Host(models.Model):
    """
    域名
    """
    name = models.CharField(max_length=50, verbose_name="名称")
    host = models.CharField(max_length=1024, verbose_name="host地址")
    description = models.CharField(max_length=1024, blank=True, null=True, verbose_name="描述")
    project = models.ForeignKey(Project, on_delete=models.CASCADE, verbose_name="项目归属", related_name="host_list")

定义了Project和Host两个模型，Host模型的project字段为外键，并赋值related_name="host_list"。
正向：Host.project = project.id，Host.project的值为对应project的id
反向：project.host_list = [host_obj, host_obj]，通过project可以反向查询活动相同project.id对应的host对象

序列化知识点

1.序列化通用配置

序列化的作用包括字段参数校验，赋值，需要定义模型（model）和返回的字段（fields/exclude）
代码如下：

from rest_framework import serializers
from . import models
class HostSerializer(serializers.ModelSerializer):
    class Meta:
        model = models.Host    #模型
        fields = "__all__"           #校验/返回所有模型的字段，包括对应模型的自增id

2.字段校验/返回限制

提供两种字段校验/返回选择
fields：包含，如"all"， ['case']
exclude：不包含，如 ['case']
具体代码如下：

#  Host模型
class Host(models.Model):
    """
    域名
    """
    name = models.CharField(max_length=50, verbose_name="名称")
    host = models.CharField(max_length=1024, verbose_name="host地址")
    description = models.CharField(max_length=1024, blank=True, null=True, verbose_name="描述")
    project = models.ForeignKey(Project, on_delete=models.CASCADE, verbose_name="项目归属", related_name="host_list")


#  所有字段，包括自增id
class HostSerializer(serializers.ModelSerializer):
    class Meta:
        model = models.Host
        fields = "__all__"

#  特定字段，只返回自增id
class HostSerializer(serializers.ModelSerializer):
    class Meta:
        model = models.Host
        fields = ["id"]

#  除了id字段，其他都返回
class HostSerializer(serializers.ModelSerializer):
    class Meta:
        model = models.Host
        exclude = ["id"]

3.序列化自定义字段

模型的外键，在序列化时一般保存的是对应的外键的id。序列化需要返回完整对外键对象，一般是将外键的序列化进行赋值，具体代码如下：

#model.py
class Case(models.Model):
    """
    自动化测试用例
    """
    project = models.ForeignKey(Project, on_delete=models.CASCADE, verbose_name="项目", related_name="case_list")
    name = models.CharField(max_length=50, verbose_name="名称")
    # 测试下case_list,无法使用，申明先后，避免循环前套
    api_list = models.ManyToManyField(Api,  verbose_name="api列表")
    user = models.ForeignKey(User, on_delete=models.SET_NULL, blank=True, null=True, verbose_name="用户")
    description = models.TextField(null=True, blank=True, verbose_name="描述")
    create_time = models.DateTimeField(auto_now=True, verbose_name="创建时间")


class CaseArgument(models.Model):
    """
    自动化用例参数
    """
    case = models.ForeignKey(Case, on_delete=models.CASCADE, verbose_name="用例", null=True, related_name="arguments")
    name = models.CharField(max_length=100, verbose_name="参数名字")
    value = models.CharField(max_length=100, verbose_name="参数的值")

#serializer.py
class CaseSerializer(serializers.ModelSerializer):
    # 定义project_id为返回字段，写过程进行校验
    # Case模型定义的外键是project，默认情况下CaseSerializer返回为project=project.id
    project_id = serializers.IntegerField(write_only=True)
    # 定义api_list，多对多的形式，读过程进行返回
    api_list = ApiSerializer(many=True, read_only=True)
     # 定义arguments字段，arguments是通过反向查询获得，参考CaseArgument定义
     #多对多的形式，读过程进行返回
    arguments = CaseArgumentSerializer(many=True, read_only=True)

    class Meta:
        model = models.Case
        fields = ['project_id', 'arguments', 'id', 'name', 'description', 'create_time']

read_only：当该字段设置为true时，读的时候会返回该字段的值
write_only：当该字段设置为true时，写的时候会校验该字段
many=True：当序列化返回多个，需要将many=True，不然会报错