Skip to content

Latest commit

 

History

History
91 lines (66 loc) · 2.72 KB

label.rst

File metadata and controls

91 lines (66 loc) · 2.72 KB

Allure labels for Robot Framework tests

You can attach allure labels to test results using the following mechanisms:

  1. From a test case file with robot framework tags
  2. From a test library, i.e., directly from python code

Add an allure label from a test case file

Apply a allure.label.<NAME>:<VALUE> tag to your test case. Such a tag will be automatically converted to the allure label:

*** Test Cases ***
Test authored by John Doe
    [Tags]  allure.label.author:John Doe
    No Operation

You can define any label that way, being it a built-in or a custom one. If you want to add a built-in label, a shorter version of the syntax can be used:

*** Test Cases ***
Test with the pinned ID
    [Tags]  allure.id:1008
    ...     allure.story:RF tags as allure labels
    No Operation

Use the Test Tags setting to automatically apply tags to all test cases:

*** Settings ***
Test Tags  allure.feature:Allure labels support

*** Test Cases ***
Test with two BDD-labels
    [Tags]  allure.story:RF tags as allure labels
    No Operation

You can read more about applying tags to test cases here: Tagging test cases.

Add an allure label from a test library

To add a label from python code use the @allure.label decorator, the allure.dynamic.label function or their specialized alternatives for built-in allure labels:

my_library.py:

import allure
import os

@allure.label("layer", "API")
@allure.severity(allure.severity_level.CRITICAL)
def open_api(host, port):
    allure.dynamic.label("endpoint", f"{host}:{port}")
    allure.dynamic.suite(f"Testing API at {host}")

Now, if you import this library in a test case file and invoke its [Open API] keyword, the test case receives four allure lables: layer, severity, endpoint and suite:

*** Settings ***
Library  ./my_library.py

*** Test Cases ***
Test backend API
    [Documentation]     Four labels should be attached to this test result.
    Open API            host=localhost
    ...                 port=443