OPSEXP-1754 Add some generic pre-commit hooks (#456)

.gitattributes

@@ -1 +1 @@
-text eol=lf
+text eol=lf

.github/actions/pipenv/action.yml

@@ -3,10 +3,10 @@ description: 'Install python packages with pipenv'
 
 runs:
   using: "composite"
-  steps: 
+  steps:
   - name: Install pipenv
     shell: bash
     run: pip install --user pipenv
   - name: Install packages from Pipfile
     shell: bash
-    run: pipenv install --deploy --dev
+    run: pipenv install --deploy --dev

.github/workflows/community.yml

@@ -80,4 +80,3 @@ jobs:
           max_attempts: 3
           retry_wait_seconds: 10
           command: cd roles/${{ matrix.role.name }} && pipenv run molecule test
-

.github/workflows/precommit.yml

@@ -16,4 +16,4 @@ jobs:
       with:
         python-version-file: '.python-version'
 
-    - uses: pre-commit/action@v3.0.0
+    - uses: pre-commit/action@v3.0.0

.gitignore

@@ -1,4 +1,4 @@
-# project specifics 
+# project specifics
 configuration_files/ssl_certificates/
 configuration_files/keystores/
 dtas

.pre-commit-config.yaml

@@ -1,9 +1,24 @@
 ---
 repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.2.0
+    hooks:
+      - id: check-yaml
+        args: [--allow-multiple-documents]
+      - id: check-json
+      - id: check-xml
+      - id: check-merge-conflict
+      - id: fix-byte-order-marker
+      - id: mixed-line-ending
+        args: ["--fix=lf"]
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
   - repo: https://github.com/Riverside-Healthcare/djLint
     rev: v1.18.0
     hooks:
       - id: djlint-jinja
+
   - repo: https://github.com/jackdewinter/pymarkdown
     rev: v0.9.6
     hooks:

configuration_files/alfresco-global.properties

@@ -1 +1 @@
-# Add your properties here
+# Add your properties here

docs/SECRETS.md

@@ -31,7 +31,7 @@ that must be handled as secrets:
 
 ```yml
 acs_environment:
-  JAVA_TOOL_OPTIONS: 
+  JAVA_TOOL_OPTIONS:
     - -Dmetadata-keystore.password=<your-keystore-password>
     - -Dmetadata-keystore.metadata.password=<your-keystore-password>
 ```

docs/resources/acs-ha.puml

@@ -91,28 +91,28 @@ storage "NFS" as nfs
 
 note top of repolb
 This is a single point of failure
-so customers may wish to replace 
+so customers may wish to replace
 this with Nginx Plus and use its
 HA features.
 end note
 
 note top of searchlb
 This is a single point of failure
-so customers may wish to replace 
+so customers may wish to replace
 this with Nginx Plus and use its
 HA features.
 end note
 
 note top of transformlb
 This is a single point of failure
-so customers may wish to replace 
+so customers may wish to replace
 this with Nginx Plus and use its
 HA features.
 end note
 
 note top of synclb
 This is a single point of failure
-so customers may wish to replace 
+so customers may wish to replace
 this with Nginx Plus and use its
 HA features.
 end note

docs/resources/ansible-overview.puml

@@ -15,4 +15,4 @@ User -> playbook
 playbook --> host1
 playbook --> hostN
 
-@enduml
+@enduml

docs/resources/deployment-type-local.puml

@@ -29,4 +29,4 @@ playbook -down-> role1 : local
 playbook -down-> role2 : local
 
 
-@enduml
+@enduml

docs/resources/deployment-type-ssh.puml

@@ -32,4 +32,4 @@ playbook -down-> host1role1 : ssh
 playbook -down-> host2role2 : ssh
 
 
-@enduml
+@enduml

docs/resources/playbook-overview.puml

@@ -16,4 +16,4 @@ rectangle "Playbook" as playbook #Ivory {
     }
 }
 
-@enduml
+@enduml

galaxy.yml

@@ -17,7 +17,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:
-- Sergiu Vidrascu 
+- Sergiu Vidrascu
 - Lucian Suciu
 - Andrei Ciubotaru
 - Alexandre Chapellon

molecule/default/molecule.yml

@@ -37,7 +37,7 @@ provisioner:
     - -e
     - "@tests/test-ssl.yml"
   inventory:
-    links: 
+    links:
       group_vars: ../../group_vars
   playbooks:
     converge: ../../playbooks/acs.yml

molecule/default/vars-centos7.yml

@@ -1,4 +1,4 @@
 MOLECULE_IT_IMAGE_ID: ami-0b850cf02cc00fdc8
 MOLECULE_IT_EXTRA_VARS: 6.2.N-extra-vars.yml
 MOLECULE_IT_TEST_CONFIG: tests/test-config-acs6-stack.json
-MOLECULE_IT_PLATFORM: centos7
+MOLECULE_IT_PLATFORM: centos7

molecule/default/vars-ubuntu20.yml

@@ -1,4 +1,4 @@
 MOLECULE_IT_IMAGE_ID: ami-081ff4b9aa4e81a08
 MOLECULE_IT_EXTRA_VARS: tests/test-extra-vars.yml
 MOLECULE_IT_TEST_CONFIG: tests/test-config.json
-MOLECULE_IT_PLATFORM: ubuntu20
+MOLECULE_IT_PLATFORM: ubuntu20

molecule/multimachine/molecule.yml

@@ -130,7 +130,7 @@ provisioner:
     - -e
     - "@tests/test-ssl.yml"
   inventory:
-    links: 
+    links:
       group_vars: ../../group_vars
       host_vars: ./host_vars
       hosts: ./hosts.yml

molecule/multimachine/prepare.yml

@@ -17,7 +17,7 @@
             filters:
               "tag:Name": molecule_{{ lookup('ansible.builtin.env', 'MOLECULE_IT_PLATFORM') }}_repo_{{ lookup('ansible.builtin.env', 'BRANCH_NAME') }}_{{ lookup('ansible.builtin.env', 'BUILD_NUMBER') }}
           register: molecule_ec2
-    
+
         - name: Create Shared contentstore
           community.aws.efs:
             state: present
@@ -30,7 +30,7 @@
               Owner: Ops Readiness Team
               Department: Engineering
               Production: false
-          loop: 
+          loop:
             - "{{ molecule_yml.platforms | selectattr('name', 'in', groups.repository) | first }}"
           register: contentstore
 

playbooks/check-versions.yml

@@ -4,22 +4,22 @@
   tasks:
     - name: Fail if Ansible version is too old
       ansible.builtin.fail:
-        msg: 
+        msg:
           - "Installed Ansible version ({{ ansible_version.major }}.{{ ansible_version.minor  }}) is too old. Upgrade to at least 2.12."
           - "Please refer to https://github.com/Alfresco/alfresco-ansible-deployment/blob/master/docs/deployment-guide.md#setup-a-control-node for detailed instructions."
       when: (ansible_version.major < 2) or
             (ansible_version.major == 2 and ansible_version.minor < 12)
 
     - name: Check Jinja2 version
-      ansible.builtin.shell: | 
+      ansible.builtin.shell: |
         JINJA_VERSION=$(pip3 freeze | grep Jinja2 | sed 's/Jinja2==//g')
         echo $JINJA_VERSION
       register: jinja2_version
       changed_when: false
 
     - name: Fail if Jinja2 version is too old
       ansible.builtin.fail:
-        msg: 
+        msg:
           - "Installed Jinja2 version ({{ jinja2_version.stdout }}) is too old. Upgrade to at least version 3."
           - "Please refer to https://github.com/Alfresco/alfresco-ansible-deployment/blob/master/docs/deployment-guide.md#setup-a-control-node for detailed instructions."
       when: (jinja2_version.stdout.split('.')[0] | int < 3)

playbooks/handlers/uninstall-handlers.yml

@@ -1,4 +1,4 @@
 ---
 - name: Reload systemd
-  ansible.builtin.systemd: 
-    daemon_reload: yes
+  ansible.builtin.systemd:
+    daemon_reload: yes

playbooks/platform-cleanup.yml

@@ -5,11 +5,11 @@
     artifacts_path: "{{ download_location | default('/tmp/ansible_artefacts') }}"
    become: no
    tasks:
-     - name: To display warning 
+     - name: To display warning
        debug:
          msg: '[WARNING]: This will remove the downloaded artifacts from your system'
 
      - name: Removing "{{ artifacts_path }}"
        ansible.builtin.file:
         path: "{{ artifacts_path }}"
-        state: "absent"
+        state: "absent"

playbooks/prerequisite-checks.yml

@@ -124,7 +124,7 @@
     vars:
       checked_host: "{% if groups.syncservice | length == 0 %}127.0.0.1{% else %}{{ hostvars[groups.syncservice[0]].ansible_host | default('127.0.0.1') }}{% endif %}"
       checked_port: "{{ ports_cfg.sync.http }}"
-      delegate_target: "{{ groups.syncservice | first }}"  
+      delegate_target: "{{ groups.syncservice | first }}"
   - name: check adw connection
     include_tasks: "../roles/helper_modules/tasks/check_port.yml"
     vars:

requirements.yml

@@ -22,4 +22,4 @@ roles:
   - name: buluma.elastic_repo
     version: v0.1.2
   - name: buluma.elasticsearch
-    version: 1.0.2
+    version: 1.0.2

roles/activemq/defaults/main.yml

@@ -4,7 +4,7 @@ activemq_base: "{{ config_folder }}/activemq"
 activemq_conf: "{{ config_folder }}/activemq/conf"
 activemq_data: "{{ data_folder }}/activemq/data"
 activemq_tmp: "{{ data_folder }}/activemq/tmp"
-activemq_environment:                                                                                                                                                                                                                                                         
+activemq_environment:
   ACTIVEMQ_OPTS:
     - -Xms128m
     - -Xmx1g

roles/activemq/handlers/main.yml

@@ -7,7 +7,7 @@
     enabled: true
     state: started
     daemon_reload: true
-    
+
 - name: restart-activemq
   become: true
   service:

roles/activemq/templates/activemq.service.j2

@@ -9,4 +9,4 @@ ExecStart={{ binaries_folder }}/activemq.sh start
 ExecStop={{ binaries_folder }}/activemq.sh stop
 
 [Install]
-WantedBy=multi-user.target
+WantedBy=multi-user.target

roles/activemq/vars/main.yml

@@ -1,3 +1,3 @@
 ---
 # vars file for roles/activemq
-activemq_home: "/opt/apache-activemq-{{ dependencies_version.activemq }}"
+activemq_home: "/opt/apache-activemq-{{ dependencies_version.activemq }}"

roles/adw/handlers/main.yml

@@ -9,7 +9,7 @@
 
 - name: restart-nginx
   become: true
-  service: 
-    name: nginx 
+  service:
+    name: nginx
     state: restarted
     daemon_reload: true

roles/adw/molecule/default/converge.yml

@@ -4,4 +4,4 @@
   tasks:
     - name: "Include adw"
       include_role:
-        name: "adw"
+        name: "adw"

roles/adw/molecule/default/molecule.yml

@@ -18,7 +18,7 @@ platforms:
 provisioner:
   name: ansible
   inventory:
-    links: 
+    links:
       host_vars: host_vars
       group_vars: ../../../../group_vars
 verifier:

roles/adw/templates/nginx.conf

@@ -32,4 +32,3 @@ http {
     include /etc/nginx/conf.d/*.conf;
 
     }
-

roles/common/handlers/main.yml

@@ -1,2 +1,2 @@
 ---
-# handlers file for roles/common
+# handlers file for roles/common

roles/common/molecule/default/molecule.yml

@@ -23,7 +23,7 @@ provisioner:
     defaults:
       pipelining: True
   inventory:
-    links: 
+    links:
       group_vars: ../../../../group_vars
       host_vars: host_vars
 verifier:

roles/common/molecule/default/tests/test_common.py

@@ -41,4 +41,3 @@ def test_logs_folder_exists(host, get_ansible_vars):
     """Check that logs folder exists"""
     assert_that(host.file(get_ansible_vars["logs_folder"]).exists)
     assert_that(host.file(get_ansible_vars["logs_folder"]).user, equal_to(get_ansible_vars["username"]))
-

roles/common/vars/CentOS7.yml

@@ -7,4 +7,4 @@ utils:
   - libselinux-python
   - libsemanage-python
   - gpg
-  - curl
+  - curl

roles/common/vars/Debian.yml

@@ -8,4 +8,4 @@ utils:
   - python3-selinux
   - python3-semanage
   - gpg
-  - curl
+  - curl

roles/common/vars/RedHat7.yml

@@ -6,4 +6,4 @@ utils:
   - libselinux-python
   - libsemanage-python
   - gpg
-  - curl
+  - curl

roles/common/vars/RedHat8.yml

@@ -6,4 +6,4 @@ utils:
   - python3-libselinux
   - python3-libsemanage
   - gpg
-  - curl
+  - curl

roles/java/molecule/default/molecule.yml

@@ -21,7 +21,7 @@ provisioner:
     defaults:
       pipelining: True
   inventory:
-    links: 
+    links:
       group_vars: ../../../../group_vars
       host_vars: host_vars
 verifier:

roles/java/templates/setenv.sh

@@ -1,4 +1,4 @@
 #!/bin/sh
 
 export JAVA_HOME="{{ java_home }}"
-export PATH="${JAVA_HOME}/bin:${PATH}"
+export PATH="${JAVA_HOME}/bin:${PATH}"