Use codespell in Robottelo (#18915)

Author: jameerpathan111

.pre-commit-config.yaml

@@ -31,3 +31,11 @@ repos:
     rev: v8.27.2
     hooks:
       - id: gitleaks
+  - repo: https://github.com/codespell-project/codespell
+    rev: v2.4.1
+    hooks:
+      - id: codespell
+        args:
+          - --skip=*hammer_commands.json,*.xml
+          - -L=Thirdparty,ACSes,checkin,cockateel
+          - -w

conf/ldap.yaml.template

@@ -13,6 +13,6 @@ LDAP:
       2019:  192.168.0.3 # <ip_address of 2019 ad server>
   NAMESERVER6:
       2019: 2001::beef:face # <ip6_address of 2019 ad server>
-  WORKGROUP:  # udpate with ldap server's domain name
+  WORKGROUP:  # update with ldap server's domain name
       2016:  FOO # <workgroup 2016 server>
       2019:  FOO19 # <workgroup 2019 server>

conf/server.yaml.template

@@ -61,7 +61,7 @@ SERVER:
   SSH_CLIENT:
     # Specify port number for ssh client, Default: 22
     PORT:
-    # Time to wait for the ssh command to finish, in miliseconds
+    # Time to wait for the ssh command to finish, in milliseconds
     COMMAND_TIMEOUT: 300000
     # Time to wait for establishing the ssh connection, in seconds
     CONNECTION_TIMEOUT: 60

docs/code_standards.rst

@@ -45,7 +45,7 @@ Strings
 * Use string methods instead of the string module.
 * Use f-strings for string formatting whenever possible.
 * Use the string's format method when an f-string would become too complex.
-* When using format, leave out indices, unless absolutely necessary (e.g. variable re-use).
+* When using format, leave out indices, unless absolutely necessary (e.g. variable reuse).
 
   * Keyword vs positional index preference is up to the reviewers.
 

docs/committing.rst

@@ -55,8 +55,8 @@ missing docstrings.
 :code:`test-robottelo` will run all the tests created to ensure Robottelo is
 working as expected. If you added a test, it will be run now.
 
-Peforming the commit
---------------------
+Performing the commit
+---------------------
 
 Proper commit messages
 

docs/features/commands.rst

@@ -83,7 +83,7 @@ In the subgroup `ui` you can find the `browse` command which opens the same
 interactive shell but it also opens a new browser instance and gives you
 the context to play with this.
 
-The interaction with the `ui` browser is done trough the `session` object, and
+The interaction with the `ui` browser is done through the `session` object, and
 the opened browser uses the configuration from your `robottelo.properties` file.
 
 Open a new REPL connected to a browser session:
@@ -112,7 +112,7 @@ Open a new REPL connected to a browser session:
     2016-09-16 14:05:46 - robottelo.ui.browser - DEBUG - logout
     2016-09-16 14:05:46 - robottelo.ui.browser - DEBUG - Close Browser
 
-While you interact wth the UI using the helpers as the ones in the exemple above
+While you interact with the UI using the helpers as the ones in the example above
 you see your browser window changing interactively, if you prefer to use a docker browser
 it is possible to connect via VNC or get screenshots calling :code:`session.browser.save_screenshot()`
 

pytest_fixtures/component/repository.py

@@ -135,7 +135,7 @@ class constructor arguments. It can create multiple repos with distro.
     """
     _repos = []
     repo_distro = None
-    # Iterating over repository thats requested more than once
+    # Iterating over repository that's requested more than once
     for repo_name, repo_options in repos.items():
         if isinstance(repo_options, list):
             [_repos.append({repo_name: options}) for options in repo_options]

pytest_fixtures/core/sat_cap_factory.py

@@ -389,7 +389,7 @@ def installer_satellite(request):
         ).get_command(),
         timeout='30m',
     )
-    # exit code 0 means no changes, 2 means changes were applied succesfully
+    # exit code 0 means no changes, 2 means changes were applied successfully
     assert installer_result.status in (0, 2), installer_result.stdout
 
     sat.enable_satellite_ipv6_http_proxy()

pytest_plugins/fixture_markers.py

@@ -155,7 +155,7 @@ def pytest_collection_modifyitems(session, items, config):
     from pytest_fixtures.core import contenthosts
 
     def chost_rhelver(params):
-        """Helper to retrive the rhel_version of a client from test params"""
+        """Helper to retrieve the rhel_version of a client from test params"""
         for param in params:
             if 'contenthost' in param:
                 return params[param].get('rhel_version')

pytest_plugins/jira_comments.py

@@ -15,7 +15,7 @@ def pytest_addoption(parser):
     help_comment = (
         'Report/Comment test results on Jira issues.\n'
         'Results for tests marked with "Verifies" or "BlockedBy" doc fields will be commented on the corresponding Jira issues. '
-        'This behaviour can be overriden by providing a comma separated list of jira issue ids.\n'
+        'This behaviour can be overridden by providing a comma separated list of jira issue ids.\n'
         'Note: To prevent accidental use, users must set ENABLE_COMMENT to true in the jira.yaml configuration file.'
     )
     parser.addoption(