Differential D1008

task-rpmdeplint
ClosedPublic
Actions

Authored by mkrizek on Sep 21 2016, 12:28 PM.

Details

Reviewers
kparal
tflink
jskladan
Maniphest Tasks
T878: replace depcheck with rpmdeplint
Summary

This runs rpmdeplint check-sat and should replace the current depcheck task. It would be good to have someone who understands depcheck to look at it. :)

I am not saying that the current state is production ready but should be good enough to have it running on dev to see how it compares to depcheck.

One potential blocker for running it in prod though is that the rpmdeplint package is not in Fedora. The package is available in copr, so we can add that repo to minion repos in libtaskotron for the time being.

Code for scenarios, squashing results and unittests is reused from the original depcheck.

Test Plan

Info on how to set up dev env, run the task via libtaskotron and how to run functional tests is in README. It passes the original depcheck scenarios.

Diff Detail

Lint
Lint Skipped
Unit
Unit Tests Skipped
mkrizek retitled this revision from to task-rpmdeplint.Sep 21 2016, 12:28 PM
mkrizek updated this object.
mkrizek edited the test plan for this revision. (Show Details)
mkrizek added reviewers: tflink, jskladan, kparal.
mkrizek updated this object.
mkrizek updated this revision to Diff 2577.Sep 21 2016, 1:15 PM
dcallagh added a subscriber: dcallagh.Sep 27 2016, 12:20 AM

I didn't realise that Fedora QA were already working on rpmdeplint integration into taskotron, this is great to see! :-)

I am definitely planning to post a Fedora package review for rpmdeplint eventually, so that you don't need to keep using my random COPR repo. We were just waiting for rpmdeplint 1.0 to stabilise a bit first.

In the meantime we have also released 1.1 which added a bunch more checks, which you would probably be interested in adding here too? But just check-sat on its own is a good starting point.

Is there anything we can do on the rpmdeplint side to make it easier to use, like better Python APIs? Suggestions are totally welcome.

dcallagh added a comment.Oct 17 2016, 3:51 AM

FYI I have filed a package review for rpmdeplint: https://bugzilla.redhat.com/show_bug.cgi?id=1385441

romanofski added a subscriber: romanofski.Nov 21 2016, 12:47 AM

Hi! Just wanted to check in and ask if you need a helping hand or have any questions with this item. The filed package review is finished and rpmdeplint is now available as a Fedora package as well.
Cheers!

jskladan accepted this revision.Dec 12 2016, 5:50 AM

Looks good apart of the nitpicks. But it is depcheck, so who am I to understand what's going on :D

tests/functest_scenarios.py
25

I'd rather see for root, dirs, files in dircontents instead.

28–29

Why are the known_broken tests skipped? It's been a long time, and I don't really remember what those meant, but looking at the scenarios, these seem to be usefull...

This revision is now accepted and ready to land.Dec 12 2016, 5:50 AM
kparal accepted this revision.Jan 12 2017, 3:04 PM

This looks awesome (except for the undocumented API, sigh). It almost renewed my willingness to work on "depcheck" (since all the heavy lifting will be done by rpmdeplint) :-) I'd like to have it deployed on dev asap, probably as dist.rpmdeplint, in parallel to the existing depcheck, so that we can compare the results.

.arcconfig
3

Needs to change now, obviously :-)

README.rst
4

Not needed anymore.

5

python2-rpmdeplint

runtask.yml
8

This needs to be (probably changed to) python2-rpmdeplint.

tests/functest_scenarios.py
28–29

The directory is basically a wishlist "we'd like to cover these cases but don't at the moment". So those scenarios were never run, if you wonder about that. However, by looking at rpmdeplint documentation, it seems it should be able to detect those cases (if we use check-repoclosure command). So hopefully we can enable these in the future.

34

Please change this to

return sorted(yamlfiles, key=lambda yamlfile: yamlfile[1])

That will make the test suite run in a deterministic order. Thanks.

tests/scenarios/scenarios/fail/01_version.yaml
6–16

I found out this is actually slightly incorrect, it should be:

current_repo:
  -
    envra: foo-0.1-1.fc19.noarch
  -
    envra: bar-0.1-1.fc19.noarch
    requires: foo == 0.1-1.fc19

update_repo:
  -
    envra: bar-0.2-1.fc19.noarch
    requires: foo == 0.2-1.fc19

Revision Contents

Path
AM.arcconfig (6 lines)
AM.gitignore (4 lines)
AMLICENSE (86 lines)
AMREADME.rst (22 lines)
AMpytest.ini (4 lines)
AMrun_rpmdeplint.py (44 lines)
AMruntask.yml (90 lines)
AMtests/__init__.py
AMtests/conftest.py (53 lines)
AMtests/functest_scenarios.py (71 lines)
AMtests/scenarios/README.md (69 lines)
AMtests/scenarios/__init__.py
AMtests/scenarios/scenarios/fail/01_version.yaml (16 lines)
AMtests/scenarios/scenarios/fail/02_multilib.yaml (15 lines)
AMtests/scenarios/scenarios/fail/03_package_requires.yaml (13 lines)
AMtests/scenarios/scenarios/fail/04_file_requires.yaml (13 lines)
AMtests/scenarios/scenarios/known_broken/05_removing_provides.yaml (18 lines)
AMtests/scenarios/scenarios/known_broken/06_removing_subpackage.yaml (15 lines)
AMtests/scenarios/scenarios/pass/01_simple.yaml (13 lines)
AMtests/scenarios/scenarios/pass/02_conflicts_1.yaml (15 lines)
AMtests/scenarios/scenarios/pass/03_conflicts_2.yaml (14 lines)
AMtests/scenarios/scenarios/pass/04_conflicts_3.yaml (14 lines)
AMtests/scenarios/scenarios/pass/05_strange_conflict.yaml (22 lines)
AMtests/scenarios/scenarios/pass/06_multilib.yaml (16 lines)
AMtests/scenarios/scenarios/pass/07_codependencies.yaml (32 lines)
AMtests/scenarios/scenarios/pass/08_recommends_present.yaml (13 lines)
AMtests/scenarios/scenarios/pass/09_recommends_not_present.yaml (13 lines)
AMtests/scenarios/scenarios/pass/10_suggests_present.yaml (13 lines)
AMtests/scenarios/scenarios/pass/11_suggests_not_present.yaml (13 lines)
AMtests/scenarios/scenarios/pass/12_supplements_present.yaml (13 lines)
AMtests/scenarios/scenarios/pass/13_supplements_not_present.yaml (13 lines)
AMtests/scenarios/yaml_to_repos.py (200 lines)
AMtests/test_squash_results.py (227 lines)
AMutils/__init__.py (46 lines)
AMutils/squash_results.py (196 lines)

Diff 2577

View Options

.arcconfig

  • This file was added.
1​{
2​ "project_id" : "task-rpmdeplint",
3​ "conduit_uri" : "https://phab.qadevel.cloud.fedoraproject.org",
kparalUnsubmitted
Not Done

Needs to change now, obviously :-)

4​ "arc.land.onto.default" : "master",
5​ "arc.feature.start.default" : "master"
6​}
View Options

.gitignore

  • This file was added.
1​*.py[co]
2​.*.swp
3​/env/
4​.cache/
View Options

LICENSE

  • This file was added.
1​GNU GENERAL PUBLIC LICENSE
2​
3​Version 2, June 1991
4​
5​Copyright (C) 1989, 1991 Free Software Foundation, Inc.
6​51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
7​
8​Everyone is permitted to copy and distribute verbatim copies
9​of this license document, but changing it is not allowed.
10​
11​Preamble
12​
13​The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Lesser General Public License instead.) You can apply it to your programs, too.
14​
15​When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.
16​
17​To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.
18​
19​For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
20​
21​We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.
22​
23​Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.
24​
25​Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.
26​
27​The precise terms and conditions for copying, distribution and modification follow.
28​TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
29​
30​0. This License applies to any program or other work which contains a notice placed by the copyright holder saying it may be distributed under the terms of this General Public License. The "Program", below, refers to any such program or work, and a "work based on the Program" means either the Program or any derivative work under copyright law: that is to say, a work containing the Program or a portion of it, either verbatim or with modifications and/or translated into another language. (Hereinafter, translation is included without limitation in the term "modification".) Each licensee is addressed as "you".
31​
32​Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.
33​
34​1. You may copy and distribute verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice and disclaimer of warranty; keep intact all the notices that refer to this License and to the absence of any warranty; and give any other recipients of the Program a copy of this License along with the Program.
35​
36​You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.
37​
38​2. You may modify your copy or copies of the Program or any portion of it, thus forming a work based on the Program, and copy and distribute such modifications or work under the terms of Section 1 above, provided that you also meet all of these conditions:
39​
40​ a) You must cause the modified files to carry prominent notices stating that you changed the files and the date of any change.
41​ b) You must cause any work that you distribute or publish, that in whole or in part contains or is derived from the Program or any part thereof, to be licensed as a whole at no charge to all third parties under the terms of this License.
42​ c) If the modified program normally reads commands interactively when run, you must cause it, when started running for such interactive use in the most ordinary way, to print or display an announcement including an appropriate copyright notice and a notice that there is no warranty (or else, saying that you provide a warranty) and that users may redistribute the program under these conditions, and telling the user how to view a copy of this License. (Exception: if the Program itself is interactive but does not normally print such an announcement, your work based on the Program is not required to print an announcement.)
43​
44​These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
45​
46​Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.
47​
48​In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
49​
50​3. You may copy and distribute the Program (or a work based on it, under Section 2) in object code or executable form under the terms of Sections 1 and 2 above provided that you also do one of the following:
51​
52​ a) Accompany it with the complete corresponding machine-readable source code, which must be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
53​ b) Accompany it with a written offer, valid for at least three years, to give any third party, for a charge no more than your cost of physically performing source distribution, a complete machine-readable copy of the corresponding source code, to be distributed under the terms of Sections 1 and 2 above on a medium customarily used for software interchange; or,
54​ c) Accompany it with the information you received as to the offer to distribute corresponding source code. (This alternative is allowed only for noncommercial distribution and only if you received the program in object code or executable form with such an offer, in accord with Subsection b above.)
55​
56​The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.
57​
58​If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.
59​
60​4. You may not copy, modify, sublicense, or distribute the Program except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense or distribute the Program is void, and will automatically terminate your rights under this License. However, parties who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.
61​
62​5. You are not required to accept this License, since you have not signed it. However, nothing else grants you permission to modify or distribute the Program or its derivative works. These actions are prohibited by law if you do not accept this License. Therefore, by modifying or distributing the Program (or any work based on the Program), you indicate your acceptance of this License to do so, and all its terms and conditions for copying, distributing or modifying the Program or works based on it.
63​
64​6. Each time you redistribute the Program (or any work based on the Program), the recipient automatically receives a license from the original licensor to copy, distribute or modify the Program subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License.
65​
66​7. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot distribute so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may not distribute the Program at all. For example, if a patent license would not permit royalty-free redistribution of the Program by all those who receive copies directly or indirectly through you, then the only way you could satisfy both it and this License would be to refrain entirely from distribution of the Program.
67​
68​If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.
69​
70​It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.
71​
72​This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
73​
74​8. If the distribution and/or use of the Program is restricted in certain countries either by patents or by copyrighted interfaces, the original copyright holder who places the Program under this License may add an explicit geographical distribution limitation excluding those countries, so that distribution is permitted only in or among countries not thus excluded. In such case, this License incorporates the limitation as if written in the body of this License.
75​
76​9. The Free Software Foundation may publish revised and/or new versions of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns.
77​
78​Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.
79​
80​10. If you wish to incorporate parts of the Program into other free programs whose distribution conditions are different, write to the author to ask for permission. For software which is copyrighted by the Free Software Foundation, write to the Free Software Foundation; we sometimes make exceptions for this. Our decision will be guided by the two goals of preserving the free status of all derivatives of our free software and of promoting the sharing and reuse of software generally.
81​
82​NO WARRANTY
83​
84​11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
85​
86​12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
View Options

README.rst

  • This file was added.
1​Setting Up Development Environment
2​----------------------------------
3​::
4​ dnf copr enable dcallagh/rpmdeplint
kparalUnsubmitted
Not Done

Not needed anymore.

5​ dnf install rpmdeplint python-virtualenv
kparalUnsubmitted
Not Done

python2-rpmdeplint

6​ virtualenv --system-site-packages env
7​ source env/bin/activate
8​ pip install -e /path/to/libtaskotron/checkout
9​
10​
11​Running the task through libtaskotron
12​-------------------------------------
13​::
14​ runtask -i f24-updates-testing-pending -t koji_tag runtask.yml
15​
16​Running Functional Test Suite
17​-----------------------------
18​::
19​ pip install pytest dingus progressbar
20​ py.test --functional tests/
21​
22​Read ``tests/scenarios/README.md`` for more details.
View Options

pytest.ini

  • This file was added.
1​[pytest]
2​minversion = 2.0
3​python_functions=test should
4​python_files=test_* functest_*
View Options

run_rpmdeplint.py

  • This file was added.
PropertyOld ValueNew Value
File Modenull100755
1​#!/usr/bin/env python
2​
3​import os
4​import sys
5​from rpmdeplint.repodata import Repo
6​
7​sys.path.insert(0, os.path.realpath(os.path.dirname(__file__)))
8​from utils import squash_results
9​from utils import log
10​from utils import check_sat
11​
12​
13​def run(rpms_dir, repos, arch, report_format='builds', artifactsdir='.'):
14​ '''Run rpmdeplint check-sat on the given RPM packages in `rpms_dir`
15​ against the given `repos` repositories.
16​
17​ @param list rpms_dir list of rpm files and/or directories containing rpm files
18​ @param dict repos dictionary or list of dictionaries in format: {'name': {'arch': 'url'}}
19​ @param str arch arch of the packages in the repo
20​ @param str report_format 'builds', 'updates' or a string containing both
21​ @param str artifactsdir directory to store the artifacts in
22​ '''
23​
24​ repositories = {}
25​
26​ if isinstance(repos, list):
27​ for repo in repos:
28​ for name, val in repo.iteritems():
29​ while name in repositories:
30​ name += "_"
31​ repositories[name] = val
32​ elif isinstance(repos, dict):
33​ repositories = repos
34​ else:
35​ raise Exception("Repos should be in the following format {'name': {'arch': 'url'}}")
36​
37​ Repos = [Repo(name, val[arch]) for name, val in repositories.iteritems()]
38​
39​ results = check_sat(rpms_dir, Repos)
40​
41​ output = squash_results.format_output(results, arch, report_format, artifactsdir)
42​ log.info(output)
43​
44​ return output
View Options

runtask.yml

  • This file was added.
1​name: rpmdeplint
2​namespace: dist
3​desc: "Checks for unmet dependencies with the given RPM packages against the given repositories."
4​maintainer: mkrizek
5​
6​environment:
7​ rpm:
8​ - rpmdeplint
kparalUnsubmitted
Not Done

This needs to be (probably changed to) python2-rpmdeplint.

9​
10​input:
11​ args:
12​ - koji_tag
13​
14​actions:
15​ # === i386
16​ - name: download koji tag
17​ koji:
18​ action: download_tag
19​ koji_tag: ${koji_tag}
20​ arch: ['i386']
21​ target_dir: "${workdir}/downloaded_tag/"
22​
23​ - name: mash downloaded rpms
24​ mash:
25​ rpmdir: "${workdir}/downloaded_tag/"
26​ dodelta: "false"
27​ arch: ['i386']
28​
29​ - name: get yum repos
30​ yumrepoinfo:
31​ koji_tag: ${koji_tag}
32​ arch: ['i386']
33​ export: yumrepos_i386
34​
35​ - name: run rpmdeplint
36​ python:
37​ file: run_rpmdeplint.py
38​ callable: run
39​ rpms_dir: "${workdir}/downloaded_tag/"
40​ arch: i386
41​ artifactsdir: "${artifactsdir}"
42​ report_format: "builds+updates"
43​ repos:
44​ - ${yumrepos_i386}
45​ - "workdir_repo": {"i386": "${workdir}/downloaded_tag/"}
46​ export: output_i386
47​
48​ # === x86_64
49​ - name: download koji tag
50​ koji:
51​ action: download_tag
52​ koji_tag: ${koji_tag}
53​ arch: ['x86_64']
54​ target_dir: "${workdir}/downloaded_tag/"
55​
56​ - name: mash downloaded rpms
57​ mash:
58​ rpmdir: "${workdir}/downloaded_tag/"
59​ dodelta: "false"
60​ arch: ['x86_64']
61​
62​ - name: get yum repos
63​ yumrepoinfo:
64​ koji_tag: ${koji_tag}
65​ arch: ['x86_64']
66​ export: yumrepos_x86_64
67​
68​ - name: run rpmdeplint
69​ python:
70​ file: run_rpmdeplint.py
71​ callable: run
72​ rpms_dir: "${workdir}/downloaded_tag/"
73​ arch: x86_64
74​ artifactsdir: "${artifactsdir}"
75​ report_format: "builds+updates"
76​ repos:
77​ - ${yumrepos_x86_64}
78​ - "workdir_repo": {"x86_64": "${workdir}/downloaded_tag/"}
79​ export: output_x86_64
80​
81​ # === report results
82​ - name: report i386 results to resultsdb
83​ resultsdb:
84​ results: ${output_i386}
85​ export: output_i386
86​
87​ - name: report x86_64 results to resultsdb
88​ resultsdb:
89​ results: ${output_x86_64}
90​ export: output_x86_64
View Options

tests/__init__.py

  • This file was added.
This is an empty file.
View Options

tests/conftest.py

  • This file was added.
1​#
2​# conftest.py - utils for py.test
3​#
4​# Copyright 2011, Red Hat, Inc.
5​#
6​# This program is free software; you can redistribute it and/or modify
7​# it under the terms of the GNU General Public License as published by
8​# the Free Software Foundation; either version 2 of the License, or
9​# (at your option) any later version.
10​#
11​# This program is distributed in the hope that it will be useful,
12​# but WITHOUT ANY WARRANTY; without even the implied warranty of
13​# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14​# GNU General Public License for more details.
15​#
16​# You should have received a copy of the GNU General Public License along
17​# with this program; if not, write to the Free Software Foundation, Inc.,
18​# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19​#
20​# Author: Tim Flink <tflink@redhat.com>
21​
22​import pytest
23​import re
24​
25​
26​def pytest_addoption(parser):
27​ """
28​ Add an option to the py.test parser to detect when the functional tests
29​ should be detected and run
30​ """
31​
32​ parser.addoption('--functional', action='store_true', default=False,
33​ help='Add functional tests')
34​
35​
36​def pytest_ignore_collect(path, config):
37​ """Prevents collection of any files named functest* to speed up non
38​ integration tests"""
39​ if path.fnmatch('*functest*'):
40​ try:
41​ is_functional = config.getvalue('functional')
42​ except KeyError:
43​ return True
44​
45​ return not is_functional
46​
47​
48​def pytest_configure(config):
49​ """This is a bit of a hack to detect whether or not we are running inside
50​ a test environment"""
51​ import sys
52​
53​ sys._called_from_test = True
View Options

tests/functest_scenarios.py

  • This file was added.
1​import os
2​import pytest
3​import yaml
4​import pprint
5​
6​from .scenarios import yaml_to_repos
7​
8​from rpmdeplint.repodata import Repo
9​
10​from utils import PASS, FAIL, check_sat
11​
12​
13​def get_scenarios():
14​ """assuming that the scenarios repo is checked out in the tests/
15​ directory, scan the directory structure for scenarios that should pass or
16​ fail.
17​
18​ :returns: list of tuples of the form (should_pass, path_to_scenario_yaml)
19​ """
20​ yamlfiles = []
21​ for scenario_type in ['pass', 'fail']:
22​ scenario_path = os.path.join(os.path.dirname(__file__),
23​ 'scenarios/scenarios/%s' % scenario_type)
24​ dircontents = os.walk(scenario_path)
25​ for dircontent in dircontents:
jskladanUnsubmitted
Not Done

I'd rather see for root, dirs, files in dircontents instead.

26​ if len(dircontent[2]) == 0:
27​ continue
28​ if dircontent[1] == 'known_broken':
29​ continue
jskladanUnsubmitted
Not Done

Why are the known_broken tests skipped? It's been a long time, and I don't really remember what those meant, but looking at the scenarios, these seem to be usefull...

kparalUnsubmitted
Not Done

The directory is basically a wishlist "we'd like to cover these cases but don't at the moment". So those scenarios were never run, if you wonder about that. However, by looking at rpmdeplint documentation, it seems it should be able to detect those cases (if we use check-repoclosure command). So hopefully we can enable these in the future.

30​ for infile in dircontent[2]:
31​ filename = '%s/%s' % (dircontent[0], infile)
32​ if infile.split('.')[-1] in ['yml', 'yaml']:
33​ yamlfiles.append((scenario_type == 'pass', filename))
34​ return yamlfiles
kparalUnsubmitted
Not Done

Please change this to

return sorted(yamlfiles, key=lambda yamlfile: yamlfile[1])

That will make the test suite run in a deterministic order. Thanks.

35​
36​
37​@pytest.fixture(params=get_scenarios())
38​def scenario(request):
39​ return request.param
40​
41​
42​def is_output_pass(output):
43​ result = True
44​ for key, value in output.items():
45​ result = result and (value['result'] == PASS)
46​ return result
47​
48​def read_yamldata(filename):
49​ with open(filename, 'r') as filedata:
50​ return yaml.load(filedata)
51​
52​
53​def test_scenarios(scenario, tmpdir, monkeypatch):
54​ # decode the input tuple for readability
55​ scenario_pass = scenario[0]
56​ scenario_path = scenario[1]
57​ print scenario_pass
58​ print "\n### Running scenario %s" % scenario_path
59​
60​ # convert the yaml scenario to fake rpms and repos
61​ scenario_data = read_yamldata(scenario_path)
62​ current_repo, update_repo, dummy = \
63​ yaml_to_repos.create_repos(scenario_data, outdir=str(tmpdir))
64​
65​ repos = [Repo('current', str(current_repo)), Repo('update', str(update_repo))]
66​
67​ results = check_sat(str(update_repo), repos)
68​
69​ pprint.pprint(results)
70​
71​ assert is_output_pass(results) is scenario_pass
View Options

tests/scenarios/README.md

  • This file was added.
1​# Test Suite
2​
3​Scripts that generate repositories for testing.
4​
5​These repos contain specially crafted RPMs, which's combinations should either PASS or FAIL.
6​
7​# Running the code
8​
9​## Running from command line
10​
11​In order to initiate the script from command line run the command `yaml_to_repos.py $YAML_FILE [$OUTPUT_DIR]`.
12​
13​The `$YAML_FILE` is a path to the YAML description file (see below), the `$OUTPUT_DIR` specifies the parent directory
14​in which the repos will be created. If the `$OUTPUT_DIR` is not set, temporary directory is created automatically.
15​
16​## Running programatically
17​
18​After importing `yaml_to_repos.py`, run `yaml_to_repos.create_repos($YAML_DATA, [$OUTPUT_DIR])`. The only difference here is,
19​that you need to pass the parsed yaml file as the first argument, not just a file name.
20​
21​You can use this snippet to parse a yaml file:
22​
23​```
24​import yaml
25​data = yaml.load(open('my_yaml_file.yaml'))
26​```
27​
28​# Creating YAML description files
29​
30​First of all, you need to create a file describing the 'testcase', the file might look like this:
31​
32​```
33​name: Simple happy path
34​description:
35​ This is a simple case in which an update does not cause problems
36​expected_outcome: pass
37​
38​current_repo:
39​ -
40​ envra: foo-0.1-1.fc19.noarch
41​ -
42​ envra: moo-0.2-3.fc19.noarch
43​
44​update_repo:
45​ -
46​ envra: bar-0.1-1.fc19.noarch
47​ requires: foo
48​```
49​
50​`name`, `description`, and `expected_outcome` are metadata for the 'testsuite', and are of no significance for the repo creation.
51​
52​`current_repo`, and `update_repo` are YAML lists of package descriptions. The `current_repo` describes the state of the 'stable' repository,
53​and the `update_repo` the available update.
54​
55​Each package is represented by `envra`. To describe dependencies, you can add `requires`, `provides`, `conflicts`, and `obsoletes`.
56​Thus creating descriptions like these:
57​```
58​...
59​
60​ -
61​ envra: foo-0.1-1.fc19.noarch
62​ requires: libbar.so
63​ -
64​ envra: bar-0.1-1.fc19.noarch
65​ provides: libbar.so
66​ conflicts: moo
67​
68​...
69​```
View Options

tests/scenarios/__init__.py

  • This file was added.
This is an empty file.
View Options

tests/scenarios/scenarios/fail/01_version.yaml

  • This file was added.
1​name: Simple version conflict
2​description:
3​ Unfulfilled version requirements
4​expected_outcome: fail
5​
6​current_repo:
7​ -
8​ envra: foo-0.1-1.fc19.noarch
9​ -
10​ envra: bar-0.1-1.fc19.noarch
11​ requires: foo == 0.1-1
12​
13​update_repo:
14​ -
15​ envra: bar-0.2-1.fc19.noarch
16​ requires: foo == 0.2-1
kparalUnsubmitted
Not Done

I found out this is actually slightly incorrect, it should be:

current_repo:
  -
    envra: foo-0.1-1.fc19.noarch
  -
    envra: bar-0.1-1.fc19.noarch
    requires: foo == 0.1-1.fc19

update_repo:
  -
    envra: bar-0.2-1.fc19.noarch
    requires: foo == 0.2-1.fc19
View Options

tests/scenarios/scenarios/fail/02_multilib.yaml

  • This file was added.
1​name: Basic Multilib Fail
2​description:
3​ Missing update for one of the arches.
4​expected_outcome: fail
5​
6​current_repo:
7​ -
8​ envra: foo-0.1-1.fc19.i386
9​ -
10​ envra: foo-0.1-1.fc19.x86_64
11​
12​update_repo:
13​ -
14​ envra: bar-0.2-1.fc19.x86_64
15​ requires: foo == 0.2-1.x86_64
View Options

tests/scenarios/scenarios/fail/03_package_requires.yaml

  • This file was added.
1​name: Missing Package Requires
2​description:
3​ Updated package requires another package, which is not available.
4​expected_outcome: fail
5​
6​current_repo:
7​ -
8​ envra: foo-0.1-1.fc19.i386
9​
10​update_repo:
11​ -
12​ envra: foo-0.2-1.fc19.x86_64
13​ requires: bar
View Options

tests/scenarios/scenarios/fail/04_file_requires.yaml

  • This file was added.
1​name: Missing File Requires
2​description:
3​ Updated package requires a file, which is not provided by any package.
4​expected_outcome: fail
5​
6​current_repo:
7​ -
8​ envra: foo-0.1-1.fc19.i386
9​
10​update_repo:
11​ -
12​ envra: foo-0.2-1.fc19.x86_64
13​ requires: libbar.so
View Options

tests/scenarios/scenarios/known_broken/05_removing_provides.yaml

  • This file was added.
1​name: Removing Provides
2​description:
3​ Existing package requires something which an update removes while the requiring package is not updated
4​expected_outcome: fail
5​
6​current_repo:
7​ -
8​ envra: foo-0.1-1.fc19.x86_64
9​ provides: cannedunicorn
10​
11​ -
12​ envra: bar-0.1-1.fc19.x86_64
13​ requires: cannedunicorn
14​
15​update_repo:
16​ -
17​ envra: foo-0.2-1.fc19.x86_64
18​ obsoletes: foo-0.1-1.fc19.x86_64
View Options

tests/scenarios/scenarios/known_broken/06_removing_subpackage.yaml

  • This file was added.
1​name: Broken dep for an existing package
2​description:
3​ Library got updated but the dependant app didn't
4​expected_outcome: fail
5​
6​current_repo:
7​ - envra: mojito-1.0-1.fc19.noarch
8​ requires: libmint = 1.0
9​
10​ - envra: libmint-1.0-1.fc19.noarch
11​ provides: libmint = 1.0
12​
13​update_repo:
14​ - envra: libmint-2.0-1.fc19.noarch
15​ provides: libmint = 2.0
View Options

tests/scenarios/scenarios/pass/01_simple.yaml

  • This file was added.
1​name: Simple happy path
2​description:
3​ This is a simple case in which an update does not cause problems
4​expected_outcome: pass
5​
6​current_repo:
7​ -
8​ envra: foo-0.1-1.fc19.noarch
9​
10​update_repo:
11​ -
12​ envra: bar-0.1-1.fc19.noarch
13​ requires: foo
View Options

tests/scenarios/scenarios/pass/02_conflicts_1.yaml

  • This file was added.
1​name: Conflicts 1
2​description:
3​ When two packages conflict, they aren't supposed to be installed together
4​ but this does not constitute a depsolving error.
5​expected_outcome: pass
6​
7​current_repo:
8​ -
9​ envra: foo-0.1-1.fc19.noarch
10​ conflicts: bar
11​
12​update_repo:
13​ -
14​ envra: bar-0.1-1.fc19.noarch
15​ conflicts: foo
View Options

tests/scenarios/scenarios/pass/03_conflicts_2.yaml

  • This file was added.
1​name: Conflicts 2
2​description:
3​ When two packages conflict, they aren't supposed to be installed together
4​ but this does not constitute a depsolving error.
5​expected_outcome: pass
6​
7​current_repo:
8​ -
9​ envra: foo-0.1-1.fc19.noarch
10​ conflicts: bar
11​
12​update_repo:
13​ -
14​ envra: bar-0.1-1.fc19.noarch
View Options

tests/scenarios/scenarios/pass/04_conflicts_3.yaml

  • This file was added.
1​name: Conflicts 4
2​description:
3​ When two packages conflict, they aren't supposed to be installed together
4​ but this does not constitute a depsolving error.
5​expected_outcome: pass
6​
7​current_repo:
8​ -
9​ envra: foo-0.1-1.fc19.noarch
10​
11​update_repo:
12​ -
13​ envra: bar-0.1-1.fc19.noarch
14​ conflicts: foo
View Options

tests/scenarios/scenarios/pass/05_strange_conflict.yaml

  • This file was added.
1​# TODO: Check for the correct "conflicts" syntax
2​name: Strange Conflict
3​description:
4​ This is a bit of a corner case that we've hit before where one arch's
5​ package conflicts with a subpackage of another arch. This shouldn't
6​ fail because you can't actually install them at the same time.
7​
8​ See https://fedorahosted.org/autoqa/ticket/328
9​expected_outcome: pass
10​
11​current_repo:
12​ -
13​ envra: foo-0.1-1.fc19.x86_64
14​ conflicts: foo-extras(x86-32)
15​
16​update_repo:
17​ -
18​ envra: foo-0.1-1.fc19.i386
19​ -
20​ envra: foo-extras-0.1-1.fc19.x86_64
21​ -
22​ envra: foo-extras-0.1-1.fc19.i386
View Options

tests/scenarios/scenarios/pass/06_multilib.yaml

  • This file was added.
1​name: Happy Path Multilib
2​description:
3​ This is a normal multilib update.
4​expected_outcome: pass
5​
6​current_repo:
7​ -
8​ envra: foo-0.1-1.fc19.x86_64
9​ -
10​ envra: foo-0.1-1.fc19.i386
11​
12​update_repo:
13​ -
14​ envra: foo-0.2-1.fc19.x86_64
15​ -
16​ envra: foo-0.2-1.fc19.i386
View Options

tests/scenarios/scenarios/pass/07_codependencies.yaml

  • This file was added.
1​name: Happy Path Codependencies
2​description:
3​ This is a normal update where the rpms in an update depend on eachother's provides
4​expected_outcome: pass
5​
6​current_repo:
7​
8​ -
9​ envra: kernel-tools-3.17.1-302.fc21.x86_64
10​
11​ -
12​ envra: kernel-tools-libs-3.17.1-302.fc21.x86_64
13​
14​ -
15​ envra: kernel-tools-libs-devel-3.17.1-302.fc21.x86_64
16​ requires:
17​ - kernel-tools = 3.17.1-302.fc21
18​ - kernel-tools-libs = 3.17.1-302.fc21
19​
20​update_repo:
21​
22​ -
23​ envra: kernel-tools-libs-devel-3.17.1-303.fc21.x86_64
24​ requires:
25​ - kernel-tools = 3.17.1-303.fc21
26​ - kernel-tools-libs = 3.17.1-303.fc21
27​
28​ -
29​ envra: kernel-tools-3.17.1-303.fc21.x86_64
30​
31​ -
32​ envra: kernel-tools-libs-3.17.1-303.fc21.x86_64
View Options

tests/scenarios/scenarios/pass/08_recommends_present.yaml

  • This file was added.
1​name: weak dependency recommends
2​description:
3​ This is a simple case in which the rpm recommends foo as a dep
4​expected_outcome: pass
5​
6​current_repo:
7​ -
8​ envra: foo-0.1-1.fc19.noarch
9​
10​update_repo:
11​ -
12​ envra: bar-0.1-1.fc19.noarch
13​ recommends: foo
View Options

tests/scenarios/scenarios/pass/09_recommends_not_present.yaml

Loading...
View Options

tests/scenarios/scenarios/pass/10_suggests_present.yaml

Loading...
View Options

tests/scenarios/scenarios/pass/11_suggests_not_present.yaml

Loading...
View Options

tests/scenarios/scenarios/pass/12_supplements_present.yaml

Loading...
View Options

tests/scenarios/scenarios/pass/13_supplements_not_present.yaml

Loading...
View Options

tests/scenarios/yaml_to_repos.py

Loading...
View Options

tests/test_squash_results.py

Loading...
View Options

utils/__init__.py

Loading...
View Options

utils/squash_results.py

Loading...