Produce better logs and collect artifacts on failed setup #41
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This PR depends on #38, it starts with "misc: add SuccessChecker" commit. |
|
To reproduce, you can just raise an error in role setup. E.g. (sssd-test-framework) diff --git a/sssd_test_framework/roles/client.py b/sssd_test_framework/roles/client.py
index c3df1c7..e1a95e2 100644
--- a/sssd_test_framework/roles/client.py
+++ b/sssd_test_framework/roles/client.py
@@ -81,6 +81,10 @@ class Client(BaseLinuxRole[ClientHost]):
#. import implicit domains from topology marker
"""
super().setup()
+
+ self.logger.info("Raising error, this will be visible in logs. SSSD artifacts will be collected.")
+ raise Exception("Setup error")
+
self.sssd.stop()
self.sssd.clear(db=True, memcache=True, logs=True, config=True)
|
pbrezina
force-pushed
the
setuplogs
branch
2 times, most recently
from
b6694de to
2c88224
Compare
|
@justin-stephenson @danlavu Kind ping for a review. Thanks! |
pytest_mh/_private/misc.py
Outdated
| Keep named states of operation. | ||
|
|
||
| This can be used to mark certain operations as completed with success, | ||
| failure or any other state state and act later upon it. |
There was a problem hiding this comment.
s/state state/state/
justin-stephenson
approved these changes
Feb 15, 2024
Keep success/failure state of certain operations. This can be used to mark certain operations as completed with success or failure state and act later upon the result. add
Previously no artifacts are collected if a setup fails and teardown was logged under setup which was confusing. Now, the code is refactored and simplified, the setup and teardown are strictly separated and all artifacts are collected.
This simplifies the code by moving decision logic out of the inner methods.
This will improve the logs, now teardown really contains only teardown.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Before we did not collect any artifacts and logged teardown to a setup phase if an exception was risen during setup.
Now, setup and teardown are fully separated which makes the code easier and it is also separated in the logs. Additionally, we now collect available artifacts so we can actually learn why the setup phase failed.