robotframework-datadriver 1.11.2

Excel支持

为了支持xls或xlsx文件，您需要安装额外的XLS或其依赖项。它包含pandas、numpy和xlrd的依赖项。只需将[XLS]添加到您的安装中。自版本3.6起。

pip install --upgrade robotframework-datadriver[XLS]

Python 2

如果您同时安装了Python 2和Python 3，可以使用以下命令：

pip3 install --upgrade robotframework-datadriver

数据驱动器（DataDriver）在版本0.2.7中仅兼容Python 2.7。

pip install --upgrade robotframework-datadriver==0.2.7

由于Python 2.7已弃用，因此没有针对Python 2.7兼容版本的新功能。

RoboCon 2020演讲

在赫尔辛基的RoboCon 2020上简要概述数据驱动器是什么以及它是如何工作的。

替代方法

数据驱动器为内置数据驱动方法提供了替代方案，例如

*** Settings ***
Resource    login_resources.robot

Suite Setup    Open my Browser
Suite Teardown    Close Browsers
Test Setup      Open Login Page
Test Template    Invalid login


*** Test Cases ***       User        Passwort
Right user empty pass    demo        ${EMPTY}
Right user wrong pass    demo        FooBar

Empty user right pass    ${EMPTY}    mode
Empty user empty pass    ${EMPTY}    ${EMPTY}
Empty user wrong pass    ${EMPTY}    FooBar

Wrong user right pass    FooBar      mode
Wrong user empty pass    FooBar      ${EMPTY}
Wrong user wrong pass    FooBar      FooBar

*** Keywords ***
Invalid login
    [Arguments]    ${username}    ${password}
    Input username    ${username}
    Input pwd    ${password}
    click login button
    Error page should be visible

这种方法对于少量数据和少量测试用例来说很好。如果您生成了或计算了数据，特别是如果您有可变的测试用例/组合数量，这些robot文件会变得相当痛苦。使用数据驱动器，您可以一次编写相同的测试用例语法，并从外部数据文件提供数据。

在测试中使用Microsoft® Excel或LibreOffice Calc的罕见原因之一…… ;-)

查看示例测试套件

查看示例CSV表格

需求

在当前时刻，有一些要求关于测试套件的构建，以便数据驱动器能够获取所需的所有信息。

• 只有第一个测试用例将被用作模板。其他所有测试用例将被删除。

• 测试用例必须在“设置”部分定义一个测试模板。这样做的原因是，数据驱动器需要知道测试用例参数的名称。测试用例没有命名参数。关键字有。

• 用作测试模板的关键字必须在测试套件内（在同一*.robot文件中）定义。如果用作测试模板的关键字在资源中定义，数据驱动器将无法访问其参数名称。

示例测试套件

***Settings***
Library           DataDriver
Resource          login_resources.robot
Suite Setup       Open my Browser
Suite Teardown    Close Browsers
Test Setup        Open Login Page
Test Template     Invalid Login

*** Test Case ***
Login with user ${username} and password ${password}    Default    UserData

***** *Keywords* *****
Invalid login
    [Arguments]    ${username}    ${password}
    Input username    ${username}
    Input pwd    ${password}
    click login button
    Error page should be visible

在此示例中，通过将其用作库来激活数据驱动器。它使用默认设置。作为测试模板的关键字使用的是Invalid Login。此关键字有两个参数。参数名称为${username}和${password}。这些名称必须作为CSV文件的列标题存在。测试用例的名称中包含两个变量名称，这在Robot Framework®中没有任何功能。然而，数据驱动器将使用测试用例名称作为模板名称，并将变量替换为单个生成的测试用例的具体值。此模板测试将仅用作模板。指定的数据默认值和用户数据仅在未找到CSV文件时使用。

最小所需列数

• *** 测试用例 ***列必须是最先的。

• 参数列：对于测试模板关键字的每个参数，数据文件中必须存在一个列作为数据源。此列的名称必须与变量名称和语法匹配。

可选列

• [Tags]列可用于向测试用例添加特定标签。标签可以是逗号分隔的。

• [Documentation]列可用于添加特定测试用例文档。

示例数据文件

在此数据文件中，定义了八个测试用例。每行指定一个测试用例。前两个测试用例有特定的名称。其他六个测试用例将根据模板测试用例的名称生成名称，并在此名称中替换变量。列的顺序无关紧要，除了第一列*** 测试用例 ***。

支持的数据类型

通常，数据驱动器支持从数据读取器传递的任何对象。但是，基于文本的读取器（如csv，excel）也支持不同类型。数据驱动器支持Robot Framework®标量变量以及字典和列表。它还支持python字面量评估。

@{DataDriver_DATA_LIST}

作为套件变量的列表，包含每个被选中执行测试用例的机器人词典。

[
  {
    "test_case_name": "Right user empty pass",
    "arguments": {
      "${username}": "demo",
      "${password}": "${EMPTY}"
    },
    "tags": [
      "1"
    ],
    "documentation": "This is a test case documentation of the first one."
  },
  {
    "test_case_name": "Right user wrong pass",
    "arguments": {
      "${username}": "demo",
      "${password}": "FooBar"
    },
    "tags": [
      "2",
      "3",
      "foo"
    ],
    "documentation": "This test case has the Tags 2,3 and foo"
  },
  {
    "test_case_name": "Login with user '${EMPTY}' and password 'mode'",
    "arguments": {
      "${username}": "${EMPTY}",
      "${password}": "mode"
    },
    "tags": [
      "1",
      "2",
      "3",
      "4"
    ],
    "documentation": "This test case has a generated name based on template name."
  },
  {
    "test_case_name": "Login with user '${EMPTY}' and password '${EMPTY}'",
    "arguments": {
      "${username}": "${EMPTY}",
      "${password}": "${EMPTY}"
    },
    "tags": [
      ""
    ],
    "documentation": ""
  },
  {
    "test_case_name": "Login with user '${EMPTY}' and password 'FooBar'",
    "arguments": {
      "${username}": "${EMPTY}",
      "${password}": "FooBar"
    },
    "tags": [
      ""
    ],
    "documentation": ""
  },
  {
    "test_case_name": "Login with user 'FooBar' and password 'mode'",
    "arguments": {
      "${username}": "FooBar",
      "${password}": "mode"
    },
    "tags": [
      "foo",
      "1"
    ],
    "documentation": ""
  },
  {
    "test_case_name": "Login with user 'FooBar' and password '${EMPTY}'",
    "arguments": {
      "${username}": "FooBar",
      "${password}": "${EMPTY}"
    },
    "tags": [
      "foo"
    ],
    "documentation": ""
  },
  {
    "test_case_name": "Login with user 'FooBar' and password 'FooBar'",
    "arguments": {
      "${username}": "FooBar",
      "${password}": "FooBar"
    },
    "tags": [
      "foo",
      "2"
    ],
    "documentation": ""
  }
]

这可以在 Robot Framework® 中像通常那样访问。

${DataDriver_DATA_LIST}[2][arguments][\\${password}] 将导致 mode 。

&{DataDriver_DATA_DICT}

作为套件变量的词典，包含与列表相同的数据，测试名称作为键。

{
  "Right user empty pass": {
    "test_case_name": "Right user empty pass",
    "arguments": {
      "${username}": "demo",
      "${password}": "${EMPTY}"
    },
    "tags": [
      "1"
    ],
    "documentation": "This is a test case documentation of the first one."
  },
  "Right user wrong pass": {
    "test_case_name": "Right user wrong pass",
    "arguments": {
      "${username}": "demo",
      "${password}": "FooBar"
    },
    "tags": [
      "2",
      "3",
      "foo"
    ],
    "documentation": "This test case has the Tags 2,3 and foo"
  },
  "Login with user '${EMPTY}' and password 'mode'": {
    "test_case_name": "Login with user '${EMPTY}' and password 'mode'",
    "arguments": {
      "${username}": "${EMPTY}",
      "${password}": "mode"
    },
    "tags": [
      "1",
      "2",
      "3",
      "4"
    ],
    "documentation": "This test case has a generated name based on template name."
  },
  "Login with user '${EMPTY}' and password '${EMPTY}'": {
    "test_case_name": "Login with user '${EMPTY}' and password '${EMPTY}'",
    "arguments": {
      "${username}": "${EMPTY}",
      "${password}": "${EMPTY}"
    },
    "tags": [
      ""
    ],
    "documentation": ""
  },
  "Login with user '${EMPTY}' and password 'FooBar'": {
    "test_case_name": "Login with user '${EMPTY}' and password 'FooBar'",
    "arguments": {
      "${username}": "${EMPTY}",
      "${password}": "FooBar"
    },
    "tags": [
      ""
    ],
    "documentation": ""
  },
  "Login with user 'FooBar' and password 'mode'": {
    "test_case_name": "Login with user 'FooBar' and password 'mode'",
    "arguments": {
      "${username}": "FooBar",
      "${password}": "mode"
    },
    "tags": [
      "foo",
      "1"
    ],
    "documentation": ""
  },
  "Login with user 'FooBar' and password '${EMPTY}'": {
    "test_case_name": "Login with user 'FooBar' and password '${EMPTY}'",
    "arguments": {
      "${username}": "FooBar",
      "${password}": "${EMPTY}"
    },
    "tags": [
      "foo"
    ],
    "documentation": ""
  },
  "Login with user 'FooBar' and password 'FooBar'": {
    "test_case_name": "Login with user 'FooBar' and password 'FooBar'",
    "arguments": {
      "${username}": "FooBar",
      "${password}": "FooBar"
    },
    "tags": [
      "foo",
      "2"
    ],
    "documentation": ""
  }
}

&{DataDriver_TEST_DATA}

作为测试变量的词典，包含当前测试用例的测试数据。此词典还包含在 Test Template 关键字中没有使用的参数。这可以在测试设置和测试用例中中使用。

{
  "test_case_name": "Right user wrong pass",
  "arguments": {
    "${username}": "demo",
    "${password}": "FooBar"
  },
  "tags": [
    "2",
    "3",
    "foo"
  ],
  "documentation": "This test case has the Tags 2,3 and foo"
}

CSV / TSV（字符分隔值）

默认情况下，DataDriver读取CSV文件。通过编码和CSV方言设置，您可以配置数据源的结构。

XLS / XLSX文件

要使用Excel文件类型，您必须安装包含Extra XLS的DataDriver。

如果您想使用基于Excel的数据源，您只需将文件设置为扩展名或指向正确的文件。如果扩展名为“.xls”或“.xlsx”，DataDriver将将其解释为Excel文件。您可以通过sheet_name选项选择要读取的表。默认设置为0，表示第一个表。您可以使用表索引（0表示第一个表）或表名称（区分大小写）。XLS解释器将忽略所有其他选项，如编码、分隔符等。

*** Settings ***
Library    DataDriver    .xlsx

或

*** Settings ***
Library    DataDriver    file=my_data_source.xlsx    sheet_name=2nd Sheet

*** Settings ***
Library    DataDriver    file=my_data_source.xlsx    preserve_xls_types=True

PICT（成对独立组合测试）

Pict可以根据模型文件生成数据文件。https://github.com/Microsoft/pict

文档：https://github.com/Microsoft/pict/blob/master/doc/pict.md

*** Settings ***
Library    DataDriver    my_model_file.pict

*** Settings ***
Library    DataDriver    pict_arg.pict    pict_options=/o:3 /r

全局文件模式

此模块实现了一个读取器类，为每个与给定glob模式匹配的文件或文件夹创建一个测试用例。

通过可选参数“arg_name”，您可以修改要设置的参数。请参阅文件夹示例。

json文件示例

*** Settings ***
Library           DataDriver    file=${CURDIR}/DataFiles/*_File.json    reader_class=glob_reader
Library           OperatingSystem
Test Template     Test all Files


*** Test Cases ***
Glob_Reader_Test    Wrong_File.NoJson


*** Keywords ***
Test all Files
    [Arguments]    ${file_name}
    ${file_content}=    Get File    ${file_name}
    ${content}=    Evaluate    json.loads($file_content)["test_case"]
    Should Be Equal    ${TEST_NAME}    ${content}

文件夹示例

*** Settings ***
Library           DataDriver    file=${CURDIR}/FoldersToFind/*/    reader_class=glob_reader    arg_name=\\${folder_name}
Library           OperatingSystem
Test Template     Test all Files


*** Test Cases ***
Glob_Reader_Test    Wrong_File.NoJson


*** Keywords ***
Test all Files
    [Arguments]    ${folder_name}
    ${content}=    Get File    ${folder_name}/verify.txt
    Should Be Equal    ${TEST_NAME}    ${content}

file=

*** Settings ***
Library         DataDriver    file=../data/my_data_source.csv

• None（默认值）：如果测试套件的文件夹中存在与测试套件的*.robot文件同名且扩展名为*.csv的文件，DataDriver将搜索该文件。

• 仅文件扩展名：如果您只设置了文件扩展名，如“.xls”或“.xlsx”，DataDriver将搜索

• 绝对路径：如果设置了文件的绝对路径，DataDriver 将尝试找到并打开指定数据文件。

• 相对路径：如果选项不是指向数据文件的绝对路径，Data Driver 将尝试在测试套件所在的文件夹中寻找数据文件。

编码=

encoding=必须在不是 cp1252 的情况下设置。

示例:

cp1252, ascii, iso-8859-1, latin-1, utf_8, utf_16, utf_16_be, utf_16_le

cp1252是

• 代码页 1252

• Windows-1252

• Windows 西欧

ISO-8859-1（拉丁-1）和cp1252之间的大多数字符相同，除了代码点128-159（0x80-0x9F）。这些字符在cp1252中可用，但在拉丁-1中不可用。

€ ‚ ƒ „ … † ‡ ˆ ‰ Š ‹ Œ Ž ‘ ’ “ ” • – — ˜ ™ š › œ ž Ÿ

有关更多编码，请参阅 Python 标准编码

dialect=

您可以在此更改CSV方言。方言选项可以是以下之一：- Excel-EU - excel - excel-tab - unix - UserDefined

支持的方言

"Excel-EU"
    delimiter=';',
    quotechar='"',
    escapechar='\\',
    doublequote=True,
    skipinitialspace=False,
    lineterminator="\\r\\n",
    quoting=csv.QUOTE_ALL

"excel"
    delimiter = ','
    quotechar = '"'
    doublequote = True
    skipinitialspace = False
    lineterminator = '\\r\\n'
    quoting = QUOTE_MINIMAL

"excel-tab"
    delimiter = '\\t'
    quotechar = '"'
    doublequote = True
    skipinitialspace = False
    lineterminator = '\\r\\n'
    quoting = QUOTE_MINIMAL

"unix"
    delimiter = ','
    quotechar = '"'
    doublequote = True
    skipinitialspace = False
    lineterminator = '\\n'
    quoting = QUOTE_ALL

在 Robot Framework® 中的使用

*** Settings ***
Library    DataDriver    my_data_file.csv    dialect=excel

*** Settings ***
Library    DataDriver    my_data_file.csv    dialect=excel_tab

*** Settings ***
Library    DataDriver    my_data_file.csv    dialect=unix_dialect

*** Settings ***
Library    DataDriver    my_data_file.csv
...    dialect=UserDefined
...    delimiter=.
...    lineterminator=\\n

默认值

file=None,
encoding='cp1252',
dialect='Excel-EU',
delimiter=';',
quotechar='"',
escapechar='\\\\',
doublequote=True,
skipinitialspace=False,
lineterminator='\\r\\n',
sheet_name=0

使用自定义 DataReader

在运行时，DataDriver 会动态地将 DataReader 类加载到 DataDriver 中。DataDriver 通过数据文件的文件扩展名或选项 reader_class 来识别要加载的 DataReader。

*** Settings ***
Library    DataDriver    file=mydata.csv

*** Settings ***
    Library    DataDriver   file=mydata.csv    reader_class=generic_csv_reader    dialect=userdefined   delimiter=\\t    encoding=UTF-8

创建自定义读取器

建议

请查看现有 DataReader 的源代码，如 csv_reader.py 或 generic_csv_reader.py。

要编写自己的读取器，请创建一个继承自 AbstractReaderClass 的类。

在 __init__ 中，您的类将作为 ReaderConfig 对象获取所有可用的配置。

DataDriver 将调用 get_data_from_source 方法。该方法应从您自定义的源加载数据，并将其存储在 TestCaseData 对象的列表中。这个 TestCaseData 列表将被返回给 DataDriver。

AbstractReaderClass 还有一些可能有用的可选辅助方法。

您可以将自定义读取器与其它文件一起放在 DataDriver 文件夹中，或放在磁盘上的任何位置。在第一种情况下或如果您的自定义读取器在 python 路径中，可以像其他文件一样通过名称使用它。

*** Settings ***
Library          DataDriver    reader_class=my_reader

如果它在磁盘上的某个位置，则可以使用绝对或相对路径到自定义读取器。自定义读取器的导入规则与导入 Robot Framework® 库的规则相同。路径可以是相对于 ${EXECDIR} 或 DataDriver/__init__.py 的相对路径。

*** Settings ***
Library          DataDriver    reader_class=C:/data/my_reader.py    # set custom reader
...                            file_search_strategy=None            # set DataDriver to not check file
...                            min=0                                # kwargs arguments for custom reader
...                            max=62

此 my_reader.py 应实现一个继承自 AbstractReaderClass 的类，该类命名为 my_reader。

from DataDriver.AbstractReaderClass import AbstractReaderClass  # inherit class from AbstractReaderClass
from DataDriver.ReaderConfig import TestCaseData  # return list of TestCaseData to DataDriver


class my_reader(AbstractReaderClass):

    def get_data_from_source(self):  # This method will be called from DataDriver to get the TestCaseData list.
        test_data = []
        for i in range(int(self.kwargs['min']), int(self.kwargs['max'])):  # Dummy code to just generate some data
            args = {'${var_1}': str(i), '${var_2}': str(i)}  # args is a dictionary. Variable name is the key, value is value.
            test_data.append(TestCaseData(f'test {i}', args, ['tag']))  # add a TestCaseData object to the list of tests.
        return test_data  # return the list of TestCaseData to DataDriver

请以其他读取器为例。

按名称选择测试用例

robot --variable "DYNAMICTEST:my suite name.test case to be executed" my_suite_name.robot

robot --variable DYNAMICTESTS:firstsuitename.testcase1|firstsuitename.testcase3|anothersuitename.othertestcase foldername

重新执行失败的测试用例

由于无法直接从命令行使用 --rerunfailed 参数，DataDriver 带来了一个 Pre-Run-Modifier，用于处理此问题。

通常重新执行失败的测试用例有三个步骤。

• 原始执行

• 根据原始执行输出重新执行失败的测试用例

• 将原始执行输出与重新执行输出合并

DataDriver.rerunfailed Pre-Run-Modifier 根据先前的 output.xml 删除所有已通过测试用例。

示例

robot --output original.xml tests                                                    # first execute all tests
robot --prerunmodifier DataDriver.rerunfailed:original.xml --output rerun.xml tests  # then re-execute failing
rebot --merge original.xml rerun.xml                                                 # finally merge results

请注意，在这种情况下，不允许在原始输出文件路径中使用“:”作为字符。如果您想在 Windows 上设置完整路径，如 e:\\myrobottest\\output.xml，则必须使用“;”作为参数分隔符。

示例

robot --prerunmodifier DataDriver.rerunfailed;e:\\myrobottest\\output.xml --output e:\\myrobottest\\rerun.xml tests

基于标签进行过滤。

新增于 0.3.1

可以使用标签来过滤数据源。要使用此功能，必须在数据源中的测试用例分配标签。

*** Settings ***
Library    DataDriver    include=1OR2    exclude=foo