Skip to content

Fixes create cmds to return an error if env passed is invalid #72

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

Merged
merged 1 commit into from
Oct 31, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions pkg/shp/cmd/build/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -62,11 +62,15 @@ func (c *CreateCommand) Run(params *params.Params, io *genericclioptions.IOStrea
Spec: *c.buildSpec,
}

envs, err := c.cmd.Flags().GetStringArray("env")
envs, err := c.cmd.Flags().GetStringArray(flags.EnvFlag)
if err != nil {
return err
}
b.Spec.Env = append(b.Spec.Env, util.StringSliceToEnvVarSlice(envs)...)
parsedEnvs, err := util.StringSliceToEnvVarSlice(envs)
if err != nil {
return err
}
b.Spec.Env = append(b.Spec.Env, parsedEnvs...)

flags.SanitizeBuildSpec(&b.Spec)

Expand Down
8 changes: 6 additions & 2 deletions pkg/shp/cmd/buildrun/create.go
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,15 @@ func (c *CreateCommand) Run(params *params.Params, ioStreams *genericclioptions.
Spec: *c.buildRunSpec,
}

envs, err := c.cmd.Flags().GetStringArray("env")
envs, err := c.cmd.Flags().GetStringArray(flags.EnvFlag)
if err != nil {
return err
}
br.Spec.Env = append(br.Spec.Env, util.StringSliceToEnvVarSlice(envs)...)
parsedEnvs, err := util.StringSliceToEnvVarSlice(envs)
if err != nil {
return err
}
br.Spec.Env = append(br.Spec.Env, parsedEnvs...)

flags.SanitizeBuildRunSpec(&br.Spec)

Expand Down
2 changes: 1 addition & 1 deletion pkg/shp/flags/flags.go
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ func envFlags(flags *pflag.FlagSet, envs []corev1.EnvVar) {
var e []string
flags.StringArrayVarP(
&e,
"env",
EnvFlag,
"e",
[]string{},
"specify a key-value pair for an environment variable to set for the build container",
Expand Down
6 changes: 3 additions & 3 deletions pkg/shp/reactor/pod_watcher.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ type PodWatcher struct {
stopLock sync.Mutex
stopped bool
eventTicker *time.Ticker
clientset kubernetes.Interface
listOpts metav1.ListOptions
ns string
clientset kubernetes.Interface
listOpts metav1.ListOptions
ns string
watcher watch.Interface // client watch instance

noPodEventsYetFn NoPodEventsYetFn
Expand Down
1 change: 0 additions & 1 deletion pkg/shp/reactor/pod_watcher_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,6 @@ func Test_PodWatcher_NotCalledYet(t *testing.T) {
eventsCh <- true
})


// executing the event loop in the background, and waiting for the stop channel before inspecting
// for errors
go func() {
Expand Down
15 changes: 10 additions & 5 deletions pkg/shp/util/env.go
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
package util

import (
"fmt"
"strings"

corev1 "k8s.io/api/core/v1"
)

func StringSliceToEnvVarSlice(envs []string) []corev1.EnvVar {
func StringSliceToEnvVarSlice(envs []string) ([]corev1.EnvVar, error) {
envVars := []corev1.EnvVar{}

for _, e := range envs {
d := strings.Split(e, "=")
envVars = append(envVars, corev1.EnvVar{Name: d[0], Value: d[1]})
for _, l := range envs {
parts := strings.SplitN(l, "=", 2)
if len(parts) == 1 {
return envVars, fmt.Errorf("failed to parse key-value pair %q, not enough parts", l)
}
envVars = append(envVars, corev1.EnvVar{Name: parts[0], Value: parts[1]})
}
return envVars

return envVars, nil
}
26 changes: 25 additions & 1 deletion pkg/shp/util/env_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,9 +46,33 @@ func TestStringSliceToEnvVar(t *testing.T) {
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if got := StringSliceToEnvVarSlice(tt.args.envs); !reflect.DeepEqual(got, tt.want) {
if got, _ := StringSliceToEnvVarSlice(tt.args.envs); !reflect.DeepEqual(got, tt.want) {
t.Errorf("StringSliceToEnvVar() = %#v, want %#v", got, tt.want)
}
})
}
}

func TestStringSliceToEnvVar_ErrorCases(t *testing.T) {
type args struct {
envs []string
}
tests := []struct {
name string
args args
}{
{
name: "value part missing",
args: args{
envs: []string{"abc"},
},
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
if _, err := StringSliceToEnvVarSlice(tt.args.envs); err == nil {
t.Errorf("StringSliceToEnvVarSlice() = want error but got nil")
}
})
}
}