测试之家

作者

米洛

pity接口自动化测试平台开发文档

连载中的一个从0到1的接口测试平台，目前基于fastapi+react(antd+umi)，emmmm。写了大概100篇内容~ 可以在掘金/公众号看到最新文章，等得及的可以在testerhome。 欢迎大家给出建议/意见，如果有错误之处还望大家帮忙指出。 多谢帮忙开通专栏的`我去催饭`大佬。

pity接口自动化测试平台开发文档 测试平台系列 (18) 项目用例表设计和权限改造

米洛 · 2022年01月05日 · 2142 次阅读

😅 社区终于恢复了，我也可以继续更新了 (没选择推送到社区，默默更新中)。上到首页会打扰大家，所以一天只发一篇，希望大家理解。

:) 珍惜来之不易的社区

回顾

上一节，我们说到了关于整个用例执行的生命周期。我后面细想了一下，如果一开始就要完全兼容代码生成的话，写起来会很费时间。为了给大家一些好的体验，还是得一口一口地吃，不能一下吃胖。

所以我们就先完成无码模式吧~

粗略地设计几个核心表

我们的用例后续如果要方便管理，肯定是需要做一些分类和权限的控制，所以我们先设计几个核心的表:

  • 项目表

    用例分步在各个项目，类似于目录的概念，不同的用例位于不同的项目之中，方便用例进行分类。

  • 项目角色表

    每个项目都是需要有自己的成员，对于成员们来说，他们因为身份的不同，身上担负的职责也不一样，我们给出几个简单的身份如:

    组长和组员，其中组长可以对组员进行相关权限的变化。

  • 测试用例表

    存放了各个用例的信息，是测试平台的一个最小的执行单元。

项目表 models/project.py

from app.models import db
from datetime import datetime


class Project(db.Model):
    id = db.Column(db.INT, primary_key=True)
    name = db.Column(db.String(16), unique=True, index=True)
    owner = db.Column(db.INT)
    created_at = db.Column(db.DATETIME, nullable=False)
    updated_at = db.Column(db.DATETIME, nullable=False)
    deleted_at = db.Column(db.DATETIME)
    create_user = db.Column(db.INT, nullable=True)
    update_user = db.Column(db.INT, nullable=True)
    private = db.Column(db.BOOLEAN, default=False)

    def __init__(self, name, owner, create_user, private=False):
        self.name = name
        self.owner = owner
        self.private = private
        self.created_at = datetime.now()
        self.updated_at = datetime.now()
        self.create_user = create_user
        self.update_user = create_user
        self.deleted_at = None

大概分为以下几个字段，除了创建/更新时间/用户以外，还有以下字段:

owner（组长）
name（项目名）
private（是否私有）

项目角色表 models/project_role.py

from app.models import db
from datetime import datetime


class ProjectRole(db.Model):
    id = db.Column(db.INT, primary_key=True)
    project_id = db.Column(db.INT, index=True)
    project_role = db.Column(db.INT, index=True)
    created_at = db.Column(db.DATETIME, nullable=False)
    updated_at = db.Column(db.DATETIME, nullable=False)
    deleted_at = db.Column(db.DATETIME)
    create_user = db.Column(db.INT, nullable=True)
    update_user = db.Column(db.INT, nullable=True)

    def __init__(self, project_id, project_role, create_user):
        self.project_id = project_id
        self.project_role = project_role
        self.created_at = datetime.now()
        self.updated_at = datetime.now()
        self.create_user = create_user
        self.update_user = create_user
        self.deleted_at = None

与上个表单类似，project_id 是项目 id，project_role 是项目角色。

咱们规定:

1: 组长 2: 组员

测试用例表 models/test_case.py

from app.models import db
from datetime import datetime


class TestCase(db.Model):
    id = db.Column(db.INT, primary_key=True)
    name = db.Column(db.String(32), unique=True, index=True)
    request_type = db.Column(db.INT, default=1, comment="请求类型 1: http 2: grpc 3: dubbo")
    url = db.Column(db.TEXT, nullable=False, comment="请求url")
    request_method = db.Column(db.String(12), nullable=True, comment="请求方式, 如果非http可为空")
    request_header = db.Column(db.TEXT, comment="请求头，可为空")
    project_id = db.Column(db.INT, comment="所属项目")
    tag = db.Column(db.String(64), comment="用例标签")
    status = db.Column(db.INT, comment="用例状态: 1: 待完成 2: 暂时关闭 3: 正常运作")
    expected = db.Column(db.TEXT, comment="预期结果, 支持el表达式", nullable=False)
    created_at = db.Column(db.DATETIME, nullable=False)
    updated_at = db.Column(db.DATETIME, nullable=False)
    deleted_at = db.Column(db.DATETIME)
    create_user = db.Column(db.INT, nullable=False)
    update_user = db.Column(db.INT, nullable=False)

    def __init__(self, name, request_type, url, project_id, tag, status, expected, create_user, request_header=None,
                 request_method=None):
        self.name = name
        self.request_type = request_type
        self.url = url
        self.project_id = project_id
        self.tag = tag
        self.status = status
        self.expected = expected
        self.create_user = create_user
        self.update_user = create_user
        self.request_header = request_header
        self.request_method = request_method
        self.created_at = datetime.now()
        self.updated_at = datetime.now()

基本上内容都在 comment 注释里面了，大家看着就行，也不多讲解了。肯定现在还有一些特性没有考虑到的，后序可以加字段解决。

编写检查用户权限的装饰器

我们在上面三张表里面定义好了create_user和update_user，其实这 2 个字段接受的都是咱们的用户 id，而用户 id 又是可以通过token进行解析的。

之前编写过的解析token的方法

还记得之前编写过的解析 token 的方法吗？我们现在就来编写一个装饰器: 自动判断用户 token 是否有效以及获取用户信息。

原理很简单，就是通过 headers 中的 token 字段获取 token，经过解析后拿到用户信息，这里更加复杂一点，对于那种需要有权限控制的地方，我们做了一层判断，如果权限在配置范围以下，那么普通成员就不能调用这个接口。

完整代码:

from functools import wraps

from flask import request, jsonify

from app import pity
from app.middleware.Jwt import UserToken

FORBIDDEN = "对不起, 你没有足够的权限"


class SingletonDecorator:
    def __init__(self, cls):
        self.cls = cls
        self.instance = None

    def __call__(self, *args, **kwargs):
        if self.instance is None:
            self.instance = self.cls(*args, **kwargs)
        return self.instance


def permission(role=pity.config.get("GUEST")):
    def login_required(func):
        @wraps(func)
        def wrapper(*args, **kwargs):
            try:
                headers = request.headers
                token = headers.get('token')
                if token is None:
                    return jsonify(dict(code=401, msg="用户信息认证失败, 请检查"))
                user_info = UserToken.parse_token(token)
                # 这里把user信息写入kwargs
                kwargs["user_info"] = user_info
            except Exception as e:
                return jsonify(dict(code=401, msg=str(e)))
            # 判断用户权限是否足够, 如果不足够则直接返回，不继续
            if user_info.get("role", 0) < role:
                return jsonify(dict(code=400, msg=FORBIDDEN))
            return func(*args, **kwargs)

        return wrapper

    return login_required

kwargs["user_info"] = user_info

重点注意一下这句话。

为之前咱们编写的 http/request 接口加入权限

这里插入咱们刚才的permission即可

由于我们这个接口暂时支持登录用户使用，所以权限默认就行了，也就是说用户 role 为 0(普通用户) 即可！

改动很简单，导入permission并使用

这里需要注意的是，我们的 http_request 必须带有user_info参数，否则会报错，因为我们后续可能会用到用户信息。

改造前端代码

因为我们之前前端在请求接口的时候，是不会带上用户 token 的，所以我们需要改造前端请求方法:

  1. 在发送 http 请求的时候带上 token 数据
  2. 校验返回 code，如果为 401 则自动注销用户，提示用户未登录！
  • 创建 src/utils/auth.js
import { message } from 'antd';

export default {
  headers: (json = true) => {
    const token = localStorage.getItem('pityToken');
    const headers = { token };
    if (json) {
      headers['Content-Type'] = 'application/json';
    }
    return headers;
  },
  response: (res, info = false) => {
    if (res.code === 0) {
      if (info) {
        message.info(res.msg);
      }
      return true;
    }
    if (res.code === 401) {
      // 说明用户未认证
      message.info(res.msg);
      localStorage.setItem('pityToken', null);
      localStorage.setItem('pityUser', null);
      window.location.href = '/user/login';
    }
    message.error(res.msg);
    return false;
  },
};

这里编写了获取 token 并组成 headers 的方法，也编写了针对 token 过期，权限不够的 code 码进行不同的处理。

  • 修改 src/services/request.js

  • 修改请求结果:

请求结束后，只有当返回true状态时才设置response

  • 开始测试

发现我们的错误信息并没有完全展示，是因为我们需要没有针对请求失败的情况进行校验，所以我们还需要调整后端接口:

判断里面的status是否为 True，不为 True 的话返回110 状态码

来个动态图测试一下吧:

接着测试一下权限

通过开发者工具的 application 可以看到:

我们的role默认是0

接着我们调整一下权限为: 只有管理员可以请求接口

来个动图看看:

广告时间

预览地址: http://121.5.2.74/

后端代码地址: https://github.com/wuranxu/pity

前端代码地址: https://github.com/wuranxu/pityWeb

欢迎关注公众号米洛的测开日记，还有加群一起讨论相关问题呀！

转载文章时务必注明原作者及原始链接，并注明「发表于 TesterHome 」，并不得对作品进行修改。
暂无回复。
需要 登录 后方可回复, 如果你还没有账号请点击这里 注册。