Add pre commit and linting (#15)

* add ansible-lint and pre-commit config files

* add pre-commit to requirements.txt

* add ansible-lint github workflow

* commit pre-commit and ansible-lint fixes excluding syntax_highlighting_demo.yml

* Add syntax_highlighting_demo.yml to ansible-lint exclude_paths.
So that GitHub lint pipeline can succeeed.

* Add instructional comments to syntax_highlighting_demo.yml

* Add molecule paths to ansible-lint exclude_paths.

* Add exclude for syntax_highligting_check.yml to pre-commit config.

.ansible-lint

@@ -0,0 +1,16 @@
+---
+mock_modules:
+  - community.okd.k8s
+
+mock_roles:
+  - backup_file
+
+exclude_paths:
+  - devfile.yml
+  - syntax_highlighting_demo.yml
+  - collections/ansible_collections/sample_namespace/sample_collection/roles/backup_file/molecule
+  - collections/ansible_collections/sample_namespace/sample_collection/extensions
+
+warn_list:
+  - galaxy[no-changelog]  # TODO: Implement changelog.
+  - schema[meta-runtime]  # TODO: Implement meta/runtime.yml

.github/workflows/ansible-lint.yml

@@ -0,0 +1,15 @@
+# .github/workflows/ansible-lint.yml
+name: ansible-lint
+on:
+  pull_request:
+    branches:
+      - 'devspaces-[0-9].[0-9]+-rhel-8'
+      - devspaces-3-rhel-8
+jobs:
+  build:
+    name: Ansible Lint  # Naming the build is important to use it as a status check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run ansible-lint
+        uses: ansible/ansible-lint@main  # or version tag instead of 'main'

.github/workflows/image-build.yaml

@@ -24,14 +24,14 @@ jobs:
 
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
-      
+
       - name: "Docker quay.io Login"
         uses: docker/login-action@v2
         with:
           registry: quay.io
           username: ${{ secrets.QUAY_USERNAME }}
           password: ${{ secrets.QUAY_PASSWORD }}
-      
+
       - name: Check Commit Message
         id: check_message
         run: |
@@ -42,7 +42,7 @@ jobs:
           else
             echo "update_devfile=true" >> $GITHUB_OUTPUT
           fi
-          
+
       - name: Build and push Docker image; Update image in devfile
         if: steps.check_message.outputs.update_devfile == 'true' || github.actor == 'devstudio-release'
         run: |
@@ -56,7 +56,7 @@ jobs:
           fi
           echo "Tag: $tag"
           image_id=$(docker build -q -t "quay.io/devspaces/ansible-creator-ee:${tag}" .)
-          
+
           short_sha=$(echo $image_id | cut -c8-12)
           echo "Short SHA: $short_sha"
           docker tag quay.io/devspaces/ansible-creator-ee:${tag} quay.io/devspaces/ansible-creator-ee:${tag}-${short_sha}
@@ -66,13 +66,13 @@ jobs:
           docker pull quay.io/devspaces/ansible-creator-ee:${tag}
           digest=$(docker inspect --format='{{index .RepoDigests 0}}' quay.io/devspaces/ansible-creator-ee:${tag})
           sed -r -i devfile.yaml -e "s|(image: .+devspaces/ansible-creator-ee.+)|image: ${digest}|g"
-      
+
       - name: Set up Git
         if: steps.check_message.outputs.update_devfile == 'true' || github.actor == 'devstudio-release'
         run: |
           git config --global user.email "[email protected]"
           git config --global user.name "Valerii Svydenko"
-        
+
       - name: Commit and Push Changes
         if: steps.check_message.outputs.update_devfile == 'true' || github.actor == 'devstudio-release'
         run: |

.pre-commit-config.yaml

@@ -0,0 +1,25 @@
+---
+repos:
+  - repo: 'https://github.com/pre-commit/pre-commit-hooks'
+    rev: v4.5.0
+    hooks:
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+        exclude: syntax_highlighting_demo.yml
+      - id: no-commit-to-branch
+
+  - repo: 'https://github.com/ansible-community/ansible-lint.git'
+    rev: v6.22.1
+    hooks:
+      - id: ansible-lint
+        pass_filenames: false
+        always_run: true
+        entry: "ansible-lint"
+        args:
+          - "--profile=production"
+          - "-c=.ansible-lint"
+        additional_dependencies:
+          - "ansible-core>=2.13"
+          - "yamllint>=1.29,<2.0"

.vscode/settings.json

@@ -12,4 +12,4 @@
     "ansible.validation.enabled": true,
     "ansible.validation.lint.enabled": true,
     "ansible.validation.lint.path": "/usr/local/bin/ansible-lint"
-}
+}

Dockerfile

@@ -14,7 +14,7 @@ RUN \
     curl -LO https://dl.k8s.io/release/`curl -LS https://dl.k8s.io/release/stable.txt`/bin/linux/amd64/kubectl && \
     chmod +x ./kubectl && \
     mv ./kubectl /usr/local/bin && \
-    kubectl version --client 
+    kubectl version --client
 
 ## helm
 RUN \

README.md

@@ -69,4 +69,4 @@ To reset your test pod back to a fresh instance you can run `molecule destroy` a
 Contributions to this repository are welcome! If you find any issues or have suggestions for improvements, feel free to open an issue with [Red Hat](https://issues.redhat.com/projects/CRW/issues).
 
 ## Code of Conduct
-We ask all of our community members and contributors to adhere to the [Ansible code of conduct](http://docs.ansible.com/ansible/latest/community/code_of_conduct.html). If you have questions or need assistance, please reach out to our community team at [[email protected]](mailto:[email protected])   
+We ask all of our community members and contributors to adhere to the [Ansible code of conduct](http://docs.ansible.com/ansible/latest/community/code_of_conduct.html). If you have questions or need assistance, please reach out to our community team at [[email protected]](mailto:[email protected])

collections/ansible_collections/sample_namespace/sample_collection/extensions/molecule/default/create.yml

@@ -19,15 +19,15 @@
       ansible.builtin.debug:
         var: server
 
-    - name: Store container information # noqa: no-handler
+    - name: Store container information  # noqa: no-handler
       when: server.changed | default(false) | bool
       block:
 
         - name: Populate instance config dict
           ansible.builtin.set_fact:
             instance_conf_dict: {
               'instance': "{{ item.result.status.containerStatuses[0].name }}",
-              }
+            }
           with_items: "{{ server.results }}"
           register: instance_config_dict
 

collections/ansible_collections/sample_namespace/sample_collection/extensions/molecule/default/destroy.yml

@@ -22,7 +22,7 @@
       ansible.builtin.set_fact:
         instance_conf: {}
 
-    - name: Dump instance config
+    - name: Dump instance config  # noqa: no-handler
       ansible.builtin.copy:
         content: |
           # Molecule managed

collections/ansible_collections/sample_namespace/sample_collection/galaxy.yml

@@ -16,7 +16,7 @@ readme: README.md
 # A list of the collection's content authors. Can be just the name or in the format 'Full Name <email> (url)
 # @nicks:irc/im.site#channel'
 authors:
-- your name <[email protected]>
+  - your name <[email protected]>
 
 
 ### OPTIONAL but strongly recommended
@@ -26,15 +26,15 @@ description: your collection description
 # Either a single license or a list of licenses for content inside of a collection. Ansible Galaxy currently only
 # accepts L(SPDX,https://spdx.org/licenses/) licenses. This key is mutually exclusive with 'license_file'
 license:
-- GPL-2.0-or-later
+  - GPL-2.0-or-later
 
 # The path to the license file for the collection. This path is relative to the root of the collection. This key is
 # mutually exclusive with 'license'
 license_file: ''
 
 # A list of tags you want to associate with the collection for indexing/searching. A tag name has the same character
 # requirements as 'namespace' and 'name'
-tags: []
+tags: [linux, infrastructure]
 
 # Collections that this collection requires to be installed for it to be usable. The key of the dict is the
 # collection label 'namespace.name'. The value is a version range
@@ -66,4 +66,3 @@ build_ignore: []
 # 'omit_default_directives' is a boolean that controls whether the default directives are used. Mutually exclusive
 # with 'build_ignore'
 # manifest: null
-

collections/ansible_collections/sample_namespace/sample_collection/roles/backup_file/README.md

@@ -1,7 +1,7 @@
 backup_file
 =========
 
-Sample role to demonstrate running molecule inside of OpenShift Dev Spaces. Molecule is configured to leverage the downstream API to create containers in the user's devspace namespace. This role does not require elevated permissions or modifications to OpenShift. 
+Sample role to demonstrate running molecule inside of OpenShift Dev Spaces. Molecule is configured to leverage the downstream API to create containers in the user's devspace namespace. This role does not require elevated permissions or modifications to OpenShift.
 
 Requirements
 ------------

collections/ansible_collections/sample_namespace/sample_collection/roles/backup_file/molecule/default/create.yml

@@ -19,15 +19,15 @@
       ansible.builtin.debug:
         var: server
 
-    - name: Store container information # noqa: no-handler
+    - name: Store container information  # noqa: no-handler
       when: server.changed | default(false) | bool
       block:
 
         - name: Populate instance config dict
           ansible.builtin.set_fact:
             instance_conf_dict: {
               'instance': "{{ item.result.status.containerStatuses[0].name }}",
-              }
+            }
           with_items: "{{ server.results }}"
           register: instance_config_dict
 

collections/ansible_collections/sample_namespace/sample_collection/roles/backup_file/molecule/default/destroy.yml

@@ -22,7 +22,7 @@
       ansible.builtin.set_fact:
         instance_conf: {}
 
-    - name: Dump instance config
+    - name: Dump instance config  # noqa: no-handler
       ansible.builtin.copy:
         content: |
           # Molecule managed

collections/ansible_collections/sample_namespace/sample_collection/roles/backup_file/tests/inventory

@@ -1,2 +1 @@
 ubi8-int
-

devfile.yaml

@@ -91,7 +91,7 @@ commands:
         if [ ! -d "$HOME/.cache/ansible-navigator" ]; then
           mkdir -p "$HOME/.cache/ansible-navigator"
         fi
-        cp /usr/local/lib/python3.11/site-packages/ansible_navigator/data/catalog_collections.py $HOME/.cache/ansible-navigator 
+        cp /usr/local/lib/python3.11/site-packages/ansible_navigator/data/catalog_collections.py $HOME/.cache/ansible-navigator
         ansible-navigator --ee false
       workingDir: ${PROJECTS_ROOT}/ansible-devspaces-demo
       component: tooling-container

playbooks/install_oc.yml

@@ -19,13 +19,13 @@
         path: "{{ molecule_user_home_dir }}/bin"
         state: directory
         mode: 0770
-    
+
     - name: Download oc binary from OCP downloads svc endpoint
       ansible.builtin.get_url:
         url: http://downloads.openshift-console.svc.cluster.local/amd64/linux/oc
         dest: "{{ molecule_user_home_dir }}/bin/oc"
         mode: '0770'
-    
+
     - name: Add another bin dir to system-wide $PATH.
       ansible.builtin.lineinfile:
         path: "{{ molecule_user_home_dir }}/.bashrc"
@@ -36,4 +36,4 @@
       ansible.builtin.pip:
         name: "{{ molecule_pip_dependencies }}"
         state: present
-      when: molecule_pip_dependencies is defined
+      when: molecule_pip_dependencies is defined

requirements.txt

@@ -1,3 +1,4 @@
 kubernetes==26.1.0
 ansible-navigator==3.5.0
+pre-commit==3.6.0
 ansible-creator

syntax_highlighting_demo.yml

@@ -1,4 +1,7 @@
 ---
+# This is a sample playbook with linting issues.
+# This filename is excluded from ansible-lint so that the GitHub pipeline will pass.
+# Copy or rename this file to try ansible-lint and/or pre-commit.
 - name: Hello World Playbook
   hosts: all
   gather_facts: false
@@ -7,4 +10,4 @@
       ansible.builtin.debug:
         msg: "Hello World"
     - debug: 
-        msg: "I am poorly written"
+        msg: "I am poorly written"