[20/22] Acceptance Tests: add basic documentation on LinuxTest base class

Commit Message

Cleber Rosa Feb. 3, 2021, 5:23 p.m. UTC

Signed-off-by: Cleber Rosa <[e-mail]>
---
 docs/devel/testing.rst | 26 ++++++++++++++++++++++++++
 1 file changed, 26 insertions(+)

Comments

Marc-André Lureau Feb. 11, 2021, 10:24 a.m. UTC | #1

On Wed, Feb 3, 2021 at 9:47 PM Cleber Rosa <[e-mail]> wrote:
>
> Signed-off-by: Cleber Rosa <[e-mail]>

Reviewed-by: Marc-André Lureau <[e-mail]>

> ---
>  docs/devel/testing.rst | 26 ++++++++++++++++++++++++++
>  1 file changed, 26 insertions(+)
>
> diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
> index 209f9d8172..fe0112b21c 100644
> --- a/docs/devel/testing.rst
> +++ b/docs/devel/testing.rst
> @@ -790,6 +790,32 @@ and hypothetical example follows:
>  At test "tear down", ``avocado_qemu.Test`` 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.
> +
> +First of all, this base class is intended for tests that need to
> +interact with a fully booted and operational Linux guest.  The most
> +basic example looks like this:
> +
> +.. code::
> +
> +  from avocado_qemu import LinuxTest
> +
> +
> +  class SomeTest(LinuxTest):
> +
> +      def test(self):
> +          self.launch_and_wait()
> +          self.ssh_connect('root', self.ssh_key)
> +          self.ssh_command('some_command_to_be_run_in_the_guest')
> +
> +Please refer to tests that use ``avocado_qemu.LinuxTest`` under
> +``tests/acceptance`` for more examples.
> +
>  QEMUMachine
>  ~~~~~~~~~~~
>
> --
> 2.25.4
>
>

Willian Rampazzo Feb. 12, 2021, 8:30 p.m. UTC | #2

On Wed, Feb 3, 2021 at 2:25 PM Cleber Rosa <[e-mail]> wrote:
>
> Signed-off-by: Cleber Rosa <[e-mail]>
> ---
>  docs/devel/testing.rst | 26 ++++++++++++++++++++++++++
>  1 file changed, 26 insertions(+)
>

Reviewed-by: Willian Rampazzo <[e-mail]>

Patch

diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
index 209f9d8172..fe0112b21c 100644
--- a/docs/devel/testing.rst
+++ b/docs/devel/testing.rst
@@ -790,6 +790,32 @@  and hypothetical example follows:
 At test "tear down", ``avocado_qemu.Test`` 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.
+
+First of all, this base class is intended for tests that need to
+interact with a fully booted and operational Linux guest.  The most
+basic example looks like this:
+
+.. code::
+
+  from avocado_qemu import LinuxTest
+
+
+  class SomeTest(LinuxTest):
+
+      def test(self):
+          self.launch_and_wait()
+          self.ssh_connect('root', self.ssh_key)
+          self.ssh_command('some_command_to_be_run_in_the_guest')
+
+Please refer to tests that use ``avocado_qemu.LinuxTest`` under
+``tests/acceptance`` for more examples.
+
 QEMUMachine
 ~~~~~~~~~~~