NAS-121797 / 24.04 / CLI for ixdiagnose #61
Merged
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
Qubad786
force-pushed
the
NAS-121797
branch
from
1db72a7 to
55d5447
Compare
Codecov Report
@@ Coverage Diff @@
## master #61 +/- ##
==========================================
+ Coverage 93.13% 95.09% +1.96%
==========================================
Files 89 90 +1
Lines 1675 1836 +161
==========================================
+ Hits 1560 1746 +186
+ Misses 115 90 -25
... and 3 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
Qubad786
force-pushed
the
NAS-121797
branch
from
29ca50c to
c078750
Compare
Qubad786
force-pushed
the
NAS-121797
branch
from
c078750 to
c3738cb
Compare
yocalebo
requested changes
Sep 20, 2023
ixdiagnose/plugin.py
Outdated
| @@ -28,6 +27,7 @@ def generate_plugins_debug(percentage: int = 0, total_percentage: int = 100) -> | |||
|
|
|||
| plugins_report[plugin_name] = report | |||
| percentage += plugin_percentage | |||
| send_event(int(percentage + 0.5), f'Gathered debug information for {plugin_name!r} plugin') | |||
There was a problem hiding this comment.
We changed this to log what plug-in is being captured so it's easier to troubleshoot as well as be more intuitive for the end-user to know what's going on.
yocalebo
requested changes
Sep 20, 2023
ixdiagnose/artifact.py
Outdated
| @@ -25,6 +29,7 @@ def gather_artifacts(percentage: int = 0, total_percentage: int = 100) -> None: | |||
|
|
|||
| artifacts_report[artifact_name] = report | |||
| percentage += artifact_percentage | |||
| send_event(int(percentage + 0.5), f'Gathered artifact {artifact_name!r}') | |||
There was a problem hiding this comment.
Same issue here. Please revert these changes.
Qubad786
force-pushed
the
NAS-121797
branch
from
c3738cb to
1660751
Compare
yocalebo
approved these changes
Sep 22, 2023
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.
Context
This PR addresses the request to enhance the ixdiagnose command-line interface (CLI). We've added subcommands and multiple options to provide users with increased flexibility when generating system debug from command line.
Features
Streamlined debugging with Python Click framework.
Added CLI commands: run, artifact, plugin.
Options for serialization, compression, exclude, timeout etc.
Example use:
ixdiagnose run --compress --serialized --> generates complete structured debug and compresses it.
ixdiagnose plugin --debug-path /tmp/debug -X vm,network --> generates only plugins' debug excluding vm,network and saves it at /tmp/debug
Appropriate help text for each command and subcommand is added.
Docs and Testing
Edited docs accordingly
Added unit tests of the feature using click.testing CliRunner