Resource Library #301

ellenkorbes · Feb 16, 2018

Package resource implements tools for the discovery and filtering of resources in an API server.

Tests to be implemented in a subsequent PR.

k8s-ci-robot · Feb 16, 2018

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: ellenkorbes
To fully approve this pull request, please assign additional approvers.
We suggest the following additional approver: pwittrock

Assign the PR to them by writing /assign @pwittrock in a comment when ready.

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

The pull request process is described 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

ellenkorbes · Feb 17, 2018

/assign @apelisse
/assign @pwittrock

apelisse · Feb 17, 2018

apelisse reviewed Feb 17, 2018

View changes

This is great! Very clean. Thank you!

apelisse · Feb 17, 2018

pkg/framework/resource/doc.go

+
+The following (admittedly ludicrous) example adds a filter to the example above that excludes all resources that do not start with the letter "n":
+
+	type letterN struct {


Yeah, there is no reason not to have this as a compiled example.

apelisse · Feb 17, 2018

pkg/framework/resource/doc.go

+
+For example:
+
+	p := resource.NewParser(resources, discovery, apiGroup, apiVersion)


Same, I think this could be compiled. We can't test the output, but we can make sure it compiles.

Since the examples won't pass testing, isn't that possibly gonna create a problem for us later on?

if you don't have the // Output: comment in your example, they won't run, they won't fail. They will be compiled to make sure that they are up-to-date though (which is still valuable to us).

apelisse · Feb 17, 2018

pkg/framework/resource/doc.go

+	}
+
+	func (*letterN) Resource(r *resource.Resource) bool {
+		return string(r.Resource.Name[0]) == "n"


It'd be weird to have an empty resource name, but that could technically crash ;-)

apelisse · Feb 17, 2018

pkg/framework/resource/doc.go

+	type letterN struct {
+	}
+
+	func (*letterN) Resource(r *resource.Resource) bool {


Doesn't need to be pointer.

apelisse · Feb 17, 2018

pkg/framework/resource/doc.go

+		if err != nil {
+			panic(err)
+		}
+		r = r.Filter(&letterN{})


Doesn't have to be address (if you remove the two pointers above)

apelisse · Feb 17, 2018

pkg/framework/resource/parse.go

+
+// resource returns the resource name and true if it is a resource (not a subresource).
+// It returns the resource name and false it if it is a subresource.
+func (p *parser) resource(resource *v1.APIResource) (string, bool) {


naming return parameters?

apelisse · Feb 17, 2018

pkg/framework/resource/parse.go

+}
+
+// isGroupVersionMatch returns false if either group or version doesn't match with the API.
+func (p *parser) isGroupVersionMatch(group, version string) bool {


I'm wondering why we need that? If we could get rid of that, that'd simplify the creation of the parser. @pwittrock

apelisse · Feb 17, 2018

pkg/framework/resource/resource.go

+
+// Resource is an API Resource.
+type Resource struct {
+	Resource        v1.APIResource


I think we'd rather make these private by default, and change them to public as needed.

You sure? If I were to do this it'd break my filter examples (they depend on r.Resource.Name).

I tried it anyway and the IDE gave me:

Rename failed: /home/ellen/go/src/k8s.io/kubectl/pkg/framework/resource/resource.go:26:6: renaming this type "Resource" to "resource" would make it unexported /home/ellen/go/src/k8s.io/kubectl/pkg/framework/resource/poc/main.go:38:38: breaking references from packages such as "k8s.io/kubectl/pkg/framework/resource/poc" [...]

I did it by hand then and indeed it broke everything.

undefined: "k8s.io/kubectl/pkg/framework/resource".Resource

There's probably a way to do the filtering differently, but do we really have to?

Sorry if I was unclear. By "these", I meant "all these fields". If this one in particular is needed, let's keep it public, what about the others?

apelisse · Feb 17, 2018

pkg/framework/resource/resource.go

+
+// SubResource is an API subresource.
+type SubResource struct {
+	Resource        v1.APIResource


public -> private?

apelisse · Feb 17, 2018

pkg/framework/resource/parse.go

+}
+
+// indexResources indexes into maps the resources from the API resource list. It returns a map indexed by resource name, and a map indexed by GroupVersionResource objects.
+func (p *parser) indexResources(gvs []*v1.APIResourceList) (map[string][]*Resource, map[schema.GroupVersionResource]*Resource) {


Should the type be "Resources" here (first returned type)?

apelisse · Feb 17, 2018

Yeah, you should run gofmt too.

apelisse · Feb 17, 2018

apelisse reviewed Feb 17, 2018

View changes

apelisse · Feb 17, 2018

pkg/framework/resource/parse.go

+	return true
+}
+
+// getOpenAPI retrieves a schema object from the API based on a GroupVersionResource triplet.


I'm not sure why this returns the Schema and bool. It's safe and sufficient to check if Schema is nil.

apelisse · Feb 20, 2018

This is great. Please fix the test so that we can merge it!

Thanks!

ellenkorbes · Feb 25, 2018

/retest

apelisse · Feb 27, 2018

apelisse reviewed Feb 27, 2018

View changes

Just had time for a cursory look, but I think it's pretty good. I have a bunch of nit, but I don't want these to block.

apelisse · Feb 27, 2018

pkg/framework/openapi/openapi_test.go

+	tst "k8s.io/kubernetes/pkg/kubectl/cmd/util/openapi/testing"
+)
+
+var fakeSchema = tst.Fake{Path: filepath.Join("..", "..", "..", "..", "..", "api", "openapi-spec", "swagger.json")}


This can't work :-/

apelisse · Feb 27, 2018

pkg/framework/openapi/testing/BUILD

@@ -0,0 +1,33 @@
+package(default_visibility = ["//visibility:public"])


I think you can drop these files in general (bazel)

apelisse · Feb 27, 2018

pkg/framework/openapi/validation/validation.go

@@ -0,0 +1,141 @@
+/*


I'm not sure you need this package at all.

apelisse · Feb 27, 2018

pkg/framework/resource/resource.go

+	Resource        v1.APIResource
+	apiGroupVersion schema.GroupVersion
+	schema          openapi.Schema
+	SubResources    []*SubResource


Try to sort public and then private fields for readability

apelisse · Mar 6, 2018

apelisse approved these changes Mar 6, 2018

View changes

Good job Ellen! Thank you so much 🎆

k8s-ci-robot added the cncf-cla: yes label Feb 16, 2018

k8s-ci-robot added the size/XL label Feb 16, 2018

k8s-ci-robot assigned apelisse and pwittrock Feb 17, 2018

k8s-ci-robot added size/XXL and removed size/XL labels Feb 25, 2018

ellenkorbes added some commits Mar 2, 2018

resource library

3be8109

rebase

a9cf135

added vendor directories

Loading status checks…

f893cb6

k8s-ci-robot merged commit f09aa18 into kubernetes:master Mar 6, 2018
3 checks passed

3 checks passed

cla/linuxfoundation ellenkorbes authorized
Details

continuous-integration/travis-ci/pr The Travis CI build passed
Details

tide In tide pool.
Details

kubernetes/kubectl

Join GitHub today

Resource Library #301

Conversation

ellenkorbes commented Feb 16, 2018 • edited

k8s-ci-robot added the cncf-cla: yes label Feb 16, 2018

This comment has been minimized.

k8s-ci-robot commented Feb 16, 2018

k8s-ci-robot added the size/XL label Feb 16, 2018

This comment has been minimized.

ellenkorbes commented Feb 17, 2018

k8s-ci-robot assigned apelisse and pwittrock Feb 17, 2018

apelisse reviewed Feb 17, 2018 View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

apelisse commented Feb 17, 2018

apelisse reviewed Feb 17, 2018 View changes

This comment has been minimized.

This comment has been minimized.

apelisse commented Feb 20, 2018

k8s-ci-robot added size/XXL and removed size/XL labels Feb 25, 2018

This comment has been minimized.

ellenkorbes commented Feb 25, 2018

apelisse reviewed Feb 27, 2018 View changes

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

ellenkorbes added some commits Mar 2, 2018

apelisse approved these changes Mar 6, 2018 View changes

Hide details View details k8s-ci-robot merged commit f09aa18 into kubernetes:master Mar 6, 2018 3 checks passed

3 checks passed

ellenkorbes commented Feb 16, 2018 •

edited

apelisse reviewed Feb 17, 2018

View changes

apelisse reviewed Feb 17, 2018

View changes

apelisse reviewed Feb 27, 2018

View changes

apelisse approved these changes Mar 6, 2018

View changes

k8s-ci-robot merged commit `f09aa18` into kubernetes:master Mar 6, 2018
3 checks passed