RobotFramework二次开发——文件解析

背景

今年下半年，基本上都在跟RobotFramework打交道了，框架是不错，但是我总是不喜欢ride的那套东西，项目大就卡成狗，而且只要更新一次代码，就要重新打开一次项目，特别繁琐，如果能够二次开发，那用起来应该会舒服很多，网上找了一圈没有找到关于RobotFramework二次开发的文章，只能自己去看源代码了。当然，不会涉及太多的源码解析，旨在分享能用的代码。

环境

如果没有特别交代，默认使用以下版本的RobotFramework。

Robot Framework 3.0.2 (Python 2.7.10 on darwin)

Robot.Parse

要在RobotFramework上做二次开发，那么就必须能够解析RobotFramework的文件，最能想到的方式，就是自己写正则去匹配，毕竟RobotFramework支持的文件，基本都是文本文件，但是写起来肯定会很蛋疼，还会有一堆bug，幸好，RobotFramework已经有了一些内部的API，我们可以直接获取到这些数据，所以第一步，先要去看robot.parse这个模块，它提供了解析文件的方法。

支持类型

Parse模块支持文件解析和目录解析。在Parse模块中，最主要的方法是TestData。源代码如下：

def TestData(parent=None, source=None, include_suites=None,             warn_on_skipped=False, extensions=None):    if os.path.isdir(source):        return TestDataDirectory(parent, source).populate(include_suites,                                                          warn_on_skipped,                                                          extensions)    return TestCaseFile(parent, source).populate()

从源代码中可以看到，如果给的source参数是文件夹，那么就按照TestDataDirectory去解析，否则按照TestCaseFile去解析，顾名思义，就是文件夹解析和文件解析

文件解析

RobotFramework支持的文件类型主要是.robot和.txt，
我们来看TestCaseFile的__init__.py函数，里面声明了可拿到的值。

class TestCaseFile(_TestData):    def __init__(self, parent=None, source=None):        self.directory = os.path.dirname(source) if source else None        self.setting_table = TestCaseFileSettingTable(self)        self.variable_table = VariableTable(self)        self.testcase_table = TestCaseTable(self)        self.keyword_table = KeywordTable(self)        _TestData.__init__(self, parent, source)

可以很容易的看到，我们可以卡到的值有这么些directory,setting_table,variable_table,testcase_table,keyword_table,这些其实就是一个RobotFramework文件的主体了，其中variable_table，testcase_table和keyword_table都是可迭代的类型，用一个for循环就可以拿到这些值。例如这样：

test.robot*** Settings ***Library     methods.pyTest Setup      get config*** Variables ***${test}     123*** Keywords ***get config    log     开始获取配置    set suite variable     ${config}       config*** Test Cases ***test    log     ${config}test1    test

这样解析

from robot.parse import TestDatadef test():    suite = TestData(source='test.robot')    for x in suite.variable_table:        print '-', x.name    for y in suite.testcase_table:        print '-', y.name    for z in suite.keyword_table:        print '-', z.name

返回的结果如下：

- ${test}- test- test1- get config

但是setting_table不一样，如果去翻源代码，这个类不是一个可迭代的。

class _SettingTable(_Table, _WithSettings):    type = 'setting'    def __init__(self, parent):        _Table.__init__(self, parent)        self.doc = Documentation('Documentation', self)        self.suite_setup = Fixture('Suite Setup', self)        self.suite_teardown = Fixture('Suite Teardown', self)        self.test_setup = Fixture('Test Setup', self)        self.test_teardown = Fixture('Test Teardown', self)        self.force_tags = Tags('Force Tags', self)        self.default_tags = Tags('Default Tags', self)        self.test_template = Template('Test Template', self)        self.test_timeout = Timeout('Test Timeout', self)        self.metadata = MetadataList(self)        self.imports = ImportList(self)

__init__方法里面的值，就是可以获取的内容，比如上面的test.robot文件，我定义了一个Test SetUp，那么我就可以通过print suite.setting_table.test_setup.name这行代码，来拿到SetUp的名称。

注意

需要特别注意，如果一个.robot或者.txt文件没有test_case,那么这个解析就会报错。

目录解析

目录解析实际上，就是获取目录中所有RobotFramework支持的文件，当然，这个可以通过初始化TestData的时候配置extensions参数来过滤，默认是所有RobotFramework支持的文件类型。
获取到文件之后，全部转换成一个个文件解析的对象，在目录解析的方法中，会有一个children的变量，这个变量会存储目录下所有支持的文件，只要迭代这个变量，再按照文件解析的方法去获取testcase_table、variable_table或者其他。比如刚刚的目录，按照如下代码来解析，就可以获取到刚刚文件的内容。

def test():    suite = TestData(source=os.getcwd())    for x in suite.children:        print x.name        for y in x.testcase_table:            print y.name

输出的结果为：

Testtesttest1

其中第一行为没有后缀的文件名，会把首字母大写。

最后

所以回过头来，我们看ride，实际上也是用这种方式来获取文件名，方法和内容，然后用表格的形式来呈现。