2018-07-13 18:47:00 +08:00
|
|
|
# rpmlint
|
2015-10-03 17:50:39 +08:00
|
|
|
|
2018-07-13 18:47:00 +08:00
|
|
|
[](https://travis-ci.org/rpm-software-management/rpmlint)
|
2019-07-11 22:10:36 +08:00
|
|
|
[](https://lgtm.com/projects/g/rpm-software-management/rpmlint/alerts/)
|
|
|
|
|
[](https://lgtm.com/projects/g/rpm-software-management/rpmlint/context:python)
|
2019-07-15 18:25:38 +08:00
|
|
|
[](https://coveralls.io/github/rpm-software-management/rpmlint?branch=master)
|
2018-07-13 18:47:00 +08:00
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
2019-07-13 04:03:30 +08:00
|
|
|
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.
|
2015-10-03 17:50:39 +08:00
|
|
|
|
|
|
|
|
The idea for rpmlint is from the lintian tool of the Debian project.
|
2019-07-26 20:41:38 +08:00
|
|
|
All the checks reside in rpmlint/checks folder. Feel free to provide new
|
2018-07-13 18:47:00 +08:00
|
|
|
checks and suggestions at:
|
2015-10-03 17:50:39 +08:00
|
|
|
|
|
|
|
|
https://github.com/rpm-software-management/rpmlint
|
|
|
|
|
|
2019-07-15 19:52:30 +08:00
|
|
|
## 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
|
2019-07-13 04:03:30 +08:00
|
|
|
|
|
|
|
|
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.
|
|
|
|
|
|
2019-07-15 19:52:30 +08:00
|
|
|
Ie. if you want to test on latest openSUSE you can test using following commands:
|
2019-07-13 04:03:30 +08:00
|
|
|
|
|
|
|
|
`docker build -t opensusetw -f test/Dockerfile-opensusetw .`
|
2019-07-15 19:52:30 +08:00
|
|
|
|
2019-07-13 04:03:30 +08:00
|
|
|
`docker run -v $(pwd):/usr/src/rpmlint/ opensusetw python3 setup.py test`
|
|
|
|
|
|
2019-07-15 19:52:30 +08:00
|
|
|
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`
|
|
|
|
|
|
2019-07-26 20:32:58 +08:00
|
|
|
Or even pick one of the tests using pytest:
|
|
|
|
|
|
|
|
|
|
`python3 -m pytest test/test_config.py`
|
|
|
|
|
|
2019-07-26 20:57:33 +08:00
|
|
|
## 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:
|
|
|
|
|
|
|
|
|
|
1) I have rpmfile that should report unreadable zip file
|
|
|
|
|
2) I store this file in git under `test/binary/texlive-codepage-doc-2018.151.svn21126-38.1.noarch.rpm`
|
|
|
|
|
3) Now I need to figure out what `check` should test this, in this case `test_zip.py`
|
|
|
|
|
4) 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.
|
|
|
|
|
|
2018-07-13 18:47:00 +08:00
|
|
|
## Configuration
|
|
|
|
|
|
|
|
|
|
If you want to change configuration options or the list of checks you can
|
|
|
|
|
use following locations:
|
|
|
|
|
|
2019-08-02 21:15:59 +08:00
|
|
|
`/etc/xdg/rpmlint/*config`
|
2018-07-13 18:47:00 +08:00
|
|
|
|
2018-08-08 23:48:07 +08:00
|
|
|
`$XDG_CONFIG_HOME/rpmlint/*config`
|
2018-07-13 18:47:00 +08:00
|
|
|
|
2019-07-29 18:04:43 +08:00
|
|
|
Configuration itself is a toml file where for some basic inspiration
|
2019-07-15 20:44:02 +08:00
|
|
|
you can check up `rpmlint/configdefaults.toml` which specifies format/defaults.
|
2015-10-03 17:50:39 +08:00
|
|
|
|
2018-08-08 23:48:07 +08:00
|
|
|
Additional option to control rpmlint behaviour is addition of rpmlintrc file
|
|
|
|
|
which uses old syntax for compatibility with old rpmlint releases, yet
|
2019-07-26 20:31:48 +08:00
|
|
|
it can be normal toml file if you wish:
|
2015-10-03 17:50:39 +08:00
|
|
|
|
2018-08-08 23:48:07 +08:00
|
|
|
`setBadness('check', 0)`
|
2015-10-03 17:50:39 +08:00
|
|
|
|
2018-08-08 23:48:07 +08:00
|
|
|
`addFilter('test-i-ignore')`
|
