Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/eriwen/lcov-to-cobertura-xml
Converts lcov output to Cobertura-compatible XML for CI
https://github.com/eriwen/lcov-to-cobertura-xml
cobertura coverage
Last synced: 4 days ago
JSON representation
Converts lcov output to Cobertura-compatible XML for CI
- Host: GitHub
- URL: https://github.com/eriwen/lcov-to-cobertura-xml
- Owner: eriwen
- License: apache-2.0
- Created: 2011-11-12T19:02:23.000Z (about 13 years ago)
- Default Branch: master
- Last Pushed: 2024-09-03T21:31:35.000Z (5 months ago)
- Last Synced: 2024-10-14T11:04:19.226Z (3 months ago)
- Topics: cobertura, coverage
- Language: Python
- Homepage: https://eriwen.github.io/lcov-to-cobertura-xml/
- Size: 2.8 MB
- Stars: 188
- Watchers: 16
- Forks: 73
- Open Issues: 16
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# lcov to cobertura XML converter
[](https://github.com/eriwen/lcov-to-cobertura-xml/actions/workflows/ci.yml)
[](https://github.com/eriwen/lcov-to-cobertura-xml/actions/workflows/sphinx.yml)
[](https://github.com/eriwen/lcov-to-cobertura-xml/actions/workflows/bandit.yml)
[](https://github.com/eriwen/lcov-to-cobertura-xml/actions/workflows/release.yml)
This project does as the name implies: it converts code coverage report files in [lcov](http://ltp.sourceforge.net/coverage/lcov.php) format to [Cobertura](http://cobertura.sourceforge.net/)'s XML report format so that CI servers like [Jenkins](http://jenkins-ci.org) can aggregate results and determine build stability etc.
Coverage metrics supported:
- Package/folder overall line and branch coverage
- Class/file overall line and branch coverage
- Functions hit
- Line and Branch hits
## Quick usage
[Grab it raw](https://raw.github.com/eriwen/lcov-to-cobertura-xml/master/lcov_cobertura/lcov_cobertura.py) and run it with python:
```bash
python lcov_cobertura.py lcov-file.dat
```
- `-b/--base-dir` - (Optional) Directory where source files are located. Defaults to the current directory
- `-e/--excludes` - (Optional) Comma-separated list of regexes of packages to exclude
- `-o/--output` - (Optional) Path to store cobertura xml file. _Defaults to ./coverage.xml_
- `-d/--demangle` - (Optional) Demangle C++ function names. _Requires c++filt_
```bash
python lcov_cobertura.py lcov-file.dat --base-dir src/dir --excludes test.lib --output build/coverage.xml --demangle
```
## With [pip](http://pypi.python.org/pypi/pip):
```bash
pip install lcov_cobertura
```
### Command-line usage
```bash
lcov_cobertura lcov-file.dat
```
- `-b/--base-dir` - (Optional) Directory where source files are located. Defaults to the current directory
- `-e/--excludes` - (Optional) Comma-separated list of regexes of packages to exclude
- `-o/--output` - (Optional) Path to store cobertura xml file. _Defaults to ./coverage.xml_
- `-d/--demangle` - (Optional) Demangle C++ function names. _Requires c++filt_
```bash
lcov_cobertura lcov-file.dat --base-dir src/dir --excludes test.lib --output build/coverage.xml --demangle
```
### Usage as a Python module
Use it anywhere in your python:
```python
from lcov_cobertura import LcovCobertura
LCOV_INPUT = 'SF:foo/file.ext\nDA:1,1\nDA:2,0\nend_of_record\n'
converter = LcovCobertura(LCOV_INPUT)
cobertura_xml = converter.convert()
print(cobertura_xml)
```
## Environment Support
Python 3.8+ is supported. The last release with Python 2.x support is [version 1.6](https://pypi.org/project/lcov_cobertura/1.6/).
## Contributions
This project is made possible due to the efforts of these fine people:
- [Eric Wendelin](https://eriwen.com)
- [Björge Dijkstra](https://github.com/bjd)
- [Jon Schewe](http://mtu.net/~jpschewe)
- [Yury V. Zaytsev](http://yury.zaytsev.net)
- [Steve Arnold](https://github.com/sarnold)
## License
This project is provided under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).