diff --git a/docs/code/classes.rst b/docs/code/classes.rst index 6cd2e9e4a6..a085afcf8f 100644 --- 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 index b933560a75..bee36f0078 100644 --- 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 index 9b9687a4ae..c68dbe8e44 100644 --- 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 index 3c87184dbe..1045d05fe0 100644 --- 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 index 89e5512892..37a1e5a940 100644 --- 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 index 8366514a61..8626c44d91 100644 --- 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 index 246e72acff..bcc770203e 100644 --- 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`. 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` 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 index 3bd51c8d86..717a6de6f5 100644 --- 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 index 2301f32ae6..dab2ef451e 100644 --- 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 index c573e34b6a..c6bd74eef7 100644 --- 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 index a2b7c16e86..a3bc15a3b6 100644 --- 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 index 1dce08f8df..02d5ca8c7a 100644 --- 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 @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 index 6997176703..3eb0ec5a49 100644 --- 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 index 70457bf710..0a04e6f021 100755 --- 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,7 +24,7 @@ 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 @@ -32,5 +32,5 @@ 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 index 304cb54432..1117f58a2d 100644 --- 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 index 49c41861be..92a1b2ae3a 100644 --- 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 index b785ca411f..87d9cc37fd 100644 --- 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 index a698a37013..93bdb2cfeb 100644 --- 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 index 8c573f30cf..e4d5e386e4 100644 --- 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 index 3e69a80794..46e5e0bb54 100644 --- 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 index c117cf5682..c02cc11743 100644 --- 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 index 928b203b6a..85b94a1ed7 100644 --- 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 index 49077b7c80..b758932c4d 100644 --- 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 index 21315b18bb..eb4ad9cad5 100644 --- a/stories/cli/usability.fmf +++ b/stories/cli/usability.fmf @@ -21,6 +21,6 @@ story: /completion: summary: Support bash completion - example: tmt st sh + example: tmt st sh link: - implemented-by: /tmt.spec diff --git a/stories/deferred/restraint.fmf b/stories/deferred/restraint.fmf index 931ee08117..49a86f2a6e 100644 --- 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 index efaf2bc985..645235591f 100644 --- 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 index 279ae7e499..fc7a1a12ee 100644 --- 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 index ccd6ee746a..0801955c6b 100644 --- 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 index 6e28a2cdd0..6486054f17 100755 --- 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 index c032fe2810..0e8245c7b1 100644 --- 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 index e884970f06..56126b5547 100755 --- 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 index 58304899d9..71ce927dae 100644 --- 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]... diff --git a/tests/lint/test/data/manual_test_failed_2/test.md b/tests/lint/test/data/manual_test_failed_2/test.md index f1539d7907..e3de3e80de 100644 --- a/tests/lint/test/data/manual_test_failed_2/test.md +++ b/tests/lint/test/data/manual_test_failed_2/test.md @@ -13,7 +13,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]... diff --git a/tests/lint/test/data/manual_test_passed/test.md b/tests/lint/test/data/manual_test_passed/test.md index e0f748be38..a1dc276659 100644 --- a/tests/lint/test/data/manual_test_passed/test.md +++ b/tests/lint/test/data/manual_test_passed/test.md @@ -5,7 +5,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/tests/login/test.sh b/tests/login/test.sh index e50c45d2eb..f09e9b1e38 100755 --- a/tests/login/test.sh +++ b/tests/login/test.sh @@ -8,21 +8,21 @@ rlJournalStart rlPhaseStartTest "Login enabled after tests" rlRun -s "tmt run -a plan -n /fmf-tests login -t -c true" 1 - rlAssertEquals "There should 5 occurences of login" $(grep "Starting interactive" $rlRun_LOG | wc -l) "5" + rlAssertEquals "There should 5 occurrences of login" $(grep "Starting interactive" $rlRun_LOG | wc -l) "5" rlAssertNotGrep "Skipping interactive" $rlRun_LOG rlAssertGrep "Starting interactive" $rlRun_LOG rlPhaseEnd rlPhaseStartTest "Login enabled after tests and after steps" rlRun -s "tmt run -a plan -n /fmf-tests login -t -c true -s discover -s prepare" 1 - rlAssertEquals "There should 6 occurences of login" $(grep "Starting interactive" $rlRun_LOG | wc -l) "6" + rlAssertEquals "There should 6 occurrences of login" $(grep "Starting interactive" $rlRun_LOG | wc -l) "6" rlAssertNotGrep "Skipping interactive" $rlRun_LOG rlAssertGrep "Starting interactive" $rlRun_LOG rlPhaseEnd rlPhaseStartTest "Login enabled after failed tests and during report step if fail" rlRun -s "tmt run -a plan -n /fmf-tests login -t -c true -s report -w fail" 1 - rlAssertEquals "There should 2 occurences of login" $(grep "Starting interactive" $rlRun_LOG | wc -l) "2" + rlAssertEquals "There should 2 occurrences of login" $(grep "Starting interactive" $rlRun_LOG | wc -l) "2" rlAssertGrep "Starting interactive" $rlRun_LOG rlPhaseEnd diff --git a/tests/pull/results/test.sh b/tests/pull/results/test.sh index c8ade3c914..95760fc7eb 100755 --- a/tests/pull/results/test.sh +++ b/tests/pull/results/test.sh @@ -30,7 +30,7 @@ rlJournalStart # Check beakerlib's backup directory pull if [[ "$PROVISION_HOW" =~ local|container ]]; then - # No pull happened so it shoud be present + # No pull happened so it should be present rlAssertExists "$data/guest/default-0/test/beakerlib-2/backup" rlAssertExists "$data/guest/default-0/test/beakerlib-2/backup-NS1" rlAssertNotEquals "any backup dir is present" "$(eval 'echo $data/guest/default-0/test/beakerlib-2/backup*')" "$data/guest/default-0/test/beakerlib-2/backup*" diff --git a/tests/run/error/test.sh b/tests/run/error/test.sh index f7ec32d70a..6049f18167 100755 --- a/tests/run/error/test.sh +++ b/tests/run/error/test.sh @@ -9,7 +9,7 @@ rlJournalStart rlRun "pushd $tmp" rlPhaseEnd - # 2 ... Errors occured during test execution. + # 2 ... Errors occurred during test execution. ECODE=2 rlPhaseStartTest "Truncated" diff --git a/tests/test/debug/test.sh b/tests/test/debug/test.sh index 4cd4a80072..7389e17c38 100755 --- a/tests/test/debug/test.sh +++ b/tests/test/debug/test.sh @@ -25,7 +25,7 @@ rlJournalStart rlRun "echo -e '#!/bin/bash\n/bin/true' > test/test.sh" rlRun "$tmt discover --force execute --force" 0 "Fixed test" - # Clenup until finish + # Cleanup until finish rlRun "$tmt --until finish" rlPhaseEnd diff --git a/tests/unit/__init__.py b/tests/unit/__init__.py index 3ca0758d8c..8c2c87e3d4 100644 --- a/tests/unit/__init__.py +++ b/tests/unit/__init__.py @@ -73,7 +73,7 @@ def _assert_log( :param caplog: Pytest's `caplog` fixture. :param evaluator: a callable reducing a given list of booleans into a single boolean. It is - used to evaluate whether the search for matching record was successfull: each record is + used to evaluate whether the search for matching record was successful: each record is tested, and results of these per-record tests are passed to `evaluator` for the final decision. """ diff --git a/tests/unit/manual_test/test.md b/tests/unit/manual_test/test.md index e0f748be38..a1dc276659 100644 --- a/tests/unit/manual_test/test.md +++ b/tests/unit/manual_test/test.md @@ -5,7 +5,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/tests/unit/test_export_to_nitrate.py b/tests/unit/test_export_to_nitrate.py index 86aa80fdad..7e336e9267 100644 --- a/tests/unit/test_export_to_nitrate.py +++ b/tests/unit/test_export_to_nitrate.py @@ -48,7 +48,7 @@ def test_export_to_nitrate_expect(self): expect = convert_manual_to_nitrate(file_name)[1] html_generated = """Test\ -

Step 1.

Text similar to the one bellow is displayed +

Step 1.

Text similar to the one below is displayed ``` Usage: tmt [OPTIONS] COMMAND [ARGS]...

Test Management Tool

diff --git a/tests/unit/test_results.py b/tests/unit/test_results.py index b660a88caf..15e57f55ff 100644 --- a/tests/unit/test_results.py +++ b/tests/unit/test_results.py @@ -14,7 +14,7 @@ [], TmtExitCode.NO_RESULTS_FOUND ), - # Errors occured during test execution. + # Errors occurred during test execution. ( [ ResultOutcome.PASS, @@ -66,7 +66,7 @@ # IDs copied from the specification: ids=( "No test results found", - "Errors occured during test execution", + "Errors occurred during test execution", "There was a fail or warn identified, but no error", "Tests were executed, and all reported the ``skip`` result", "At least one test passed, there was no fail, warn or error", diff --git a/tests/unit/test_utils.py b/tests/unit/test_utils.py index 4a9e65d642..9573071c7b 100644 --- a/tests/unit/test_utils.py +++ b/tests/unit/test_utils.py @@ -210,7 +210,7 @@ def test_config(): def test_last_run_race(tmppath: Path, monkeypatch): - """ Race in last run symlink should't be fatal """ + """ Race in last run symlink shouldn't be fatal """ config_path = tmppath / 'config' config_path.mkdir() monkeypatch.setattr(tmt.utils, 'CONFIG_DIR', config_path) diff --git a/tmt.spec b/tmt.spec index 580a35689c..a65707a876 100644 --- a/tmt.spec +++ b/tmt.spec @@ -448,7 +448,7 @@ install -pm 644 %{name}/steps/provision/mrack/mrack* %{buildroot}/etc/%{name}/ - Always show the real beaker job id - Create a production copr build for each release - AVC denials check for tests (#2331) -- Add nice & colorfull help to "make" targets +- Add nice & colorful help to "make" targets - Include more dependencies in the dev environment - Stop using the `_version.py` file - Replace `opt()` for `--dry/--force` with properties @@ -867,7 +867,7 @@ install -pm 644 %{name}/steps/provision/mrack/mrack* %{buildroot}/etc/%{name}/ - Prune irrelevant files during the `finish` step - Add junit plugin schema - Support to import empty key from Makefile -- Deleting unsed and duplicite part of finish step +- Deleting unused and duplicite part of finish step - Support absolute paths in HTML reports - Capture exceptions when getting `image_url` - Enable verbose output for `provision` & `prepare` @@ -1110,8 +1110,8 @@ install -pm 644 %{name}/steps/provision/mrack/mrack* %{buildroot}/etc/%{name}/ - Remove duplicated short option in tmt lint - Adjust the `rstrnt-report-result` implementation - Backwards compatibility for `rstrnt-report-result` -- Set the `1777` permision for `/var/tmp/tmt` -- Adjust the fix for the `rpm-ostree` intallation +- Set the `1777` permission for `/var/tmp/tmt` +- Adjust the fix for the `rpm-ostree` installation - Fix package installation using `rpm-ostree` - Handle empty fmf file as an empty dictionary - Fix distgit testsuite after tmt packaging change @@ -1333,7 +1333,7 @@ install -pm 644 %{name}/steps/provision/mrack/mrack* %{buildroot}/etc/%{name}/ - Require beakerlib-1.28 for beakerlib tests - Adjust the dist git source discover implementation - Discover tmt tests from sources -- Reenable plans/install/docs +- Re-enable plans/install/docs - Correct the `playbook` attribute in the spec (#948) - Ansible plugin for Finish step - Thread processing of executed commands inside tmt @@ -1602,7 +1602,7 @@ install -pm 644 %{name}/steps/provision/mrack/mrack* %{buildroot}/etc/%{name}/ - Strip whitespace before relevancy comment - Ensure rsync is installed on the guest if needed - Use the default branch in the discover fmf plugin -- Suport the 'el' shortcut for the distro context +- Support the 'el' shortcut for the distro context - Implement the 'tmt --version' option [fix #445] - Adjust test create test, fix missing dots - Support creating tests in the current directory @@ -1912,7 +1912,7 @@ install -pm 644 %{name}/steps/provision/mrack/mrack* %{buildroot}/etc/%{name}/ - Add a story and examples describing manual tests - Sync more extra-* attributes when exporting [#199] - Enable checks for essential test attributes -- Handle require in Dicovery +- Handle require in Discovery - Store imported metadata in a sane order [fix #86] - Enable Python 3.8 in Travis, update classifiers - Add missing 'require' attribute to the Test class @@ -1923,7 +1923,7 @@ install -pm 644 %{name}/steps/provision/mrack/mrack* %{buildroot}/etc/%{name}/ - Merge improved import of tier from tags [#187] - Adjust tier import from test case tags - Merge tmt test export --nitrate --create [#185] -- Adjust suppport for creating new nitrate testcases +- Adjust support for creating new nitrate testcases - Allow creation of nitrate cases when exporting - Create tier attribute from multiple Tier tags - Fix run.sh to work with RHEL/CentOS 7 as well @@ -2182,7 +2182,7 @@ install -pm 644 %{name}/steps/provision/mrack/mrack* %{buildroot}/etc/%{name}/ - Enable bash completion feature * Thu Oct 17 2019 Petr Šplíchal - 0.4-1 -- Add tests for 'tmt init', allow overwritting +- Add tests for 'tmt init', allow overwriting - Use plural commands to prevent confusion [fix #10] - Add a link to Packit & Testing Farm documentation - Add a simple develop section to the readme @@ -2207,7 +2207,7 @@ install -pm 644 %{name}/steps/provision/mrack/mrack* %{buildroot}/etc/%{name}/ - Add a story for the mock shortcut [fix #5, fix #6] - Add a story for core option --format - Propose a dream for hands-free debugging -- Rename remaining testset occurences to plan +- Rename remaining testset occurrences to plan - Implement 'tmt plan lint' with initial checks * Thu Oct 10 2019 Petr Šplíchal - 0.3-1 @@ -2225,7 +2225,7 @@ install -pm 644 %{name}/steps/provision/mrack/mrack* %{buildroot}/etc/%{name}/ - Provide one-letter versions for select options - Implement 'tmt run --all' to run all test steps - Support command abbreviation, add related stories -- Add the Quick Start Guide story to documention +- Add the Quick Start Guide story to documentation - Add coverage options to tmt story ls and show - Initialize metadata tree only when accessed - Remove show functionality from the 'run' command diff --git a/tmt/base.py b/tmt/base.py index 34e50c6caf..363d580e97 100644 --- a/tmt/base.py +++ b/tmt/base.py @@ -301,7 +301,7 @@ def _export( # Link target - can be either a string (like test case name or URL), or an fmf id. _RawLinkTarget = Union[str, _RawFmfId] -# Basic "relation-aware" link - essentialy a mapping with one key/value pair. +# Basic "relation-aware" link - essentially a mapping with one key/value pair. _RawLinkRelation = dict[_RawLinkRelationName, _RawLinkTarget] # A single link can be represented as a string or FMF ID (meaning only target is specified), @@ -940,7 +940,7 @@ def detect_unallowed_properties_with_pattern( f' and does not match "{match.group(2)}" pattern' # A key value is not recognized. This is often a case with keys whose values are - # limited by an enum, like `how`. Unfortunatelly, validator will record every mismatch + # limited by an enum, like `how`. Unfortunately, validator will record every mismatch # between a value and enum even if eventually a match is found. So it might be tempting # to ignore this particular kind of error - it may also indicate a genuine typo in # key name or completely misplaced key, so it's still necessary to report the error. @@ -2523,7 +2523,7 @@ def __init__( **kwargs) self._update_metadata() - # Override the parent implementation - it would try to call `Tree.storys()`... + # Override the parent implementation - it would try to call `Tree.stories()`... @classmethod def from_tree(cls, tree: 'tmt.Tree') -> list['Story']: return tree.stories() @@ -3303,7 +3303,7 @@ def save(self) -> None: def load_from_workdir(self) -> None: """ Load the run from its workdir, do not require the root in - run.yaml to exist. Doest not load the fmf tree. + run.yaml to exist. Does not load the fmf tree. Use only when the data in workdir is sufficient (e.g. tmt clean and status only require the steps to be loaded and diff --git a/tmt/checks/avc.py b/tmt/checks/avc.py index d77d54c0de..1a91f37d46 100644 --- a/tmt/checks/avc.py +++ b/tmt/checks/avc.py @@ -113,7 +113,7 @@ def _output_logger( def _report_success(label: str, output: tmt.utils.CommandOutput) -> list[str]: - """ Format successfull command output for the report """ + """ Format successful command output for the report """ return [ f'# {label}', diff --git a/tmt/checks/watchdog.py b/tmt/checks/watchdog.py index 94fb0190b8..624bc4f6cf 100644 --- a/tmt/checks/watchdog.py +++ b/tmt/checks/watchdog.py @@ -153,7 +153,7 @@ def do_ping( log = render_report_path(invocation) def _fail_parse_error(ping_output: str) -> None: - """ Handle unparseable ``ping`` output """ + """ Handle unparsable ``ping`` output """ logger.fail('failed to parse ping output') @@ -187,12 +187,12 @@ def _fail_lost_packets(ping_output: str, transmitted: int, received: int) -> Non ) def _success(ping_output: str) -> None: - """ Handle successfull response """ + """ Handle successful response """ logger.verbose('Received successful response to ping.', level=2) report = [ - '# successfull response' + '# successful response' ] if guest_context.ping_failures != 0: @@ -301,12 +301,12 @@ def _fail_connection_refused(ncat_output: str) -> None: command_output=ncat_output) def _success(ncat_output: str) -> None: - """ Handle successfull response """ + """ Handle successful response """ logger.verbose('Received successful response to SSH ping.', level=2) report = [ - '# successfull response' + '# successful response' ] if guest_context.ssh_ping_failures != 0: @@ -368,7 +368,7 @@ class Watchdog(CheckPlugin[WatchdogCheck]): * "reboot" action issues a hard reboot of the guest. Each probe has a "budget" of allowed failures, and when it runs out, - the action is taken. A successfull probe replenishes its budget to + the action is taken. A successful probe replenishes its budget to the original level. Multiple probes can be enabled at the same time, for the action to diff --git a/tmt/cli.py b/tmt/cli.py index 1afd4bbfaf..59107f31b7 100644 --- a/tmt/cli.py +++ b/tmt/cli.py @@ -68,7 +68,7 @@ class TmtExitCode(enum.IntEnum): #: There was a fail or warn identified, but no error. FAIL = 1 - #: Errors occured during test execution. + #: Errors occurred during test execution. ERROR = 2 #: No test results found. diff --git a/tmt/convert.py b/tmt/convert.py index 0ec5e486be..733ae1dbe8 100644 --- a/tmt/convert.py +++ b/tmt/convert.py @@ -473,7 +473,7 @@ def read( else: old_testinfo = None - # Make Makefile 'makeable' without extra dependecies + # Make Makefile 'makeable' without extra dependencies # (replace targets, make include optional and remove rhts-lint) if makefile_file: datafile = datafile.replace('$(METADATA)', 'testinfo.desc') diff --git a/tmt/export/nitrate.py b/tmt/export/nitrate.py index d6caf5d08d..dd62cc2724 100644 --- a/tmt/export/nitrate.py +++ b/tmt/export/nitrate.py @@ -595,7 +595,7 @@ def export_to_nitrate(test: 'tmt.Test') -> None: struct_field.set(section, attribute) echo(style(section + ': ', fg='green') + attribute.strip()) - # fmf identifer + # fmf identifier fmf_id = tmt.utils.dict_to_yaml(test.fmf_id.to_minimal_spec()) struct_field.set('fmf', fmf_id) echo(style('fmf id:\n', fg='green') + fmf_id.strip()) diff --git a/tmt/export/polarion.py b/tmt/export/polarion.py index a05f9989be..64710bb102 100644 --- a/tmt/export/polarion.py +++ b/tmt/export/polarion.py @@ -155,7 +155,7 @@ def add_hyperlink(polarion_case: PolarionTestCase, link: str, role: str = 'tests else: for hyperlink in set(existing_hyperlinks): for _ in range(existing_hyperlinks.count(hyperlink) - 1): - # Remove all but one occurence of the same hyperlink + # Remove all but one occurrence of the same hyperlink polarion_case.remove_hyperlink(hyperlink) diff --git a/tmt/hardware.py b/tmt/hardware.py index 42e7c123e3..eb6a367f1e 100644 --- a/tmt/hardware.py +++ b/tmt/hardware.py @@ -375,9 +375,9 @@ def variants( def variant(self) -> list['Constraint[Any]']: """ - Pick one of the available variants of this contraints. + Pick one of the available variants of this constraints. - As the contraint can yield many variants, often there's an interest in + As the constraint can yield many variants, often there's an interest in just one. There can be many different ways for picking the best one, whatever that may mean depending on the context, as a starting point this method is provided. In the future, provision plugins would probably @@ -408,7 +408,7 @@ def __init__( :param reducer: a callable reducing a list of results from child constraints into the final answer. - :param constraints: child contraints. + :param constraints: child constraints. """ self.reducer = reducer @@ -847,7 +847,7 @@ def ungroupify(fn: Callable[[Spec], BaseConstraint]) -> Callable[[Spec], BaseCon """ Swap returned single-child compound constraint and that child. - Helps reduce the number of levels in the contraint tree: if the return value + Helps reduce the number of levels in the constraint tree: if the return value is a compound constraint which contains just a single child, return the child instead of the compound constraint. @@ -873,7 +873,7 @@ def ungroupify_indexed( """ Swap returned single-child compound constraint and that child. - Helps reduce the number of levels in the contraint tree: if the return value + Helps reduce the number of levels in the constraint tree: if the return value is a compound constraint which contains just a single child, return the child instead of the compound constraint. diff --git a/tmt/log.py b/tmt/log.py index ca4b96d5c5..b5d7849956 100644 --- a/tmt/log.py +++ b/tmt/log.py @@ -460,7 +460,7 @@ def __init__( command-line option. :param debug_level: desired debugging level, usually derived from ``-d`` command-line option. - :param quiet: if set, all messages would be supressed, with the exception of + :param quiet: if set, all messages would be suppressed, with the exception of warnings (:py:meth:`warn`), errors (:py:meth:`fail`) and messages emitted with :py:meth:`print`. """ @@ -541,7 +541,7 @@ def descend( Create a copy of this logger instance, but with a new raw logger. New :py:class:`logging.Logger` instance is created from our raw logger, forming a - parent/child relationship betwen them, and it's then wrapped with ``Logger`` instance. + parent/child relationship between them, and it's then wrapped with ``Logger`` instance. Settings of this logger are copied to new one, with the exception of ``base_shift`` which is increased by one, effectively indenting all messages passing through new logger. diff --git a/tmt/options.py b/tmt/options.py index 07eed337df..f9d6bcf58f 100644 --- a/tmt/options.py +++ b/tmt/options.py @@ -51,7 +51,7 @@ def rendered(self) -> str: # produced by click.option() calls: not options, but decorators, functions that attach # options to a given command. # Since click.decorators does not have a dedicated type for this purpose, we need -# to construct it on our own, but we can re-use a typevar click.decorators has. +# to construct it on our own, but we can reuse a typevar click.decorators has. _ClickOptionDecoratorType = Callable[[FC], FC] # The type above is a generic type, `FC` being a typevar, so we have two options: # * each place using the type would need to fill the variable, i.e. add [foo]`, or diff --git a/tmt/result.py b/tmt/result.py index 69e8a6e939..0b09a2acf7 100644 --- a/tmt/result.py +++ b/tmt/result.py @@ -395,7 +395,7 @@ def results_to_exit_code(results: list[Result]) -> int: if sum(stats.values()) == 0: return TmtExitCode.NO_RESULTS_FOUND - # "Errors occured during test execution." + # "Errors occurred during test execution." if stats[ResultOutcome.ERROR]: return TmtExitCode.ERROR diff --git a/tmt/steps/__init__.py b/tmt/steps/__init__.py index 4cacdd9983..0080787d03 100644 --- a/tmt/steps/__init__.py +++ b/tmt/steps/__init__.py @@ -711,7 +711,7 @@ def _apply_cli_invocations(self, raw_data: list[_RawStepData]) -> list[_RawStepD # Do NOT iterate over `self.data`: reading `self.data` would trigger materialization # of its content, calling plugins owning various raw step data to create corresponding # `StepData` instances. That is actually harmful, as plugins that might be explicitly - # overriden by `--how` option, would run, with unexpected side-effects. + # overridden by `--how` option, would run, with unexpected side-effects. # Instead, iterate over raw data, and replace incompatible plugins with the one given # on command line. There is no reason to ever let dropped plugin's `StepData` to # materialize when it's going to be thrown away anyway. @@ -1179,7 +1179,7 @@ class BasePlugin(Phase, Generic[StepDataT]): # Methods ("how: ..." implementations) registered for the same step. # # The field is declared here, in a base class of all plugin classes, and - # each step-specific base plugin class assignes it a value as a class-level + # each step-specific base plugin class assigns it a value as a class-level # attribute. This guarantees steps would not share a registry instance while # the declaration below make the name and type visible across all # subclasses. @@ -1435,7 +1435,7 @@ def get(self, option: str, default: Optional[Any] = None) -> Any: # still matches the default value, instead of returning the default # value right away, call `self.default()` so the plugin has chance to # catch calls for computed or virtual keys, keys that don't exist as - # atributes of our step data. + # attributes of our step data. # # One way would be to subclass step's base plugin class' step data class # (which is a subclass of `StepData` and `SerializedContainer`), and @@ -1509,7 +1509,7 @@ def _emit_key(key: str) -> None: echo(tmt.utils.format(key_to_option(key), value)) - # First, follow the order prefered by step data, but emit only the keys + # First, follow the order preferred by step data, but emit only the keys # that are allowed. Each emitted key would be removed so we wouldn't # emit it again when showing the unsorted rest of keys. for key in self.data._KEYS_SHOW_ORDER: @@ -2298,7 +2298,7 @@ def safe_filename(basename: str, phase: Phase, guest: 'Guest') -> Path: Function adds enough uniqueness to the starting base name by adding a phase name and a guest name that the eventual filename would be safe against conflicting access from a phase running on multiple guests, and against - re-use when created by the same plugin in different phases. + reuse when created by the same plugin in different phases. At first glance, the name might be an overkill: at one moment, there is just one phase running on the given guest, why bother? No other phase @@ -2313,7 +2313,7 @@ def safe_filename(basename: str, phase: Phase, guest: 'Guest') -> Path: --guest $IP``. Therefore it may happen that one phase, running against two guests, would actually run on the very same HW. Therefore even the remote per-guest uniqueness is needed. - 3. the phase name is included to avoid re-use of the filename by different + 3. the phase name is included to avoid reuse of the filename by different phases. A plugin may be invoked by multiple phases, and it might use a "constant" name for the file. That would lead to the filename being re-used by different plugin executions. Adding the phase name should diff --git a/tmt/steps/discover/__init__.py b/tmt/steps/discover/__init__.py index 6e205d5536..fc12018a95 100644 --- a/tmt/steps/discover/__init__.py +++ b/tmt/steps/discover/__init__.py @@ -192,7 +192,7 @@ def load(self) -> None: for raw_test_datum in raw_test_data: # The name of `discover` phases providing the test was added in 1.24. - # Unfortunatelly, the field is required for correct work of `execute`, + # Unfortunately, the field is required for correct work of `execute`, # now when it is parallel in nature. Without it, it's not possible # to pick the right `discover` phase which then provides the list # of tests to execute. Therefore raising an error instead of guessing diff --git a/tmt/steps/discover/shell.py b/tmt/steps/discover/shell.py index 0961ed6917..5d5257ae08 100644 --- a/tmt/steps/discover/shell.py +++ b/tmt/steps/discover/shell.py @@ -35,7 +35,7 @@ class TestDescription( """ Keys necessary to describe a shell-based test. - Provides basic functionality for tansition between "raw" step data representation, + Provides basic functionality for transition between "raw" step data representation, which consists of keys and values given by fmf tree and CLI options, and this container representation for internal use. """ @@ -43,10 +43,10 @@ class TestDescription( name: str # TODO: following keys are copy & pasted from base.Test. It would be much, much better - # to re-use the definitions from base.Test instead copying them here, but base.Test + # to reuse the definitions from base.Test instead copying them here, but base.Test # does not support save/load operations. This is a known issue, introduced by a patch # transitioning step data to data classes, it is temporary, and it will be fixed as - # soon as possible - nobody want's to keep two very same lists of attributes. + # soon as possible - nobody wants to keep two very same lists of attributes. test: ShellScript = field( default=ShellScript(''), normalize=lambda key_address, raw_value, logger: ShellScript(raw_value), diff --git a/tmt/steps/execute/__init__.py b/tmt/steps/execute/__init__.py index edb18eb15b..750956ddf5 100644 --- a/tmt/steps/execute/__init__.py +++ b/tmt/steps/execute/__init__.py @@ -814,7 +814,7 @@ def go(self, force: bool = False) -> None: queue.enqueue_action(phase=phase) else: - # A single execute plugin is expected to process (potentialy) + # A single execute plugin is expected to process (potentially) # multiple discover phases. There must be a way to tell the execute # plugin which discover phase to focus on. Unfortunately, the # current way is the execute plugin checking its `discover` @@ -843,7 +843,7 @@ def go(self, force: bool = False) -> None: continue # Execute plugins do not return results. Instead, plugin collects results - # in its internal `_results` list. To accomodate for different discover + # in its internal `_results` list. To accommodate for different discover # phases, we create a copy of the execute phase for each discover phase # we have. All these copies share the `_results` list, and append to it. # diff --git a/tmt/steps/execute/internal.py b/tmt/steps/execute/internal.py index aca54cca36..77f435ed6b 100644 --- a/tmt/steps/execute/internal.py +++ b/tmt/steps/execute/internal.py @@ -533,7 +533,7 @@ def _run_tests( result.note = 'aborted' self._results.extend(invocation.results) - # If test duration information is missing, print 8 spaces to keep indention + # If test duration information is missing, print 8 spaces to keep indentation def _format_duration(result: BaseResult) -> str: return click.style(result.duration, fg='cyan') if result.duration else 8 * ' ' diff --git a/tmt/steps/execute/scripts/tmt-report-result b/tmt/steps/execute/scripts/tmt-report-result index 1683bcde9f..98d1e0a647 100755 --- a/tmt/steps/execute/scripts/tmt-report-result +++ b/tmt/steps/execute/scripts/tmt-report-result @@ -44,7 +44,7 @@ check_report_file () { fileHierarchy="${RESULTS_HIERARCHY[$fileResult]}" # Compare the current result hierarchy against # the hierarchy result retrieved from the file. - # Overwrite the file if the current hierachy is higher. + # Overwrite the file if the current hierarchy is higher. thisResultHierarchy="${RESULTS_HIERARCHY[$TESTRESULT]}" if [ $thisResultHierarchy -gt $fileHierarchy ]; then write_report_file diff --git a/tmt/steps/execute/upgrade.py b/tmt/steps/execute/upgrade.py index 6e614d7361..13cc38131e 100644 --- a/tmt/steps/execute/upgrade.py +++ b/tmt/steps/execute/upgrade.py @@ -301,7 +301,7 @@ def _perform_upgrade( plan = self._get_plan(self._discover_upgrade.testdir) data = self._prepare_remote_discover_data(plan) # Unset `url` because we don't want discover step to perform clone. Instead, - # we want it to re-use existing, already cloned path. + # we want it to reuse existing, already cloned path. # ignore[typeddict-unknown-key]: data is _RwStepData, we do not have more detailed # type for raw step data of internal/upgrade plugins, it would be pretty verbose. data['url'] = None # type: ignore[typeddict-unknown-key] diff --git a/tmt/steps/prepare/__init__.py b/tmt/steps/prepare/__init__.py index 6f98b118e5..c2bd90f03e 100644 --- a/tmt/steps/prepare/__init__.py +++ b/tmt/steps/prepare/__init__.py @@ -239,7 +239,7 @@ def as_key(self) -> frozenset['tmt.base.DependencySimple']: # The `discover` step is different: no phases, just query tests # collected by the step itself. Maybe we could iterate over - # `discover` phases, but I think re-runs and workdir re-use would + # `discover` phases, but I think re-runs and workdir reuse would # use what the step loads from its storage, `tests.yaml`. Which # means, there probably would be no phases to inspect from time to # time, therefore going after the step itself. diff --git a/tmt/steps/prepare/install.py b/tmt/steps/prepare/install.py index 73624251e9..af4beb2e1b 100644 --- a/tmt/steps/prepare/install.py +++ b/tmt/steps/prepare/install.py @@ -259,7 +259,7 @@ def install_local(self) -> None: """ Install packages stored in a local directory """ # Use both dnf install/reinstall to get all packages refreshed - # FIXME Simplify this once BZ#1831022 is fixed/implemeted. + # FIXME Simplify this once BZ#1831022 is fixed/implemented. filelist = [PackagePath(self.package_directory / filename) for filename in self.local_packages] diff --git a/tmt/steps/provision/__init__.py b/tmt/steps/provision/__init__.py index 267a6c963b..bdbc7bae7c 100644 --- a/tmt/steps/provision/__init__.py +++ b/tmt/steps/provision/__init__.py @@ -256,7 +256,7 @@ def _probe( guest: 'Guest', probes: list[tuple[Command, T]]) -> Optional[T]: """ - Find a first successfull command. + Find a first successful command. :param guest: the guest to run commands on. :param probes: list of command/mark pairs. @@ -276,7 +276,7 @@ def _query( guest: 'Guest', probes: list[tuple[Command, str]]) -> Optional[str]: """ - Find a first successfull command, and extract info from its output. + Find a first successful command, and extract info from its output. :param guest: the guest to run commands on. :param probes: list of command/pattenr pairs. @@ -927,7 +927,7 @@ def _run_ansible( playbook in whatever way is fitting for the guest and infrastructure. :param playbook: path to the playbook to run. - :param extra_args: aditional arguments to be passed to ``ansible-playbook`` + :param extra_args: additional arguments to be passed to ``ansible-playbook`` via ``--extra-args``. :param friendly_command: if set, it would be logged instead of the command itself, to improve visibility of the command in logging output. @@ -949,11 +949,11 @@ def ansible( """ Run an Ansible playbook on the guest. - A wrapper for :py:meth:`_run_ansible` which is reponsible for running + A wrapper for :py:meth:`_run_ansible` which is responsible for running the playbook while this method makes sure our logging is consistent. :param playbook: path to the playbook to run. - :param extra_args: aditional arguments to be passed to ``ansible-playbook`` + :param extra_args: additional arguments to be passed to ``ansible-playbook`` via ``--extra-args``. :param friendly_command: if set, it would be logged instead of the command itself, to improve visibility of the command in logging output. @@ -1300,7 +1300,7 @@ def _ssh_options(self) -> Command: options.extend(['-oPasswordAuthentication=yes']) else: # Make sure the connection is rejected when we want key- - # based authetication only instead of presenting a prompt. + # based authentication only instead of presenting a prompt. # Prevents issues like https://github.com/teemtee/tmt/issues/2687 # from happening and makes the ssh connection more robust # by allowing proper re-try mechanisms to kick-in. @@ -1411,7 +1411,7 @@ def _run_ansible( playbook in whatever way is fitting for the guest and infrastructure. :param playbook: path to the playbook to run. - :param extra_args: aditional arguments to be passed to ``ansible-playbook`` + :param extra_args: additional arguments to be passed to ``ansible-playbook`` via ``--extra-args``. :param friendly_command: if set, it would be logged instead of the command itself, to improve visibility of the command in logging output. @@ -1559,7 +1559,7 @@ def push(self, By default the whole plan workdir is synced to the same location on the guest. Use the 'source' and 'destination' to sync custom - location and the 'options' parametr to modify default options + location and the 'options' parameter to modify default options which are '-Rrz --links --safe-links --delete'. Set 'superuser' if rsync command has to run as root or passwordless diff --git a/tmt/steps/provision/local.py b/tmt/steps/provision/local.py index dd3432132a..3ceb6d53cf 100644 --- a/tmt/steps/provision/local.py +++ b/tmt/steps/provision/local.py @@ -40,7 +40,7 @@ def _run_ansible( playbook in whatever way is fitting for the guest and infrastructure. :param playbook: path to the playbook to run. - :param extra_args: aditional arguments to be passed to ``ansible-playbook`` + :param extra_args: additional arguments to be passed to ``ansible-playbook`` via ``--extra-args``. :param friendly_command: if set, it would be logged instead of the command itself, to improve visibility of the command in logging output. diff --git a/tmt/steps/provision/mrack.py b/tmt/steps/provision/mrack.py index 9f42e9242f..43b7831228 100644 --- a/tmt/steps/provision/mrack.py +++ b/tmt/steps/provision/mrack.py @@ -103,7 +103,7 @@ def operator_to_beaker_op(operator: tmt.hardware.Operator, value: str) -> tuple[ # Transcription of our HW constraints into Mrack's own representation. It's based # on dictionaries, and it's slightly weird. There is no distinction between elements # that do not have attributes, like , and elements that must have them, like -# and other binary operations. Also, there is no distinction betwen +# and other binary operations. Also, there is no distinction between # element attribute and child element, both are specified as dictionary key, just # the former would be a string, the latter another, nested, dictionary. # diff --git a/tmt/steps/report/junit.py b/tmt/steps/report/junit.py index f4f293d20a..e5fe86d9f2 100644 --- a/tmt/steps/report/junit.py +++ b/tmt/steps/report/junit.py @@ -19,7 +19,7 @@ junit_xml: Optional[types.ModuleType] = None -# Thanks to import burried in a function, we don't get the regular missing annotations +# Thanks to import buried in a function, we don't get the regular missing annotations # but "name ... is not defined". Define a special type to follow the test suite instance # around, and if junit_xml ever gets annotations, we can replace it with provided type. JunitTestSuite = Any diff --git a/tmt/steps/report/reportportal.py b/tmt/steps/report/reportportal.py index 8a4a5edb5c..c75a20c0e3 100644 --- a/tmt/steps/report/reportportal.py +++ b/tmt/steps/report/reportportal.py @@ -87,7 +87,7 @@ class ReportReportPortalData(tmt.steps.report.ReportStepData): default=_flag_env_to_default('suite_per_plan', False), is_flag=True, help=""" - Mapping suite per plan, creating one launch and continous uploading suites into it. + Mapping suite per plan, creating one launch and continuous uploading suites into it. Recommended to use with '--launch' and '--launch-description' options. Can be used with '--upload-to-launch' option to avoid creating a new launch. """) @@ -167,7 +167,7 @@ class ReportReportPortal(tmt.steps.report.ReportPlugin[ReportReportPortalData]): """ Report test results to a ReportPortal instance via API. - For communication with Report Portal API is neccessary to provide + For communication with Report Portal API is necessary to provide following options: * token for authentication @@ -239,7 +239,7 @@ def check_options(self) -> None: """ Write warning if there might be caused an unexpected behaviour by the option combinations """ - # TODO: Update restriction of forbiden option combinations based on feedback. + # TODO: Update restriction of forbidden option combinations based on feedback. if self.data.launch_per_plan and self.data.suite_per_plan: raise tmt.utils.ReportError( diff --git a/tmt/trying.py b/tmt/trying.py index dc7ef91994..1fcc03de1d 100644 --- a/tmt/trying.py +++ b/tmt/trying.py @@ -195,7 +195,7 @@ def check_plans(self, run: tmt.base.Run) -> None: self.debug("Matching plans found\n" + tmt.utils.format_value(self.plans)) - # Attach a login instace to each plan + # Attach a login instance to each plan for plan in self.plans: plan.login = tmt.steps.Login( logger=plan.provision._logger.descend(), diff --git a/tmt/utils.py b/tmt/utils.py index 5758452985..95b3b9a2ee 100644 --- a/tmt/utils.py +++ b/tmt/utils.py @@ -693,7 +693,7 @@ def from_inputs( inputs. All inputs are optional, and there is a clear order of preference, which is, - from the most prefered: + from the most preferred: * ``--environment`` CLI option (``raw_cli_environment``) * ``--environment-file`` CLI option (``raw_cli_environment_files``) @@ -940,7 +940,7 @@ def fmf_tree(self) -> fmf.Tree: raise MetadataError(f"Config tree not found in '{self.path}'.") from error -# TODO: `StreamLogger` is a dedicated thread fillowing given stream, passing their content to +# TODO: `StreamLogger` is a dedicated thread following given stream, passing their content to # tmt's logging methods. Thread is needed because of some amount of blocking involved in the # process, but it has a side effect of `NO_COLOR` envvar being ignored. When tmt spots `NO_COLOR` # envvar, it flips a `color` flag in its Click context. But since contexts are thread-local, @@ -2288,7 +2288,7 @@ def __init__( # Store instance of caller to get additional details # in post processing (e.g. verbose level) self.caller = caller - # Since logger may get swaped, to better reflect context (guests start + # Since logger may get swapped, to better reflect context (guests start # with logger inherited from `provision` but may run under `prepare` or # `finish`), save a logger for later. self.logger = caller._logger if isinstance(caller, Common) else None @@ -2327,7 +2327,7 @@ def __init__( A subclass of :py:class:`SpecificationError`, but describing errors that appear in a very specific point of key loading in a unified manner. - :param key_address: the key in question, preferrably with detailed location, + :param key_address: the key in question, preferably with detailed location, e.g. ``/plans/foo:discover[0].tests``. :param raw_value: input value, the one that failed the normalization. :param expected_type: string description of expected, allowed types, as @@ -3230,7 +3230,7 @@ def _produce_unserialized() -> Iterator[tuple[str, Any]]: yield key, value # Set attribute by adding it to __dict__ directly. Messing with setattr() - # might cause re-use of mutable values by other instances. + # might cause reuse of mutable values by other instances. # obj.__dict__[keyname] = unserialize_callback(value) return cls(**dict(_produce_unserialized())) @@ -3818,7 +3818,7 @@ def format_value( # UX: if there are multiple items, we do not add prefixes as long as # there are no multi-line items - once there is just a single one item # rendered across multiple lines, we need to add `-` prefix & indentation - # to signal where items start and end visualy. + # to signal where items start and end visually. if len(value) > 1 and any('\n' in formatted_item for formatted_item in formatted_value): prefixed: list[str] = [] @@ -4074,7 +4074,7 @@ def check_git_url(url: str) -> str: PUBLIC_GIT_URL_PATTERNS: list[tuple[str, str]] = [ - # Gitlab on private namepace is synced to pkgs.devel.redhat.com + # Gitlab on private namespace is synced to pkgs.devel.redhat.com # old: https://gitlab.com/redhat/rhel/tests/bash # old: git@gitlab.com:redhat/rhel/tests/bash # new: https://pkgs.devel.redhat.com/git/tests/bash @@ -4153,10 +4153,10 @@ def inject_auth_git_url(url: str) -> str: Inject username or token to the git url :param url: original git repo url - :returns: URL with injected authentification based on pattern from the environment + :returns: URL with injected authentication based on pattern from the environment or unmodified URL """ - # Try all environement variables sorted by their name + # Try all environment variables sorted by their name for name, value in sorted(os.environ.items(), key=lambda x: x[0]): # First one which matches url is taken into the account if name.startswith(INJECT_CREDENTIALS_URL_PREFIX) and re.search(value, url): @@ -4322,7 +4322,7 @@ def increment( # Detect a subset of exception we do not want to follow with a retry. # SIM102: Use a single `if` statement instead of nested `if` statements. Keeping for - # readibility. + # readability. if error is not None: # noqa: SIM102 # Failed certificate verification - this issue will probably not get any better # should we try again. @@ -5421,7 +5421,7 @@ def update(self, value: str, color: Optional[str] = None) -> None: def find_fmf_root(path: Path, ignore_paths: Optional[list[Path]] = None) -> list[Path]: """ - Search trough path and return all fmf roots that exist there + Search through path and return all fmf roots that exist there Returned list is ordered by path length, shortest one first. @@ -5594,7 +5594,7 @@ def _prenormalize_fmf_node(node: fmf.Tree, schema_name: str, logger: tmt.log.Log This function is not part of the normalization process that happens after validation. The purpose of this function is to make the world nice and shiny for tmt users while avoiding the possibility of schema becoming way too complicated, especially when we would need - non-trivial amount fo time for experiments. + non-trivial amount of time for experiments. The real normalization process takes place after validation, and is responsible for converting raw fmf data to data types and structures more suited for tmt internal @@ -5610,7 +5610,7 @@ def _prenormalize_fmf_node(node: fmf.Tree, schema_name: str, logger: tmt.log.Log # value - but it's not our job to validate the general structure of node data. Walk the "happy" # path, touch the node only when it matches the specification of being a mapping of steps and # these being either mappings or lists of mappings. Whenever we notice some value does not - # match this basic structure, ignore the step completely - its issues will be cought by schema + # match this basic structure, ignore the step completely - its issues will be caught by schema # later, don't waste time on steps that do not follow specification. # Fmf data describing a plan shall be a mapping (with keys like `discover` or `adjust`). @@ -5736,9 +5736,9 @@ def wait( To test the condition state, a ``check`` callback is called every ``tick`` seconds until ``check`` reports a success. The callback may: - * decide the condition has been fulfilled. This is a successfull outcome, + * decide the condition has been fulfilled. This is a successful outcome, ``check`` shall then simply return, and waiting ends. Or, - * decide more time is needed. This is not a successfull outcome, ``check`` + * decide more time is needed. This is not a successful outcome, ``check`` shall then raise :py:class:`WaitingIncomplete` exception, and ``wait()`` will try again later. @@ -5749,8 +5749,8 @@ def wait( without exception. Its return value will be propagated by ``wait()`` up to ``wait()``'s. All other exceptions raised by ``check`` will propagate to ``wait()``'s caller as well, terminating the wait. - :param timeout: amount of time ``wait()`` is alowed to spend waiting for - successfull outcome of ``check`` call. + :param timeout: amount of time ``wait()`` is allowed to spend waiting for + successful outcome of ``check`` call. :param tick: how many seconds to wait between two consecutive calls of ``check``. :param tick_increase: a multiplier applied to ``tick`` after every attempt. @@ -5932,7 +5932,7 @@ def dataclass_normalize_field( topic=tmt.log.Topic.KEY_NORMALIZATION) # Set attribute by adding it to __dict__ directly. Messing with setattr() - # might cause re-use of mutable values by other instances. + # might cause reuse of mutable values by other instances. container.__dict__[keyname] = value return value