Fix/lint workflow 192 (#199)

Fix #192.

This PR introduces a reusable workflow. This general workflow handles
the job necessary to run both `ansible-lint` and `yamllint` on
**either** all roles or one specific role.

All roles are linted when:
- linting rules are changed
- the linting workflow is changed

Specific roles are linted when:
- a role specific workflow is triggered (linting as first job)
- the `full_stack` workflow is triggered (linting as first job)

The workflow for the specific role now uses a call to the general
linting workflow, while providing it with its own role name.

This approach does not completely remove linting from single workflows,
but it makes those linting jobs much more readable and reduces redundant
code, while also allowing for a bit more flexibility.

---------

Co-authored-by: Thomas Widhalm <[email protected]>

Author: Donien

.github/workflows/test_full_stack.yml

@@ -16,27 +16,10 @@ on:
     - cron: "0 4 * * *"
 
 jobs:
-
   lint_full:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out the codebase.
-        uses: actions/checkout@v3
-
-      - name: Set up Python 3.
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.x'
-
-      - name: Install test dependencies.
-        run: |
-          python3 -m pip install --upgrade pip
-          python3 -m pip install -r requirements-test.txt
-
-      - name: Lint code.
-        run: |
-          yamllint .
-          ansible-lint roles/
+    uses: ./.github/workflows/test_linting.yml
+    with:
+      rolename: ''
 
   molecule_full_stack_every_os:
     runs-on: ubuntu-latest

.github/workflows/test_linting.yml

@@ -0,0 +1,68 @@
+---
+name: Test Linting
+on:
+  workflow_dispatch:
+    inputs:
+      logLevel:
+        description: 'Log level'
+        required: true
+        default: 'warning'
+        type: choice
+        options:
+          - info
+          - warning
+          - debug
+  workflow_call:
+    inputs:
+      rolename:
+        required: true
+        type: string
+  push:
+    branches:
+      - 'feature/**'
+      - 'fix/**'
+      - '!doc/**'
+    paths:
+      - '.github/workflows/test_linting.yml'
+      - '.config/ansible-lint.yml'
+      - '.yamllint'
+  pull_request:
+    branches:
+      - 'feature/**'
+      - 'fix/**'
+      - '!doc/**'
+    paths:
+      - '.github/workflows/test_linting.yml'
+      - '.config/ansible-lint.yml'
+      - '.yamllint'
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out the codebase.
+        uses: actions/checkout@v3
+
+      - name: Set up Python 3.
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+
+      - name: Install test dependencies.
+        run: |
+          python3 -m pip install --upgrade pip
+          python3 -m pip install -r requirements-test.txt
+
+      - name: Lint code (yamllint).
+        run: |
+          yamllint .
+        if: ${{ inputs.rolename == '' }}
+
+      - name: Lint Role (yamllint).
+        run: |
+          ansible-lint roles/${{ inputs.rolename }}
+        if: ${{ inputs.rolename != '' }}
+
+      - name: Lint Role (ansible-lint).
+        run: |
+          ansible-lint roles/${{ inputs.rolename }}

.github/workflows/test_role_beats.yml

@@ -21,8 +21,6 @@ on:
       - 'roles/beats/**'
       - '.github/workflows/test_role_beats.yml'
       - 'molecule/beats_**'
-      - '.config/ansible-lint.yml'
-      - '.yamllint'
   pull_request:
     branches:
       - 'feature/**'
@@ -32,30 +30,12 @@ on:
       - 'roles/beats/**'
       - '.github/workflows/test_role_beats.yml'
       - 'molecule/beats_**'
-      - '.config/ansible-lint.yml'
-      - '.yamllint'
 
 jobs:
   lint_beats:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out the codebase.
-        uses: actions/checkout@v3
-
-      - name: Set up Python 3.
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.x'
-
-      - name: Install test dependencies.
-        run: |
-          python3 -m pip install --upgrade pip
-          python3 -m pip install -r requirements-test.txt
-
-      - name: Lint code.
-        run: |
-          yamllint roles/beats/
-          ansible-lint roles/beats/
+    uses: ./.github/workflows/test_linting.yml
+    with:
+      rolename: beats
 
   molecule_beats:
     needs: lint_beats

.github/workflows/test_role_elasticsearch.yml

@@ -21,8 +21,6 @@ on:
       - 'roles/elasticsearch/**'
       - '.github/workflows/test_role_elasticsearch.yml'
       - 'molecule/elasticsearch_**'
-      - '.config/ansible-lint.yml'
-      - '.yamllint'
   pull_request:
     branches:
       - 'feature/**'
@@ -32,30 +30,12 @@ on:
       - 'roles/elasticsearch/**'
       - '.github/workflows/test_role_elasticsearch.yml'
       - 'molecule/elasticsearch_**'
-      - '.config/ansible-lint.yml'
-      - '.yamllint'
 
 jobs:
   lint_elasticsearch:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out the codebase.
-        uses: actions/checkout@v3
-
-      - name: Set up Python 3.
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.x'
-
-      - name: Install test dependencies.
-        run: |
-          python3 -m pip install --upgrade pip
-          python3 -m pip install -r requirements-test.txt
-
-      - name: Lint code.
-        run: |
-          yamllint roles/elasticsearch/
-          ansible-lint roles/elasticsearch/
+    uses: ./.github/workflows/test_linting.yml
+    with:
+      rolename: elasticsearch
 
   molecule_elasticsearch:
     needs: lint_elasticsearch

.github/workflows/test_role_kibana.yml

@@ -21,8 +21,6 @@ on:
       - 'roles/kibana/**'
       - '.github/workflows/test_role_kibana.yml'
       - 'molecule/kibana_**'
-      - '.config/ansible-lint.yml'
-      - '.yamllint'
   pull_request:
     branches:
       - 'feature/**'
@@ -32,30 +30,13 @@ on:
       - 'roles/kibana/**'
       - '.github/workflows/test_role_kibana.yml'
       - 'molecule/kibana_**'
-      - '.config/ansible-lint.yml'
-      - '.yamllint'
 
 jobs:
   lint_kibana:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out the codebase.
-        uses: actions/checkout@v3
-
-      - name: Set up Python 3.
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.x'
+    uses: ./.github/workflows/test_linting.yml
+    with:
+      rolename: kibana
 
-      - name: Install test dependencies.
-        run: |
-          python3 -m pip install --upgrade pip
-          python3 -m pip install -r requirements-test.txt
-
-      - name: Lint code.
-        run: |
-          yamllint roles/kibana/
-          ansible-lint roles/kibana/
 
   molecule_kibana:
     needs: lint_kibana

.github/workflows/test_role_logstash.yml

@@ -21,8 +21,6 @@ on:
       - 'roles/logstash/**'
       - '.github/workflows/test_role_logstash.yml'
       - 'molecule/logstash_**'
-      - '.config/ansible-lint.yml'
-      - '.yamllint'
   pull_request:
     branches:
       - 'feature/**'
@@ -32,30 +30,13 @@ on:
       - 'roles/logstash/**'
       - '.github/workflows/test_role_logstash.yml'
       - 'molecule/logstash_**'
-      - '.config/ansible-lint.yml'
-      - '.yamllint'
 
 jobs:
   lint_logstash:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out the codebase.
-        uses: actions/checkout@v3
-
-      - name: Set up Python 3.
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.x'
+    uses: ./.github/workflows/test_linting.yml
+    with:
+      rolename: logstash
 
-      - name: Install test dependencies.
-        run: |
-          python3 -m pip install --upgrade pip
-          python3 -m pip install -r requirements-test.txt
-
-      - name: Lint code.
-        run: |
-          yamllint roles/logstash/
-          ansible-lint roles/logstash/
 
   molecule_logstash_extended:
     runs-on: ubuntu-latest

.github/workflows/test_role_repos.yml

@@ -20,8 +20,6 @@ on:
       - 'roles/repos/**'
       - '.github/workflows/test_role_repos.yml'
       - 'molecule/repos_**'
-      - '.config/ansible-lint.yml'
-      - '.yamllint'
   pull_request:
     branches:
       - 'feature/**'
@@ -31,30 +29,12 @@ on:
       - 'roles/repos/**'
       - '.github/workflows/test_role_repos.yml'
       - 'molecule/repos_**'
-      - '.config/ansible-lint.yml'
-      - '.yamllint'
 
 jobs:
   lint_repos:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out the codebase.
-        uses: actions/checkout@v3
-
-      - name: Set up Python 3.
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.x'
-
-      - name: Install test dependencies.
-        run: |
-          python3 -m pip install --upgrade pip
-          python3 -m pip install -r requirements-test.txt
-
-      - name: Lint code.
-        run: |
-          yamllint roles/repos/
-          ansible-lint roles/repos/
+    uses: ./.github/workflows/test_linting.yml
+    with:
+      rolename: repos
 
   molecule_repos:
     needs: lint_repos

.github/workflows/test_roles_pr.yml

@@ -21,8 +21,6 @@ on:
       - 'roles/**'
       - '.github/workflows/test_roles_pr.yml'
       - 'molecule/elasticstack_default/**'
-      - '.config/ansible-lint.yml'
-      - '.yamllint'
   push:
     branches:
       - 'feature/**'
@@ -32,30 +30,13 @@ on:
       - 'roles/**'
       - '.github/workflows/test_roles_pr.yml'
       - 'molecule/elasticstack_default/**'
-      - '.config/ansible-lint.yml'
-      - '.yamllint'
 
 jobs:
   lint_full:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Check out the codebase.
-        uses: actions/checkout@v3
-
-      - name: Set up Python 3.
-        uses: actions/setup-python@v4
-        with:
-          python-version: '3.x'
+    uses: ./.github/workflows/test_linting.yml
+    with:
+      rolename: ''
 
-      - name: Install test dependencies.
-        run: |
-          python3 -m pip install --upgrade pip
-          python3 -m pip install -r requirements-test.txt
-
-      - name: Lint code.
-        run: |
-          yamllint .
-          ansible-lint roles/
   molecule_full_stack:
     runs-on: ubuntu-latest
     needs: lint_full