Skip to content

Commit 00729c9

Browse files
rxinuirxinui
committed
new: add --scheduler-name to build and buildrun
- test: add go test and bats tests - ref: harmonise tab/spaces in bats tests Signed-off-by: rxinui <[email protected]>
1 parent 63a617e commit 00729c9

File tree

10 files changed

+138
-41
lines changed

10 files changed

+138
-41
lines changed

‎docs/shp_build_create.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ shp build create <name> [flags]
3030
--retention-succeeded-limit uint number of succeeded BuildRuns to be kept (default 65535)
3131
--retention-ttl-after-failed duration duration to delete a failed BuildRun after completion
3232
--retention-ttl-after-succeeded duration duration to delete a succeeded BuildRun after completion
33+
--scheduler-name string specify the scheduler to be used to dispatch the Pod
3334
--source-context-dir string use a inner directory as context directory
3435
--source-git-clone-secret string name of the secret with credentials to access the git source, e.g. git credentials
3536
--source-git-revision string git repository source revision

‎docs/shp_build_run.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,7 @@ shp build run <name> [flags]
3232
--retention-ttl-after-failed duration duration to delete the BuildRun after it failed
3333
--retention-ttl-after-succeeded duration duration to delete the BuildRun after it succeeded
3434
--sa-name string Kubernetes service-account name
35+
--scheduler-name string specify the scheduler to be used to dispatch the Pod
3536
--timeout duration build process timeout
3637
```
3738

‎docs/shp_build_upload.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,7 @@ shp build upload <build-name> [path/to/source|.] [flags]
4242
--retention-ttl-after-failed duration duration to delete the BuildRun after it failed
4343
--retention-ttl-after-succeeded duration duration to delete the BuildRun after it succeeded
4444
--sa-name string Kubernetes service-account name
45+
--scheduler-name string specify the scheduler to be used to dispatch the Pod
4546
--timeout duration build process timeout
4647
```
4748

‎docs/shp_buildrun_create.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ shp buildrun create <name> [flags]
3131
--retention-ttl-after-failed duration duration to delete the BuildRun after it failed
3232
--retention-ttl-after-succeeded duration duration to delete the BuildRun after it succeeded
3333
--sa-name string Kubernetes service-account name
34+
--scheduler-name string specify the scheduler to be used to dispatch the Pod
3435
--timeout duration build process timeout
3536
```
3637

‎pkg/shp/flags/build.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,8 @@ func BuildSpecFromFlags(flags *pflag.FlagSet) (*buildv1beta1.BuildSpec, *string,
4444
TTLAfterFailed: &metav1.Duration{},
4545
TTLAfterSucceeded: &metav1.Duration{},
4646
},
47-
NodeSelector: map[string]string{},
47+
NodeSelector: map[string]string{},
48+
SchedulerName: ptr.To(""),
4849
}
4950

5051
sourceFlags(flags, spec.Source)
@@ -57,6 +58,7 @@ func BuildSpecFromFlags(flags *pflag.FlagSet) (*buildv1beta1.BuildSpec, *string,
5758
imageAnnotationsFlags(flags, spec.Output.Annotations)
5859
buildRetentionFlags(flags, spec.Retention)
5960
buildNodeSelectorFlags(flags, spec.NodeSelector)
61+
buildSchedulerNameFlag(flags, spec.SchedulerName)
6062
var dockerfile, builderImage string
6163
dockerfileFlags(flags, &dockerfile)
6264
builderImageFlag(flags, &builderImage)

‎pkg/shp/flags/build_test.go

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,8 @@ func TestBuildSpecFromFlags(t *testing.T) {
5555
Duration: 30 * time.Minute,
5656
},
5757
},
58-
NodeSelector: map[string]string{"kubernetes.io/hostname": "worker-1"},
58+
NodeSelector: map[string]string{"kubernetes.io/hostname": "worker-1"},
59+
SchedulerName: ptr.To("dolphinscheduler"),
5960
}
6061

6162
cmd := &cobra.Command{}
@@ -123,6 +124,13 @@ func TestBuildSpecFromFlags(t *testing.T) {
123124
g.Expect(expected.NodeSelector).To(o.Equal(spec.NodeSelector), ".spec.nodeSelector")
124125
})
125126

127+
t.Run(".spec.schedulerName", func(_ *testing.T) {
128+
err := flags.Set(SchedulerNameFlag, *expected.SchedulerName)
129+
g.Expect(err).To(o.BeNil())
130+
131+
g.Expect(expected.SchedulerName).To(o.Equal(spec.SchedulerName), "spec.schedulerName")
132+
})
133+
126134
t.Run(".spec.timeout", func(_ *testing.T) {
127135
err := flags.Set(TimeoutFlag, expected.Timeout.Duration.String())
128136
g.Expect(err).To(o.BeNil())

‎pkg/shp/flags/buildrun.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ func BuildRunSpecFromFlags(flags *pflag.FlagSet) *buildv1beta1.BuildRunSpec {
2828
TTLAfterFailed: &metav1.Duration{},
2929
TTLAfterSucceeded: &metav1.Duration{},
3030
},
31-
NodeSelector: map[string]string{},
31+
NodeSelector: map[string]string{},
32+
SchedulerName: ptr.To(""),
3233
}
3334

3435
buildRefFlags(flags, &spec.Build)
@@ -41,6 +42,7 @@ func BuildRunSpecFromFlags(flags *pflag.FlagSet) *buildv1beta1.BuildRunSpec {
4142
imageAnnotationsFlags(flags, spec.Output.Annotations)
4243
buildRunRetentionFlags(flags, spec.Retention)
4344
buildNodeSelectorFlags(flags, spec.NodeSelector)
45+
buildSchedulerNameFlag(flags, spec.SchedulerName)
4446
return spec
4547
}
4648

‎pkg/shp/flags/buildrun_test.go

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ func TestBuildRunSpecFromFlags(t *testing.T) {
3838
Duration: 30 * time.Minute,
3939
},
4040
},
41-
NodeSelector: map[string]string{"kubernetes.io/hostname": "worker-1"},
41+
NodeSelector: map[string]string{"kubernetes.io/hostname": "worker-1"},
42+
SchedulerName: ptr.To("dolphinscheduler"),
4243
}
4344

4445
cmd := &cobra.Command{}
@@ -83,6 +84,13 @@ func TestBuildRunSpecFromFlags(t *testing.T) {
8384
g.Expect(expected.NodeSelector).To(o.Equal(spec.NodeSelector), ".spec.nodeSelector")
8485
})
8586

87+
t.Run(".spec.schedulerName", func(_ *testing.T) {
88+
err := flags.Set(SchedulerNameFlag, *expected.SchedulerName)
89+
g.Expect(err).To(o.BeNil())
90+
91+
g.Expect(expected.SchedulerName).To(o.Equal(spec.SchedulerName), "spec.schedulerName")
92+
})
93+
8694
t.Run(".spec.retention.ttlAfterFailed", func(_ *testing.T) {
8795
err := flags.Set(RetentionTTLAfterFailedFlag, expected.Retention.TTLAfterFailed.Duration.String())
8896
g.Expect(err).To(o.BeNil())

‎pkg/shp/flags/flags.go

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,8 @@ const (
6666
RetentionTTLAfterSucceededFlag = "retention-ttl-after-succeeded"
6767
// NodeSelectorFlag command-line flag.
6868
NodeSelectorFlag = "node-selector"
69+
// SchedulerNameFlag command-line flag.
70+
SchedulerNameFlag = "scheduler-name"
6971
)
7072

7173
// sourceFlags flags for ".spec.source"
@@ -266,6 +268,16 @@ func buildNodeSelectorFlags(flags *pflag.FlagSet, nodeSelectorLabels map[string]
266268
flags.Var(NewMapValue(nodeSelectorLabels), NodeSelectorFlag, "set of key-value pairs that correspond to labels of a node to match")
267269
}
268270

271+
// buildSchedulerNameFlag registers flags for adding BuildSpec.SchedulerName
272+
func buildSchedulerNameFlag(flags *pflag.FlagSet, schedulerName *string) {
273+
flags.StringVar(
274+
schedulerName,
275+
SchedulerNameFlag,
276+
"",
277+
"specify the scheduler to be used to dispatch the Pod",
278+
)
279+
}
280+
269281
// envFlags registers flags for adding corev1.EnvVars.
270282
func envFlags(flags *pflag.FlagSet, envs *[]corev1.EnvVar) {
271283
flags.VarP(

‎test/e2e/node-selector.bats

Lines changed: 98 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -3,112 +3,173 @@
33
source test/e2e/helpers.sh
44

55
setup() {
6-
load 'bats/support/load'
7-
load 'bats/assert/load'
8-
load 'bats/file/load'
6+
load 'bats/support/load'
7+
load 'bats/assert/load'
8+
load 'bats/file/load'
99
}
1010

1111
teardown() {
12-
run kubectl delete builds.shipwright.io --all
13-
run kubectl delete buildruns.shipwright.io --all
12+
run kubectl delete builds.shipwright.io --all
13+
run kubectl delete buildruns.shipwright.io --all
1414
}
1515

16+
scheduler_name="dolphinscheduler"
17+
1618
@test "shp build create --node-selector single label" {
1719
# generate random names for our build
18-
build_name=$(random_name)
20+
build_name=$(random_name)
1921

20-
# create a Build with node selector
22+
# create a Build with node selector
2123
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"
2224
assert_success
2325

2426
# ensure that the build was successfully created
25-
assert_output --partial "Created build \"${build_name}\""
27+
assert_output --partial "Created build \"${build_name}\""
2628

2729
# get the jsonpath of Build object .spec.nodeSelector
28-
run kubectl get builds.shipwright.io/${build_name} -ojsonpath="{.spec.nodeSelector}"
29-
assert_success
30+
run kubectl get builds.shipwright.io/${build_name} -ojsonpath="{.spec.nodeSelector}"
31+
assert_success
3032

3133
assert_output '{"kubernetes.io/hostname":"node-1"}'
3234
}
3335

3436
@test "shp build create --node-selector multiple labels" {
3537
# generate random names for our build
36-
build_name=$(random_name)
38+
build_name=$(random_name)
3739

38-
# create a Build with node selector
39-
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"
40+
# create a Build with node selector
41+
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"
4042
assert_success
4143

4244
# ensure that the build was successfully created
43-
assert_output --partial "Created build \"${build_name}\""
45+
assert_output --partial "Created build \"${build_name}\""
4446

4547
# get the jsonpath of Build object .spec.nodeSelector
46-
run kubectl get builds.shipwright.io/${build_name} -ojsonpath="{.spec.nodeSelector}"
47-
assert_success
48+
run kubectl get builds.shipwright.io/${build_name} -ojsonpath="{.spec.nodeSelector}"
49+
assert_success
4850

4951
assert_output --partial '"kubernetes.io/hostname":"node-1"'
5052
assert_output --partial '"kubernetes.io/os":"linux"'
5153
}
5254

55+
@test "shp build create --scheduler-name" {
56+
# generate random names for our build
57+
build_name=$(random_name)
58+
59+
# create a Build with node selector
60+
run shp build create ${build_name} --source-git-url=https://github.com/shipwright-io/sample-go --output-image=my-fake-image --scheduler-name=${scheduler_name}
61+
assert_success
62+
63+
# ensure that the build was successfully created
64+
assert_output --partial "Created build \"${build_name}\""
65+
66+
# get the jsonpath of Build object .spec.nodeSelector
67+
run kubectl get builds.shipwright.io/${build_name} -ojsonpath="{.spec.schedulerName}"
68+
assert_success
69+
70+
assert_output "${scheduler_name}"
71+
}
72+
5373
@test "shp buildrun create --node-selector single label" {
5474
# generate random names for our buildrun
55-
buildrun_name=$(random_name)
56-
build_name=$(random_name)
75+
buildrun_name=$(random_name)
76+
build_name=$(random_name)
5777

58-
# create a Build with node selector
78+
# create a Build with node selector
5979
run shp buildrun create ${buildrun_name} --buildref-name=${build_name} --node-selector="kubernetes.io/hostname=node-1"
6080
assert_success
6181

6282
# ensure that the build was successfully created
63-
assert_output --partial "BuildRun created \"${buildrun_name}\" for Build \"${build_name}\""
83+
assert_output --partial "BuildRun created \"${buildrun_name}\" for Build \"${build_name}\""
6484

6585
# get the jsonpath of Build object .spec.nodeSelector
66-
run kubectl get buildruns.shipwright.io/${buildrun_name} -ojsonpath="{.spec.nodeSelector}"
67-
assert_success
86+
run kubectl get buildruns.shipwright.io/${buildrun_name} -ojsonpath="{.spec.nodeSelector}"
87+
assert_success
6888

6989
assert_output '{"kubernetes.io/hostname":"node-1"}'
7090
}
7191

7292
@test "shp buildrun create --node-selector multiple labels" {
7393
# generate random names for our buildrun
74-
buildrun_name=$(random_name)
75-
build_name=$(random_name)
94+
buildrun_name=$(random_name)
95+
build_name=$(random_name)
7696

77-
# create a Build with node selector
78-
run shp buildrun create ${buildrun_name} --buildref-name=${build_name} --node-selector="kubernetes.io/hostname=node-1" --node-selector="kubernetes.io/os=linux"
97+
# create a Build with node selector
98+
run shp buildrun create ${buildrun_name} --buildref-name=${build_name} --node-selector="kubernetes.io/hostname=node-1" --node-selector="kubernetes.io/os=linux"
7999
assert_success
80100

81101
# ensure that the build was successfully created
82-
assert_output --partial "BuildRun created \"${buildrun_name}\" for Build \"${build_name}\""
102+
assert_output --partial "BuildRun created \"${buildrun_name}\" for Build \"${build_name}\""
83103

84104
# get the jsonpath of Build object .spec.nodeSelector
85-
run kubectl get buildruns.shipwright.io/${buildrun_name} -ojsonpath="{.spec.nodeSelector}"
86-
assert_success
105+
run kubectl get buildruns.shipwright.io/${buildrun_name} -ojsonpath="{.spec.nodeSelector}"
106+
assert_success
87107

88108
assert_output --partial '"kubernetes.io/hostname":"node-1"'
89109
assert_output --partial '"kubernetes.io/os":"linux"'
90110
}
91111

112+
@test "shp buildrun create --scheduler-name" {
113+
# generate random names for our buildrun
114+
buildrun_name=$(random_name)
115+
build_name=$(random_name)
116+
117+
# create a Build with node selector
118+
run shp buildrun create ${buildrun_name} --buildref-name=${build_name} --scheduler-name=${scheduler_name}
119+
assert_success
120+
121+
# ensure that the build was successfully created
122+
assert_output --partial "BuildRun created \"${buildrun_name}\" for Build \"${build_name}\""
123+
124+
# get the jsonpath of Build object .spec.nodeSelector
125+
run kubectl get buildruns.shipwright.io/${buildrun_name} -ojsonpath="{.spec.schedulerName}"
126+
assert_success
127+
128+
assert_output "${scheduler_name}"
129+
}
92130

93131
@test "shp build run --node-selector set" {
94132
# generate random names for our build
95-
build_name=$(random_name)
133+
build_name=$(random_name)
96134

97-
# create a Build with node selector
135+
# create a Build with node selector
98136
run shp build create ${build_name} --source-git-url=https://github.com/shipwright-io/sample-go --output-image=my-fake-image
99137
assert_success
100138

101139
# ensure that the build was successfully created
102-
assert_output --partial "Created build \"${build_name}\""
140+
assert_output --partial "Created build \"${build_name}\""
103141

104142
# get the build object
105-
run kubectl get builds.shipwright.io/${build_name}
106-
assert_success
143+
run kubectl get builds.shipwright.io/${build_name}
144+
assert_success
107145

108146
run shp build run ${build_name} --node-selector="kubernetes.io/hostname=node-1"
109147

110148
# get the jsonpath of Build object .spec.nodeSelector
111-
run kubectl get buildruns.shipwright.io -ojsonpath='{.items[*].spec.nodeSelector}'
112-
assert_success
149+
run kubectl get buildruns.shipwright.io -ojsonpath='{.items[*].spec.nodeSelector}'
150+
assert_success
113151
assert_output --partial '"kubernetes.io/hostname":"node-1"'
114-
}
152+
}
153+
154+
@test "shp build run --scheduler-name" {
155+
# generate random names for our build
156+
build_name=$(random_name)
157+
158+
# create a Build with node selector
159+
run shp build create ${build_name} --source-git-url=https://github.com/shipwright-io/sample-go --output-image=my-fake-image
160+
assert_success
161+
162+
# ensure that the build was successfully created
163+
assert_output --partial "Created build \"${build_name}\""
164+
165+
# get the build object
166+
run kubectl get builds.shipwright.io/${build_name}
167+
assert_success
168+
169+
run shp build run ${build_name} --scheduler-name=${scheduler_name}
170+
171+
# get the jsonpath of BuildRun object .spec.schedulerName
172+
run kubectl get buildruns.shipwright.io -l build.shipwright.io/name=${build_name} -ojsonpath='{.spec.schedulerName}'
173+
assert_success
174+
assert_output --partial "${scheduler_name}"
175+
}

0 commit comments

Comments
 (0)