Re: [Qemu-devel] [PATCH v4 2/3] Acceptance tests: add make rule for running them
On 10/12/18 5:37 PM, Philippe Mathieu-Daudé wrote: > On 12/10/2018 18:53, Cleber Rosa wrote: >> The acceptance (aka functional, aka Avocado-based) tests are >> Python files located in "tests/acceptance" that need to be run >> with the Avocado libs and test runner. >> >> Let's provide a convenient way for QEMU developers to run them, >> by making use of the tests-venv with the required setup. >> >> Also, while the Avocado test runner will take care of creating a >> location to save test results to, it was understood that it's better >> if the results are kept within the build tree. >> >> Signed-off-by: Cleber Rosa >> --- >> docs/devel/testing.rst | 35 ++- >> tests/Makefile.include | 21 +++-- >> tests/venv-requirements.txt | 1 + >> 3 files changed, 50 insertions(+), 7 deletions(-) >> >> diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst >> index 727c4019b5..b992a2961d 100644 >> --- a/docs/devel/testing.rst >> +++ b/docs/devel/testing.rst >> @@ -545,10 +545,31 @@ Tests based on ``avocado_qemu.Test`` can easily: >> - >> http://avocado-framework.readthedocs.io/en/latest/api/test/avocado.html#avocado.Test >> - >> http://avocado-framework.readthedocs.io/en/latest/api/utils/avocado.utils.html >> >> -Installation >> - >> +Running tests >> +- >> >> -To install Avocado and its dependencies, run: >> +You can run the acceptance tests simply by executing: >> + >> +.. code:: >> + >> + make check-acceptance >> + >> +This involves the automatic creation of Python virtual environment >> +within the build tree (at ``tests/venv``) which will have all the >> +right dependencies, and will save tests results also within the >> +build tree (at ``tests/results``). > > Missing: how to activate the virtualenv. > I think there's a clear difference in expectations here... the goal of the venv is not be emphasized... IMO it's supposed to be as transparent as possible. >> + >> +Note: the build environment must be using a Python 3 stack, and have >> +the ``venv`` and ``pip`` packages installed. If necessary, make sure >> +``configure`` is called with ``--python=`` and that those modules are >> +available. On Debian and Ubuntu based systems, depending on the >> +specific version, they may be on packages named ``python3-venv`` and >> +``python3-pip``. >> + >> +Manual Installation >> +--- >> + >> +To manually install Avocado and its dependencies, run: >> >> .. code:: >> >> @@ -689,11 +710,15 @@ The exact QEMU binary to be used on QEMUMachine. >> Uninstalling Avocado >> >> >> -If you've followed the installation instructions above, you can easily >> -uninstall Avocado. Start by listing the packages you have installed:: >> +If you've followed the manual installation instructions above, you can >> +easily uninstall Avocado. Start by listing the packages you have >> +installed:: >> >>pip list --user >> >> And remove any package you want with:: >> >>pip uninstall >> + >> +If you've used ``make check-acceptance``, the Python virtual environment >> where >> +Avocado is installed will be cleaned up as part of ``make check-clean``. > > Add a line about deactivating the venv? > Ditto here. Anyway, I can change it if most people think the venv usage should be explicit (I'm clearly against it, though). - Cleber. >> diff --git a/tests/Makefile.include b/tests/Makefile.include >> index b66180efa1..75547fc947 100644 >> --- a/tests/Makefile.include >> +++ b/tests/Makefile.include >> @@ -11,6 +11,7 @@ check-help: >> @echo " $(MAKE) check-qapi-schemaRun QAPI schema tests" >> @echo " $(MAKE) check-block Run block tests" >> @echo " $(MAKE) check-tcgRun TCG tests" >> +@echo " $(MAKE) check-acceptance Run all acceptance (functional) >> tests" >> @echo " $(MAKE) check-report.htmlGenerates an HTML test report" >> @echo " $(MAKE) check-venv Creates a Python venv for tests" >> @echo " $(MAKE) check-clean Clean the tests" >> @@ -1020,10 +1021,15 @@ check-decodetree: >> >> # Python venv for running tests >> >> -.PHONY: check-venv >> +.PHONY: check-venv check-acceptance >> >> TESTS_VENV_DIR=$(BUILD_DIR)/tests/venv >> TESTS_VENV_REQ=$(SRC_PATH)/tests/venv-requirements.txt >> +TESTS_RESULTS_DIR=$(BUILD_DIR)/tests/results >> +# Controls the output generated by Avocado when running tests. >> +# Any number of command separated loggers are accepted. For more >> +# information please refer to "avocado --help". >> +AVOCADO_SHOW=none >> >> $(TESTS_VENV_DIR): $(TESTS_VENV_REQ) >> $(call quiet-command, \ >> @@ -1034,8 +1040,19 @@ $(TESTS_VENV_DIR): $(TESTS_VENV_REQ) >> PIP, $(TESTS_VENV_REQ)) >> $(call quiet-command, touch $@) >> >> +$(TESTS_RESULTS_DIR): >> +$(call quiet-command, mkdir -p $@, \ >> +MKDIR, $@) >> + >> check-venv: $(TESTS_VENV_DIR) >>
Re: [Qemu-devel] [PATCH v4 2/3] Acceptance tests: add make rule for running them
On 12/10/2018 18:53, Cleber Rosa wrote: > The acceptance (aka functional, aka Avocado-based) tests are > Python files located in "tests/acceptance" that need to be run > with the Avocado libs and test runner. > > Let's provide a convenient way for QEMU developers to run them, > by making use of the tests-venv with the required setup. > > Also, while the Avocado test runner will take care of creating a > location to save test results to, it was understood that it's better > if the results are kept within the build tree. > > Signed-off-by: Cleber Rosa > --- > docs/devel/testing.rst | 35 ++- > tests/Makefile.include | 21 +++-- > tests/venv-requirements.txt | 1 + > 3 files changed, 50 insertions(+), 7 deletions(-) > > diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst > index 727c4019b5..b992a2961d 100644 > --- a/docs/devel/testing.rst > +++ b/docs/devel/testing.rst > @@ -545,10 +545,31 @@ Tests based on ``avocado_qemu.Test`` can easily: > - > http://avocado-framework.readthedocs.io/en/latest/api/test/avocado.html#avocado.Test > - > http://avocado-framework.readthedocs.io/en/latest/api/utils/avocado.utils.html > > -Installation > - > +Running tests > +- > > -To install Avocado and its dependencies, run: > +You can run the acceptance tests simply by executing: > + > +.. code:: > + > + make check-acceptance > + > +This involves the automatic creation of Python virtual environment > +within the build tree (at ``tests/venv``) which will have all the > +right dependencies, and will save tests results also within the > +build tree (at ``tests/results``). Missing: how to activate the virtualenv. > + > +Note: the build environment must be using a Python 3 stack, and have > +the ``venv`` and ``pip`` packages installed. If necessary, make sure > +``configure`` is called with ``--python=`` and that those modules are > +available. On Debian and Ubuntu based systems, depending on the > +specific version, they may be on packages named ``python3-venv`` and > +``python3-pip``. > + > +Manual Installation > +--- > + > +To manually install Avocado and its dependencies, run: > > .. code:: > > @@ -689,11 +710,15 @@ The exact QEMU binary to be used on QEMUMachine. > Uninstalling Avocado > > > -If you've followed the installation instructions above, you can easily > -uninstall Avocado. Start by listing the packages you have installed:: > +If you've followed the manual installation instructions above, you can > +easily uninstall Avocado. Start by listing the packages you have > +installed:: > >pip list --user > > And remove any package you want with:: > >pip uninstall > + > +If you've used ``make check-acceptance``, the Python virtual environment > where > +Avocado is installed will be cleaned up as part of ``make check-clean``. Add a line about deactivating the venv? > diff --git a/tests/Makefile.include b/tests/Makefile.include > index b66180efa1..75547fc947 100644 > --- a/tests/Makefile.include > +++ b/tests/Makefile.include > @@ -11,6 +11,7 @@ check-help: > @echo " $(MAKE) check-qapi-schemaRun QAPI schema tests" > @echo " $(MAKE) check-block Run block tests" > @echo " $(MAKE) check-tcgRun TCG tests" > + @echo " $(MAKE) check-acceptance Run all acceptance (functional) > tests" > @echo " $(MAKE) check-report.htmlGenerates an HTML test report" > @echo " $(MAKE) check-venv Creates a Python venv for tests" > @echo " $(MAKE) check-clean Clean the tests" > @@ -1020,10 +1021,15 @@ check-decodetree: > > # Python venv for running tests > > -.PHONY: check-venv > +.PHONY: check-venv check-acceptance > > TESTS_VENV_DIR=$(BUILD_DIR)/tests/venv > TESTS_VENV_REQ=$(SRC_PATH)/tests/venv-requirements.txt > +TESTS_RESULTS_DIR=$(BUILD_DIR)/tests/results > +# Controls the output generated by Avocado when running tests. > +# Any number of command separated loggers are accepted. For more > +# information please refer to "avocado --help". > +AVOCADO_SHOW=none > > $(TESTS_VENV_DIR): $(TESTS_VENV_REQ) > $(call quiet-command, \ > @@ -1034,8 +1040,19 @@ $(TESTS_VENV_DIR): $(TESTS_VENV_REQ) > PIP, $(TESTS_VENV_REQ)) > $(call quiet-command, touch $@) > > +$(TESTS_RESULTS_DIR): > + $(call quiet-command, mkdir -p $@, \ > +MKDIR, $@) > + > check-venv: $(TESTS_VENV_DIR) > > +check-acceptance: check-venv $(TESTS_RESULTS_DIR) > + $(call quiet-command, \ > +$(TESTS_VENV_DIR)/bin/python -m avocado \ > +--show=$(AVOCADO_SHOW) run > --job-results-dir=$(TESTS_RESULTS_DIR) \ > +--failfast=on $(SRC_PATH)/tests/acceptance, \ > +"AVOCADO", "tests/acceptance") > + > # Consolidated targets > > .PHONY: check-qapi-schema check-qtest check-unit check check-clean > @@ -1049,7 +1066,7 @@ chec
