ci: run python check after build

After the build is completed and all python files are generated, run python check.
Python check runs pylint, pyflakes, isort and pycodestyle.
This ensures a proper and uniform layout of python files.

Signed-off-by: Jasper Berton <[email protected]>

Author: JasperB-TeamBlue

.github/workflows/build.yml

@@ -30,7 +30,10 @@ jobs:
 
     steps:
     - name: Install required PyPI packages
-      run: ${{ matrix.pip-command }} install "ansible-lint>=6.0.0,<7.0.0"
+      run: ${{ matrix.pip-command }} install ansible-lint pylint mock paramiko psycopg2-binary websockify websocket-client looseversion isort pycodestyle pyflakes
+
+    - name: Ensure required packages are available for linting
+      run: dnf -y install otopi python3-ovirt-setup-lib python3-daemon
 
     - name: Checkout sources
       uses: ovirt/checkout-action@main
@@ -39,6 +42,9 @@ jobs:
       run: |
         .automation/build-rpm.sh $ARTIFACTS_DIR
 
+    - name: Run python check
+      run: build/python-check.sh
+
     - name: Create DNF repository
       run: |
         createrepo_c $ARTIFACTS_DIR

.pylintrc

@@ -0,0 +1,13 @@
+[MASTER]
+init-hook=
+  import sys, pathlib;
+  root = pathlib.Path().resolve();
+  paths = [
+    root / "packaging" / "pythonlib",
+    root / "packaging" / "services" / "ovirt-engine",
+    root / "packaging" / "services" / "ovirt-fence-kdump-listener",
+    root / "packaging" / "services" / "ovirt-websocket-proxy",
+    root / "packaging" / "services" / "ovirt-engine-notifier",
+    root / "packaging" / "libexec" / "ovirt-vmconsole-proxy-helper"
+  ];
+  [sys.path.insert(0, str(p)) for p in paths if str(p) not in sys.path]

Dockerfile

@@ -23,7 +23,10 @@ RUN make ovirt-engine.spec
 RUN dnf -y builddep ovirt-engine.spec
 
 # Install run deps
-RUN dnf -y install python3-daemon python3-otopi python3-psycopg2 python3-ovirt-setup-lib otopi-common initscripts-service bind-utils postgresql ovirt-engine-wildfly-overlay mailcap ansible-runner ansible-collection-ansible-posix ovirt-imageio-daemon novnc ovirt-engine-websocket-proxy
+RUN dnf -y install python3-daemon python3-otopi python3-psycopg2 python3-ovirt-setup-lib otopi-common initscripts-service bind-utils postgresql ovirt-engine-wildfly-overlay mailcap ansible-runner ansible-collection-ansible-posix ovirt-imageio-daemon novnc ovirt-engine-websocket-proxy python3-pip
+
+# Install linting tools
+RUN pip install pylint pyflakes isort pycodestyle mock
 
 # engine-setup needs the link to initctl
 RUN ln -s /usr/sbin/service /usr/bin/initctl

Makefile

@@ -30,10 +30,11 @@ PACKAGE_NAME=ovirt-engine
 ENGINE_NAME=$(PACKAGE_NAME)
 MVN=mvn
 PYTHON=$(shell which python3 2> /dev/null)
-PYFLAKES=$(shell which pyflakes 2> /dev/null)
+PYFLAKES=pyflakes
 PY_VERSION=3
-PEP8=$(shell which pycodestyle-3 2> /dev/null)
+PEP8=pycodestyle
 ISORT=isort
+PYLINT=pylint
 PREFIX?=/usr/local
 LOCALSTATE_DIR=$(PREFIX)/var
 BIN_DIR=$(PREFIX)/bin
@@ -184,6 +185,7 @@ BUILD_TARGET=install
 	-e "s|@PEP8@|$(PEP8)|g" \
 	-e "s|@PYFLAKES@|$(PYFLAKES)|g" \
 	-e "s|@ISORT@|$(ISORT)|g" \
+	-e "s|@PYLINT@|$(PYLINT)|g" \
 	-e "s|@DEVMODE@|$(BUILD_DEV)|g" \
 	-e "s|@VMCONSOLE_SYSCONF_DIR@|$(VMCONSOLE_SYSCONF_DIR)|g" \
 	-e "s|@VMCONSOLE_PKI_DIR@|$(VMCONSOLE_PKI_DIR)|g" \

build/python-check.sh.in

@@ -1,8 +1,9 @@
-#!/bin/sh -x
+#!/bin/sh
 
 PEP8="@PEP8@"
 PYFLAKES="@PYFLAKES@"
 ISORT="@ISORT@"
+PYLINT="@PYLINT@"
 SRCDIR="$(dirname "$0")/.."
 
 cd "${SRCDIR}"
@@ -19,7 +20,7 @@ for exe in "${PYFLAKES}" "${PEP8}"; do
 		echo "WARNING: tool '${exe}' is missing" >&2
 	else
 		if "${exe}" ${FILES}; then
-			echo Passed check: "${exe}" ${FILES}
+			echo Passed check: "${exe}"
 		else
 			echo ERROR: The following check failed:
 			echo "${exe}" ${FILES}
@@ -28,11 +29,23 @@ for exe in "${PYFLAKES}" "${PEP8}"; do
 	fi
 done
 
+if ! which "${PYLINT}" > /dev/null 2>&1; then
+	echo "WARNING: Pylint is missing" >&2
+else
+	if "${PYLINT}" --errors-only ${FILES}; then
+		echo Passed check: "${PYLINT}" --errors-only
+	else
+		echo ERROR: The following check failed:
+		echo python3 -m "${PYLINT}" --errors-only ${FILES}
+		ret=1
+	fi
+fi
+
 if ! which "${ISORT}" > /dev/null 2>&1; then
 	echo "WARNING: tool '${ISORT}' is missing" >&2
 else
 	if "${ISORT}" --check ${FILES}; then
-		echo Passed check: "${ISORT}" --check ${FILES}
+		echo Passed check: "${ISORT}" --check
 	else
 		echo ERROR: The following check failed:
 		echo "${ISORT}" --check ${FILES}