From 8949fce5e1bac456c7390a7394342384999993b6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marcus=20Sch=C3=A4fer?= Date: Tue, 14 Jan 2025 10:52:43 +0100 Subject: [PATCH] Drop still present tox artifacts There were still some left over tox files and the documentation contribution chapter was also wrong at several places --- doc/source/contributing.rst | 54 ++------------------- doc/source/contributing/scripts_testing.rst | 4 +- pyproject.toml | 3 -- 3 files changed, 5 insertions(+), 56 deletions(-) diff --git a/doc/source/contributing.rst b/doc/source/contributing.rst index 09ca063e3ca..9c79416c28d 100644 --- a/doc/source/contributing.rst +++ b/doc/source/contributing.rst @@ -64,13 +64,6 @@ Create a Python Virtual Development Environment The following commands initializes and activates a development environment for Python 3: -.. note:: - - {kiwi} uses tox to create a devel environment and to run - tests, linters and other tasks in the tox generated environment. - A tox version >= 3.3 is required for this setup process. On your - host a python version >= 3.9 is required for tox to work. - .. code:: shell-session $ poetry install @@ -87,47 +80,13 @@ Python sources inside the virtual environment using Poetry: Running the Unit Tests ---------------------- -We use :command:`tox` to run the unit tests. Tox sets up its own -virtualenvs inside the :file:`.tox` directory for multiple Python versions -and should thus **not** be invoked from inside your development virtualenv. - Before submitting your changes via a pull request, ensure that all tests pass and that the code has the required test coverage via the command: .. code:: shell-session - $ tox - -We also include `pytest-xdist` in the development virtualenv which allows -to run the unit tests in parallel. It is turned off by default but can be -enabled via: - -.. code:: shell-session - - $ tox -- "-n NUMBER_OF_PROCESSES" - -where you can insert an arbitrary number as `NUMBER_OF_PROCESSES` (or a -shell command like `$(nproc)`). Note that the double quotes around `-n -NUMBER_OF_PROCESSES` are required (otherwise :command:`tox` will consume -this command line flag instead of forwarding it to :command:`pytest`). - -The previous call would run the unit tests for different Python versions, -check the source code for errors and build the documentation. - -If you want to see the available targets, use the option `-l` to let -:command:`tox` print a list of them: - -.. code:: shell-session - - $ tox -l - -To only run a special target, use the `-e` option. The following -example runs the test cases for the Python 3.11 interpreter only: - -.. code:: shell-session - - $ tox -e unit_py3_11 - + $ make check + $ make test Create a Branch for each Feature or Bugfix ------------------------------------------ @@ -159,13 +118,6 @@ Make and commit your changes. $ git commit -S -a -Run the tests and code style checks. All of these are also performed by -`GitLab CI `_ when a pull request is created. - -.. code:: shell-session - - $ tox - Once everything is done, push your local branch to your forked repository and create a pull request into the upstream repository. @@ -199,7 +151,7 @@ user documentation and manual pages .. code:: shell-session - tox -e doc + $ make docs Document all your classes, methods, their parameters and their types using the standard `reStructuredText diff --git a/doc/source/contributing/scripts_testing.rst b/doc/source/contributing/scripts_testing.rst index 9777393a639..7a81c658878 100644 --- a/doc/source/contributing/scripts_testing.rst +++ b/doc/source/contributing/scripts_testing.rst @@ -10,11 +10,11 @@ configured on your system. With Podman, the integration tests use :command:`podm **rootless mode** by default. You can select :command:`docker` instead by setting the environment variable ``CONTAINER_RUNTIME`` to ``docker``. Then you can run the integration tests via -tox: +the `test_scripts` Makefile target: .. code:: shell-session - $ tox -e scripts -- -n NUMBER_OF_THREADS + $ sudo make test_scripts The tests are written using the `pytest-container diff --git a/pyproject.toml b/pyproject.toml index 6bf1cd99ede..11004276f9c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -25,8 +25,6 @@ packages = [ include = [ { path = ".bumpversion.cfg", format = "sdist" }, { path = ".coverage*", format = "sdist" }, - { path = ".virtualenv.requirements*.txt", format = "sdist" }, - { path = ".virtualenv.dev-requirements.txt", format = "sdist" }, { path = "setup.cfg", format = "sdist" }, { path = "doc/source", format = "sdist" }, { path = "doc/Makefile", format = "sdist" }, @@ -36,7 +34,6 @@ include = [ { path = "Makefile", format = "sdist" }, { path = "package", format = "sdist" }, { path = "test", format = "sdist" }, - { path = "tox.ini", format = "sdist" }, { path = "kiwi/runtime_checker_metadata.yml", format = "sdist" }, ]