Skip to content

Commit e10cdb3

Browse files
roycaihwroycaihw
committed
Dynamic client support subresource create/get/update/patch verbs
1 parent 3904cc7 commit e10cdb3

File tree

2 files changed

+131
-25
lines changed

2 files changed

+131
-25
lines changed

‎staging/src/k8s.io/client-go/dynamic/client.go

+45-7
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,19 @@ type ResourceClient struct {
145145
parameterCodec runtime.ParameterCodec
146146
}
147147

148+
func (rc *ResourceClient) parseResourceSubresourceName() (string, []string) {
149+
var resourceName string
150+
var subresourceName []string
151+
if strings.Contains(rc.resource.Name, "/") {
152+
resourceName = strings.Split(rc.resource.Name, "/")[0]
153+
subresourceName = strings.Split(rc.resource.Name, "/")[1:]
154+
} else {
155+
resourceName = rc.resource.Name
156+
}
157+
158+
return resourceName, subresourceName
159+
}
160+
148161
// List returns a list of objects for this resource.
149162
func (rc *ResourceClient) List(opts metav1.ListOptions) (runtime.Object, error) {
150163
parameterEncoder := rc.parameterCodec
@@ -166,9 +179,11 @@ func (rc *ResourceClient) Get(name string, opts metav1.GetOptions) (*unstructure
166179
parameterEncoder = defaultParameterEncoder
167180
}
168181
result := new(unstructured.Unstructured)
182+
resourceName, subresourceName := rc.parseResourceSubresourceName()
169183
err := rc.cl.Get().
170184
NamespaceIfScoped(rc.ns, rc.resource.Namespaced).
171-
Resource(rc.resource.Name).
185+
Resource(resourceName).
186+
SubResource(subresourceName...).
172187
VersionedParams(&opts, parameterEncoder).
173188
Name(name).
174189
Do().
@@ -205,11 +220,26 @@ func (rc *ResourceClient) DeleteCollection(deleteOptions *metav1.DeleteOptions,
205220
// Create creates the provided resource.
206221
func (rc *ResourceClient) Create(obj *unstructured.Unstructured) (*unstructured.Unstructured, error) {
207222
result := new(unstructured.Unstructured)
208-
err := rc.cl.Post().
223+
resourceName, subresourceName := rc.parseResourceSubresourceName()
224+
req := rc.cl.Post().
209225
NamespaceIfScoped(rc.ns, rc.resource.Namespaced).
210-
Resource(rc.resource.Name).
211-
Body(obj).
212-
Do().
226+
Resource(resourceName).
227+
Body(obj)
228+
if len(subresourceName) > 0 {
229+
// If the provided resource is a subresource, the POST request should contain
230+
// object name. Examples of subresources that support Create operation:
231+
// core/v1/pods/{name}/binding
232+
// core/v1/pods/{name}/eviction
233+
// extensions/v1beta1/deployments/{name}/rollback
234+
// apps/v1beta1/deployments/{name}/rollback
235+
// NOTE: Currently our system assumes every subresource object has the same
236+
// name as the parent resource object. E.g. a pods/binding object having
237+
// metadada.name "foo" means pod "foo" is being bound. We may need to
238+
// change this if we break the assumption in the future.
239+
req = req.SubResource(subresourceName...).
240+
Name(obj.GetName())
241+
}
242+
err := req.Do().
213243
Into(result)
214244
return result, err
215245
}
@@ -220,9 +250,15 @@ func (rc *ResourceClient) Update(obj *unstructured.Unstructured) (*unstructured.
220250
if len(obj.GetName()) == 0 {
221251
return result, errors.New("object missing name")
222252
}
253+
resourceName, subresourceName := rc.parseResourceSubresourceName()
223254
err := rc.cl.Put().
224255
NamespaceIfScoped(rc.ns, rc.resource.Namespaced).
225-
Resource(rc.resource.Name).
256+
Resource(resourceName).
257+
SubResource(subresourceName...).
258+
// NOTE: Currently our system assumes every subresource object has the same
259+
// name as the parent resource object. E.g. a pods/binding object having
260+
// metadada.name "foo" means pod "foo" is being bound. We may need to
261+
// change this if we break the assumption in the future.
226262
Name(obj.GetName()).
227263
Body(obj).
228264
Do().
@@ -246,9 +282,11 @@ func (rc *ResourceClient) Watch(opts metav1.ListOptions) (watch.Interface, error
246282

247283
func (rc *ResourceClient) Patch(name string, pt types.PatchType, data []byte) (*unstructured.Unstructured, error) {
248284
result := new(unstructured.Unstructured)
285+
resourceName, subresourceName := rc.parseResourceSubresourceName()
249286
err := rc.cl.Patch(pt).
250287
NamespaceIfScoped(rc.ns, rc.resource.Namespaced).
251-
Resource(rc.resource.Name).
288+
Resource(resourceName).
289+
SubResource(subresourceName...).
252290
Name(name).
253291
Body(data).
254292
Do().

‎staging/src/k8s.io/client-go/dynamic/client_test.go

+86-18
Original file line numberDiff line numberDiff line change
@@ -150,29 +150,47 @@ func TestList(t *testing.T) {
150150

151151
func TestGet(t *testing.T) {
152152
tcs := []struct {
153+
resource string
153154
namespace string
154155
name string
155156
path string
156157
resp []byte
157158
want *unstructured.Unstructured
158159
}{
159160
{
160-
name: "normal_get",
161-
path: "/api/gtest/vtest/rtest/normal_get",
162-
resp: getJSON("vTest", "rTest", "normal_get"),
163-
want: getObject("vTest", "rTest", "normal_get"),
161+
resource: "rtest",
162+
name: "normal_get",
163+
path: "/api/gtest/vtest/rtest/normal_get",
164+
resp: getJSON("vTest", "rTest", "normal_get"),
165+
want: getObject("vTest", "rTest", "normal_get"),
164166
},
165167
{
168+
resource: "rtest",
166169
namespace: "nstest",
167170
name: "namespaced_get",
168171
path: "/api/gtest/vtest/namespaces/nstest/rtest/namespaced_get",
169172
resp: getJSON("vTest", "rTest", "namespaced_get"),
170173
want: getObject("vTest", "rTest", "namespaced_get"),
171174
},
175+
{
176+
resource: "rtest/srtest",
177+
name: "normal_subresource_get",
178+
path: "/api/gtest/vtest/rtest/normal_subresource_get/srtest",
179+
resp: getJSON("vTest", "srTest", "normal_subresource_get"),
180+
want: getObject("vTest", "srTest", "normal_subresource_get"),
181+
},
182+
{
183+
resource: "rtest/srtest",
184+
namespace: "nstest",
185+
name: "namespaced_subresource_get",
186+
path: "/api/gtest/vtest/namespaces/nstest/rtest/namespaced_subresource_get/srtest",
187+
resp: getJSON("vTest", "srTest", "namespaced_subresource_get"),
188+
want: getObject("vTest", "srTest", "namespaced_subresource_get"),
189+
},
172190
}
173191
for _, tc := range tcs {
174192
gv := &schema.GroupVersion{Group: "gtest", Version: "vtest"}
175-
resource := &metav1.APIResource{Name: "rtest", Namespaced: len(tc.namespace) != 0}
193+
resource := &metav1.APIResource{Name: tc.resource, Namespaced: len(tc.namespace) != 0}
176194
cl, srv, err := getClientServer(gv, func(w http.ResponseWriter, r *http.Request) {
177195
if r.Method != "GET" {
178196
t.Errorf("Get(%q) got HTTP method %s. wanted GET", tc.name, r.Method)
@@ -303,26 +321,42 @@ func TestDeleteCollection(t *testing.T) {
303321

304322
func TestCreate(t *testing.T) {
305323
tcs := []struct {
324+
resource string
306325
name string
307326
namespace string
308327
obj *unstructured.Unstructured
309328
path string
310329
}{
311330
{
312-
name: "normal_create",
313-
path: "/api/gtest/vtest/rtest",
314-
obj: getObject("vTest", "rTest", "normal_create"),
331+
resource: "rtest",
332+
name: "normal_create",
333+
path: "/api/gtest/vtest/rtest",
334+
obj: getObject("vTest", "rTest", "normal_create"),
315335
},
316336
{
337+
resource: "rtest",
317338
name: "namespaced_create",
318339
namespace: "nstest",
319340
path: "/api/gtest/vtest/namespaces/nstest/rtest",
320341
obj: getObject("vTest", "rTest", "namespaced_create"),
321342
},
343+
{
344+
resource: "rtest/srtest",
345+
name: "normal_subresource_create",
346+
path: "/api/gtest/vtest/rtest/normal_subresource_create/srtest",
347+
obj: getObject("vTest", "srTest", "normal_subresource_create"),
348+
},
349+
{
350+
resource: "rtest/srtest",
351+
name: "namespaced_subresource_create",
352+
namespace: "nstest",
353+
path: "/api/gtest/vtest/namespaces/nstest/rtest/namespaced_subresource_create/srtest",
354+
obj: getObject("vTest", "srTest", "namespaced_subresource_create"),
355+
},
322356
}
323357
for _, tc := range tcs {
324358
gv := &schema.GroupVersion{Group: "gtest", Version: "vtest"}
325-
resource := &metav1.APIResource{Name: "rtest", Namespaced: len(tc.namespace) != 0}
359+
resource := &metav1.APIResource{Name: tc.resource, Namespaced: len(tc.namespace) != 0}
326360
cl, srv, err := getClientServer(gv, func(w http.ResponseWriter, r *http.Request) {
327361
if r.Method != "POST" {
328362
t.Errorf("Create(%q) got HTTP method %s. wanted POST", tc.name, r.Method)
@@ -362,26 +396,42 @@ func TestCreate(t *testing.T) {
362396

363397
func TestUpdate(t *testing.T) {
364398
tcs := []struct {
399+
resource string
365400
name string
366401
namespace string
367402
obj *unstructured.Unstructured
368403
path string
369404
}{
370405
{
371-
name: "normal_update",
372-
path: "/api/gtest/vtest/rtest/normal_update",
373-
obj: getObject("vTest", "rTest", "normal_update"),
406+
resource: "rtest",
407+
name: "normal_update",
408+
path: "/api/gtest/vtest/rtest/normal_update",
409+
obj: getObject("vTest", "rTest", "normal_update"),
374410
},
375411
{
412+
resource: "rtest",
376413
name: "namespaced_update",
377414
namespace: "nstest",
378415
path: "/api/gtest/vtest/namespaces/nstest/rtest/namespaced_update",
379416
obj: getObject("vTest", "rTest", "namespaced_update"),
380417
},
418+
{
419+
resource: "rtest/srtest",
420+
name: "normal_subresource_update",
421+
path: "/api/gtest/vtest/rtest/normal_update/srtest",
422+
obj: getObject("vTest", "srTest", "normal_update"),
423+
},
424+
{
425+
resource: "rtest/srtest",
426+
name: "namespaced_subresource_update",
427+
namespace: "nstest",
428+
path: "/api/gtest/vtest/namespaces/nstest/rtest/namespaced_update/srtest",
429+
obj: getObject("vTest", "srTest", "namespaced_update"),
430+
},
381431
}
382432
for _, tc := range tcs {
383433
gv := &schema.GroupVersion{Group: "gtest", Version: "vtest"}
384-
resource := &metav1.APIResource{Name: "rtest", Namespaced: len(tc.namespace) != 0}
434+
resource := &metav1.APIResource{Name: tc.resource, Namespaced: len(tc.namespace) != 0}
385435
cl, srv, err := getClientServer(gv, func(w http.ResponseWriter, r *http.Request) {
386436
if r.Method != "PUT" {
387437
t.Errorf("Update(%q) got HTTP method %s. wanted PUT", tc.name, r.Method)
@@ -492,29 +542,47 @@ func TestWatch(t *testing.T) {
492542

493543
func TestPatch(t *testing.T) {
494544
tcs := []struct {
545+
resource string
495546
name string
496547
namespace string
497548
patch []byte
498549
want *unstructured.Unstructured
499550
path string
500551
}{
501552
{
502-
name: "normal_patch",
503-
path: "/api/gtest/vtest/rtest/normal_patch",
504-
patch: getJSON("vTest", "rTest", "normal_patch"),
505-
want: getObject("vTest", "rTest", "normal_patch"),
553+
resource: "rtest",
554+
name: "normal_patch",
555+
path: "/api/gtest/vtest/rtest/normal_patch",
556+
patch: getJSON("vTest", "rTest", "normal_patch"),
557+
want: getObject("vTest", "rTest", "normal_patch"),
506558
},
507559
{
560+
resource: "rtest",
508561
name: "namespaced_patch",
509562
namespace: "nstest",
510563
path: "/api/gtest/vtest/namespaces/nstest/rtest/namespaced_patch",
511564
patch: getJSON("vTest", "rTest", "namespaced_patch"),
512565
want: getObject("vTest", "rTest", "namespaced_patch"),
513566
},
567+
{
568+
resource: "rtest/srtest",
569+
name: "normal_subresource_patch",
570+
path: "/api/gtest/vtest/rtest/normal_subresource_patch/srtest",
571+
patch: getJSON("vTest", "srTest", "normal_subresource_patch"),
572+
want: getObject("vTest", "srTest", "normal_subresource_patch"),
573+
},
574+
{
575+
resource: "rtest/srtest",
576+
name: "namespaced_subresource_patch",
577+
namespace: "nstest",
578+
path: "/api/gtest/vtest/namespaces/nstest/rtest/namespaced_subresource_patch/srtest",
579+
patch: getJSON("vTest", "srTest", "namespaced_subresource_patch"),
580+
want: getObject("vTest", "srTest", "namespaced_subresource_patch"),
581+
},
514582
}
515583
for _, tc := range tcs {
516584
gv := &schema.GroupVersion{Group: "gtest", Version: "vtest"}
517-
resource := &metav1.APIResource{Name: "rtest", Namespaced: len(tc.namespace) != 0}
585+
resource := &metav1.APIResource{Name: tc.resource, Namespaced: len(tc.namespace) != 0}
518586
cl, srv, err := getClientServer(gv, func(w http.ResponseWriter, r *http.Request) {
519587
if r.Method != "PATCH" {
520588
t.Errorf("Patch(%q) got HTTP method %s. wanted PATCH", tc.name, r.Method)

0 commit comments

Comments
 (0)