chore: fix spellcheck errors and enable cspell (#217)

* Misc Typo fixes Signed-off-by: Abhijeet Kasurde <[email protected]> * Enable cspell * Ignore requirements.txt Signed-off-by: Abhijeet Kasurde <[email protected]> --------- Signed-off-by: Abhijeet Kasurde <[email protected]> Co-authored-by: Sorin Sbarnea <[email protected]>
ansible · Aug 3, 2024 · 519a3d2 · 519a3d2
1 parent 14306fa
commit 519a3d2
Show file tree

Hide file tree

Showing 16 changed files with 84 additions and 16 deletions.
diff --git a/.config/dictionary.txt b/.config/dictionary.txt
@@ -0,0 +1,41 @@
+-CAcreateserial
+-Djava
+GSSAPI
+OAUTHBEARER
+alertmanager
+basepython
+benthomasosn
+cafile
+capath
+caroot
+confluentinc
+conninfo
+darglint
+digestmod
+dynatrace
+envlist
+extfile
+finito
+healthcheck
+jaas
+keypass
+keytool
+libsystemd
+mydb
+myqueue
+nada
+noprompt
+parseable
+posargs
+pythonmain
+realworld
+rulebook
+rulebooks
+ruleset
+servicebus
+snakeoil
+storepass
+testenv
+toxinidir
+trustore
+truststore
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -58,7 +58,7 @@ body:
     id: expected-results
     attributes:
       label: Expected results
-      description: What did you expect to happpen when running the steps above?
+      description: What did you expect to happen when running the steps above?
     validations:
       required: true
 

diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -6,7 +6,7 @@ contact_links:
 
   - name: 📝 Ansible Code of Conduct
     url: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html?utm_medium=github&utm_source=issue_template_chooser
-    about: EDA-Controlles uses the Ansible Code of Conduct; ❤ Be nice to other members of the community. ☮ Behave.
+    about: EDA-Controller uses the Ansible Code of Conduct; ❤ Be nice to other members of the community. ☮ Behave.
 
   - name: 💼 For Enterprise
     url: https://www.ansible.com/use-cases/event-driven-automation

diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml
@@ -60,9 +60,9 @@ body:
       required: true
 
   - type: textarea
-    id: sugested-results
+    id: suggested-results
     attributes:
-      label: Sugested feature result
+      label: Suggested feature result
       description: What is the result this new feature will bring?
     validations:
       required: true

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -11,7 +11,10 @@ repos:
       - id: trailing-whitespace
       - id: end-of-file-fixer
         language_version: python3
-
+  - repo: https://github.com/streetsidesoftware/cspell-cli
+    rev: v8.13.0
+    hooks:
+      - id: cspell
   - repo: local
     hooks:
       - id: ansible-test-sanity

diff --git a/cspell.config.yaml b/cspell.config.yaml
@@ -0,0 +1,23 @@
+---
+dictionaryDefinitions:
+  - name: words
+    path: .config/dictionary.txt
+    addWords: true
+dictionaries:
+  # Use `cspell-cli trace word` to check where a work is defined
+  - en_US
+  - bash
+  - words
+  - python
+ignorePaths:
+  - cspell.config.yaml
+  # The requirements file
+  - requirements.txt
+  - .config/constraints.txt
+  - docs/requirements.txt
+  - docs/requirements.in
+  # Test fixtures generated from outside
+  - test/**/*.result
+  - src/ansiblelint/schemas/*.json
+  # Other
+  - "*.svg"
diff --git a/extensions/eda/plugins/event_filter/insert_hosts_to_meta.py b/extensions/eda/plugins/event_filter/insert_hosts_to_meta.py
@@ -9,7 +9,7 @@
     host_path:      The json path inside the event data to find hosts.
                     Do nothing if the key is not present or does exist in event
     path_separator: The separator to interpret host_path. Default to "."
-    host_separator: The separator to interpet host string.
+    host_separator: The separator to interpret host string.
                     host_path can point to a string or a list. If it is a single
                     string but contains multiple hosts, use this parameter to
                     delimits the hosts. Treat the vale as a single host if the

diff --git a/extensions/eda/plugins/event_filter/normalize_keys.py b/extensions/eda/plugins/event_filter/normalize_keys.py
@@ -1,7 +1,7 @@
 """normalize_keys.py.
 
     An event filter that changes keys that contain non alpha numeric or
-    underscore to undersocres.
+    underscore to underscores.
     For instance, the key server-name becomes the new key server_name
     If there are consecutive non alpa numeric or under score, they would
     be coalesced into a single underscore

diff --git a/extensions/eda/plugins/event_source/aws_cloudtrail.py b/extensions/eda/plugins/event_source/aws_cloudtrail.py
@@ -12,7 +12,7 @@
     delay_seconds: The number of seconds to wait between polling (default 10sec)
 
     lookup_attributes:  The optional list of lookup attributes.
-                        lookup attribute are dictionnary with an AttributeKey (string),
+                        lookup attribute are dictionary with an AttributeKey (string),
                         which specifies an attribute on which to filter the events
                         returned and an AttributeValue (string) which specifies
                         a value for the specified AttributeKey

diff --git a/extensions/eda/plugins/event_source/aws_sqs_queue.py b/extensions/eda/plugins/event_source/aws_sqs_queue.py
@@ -56,7 +56,7 @@ async def main(queue: asyncio.Queue, args: dict[str, Any]) -> None:
         queue_url = response["QueueUrl"]
 
         while True:
-            # This loop wont spin really fast as there is
+            # This loop won't spin really fast as there is
             # essentially a sleep in the receive_message call
             response = await client.receive_message(
                 QueueUrl=queue_url,

diff --git a/extensions/eda/plugins/event_source/generic.py b/extensions/eda/plugins/event_source/generic.py
@@ -21,11 +21,11 @@
                    next set of events. Default 0
 shutdown_after float Number of seconds to wait before shutting down the
                    plugin. Default 0
-loop_count int     Number of times the set of events in the playload
+loop_count int     Number of times the set of events in the payload
                    should be repeated. Default 0
-repeat_count int   Number of times each individual event in the playload
+repeat_count int   Number of times each individual event in the payload
                    should be repeated. Default 1
-blob_size int      An arbitray blob of blob_size bytes to be inserted
+blob_size int      An arbitrary blob of blob_size bytes to be inserted
                    into every event payload. Default is 0 don't create
                    a blob
 final_payload dict After all the events have been sent we send the optional

diff --git a/extensions/eda/plugins/event_source/pg_listener.py b/extensions/eda/plugins/event_source/pg_listener.py
@@ -19,7 +19,7 @@
 Chunking:
 ---------
    This is just informational a user doesn't have to do anything
-   special to enablo chunking. The sender which is the pg_notify
+   special to enable chunking. The sender which is the pg_notify
    action from ansible rulebook will decide if chunking needs to
    happen based on the size of the payload.
    If the messages are over 7KB the sender will chunk the messages

diff --git a/plugins/modules/upcase.py b/plugins/modules/upcase.py
@@ -24,7 +24,7 @@
 
 version_added: "1.0.0"
 
-description: Upper cases a passed in string, if the passed in string is already uppercased changed is set to false.
+description: Upper cases a passed in string, if the passed in string is already uppercase, changed is set to false.
     To have the module generate an error send the string fail
 
 options:

diff --git a/requirements.txt b/requirements.txt
@@ -4,8 +4,8 @@ aiokafka
 azure-servicebus
 dpath
 kafka-python
+psycopg
 pyyaml
 systemd-python; sys_platform != 'darwin'
 watchdog
-psycopg
 xxhash
diff --git a/tests/integration/event_source_kafka/certs-create.sh b/tests/integration/event_source_kafka/certs-create.sh
@@ -1,6 +1,7 @@
 #!/usr/bin/env bash
 # Generate self-signed certificate for Kafka broker
 # Greatly inspired by https://github.com/ansibleinc/cp-demo/blob/master/scripts/security/certs-create-per-user.sh
+# cspell: ignore keyout passin passout genkey keyalg trustore storetype pkcs certreq srand
 set -e
 
 CA_PATH=$(dirname "${BASH_SOURCE[0]}")

diff --git a/tests/integration/event_source_url_check/test_url_check_source.py b/tests/integration/event_source_url_check/test_url_check_source.py
@@ -35,7 +35,7 @@ def init_webserver():
     "endpoint, expected_resp_data",
     [
         pytest.param("", "Endpoint available", id="valid_endpoint"),
-        pytest.param("nonexistant", "Endpoint unavailable", id="invalid_endpoint"),
+        pytest.param("nonexistent", "Endpoint unavailable", id="invalid_endpoint"),
     ],
 )
 def test_url_check_source_sanity(