Message ID | 20240724175248.1389201-1-thuth@redhat.com (mailing list archive) |
---|---|
Headers | show |
Series | Convert avocado tests to normal Python unittests | expand |
On 7/25/24 03:52, Thomas Huth wrote: > The Avocado v88 that we use in QEMU is already on a life support > system: It is not supported by upstream anymore, and with the latest > versions of Python, it won't work anymore since it depends on the > "imp" module that has been removed in Python 3.12. > > There have been several attempts to update the test suite in QEMU > to a newer version of Avocado, but so far no attempt has successfully > been merged yet. > > Additionally, the whole "make check" test suite in QEMU is using the > meson test runner nowadays, so running the python-based tests via the > Avocodo test runner looks and feels quite like an oddball, requiring > the users to deal with the knowledge of multiple test runners in > parallel (e.g. the timeout settings work completely differently). > > So instead of trying to update the python-based test suite in QEMU > to a newer version of Avocado, we should try to better integrate > it with the meson test runner instead. Indeed most tests work quite > nicely without the Avocado framework already, as you can see with > this patch series - it does not convert all tests, just a subset so > far, but this already proves that many tests only need small modifi- > cations to work without Avocado. > > Only tests that use the LinuxTest / LinuxDistro and LinuxSSHMixIn > classes (e.g. based on cloud-init images or using SSH) really depend > on the Avocado framework, so we'd need a solution for those if we > want to continue using them. One solution might be to simply use the > required functions from avocado.utils for these tests, and still run > them via the meson test runner instead, but that needs some further > investigation that will be done later. > > > Now if you want to try out these patches: Apply the patches, then > recompile and then run: > > make check-functional > > You can also run single targets e.g. with: > > make check-functional-ppc > > You can also run the tests without any test runner now by > setting the PYTHONPATH environment variable to the "python" folder > of your source tree, and by specifying the build directory via > QEMU_BUILD_ROOT (if autodetection fails) and by specifying the > QEMU binary via QEMU_TEST_QEMU_BINARY. For example: > > export PYTHONPATH=$HOME/qemu/python > export QEMU_TEST_QEMU_BINARY=qemu-system-x86_64 > export QEMU_BUILD_ROOT=$HOME/qemu/build > ~/qemu/tests/functional/test_virtio_version.py > > The logs of the tests can be found in the build directory under > tests/functional/<arch>/<testname> - console log and general logs will > be put in separate files there. > > Still to be done: Update the documentation for this new test framework. I'll say again that the download *must* be handled separately from the test with timeout. This is an absolute show-stopper. I've tried this twice now, from a decently fast connection in central Brisbane, and have had multiple downloads be canceled by the timeout. Since the download isn't clever enough to pick up where it left off, it will never succeed. r~
On Thu, Jul 25, 2024 at 09:35:22AM +1000, Richard Henderson wrote: > On 7/25/24 03:52, Thomas Huth wrote: > > The Avocado v88 that we use in QEMU is already on a life support > > system: It is not supported by upstream anymore, and with the latest > > versions of Python, it won't work anymore since it depends on the > > "imp" module that has been removed in Python 3.12. > > > > There have been several attempts to update the test suite in QEMU > > to a newer version of Avocado, but so far no attempt has successfully > > been merged yet. > > > > Additionally, the whole "make check" test suite in QEMU is using the > > meson test runner nowadays, so running the python-based tests via the > > Avocodo test runner looks and feels quite like an oddball, requiring > > the users to deal with the knowledge of multiple test runners in > > parallel (e.g. the timeout settings work completely differently). > > > > So instead of trying to update the python-based test suite in QEMU > > to a newer version of Avocado, we should try to better integrate > > it with the meson test runner instead. Indeed most tests work quite > > nicely without the Avocado framework already, as you can see with > > this patch series - it does not convert all tests, just a subset so > > far, but this already proves that many tests only need small modifi- > > cations to work without Avocado. > > > > Only tests that use the LinuxTest / LinuxDistro and LinuxSSHMixIn > > classes (e.g. based on cloud-init images or using SSH) really depend > > on the Avocado framework, so we'd need a solution for those if we > > want to continue using them. One solution might be to simply use the > > required functions from avocado.utils for these tests, and still run > > them via the meson test runner instead, but that needs some further > > investigation that will be done later. > > > > > > Now if you want to try out these patches: Apply the patches, then > > recompile and then run: > > > > make check-functional > > > > You can also run single targets e.g. with: > > > > make check-functional-ppc > > > > You can also run the tests without any test runner now by > > setting the PYTHONPATH environment variable to the "python" folder > > of your source tree, and by specifying the build directory via > > QEMU_BUILD_ROOT (if autodetection fails) and by specifying the > > QEMU binary via QEMU_TEST_QEMU_BINARY. For example: > > > > export PYTHONPATH=$HOME/qemu/python > > export QEMU_TEST_QEMU_BINARY=qemu-system-x86_64 > > export QEMU_BUILD_ROOT=$HOME/qemu/build > > ~/qemu/tests/functional/test_virtio_version.py > > > > The logs of the tests can be found in the build directory under > > tests/functional/<arch>/<testname> - console log and general logs will > > be put in separate files there. > > > > Still to be done: Update the documentation for this new test framework. > > I'll say again that the download *must* be handled separately from the test > with timeout. This is an absolute show-stopper. > > I've tried this twice now, from a decently fast connection in central > Brisbane, and have had multiple downloads be canceled by the timeout. Since > the download isn't clever enough to pick up where it left off, it will never > succeed. This is a tricky problem the way the tests are currently written, given the desire for a minimal-change from the old avocado impl. IIUC, avocado already had a per-test timeout, so would suffer the same problem with downloads exploding the "normal" running time when cached. To address this we'll need a refactoring to enable us to declare the required "assets" externally from the test code. Taking one simple example class LinuxInitrd(QemuSystemTest): def test_with_2gib_file_should_exit_error_msg_with_linux_v3_6(self): kernel_url = ('https://archives.fedoraproject.org/pub/archive/fedora/li' 'nux/releases/18/Fedora/x86_64/os/images/pxeboot/vmlinuz') kernel_hash = '41464f68efe42b9991250bed86c7081d2ccdbb21' kernel_path = self.fetch_asset(kernel_url, asset_hash=kernel_hash) ...snip... if __name__ == '__main__': QemuSystemTest.main() Consider if we declared all required assets as class level variable class LinuxInitrd(QemuSystemTest): ASSETS = { "fedora18": { "url": ('https://archives.fedoraproject.org/pub/archive/fedora/li' 'nux/releases/18/Fedora/x86_64/os/images/pxeboot/vmlinuz'), "hash": "'41464f68efe42b9991250bed86c7081d2ccdbb21'" } } Then, we change the 'fetch_asset' method to take an asset name, not a URL+hash: def test_with_2gib_file_should_exit_error_msg_with_linux_v3_6(self): kernel_path = self.fetch_asset("fedora18") Now, 'fetch_asset' would lookup the URL + hash in the self.__class__.ASSETS dict, so the test would run exactly as before. Finally, we modify QemuSystemTest.main() so that knows to look for a '--fetch-assets' parameter in sys.argv. When it see --fetch-assets, instead of running each test, it should download everything found in the ASSETS class variables. This now gives us the ability to run a separate '--fetch-assets' invokation with elevated timeout, while runing tests with a normal timeout. This is all a non-trivial amount of work though, so I don't think it is reasonable todo this as part of the immediate conversion in this series. The only short term option is to configure meson run tests with a massively larger timeout, until we're able to enable some pre-caching mechansim. With regards, Daniel
On 25/07/2024 01.35, Richard Henderson wrote: > On 7/25/24 03:52, Thomas Huth wrote: >> The Avocado v88 that we use in QEMU is already on a life support >> system: It is not supported by upstream anymore, and with the latest >> versions of Python, it won't work anymore since it depends on the >> "imp" module that has been removed in Python 3.12. >> >> There have been several attempts to update the test suite in QEMU >> to a newer version of Avocado, but so far no attempt has successfully >> been merged yet. >> >> Additionally, the whole "make check" test suite in QEMU is using the >> meson test runner nowadays, so running the python-based tests via the >> Avocodo test runner looks and feels quite like an oddball, requiring >> the users to deal with the knowledge of multiple test runners in >> parallel (e.g. the timeout settings work completely differently). >> >> So instead of trying to update the python-based test suite in QEMU >> to a newer version of Avocado, we should try to better integrate >> it with the meson test runner instead. Indeed most tests work quite >> nicely without the Avocado framework already, as you can see with >> this patch series - it does not convert all tests, just a subset so >> far, but this already proves that many tests only need small modifi- >> cations to work without Avocado. >> >> Only tests that use the LinuxTest / LinuxDistro and LinuxSSHMixIn >> classes (e.g. based on cloud-init images or using SSH) really depend >> on the Avocado framework, so we'd need a solution for those if we >> want to continue using them. One solution might be to simply use the >> required functions from avocado.utils for these tests, and still run >> them via the meson test runner instead, but that needs some further >> investigation that will be done later. >> >> >> Now if you want to try out these patches: Apply the patches, then >> recompile and then run: >> >> make check-functional >> >> You can also run single targets e.g. with: >> >> make check-functional-ppc >> >> You can also run the tests without any test runner now by >> setting the PYTHONPATH environment variable to the "python" folder >> of your source tree, and by specifying the build directory via >> QEMU_BUILD_ROOT (if autodetection fails) and by specifying the >> QEMU binary via QEMU_TEST_QEMU_BINARY. For example: >> >> export PYTHONPATH=$HOME/qemu/python >> export QEMU_TEST_QEMU_BINARY=qemu-system-x86_64 >> export QEMU_BUILD_ROOT=$HOME/qemu/build >> ~/qemu/tests/functional/test_virtio_version.py >> >> The logs of the tests can be found in the build directory under >> tests/functional/<arch>/<testname> - console log and general logs will >> be put in separate files there. >> >> Still to be done: Update the documentation for this new test framework. > > I'll say again that the download *must* be handled separately from the test > with timeout. This is an absolute show-stopper. > > I've tried this twice now, from a decently fast connection in central > Brisbane, and have had multiple downloads be canceled by the timeout. Since > the download isn't clever enough to pick up where it left off, it will never > succeed. Hi Richard, just for my understanding, did you try to run the tests in parallel (i.e. something like "make -j$(nproc)")? ... I think in that case you can easily clog your internet connection even on modern systems if a lot of tests are trying to download the assets in parallel. For me, it works fine if I use normal serial testing with "-j" (btw. Avocado v88 is doing serial testing, too, so you won't lose much time during the first run here). But if downloading fails for you without "-j", too, I agree, we need to tackle that problem first, e.g. by implementing what Daniel suggested. That will take a little bit longer, of course, so I hope you meanwhile found a work-around for the problem with the missing "imp" package on your system? Thomas
On 7/25/24 19:55, Daniel P. Berrangé wrote: > On Thu, Jul 25, 2024 at 09:35:22AM +1000, Richard Henderson wrote: >> On 7/25/24 03:52, Thomas Huth wrote: >>> The Avocado v88 that we use in QEMU is already on a life support >>> system: It is not supported by upstream anymore, and with the latest >>> versions of Python, it won't work anymore since it depends on the >>> "imp" module that has been removed in Python 3.12. >>> >>> There have been several attempts to update the test suite in QEMU >>> to a newer version of Avocado, but so far no attempt has successfully >>> been merged yet. >>> >>> Additionally, the whole "make check" test suite in QEMU is using the >>> meson test runner nowadays, so running the python-based tests via the >>> Avocodo test runner looks and feels quite like an oddball, requiring >>> the users to deal with the knowledge of multiple test runners in >>> parallel (e.g. the timeout settings work completely differently). >>> >>> So instead of trying to update the python-based test suite in QEMU >>> to a newer version of Avocado, we should try to better integrate >>> it with the meson test runner instead. Indeed most tests work quite >>> nicely without the Avocado framework already, as you can see with >>> this patch series - it does not convert all tests, just a subset so >>> far, but this already proves that many tests only need small modifi- >>> cations to work without Avocado. >>> >>> Only tests that use the LinuxTest / LinuxDistro and LinuxSSHMixIn >>> classes (e.g. based on cloud-init images or using SSH) really depend >>> on the Avocado framework, so we'd need a solution for those if we >>> want to continue using them. One solution might be to simply use the >>> required functions from avocado.utils for these tests, and still run >>> them via the meson test runner instead, but that needs some further >>> investigation that will be done later. >>> >>> >>> Now if you want to try out these patches: Apply the patches, then >>> recompile and then run: >>> >>> make check-functional >>> >>> You can also run single targets e.g. with: >>> >>> make check-functional-ppc >>> >>> You can also run the tests without any test runner now by >>> setting the PYTHONPATH environment variable to the "python" folder >>> of your source tree, and by specifying the build directory via >>> QEMU_BUILD_ROOT (if autodetection fails) and by specifying the >>> QEMU binary via QEMU_TEST_QEMU_BINARY. For example: >>> >>> export PYTHONPATH=$HOME/qemu/python >>> export QEMU_TEST_QEMU_BINARY=qemu-system-x86_64 >>> export QEMU_BUILD_ROOT=$HOME/qemu/build >>> ~/qemu/tests/functional/test_virtio_version.py >>> >>> The logs of the tests can be found in the build directory under >>> tests/functional/<arch>/<testname> - console log and general logs will >>> be put in separate files there. >>> >>> Still to be done: Update the documentation for this new test framework. >> >> I'll say again that the download *must* be handled separately from the test >> with timeout. This is an absolute show-stopper. >> >> I've tried this twice now, from a decently fast connection in central >> Brisbane, and have had multiple downloads be canceled by the timeout. Since >> the download isn't clever enough to pick up where it left off, it will never >> succeed. > > This is a tricky problem the way the tests are currently written, given the > desire for a minimal-change from the old avocado impl. > > IIUC, avocado already had a per-test timeout, so would suffer the same > problem with downloads exploding the "normal" running time when cached. Avocado runs a first pass doing all of the downloads, and only afterward runs the actual timed tests. I don't know the specifics of how, but it certainly obvious in the logging. > Consider if we declared all required assets as class level variable > > class LinuxInitrd(QemuSystemTest): > > ASSETS = { > "fedora18": { > "url": ('https://archives.fedoraproject.org/pub/archive/fedora/li' > 'nux/releases/18/Fedora/x86_64/os/images/pxeboot/vmlinuz'), > "hash": "'41464f68efe42b9991250bed86c7081d2ccdbb21'" > } > } > > Then, we change the 'fetch_asset' method to take an asset name, not a > URL+hash: > > def test_with_2gib_file_should_exit_error_msg_with_linux_v3_6(self): > kernel_path = self.fetch_asset("fedora18") > > Now, 'fetch_asset' would lookup the URL + hash in the self.__class__.ASSETS > dict, so the test would run exactly as before. Sure, that's one possibility. > This is all a non-trivial amount of work though, so I don't think > it is reasonable todo this as part of the immediate conversion in > this series. I think that if we *don't* do this, then we cannot run in CI *at all* because we will be plagued with false timeouts. And, frankly, any developer more than a few time zones away from the hosting of the asset will be continually frustrated. I repeat: this is a show-stopper. r~
On 7/25/24 20:13, Thomas Huth wrote: > Hi Richard, > > just for my understanding, did you try to run the tests in parallel (i.e. something like > "make -j$(nproc)")? No, I ran "make check-functional" with zero parallelism. > For me, it works fine if I use normal serial testing with "-j" (btw. Avocado v88 is doing > serial testing, too, so you won't lose much time during the first run here). But if > downloading fails for you without "-j", too, I agree, we need to tackle that problem > first, e.g. by implementing what Daniel suggested. That will take a little bit longer, of > course, so I hope you meanwhile found a work-around for the problem with the missing "imp" > package on your system? Not so far. I'm using VMs for avocado testing at present. r~
On Thu, Jul 25, 2024 at 08:42:31PM +1000, Richard Henderson wrote: > On 7/25/24 19:55, Daniel P. Berrangé wrote: > > On Thu, Jul 25, 2024 at 09:35:22AM +1000, Richard Henderson wrote: > > > On 7/25/24 03:52, Thomas Huth wrote: > > > > The Avocado v88 that we use in QEMU is already on a life support > > > > system: It is not supported by upstream anymore, and with the latest > > > > versions of Python, it won't work anymore since it depends on the > > > > "imp" module that has been removed in Python 3.12. > > > > > > > > There have been several attempts to update the test suite in QEMU > > > > to a newer version of Avocado, but so far no attempt has successfully > > > > been merged yet. > > > > > > > > Additionally, the whole "make check" test suite in QEMU is using the > > > > meson test runner nowadays, so running the python-based tests via the > > > > Avocodo test runner looks and feels quite like an oddball, requiring > > > > the users to deal with the knowledge of multiple test runners in > > > > parallel (e.g. the timeout settings work completely differently). > > > > > > > > So instead of trying to update the python-based test suite in QEMU > > > > to a newer version of Avocado, we should try to better integrate > > > > it with the meson test runner instead. Indeed most tests work quite > > > > nicely without the Avocado framework already, as you can see with > > > > this patch series - it does not convert all tests, just a subset so > > > > far, but this already proves that many tests only need small modifi- > > > > cations to work without Avocado. > > > > > > > > Only tests that use the LinuxTest / LinuxDistro and LinuxSSHMixIn > > > > classes (e.g. based on cloud-init images or using SSH) really depend > > > > on the Avocado framework, so we'd need a solution for those if we > > > > want to continue using them. One solution might be to simply use the > > > > required functions from avocado.utils for these tests, and still run > > > > them via the meson test runner instead, but that needs some further > > > > investigation that will be done later. > > > > > > > > > > > > Now if you want to try out these patches: Apply the patches, then > > > > recompile and then run: > > > > > > > > make check-functional > > > > > > > > You can also run single targets e.g. with: > > > > > > > > make check-functional-ppc > > > > > > > > You can also run the tests without any test runner now by > > > > setting the PYTHONPATH environment variable to the "python" folder > > > > of your source tree, and by specifying the build directory via > > > > QEMU_BUILD_ROOT (if autodetection fails) and by specifying the > > > > QEMU binary via QEMU_TEST_QEMU_BINARY. For example: > > > > > > > > export PYTHONPATH=$HOME/qemu/python > > > > export QEMU_TEST_QEMU_BINARY=qemu-system-x86_64 > > > > export QEMU_BUILD_ROOT=$HOME/qemu/build > > > > ~/qemu/tests/functional/test_virtio_version.py > > > > > > > > The logs of the tests can be found in the build directory under > > > > tests/functional/<arch>/<testname> - console log and general logs will > > > > be put in separate files there. > > > > > > > > Still to be done: Update the documentation for this new test framework. > > > > > > I'll say again that the download *must* be handled separately from the test > > > with timeout. This is an absolute show-stopper. > > > > > > I've tried this twice now, from a decently fast connection in central > > > Brisbane, and have had multiple downloads be canceled by the timeout. Since > > > the download isn't clever enough to pick up where it left off, it will never > > > succeed. > > > > This is a tricky problem the way the tests are currently written, given the > > desire for a minimal-change from the old avocado impl. > > > > IIUC, avocado already had a per-test timeout, so would suffer the same > > problem with downloads exploding the "normal" running time when cached. > > Avocado runs a first pass doing all of the downloads, and only afterward > runs the actual timed tests. I don't know the specifics of how, but it > certainly obvious in the logging. Oh interesting, I found how it does it.. The file avocado/plugins/assets.py will build an AST of the python code in a test file, look for all 'fetch_asset' calls, then extract the parameters to these calls, and donwload them. This is clever. Basically avoids the refactoring that I suggested. So yeah, that is a gap. Practically speaking, we have a choice of either calling into this avocado python lib as is, or copying tthat python lib into QEMU. With regards, Daniel
On 25/07/2024 13.07, Daniel P. Berrangé wrote: > On Thu, Jul 25, 2024 at 08:42:31PM +1000, Richard Henderson wrote: >> On 7/25/24 19:55, Daniel P. Berrangé wrote: >>> On Thu, Jul 25, 2024 at 09:35:22AM +1000, Richard Henderson wrote: ... >> Avocado runs a first pass doing all of the downloads, and only afterward >> runs the actual timed tests. I don't know the specifics of how, but it >> certainly obvious in the logging. > > Oh interesting, I found how it does it.. > > The file avocado/plugins/assets.py will build an AST of the python > code in a test file, look for all 'fetch_asset' calls, then extract > the parameters to these calls, and donwload them. This is clever. > Basically avoids the refactoring that I suggested. > > So yeah, that is a gap. > > Practically speaking, we have a choice of either calling into this > avocado python lib as is, or copying tthat python lib into QEMU. Honestly, I'd prefer to do some refactoring instead, something like you suggested in your earlier mail. Rationale: For the basic tests it would be good if we would not depend on the Avacodo framework anymore, otherwise we likely will continue to run into the situation that our test framework stops working on some random new python versions and nobody within the QEMU community has a clue how to fix the situation since nobody is really familiar with the Avocado framework. Also, while that avocado/plugins/assets.py sounds like a very neat trick done by a skilled Python wizard, the average QEMU developer (like me) is just a skilled C coder with only basic Python knowledge, so I'd prefer if we could use a simpler mechanism instead that is easier to understand and to debug for everybody once we run into problems with it. Thus, I'd suggest to bite the bullet and refactor the tests that download assets. I can look into this after my summer vacation - but if somebody feels interested and wants to look into this during the next two weeks already, that would be very welcome, too, of course! Thomas
On Fri, Jul 26, 2024 at 9:04 AM Thomas Huth <thuth@redhat.com> wrote: > > On 25/07/2024 13.07, Daniel P. Berrangé wrote: > > On Thu, Jul 25, 2024 at 08:42:31PM +1000, Richard Henderson wrote: > >> On 7/25/24 19:55, Daniel P. Berrangé wrote: > >>> On Thu, Jul 25, 2024 at 09:35:22AM +1000, Richard Henderson wrote: > ... > >> Avocado runs a first pass doing all of the downloads, and only afterward > >> runs the actual timed tests. I don't know the specifics of how, but it > >> certainly obvious in the logging. > > > > Oh interesting, I found how it does it.. > > > > The file avocado/plugins/assets.py will build an AST of the python > > code in a test file, look for all 'fetch_asset' calls, then extract > > the parameters to these calls, and donwload them. This is clever. > > Basically avoids the refactoring that I suggested. > > > > So yeah, that is a gap. > > > > Practically speaking, we have a choice of either calling into this > > avocado python lib as is, or copying tthat python lib into QEMU. > > Honestly, I'd prefer to do some refactoring instead, something like you > suggested in your earlier mail. Rationale: For the basic tests it would be > good if we would not depend on the Avacodo framework anymore, otherwise we > likely will continue to run into the situation that our test framework stops > working on some random new python versions and nobody within the QEMU > community has a clue how to fix the situation since nobody is really > familiar with the Avocado framework. Also, while that > avocado/plugins/assets.py sounds like a very neat trick done by a skilled > Python wizard, the average QEMU developer (like me) is just a skilled C > coder with only basic Python knowledge, so I'd prefer if we could use a > simpler mechanism instead that is easier to understand and to debug for > everybody once we run into problems with it. > Hi Thomas, That wizardry is indeed not nice, and has limitations. It was replaced in recent Avocado versions for the dependencies mechanism: https://avocado-framework.readthedocs.io/en/103.0/guides/user/chapters/dependencies.html Specifically for the assets (downloadable files), you can find the documentation here: https://avocado-framework.readthedocs.io/en/103.0/guides/user/chapters/dependencies.html#asset Those are superior to the previous implementation because they compute a dependency graph that works on the resolution while tests with dependencies met (or no deps) start running right away. Regards, - Cleber.
On 25/7/24 01:35, Richard Henderson wrote: > On 7/25/24 03:52, Thomas Huth wrote: > I'll say again that the download *must* be handled separately from the > test with timeout. This is an absolute show-stopper. Queuing patches not related to assets downloading (1-6, 13, 15 and 23).