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 metadata user data parse #62061

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

superzc-github
Copy link

What does this PR do?

This is to make sure user-data in grains metadata will be returned correctly

What issues does this PR fix or reference?

N/A

Previous Behavior

user-data content will be cut by this current condition:
elif "=" in line:
key, value = line.split("=")
ret[value] = _search(prefix=os.path.join(prefix, key))

New Behavior

user-data will be return with its whole content directly with any further cut/parse for it's content

Merge requirements satisfied?

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

Commits signed with GPG?

Yes/No

Please review Salt's Contributing Guide for best practices.

See GitHub's page on GPG signing for more information about signing commits with GPG.

@superzc-github superzc-github requested a review from a team as a code owner May 13, 2022 06:15
@superzc-github superzc-github requested review from waynew and removed request for a team May 13, 2022 06:15
@github-actions
Copy link

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.13s
- exit code: 1

/home/runner/.cache/pre-commit/repoyt5u40n1/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 'metadata' on 'salt/grains/metadata.py' does not have a docstring
Found 1 errors


Thanks again!

@dwoz
Copy link
Contributor

dwoz commented Dec 10, 2023

@superzc-github Are you able to add a test case for this change?

@dwoz dwoz self-assigned this Dec 10, 2023
@dwoz dwoz added this to the Argon v3008.0 milestone Dec 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants