Merge pull request #566 from bcrocker15/ogr-makefile-update-prepare-c…

…heck

Make 'make check' more consistent, and better documented, across projects

Makefile:
Abolish the 'prepare-check' target, merging its functionality into
'check' target.  In 'check' target, conditionally install

python3-flexmock
python3-requre

depending on presence/absence of /usr/share/doc/python3-flexmock
and /usr/bin/requre-patch respectively.
Check for

ansible-bender
podman

in 'build' target.
Remove all mention of unused python3-tox.
CONTRIBUTING.md:
Remove all mention of unused tox.
Remove mention of prepare-check (merged into 'check' target).
Document installation of python3-flexmock and python3-requre
by 'make check', ansible-bender and podman by 'make build'.
Include note about 7.1 GB of disk space consumed by 'make build'.
Mention conditional installation of

ansible-bender
podman
python3-requre
python3-flexmock

Minor language & spelling fixes.
Fixes #579

Reviewed-by: None <None>
Reviewed-by: None <None>
Reviewed-by: Hunor Csomortáni <[email protected]>

CONTRIBUTING.md

@@ -5,7 +5,7 @@ Please follow common guidelines for our projects [here](https://github.com/packi
 ## Reporting Bugs
 
 - [List of known issues](https://github.com/packit/ogr/issues) and in case you need to create a new issue, you can do so [here](https://github.com/packit/ogr/issues/new).
-- Getting a version of `ogr`:<br>
+- Getting the version of `ogr`:<br>
   `rpm -q python3-ogr` or `pip3 freeze | grep ogr`
 
 ## Documentation
@@ -22,33 +22,49 @@ Here are some links to the documentation that could be helpful when contributing
 - GitLab (through `Python-Gitlab`)
   - [Python-Gitlab documentation](https://python-gitlab.readthedocs.io/)
   - for details also see [official GitLab API docs](https://docs.gitlab.com/ee/api/)
-- Pagure (through `requests`) - API is dependant on deployed version of Pagure service;
+- Pagure (through `requests`) - API is dependent on deployed version of Pagure service;
   `ogr` is majorly used on (links lead directly to API docs)
   - [src.fedoraproject.org](https://src.fedoraproject.org/api/0/)
   - [pagure.io](https://pagure.io/api/0/)
   - [git.stg.centos.org](https://git.stg.centos.org/api/0/)
 
 ## Testing
 
-Tests are stored in [tests](/tests) directory.
-
-We use [Tox](https://pypi.org/project/tox) with configuration in [tox.ini](tox.ini).
+Tests are stored in the [tests](/tests) directory.
 
 Running tests locally:
 
 ```
 make prepare-check && make check
 ```
 
-Or you can run them in a container:
+The following packages are installed by 'make prepare-check'
+if they are not installed already:
+
+    python3-flexmock
+    python3-requre
+
+Or you can run tests in a container:
 
+    make prepare-build
     make build
     make check-in-container
 
-The above builds a local image with all the dependencies using
-[ansible-bender](https://github.com/ansible-community/ansible-bender), and
-runs the tests in a container created from that image. `TEST_TARGET` can be
-set to select a subset of the tests.
+The following packages are installed by 'make prepare-build'
+if they are not installed already:
+
+    podman
+    ansible-bender
+
+The 'make build' command builds a local image with all the dependencies using
+[ansible-bender](https://github.com/ansible-community/ansible-bender);
+the 'make check-in-container' command runs the tests in a container created
+from that image. `TEST_TARGET` can be set to select a subset of the tests.
+
+NOTE that 'make build' uses several GB of disk space; consult 'man
+containers-storage.conf' for more about container storage
+configuration ('make check-in-container' does not use appreciably more
+storage).
 
 As a CI we use [Zuul](https://softwarefactory-project.io/zuul/t/local/builds?project=packit-service/ogr) with a configuration in [.zuul.yaml](.zuul.yaml).
 If you want to re-run CI/tests in a pull request, just include `recheck` in a comment.
@@ -77,6 +93,7 @@ Here are some important and useful targets of [Makefile](/Makefile):
 Use [ansible-bender](https://pypi.org/project/ansible-bender) to build container image from [recipe.yaml](recipe.yaml):
 
 ```
+make prepare-build
 make build
 ```
 

Makefile

@@ -2,12 +2,25 @@ BASE_IMAGE := fedora:latest
 TEST_TARGET ?= ./tests/
 PY_PACKAGE := ogr
 OGR_IMAGE := ogr
+IS_FEDORA := $(shell uname -r | grep -c "\.fc[1-9]")
+ifeq ($(IS_FEDORA), 1)
+    PACKAGE_CHECKER := rpm -q --quiet
+    PACKAGE_INSTALLER := dnf install
+else
+    PACKAGE_CHECKER := :
+    PACKAGE_INSTALLER := :
+endif
+
+prepare-build:
+	if ! $(PACKAGE_CHECKER) ansible-bender ; then sudo $(PACKAGE_INSTALLER) ansible-bender ; fi
+	if ! $(PACKAGE_CHECKER) podman ; then sudo $(PACKAGE_INSTALLER) podman ; fi
 
 build: recipe.yaml
 	ansible-bender build --build-volumes $(CURDIR):/src:Z -- ./recipe.yaml $(BASE_IMAGE) $(OGR_IMAGE)
 
 prepare-check:
-	sudo dnf install python3-tox python36
+	if ! $(PACKAGE_CHECKER) python3-requre ; then sudo $(PACKAGE_INSTALLER) python3-requre ; fi
+	if ! $(PACKAGE_CHECKER) python3-flexmock ; then sudo $(PACKAGE_INSTALLER)  python3-flexmock ; fi
 
 check:
 	@#`python3 -m pytest` doesn't work here b/c the way requre overrides import system: