robotframework-datadriver 1.6.1

Excel 支持

对于xls或xlsx文件的文件支持，您需要安装额外的 XLS 或依赖项。它包含 pandas、numpy 和 xlrd 的依赖项。只需将 [XLS] 添加到您的安装中。自 3.6 版以来的新功能。

pip install --upgrade robotframework-datadriver[XLS]

蟒蛇2

或者如果您并行安装了 Python 2 和 3，您可以使用

pip3 安装--升级机器人 框架-数据驱动程序

DataDriver 仅在 0.2.7 版本中与 Python 2.7 兼容。

pip install --upgrade robotframework-datadriver==0.2.7

由于 Python 2.7 已被弃用，python 2.7 兼容版本没有新功能。

RoboCon 2020 演讲

简要概述 DataDriver 是什么以及它在赫尔斯基的 RoboCon 2020 上的工作原理。

替代方法

DataDriver 为内置数据驱动方法提供了一种替代方法，例如：

*** 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    <s>demo</s>        ${EMPTY}
Right user wrong pass    <s>demo</s>        <s>FooBar</s>

Empty user right pass    ${EMPTY}    <s>mode</s>
Empty user empty pass    ${EMPTY}    ${EMPTY}
Empty user wrong pass    ${EMPTY}    <s>FooBar</s>

Wrong user right pass    <s>FooBar</s>      <s>mode</s>
Wrong user empty pass    <s>FooBar</s>      ${EMPTY}
Wrong user wrong pass    <s>FooBar</s>      <s>FooBar</s>

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

这种内置方法适用于满手数据和满手测试用例。如果您已经生成或计算了数据，特别是如果您有可变数量的测试用例/组合，这些机器人文件会变得非常痛苦。使用 DataDriver，您可以编写相同的测试用例语法，但只编写一次，并从外部数据文件传递数据。

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

查看示例测试套件

请参阅示例 csv 表

要求

目前有一些要求，必须如何构建测试套件，以便 DataDriver 可以获取所需的所有信息。

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

• 测试用例必须在设置部分使用 测试模板定义。这样做的原因是，DataDriver 需要知道测试用例参数的名称。测试用例没有命名参数。关键字可以。

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

示例测试套件

***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}    <s>Default</s>    <s>UserData</s>

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

在此示例中，DataDriver 通过将其用作库来激活。它与默认设置一起使用。使用关键字无效登录作为测试模板。这个关键字有两个参数。参数名称是${username}和 ${password}。这些名称必须在 CSV 文件中作为列标题。测试用例的名称中包含两个变量名称，这在 Robot Framework® 中没有任何功能。但是，数据驱动程序将使用测试用例名称作为模板名称，并将变量替换为单个生成的测试用例的特定值。此模板测试将仅用作模板。指定数据 Default和UserData仅在未找到 CSV 文件时使用。

分钟。必填列

• *** 测试用例 ***列必须是第一个。

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

可选列

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

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

示例数据文件

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

支持的数据类型

一般来说，DataDriver 支持从 DataReader 移交的任何 Object。然而，基于文本的 csv、excel 等阅读器也支持不同的类型。DataDriver 支持 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    <s>.xlsx</s>

或者：

*** Settings ***
Library    DataDriver    <s>file=my_data_source.xlsx</s>    <s>sheet_name=2nd Sheet</s>

*** Settings ***
Library    DataDriver    <s>file=my_data_source.xlsx</s>    <s>preserve_xls_types=True</s>

PICT（成对独立组合测试）

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

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

*** Settings ***
Library    DataDriver    <s>my_model_file.pict</s>

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

Glob 文件模式

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

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

带有 json 文件的示例：

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


*** Test Cases ***
Glob_Reader_Test    <s>Wrong_File.NoJson</s>


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

文件夹示例：

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


*** Test Cases ***
Glob_Reader_Test    <s>Wrong_File.NoJson</s>


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

文件=

*** Settings ***
Library         DataDriver    <s>file=../data/my_data_source.csv</s>

• 无（默认）：如果存在与测试套件 *.robot 文件同名的 *.csv 文件，Data Driver 将在测试套件文件夹中搜索

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

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

• 相对路径：如果该选项没有将数据文件作为绝对路径指向，Data Driver 会尝试查找相对于测试套件所在文件夹的数据文件。

编码=

如果不是 cp1252，则必须设置encoding= 。

例子：

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

cp1252是：

• 代码页 1252

• Windows-1252

• Windows 西欧

除了代码点 128-159 (0x80-0x9F) 之外，ISO-8859-1 (Latin-1) 之间的大多数字符都是相同的。这些字符在 cp1252 中可用，而在 Latin-1 中不存在。

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

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

方言=

您可以在此处更改 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 =