30行代码就能实现ddt模块收藏起来慢慢学

Posted 2021-12-28 程序员二黑

用 python 做过自动化的小伙伴，大多数都应该使用过 ddt 这个模块，不可否认 ddt 这个模块确实挺好用，可以自动根据用例数据，来生成测试用例，能够很方便的将测试数据和测试用例执行的逻辑进行分离。

接下来就带大家一起手把手撸出一个 ddt：

1、DDT 的实现原理

首先我们来看一下 ddt 的基本使用：

ddt 在使用时非常简洁，也就是两个装饰器，@ddt 这个装饰器装饰测试类，@data 这个装饰器装饰器用例方法并传入测试数据。这两个装饰器实现的效果就是根据传入的用例数据自动生成用例。

具体是怎么实现的呢？其实实现的思路也特别的简单，也就两个步骤：

• 第一步：把传进来的用例数据保存起来

• 第二步：遍历用例数据，每遍历一条数据 就动态的给测试类添加一个用例方法。

ddt 中的两个装饰器其实实现的就是这么两个步骤：

• @data:做的是第一步将传入测试数据保存起来;
• @ddt 做的是第二步，遍历用例数据，给测试类动态添加用例方法。

2、data 装饰器的实现

前面我们说到 data 这个装饰器，做的事情是将用例数据保存起来。

那么如何保存呢？其实最简单的方式就是保存被装饰的这个用例方法的属性。

接下来我们来具体实现：

先看一个 ddt 使用的案例

@ddt
class TestLogin(unittest.TestCase):

    @data(11,22)
    def test_login(self, item):
      pass

了解过装饰器装饰器原理的小伙伴，应该都知道上面@data(11,22) 这行代码执行的效果等同于

test_login = data(11,22)(test_login)

接下来我们来分析一下上面这行代码，首先是调用 data 这个装饰器函数，把用例数据 11,22 当成参数传入进去，然后返回一个可调用对象(函数)，再次调用返回的函数并把用例方法传入进去。明确了调用的流程，那么我们就可以结合之前的需求去定义 data 这个装饰器函数了。

具体实现如下：

def data(*args):
    def wrapper(func):
        setattr(func, "PARAMS", args)
        return func
    return wrapper

代码解读：

前面的案例在使用 data 时，执行的 test_login = data(11,22)(test_login)
先调用 data 传入的 11,22 通过不定长参数 args 接收，然后返回嵌套的函数 wrapper
然后调用返回的 wrapper 函数，传入被装饰的 test_login 方法
在 wrapper 函数中我们把用例数据保存为 test_login 这个方法的 PARAMS 属性，再把 test_login 返回
到此为止，data 这个装饰器我们就实现用例数据的保存

3、ddt 装饰器的实现

通过 data 这个装饰器我们实现了用例数据保存之后，我们接下来实现 ddt 这个装饰器，根据用例数据生成测试用例。前面的案例 @ddt 装饰测试类的时候，实际上执行的效果等同于下面的代码

TestLogin = ddt(TestLogin)

这行代码就是把被装饰器的类传入到 ddt 这个装饰器函数中，再把返回值赋值给TestLogin。之前我们分析的时候说了 ddt 这个装饰器做的事情是遍历用例数据，动态的给测试类添加用例方法。

接下来我们就来实现 ddt 这个装饰器内部的逻辑。

def ddt(cls):
    for name, func in list(cls.__dict__.items()):
        if hasattr(func, "PARAMS"):
            for index, case_data in enumerate(getattr(func, "PARAMS")):
                new_test_name ="_".format(name,index)
                setattr(cls, new_test_name, func)
            else:
                delattr(cls, name)
    return cls

代码解读：

ddt 函数内部逻辑说明：
1、调用 ddt 这个函数时会把测试类当成参数传入进来，
2、然后通过 cls.dict 获取测试的所有属性和方法，进行遍历
3、判断变量出来的属性或方法 有没有 PARAMS 这个属性，
4、如果有，则说明这个方法用 data 装饰器装饰过并传入了用例数据。
5、通过 getattr(func, “PARAMS”)获取所有的用例数据，进行遍历。
6、每遍历出来一组用例数据，生产一个用例方法名， 再动态的给测试类添加一个用例方法。
7、遍历完所有用例数据之后，删除测试类原来定义的测试方法
8、最后返回测试类

当目前为止 ddt 和 data 这两个装饰器函数的基本功能实现了，可以自动根据用例数据生成测试用例了，接下来我们写个测试类来检查一下

# 定义装饰器函数data
def data(*args):
    def wrapper(func):
        setattr(func, "PARAMS", args)
        return func

    return wrapper

# 定义装饰器函数ddt
def ddt(cls):
    for name, func in list(cls.__dict__.items()):
        if hasattr(func, "PARAMS"):
            for index, case_data in enumerate(getattr(func, "PARAMS")):
                new_test_name = "_".format(name, index)
                setattr(cls, new_test_name, func)
            else:
                delattr(cls, name)
    return cls


import unittest

# 编写测试类
@ddt
class TestDome(unittest.TestCase):
    @data(11, 22, 33, 44)
    def test_demo(self):
        pass

运行上述用例，我们就会发现执行了四条用例，根据用例数据生成用例的功能就已经实现了。

4、解决用例参数传递的问题

虽然上面基本的功能已经实现了，但是还存在一个问题：用例的数据没有传递到用例方法中。那么用例数据传递怎么实现了，我们可以通过一个闭包函数对用例方法进行修，从而实现在调用用例方法的时候，把用例测试当成参数传递进去。

修改原有用例方法的函数代码如下

from functools import wraps

def update_test_func(test_func,case_data):
    @wraps(test_func)
    def wrapper(self):
        return test_func(self, case_data)
    return wrapper

代码解读：

上面我们定义了一个叫做 update_test_func 的闭包函数
闭包函数接收两个参数：test_func(接收用例方法),case_data(接收用例数据)
闭包函数返回一个嵌套函数，嵌套函数内部调用原来的用例方法，并传入测试数据 嵌套函数在定义时，使用了 functools 模块中的装饰器
wraps 来装饰，它可以让 wrapper 这个嵌套函数具有 test_func 这个用例函数的相关属性。

下面我们回到前面写的 ddt 这个函数中，在给测试类添加用例之前，调用 update_test_func 方法对用例方法进行修改：

def ddt(cls):
    for name, func in list(cls.__dict__.items()):
        if hasattr(func, "PARAMS"):
            for index, case_data in enumerate(getattr(func, "PARAMS")):
                # 生成一个用例方法名
                new_test_name = "_".format(name, index)
                # 修改原有的测试方法，设置用例数据为测试方法的参数
                test_func = update_test_func(func,case_data)
                setattr(cls, new_test_name, test_func)
            else:
                delattr(cls, name)
    return cls

通过加上这一步之后，我们在测试类中 动态给测试类添加的测试方法，其实指向的全部是 update_test_func 里面定义的 wrapper 函数，在执行测试用的时候实际上也是执行的 wrapper 函数，而在 wrapper 函数内部，我们调用了原来定义的测试方法，并将用例数据传入了进去。

到此为止 ddt 的功能我们就完全实现了！

End:
给大家举一个完整的案例，大家可以复制过去运行，也可以自己去写一遍，还可以根据自己的一些需求进行自定义的扩展。

完整案例

rom functools import wraps
import unittest

# --------ddt的实现--------
def data(*args):
    def wrapper(func):
        setattr(func, "PARAMS", args)
        return func

    return wrapper


def update_test_func(test_func, case_data):
    @wraps(test_func)
    def wrapper(self):
        return test_func(self, case_data)

    return wrapper


def ddt(cls):
    for name, func in list(cls.__dict__.items()):
        if hasattr(func, "PARAMS"):
            for index, case_data in enumerate(getattr(func, "PARAMS")):
                # 生成一个用例方法名
                new_test_name = "_".format(name, index)
                # 修改原有的测试方法，设置用例数据为测试方法的参数
                test_func = update_test_func(func, case_data)
                setattr(cls, new_test_name, test_func)
            else:
                delattr(cls, name)
    return cls

# --------测试用例编写--------
@ddt
class TestDome(unittest.TestCase):
    @data(11, 22, 33, 44)
    def test_demo(self, data):
        assert data < 40
#---------用例执行-----------
unittest.main()

如果您觉得文章还不错，可以关注，评论，点赞，收藏 一下，因为这将是我持续输出更多优质文章的最强动力！同时我也给大家准备了18G的软件测试核心知识点，对于软件测试的的朋友来说应该是很全面最的备战仓库，有需要的朋友可以关注我的微信公众号：程序员二黑，免费获取！

最困难的时候，也就是我们离成功不远的时候！接下来的路我们一起加油！

精彩推荐

高薪程序员也躲不过35岁这一关…当能力与年龄脱节，我们该如何自救？

清华学姐熬了一个月肝出这份32W字Linux知识手册，在 Github标星31K+

字节跳动软件测试岗，前两面过了，第三面HR天坑！竟然跟我说……