Skip to content

Add percent success/failure of state runs in highstate summary output#60991

Merged
Ch3LL merged 4 commits intosaltstack:masterfrom
nicholasmhughes:add-state-output-pct
Nov 10, 2021
Merged

Add percent success/failure of state runs in highstate summary output#60991
Ch3LL merged 4 commits intosaltstack:masterfrom
nicholasmhughes:add-state-output-pct

Conversation

@nicholasmhughes
Copy link
Contributor

What does this PR do?

This PR adds a new master and minion configuration to modify the display of the summary information int he highstate output module. It will show successful and failed operations in a state run as a percentage of total operations.

What issues does this PR fix or reference?

Fixes: #60990

Previous Behavior

Summary output as shown.

Summary for local
------------
Succeeded: 2 (changed=2)
Failed:    2
------------
Total states run:     4
Total run time:   4.088 ms

New Behavior

When setting state_output_pct: True, the summary output will include two new lines showing the percent of successful and failed states in the run.

Summary for local
------------
Succeeded: 2 (changed=2)
Failed:    2
Success %: 50.0
Failure %: 50.0
------------
Total states run:     4
Total run time:   4.088 ms

Merge requirements satisfied?

Commits signed with GPG?

Yes

@nicholasmhughes nicholasmhughes requested a review from a team as a code owner October 2, 2021 14:09
@nicholasmhughes nicholasmhughes requested review from xeacott and removed request for a team October 2, 2021 14:09
Ch3LL
Ch3LL previously approved these changes Oct 12, 2021
@Ch3LL
Copy link
Contributor

Ch3LL commented Oct 12, 2021

There are failures on Debian 9 that are related to this change: https://jenkins.saltproject.io/job/pr-debian-9-amd64-py3-pytest/job/PR-60991/2/

Debian 9 runs python 3.5, which is usually the distinguishing reason why tests fail on that platform but not on others.

@github-actions
Copy link

github-actions bot commented Nov 9, 2021

Hi! I'm your friendly PR bot!

You might be wondering what I'm doing commenting here on your PR.

Yes, as a matter of fact, I am...

I'm just here to help us improve the documentation. I can't respond to
questions or anything, but what I can do, I do well!

Okay... so what do you do?

I detect modules that are missing docstrings or "CLI Example" on existing docstrings!
When I was created we had a lot of these. The documentation for these
modules need some love and attention to make Salt better for our users.

So what does that have to do with my PR?

I noticed that in this PR there are some files changed that have some of these
issues. So I'm leaving this comment to let you know your options.

Okay, what are they?

Well, my favorite, is that since you were making changes here I'm hoping that
you would be the most familiar with this module and be able to add some other
examples or fix any of the reported issues.

If I can, then what?

Well, you can either add them to this PR or add them to another PR. Either way is fine!

Well... what if I can't, or don't want to?

That's also fine! We appreciate all contributions to the Salt Project. If you
can't add those other examples, either because you're too busy, or unfamiliar,
or you just aren't interested, we still appreciate the contributions that
you've made already.

Whatever approach you decide to take, just drop a comment here letting us know!

Detected Issues (click me)
[INFO] Initializing environment for https://github.com/saltstack/pip-tools-compile-impersonate.
[INFO] Initializing environment for https://github.com/asottile/pyupgrade.
[INFO] Initializing environment for https://github.com/saltstack/pre-commit-remove-import-headers.
[INFO] Initializing environment for https://github.com/s0undt3ch/salt-rewrite.
[INFO] Initializing environment for https://github.com/timothycrosley/isort.
[INFO] Initializing environment for https://github.com/timothycrosley/isort:toml.
[INFO] Initializing environment for https://github.com/psf/black.
[INFO] Initializing environment for https://github.com/asottile/blacken-docs.
[INFO] Initializing environment for https://github.com/asottile/blacken-docs:black==21.7b0.
[INFO] Initializing environment for https://github.com/PyCQA/bandit.
[INFO] Initializing environment for https://github.com/saltstack/invoke-pre-commit.
[INFO] Initializing environment for https://github.com/saltstack/invoke-pre-commit:blessings,distro,jinja2,msgpack,pyyaml.
[INFO] Initializing environment for https://github.com/saltstack/mirrors-nox.
[INFO] Initializing environment for https://github.com/saltstack/mirrors-nox:pip>=20.2.4,<21.2,setuptools<58.0.
[INFO] Installing environment for https://github.com/saltstack/invoke-pre-commit.
[INFO] Once installed this environment will be reused.
[INFO] This may take a few minutes...
Check Known Missing Docstrings...........................................Passed
- hook id: invoke
- duration: 1.83s

Thanks again!

@Ch3LL Ch3LL added the Phosphorus v3005.0 Release code name and version label Nov 9, 2021
@nicholasmhughes
Copy link
Contributor Author

re-run pr-ubuntu-2004-arm64-py3-pytest

@nicholasmhughes
Copy link
Contributor Author

re-run pr-debian-11-arm64-py3-pytest

@Ch3LL Ch3LL merged commit 4c0968e into saltstack:master Nov 10, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Phosphorus v3005.0 Release code name and version

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEATURE REQUEST] Show percentage success/failure in state summary output

2 participants