RobotFramework學習系列(一)

　　測試工作需要用到了RobotFramework，之前只是使用，用了一段時間后，決定深入研究一下它。使用平台為Windows + Linux。由於是基於Linux 系統方面的測試工作，使用的RobotFramework版本為2.8.5

　　先簡單介紹一下Robot中的一些概念

　　關鍵字(Keyword)： 分為內部關鍵字和用戶關鍵字。

　　　　　　內部關鍵字顧名思義為Robot內置的部分關鍵字，例如Should Be Equal，Run Keyword 等等

　　　　　　用戶關鍵字，開發人員或者測試人員自行通過內部關鍵字組合 OR 采用外部代碼導入構成的關鍵字

　　資源(Resource)：  關鍵字的組合包，例如將多個關鍵字放在一個文件里，這個文件在Robot里可以稱為一個資源

　　庫(Library)： Robot支持很多庫，分為內置和外置，內置的如Collections等，外置的，可以是python寫成的文件，java寫成的文件，以及通過xml-rpc導入的遠程庫，這些庫一般都是通過代碼寫成

　　用例(Case)：多個關鍵字的組合，順序 or 帶分支控制等組成的文件為Case

　　Suite：可以理解為多個用例的組合，一個suit 文件下可以寫多條用例。

 

　　Windows的入口文件為pybot.bat

　　

 　　Linux的入口文件為pybot

　　

 　　由上圖可以知道，robot的入口文件為robot\run.py(可以查看robot\__init__.py中代碼可知)

　　看一下run_cli()和run()的區別

　　

 　　從上圖和下圖的代碼看，run_cli調用的是RobotFramework類下的execute_cli方法，run調用的是RobotFramework類下的execute方法，不同的是execute_cli多了一些參數解析的操作，所以推薦當代碼中調用的時候，使用run_cli，而當工具調用的時候，使用run。

　　不管是run還是run_cli，核心都調用了_execute這個內部函數，而它又調用了main函數，這個main，在Application類中是一個需要被繼承重寫的函數，所以需要去繼承它的類中尋找具體實現

    def execute_cli(self, cli_arguments):
        with self._logging():
            options, arguments = self._parse_arguments(cli_arguments)
            rc = self._execute(arguments, options)
        self._exit(rc)

    def execute(self, *arguments, **options):
        with self._logging():
            return self._execute(list(arguments), options)

    def _execute(self, arguments, options):
        try:
            rc = self.main(arguments, **options)
        except DataError, err:
            return self._report_error(unicode(err), help=True)
        except (KeyboardInterrupt, SystemExit):
            return self._report_error('Execution stopped by user.',
                                      rc=STOPPED_BY_USER)
        except:
            error, details = get_error_details()
            return self._report_error('Unexpected error: %s' % error,
                                      details, rc=FRAMEWORK_ERROR)
        else:
            return rc or 0

　　下面為main函數的具體實現，核心為5~9行，5行前面為初始化一些基礎的配置，9行以后為生成測試log

    def main(self, datasources, **options):
        settings = RobotSettings(options)
        LOGGER.register_console_logger(**settings.console_logger_config)
        LOGGER.info('Settings:\n%s' % unicode(settings))
        suite = TestSuiteBuilder(settings['SuiteNames'],
                                 settings['WarnOnSkipped'],
                                 settings['RunEmptySuite']).build(*datasources)
        suite.configure(**settings.suite_config)
        result = suite.run(settings)
        LOGGER.info("Tests execution ended. Statistics:\n%s"
                    % result.suite.stat_message)
        if settings.log or settings.report or settings.xunit:
            writer = ResultWriter(settings.output if settings.log else result)
            writer.write_results(settings.get_rebot_settings())
        return result.return_code

　　以windows運行命令行為例　　python run.py --outputdir  C:\\logs  --test 初始化環境   C:\\環境驗證

　　5~7行，suite為TestSuiteBuilder根據Settings中的部分參數進行構建，並執行build函數，其中datasources為List類型的數據，即['C:\\環境驗證']，說明指定用例suit的時候，是可以同時指定多個Suit一起跑

　　9行，為執行指定suite(用例)，並獲取結果

　　看一下build具體執行操作

    def build(self, *paths):
        if not paths:
            raise DataError('One or more source paths required.')
        if len(paths) == 1:
            return self._build_and_check_if_empty(paths[0])  6         root = TestSuite()
        for path in paths:
            root.suites.append(self._build_and_check_if_empty(path))
        return root
    def _build_and_check_if_empty(self, path): 11         builded = self._build_suite(self._parse(path)) 12         if not self._empty_suites_allowed and not builded.test_count:
                raise DataError("Suite '%s' contains no tests." % builded.name)
        builded.remove_empty_suites()
        return builded

 　　def _build_suite(self, data, parent_defaults=None): 18         defaults = TestDefaults(data.setting_table, parent_defaults)
        suite = TestSuite(name=data.name,
                          source=data.source,
                          doc=unicode(data.setting_table.doc),
                          metadata=self._get_metadata(data.setting_table))
        for import_data in data.setting_table.imports:
            self._create_import(suite, import_data)
        self._create_setup(suite, data.setting_table.suite_setup)
        self._create_teardown(suite, data.setting_table.suite_teardown)
        for var_data in data.variable_table.variables:
            self._create_variable(suite, var_data)
        for uk_data in data.keyword_table.keywords:
            self._create_user_keyword(suite, uk_data)
        for test_data in data.testcase_table.tests:
            self._create_test(suite, test_data, defaults)
        for child in data.children:
            suite.suites.append(self._build_suite(child, defaults))
        return suite

　　build根據傳入的datasources的個數進行構建，對於單獨的一個文件的情況下，調用了內部函數_build_and_check_if_empty，這個函數會判斷傳入的datasource是否真實存在，如果存在，會再次調用_build_suite進行suite構建

　　_parse()這個內部的函數完成了robot文件(.txt 或者.robot文件)到robot的數據結構TestData的轉換， TestData數據結構會在后面的文章詳細講解

    def _parse(self, path):
        try:
            return TestData(source=abspath(path),
                            include_suites=self.include_suites,
                            warn_on_skipped=self.warn_on_skipped)
        except DataError, err:
            raise DataError("Parsing '%s' failed: %s" % (path, unicode(err)))

　　回到_build_suite

　　data.setting_table.imports是指suite最開始定義的可以進行導入的Source, Libriary等

　　data.setting_table.suite_setup 是指在suite中定義的  Suite Setup，同理  data.setting_table.suite_teardown 是指 Suite Teardown 

　　data.variable_table.variables 是指在suite中定義的變量

　　data.keyword_table.keywords 定義的關鍵字

　　data.testcase_table.tests 是指suite中定義的case，對test，會調用下面的代碼進行創建test

    def _create_test(self, suite, data, defaults):
        values = defaults.get_test_values(data)
        test = suite.tests.create(name=data.name,
                                  doc=unicode(data.doc),
                                  tags=values.tags.value,
                                  template=self._get_template(values.template),
                                  timeout=self._get_timeout(values.timeout))
        self._create_setup(test, values.setup)
        for step_data in data.steps:
            self._create_step(test, step_data, template=values.template)
        self._create_teardown(test, values.teardown)

　　values是獲取了單個test的一些具體信息，如tags，test Setup, Test Teardown等

　　suite.tests為 TestCase類型數據，TestSuite 繼承於model.TestSuite， 而model.TestSuite 中通過裝飾器為tests 賦予TestCase類型數據

@setter
    def tests(self, tests):
        return TestCases(self.test_class, self, tests)

　　后續代碼創建了分解了整個case的各個步驟，通過_create_step對test的步驟進行擴充

　　到此為止，TestSuiteBuilder便構建完成

　　由於Case執行部分復雜，將在下一篇文章中詳細講解