Run codespell

Signed-off-by: Cristian Le <[email protected]>
teemtee · Apr 4, 2024 · ecad6c4 · ecad6c4
1 parent 89fb7d9
commit ecad6c4
Show file tree

Hide file tree

Showing 71 changed files with 145 additions and 145 deletions.
diff --git a/docs/code/classes.rst b/docs/code/classes.rst
@@ -307,7 +307,7 @@ of default implementations.
     If you think of using ``to_dict()``, please, think again and be sure
     you know what are you doing. Despite its output being sometimes
     perfectly compatible with output of ``to_serialized()`` or ``to_spec()``,
-    it is not generaly true, and using it instead of proper methods may lead
+    it is not generally true, and using it instead of proper methods may lead
     to unexpected exceptions.
 
     The same applies to ``to_minimal_dict()``.

diff --git a/docs/contribute.rst b/docs/contribute.rst
@@ -218,11 +218,11 @@ provision-only
 
 Tags
 ------------------------------------------------------------------
-In additon to the tags related to the :ref:`provision-methods` tags,
+In addition to the tags related to the :ref:`provision-methods` tags,
 following are used in the tests:
 
 as_root
-    Test has to be executed as the root (or priviledged) user to
+    Test has to be executed as the root (or privileged) user to
     execute properly.  For example test adds user, changes the
     system, etc.
 

diff --git a/docs/examples.rst b/docs/examples.rst
@@ -223,7 +223,7 @@ tags and links. If ``id`` is not found in Polarion it's generated
 and exported.
 
 Argument ``--polarion-case-id`` can be provided multiple times to import
-multiple test cases and it supports setting of test names (seprated by ``:``),
+multiple test cases and it supports setting of test names (separated by ``:``),
 if test name is not provided ``Polarion WorkItem ID`` is used
 and lastly when ``--no-link-polarion`` is used ``summary`` is taken as test name.
 Examples how to use the import with multiple cases and test names:
@@ -750,7 +750,7 @@ available for binary status filtering:
     $ tmt stories show --documented
     /stories/cli/common/debug
          summary Print out everything tmt is doing
-           story I want to have common command line options consistenly used
+           story I want to have common command line options consistently used
                  across all supported commands and subcommands.
          example tmt run -d
                  tmt run --debug

diff --git a/docs/guide.rst b/docs/guide.rst
@@ -228,7 +228,7 @@ example of test metadata:
     require: wget
     duration: 1m
 
-Instead of writing the plan and test metadata manualy, you might
+Instead of writing the plan and test metadata manually, you might
 want to simply apply the ``base`` template which contains the plan
 mentioned above together with a test example including both test
 metadata and test script skeleton for inspiration:
@@ -406,7 +406,7 @@ Custom Templates
 
 If you create new tests often, you might want to create a custom
 template in order to get quickly started with a new test skeleton
-taylored exactly to your needs. The same applies for plans and
+tailored exactly to your needs. The same applies for plans and
 stories.
 
 Templates can be defined inside the config directory
@@ -945,7 +945,7 @@ Current Limits
 .. note::
 
     For the most up-to-date list of issues related to multihost,
-    our Github can display all isues with the `multihost`__ label.
+    our Github can display all issues with the `multihost`__ label.
 
 * requirements of all tests (:ref:`/spec/tests/require`,
   :ref:`/spec/tests/recommend`) are installed on all guests. See

diff --git a/docs/overview.rst b/docs/overview.rst
@@ -328,7 +328,7 @@ and only check for the exit code.
 1
     There was a fail or warn identified, but no error.
 2
-    Errors occured during test execution.
+    Errors occurred during test execution.
 3
     No test results found.
 4
@@ -425,7 +425,7 @@ TMT_GIT_CLONE_ATTEMPTS
     fails. By default, 3 attempts are done.
 
 TMT_GIT_CLONE_INTERVAL
-    The interval (in seconds) to retry clonning a git repository
+    The interval (in seconds) to retry cloning a git repository
     again, 10 seconds by default.
 
 TMT_GIT_CLONE_TIMEOUT

diff --git a/docs/plugins/index.rst b/docs/plugins/index.rst
@@ -10,7 +10,7 @@ Here you will find documentation for plugins shipped with tmt.
 
     Please, be aware that the documentation below is a work in progress. We are
     working on fixing it, adding missing bits and generally making it better.
-    Also, it was originaly used for command line help only, therefore the
+    Also, it was originally used for command line help only, therefore the
     formatting is often suboptional.
 
 .. toctree::

diff --git a/docs/releases.rst b/docs/releases.rst
@@ -15,7 +15,7 @@ the :ref:`/spec/plans/provision/beaker` provision plugin.
 The :ref:`/spec/plans/provision/virtual` provision plugin gains support
 for :ref:`TPM hardware requirement</spec/hardware/tpm>`. It is limited
 to TPM 2.0 for now, the future release of `testcloud`__, the
-library behing ``virtual`` plugin, will extend the support to more
+library behind ``virtual`` plugin, will extend the support to more
 versions.
 
 A new :ref:`watchdog test check<plugins/test-checks/watchdog>` has been
@@ -128,7 +128,7 @@ and let us know what you think! :)
 Now it's possible to use :ref:`custom_templates` when creating new
 tests, plans and stories. In this way you can substantially speed
 up the initial phase of the test creation by easily applying test
-metadata and test script skeletons taylored to your individual
+metadata and test script skeletons tailored to your individual
 needs.
 
 The :ref:`/spec/core/contact` key has been moved from the
@@ -143,7 +143,7 @@ containers as well.
 For the purpose of tmt exit code, ``info`` test results are no
 longer considered as failures, and therefore the exit code of tmt
 changes. ``info`` results are now treated as ``pass`` results, and
-would be counted towards the succesful exit code, ``0``, instead
+would be counted towards the successful exit code, ``0``, instead
 of the exit code ``2`` in older releases.
 
 The :ref:`/spec/plans/report/polarion` report now supports the

diff --git a/docs/templates/plugins.rst.j2 b/docs/templates/plugins.rst.j2
@@ -21,7 +21,7 @@
 
     Please, be aware that the documentation below is a work in progress. We are
     working on fixing it, adding missing bits and generally making it better.
-    Also, it was originaly used for command line help only, therefore the
+    Also, it was originally used for command line help only, therefore the
     formatting is often suboptional.
 
 {% if PLUGIN.__doc__ %}

diff --git a/docs/templates/story.rst.j2 b/docs/templates/story.rst.j2
@@ -83,7 +83,7 @@
     story, source file.
 
     If we're able to identify the object in story's tree, we will use its
-    :py:meth:`Core.web_link` method to get the proper URL. Othwerise, a URL
+    :py:meth:`Core.web_link` method to get the proper URL. Otherwise, a URL
     would be constructed from link's target.
 
     :param link: tmt.base.Link instance.

diff --git a/examples/l2/tooling.fmf b/examples/l2/tooling.fmf
@@ -1,7 +1,7 @@
 # Multiple tool support for test discovery & execution
 /test:
     /build:
-        # Standard Test Inteface
+        # Standard Test Interface
         /sti:
             execute:
                 how: sti

diff --git a/examples/manual/full.md b/examples/manual/full.md
@@ -15,7 +15,7 @@ Verify tmt shows help page
 tmt --help
 ```
 ## Expect
-Text similar to the one bellow is displayed
+Text similar to the one below is displayed
 ```
 Usage: tmt [OPTIONS] COMMAND [ARGS]...
 

diff --git a/examples/vagrant/Vagrantfile.real_prod b/examples/vagrant/Vagrantfile.real_prod
@@ -14,7 +14,7 @@
 # vagrant --use-staging up
 #
 # vagrant will prompt you for for fas username for auth to koji. Additionally
-# after the box is finished, you will need to aquire a kerberos ticket periodically
+# after the box is finished, you will need to acquire a kerberos ticket periodically
 # with `kinit <fasusername>@STG.FEDORAPROJECT.ORG` for bodhi to be able to auth with
 # the stg koji.
 

diff --git a/plans/provision/artemis/sanity.fmf b/plans/provision/artemis/sanity.fmf
@@ -2,7 +2,7 @@
     summary: Sanity tests of Artemis provision plugin
 
 /hardware:
-    summary: Sanity tests hardware requirements suport
+    summary: Sanity tests hardware requirements support
 
     provision:
         how: artemis

diff --git a/prepare/podman-images.sh b/prepare/podman-images.sh
@@ -7,7 +7,7 @@
 IMAGES=${IMAGES:-fedora centos:stream9}
 
 TOTAL=0
-SUCCESSFULL=0
+SUCCESSFUL=0
 
 set -x
 
@@ -24,13 +24,13 @@ for image in $IMAGES; do
         podman commit fresh "$image" &&
 
         # Count success and break or sleep a bit before the next attempt
-        SUCCESSFULL=$((SUCCESSFULL + 1)) && break
+        SUCCESSFUL=$((SUCCESSFUL + 1)) && break
         sleep 3
     done
 done
 
 set +x
 
 echo "Total: $TOTAL"
-echo "Successfull: $SUCCESSFULL"
-[[ "$SUCCESSFULL" == "$TOTAL" ]] && exit 0 || exit 1
+echo "Successful: $SUCCESSFUL"
+[[ "$SUCCESSFUL" == "$TOTAL" ]] && exit 0 || exit 1
diff --git a/spec/core/id.fmf b/spec/core/id.fmf
@@ -16,7 +16,7 @@ description: |
     to track the complete test execution history even if the test
     changed the location or name.
 
-    Must be a uniqe ``string``, using a `uuid`__ is recommended.
+    Must be a unique ``string``, using a `uuid`__ is recommended.
 
     __ https://fmf.readthedocs.io/en/latest/concept.html#identifiers
     __ https://en.wikipedia.org/wiki/Universally_unique_identifier

diff --git a/spec/plans/context.fmf b/spec/plans/context.fmf
@@ -6,7 +6,7 @@ story:
 
 description: |
     Define the default context values for all tests executed under
-    the given plan. Can be overriden by context provided directly
+    the given plan. Can be overridden by context provided directly
     on the command line. See the :ref:`/spec/context` definition
     for the full list of supported context dimensions. Must be a
     ``dictionary``.

diff --git a/spec/plans/discover.fmf b/spec/plans/discover.fmf
@@ -315,7 +315,7 @@ description: |
               - name: /print/pyproject
                 test: cat $TMT_SOURCE_DIR/tmt-*/pyproject.toml
       - |
-        # Just download sources, test is reponsible for rpmbuild
+        # Just download sources, test is responsible for rpmbuild
         # and running tests
         discover:
             how: shell

diff --git a/spec/plans/execute.fmf b/spec/plans/execute.fmf
@@ -211,7 +211,7 @@ description: |
     summary: Execute shell scripts
     story: As a user I want to easily run shell script as a test.
     description: |
-        Execute arbitratry shell commands and check their exit
+        Execute arbitrary shell commands and check their exit
         code which is used as a test result. The ``script`` field
         is provided to cover simple test use cases only and must
         not be combined with the :ref:`/spec/plans/discover` step

diff --git a/spec/plans/prepare.fmf b/spec/plans/prepare.fmf
@@ -7,7 +7,7 @@ description: |
 
     The :ref:`/spec/plans/prepare/install` plugin provides an easy
     way to install required or recommended packages from disk and
-    from the offical distribution or copr repositories. Use the
+    from the official distribution or copr repositories. Use the
     :ref:`/spec/plans/prepare/ansible` plugin for applying custom
     playbooks or execute :ref:`/spec/plans/prepare/shell` scripts
     to perform arbitrary preparation tasks.
@@ -115,7 +115,7 @@ example: |
         on the guest. They can either be specified using their
         names, paths to local rpm files or urls to remote rpms.
 
-        Additionaly, the ``directory`` attribute can be used to
+        Additionally, the ``directory`` attribute can be used to
         install all packages from the given directory. Copr
         repositories can be enabled using the ``copr`` attribute.
         Use the ``exclude`` option to skip selected packages from

diff --git a/spec/plans/report.fmf b/spec/plans/report.fmf
@@ -137,7 +137,7 @@ description:
         ## Simple upload with url and token exported in environment variable
         tmt run --all report --how reportportal --project=baseosqe
 
-        ## Upload with project name in fmf data, filtering out parameters (environemnt variables) that tend to be unique and break the history aggregation
+        ## Upload with project name in fmf data, filtering out parameters (environment variables) that tend to be unique and break the history aggregation
         tmt run --all report --how reportportal --exclude-variables="^(TMT|PACKIT|TESTING_FARM).*"
 
         ## Upload all plans as suites into one ReportPortal launch

diff --git a/stories/cli/common.fmf b/stories/cli/common.fmf
@@ -1,5 +1,5 @@
 story:
-    I want to have common command line options consistenly
+    I want to have common command line options consistently
     used across all supported commands and subcommands.
 
 /verbose:

diff --git a/stories/cli/config.fmf b/stories/cli/config.fmf
@@ -13,7 +13,7 @@ description:
     description:
         Global default values common for all users on the system
         should be stored under the ``/etc/tmt`` folder. It is
-        overriden by user configuration if present.
+        overridden by user configuration if present.
     example: |
         provision:
             how: container

diff --git a/stories/cli/try.fmf b/stories/cli/try.fmf
@@ -63,7 +63,7 @@ link:
 
     description: |
         Sometimes it's handy to be able to quickly spawn a new
-        clean guest and start experimeting in the sand box. Run
+        clean guest and start experimenting in the sand box. Run
         the ``tmt try`` command in a directory without tests or
         explicitly ask for interactive shell with ``--login``.
 

diff --git a/stories/cli/usability.fmf b/stories/cli/usability.fmf
@@ -21,6 +21,6 @@ story:
 
 /completion:
     summary: Support bash completion
-    example: tmt st<tabl> sh<tab>
+    example: tmt st<table> sh<tab>
     link:
       - implemented-by: /tmt.spec
diff --git a/stories/deferred/restraint.fmf b/stories/deferred/restraint.fmf
@@ -12,7 +12,7 @@ description: |
     ``rstrnt-report-result``.
 
     Although implementation of the full execute step plugin has
-    been deferred, backward compatiblity scripts have been
+    been deferred, backward compatibility scripts have been
     provided for several most commonly used restraint commands:
 
     rstrnt-abort

diff --git a/stories/docs.fmf b/stories/docs.fmf
@@ -23,7 +23,7 @@ story:
         As a command line user I want to check the man page to get
         a basic overview about the tool.
     description:
-        There should be a manual page availabe in the package.
+        There should be a manual page available in the package.
         Man page should contain brief introduction about the tool
         and a list of essential commands and options.
     example:

diff --git a/stories/features/reboot.fmf b/stories/features/reboot.fmf
@@ -20,7 +20,7 @@ description: |
     "dnf system-upgrade reboot"``.
 
     In some scenarios, rebooting may take longer than usual. The
-    default timeout used in tmt can be overriden using the ``-t``
+    default timeout used in tmt can be overridden using the ``-t``
     option of the reboot script, e.g. ``tmt-reboot -t 3600`` to
     wait for up to an hour for the guest to come back up.
 

diff --git a/tests/core/environment-file/main.fmf b/tests/core/environment-file/main.fmf
@@ -3,5 +3,5 @@ description:
     Verify that
     - environment-file can get vars from the file and url of dotenv and yaml fmts
     - environment option takes precedence over environment-file
-    - cli specified options takes precendence over fmf one
+    - cli specified options takes precedence over fmf one
 require: python3-pytest
diff --git a/tests/core/plan-env-file/test.sh b/tests/core/plan-env-file/test.sh
@@ -25,21 +25,21 @@ rlJournalStart
         rlAssertGrep 'total: 1 test passed' $rlRun_LOG
     rlPhaseEnd
 
-    rlPhaseStartTest 'Check environment variable is overriden by "environment-file" key'
+    rlPhaseStartTest 'Check environment variable is overridden by "environment-file" key'
         rlRun -s 'tmt run -rvvv plan --name /plan/env-file-override'
         rlAssertGrep 'MYVAR1="MYVAR1_OVERRIDE"' $rlRun_LOG
         rlAssertGrep 'FINISH1="MYVAR1_OVERRIDE"' $rlRun_LOG
         rlAssertGrep 'total: 1 test passed' $rlRun_LOG
     rlPhaseEnd
 
-    rlPhaseStartTest 'Check environment variable is overriden by "environment" key'
+    rlPhaseStartTest 'Check environment variable is overridden by "environment" key'
         rlRun -s 'tmt run -rvvv plan --name /plan/env-override'
         rlAssertGrep 'MYVAR1="MYVAR1_OVERRIDE"' $rlRun_LOG
         rlAssertGrep 'FINISH1="MYVAR1_OVERRIDE"' $rlRun_LOG
         rlAssertGrep 'total: 1 test passed' $rlRun_LOG
     rlPhaseEnd
 
-    rlPhaseStartTest 'Check environment variable is overriden by command line'
+    rlPhaseStartTest 'Check environment variable is overridden by command line'
         rlRun -s 'tmt run -rvvv -e MYVAR1=MYVAR1_OVERRIDE plan --name /plan/multiple'
         rlAssertGrep 'MYVAR1="MYVAR1_OVERRIDE"' $rlRun_LOG
         rlAssertGrep 'MYVAR2="MYVAR2_VALUE"' $rlRun_LOG

diff --git a/tests/discover/data/plans.fmf b/tests/discover/data/plans.fmf
@@ -148,7 +148,7 @@ execute:
                 discover:
                     how: fmf
                     ref: eae4d52
-                    path: (overriden by --path)
+                    path: (overridden by --path)
             /nopath:
                 discover:
                     how: fmf
@@ -157,7 +157,7 @@ execute:
             /path:
                 discover:
                     how: fmf
-                    path: (overriden by --path)
+                    path: (overridden by --path)
             /nopath:
                 discover:
                     how: fmf

diff --git a/tests/execute/result/custom.sh b/tests/execute/result/custom.sh
@@ -6,7 +6,7 @@ rlJournalStart
     rlPhaseStartSetup
         rlRun "pushd custom"
         rlRun "set -o pipefail"
-        rlRun "run=\$(mktemp -d)" 0 "Creating run direcotory/id"
+        rlRun "run=\$(mktemp -d)" 0 "Creating run directory/id"
     rlPhaseEnd
 
     tmt_command="tmt run --scratch -a --id ${run} provision --how local execute -vv report -vv test --name"

diff --git a/tests/lint/test/data/manual_test_failed/test.md b/tests/lint/test/data/manual_test_failed/test.md
@@ -16,7 +16,7 @@ tmt --help
 
 
 ## Expect
-Text similar to the one bellow is displayed
+Text similar to the one below is displayed
 ```
 Usage: tmt [OPTIONS] COMMAND [ARGS]...