aboutsummaryrefslogtreecommitdiffstats
path: root/tests/report_tests/plugin_tests/sos_extras/sos_extras.py
diff options
context:
space:
mode:
authorJake Hunsaker <jhunsake@redhat.com>2022-12-02 16:20:01 -0500
committerJake Hunsaker <jhunsake@redhat.com>2023-01-12 12:21:25 -0500
commit131b3bcf5691a158598bed30bd0af6ac9c96737c (patch)
treee70b824a077300eea34513a6305568c38696ac79 /tests/report_tests/plugin_tests/sos_extras/sos_extras.py
parentca8a8a7b9f452a81c5654234918b99092620bf13 (diff)
downloadsos-131b3bcf5691a158598bed30bd0af6ac9c96737c.tar.gz
[testing] Change location of mocked files for tests
Previously, mocked files were kept under the `tests/test_data/` directory and generally mimic'd the file location they would be temporarily copied to during the execution of their relevant tests. This has a few maintainability drawbacks, and the handling of the `files` attribute for test cases as either strings or tuples is at best confusing. Improve on this by instead making the `files` references relative to where the test case file is written. This enables easier maintenance by keeping all test requirements closer together, rather than spread across the repo. As such, the `files` attribute now requires a list of tuples, taking the form `(relative_src, absolute_dest)`. Additionally, fake plugins for tests that need them to artificially test a specific criteria should also be included in the test's subdir now. Along with this change, move several StageTwo tests to their own subdirs that now contain both the test cases and the needed files for mocking. This should be the new design pattern going forward - if a test needs to mock files of any kind, put it in a new subdirectory (and if it doesn't need to mock files, continue to keep it in the relevant directory within the test suite). Signed-off-by: Jake Hunsaker <jhunsake@redhat.com>
Diffstat (limited to 'tests/report_tests/plugin_tests/sos_extras/sos_extras.py')
-rw-r--r--tests/report_tests/plugin_tests/sos_extras/sos_extras.py32
1 files changed, 32 insertions, 0 deletions
diff --git a/tests/report_tests/plugin_tests/sos_extras/sos_extras.py b/tests/report_tests/plugin_tests/sos_extras/sos_extras.py
new file mode 100644
index 00000000..ae5c347a
--- /dev/null
+++ b/tests/report_tests/plugin_tests/sos_extras/sos_extras.py
@@ -0,0 +1,32 @@
+# 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 sos_tests import StageTwoReportTest
+
+
+class SosExtrasPluginTest(StageTwoReportTest):
+ """Ensure that the sos_extras plugin is properly executing command and
+ file collections as defined in the sos_extras config file
+
+ :avocado: tags=stagetwo
+ """
+
+ files = [('sos_testing.conf', '/etc/sos/extras.d/sos_testing.conf')]
+ # rather than only enabling this plugin, make sure the enablement trigger
+ # is working
+ sos_cmd = '-n logs,networking,devicemapper,filesys,systemd'
+
+ def test_extras_enabled(self):
+ self.assertPluginIncluded('sos_extras')
+
+ def test_setup_message_displayed(self):
+ self.assertOutputContains('Collecting data from extras file /etc/sos/extras.d/sos_testing.conf')
+
+ def test_extras_config_parsed(self):
+ self.assertFileCollected('/etc/fstab')
+ self.assertFileCollected('sos_commands/sos_extras/sos_testing.conf/echo_sos_test')