devel/testing/avocado.rst

1 .. _checkavocado-ref:
18    ``self.vm`` attribute (a QEMUMachine instance)
28    (see ``self.get_data()``)
39    - http://avocado-framework.readthedocs.io/en/latest/api/test/avocado.html#avocado.Test
40    - http://avocado-framework.readthedocs.io/en/latest/api/utils/avocado.utils.html
43 -------------
49   make check-avocado
52 necessary avocado-framework dependencies into the QEMU venv within the
58 ``configure`` is called with ``--python=`` and that those modules are
60 specific version, they may be on packages named ``python3-venv`` and
61 ``python3-pip``.
64 ``make check-avocado`` command and the ``AVOCADO_TAGS`` environment
69    make check-avocado AVOCADO_TAGS=quick
75  https://avocado-framework.readthedocs.io/en/latest/guides/user/chapters/tags.html
78 using the ``make check-avocado`` command, set the ``AVOCADO_TESTS``
84   make check-avocado AVOCADO_TESTS=$FILEPATH
90   make check-avocado AVOCADO_TESTS='$FILEPATH1 $FILEPATH2'
96   make check-avocado AVOCADO_TESTS=$FILEPATH:$TESTCLASS.$TESTNAME
102 …make check-avocado AVOCADO_TESTS='$FILEPATH1:$TESTCLASS1.$TESTNAME1 $FILEPATH2:$TESTCLASS2.$TESTNA…
112 Note that if ``make check-avocado`` was not executed before, it is
118   make check-venv
134 of Avocado or ``make check-avocado``, and can also be queried using:
141 -------------------
147   pip install --user avocado-framework
151   https://avocado-framework.readthedocs.io/en/latest/guides/user/chapters/installing.html
154 --------
169       def test_qmp_human_info_version(self):
170           self.vm.launch()
171           res = self.vm.cmd('human-monitor-command',
173           self.assertRegex(res, r'^(\d+\.\d+\.\d)')
187   avocado run -t quick .
196 instance, available at ``self.vm``.  Because many tests will tweak the
197 QEMU command line, launching the QEMUMachine (by using ``self.vm.launch()``)
201 QEMUMachine. The way to get machines is through the ``self.get_vm()``
202 method which will return a QEMUMachine instance. The ``self.get_vm()``
214       def test_multiple_machines(self):
215           first_machine = self.get_vm()
216           second_machine = self.get_vm()
217           self.get_vm(name='third_machine').launch()
223               'human-monitor-command',
227               'human-monitor-command',
230           third_res = self.get_vm(name='third_machine').cmd(
231               'human-monitor-command',
234           self.assertEqual(first_res, second_res, third_res)
258       def test(self):
259           self.launch_and_wait()
260           self.ssh_command('some_command_to_be_run_in_the_guest')
266 -----------
269 device-crash-test and other Python scripts.  It's a wrapper around the
285 The QEMU binary used for the ``self.vm`` QEMUMachine instance will
297    "qemu-system-${arch}", either in the current
298    working directory, or in the current source tree.
304 -------------------
362 dynamic probe for a QEMU binary in the current working directory or
378 https://avocado-framework.readthedocs.io/en/latest/guides/writer/libs/vmimage.html#supported-images
387 https://avocado-framework.readthedocs.io/en/latest/guides/writer/libs/vmimage.html#supported-images
399 -------------------
404 …https://avocado-framework.readthedocs.io/en/latest/guides/writer/chapters/writing.html#accessing-t…
411   PARAMS (key=qemu_bin, path=*, default=./qemu-system-x86_64) => './qemu-system-x86_64
459 https://avocado-framework.readthedocs.io/en/latest/guides/writer/libs/vmimage.html#supported-images
468 https://avocado-framework.readthedocs.io/en/latest/guides/writer/libs/vmimage.html#supported-images
479 --------------
486 …https://avocado-framework.readthedocs.io/en/latest/guides/writer/chapters/writing.html#skipping-te…
531 …https://avocado-framework.readthedocs.io/en/latest/guides/writer/chapters/writing.html#setting-a-t…
534 that may not have a well-defined limit of time to finish under certain
541 Some tests are not working reliably and thus are disabled by default.
550   # See https://gitlab.com/qemu-project/qemu/-/issues/nnnn
552   def test(self):
555 You can also add ``:avocado: tags=flaky`` to the test meta-data so
561       run tests/avocado -filter-by-tags=flaky
568 --------------------
574   pip list --user
580 If you've used ``make check-avocado``, the Python virtual environment where
581 Avocado is installed will be cleaned up as part of ``make check-clean``.