robotframework-reqcov 0.1.0

Listener for generating requirement coverage reports for tests performed with Robot Framework

1. Robot Framework Requirement Coverage

• 1. Robot Framework Requirement Coverage
• 2. English
  • 2.1. Introduction
  • 2.2. Features
  • 2.3. Installation
  • 2.4. How to Use
  • 2.5. Compatibility
• 3. Portuguese
  • 3.1. Introdução
  • 3.2. Recursos
  • 3.3. Instalação
  • 3.4. Como Usar
  • 3.5. Compatibilidade
• 4. Video

2. English

2.1. Introduction

This listening library generates reports on requirements coverage for automated tests in the Robot Framework. The report includes:

2.2. Features

• Identification of tested requirements through Tags
• Generation of an HTML report coverage_report.html.
• Addition of a summary in the console with analysis information
• Support for light and dark mode (Dark Mode).
• Visual progress bar indicating test coverage.
• Test execution failure if the minimum coverage (if informed) is not reached. - Indication of tested and untested requirements and number of tests per requirement

2.3. Installation

With pip:

pip install robotframework-reqcov

With poetry:

poetry add robotframework-reqcov

2.4. How to Use

1 - Create a CSV file with the requirements, as shown in the example below:

Requirement,Description
REQ-001,Requirement 1
REQ-002,Requirement 2
REQ-003,Requirement 3
REQ-004,Requirement 4
REQ-005,Requirement 5

2 - Add tags to the tests to track the requirements

The id of each requirement reported in the csv file should be used as a TAG in the related tests.

• Example 1:

*** Settings ***
Test Tags  REQ-001

*** Test Cases ***
Scenario: Test Req 1

    Pass Execution    Hello REQ-001

• Example 2:

*** Test Cases ***
Scenario: Test Req 2
    [Tags]  REQ-002
    Pass Execution    Hello REQ-002 

3 - Run the tests and generate the coverage report

3.1 - Without minimum coverage

robot -d reports --listener RobotRequirementsCovarege:requirements.csv .

3.2 - With minimum coverage

robot -d reports --listener RobotRequirementsCovarege:requirements.csv:60 .  

By default, the report file coverage_report.html will be added in the same directory where the Robot Framework files will be added.

2.5. Compatibility

• Robot Framework 7.0
• Python 3

3. Portuguese

3.1. Introdução

Esta biblioteca ouvinte, gera relatórios sobre cobertura de requisitos para testes automatizados no Robot Framework. O relatório inclui:

3.2. Recursos

• Identificação dos requisitos testados por meio de Tags
• Geração de um report HTML coverage_report.html.
• Adição de um sumário no console com informações da análise
• Suporte a modo claro e escuro (Dark Mode).
• Barra de progresso visual indicando cobertura de testes.
• Falha na execução dos testes caso a cobertura mínima (caso informado) não seja atingida.
• Indicação dos requisitos testados, não testados e quantidade de testes por requisitos

3.3. Instalação

Com pip:

pip install robotframework-reqcov

Com poetry:

poetry add robotframework-reqcov 

3.4. Como Usar

1 - Crie um arquivo CSV com os requisitos, conforme o exemplo abaixo:

Requirement,Description
REQ-001,Requirement 1
REQ-002,Requirement 2
REQ-003,Requirement 3
REQ-004,Requirement 4
REQ-005,Requirement 5

2 - Adicionar tags nos testes para rastrear os requisitos

O id de cada requisito informado no arquivo csv, deverá ser utilizado como TAG nos testes relacionados.

• Exemplo 1:

*** Settings ***
Test Tags  REQ-001

*** Test Cases ***
Scenario: Test Req 1

    Pass Execution    Hello REQ-001

• Exemplo 2:

*** Test Cases ***
Scenario: Test Req 2
    [Tags]  REQ-002
    Pass Execution    Hello REQ-002 

3 - Executar os testes e gerar o relatório de cobertura

3.1 - Sem cobertura mínima

robot -d reports --listener RobotRequirementsCovarege:requirements.csv .

3.2 - Com cobertura mínima

robot -d reports --listener RobotRequirementsCovarege:requirements.csv:60 .

Por padrão, o arquivo de report coverage_report.html será adicionado no mesmo diretório onde os arquivos do Robot Framework serão adicionados.

3.5. Compatibilidade

• Robot Framework 7.0
• Python 3

4. Video

Veja o vídeo abaixo para mais informações / See the video below for more information: