Metadata-Version: 2.1
Name: robotframework-reqcov
Version: 0.1.2
Summary: Listener for generating requirement coverage reports for tests performed with Robot Framework
License: License :: OSI Approved :: Apache Software License
Author: Robot Courses
Author-email: git@robotcourses.com.br
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 5 - Production/Stable
Classifier: Framework :: Robot Framework
Classifier: Framework :: Robot Framework :: Library
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Requires-Dist: robotframework (>=7.0,<8.0)
Project-URL: Bugs Tracker, https://github.com/robotcourses/robotframework-reqcov/issues
Project-URL: Github, https://github.com/robotcourses/robotframework-reqcov
Description-Content-Type: text/markdown

# 1. Robot Framework Requirement Coverage

- [1. Robot Framework Requirement Coverage](#1-robot-framework-requirement-coverage)
- [2. Video](#2-video)
- [3. English](#3-english)
  - [3.1. Introduction](#31-introduction)
  - [3.2. Features](#32-features)
  - [3.3. Installation](#33-installation)
  - [3.4. How to Use](#34-how-to-use)
  - [3.5. Compatibility](#35-compatibility)
- [4. Portugês](#4-portugês)
  - [4.1. Introdução](#41-introdução)
  - [4.2. Recursos](#42-recursos)
  - [4.3. Instalação](#43-instalação)
  - [4.4. Como Usar](#44-como-usar)
  - [4.5. Compatibilidade](#45-compatibilidade)


# 2. Video

Aprenda a usar a biblioteca assistindo ao nosso vídeo no YouTube: // 
Learn how to use the library by watching our YouTube video:

[![Cobertura de Requisitos no Robot Framework](https://img.youtube.com/vi/q9S4Y6LqZic/maxresdefault.jpg)](https://www.youtube.com/watch?v=q9S4Y6LqZic)

🔗 **Clique na imagem para assistir ao vídeo.**

🔗 **Click on the image to watch the video.**


# 3. English
## 3.1. Introduction

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

## 3.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

## 3.3. Installation

With pip:
```bash
pip install robotframework-reqcov
```

With poetry:
```bash
poetry add robotframework-reqcov
```

## 3.4. How to Use
1 - Create a CSV file with the requirements, as shown in the example below:

``` csv
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:
``` robot
*** Settings ***
Test Tags  REQ-001

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

    Pass Execution    Hello REQ-001
```

- Example 2:
``` robot
*** 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
``` bash
robot -d reports --listener RobotRequirementsCovarege:requirements.csv .
```

3.2 - With minimum coverage

``` bash
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.

## 3.5. Compatibility

- [Robot Framework 7.0](https://pypi.org/project/robotframework/7.0/)
- [Python 3](https://www.python.org/)



# 4. Portugês
## 4.1. Introdução

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


## 4.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

## 4.3. Instalação

Com pip:
```bash
pip install robotframework-reqcov
```

Com poetry:
```bash
poetry add robotframework-reqcov 
```

## 4.4. Como Usar
1 - Crie um arquivo CSV com os requisitos, conforme o exemplo abaixo:

``` csv
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:
``` robot
*** Settings ***
Test Tags  REQ-001

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

    Pass Execution    Hello REQ-001
```

   - Exemplo 2:
``` robot
*** 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 
``` bash
robot -d reports --listener RobotRequirementsCovarege:requirements.csv .
```

3.2 - Com cobertura mínima 

``` bash
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.

## 4.5. Compatibilidade

-  [Robot Framework 7.0](https://pypi.org/project/robotframework/7.0/)
-  [Python 3](https://www.python.org/)
