ref: change --node to --node-selector flag

- test: add bats for `shp build run`

Signed-off-by: rxinui <[email protected]>

Author: rxinui

docs/shp_build_create.md

@@ -19,7 +19,7 @@ shp build create <name> [flags]
 ```
   -e, --env stringArray                          specify a key-value pair for an environment variable to set for the build container (default [])
   -h, --help                                     help for create
-      --node stringArray                         set of key-value pairs that correspond to labels of a node to match (default [])
+      --node-selector stringArray                set of key-value pairs that correspond to labels of a node to match (default [])
       --output-image string                      image employed during the building process
       --output-image-annotation stringArray      specify a set of key-value pairs that correspond to annotations to set on the output image (default [])
       --output-image-label stringArray           specify a set of key-value pairs that correspond to labels to set on the output image (default [])

docs/shp_build_run.md

@@ -22,7 +22,7 @@ shp build run <name> [flags]
   -e, --env stringArray                          specify a key-value pair for an environment variable to set for the build container (default [])
   -F, --follow                                   Start a build and watch its log until it completes or fails.
   -h, --help                                     help for run
-      --node stringArray                         set of key-value pairs that correspond to labels of a node to match (default [])
+      --node-selector stringArray                set of key-value pairs that correspond to labels of a node to match (default [])
       --output-image string                      image employed during the building process
       --output-image-annotation stringArray      specify a set of key-value pairs that correspond to annotations to set on the output image (default [])
       --output-image-label stringArray           specify a set of key-value pairs that correspond to labels to set on the output image (default [])

docs/shp_build_upload.md

@@ -32,7 +32,7 @@ shp build upload <build-name> [path/to/source|.] [flags]
   -e, --env stringArray                          specify a key-value pair for an environment variable to set for the build container (default [])
   -F, --follow                                   Start a build and watch its log until it completes or fails.
   -h, --help                                     help for upload
-      --node stringArray                         set of key-value pairs that correspond to labels of a node to match (default [])
+      --node-selector stringArray                set of key-value pairs that correspond to labels of a node to match (default [])
       --output-image string                      image employed during the building process
       --output-image-annotation stringArray      specify a set of key-value pairs that correspond to annotations to set on the output image (default [])
       --output-image-label stringArray           specify a set of key-value pairs that correspond to labels to set on the output image (default [])

docs/shp_buildrun_create.md

@@ -21,7 +21,7 @@ shp buildrun create <name> [flags]
       --buildref-name string                     name of build resource to reference
   -e, --env stringArray                          specify a key-value pair for an environment variable to set for the build container (default [])
   -h, --help                                     help for create
-      --node stringArray                         set of key-value pairs that correspond to labels of a node to match (default [])
+      --node-selector stringArray                set of key-value pairs that correspond to labels of a node to match (default [])
       --output-image string                      image employed during the building process
       --output-image-annotation stringArray      specify a set of key-value pairs that correspond to annotations to set on the output image (default [])
       --output-image-label stringArray           specify a set of key-value pairs that correspond to labels to set on the output image (default [])

pkg/shp/flags/build.go

@@ -56,7 +56,7 @@ func BuildSpecFromFlags(flags *pflag.FlagSet) (*buildv1beta1.BuildSpec, *string,
 	imageLabelsFlags(flags, spec.Output.Labels)
 	imageAnnotationsFlags(flags, spec.Output.Annotations)
 	buildRetentionFlags(flags, spec.Retention)
-	buildNodeFlags(flags, spec.NodeSelector)
+	buildNodeSelectorFlags(flags, spec.NodeSelector)
 	var dockerfile, builderImage string
 	dockerfileFlags(flags, &dockerfile)
 	builderImageFlag(flags, &builderImage)

pkg/shp/flags/buildrun.go

@@ -40,7 +40,7 @@ func BuildRunSpecFromFlags(flags *pflag.FlagSet) *buildv1beta1.BuildRunSpec {
 	imageLabelsFlags(flags, spec.Output.Labels)
 	imageAnnotationsFlags(flags, spec.Output.Annotations)
 	buildRunRetentionFlags(flags, spec.Retention)
-	buildNodeFlags(flags, spec.NodeSelector)
+	buildNodeSelectorFlags(flags, spec.NodeSelector)
 	return spec
 }
 

pkg/shp/flags/flags.go

@@ -65,7 +65,7 @@ const (
 	// RetentionTTLAfterSucceededFlag command-line flag.
 	RetentionTTLAfterSucceededFlag = "retention-ttl-after-succeeded"
 	// NodeSelectorFlag command-line flag.
-	NodeSelectorFlag = "node"
+	NodeSelectorFlag = "node-selector"
 )
 
 // sourceFlags flags for ".spec.source"
@@ -261,8 +261,8 @@ func serviceAccountFlags(flags *pflag.FlagSet, sa *string) {
 
 }
 
-// buildNodeFlags registers flags for adding BuildSpec.NodeSelector
-func buildNodeFlags(flags *pflag.FlagSet, nodeSelectorLabels map[string]string) {
+// buildNodeSelectorFlags registers flags for adding BuildSpec.NodeSelector
+func buildNodeSelectorFlags(flags *pflag.FlagSet, nodeSelectorLabels map[string]string) {
 	flags.Var(NewMapValue(nodeSelectorLabels), NodeSelectorFlag, "set of key-value pairs that correspond to labels of a node to match")
 }
 

test/e2e/node-selector.bats

@@ -13,12 +13,12 @@ teardown() {
 	run kubectl delete buildruns.shipwright.io --all
 }
 
-@test "shp build node selector single label" {
+@test "shp build create --node-selector single label" {
     # generate random names for our build
 	build_name=$(random_name)
 
     # create a Build with node selector 
-    run shp build create ${build_name} --source-url=https://github.com/shipwright-io/sample-go --output-image=my-fake-image --node="kubernetes.io/hostname=node-1"
+    run shp build create ${build_name} --source-git-url=https://github.com/shipwright-io/sample-go --output-image=my-fake-image --node-selector="kubernetes.io/hostname=node-1"
     assert_success
 
     # ensure that the build was successfully created
@@ -31,12 +31,12 @@ teardown() {
     assert_output '{"kubernetes.io/hostname":"node-1"}'
 }
 
-@test "shp build node selector multiple labels" {
+@test "shp build create --node-selector multiple labels" {
     # generate random names for our build
 	build_name=$(random_name)
 
     # create a Build with node selector 
-    run shp build create ${build_name} --source-url=https://github.com/shipwright-io/sample-go --output-image=my-fake-image --node="kubernetes.io/hostname=node-1" --node="kubernetes.io/os=linux" 
+    run shp build create ${build_name} --source-git-url=https://github.com/shipwright-io/sample-go --output-image=my-fake-image --node-selector="kubernetes.io/hostname=node-1" --node-selector="kubernetes.io/os=linux" 
     assert_success
 
     # ensure that the build was successfully created
@@ -50,13 +50,13 @@ teardown() {
     assert_output --partial '"kubernetes.io/os":"linux"'
 }
 
-@test "shp buildrun node selector single label" {
+@test "shp buildrun create --node-selector single label" {
     # generate random names for our buildrun
 	buildrun_name=$(random_name)
 	build_name=$(random_name)
 
     # create a Build with node selector 
-    run shp buildrun create ${buildrun_name} --buildref-name=${build_name} --node="kubernetes.io/hostname=node-1"
+    run shp buildrun create ${buildrun_name} --buildref-name=${build_name} --node-selector="kubernetes.io/hostname=node-1"
     assert_success
 
     # ensure that the build was successfully created
@@ -69,13 +69,13 @@ teardown() {
     assert_output '{"kubernetes.io/hostname":"node-1"}'
 }
 
-@test "shp buildrun node selector multiple labels" {
+@test "shp buildrun create --node-selector multiple labels" {
     # generate random names for our buildrun
 	buildrun_name=$(random_name)
 	build_name=$(random_name)
 
     # create a Build with node selector 
-    run shp buildrun create ${buildrun_name} --buildref-name=${build_name} --node="kubernetes.io/hostname=node-1"  --node="kubernetes.io/os=linux"
+    run shp buildrun create ${buildrun_name} --buildref-name=${build_name} --node-selector="kubernetes.io/hostname=node-1"  --node-selector="kubernetes.io/os=linux"
     assert_success
 
     # ensure that the build was successfully created
@@ -87,4 +87,28 @@ teardown() {
 
     assert_output --partial '"kubernetes.io/hostname":"node-1"'
     assert_output --partial '"kubernetes.io/os":"linux"'
+}
+
+
+@test "shp build run --node-selector set" {
+    # generate random names for our build
+	build_name=$(random_name)
+
+    # create a Build with node selector 
+    run shp build create ${build_name} --source-git-url=https://github.com/shipwright-io/sample-go --output-image=my-fake-image
+    assert_success
+
+    # ensure that the build was successfully created
+	assert_output --partial "Created build \"${build_name}\""
+
+    # get the build object
+	run kubectl get builds.shipwright.io/${build_name}
+	assert_success
+
+    run shp build run ${build_name} --node-selector="kubernetes.io/hostname=node-1"
+
+    # get the jsonpath of Build object .spec.nodeSelector
+	run kubectl get buildruns.shipwright.io -ojsonpath='{.items[*].spec.nodeSelector}' 
+	assert_success
+    assert_output --partial '"kubernetes.io/hostname":"node-1"'
 }