Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix misplaced periods in tls #62139

Merged
merged 8 commits into from
Nov 16, 2022
Merged

Conversation

waynew
Copy link
Contributor

@waynew waynew commented Jun 6, 2022

When giving something like "/path/to/some/file.crt" it's incorrect to
say "/path/to/some/file.crt." if the extension is not actually .crt.,
but .crt.

This fixes all of that in the tls module.

I may need to make some changes to expected test outputs.

What does this PR do?

Previously it would return something like this:

local:
    Created Private Key: "/etc/pki/tls/certs/localhost.key." Created Certificate: "/etc/pki/tls/certs/localhost.crt."

But that's uh... not the filename. It's not localhost.key. that was generated, it's localhost.key. That trailing period matters.

What issues does this PR fix or reference?

Didn't create one (yet)

Previous Behavior

You'd have to double check that the filename was really .crt or .key and didn't have an extra period at the end.

New Behavior

Now you don't, the actual filename is what's in the quotes.

Merge requirements satisfied?

[NOTICE] Bug fixes or features added to Salt require tests.

Commits signed with GPG?

Yes

@waynew waynew requested a review from a team as a code owner June 6, 2022 23:14
@waynew waynew requested review from MKLeb and removed request for a team June 6, 2022 23:14
@github-actions
Copy link

github-actions bot commented Jun 6, 2022

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)
Check Known Missing Docstrings...........................................Failed
- hook id: invoke
- duration: 1.3s
- exit code: 1

/home/runner/.cache/pre-commit/repo52pd0ynv/py_env-python3/lib/python3.9/site-packages/_distutils_hack/init.py:30: UserWarning: Setuptools is replacing distutils.
warnings.warn("Setuptools is replacing distutils.")
The function 'validate' on 'salt/modules/tls.py' does not have a 'CLI Example:' in its docstring
Found 1 errors


Thanks again!

@MKLeb MKLeb added Needs-Testcase PR needs test cases written, or the issue is about a bug/feature that needs test cases needs-changelog-file labels Sep 13, 2022
When giving something like "/path/to/some/file.crt" it's incorrect to
say "/path/to/some/file.crt." if the extension is not actually `.crt.`,
but `.crt`.

This fixes all of that in the tls module.
While we were at it we did a little bit of refactoring.
@waynew waynew force-pushed the fix-tls-misplaced-periods branch from b1ca89b to fbe301e Compare November 10, 2022 18:07
@waynew waynew removed the Needs-Testcase PR needs test cases written, or the issue is about a bug/feature that needs test cases label Nov 15, 2022
@Ch3LL Ch3LL merged commit a4b77df into saltstack:master Nov 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants