f5cc3e1e87
We are having toml based configuration. |
||
---|---|---|
rpmlint | ||
test | ||
tools | ||
.coveragerc | ||
.dockerignore | ||
.editorconfig | ||
.gitignore | ||
.travis.yml | ||
COPYING | ||
Makefile | ||
README.md | ||
setup.cfg | ||
setup.py |
README.md
rpmlint
rpmlint is a tool for checking common errors in rpm packages. rpmlint can be used to test individual packages before uploading or to check an entire distribution.
rpmlint can check binary rpms, source rpms, and plain specfiles, but all checks do not apply to all argument types. For best check coverage, run rpmlint on source rpms instead of plain specfiles.
The idea for rpmlint is from the lintian tool of the Debian project. All the checks reside in rpmlint/checks folder. Feel free to provide new checks and suggestions at:
https://github.com/rpm-software-management/rpmlint
Install
For installation on your machine you will need following packages:
- Python 3.6 or newer
- Python setuptoools
- rpm and its python bindings
- readelf, cpio, gzip, bzip and xz
- libmagic and its python bindings (optional)
- groff and gtbl (optional)
- enchant and its python bindings (optional)
- appstream-util, part of appstream-glib (optional)
Testing
If you want to test the rpmlint when developing best is to use docker
to provide the enviroment for you. There are various distribution
dockerfiles in test/
folder.
Ie. if you want to test on latest openSUSE you can test using following commands:
docker build -t opensusetw -f test/Dockerfile-opensusetw .
docker run -v $(pwd):/usr/src/rpmlint/ opensusetw python3 setup.py test
Another option is to run the tests on your system directly. If you
have all the required modules as listed on the Install section above.
You will also need pytest
and pytest-cov
and pytest-flake8
.
If all the dependencies are present you can just execute tests using:
python3 setup.py test
Or even pick one of the tests using pytest:
python3 -m pytest test/test_config.py
Bugfixing and contributing
Any help of course welcome but honestly most probable cause for your visit here is that rpmlint is marking something as invalid while it shouldn't or it is marking something as correct while it should not either :)
Now there is easy way how to fix that. Our testsuite simply needs an extension to take the above problem into the account.
Primarily we just need the offending rpm file (best the smallest you can find or we would soon take few GB to take a checkout) and some basic expectation of what should happen.
Now lets look on an example workflow:
- I have rpmfile that should report unreadable zip file
- I store this file in git under
test/binary/texlive-codepage-doc-2018.151.svn21126-38.1.noarch.rpm
- Now I need to figure out what
check
should test this, in this casetest_zip.py
- For the testing I will have to devise a small function that validates my expectations:
@pytest.mark.parametrize('package', ['binary/texlive-codepage-doc'])
def test_zip2(tmpdir, package, zipcheck):
output, test = zipcheck
test.check(get_tested_package(package, tmpdir))
out = output.print_results(output.results)
assert 'W: unable-to-read-zip' in out
As you can see it is not so hard and with each added test we get better coverage on what is really expected from rpmlint and avoid naughty regressions in a long run.
Configuration
If you want to change configuration options or the list of checks you can use following locations:
/etc/rpmlint/*config
$XDG_CONFIG_HOME/rpmlint/*config
Configuration itself is a toml file where for some basic inspiration
you can check up rpmlint/configdefaults.toml
which specifies format/defaults.
Additional option to control rpmlint behaviour is addition of rpmlintrc file which uses old syntax for compatibility with old rpmlint releases, yet it can be normal toml file if you wish:
setBadness('check', 0)
addFilter('test-i-ignore')