{"id":15018749,"url":"https://github.com/kootstra/robotframework-allurereport","last_synced_at":"2025-09-29T13:31:11.295Z","repository":{"id":57462318,"uuid":"77247055","full_name":"kootstra/robotframework-allurereport","owner":"kootstra","description":"This is a library for the Allure Framework and Robot Framework.","archived":false,"fork":true,"pushed_at":"2017-11-22T06:29:57.000Z","size":47,"stargazers_count":21,"open_issues_count":11,"forks_count":16,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-04-30T00:46:24.755Z","etag":null,"topics":["allure","python","reporting","robotframework"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"keenyang/robotframework_allure","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kootstra.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-12-23T19:40:37.000Z","updated_at":"2024-02-11T23:10:30.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/kootstra/robotframework-allurereport","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kootstra%2Frobotframework-allurereport","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kootstra%2Frobotframework-allurereport/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kootstra%2Frobotframework-allurereport/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kootstra%2Frobotframework-allurereport/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kootstra","download_url":"https://codeload.github.com/kootstra/robotframework-allurereport/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":234624028,"owners_count":18862269,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["allure","python","reporting","robotframework"],"created_at":"2024-09-24T19:52:24.330Z","updated_at":"2025-09-29T13:31:10.918Z","avatar_url":"https://github.com/kootstra.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Allure Adaptor for Robot Framework\n==================================\n\n.. contents::\n   :local:\n\nIntroduction\n------------\n\nThe Allure Adaptor for Robot Framework is a Library that can be included\nin the Robot scripts to generate `Allure \u003chttp://allure.qatools.ru/\u003e`_\ncompatible XML files which can then be used to generate the Allure HTML\nreports. These reports provide a clear and dynamic overview of the status\nof the test run through several graphs and a time line overview of the run\nitself.\n\n.. image:: https://img.shields.io/pypi/v/robotframework-allurereport.svg?label=version\n   :target: https://pypi.python.org/pypi/robotframework-allurereport\n   :alt: Latest version\n\n.. image:: https://img.shields.io/pypi/dm/robotframework-allurereport.svg\n   :target: https://pypi.python.org/pypi/robotframework-allurereport\n   :alt: Number of downloads\n   \n.. image:: \n    https://img.shields.io/badge/license-MIT-blue.svg   \n    :target: https://raw.githubusercontent.com/kootstra/robotframework-allurereport/master/LICENSE.txt\n    :alt: License\n\n.. image:: https://robotframework-slack.herokuapp.com/badge.svg\n   :target: https://robotframework-slack.herokuapp.com\n   :alt: Slack channel\n\nFeatures\n--------\n\n-   Steps in Allure Framework are aligned to Keyword in Robot Framework.\n-   Test Suites map to Allure Test Cases are the same at both xml formats of \n    Robot Framework and Allure.\n-   Feature and Stories are implemented as robot framework Tags story:name and\n    feature:name format.\n-   External Issues Id's are supported as Robot Framework tags and an option to \n    define a regular expression for their recognition.\n-   Link to the Issue Management system (For example JIRA) can be configured. \n-   The Allure adapter output is on top of the standard Robot Framework and does \n    not replace it. \n-   Initialisation is done as a Robot Framework Library or as a Command Line \n    Listener. Listener is preferred over the Library when in conflict.\n-   Parallelisation is supported, both manually started Robot Framework instances \n    as well as using `Pabot \u003chttps://github.com/mkorpela/pabot\u003e`_ (version 0.32+).\n-   Supports overriding of Test Case status with: failed, broken, canceled, \n    pending or passed by using Tags.\n-   Extends the number of Severity options to: blocker, critical, normal, minor \n    or trivial through use of Robot Framework Tags\n-   The Allure Library is compatible with the Libspec API used by editors as for \n    example `RED \u003chttps://github.com/nokia/RED\u003e`_\n-   Supports nesting of keywords. \n-   Provides Robot Framwork Environment information in the Environment section \n    (versions, CLI arguments, OS type).\n-   Screenshots created by the Selenium2Library are supported.\n\n\nInstallation\n------------\nPrerequisites:\n^^^^^^^^^^^^^ \nThe Allure adapter for Robotframework has a number of requirements that need to\nbe in place:\n-   Python. In testing 2.7 has been used. \n-   `Allure Pytest Adaptor \u003chttps://github.com/allure-framework/allure-python\u003e` \n    who'se foundation Python classes are used. It will be installed if not present.\n-   Robot Framework versions 2.8.5 and 3.0 have been used in testing. Since Robot \n    Framework can be installed outside of `pip` this is not automatically installed.\n-   `Allure Command line \u003chttp://wiki.qatools.ru/display/AL/Allure+Commandline\u003e`\n    is needed to convert the Allure adapter for Robot Framework output files to \n    the final HTML format.\n-   The Allure command line application requires Java Runtime Environment of 1.7\n    higher to function properly.\n\nSteps\n^^^^^^^^^^^^^^\nUse PIP::\n\n    pip install robotframework-allurereport\n\n\nClone the project repository from GitHub. After that you can install\nthe framework with::\n\n    python setup.py install\n\nUsage\n-------\nThe Allure adapter can be started as Library from within a Robot Framework test \nsuite or when Robot Framework is started as a command line switch.\n\nLibrary\n^^^^^^^\nBelow is a example Robot Framework suite file. The AllureLibrary is added in the\nSettings section of the file. When it's loaded it adds the listener to Robot\nFramework.\n\nOptionally an argument can be provided to have the Allure adapter store its \nfiles in a different folder from the normal Robot Framework log files. \n\n.. code:: robotframework\n\n    Library           AllureReportLibrary     C:\\\\Temp\\\\Allure\n\nBelow a more complete example:\n\n.. code:: robotframework\n\n    *** Settings ***\n    Documentation     A test suite with a single test for valid login.\n    ...\n    ...               This test has a workflow that is created using keywords in\n    ...               the imported resource file.\n    Resource          resource.robot\n    Library           AllureReportLibrary      //var//lib//Allure\n\n    *** Test Cases ***\n    Valid Login\n        Open Browser To Login Page\n        Input Username    demo\n        Input Password    mode\n        Submit Credentials\n        Welcome Page Should Be Open\n        [Teardown]    Close Browser\n\nCommand line switch\n^^^^^^^^^^^^^^^^^^\nFor enabling the Allure adapter for a large set of suites files or simply for \nprefer to switch it on when needed, specifying a `listner \u003chttp://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#listener-interface\u003e`_ on the command line \nis the recommended approach.\n\nThe Listener is a class in the AllureLibrary Python module and can be directly \naccessed as `AllureLibrary.AllureListener` or in case the module is not installed\nvia PIP the full path to the `AllureListner.py` file.\n\nThe listener has 1 option argument to set the output folder. In the same way as \nthe Library the full path to the folder where the files can be stored.:: \n\n    robot --listener AllureReportLibrary.AllureListener;C:\\\\tmp\\AllureLog\\ C:\\tmp\\\\RobotScripts\n\nAnother example but then for `Pabot \u003chttps://github.com/mkorpela/pabot\u003e`_. Since\nit supports the regular Robot Framework command line switches as well the difference\nis small.::\n\n    pabot --processes 2 --listener AllureReportLibrary.AllureListener;C:\\\\tmp\\AllureLog\\ C:\\tmp\\\\RobotScripts\n\nNotes\n-----\n\nThe Allure Adapter for Robotframework adheres to the Allure `Output Convention \u003chttps://github.com/allure-framework/allure1/wiki/Creating-Allure-Adapter#output-file-conventions\u003e`.\n\n-  Every XML file should be named like this: `{UUID}-testsuite.xml`,\n   where `{UUID}` is a `universally unique identifier`_.\n-  Every XML file should be valid when checked with the `Allure\n   schema`_.\n-  The output result of an Allure adapter should store not only XML\n   files with information about tests, but also copies of all attached\n   files.\n-  Every `attachment`_ file should be named like this:\n   `{HASH-SUM}-attachment.{EXT}`, where `{HASH-SUM}` is the\n   cryptographic hash sum of the file contents (e.g. `MD5`_, `SHA1`_,\n   `Whirlpool`_ and so on), `{EXT}` is the file extension\n   corresponding to the `MIME type`_ in the XML file. We require\n   cryptographic hash sums in order to avoid storing files with\n   duplicate content.\n\n.. _universally unique identifier: http://en.wikipedia.org/wiki/Uuid\n.. _Allure schema: https://github.com/allure-framework/allure-core/blob/master/allure-model/src/main/resources/allure.xsd\n.. _attachment: https://github.com/allure-framework/allure-core/wiki/Glossary#attachment\n.. _MD5: http://en.wikipedia.org/wiki/MD5\n.. _SHA1: http://en.wikipedia.org/wiki/SHA1\n.. _Whirlpool: http://en.wikipedia.org/wiki/Whirlpool_%28cryptography%29\n.. _MIME type: http://en.wikipedia.org/wiki/MIME\n\n\nFurther development\n-------------------\n\nWith logging being influenced by a lot of different factors the present state\ndoes not cover all options and permutations. Some notable examples that are \nslated for upcoming releases:\n\n-   Screenshots are saved as a copy of the screenshots generated from\n    Robot Framework. This requires the regular logging to happen in parallel. \n-   Command line settings for criticality and non-criticality are currently not\n    used.\n-   Suite Setup and Tear down may not behave as expected.\n-   Interaction between the Library and Listener is currently not possible. The \n    Library on facilitates the initialisation, but not any interaction.\n-   Although maybe last, certainly not least: documentation. \n\nLicense\n-------\n\nAllure Adaptor for Robot Framework is open source software provided under the \n`MIT License \u003chttps://opensource.org/licenses/MIT\u003e`_. This software depends on \n`Allure Reporting \u003chttps://github.com/allure-framework/allure1\u003e`_ and the \nAllure Python adapter. These two projects are also based on GitHub but are \navailable under the `Apache 2.0 license \u003chttp://www.apache.org/licenses/\u003e`_. \nOther dependent Python Modules are available but perhaps under other licenses. \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkootstra%2Frobotframework-allurereport","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkootstra%2Frobotframework-allurereport","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkootstra%2Frobotframework-allurereport/lists"}