{"id":25846559,"url":"https://github.com/robotcourses/robotframework-reqcov","last_synced_at":"2026-06-10T19:31:01.356Z","repository":{"id":279871476,"uuid":"940270453","full_name":"robotcourses/robotframework-reqcov","owner":"robotcourses","description":null,"archived":false,"fork":false,"pushed_at":"2025-04-11T14:11:53.000Z","size":59,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-22T20:56:36.417Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/robotcourses.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-02-27T22:23:23.000Z","updated_at":"2025-04-11T14:11:56.000Z","dependencies_parsed_at":"2025-11-24T03:02:59.350Z","dependency_job_id":null,"html_url":"https://github.com/robotcourses/robotframework-reqcov","commit_stats":null,"previous_names":["robotcourses/robotframework-reqcov"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/robotcourses/robotframework-reqcov","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robotcourses%2Frobotframework-reqcov","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robotcourses%2Frobotframework-reqcov/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robotcourses%2Frobotframework-reqcov/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robotcourses%2Frobotframework-reqcov/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/robotcourses","download_url":"https://codeload.github.com/robotcourses/robotframework-reqcov/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robotcourses%2Frobotframework-reqcov/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34168086,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-10T02:00:07.152Z","response_time":89,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-03-01T09:32:46.980Z","updated_at":"2026-06-10T19:31:01.339Z","avatar_url":"https://github.com/robotcourses.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 1. Robot Framework Requirement Coverage\n\n- [1. Robot Framework Requirement Coverage](#1-robot-framework-requirement-coverage)\n- [2. Video](#2-video)\n- [3. English](#3-english)\n  - [3.1. Introduction](#31-introduction)\n  - [3.2. Features](#32-features)\n  - [3.3. Installation](#33-installation)\n  - [3.4. How to Use](#34-how-to-use)\n  - [3.5. Compatibility](#35-compatibility)\n- [4. Portugês](#4-portugês)\n  - [4.1. Introdução](#41-introdução)\n  - [4.2. Recursos](#42-recursos)\n  - [4.3. Instalação](#43-instalação)\n  - [4.4. Como Usar](#44-como-usar)\n  - [4.5. Compatibilidade](#45-compatibilidade)\n\n\n# 2. Video\n\nAprenda a usar a biblioteca assistindo ao nosso vídeo no YouTube: // \nLearn how to use the library by watching our YouTube video:\n\n[![Cobertura de Requisitos no Robot Framework](https://img.youtube.com/vi/q9S4Y6LqZic/maxresdefault.jpg)](https://www.youtube.com/watch?v=q9S4Y6LqZic)\n\n🔗 **Clique na imagem para assistir ao vídeo.**\n\n🔗 **Click on the image to watch the video.**\n\n\n# 3. English\n## 3.1. Introduction\n\nThis listening library generates reports on requirements coverage for automated tests in the Robot Framework. The report includes:\n\n## 3.2. Features\n\n- Identification of tested requirements through Tags\n- Generation of an HTML report coverage_report.html.\n- Addition of a summary in the console with analysis information\n- Support for light and dark mode (Dark Mode).\n- Visual progress bar indicating test coverage.\n- Test execution failure if the minimum coverage (if informed) is not reached.  - Indication of tested and untested requirements and number of tests per requirement\n\n## 3.3. Installation\n\nWith pip:\n```bash\npip install robotframework-reqcov\n```\n\nWith poetry:\n```bash\npoetry add robotframework-reqcov\n```\n\n## 3.4. How to Use\n1 - Create a CSV file with the requirements, as shown in the example below:\n\n``` csv\nRequirement,Description\nREQ-001,Requirement 1\nREQ-002,Requirement 2\nREQ-003,Requirement 3\nREQ-004,Requirement 4\nREQ-005,Requirement 5\n```\n\n2 - Add tags to the tests to track the requirements\n\nThe `id` of each requirement reported in the csv file should be used as a TAG in the related tests.\n\n- Example 1:\n``` robot\n*** Settings ***\nTest Tags  REQ-001\n\n*** Test Cases ***\nScenario: Test Req 1\n\n    Pass Execution    Hello REQ-001\n```\n\n- Example 2:\n``` robot\n*** Test Cases ***\nScenario: Test Req 2\n    [Tags]  REQ-002\n    Pass Execution    Hello REQ-002 \n```\n\n3 - Run the tests and generate the coverage report\n\n3.1 - Without minimum coverage\n``` bash\nrobot -d reports --listener RobotRequirementsCovarege:requirements.csv .\n```\n\n3.2 - With minimum coverage\n\n``` bash\nrobot -d reports --listener RobotRequirementsCovarege:requirements.csv:60 .  \n```\n\nBy default, the report file `coverage_report.html` will be added in the same directory where the Robot Framework files will be added.\n\n## 3.5. Compatibility\n\n- [Robot Framework 7.0](https://pypi.org/project/robotframework/7.0/)\n- [Python 3](https://www.python.org/)\n\n\n\n# 4. Portugês\n## 4.1. Introdução\n\nEsta biblioteca ouvinte, gera relatórios sobre cobertura de requisitos para testes automatizados no Robot Framework. O relatório inclui:\n\n\n## 4.2. Recursos\n\n- Identificação dos requisitos testados por meio de Tags\n- Geração de um report HTML coverage_report.html.\n- Adição de um sumário no console com informações da análise \n- Suporte a modo claro e escuro (Dark Mode).\n- Barra de progresso visual indicando cobertura de testes.\n- Falha na execução dos testes caso a cobertura mínima (caso informado) não seja atingida.\n- Indicação dos requisitos testados, não testados e quantidade de testes por requisitos\n\n## 4.3. Instalação\n\nCom pip:\n```bash\npip install robotframework-reqcov\n```\n\nCom poetry:\n```bash\npoetry add robotframework-reqcov \n```\n\n## 4.4. Como Usar\n1 - Crie um arquivo CSV com os requisitos, conforme o exemplo abaixo:\n\n``` csv\nRequirement,Description\nREQ-001,Requirement 1\nREQ-002,Requirement 2\nREQ-003,Requirement 3\nREQ-004,Requirement 4\nREQ-005,Requirement 5\n```\n\n2 - Adicionar tags nos testes para rastrear os requisitos\n\nO `id` de cada requisito informado no arquivo csv, deverá ser utilizado como TAG nos testes relacionados.\n\n   - Exemplo 1:\n``` robot\n*** Settings ***\nTest Tags  REQ-001\n\n*** Test Cases ***\nScenario: Test Req 1\n\n    Pass Execution    Hello REQ-001\n```\n\n   - Exemplo 2:\n``` robot\n*** Test Cases ***\nScenario: Test Req 2\n    [Tags]  REQ-002\n    Pass Execution    Hello REQ-002 \n```\n\n3 - Executar os testes e gerar o relatório de cobertura\n\n3.1 - Sem cobertura mínima \n``` bash\nrobot -d reports --listener RobotRequirementsCovarege:requirements.csv .\n```\n\n3.2 - Com cobertura mínima \n\n``` bash\nrobot -d reports --listener RobotRequirementsCovarege:requirements.csv:60 .\n```\n\nPor padrão, o arquivo de report `coverage_report.html` será adicionado no mesmo diretório onde os arquivos do Robot Framework serão adicionados.\n\n## 4.5. Compatibilidade\n\n-  [Robot Framework 7.0](https://pypi.org/project/robotframework/7.0/)\n-  [Python 3](https://www.python.org/)","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobotcourses%2Frobotframework-reqcov","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobotcourses%2Frobotframework-reqcov","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobotcourses%2Frobotframework-reqcov/lists"}