Skip to content
This repository has been archived by the owner on Mar 13, 2022. It is now read-only.

add proxy authentication supporting for websocket (stream/ws_client.py) #256

Merged
merged 3 commits into from
Oct 9, 2021
Merged

add proxy authentication supporting for websocket (stream/ws_client.py) #256

merged 3 commits into from
Oct 9, 2021

Conversation

itaru2622
Copy link
Contributor

What type of PR is this?

/kind bug

What this PR does / why we need it:

This PR supports proxy authentication for websocket client.
as described in #255, and ansible-collections/kubernetes.core#246
current kubernets-client/python(-base) support proxy auth only for REST but NOT websocket.
as the result, kubernets.core's k8s_cp nor k8s_exec cannot work with proxy when proxy requires authentication.

Which issue(s) this PR fixes:

Fixes #255
Fixes ansible-collections/kubernetes.core#246

Special notes for your reviewer:

Does this PR introduce a user-facing change?

NONE

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/bug Categorizes issue or PR as related to a bug. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Oct 1, 2021
@k8s-ci-robot
Copy link
Contributor

Welcome @itaru2622!

It looks like this is your first PR to kubernetes-client/python-base 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-client/python-base has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Oct 1, 2021
@itaru2622
Copy link
Contributor Author

/assign @roycaihw

@yliaog
Copy link
Contributor

yliaog commented Oct 4, 2021

please add a test to verify the added logic works as expected.

@itaru2622
Copy link
Contributor Author

@yliaog ok, I will add test.

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Oct 5, 2021
@itaru2622
Copy link
Contributor Author

@yliaog unittest code added. Could you review this PR, please.

ps. I also added small change into stream/ws_client.py to get unittest friendly.

yliaog
yliaog reviewed Oct 8, 2021
View reviewed changes
stream/ws_client.py Outdated
for key,value in configuration.proxy_headers.items():
if key == 'proxy-authorization' and value.startswith('Basic'):
b64value = value.split()[1]
auth = b64decode(b64value).decode().split(':')
Copy link
Contributor

Choose a reason for hiding this comment

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

do you need urlsafe_b64decode?

Copy link
Contributor Author

@itaru2622 itaru2622 Oct 9, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

I changed b64decode to urlsafe_b64decode for safe by 59e7d11

@yliaog
Copy link
Contributor

yliaog commented Oct 9, 2021

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm Indicates that a PR is ready to be merged. label Oct 9, 2021
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: itaru2622, yliaog

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 9, 2021
@k8s-ci-robot k8s-ci-robot merged commit 0052a68 into kubernetes-client:master Oct 9, 2021
@itaru2622 itaru2622 deleted the proxy_auth branch October 15, 2021 02:10
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@yliaog yliaog yliaog left review comments

@fabianvf fabianvf Awaiting requested review from fabianvf

Assignees

@roycaihw roycaihw

@yliaog yliaog

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/bug Categorizes issue or PR as related to a bug. lgtm Indicates that a PR is ready to be merged. release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
4 participants
@itaru2622 @k8s-ci-robot @yliaog @roycaihw