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

netmiko poxy import fixes #62404

Merged
merged 4 commits into from
Aug 8, 2022

Conversation

garethgreenaway
Copy link
Contributor

@garethgreenaway garethgreenaway commented Aug 1, 2022

What does this PR do?

Due to changes in the Netmiko library for the exception paths, need to check the version of Netmiko python library and then import the exceptions from different locations depending on the result.

What issues does this PR fix or reference?

Fixes: #62405

Merge requirements satisfied?

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

Commits signed with GPG?

Yes

Please review Salt's Contributing Guide for best practices.

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

…he exceptions from different locations depending on the result.
@garethgreenaway garethgreenaway requested a review from a team as a code owner August 1, 2022 21:51
@garethgreenaway garethgreenaway requested review from dwoz and removed request for a team August 1, 2022 21:51
@garethgreenaway
Copy link
Contributor Author

Change in Netmiko mentioned here: https://github.com/ktbyers/netmiko/releases/tag/v4.0.0

@garethgreenaway garethgreenaway changed the title [WIP] netmiko poxy import fixes netmiko poxy import fixes Aug 2, 2022
whytewolf
whytewolf previously approved these changes Aug 2, 2022
@garethgreenaway garethgreenaway mentioned this pull request Aug 2, 2022
3 tasks
dmurphy18
dmurphy18 previously approved these changes Aug 2, 2022
Copy link
Contributor

@Ch3LL Ch3LL left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changelog?

salt/proxy/netmiko_px.py Outdated Show resolved Hide resolved
@github-actions
Copy link

github-actions bot commented Aug 3, 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
- exit code: 1

/home/runner/.cache/pre-commit/repo3q9bxmoy/py_env-python3/lib/python3.9/site-packages/_distutils_hack/init.py:33: UserWarning: Setuptools is replacing distutils.
warnings.warn("Setuptools is replacing distutils.")
The function 'make_con' on 'salt/proxy/netmiko_px.py' does not have a docstring
The function 'connection' on 'salt/proxy/netmiko_px.py' does not have a docstring
Found 2 errors


Thanks again!

1 similar comment
@github-actions
Copy link

github-actions bot commented Aug 3, 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
- exit code: 1

/home/runner/.cache/pre-commit/repo3q9bxmoy/py_env-python3/lib/python3.9/site-packages/_distutils_hack/init.py:33: UserWarning: Setuptools is replacing distutils.
warnings.warn("Setuptools is replacing distutils.")
The function 'make_con' on 'salt/proxy/netmiko_px.py' does not have a docstring
The function 'connection' on 'salt/proxy/netmiko_px.py' does not have a docstring
Found 2 errors


Thanks again!

@s0undt3ch
Copy link
Collaborator

Tests are passing and includes changelog.
Merging.

@s0undt3ch
Copy link
Collaborator

Dam, @garethgreenaway looks like you need to rebase.

@Ch3LL Ch3LL merged commit d6307c2 into saltstack:master Aug 8, 2022
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.

[BUG] netmiko proxy exception depending on version installed
5 participants