AMW-621 amq collection spelling and grammar checking for PRs

Author: RanabirChakraborty

.cspell/custom-dictionary.txt

@@ -0,0 +1,67 @@
+# JWS / Tomcat / Ansible domain-specific words
+# Only terms NOT covered by built-in dictionaries
+
+# Product names and projects
+Wildfly
+Infinispan
+jolokia
+
+# Java / Tomcat terms
+aspectj
+beanutils
+cglib
+dbcp
+easymock
+hamcrest
+jaspic
+jaxb
+jaxen
+jaxrpc
+jaxws
+jdom
+jndi
+JNDI
+JSSE
+jstl
+juli
+mbeans
+objenesis
+oraclepki
+tagsoup
+tomcatjss
+xerces
+xpowered
+osgi
+keepgenerated
+changeit
+Jsps
+mappedfile
+
+# Ansible terms
+fqcn
+FQCN
+unarchived
+
+# WildFly / JBoss terms
+modcluster
+
+# Linux / System terms
+firewalld
+procps
+restorecon
+semanage
+semodule
+seport
+
+# Molecule testing
+preinstalledjdk
+
+# CI / DevOps
+sangonzal
+rootperm
+
+# RST / Sphinx directives
+toctree
+
+# Miscellaneous
+subcomponents

.github/workflows/ci.yml

@@ -9,6 +9,18 @@ on:
     - cron: '0 6 * * *'
 
 jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v7
+
+      - name: Run cspell
+        uses: streetsidesoftware/cspell-action@v9
+        with:
+          incremental_files_only: false
+          use_cspell_files: true
+
   ci:
     uses: ansible-middleware/github-actions/.github/workflows/ci.yml@rootperm
     secrets: inherit

README.md

@@ -26,7 +26,7 @@ The plug-ins and modules that are within a collection might be tested with speci
     - Installs JBoss Web Server from product archive files or RPM packages
     - Assigns ownership of the JBoss Web Server directories to the appropriate user account and group
     - Deploys the `server.xml`, `web.xml`, and `context.xml` files
-- The [jws_validation](https://github.com/ansible-middleware/jws/blob/main/roles/jws_validation/README.md) role contains a set of utility playbooks and tasks to validate that the server was properly installed on the target and is functionnal.
+- The [jws_validation](https://github.com/ansible-middleware/jws/blob/main/roles/jws_validation/README.md) role contains a set of utility playbooks and tasks to validate that the server was properly installed on the target and is functional.
 <!--end role_content -->
 
 ## Collection setup

cspell.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+  "version": "0.2",
+  "language": "en",
+  "ignorePaths": [
+    "changelogs/**",
+    "CHANGELOG.rst",
+    "roles/jws/templates/web.xml.j2"
+  ],
+  "files": [
+    "**/*.md",
+    "**/*.rst",
+    "roles/*/meta/argument_specs.yml",
+    "roles/*/meta/main.yml",
+    "roles/*/tasks/**/*.yml",
+    "roles/*/defaults/*.yml",
+    "roles/*/handlers/*.yml",
+    "roles/*/templates/*.j2",
+    "molecule/**/*.yml",
+    "molecule/**/*.j2",
+    "playbooks/**/*.yml",
+    "meta/runtime.yml",
+    "meta/execution-environment.yml",
+    ".github/workflows/*.yml",
+    ".github/ISSUE_TEMPLATE/*.md",
+    "galaxy.yml"
+  ],
+  "dictionaries": ["custom-jws", "java", "bash", "shellscript", "fullstack", "softwareTerms", "software-tools", "cpp-compound-words", "python", "docker", "k8s", "html", "css", "git", "networking-terms", "node", "npm"],
+  "dictionaryDefinitions": [
+    {
+      "name": "custom-jws",
+      "path": ".cspell/custom-dictionary.txt",
+      "addWords": true
+    }
+  ],
+  "ignoreRegExpList": [
+    "/\\{\\{.*?\\}\\}/g",
+    "/`[^`]+`/g",
+    "/(https?:\\/\\/[^\\s)]+)/g",
+    "/\\|`?[a-z_]+`?\\|/g",
+    "/\\[.*?\\]\\(.*?\\)/g",
+    "/^\\s*authors?:.*$/gm",
+    "/^\\s*-\\s+.*<[^>]+>.*$/gm"
+  ]
+}

molecule/override_server_xml/verify.yml

@@ -28,7 +28,7 @@
       ansible.builtin.set_fact:
         matches: "{{ slurped_server_xml['content'] | b64decode | regex_findall(jvm_route) }}"
 
-    - name: "Checks that occurence of {{ jvm_route }} was found."
+    - name: "Checks that occurrence of {{ jvm_route }} was found."
       ansible.builtin.assert:
         that:
           - matches is defined

roles/jws/meta/argument_specs.yml

@@ -26,7 +26,7 @@ argument_specs:
                 type: "bool"
             jws_install_download_archive_require_privilege_escalation:
                 default: True
-                description: "Whether or not to become root to donwload the archive"
+                description: "Whether or not to become root to download the archive"
                 type: "bool"
             jws_install_unarchive_require_privilege_escalation:
                 default: True
@@ -353,7 +353,7 @@ argument_specs:
             jws_systemd_script_shebang:
                 # line 54 of jws/defaults/main.yml
                 default: "#!/bin/{{ jws_systemd_script_interpreter }}"
-                description: "Customize sysVinit script sheband"
+                description: "Customize sysVinit script shebang"
                 type: "str"
             jws_service_name:
                 # line 55 of jws/defaults/main.yml
@@ -424,7 +424,7 @@ argument_specs:
         options:
             jws_skip_delete_zipfile:
                 required: False
-                description: "Whether to skip deleteion of zipfile when uninstalling"
+                description: "Whether to skip deletion of zipfile when uninstalling"
                 type: "bool"
             jws_home:
                 default: "{{ jws_install_dir }}/{{ jws_zipfile_rootdir }}"
@@ -446,7 +446,7 @@ argument_specs:
         options:
             jws_enable:
                 default: True
-                description: "Wheter or not to use JWS instead of uptream"
+                description: "Whether or not to use JWS instead of upstream"
                 type: "bool"
             jws_version:
                 default: "6.1.0"

roles/jws/tasks/apply_cp/apply_cp.yml

@@ -1,5 +1,5 @@
 ---
-- name: "Check prerequirements."
+- name: "Check prerequisites."
   ansible.builtin.include_tasks: prereqs.yml
 
 - name: "Download patches from RHN if requested."

roles/jws/tasks/main.yml

@@ -150,7 +150,7 @@
         - webapps
         - bin
 
-    - name: "Ensure {{ jws_home }}/ files have the recommended priviliges, owner and group"
+    - name: "Ensure {{ jws_home }}/ files have the recommended privileges, owner and group"
       become: "{{ jws_install_requires_become | default(true) }}"
       ansible.builtin.file:
         path: "{{ jws_home }}/{{ item }}"

roles/jws_validation/tasks/apply_cp.yml

@@ -1,5 +1,5 @@
 ---
-- name: "Check that required paramters have been provided."
+- name: "Check that required parameters have been provided."
   ansible.builtin.assert:
     that:
       - checksum_file_name is defined

roles/jws_validation/tasks/service_status.yml

@@ -19,6 +19,6 @@
       ansible.builtin.debug:
         var: catalina_out
 
-    - name: Fail after priting the logfile
+    - name: Fail after printing the logfile
       ansible.builtin.fail:
         msg: Service is not running or not enable