From f568fb219fff5b502882d591ddcc6bd5cc84c7a2 Mon Sep 17 00:00:00 2001 From: Jake Hunsaker Date: Wed, 27 Jan 2021 09:55:39 -0500 Subject: [tests] Start using avocado for test suite This commit represents the start of an overhaul of the test suite used by sos. Note that several more commits to follow will be required in order for the test suite to be considered stable. The new test suite will use the avocado-framework to build out new tests. This first part adopts a new 'stageX' naming scheme for our tests as follows: stage0 -> Unittests stage1 -> Basic function tests, no mocking allowed stage2 -> Mocked tests for specific scenarios/regressions stage3 -> Complex setups for layered products/environments At the moment, these unittests are not updated for avocado, though most should still work with `nosetest` directly. A new set of base classes is defined in tests/sos_tests.py which provide the foundation for actual tests cases. This approach entails new test cases subclassing a base class, such as the new `StageOneReportTest`, and setting the `sos_cmd` class attr to the _options_ for an sos report run. By default `sos report --batch` will be run, and targeted to the test job's directory as a tmpdir. Each sos command will be executed once, and all test_* methods within a test case that subclasses `StageOneReportTest` will be checked against the output of that execution. Note that this diverges from avocado's typical approach where each test_* method is performed against a brand new instance of the class (thus meaning any setup including our sos report run would normally be run fresh). However, after speaking with the avocado devel team, this is still seen as a valid pattern for the framework. The current organizational approach is to separate the tests by component rather than stage. For example. `tests/report_tests/` should hold any report-centric tests, and the `plugin_tests` directory therein should be used for plugin-specific tests. As of this commit, there are basic functionality tests under `tests/report_tests/` and a single plugin test under `tests/report_tests/plugin_tests/` to act as a POC. Further, there is a `tests/vendor_tests/` directory for organizing vendor-specific bug/feature tests that are not covered by the generic project-wide tests. A POC test from RHBZ1928628 is available with this commit. Note that in order for these tests to be run properly _without_ installing the current branch to the local system, you will need to run the following command: `PYTHONPATH=tests/ avocado run -t stageone tests/` Related: #2431 Signed-off-by: Jake Hunsaker --- tests/vendor_tests/__init__.py | 0 tests/vendor_tests/redhat/__init__.py | 0 tests/vendor_tests/redhat/rhbz1928628.py | 44 ++++++++++++++++++++++++++++++++ 3 files changed, 44 insertions(+) create mode 100644 tests/vendor_tests/__init__.py create mode 100644 tests/vendor_tests/redhat/__init__.py create mode 100644 tests/vendor_tests/redhat/rhbz1928628.py (limited to 'tests/vendor_tests') diff --git a/tests/vendor_tests/__init__.py b/tests/vendor_tests/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/tests/vendor_tests/redhat/__init__.py b/tests/vendor_tests/redhat/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/tests/vendor_tests/redhat/rhbz1928628.py b/tests/vendor_tests/redhat/rhbz1928628.py new file mode 100644 index 00000000..00746658 --- /dev/null +++ b/tests/vendor_tests/redhat/rhbz1928628.py @@ -0,0 +1,44 @@ +# This file is part of the sos project: https://github.com/sosreport/sos +# +# This copyrighted material is made available to anyone wishing to use, +# modify, copy, or redistribute it subject to the terms and conditions of +# version 2 of the GNU General Public License. +# +# See the LICENSE file in the source distribution for further information. + + +from report_tests.plugin_tests.networking import NetworkingPluginTest + + +class rhbz1928628(NetworkingPluginTest): + """ + Only collect an eeprom dump when requested, as otherwise this can cause + NIC flaps. + + https://bugzilla.redhat.com/show_bug.cgi?id=1928628 + + :avocado: enable + :avocado: tags=stageone + """ + + sos_cmd = '-o networking' + + def test_eeprom_dump_not_collected(self): + self.assertFileGlobNotInArchive('sos_commands/networking/ethtool_-e*') + + +class rhbz1928628Enabled(NetworkingPluginTest): + """ + Enable the option to perform eeprom collection. + + WARNING: it has been noted (via this rhbz) that certain NICs may pause + during this collection + + :avocado: enable + :avocado: tags=stageone + """ + + sos_cmd = '-o networking -k networking.eepromdump=on' + + def test_eeprom_dump_collected(self): + self.assertFileGlobInArchive('sos_commands/networking/ethtool_-e*') -- cgit