[Notes] [Git][BuildStream/buildstream][chandan/toxify] 5 commits: Add re

Chandan Singh pushed to branch chandan/toxify at BuildStream / buildstream

Commits:

daa4c755

by Chandan Singh at 2018-12-29T02:25:57Z

Add requirements files for install, test and plugin dependencies

Add `.in` and `.txt` requirements files for BuildStream's pure python
dependencies. For each pair, the `.in` file is supposed to capture the
loose version requirements, and the corresponding `.txt` file is
supposed to have frozen requirements. We have 3 such sets:

* `requirements`: BuildStream's runtime dependencies
* `dev-requirements`: Dependencies for running tests
* `plugin-requirements`: Dependencies for core plugins

Note that the frozen requirements files will only be used for testing
purposes, and `setup.py` will continue to read loose requirements.

6101bab4

by Chandan Singh at 2018-12-29T02:34:07Z

Add tox.ini to enable running tests using tox

Add `tox.ini` file that will enable us to use
[tox](https://tox.readthedocs.io/) as a frontend for running tests.
Since we share the config via `setup.cfg` and requirements via
requirements files, commands like `python3 setup.py test` will continue
to work.

d3d0894b

by Chandan Singh at 2018-12-29T02:36:14Z

.gitlab-ci.yml: Run tests using tox

Instead of invoking tests throung `setup.py`, use `tox` as a frontend in
the CI pipelines.

e0d5710c

by Tristan Van Berkom at 2018-12-29T02:38:31Z

CONTRIBUTING.rst: Updated to reflect running tests using tox.

63ce0e4a

by Chandan Singh at 2018-12-29T03:01:42Z

CONTRIBUTING.rst: Add steps for installing non-python build dependencies

Since we don't allow use of site packages by default in our `tox`
configuration, people will need to install non-python build dependencies
of some of our dependencies that do not provide pre-built wheels. We
have two such packages at the moment:

* psuitl: requires python C headers, compiler
* pygobject: requires python C headers, pkg-config, compiler, cairo
  headers, and gobject libraries

Changes:

.gitignore

@@ -17,6 +17,7 @@ tmp
  .cache
  .pytest_cache/
  *.bst/
 +.tox
  # Pycache, in case buildstream is ran directly from within the source
  # tree

.gitlab-ci.yml

@@ -13,7 +13,7 @@ stages:
  variables:
    PYTEST_ADDOPTS: "--color=yes"
    INTEGRATION_CACHE: "${CI_PROJECT_DIR}/cache/integration-cache"
 -  TEST_COMMAND: 'python3 setup.py test --index-url invalid://uri --addopts --integration'
 +  TEST_COMMAND: 'tox -- --color=yes --integration'
  #####################################################
  #                  Prepare stage                    #
@@ -67,10 +67,10 @@ source_dist:
    # Diagnostics
    - mount
    - df -h
+-
 -  # Unpack
 -  - cd dist && ./unpack.sh
 -  - cd buildstream
 +  # FIXME: this deps should ideally be provided by the testsuite images
 +  - pip3 install tox
 +  - |
 +    bash -c '( apt-get update && apt-get install -y python3-dev gcc libcairo2-dev pkg-config libgirepository1.0-dev ) || ( dnf install -y gcc python3-devel gobject-introspection-devel glib2-devel cairo-gobject-devel )'
    script:
    - useradd -Um buildstream
@@ -83,7 +83,7 @@ source_dist:
    after_script:
    # Collect our reports
    - mkdir -p ${COVERAGE_DIR}
 -  - cp dist/buildstream/.coverage ${COVERAGE_DIR}/coverage."${CI_JOB_NAME}"
 +  - cp .coverage ${COVERAGE_DIR}/coverage."${CI_JOB_NAME}"
    except:
    - schedules
    artifacts:

CONTRIBUTING.rst

@@ -1468,58 +1468,113 @@ regenerate them locally in order to build the docs.
  Testing
  -------
 -BuildStream uses pytest for regression tests and testing out
 -the behavior of newly added components.
 +BuildStream uses `tox <https://tox.readthedocs.org/>`_ as a frontend to run the
 +tests which are implemented using `pytest <https://pytest.org/>`_. We use
 +pytest for regression tests and testing out the behavior of newly added
 +components.
  The elaborate documentation for pytest can be found here: http://doc.pytest.org/en/latest/contents.html
  Don't get lost in the docs if you don't need to, follow existing examples instead.
 +Installing build dependencies
 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 +Some of BuildStream's dependencies have non-python build dependencies. When
 +running tests with ``tox``, you will first need to install these dependencies.
 +Exact steps to install these will depend on your oprtation systemm. Commands
 +for installing them for some common distributions are lised below.
++
 +For Fedora-based systems::
++
 +  dnf install gcc pkg-config python3-devel cairo-gobject-devel glib2-devel gobject-introspection-devel
++
++
 +For Debian-based systems::
++
 +  apt install gcc pkg-config python3-dev libcairo2-dev libgirepository1.0-dev
++
++
  Running tests
  ~~~~~~~~~~~~~
 -To run the tests, just type::
 +To run the tests, simply navigate to the toplevel directory of your BuildStream
 +checkout and run::
++
 +  tox
++
 +By default, the test suite will be run against every supported python version
 +found on your host. If you have multiple python versions installed, you may
 +want to run tests against only one version and you can do that using the ``-e``
 +option when running tox::
++
 +  tox -e py37
 -  ./setup.py test
 +The output of all failing tests will always be printed in the summary, but
 +if you want to observe the stdout and stderr generated by a passing test,
 +you can pass the ``-s`` option to pytest as such::
 -At the toplevel.
 +  tox -- -s
 -When debugging a test, it can be desirable to see the stdout
 -and stderr generated by a test, to do this use the ``--addopts``
 -function to feed arguments to pytest as such::
 +.. tip::
 -  ./setup.py test --addopts -s
 +   The ``-s`` option is `a pytest option <https://docs.pytest.org/latest/usage.html>`_.
++
 +   Any options specified before the ``--`` separator are consumed by ``tox``,
 +   and any options after the ``--`` separator will be passed along to pytest.
  You can always abort on the first failure by running::
 -  ./setup.py test --addopts -x
 +  tox -- -x
  If you want to run a specific test or a group of tests, you
  can specify a prefix to match. E.g. if you want to run all of
  the frontend tests you can do::
 -  ./setup.py test --addopts 'tests/frontend/'
 +  tox -- tests/frontend/
  Specific tests can be chosen by using the :: delimeter after the test module.
  If you wanted to run the test_build_track test within frontend/buildtrack.py you could do::
 -  ./setup.py test --addopts 'tests/frontend/buildtrack.py::test_build_track'
 +  tox -- tests/frontend/buildtrack.py::test_build_track
  We also have a set of slow integration tests that are disabled by
  default - you will notice most of them marked with SKIP in the pytest
  output. To run them, you can use::
 -  ./setup.py test --addopts '--integration'
 +  tox -- --integration
  By default, buildstream also runs pylint on all files. Should you want
  to run just pylint (these checks are a lot faster), you can do so
  with::
 -  ./setup.py test --addopts '-m pylint'
 +  tox -- -m pylint
  Alternatively, any IDE plugin that uses pytest should automatically
  detect the ``.pylintrc`` in the project's root directory.
 +.. note::
++
 +   By default, we do not allow use of site packages in our ``tox``
 +   confguration to enable running the tests in an isolated environment.
 +   If you need to enable use of site packages for whatever reason, you can
 +   do so by passing the ``--sitepackages`` option to ``tox``. Also, you will
 +   not need to install any of the build dependencies mentioned above if you
 +   use this approach.
++
 +.. note::
++
 +   While using ``tox`` is practical for developers running tests in
 +   more predictable execution environments, it is still possible to
 +   execute the test suite against a specific installation environment
 +   using pytest directly::
++
 +     ./setup.py test
++
 +   Specific options can be passed to ``pytest`` using the ``--addopts``
 +   option::
++
 +     ./setup.py test --addopts 'tests/frontend/buildtrack.py::test_build_track'
++
  Adding tests
  ~~~~~~~~~~~~

MANIFEST.in

@@ -24,6 +24,7 @@ recursive-include doc/sessions *.run
  # Tests
  recursive-include tests *
  include conftest.py
 +include tox.ini
  include .coveragerc
  include .pylintrc
@@ -31,7 +32,12 @@ include .pylintrc
  recursive-include buildstream/_protos *.proto
  # Requirements files
 +include requirements.in
 +include requirements.txt
 +include dev-requirements.in
  include dev-requirements.txt
 +include plugin-requirements.in
 +include plugin-requirements.txt
  # Versioneer
  include versioneer.py

dev-requirements.in

 +coverage == 4.4.0
 +pep8
 +pylint
 +pytest >= 3.9
 +pytest-cov >= 2.5.0
 +pytest-datafiles >= 2.0
 +pytest-env
 +pytest-pep8
 +pytest-pylint
 +pytest-xdist
 +pytest-timeout
 +pyftpdlib

dev-requirements.txt

 -coverage == 4.4.0
 -pep8
 -pylint
 -pytest >= 3.9
 -pytest-cov >= 2.5.0
 -pytest-datafiles >= 2.0
 -pytest-env
 -pytest-pep8
 -pytest-pylint
 -pytest-xdist
 -pytest-timeout
 -pyftpdlib
 +coverage==4.4
 +pep8==1.7.1
 +pylint==2.2.2
 +pytest==4.0.2
 +pytest-cov==2.6.0
 +pytest-datafiles==2.0
 +pytest-env==0.6.2
 +pytest-pep8==1.0.6
 +pytest-pylint==0.13.0
 +pytest-xdist==1.25.0
 +pytest-timeout==1.3.3
 +pyftpdlib==1.5.4
 +## The following requirements were added by pip freeze:
 +apipkg==1.5
 +astroid==2.1.0
 +atomicwrites==1.2.1
 +attrs==18.2.0
 +execnet==1.5.0
 +isort==4.3.4
 +lazy-object-proxy==1.3.1
 +mccabe==0.6.1
 +more-itertools==5.0.0
 +pluggy==0.8.0
 +py==1.7.0
 +pytest-cache==1.0
 +pytest-forked==0.2
 +six==1.12.0
 +typed-ast==1.1.1
 +wrapt==1.10.11

plugin-requirements.in

	1	+arpy
	2	+PyGObject

plugin-requirements.txt

 +arpy==1.1.1
 +PyGObject==3.30.4
 +## The following requirements were added by pip freeze:
 +pycairo==1.18.0

requirements.in

 +Click
 +grpcio >= 1.10
 +jinja2 >= 2.10
 +pluginbase
 +protobuf >= 3.5
 +psutil
 +# According to ruamel.yaml's PyPI page, we are suppose to use
 +# "<=0.15" in production until 0.15 becomes API stable.
 +# However we need ruamel.yaml 0.15.41 or greater for Python 3.7.
 +# We know that ruamel.yaml 0.15.52 breaks API in a way that
 +# is incompatible with BuildStream.
 +#
 +# See issues #571 and #790.
 +ruamel.yaml >= 0.15.41, < 0.15.52
 +setuptools

requirements.txt

 +Click==7.0
 +grpcio==1.17.1
 +pluginbase==0.7
 +protobuf==3.6.1
 +psutil==5.4.8
 +# According to ruamel.yaml's PyPI page, we are suppose to use
 +# "<=0.15" in production until 0.15 becomes API stable.
 +# However we need ruamel.yaml 0.15.41 or greater for Python 3.7.
 +# We know that ruamel.yaml 0.15.52 breaks API in a way that
 +# is incompatible with BuildStream.
 +#
 +# See issues #571 and #790.
 +ruamel.yaml==0.15.51
 +setuptools==39.0.1
 +## The following requirements were added by pip freeze:
 +Jinja2==2.10
 +MarkupSafe==1.1.0
 +six==1.12.0

setup.py

@@ -270,9 +270,12 @@ def get_cmdclass():
  #####################################################
  #               Gather requirements                 #
  #####################################################
 -with open('dev-requirements.txt') as dev_reqs:
 +with open('dev-requirements.in') as dev_reqs:
      dev_requires = dev_reqs.read().splitlines()
 +with open('requirements.in') as install_reqs:
 +    install_requires = install_reqs.read().splitlines()
++
  #####################################################
  #     Prepare package description from README       #
  #####################################################
@@ -334,23 +337,7 @@ setup(name='BuildStream',
                os.path.join('buildstream', 'data', 'bst')
            ])
        ],
 -      install_requires=[
 -          'setuptools',
 -          'psutil',
 -          # According to ruamel.yaml's PyPI page, we are suppose to use
 -          # "<=0.15" in production until 0.15 becomes API stable.
 -          # However we need ruamel.yaml 0.15.41 or greater for Python 3.7.
 -          # We know that ruamel.yaml 0.15.52 breaks API in a way that
 -          # is incompatible with BuildStream.
 -          #
 -          # See issues #571 and #790.
 -          'ruamel.yaml >= 0.15.41, < 0.15.52',
 -          'pluginbase',
 -          'Click >= 7.0',
 -          'jinja2 >= 2.10',
 -          'protobuf >= 3.5',
 -          'grpcio >= 1.10',
 -      ],
 +      install_requires=install_requires,
        entry_points=bst_install_entry_points,
        tests_require=dev_requires,
        zip_safe=False)

tox.ini

 +[tox]
 +envlist = py35,py36,py37
 +skip_missing_interpreters = true
++
 +[testenv]
 +commands = pytest {posargs}
 +deps =
 +    -rrequirements.txt
 +    -rdev-requirements.txt
 +    -rplugin-requirements.txt
 +passenv =
 +    GI_TYPELIB_PATH

[Notes] [Git][BuildStream/buildstream][chandan/toxify] 5 commits: Add requirements files for install, test and plugin dependencies

Chandan Singh pushed to branch chandan/toxify at BuildStream / buildstream

Commits:

12 changed files:

Changes: