diff options
author | Thomas Huth <thuth@redhat.com> | 2024-08-30 15:38:37 +0200 |
---|---|---|
committer | Thomas Huth <thuth@redhat.com> | 2024-09-04 12:28:00 +0200 |
commit | 0abdd9708478c1109de9114d979ec8d388f04c54 (patch) | |
tree | 4c35bd0f56d8404fc0c358cb1450f253fd90917e | |
parent | 2133c2ab9c008a19e30eeea40104eaaa2619de3e (diff) |
docs/devel/testing: Rename avocado_qemu.Test class
The avocado_qemu.Test class has been renamed a while back in commit
2283b627bc ("tests/avocado: Rename avocado_qemu.Test -> QemuSystemTest"),
so we should reflect this now in the documentation, too.
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com>
Message-ID: <20240830133841.142644-44-thuth@redhat.com>
Signed-off-by: Thomas Huth <thuth@redhat.com>
-rw-r--r-- | docs/devel/testing/avocado.rst | 32 |
1 files changed, 16 insertions, 16 deletions
diff --git a/docs/devel/testing/avocado.rst b/docs/devel/testing/avocado.rst index 0d207a05c5..eda76fe2db 100644 --- a/docs/devel/testing/avocado.rst +++ b/docs/devel/testing/avocado.rst @@ -8,11 +8,11 @@ The ``tests/avocado`` directory hosts integration tests. They're usually higher level tests, and may interact with external resources and with various guest operating systems. -These tests are written using the Avocado Testing Framework (which must -be installed separately) in conjunction with a the ``avocado_qemu.Test`` +These tests are written using the Avocado Testing Framework (which must be +installed separately) in conjunction with a the ``avocado_qemu.QemuSystemTest`` class, implemented at ``tests/avocado/avocado_qemu``. -Tests based on ``avocado_qemu.Test`` can easily: +Tests based on ``avocado_qemu.QemuSystemTest`` can easily: * Customize the command line arguments given to the convenience ``self.vm`` attribute (a QEMUMachine instance) @@ -154,7 +154,7 @@ Overview -------- The ``tests/avocado/avocado_qemu`` directory provides the -``avocado_qemu`` Python module, containing the ``avocado_qemu.Test`` +``avocado_qemu`` Python module, containing the ``avocado_qemu.QemuSystemTest`` class. Here's a simple usage example: .. code:: @@ -186,11 +186,11 @@ in the current directory, tagged as "quick", run: avocado run -t quick . -The ``avocado_qemu.Test`` base test class -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The ``avocado_qemu.QemuSystemTest`` base test class +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -The ``avocado_qemu.Test`` class has a number of characteristics that -are worth being mentioned right away. +The ``avocado_qemu.QemuSystemTest`` class has a number of characteristics +that are worth being mentioned right away. First of all, it attempts to give each test a ready to use QEMUMachine instance, available at ``self.vm``. Because many tests will tweak the @@ -233,15 +233,15 @@ and hypothetical example follows: self.assertEqual(first_res, second_res, third_res) -At test "tear down", ``avocado_qemu.Test`` handles all the QEMUMachines -shutdown. +At test "tear down", ``avocado_qemu.QemuSystemTest`` handles all the +QEMUMachines shutdown. The ``avocado_qemu.LinuxTest`` base test class ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The ``avocado_qemu.LinuxTest`` is further specialization of the -``avocado_qemu.Test`` class, so it contains all the characteristics of -the later plus some extra features. +``avocado_qemu.QemuSystemTest`` class, so it contains all the characteristics +of the later plus some extra features. First of all, this base class is intended for tests that need to interact with a fully booted and operational Linux guest. At this @@ -298,7 +298,7 @@ the following approaches: working directory, or in the current source tree. The resulting ``qemu_bin`` value will be preserved in the -``avocado_qemu.Test`` as an attribute with the same name. +``avocado_qemu.QemuSystemTest`` as an attribute with the same name. Attribute reference ------------------- @@ -308,7 +308,7 @@ Test Besides the attributes and methods that are part of the base ``avocado.Test`` class, the following attributes are available on any -``avocado_qemu.Test`` instance. +``avocado_qemu.QemuSystemTest`` instance. vm "" @@ -365,7 +365,7 @@ source tree. LinuxTest ^^^^^^^^^ -Besides the attributes present on the ``avocado_qemu.Test`` base +Besides the attributes present on the ``avocado_qemu.QemuSystemTest`` base class, the ``avocado_qemu.LinuxTest`` adds the following attributes: distro @@ -446,7 +446,7 @@ The exact QEMU binary to be used on QEMUMachine. LinuxTest ^^^^^^^^^ -Besides the parameters present on the ``avocado_qemu.Test`` base +Besides the parameters present on the ``avocado_qemu.QemuSystemTest`` base class, the ``avocado_qemu.LinuxTest`` adds the following parameters: distro |