python: rename 'venv-check' target to 'check-pipenv'

Well, Cleber was right, this is a better name.

In preparation for adding a different kind of virtual environment check
(One that simply uses whichever version of Python you happen to have),
rename this test 'check-pipenv' so that it matches the CI job
'check-python-pipenv'.

Remove the "If you don't know which test to run" hint, because it's not
actually likely you have Python 3.6 installed to be able to run the
test. It's still the test I'd most prefer you to run, but it's not the
test you are most likely to be able to run.

Rename the 'venv' target to 'pipenv' as well, and move the more
pertinent help text under the 'check-pipenv' target.

Signed-off-by: John Snow <jsnow@redhat.com>
Reviewed-by: Willian Rampazzo <willianr@redhat.com>
Reviewed-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
Message-id: 20210629214323.1329806-8-jsnow@redhat.com
Signed-off-by: John Snow <jsnow@redhat.com>

diff --git a/.gitlab-ci.d/static_checks.yml b/.gitlab-ci.d/static_checks.yml
index c5fa4fce26dc2d935da147b195de07b5a97c12eb..b01f6ec231e8f349f2d0efe2efa64f71061930dc 100644 (file)
--- a/.gitlab-ci.d/static_checks.yml
+++ b/.gitlab-ci.d/static_checks.yml
@@ -30,7 +30,7 @@ check-python-pipenv:
   stage: test
   image: $CI_REGISTRY_IMAGE/qemu/python:latest
   script:
-    - make -C python venv-check
+    - make -C python check-pipenv
   variables:
     GIT_DEPTH: 1
   needs:

diff --git a/python/Makefile b/python/Makefile
index b5621b0d540e7aaa814fb5bcc0bf18383d9c6fec..07ad73ccd023b6afa9f32c9b91b9b2798cdedeac 100644 (file)
--- a/python/Makefile
+++ b/python/Makefile
@@ -1,15 +1,13 @@
-.PHONY: help venv venv-check check clean distclean develop
+.PHONY: help pipenv check-pipenv check clean distclean develop
 
 help:
        @echo "python packaging help:"
        @echo ""
-       @echo "make venv:       Create pipenv's virtual environment."
-       @echo "    NOTE: Requires Python 3.6 and pipenv."
-       @echo "          Will download packages from PyPI."
-       @echo "    Hint: (On Fedora): 'sudo dnf install python36 pipenv'"
-       @echo ""
-       @echo "make venv-check: run linters using pipenv's virtual environment."
-       @echo "    Hint: If you don't know which test to run, run this one!"
+       @echo "make check-pipenv:"
+       @echo "    Run tests in pipenv's virtual environment."
+       @echo "    These tests use the oldest dependencies."
+       @echo "    Requires: Python 3.6 and pipenv."
+       @echo "    Hint (Fedora): 'sudo dnf install python3.6 pipenv'"
        @echo ""
        @echo "make develop:    Install deps for 'make check', and"
        @echo "                 the qemu libs in editable/development mode."
@@ -18,18 +16,21 @@ help:
        @echo ""
        @echo "make check-tox:  run linters using multiple python versions."
        @echo ""
+       @echo "make pipenv"
+       @echo "    Creates pipenv's virtual environment (.venv)"
+       @echo ""
        @echo "make clean:      remove package build output."
        @echo ""
        @echo "make distclean:  remove venv files, qemu package forwarder,"
        @echo "                 built distribution files, and everything"
        @echo "                 from 'make clean'."
 
-venv: .venv
+pipenv: .venv
 .venv: Pipfile.lock
        @PIPENV_VENV_IN_PROJECT=1 pipenv sync --dev --keep-outdated
        @touch .venv
 
-venv-check: venv
+check-pipenv: pipenv
        @pipenv run make check
 
 develop:

diff --git a/python/README.rst b/python/README.rst
index d4502fdb6042fdf8adfec89c387befd19a1f3912..9c1fceaee73b11cb313b71a9a558a0bc2e4a813a 100644 (file)
--- a/python/README.rst
+++ b/python/README.rst
@@ -79,7 +79,7 @@ Files in this directory
 - ``PACKAGE.rst`` is used as the README file that is visible on PyPI.org.
 - ``Pipfile`` is used by Pipenv to generate ``Pipfile.lock``.
 - ``Pipfile.lock`` is a set of pinned package dependencies that this package
-  is tested under in our CI suite. It is used by ``make venv-check``.
+  is tested under in our CI suite. It is used by ``make check-pipenv``.
 - ``README.rst`` you are here!
 - ``VERSION`` contains the PEP-440 compliant version used to describe
   this package; it is referenced by ``setup.cfg``.