ci: add hadolint and flake8 linters

addresses reanahub/reana#450

.flake8

@@ -0,0 +1,20 @@
+[flake8]
+max-line-length = 89
+
+exclude =
+    build
+    modules
+    dist
+    docs
+    coverage.xml
+    reana_job_controller.egg-info
+    .*/
+    env/
+    .git
+    __pycache__
+
+ignore = E203, E231, E266, E501, W503, F403, F401
+
+max-complexity = 18
+
+select = B,C,E,F,W,T4,B9

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ on: [push, pull_request]
 
 jobs:
   lint-shellcheck:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -21,7 +21,7 @@ jobs:
           ./run-tests.sh --check-shellscript
 
   lint-black:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -37,8 +37,25 @@ jobs:
           pip install black==19.10b0
           ./run-tests.sh --check-black
 
+  lint-flake8:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Check compliance with pep8, pyflakes and circular complexity
+        run: |
+          pip install --upgrade pip
+          pip install flake8
+          ./run-tests.sh --check-flake8
+
   lint-pydocstyle:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -55,7 +72,7 @@ jobs:
           ./run-tests.sh --check-pydocstyle
 
   lint-check-manifest:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -72,7 +89,7 @@ jobs:
           ./run-tests.sh --check-manifest
 
   docs-sphinx:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -96,7 +113,7 @@ jobs:
         run: ./run-tests.sh --check-sphinx
 
   python-tests:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     strategy:
       matrix:
         python-version: [3.6, 3.7, 3.8]
@@ -131,11 +148,20 @@ jobs:
           token: ${{ secrets.CODECOV_TOKEN }}
           files: coverage.xml
 
+  lint-dockerfile:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Check Dockerfile compliance
+        run: ./run-tests.sh --check-dockerfile
+
   docker-build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-20.04
     steps:
       - name: Checkout
         uses: actions/checkout@v2
 
-      - name: Build docker image
+      - name: Build Docker image
         run: ./run-tests.sh --check-docker-build

Dockerfile

@@ -6,6 +6,7 @@
 
 # Install base image and its dependencies
 FROM python:3.8-slim
+# hadolint ignore=DL3008, DL3013, DL3015
 RUN apt-get update && \
     apt-get install -y \
       autoconf \
@@ -21,6 +22,8 @@ RUN apt-get update && \
       python-pip \
       unzip \
       vim-tiny && \
+      apt-get clean && \
+      rm -rf /var/lib/apt/lists/* && \
     pip install --upgrade pip
 
 # Install dependencies
@@ -36,6 +39,7 @@ ARG DEBUG=0
 RUN if [ "${DEBUG}" -gt 0 ]; then pip install -e ".[debug]"; else pip install .; fi;
 
 # Are we building with locally-checked-out shared modules?
+# hadolint ignore=SC2102
 RUN if test -e modules/reana-commons; then pip install -e modules/reana-commons[kubernetes] --upgrade; fi
 
 # Check if there are broken requirements

MANIFEST.in

@@ -11,6 +11,7 @@ include *.rst
 include *.sh
 include *.in
 include *.txt
+include .flake8
 include pytest.ini
 recursive-include docs *.py
 recursive-include docs *.png

reana_workflow_engine_yadage/externalbackend.py

@@ -62,7 +62,7 @@ def __init__(self):
 
         self._fail_info = None
 
-    def submit(self, spec, parameters, state, metadata):
+    def submit(self, spec, parameters, state, metadata):  # noqa: C901
         """Submit a yadage packtivity to RJC."""
         parameters, state = finalize_inputs(parameters, state)
         job = build_job(spec["process"], parameters, state, self.config)

reana_workflow_engine_yadage/tracker.py

@@ -26,9 +26,7 @@
 
 def analyze_progress(adageobj):
     """Analyze the workflow progress."""
-    dag, rules, applied = adageobj.dag, adageobj.rules, adageobj.applied_rules
-    successful, failed, running, unsubmittable = 0, 0, 0, 0
-
+    dag = adageobj.dag
     nodestates = []
     for node in nx.topological_sort(dag):
         nodeobj = dag.getNode(node)

run-tests.sh

@@ -24,6 +24,10 @@ check_black () {
     black --check .
 }
 
+check_flake8 () {
+    flake8 .
+}
+
 check_manifest () {
     check-manifest
 }
@@ -36,6 +40,10 @@ check_pytest () {
     python setup.py test
 }
 
+check_dockerfile () {
+    docker run -i --rm hadolint/hadolint < Dockerfile
+}
+
 check_docker_build () {
     docker build -t reanahub/reana-workflow-engine-yadage .
 }
@@ -44,9 +52,11 @@ check_all () {
     check_script
     check_pydocstyle
     check_black
+    check_flake8
     check_manifest
     check_sphinx
     check_pytest
+    check_dockerfile
     check_docker_build
 }
 
@@ -61,9 +71,11 @@ do
         --check-shellscript) check_script;;
         --check-pydocstyle) check_pydocstyle;;
         --check-black) check_black;;
+        --check-flake8) check_flake8;;
         --check-manifest) check_manifest;;
         --check-sphinx) check_sphinx;;
         --check-pytest) check_pytest;;
+        --check-dockerfile) check_dockerfile;;
         --check-docker-build) check_docker_build;;
         *)
     esac

setup.py

@@ -67,7 +67,7 @@
 
 # Get the version string. Cannot be done with import!
 with open(os.path.join("reana_workflow_engine_yadage", "version.py"), "rt") as f:
-    version = re.search('__version__\s*=\s*"(?P<version>.*)"\n', f.read()).group(
+    version = re.search(r'__version__\s*=\s*"(?P<version>.*)"\n', f.read()).group(
         "version"
     )