Metadata-Version: 2.1
Name: taskotron-python-versions
Version: 0.1.dev6
Summary: Taskotron checks regarding Python versions
Home-page: https://github.com/fedora-python/taskotron-python-versions
Author: Miro Hrončok, Iryna Shcherbina, Michal Cyprian
Author-email: mhroncok@redhat.com, ishcherb@redhat.com, mcyprian@redhat.com
License: Public Domain
Keywords: taskotron fedora python rpm
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Testing
Requires-Dist: libarchive-c
Requires-Dist: python-bugzilla

`Taskotron <https://fedoraproject.org/wiki/Taskotron>`__ task regarding Python versions
=======================================================================================

This represents the automatic checks happening in the Fedora
infrastructure after any package is built.

Currently the following checks are available:

-  Whether a package does not require Python 2 and Python 3 at the same
   time;

-  Whether the package name follows the Python package naming scheme;

-  Whether the package uses versioned Python prefix in requirements' names;

-  Whether only Python 2 version of the package contains the executables;

-  Whether the package supports Python 3 upstream but not in the package;

-  Whether the package requires ``/usr/bin/python`` (or ``python-unversioned-command``).


Running
-------

To run this task locally, execute the following command as root (don't do this
on a production machine!)::

  $ ansible-playbook tests.yml -e taskotron_item=<nevr>

where ``nevr`` is a Koji build ``name-(epoch:)version-release`` identifier.

For example::

  $ ansible-playbook tests.yml -e taskotron_item=python-gear-0.11.0-1.fc27

You can see the results in ``./artifacts/`` directory.

You can also run the above in mock::

  $ mock -r ./mock.cfg --init
  $ mock -r ./mock.cfg --copyin taskotron_python_versions *.py tests.yml /
  $ mock -r ./mock.cfg --shell 'ansible-playbook tests.yml -e taskotron_item=python-gear-0.11.0-1.fc27'
  $ mock -r ./mock.cfg --copyout artifacts artifacts

Tests
-----

This task is covered with functional and integration tests.
You can run them using `tox <https://tox.readthedocs.io/>`__, but
you will need ``mock``, ``python3-rpm`` and ``python3-dnf`` installed.
For mock configuration see
`mock setup <https://github.com/rpm-software-management/mock/wiki#setup>`__
instructions. Use the following command to run the test suite::

    $ tox

The integration tests may take a while to execute, as they are
running real tasks in mock. However, for development you may
speed them up by reusing the results of the previous test run.
This is useful if you modify the test itself, without changing the
implementation of task checks. Use the following command to run
integration tests in a fake mode::

    $ tox -e integration -- --fake

The tests are also being executed on `Travis
CI <https://travis-ci.org/fedora-python/taskotron-python-versions/>`__.
Since Travis CI runs on Ubuntu
and Ubuntu lacks the RPM Python bindings and mock,
`Docker <https://docs.travis-ci.com/user/docker/>`__ is used
to run the tests on Fedora. You can run the tests in Docker as well,
just use the commands from the ``.travis.yml`` file.

License
-------

This code has been dedicated to the Public Domain, it is licensed with
`CC0 1.0 Universal Public Domain
Dedication <https://creativecommons.org/publicdomain/zero/1.0/>`__,
full text of the license is available in the LICENSE file in this
repository.

Please note that the RPM packages in this repository used for testing
have their own license terms and are not dedicated to the Public Domain.

The sources of those packages can be found in
`Koji <https://koji.fedoraproject.org/koji/>`__ by searching the
package name and selecting the appropriate version.


