Add fish shell detection #789

Qinusty · 2019-08-21T14:12:25Z

Implement basic shell detection for Linux platforms in the kind create command.

Additions:

Implement GetLinuxShell() utility function
Add fish as a custom output whilst leaving bash/zsh under default

k8s-ci-robot · 2019-08-21T14:12:26Z

Welcome @Qinusty!

It looks like this is your first PR to kubernetes-sigs/kind 🎉. 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-sigs/kind 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 · 2019-08-21T14:12:28Z

Thanks for your pull request. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

📝 Please follow instructions at https://git.k8s.io/community/CLA.md#the-contributor-license-agreement to sign the CLA.

It may take a couple minutes for the CLA signature to be fully registered; after that, please reply here with a new comment and we'll verify. Thanks.

If you've already signed a CLA, it's possible we don't have your GitHub username or you're using a different email address. Check your existing CLA data and verify that your email is set on your git commits.
If you signed the CLA as a corporation, please sign in with your organization's credentials at https://identity.linuxfoundation.org/projects/cncf to be authorized.
If you have done the above and are still having issues with the CLA being reported as unsigned, please log a ticket with the Linux Foundation Helpdesk: https://support.linuxfoundation.org/
Should you encounter any issues with the Linux Foundation Helpdesk, send a message to the backup e-mail support address at: [email protected]

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

k8s-ci-robot · 2019-08-21T14:12:32Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Qinusty
To complete the pull request process, please assign bentheelder
You can assign the PR to them by writing /assign @bentheelder in a comment when ready.

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

Needs approval from an approver in each of these files:

OWNERS

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 · 2019-08-21T14:12:39Z

Hi @Qinusty. Thanks for your PR.

I'm waiting for a kubernetes-sigs or kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

neolit123 · 2019-08-21T14:55:12Z

pkg/internal/util/env/shell.go

+)
+
+func GetLinuxShell() string {
+	shell := os.Getenv("SHELL")


what if the user unset the SHELL variable, e.g. by mistake?

This is currently a best guess, I'm not certain of a guaranteed way to get the users current shell. Scraping current running processes would run into a similar issue if the user was running multiple shells.

In regard to what would happen, shell would be "" and it would default and behave as it currently does without this logic.

neolit123 · 2019-08-21T14:56:48Z

pkg/internal/cluster/create/create.go

@@ -190,12 +191,20 @@ func printUsage(name string) {
 			name,
 		)
 	} else {
+		// Detect shell and usage build prompt appropriately.
+		setKubeConfigPrompt := ""
+		switch shell := env.GetLinuxShell(); shell {


shouldn't the function be called UnixShell, as this branch is !windows?
can it cover custom OSX shells too?

also noting that fish appears to be on macOS

neolit123 · 2019-08-21T14:58:02Z

thanks for the PR @Qinusty

please make sure you sign the CLA if this command fails:
/check-cla

neolit123 · 2019-08-21T14:59:49Z

if you have signed the CLA already, make sure your CLA email is added to your github account.
if there is a problem with that try contacting the CNCF help-desk.

WRT this PR, i must admit this is the first time i've heard about "fish" shell, and given all the flavors of shells out there, it might be better to not add special handling for all of them?
/assign @BenTheElder

BenTheElder · 2019-08-21T15:51:12Z

pkg/internal/cluster/create/create.go

+		setKubeConfigPrompt := ""
+		switch shell := env.GetLinuxShell(); shell {
+		case "fish":
+			setKubeConfigPrompt = "set -x KUBECONFIG (kind get kubeconfig-path --name=%q)"


I'm a bit dumbfounded that a Linux shell doesn't support POSIX... 🧐
https://pubs.opengroup.org/onlinepubs/009695399/utilities/export.html

Yeah it's a bit strange but it appears to be the case. https://fishshell.com/docs/current/tutorial.html#tut_exports

BenTheElder · 2019-10-31T19:34:53Z

#850 landed so we don't need to export this env anymore.

Thanks for the PR though!

Qinusty added 2 commits August 21, 2019 09:11

Add fish usage for create cluster

61fa8d2

Add basic linux shell detection for create usage

c03da7a

k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Aug 21, 2019

k8s-ci-robot requested review from amwat and neolit123 August 21, 2019 14:12

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 21, 2019

neolit123 reviewed Aug 21, 2019

View reviewed changes

k8s-ci-robot assigned BenTheElder Aug 21, 2019

BenTheElder reviewed Aug 21, 2019

View reviewed changes

BenTheElder closed this Oct 31, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add fish shell detection #789

Add fish shell detection #789

Qinusty commented Aug 21, 2019

k8s-ci-robot commented Aug 21, 2019

k8s-ci-robot commented Aug 21, 2019

k8s-ci-robot commented Aug 21, 2019

k8s-ci-robot commented Aug 21, 2019

neolit123 Aug 21, 2019

Qinusty Aug 24, 2019 •

edited

Loading

neolit123 Aug 21, 2019

BenTheElder Aug 21, 2019

neolit123 commented Aug 21, 2019

neolit123 commented Aug 21, 2019

BenTheElder Aug 21, 2019

Qinusty Aug 24, 2019

BenTheElder commented Oct 31, 2019

Add fish shell detection #789

Add fish shell detection #789

Conversation

Qinusty commented Aug 21, 2019

Additions:

k8s-ci-robot commented Aug 21, 2019

k8s-ci-robot commented Aug 21, 2019

k8s-ci-robot commented Aug 21, 2019

k8s-ci-robot commented Aug 21, 2019

neolit123 Aug 21, 2019

Choose a reason for hiding this comment

Qinusty Aug 24, 2019 • edited Loading

Choose a reason for hiding this comment

neolit123 Aug 21, 2019

Choose a reason for hiding this comment

BenTheElder Aug 21, 2019

Choose a reason for hiding this comment

neolit123 commented Aug 21, 2019

neolit123 commented Aug 21, 2019

BenTheElder Aug 21, 2019

Choose a reason for hiding this comment

Qinusty Aug 24, 2019

Choose a reason for hiding this comment

BenTheElder commented Oct 31, 2019

Qinusty Aug 24, 2019 •

edited

Loading