高大上可视化接口测试报告(少量代码)

想做一个高大上且无须多余代码编写的可视化的接口自动化测试报告吗?

请给我疯狂打Call。

做一个合格的TestOps,首先你要简单学习下Docker。因为此次报告的内容是在Docker的基础上完成的。我们看下现在几款主流使用的测试报告样式:

有像这样的:

ReportNG 生成

还有像这样的:

HTMLTestRunner 生成

诸如此类的测试报告层出不穷。

首先我们不能否决它(会被人砍)

作为微服务新时代的人类,这个画风实在不是很适合我。他需要一定的代码编写,就算是引用第三方的代码,你需要阅读和学习成本。而且像HTMLTestRunner是结合Python内置的单元测试框架(pytest、unittest)组合使用。前文我们自己编写的测试框架无法去使用它。我认为测试报告的画风这样才对:(前方高能预警)

image.png

Markdown深度使用患者一定对这个很感兴趣哦。因为之前一直想找到关于通过测试报告输出为md格式文件,前台输出样式的。找到天昏地暗也没有第三方的代码可以调用,索性自己写一个DIY,废话不多说 Let`s GO!

一、两种方式使用MkDocs

第一种官方提供了使用文档包括安装使用。提供链接给大家自我阅读,比较清晰适合传统公司使用。这次不详细展开。地址:Mkdocs官方中文文档

第二种跟微服务比较接近我选择使用它,我们展开下:

你需要一个Docker,Docker是微服务至关重要的设施。下载地址:Docker 官网

Docker 官网

你还需要去查找与此次mkdocs相关的镜像,docker hub是docker提供的官方开源镜像仓库。类似于python第三方的pypi库,里面开源了大量的镜像,直接查找即可使用。

docker hub

查找完毕后会展示很多镜像,我们选择第五个,别问我为什么不选择前面几个(手动滑稽),里面的安装启动内容比较简易,第五个最易教学而且使用起来比较稳定。

moird/mkdocs

点进detail查看使用方法,需要两个命令。

$ docker pull moird/mkdocs

$ docker run -d -p 8000:8000 --name documents -v /path/to/documents:/documents moird/mkdocs

简单解释下这两个命令吧:

从官方拉取mkdocs镜像到本地系统。

通过守护进程的方式、将本地的8000端口映射容器的8000端口、数据卷挂载的方式运行起来。

讲到数据卷挂载 -- 其实是将本地的文件夹和容器中的文件夹保持一致。建立关系后,代码中的文件变更后,容器的文件内容跟随变更,所以代码中集成的文件结构是这样的:

文件结构

代码中的写法是怎么样的呢?这个是首页展示信息,md传统写法即可。

代码md格式

mkdocs.yml文件主要是为了生成的样式、首页、头信息...官方有很多方法编写。这里展示演示使用的模板:(ps:index.md是必须有的首页展示信息,下面的md格式通过编写一小段代码在运行接口测试后会去运行那段代码然后输出的稍后贴出代码)

配置文件格式

挂载是如何挂载呢?查看本地report的目录:

运行镜像

查看运行起来的容器提供的服务:

查看容器

因为我本地使用的8000端口被占用了所以使用了8001端口。

访问 127.0.0.1:8000即可访问测试报告了。

二 、如何将测试报告内容和目录通过md格式结果写入到mkdocs.yml文件

前文中有整个框架代码的结构,此处把测试报告这段代码摘取出来:

    def reset_report(self, filename):
        """
        这个方法主要是通过写入文件的方法,先打开cs.YML_REPORT也就是
        mkdocs.yml文件,判断文件中是否存在当前写入的内容。
        :param filename: 测试用例文件
        :return: 测试报告内容
        """
        try:
            result = os.path.exists(cs.REPORT_PATH)
            if result == True:
                conf.get_config(filename)
                reportName = eval(conf.get_data(title=cs.REPORT_NAME, key=cs.REPORT))
                report_name = eval(conf.get_data(title=cs.REPORT_NAME, key=cs.R_NAME))
                file = open(cs.YML_REPORT, 'r')
                list_con = file.readlines()
                content = str(list_con).decode("string_escape")
                fileContent = "- [%s, %s]"
                row = "\n"
                con = row + fileContent % (reportName + cs.NOW, report_name)

                if fileContent % (reportName + cs.NOW, report_name) not in content:
                    f = open(cs.YML_REPORT, 'a+')
                    f.write(con)
                else:
                    print ("内容已经存在 %s" % con)
        except Exception, e:
            print ("文件路径不存在 %s", e)

    def run_test(self, filename):
        conf.get_config(filename)
        list = eval(conf.get_title_list())
        reportName = eval(conf.get_data(cs.REPORT_NAME, key=cs.REPORT))
        logging = log.get_logger(reportName)
        for i in range(2, len(list)):
            title = list[i]
            number = eval(conf.get_data(title, key=cs.NUMBER))
            name = str(conf.get_data(title, key=cs.NAME))
            method = str(conf.get_data(title, key=cs.METHOD))
            url = str(conf.get_data(title, key=cs.URL))
            data = request.change_type(conf.get_data(title, key=cs.DATA))
            headers = eval(conf.get_data(title, key=cs.HEADERS))
            testUrl = cs.TEST_URL + url
            actualCode = request.api(method, testUrl, data, headers)
            expectCode = conf.get_data(title, key=cs.CODE)

            if actualCode != expectCode:
                print "FailInfo"
                print number
                logging.warning("> <font color=#FFB5C5 size=3> %s Case Fail", name)
                logging.warning("                                     ")
                logging.warning("> - <font color=#FFB5C5 size=3>Number : %s", number)
                logging.warning("    - <font color=#FFB5C5 size=3>Method : %s", method)
                logging.warning("    - <font color=#FFB5C5 size=3>Url : %s", testUrl)
                logging.warning("    - Data : </br> ``` %s ```", data)
                logging.warning("    - Headers : </br> ``` %s ```", headers)
                logging.warning("    - <font color=#FFB5C5 size=3>期望值 : %s", expectCode)
                logging.warning("    - <font color=#FFB5C5 size=3>实际值 : %s", str(actualCode))
                logging.warning("*****************")
                logging.warning("                                     ")
            else:
                print number
                print "TrueInfo"
                logging.warning("> <font color=#3cc8b4 size=3> %sCase Success", name)
                logging.warning("                                     ")
                logging.warning("> - <font color=#3cc8b4 size=3>Case Number : %s", number)
                logging.warning("*****************")
                logging.warning("                                     ")

下面可以看到logging.warning的内容,前面文章封装了一个基于logging模块将logging.warning的日志写入指定文件,其实就是docs下的测试报告啦。

到这里基本一个从搭建到写入文件的可视化测试报告教程就到这里结束了。

还是那句话:通过高效的方式完成重复工作是工程师永远追求的。

PS:最近在Gitchat 发一起了一场chat,关于测试工程师的未来。有兴趣关注一下,探讨任何关于TestOps的故事。

GITCHAT:关于微服务时代崛起的TestOps工程师

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,293评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,604评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,958评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,729评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,719评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,630评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,000评论 3 397
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,665评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,909评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,646评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,726评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,400评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,986评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,959评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,197评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,996评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,481评论 2 342

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,594评论 18 139
  • Docker — 云时代的程序分发方式 要说最近一年云计算业界有什么大事件?Google Compute Engi...
    ahohoho阅读 15,506评论 15 147
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,424评论 25 707
  • 又到了一年一度的毕业季,还在找工作的同学会发现招聘最多的是销售类岗位。我希望应届生在选择销售工作时,能先问自己这六...
    任易阅读 2,402评论 1 7
  • 最近有一位小伙伴通过公众号给我留言, “我参加工作没多久,看着圈里的技术大牛,特别羡慕,也渴望成为技术大牛,想让您...
    JavaQ阅读 960评论 8 27