Start setting SelfLink

pkg/api/latest/latest.go

@@ -49,16 +49,36 @@ var Codec = v1beta1.Codec
 // TODO: when versioning changes, make this part of each API definition.
 var ResourceVersioner = runtime.NewJSONBaseResourceVersioner()
 
+// SelfLinker can set or get the SelfLink field of all API types.
+// TODO: when versioning changes, make this part of each API definition.
+// TODO(lavalamp): Combine SelfLinker & ResourceVersioner interfaces, force all uses
+// to go through the InterfacesFor method below.
+var SelfLinker = runtime.NewJSONBaseSelfLinker()
+
+// VersionInterfaces contains the interfaces one should use for dealing with types of a particular version.
+type VersionInterfaces struct {
+	runtime.Codec
+	runtime.ResourceVersioner
+	runtime.SelfLinker
+}
+
 // InterfacesFor returns the default Codec and ResourceVersioner for a given version
 // string, or an error if the version is not known.
-func InterfacesFor(version string) (codec runtime.Codec, versioner runtime.ResourceVersioner, err error) {
+func InterfacesFor(version string) (*VersionInterfaces, error) {
 	switch version {
 	case "v1beta1":
-		codec, versioner = v1beta1.Codec, ResourceVersioner
+		return &VersionInterfaces{
+			Codec:             v1beta1.Codec,
+			ResourceVersioner: ResourceVersioner,
+			SelfLinker:        SelfLinker,
+		}, nil
 	case "v1beta2":
-		codec, versioner = v1beta2.Codec, ResourceVersioner
+		return &VersionInterfaces{
+			Codec:             v1beta2.Codec,
+			ResourceVersioner: ResourceVersioner,
+			SelfLinker:        SelfLinker,
+		}, nil
 	default:
-		err = fmt.Errorf("unsupported storage version: %s (valid: %s)", version, strings.Join(Versions, ", "))
+		return nil, fmt.Errorf("unsupported storage version: %s (valid: %s)", version, strings.Join(Versions, ", "))
 	}
-	return
 }

pkg/api/latest/latest_test.go

@@ -146,11 +146,11 @@ func TestCodec(t *testing.T) {
 }
 
 func TestInterfacesFor(t *testing.T) {
-	if _, _, err := InterfacesFor(""); err == nil {
+	if _, err := InterfacesFor(""); err == nil {
 		t.Fatalf("unexpected non-error: %v", err)
 	}
 	for i, version := range append([]string{Version, OldestVersion}, Versions...) {
-		if codec, versioner, err := InterfacesFor(version); err != nil || codec == nil || versioner == nil {
+		if vi, err := InterfacesFor(version); err != nil || vi == nil {
 			t.Fatalf("%d: unexpected result: %v", i, err)
 		}
 	}

pkg/apiserver/apiserver.go

@@ -45,11 +45,11 @@ const (
 	StatusUnprocessableEntity = 422
 )
 
-// Handle returns a Handler function that expose the provided storage interfaces
+// Handle returns a Handler function that exposes the provided storage interfaces
 // as RESTful resources at prefix, serialized by codec, and also includes the support
 // http resources.
-func Handle(storage map[string]RESTStorage, codec runtime.Codec, prefix string) http.Handler {
-	group := NewAPIGroup(storage, codec)
+func Handle(storage map[string]RESTStorage, codec runtime.Codec, prefix string, selfLinker runtime.SelfLinker) http.Handler {
+	group := NewAPIGroup(storage, codec, prefix, selfLinker)
 
 	mux := http.NewServeMux()
 	group.InstallREST(mux, prefix)
@@ -72,11 +72,13 @@ type APIGroup struct {
 // This is a helper method for registering multiple sets of REST handlers under different
 // prefixes onto a server.
 // TODO: add multitype codec serialization
-func NewAPIGroup(storage map[string]RESTStorage, codec runtime.Codec) *APIGroup {
+func NewAPIGroup(storage map[string]RESTStorage, codec runtime.Codec, canonicalPrefix string, selfLinker runtime.SelfLinker) *APIGroup {
 	return &APIGroup{RESTHandler{
-		storage: storage,
-		codec:   codec,
-		ops:     NewOperations(),
+		storage:         storage,
+		codec:           codec,
+		canonicalPrefix: canonicalPrefix,
+		selfLinker:      selfLinker,
+		ops:             NewOperations(),
 		// Delay just long enough to handle most simple write operations
 		asyncOpWait: time.Millisecond * 25,
 	}}

pkg/apiserver/apiserver_test.go

@@ -45,6 +45,7 @@ func convert(obj runtime.Object) (runtime.Object, error) {
 }
 
 var codec = latest.Codec
+var selfLinker = latest.SelfLinker
 
 func init() {
 	api.Scheme.AddKnownTypes("", &Simple{}, &SimpleList{})
@@ -193,7 +194,7 @@ func TestNotFound(t *testing.T) {
 	}
 	handler := Handle(map[string]RESTStorage{
 		"foo": &SimpleRESTStorage{},
-	}, codec, "/prefix/version")
+	}, codec, "/prefix/version", selfLinker)
 	server := httptest.NewServer(handler)
 	client := http.Client{}
 	for k, v := range cases {
@@ -214,7 +215,7 @@ func TestNotFound(t *testing.T) {
 }
 
 func TestVersion(t *testing.T) {
-	handler := Handle(map[string]RESTStorage{}, codec, "/prefix/version")
+	handler := Handle(map[string]RESTStorage{}, codec, "/prefix/version", selfLinker)
 	server := httptest.NewServer(handler)
 	client := http.Client{}
 
@@ -243,7 +244,11 @@ func TestSimpleList(t *testing.T) {
 	storage := map[string]RESTStorage{}
 	simpleStorage := SimpleRESTStorage{}
 	storage["simple"] = &simpleStorage
-	handler := Handle(storage, codec, "/prefix/version")
+	selfLinker := &setTestSelfLinker{
+		t:           t,
+		expectedSet: "/prefix/version/simple",
+	}
+	handler := Handle(storage, codec, "/prefix/version", selfLinker)
 	server := httptest.NewServer(handler)
 
 	resp, err := http.Get(server.URL + "/prefix/version/simple")
@@ -254,6 +259,9 @@ func TestSimpleList(t *testing.T) {
 	if resp.StatusCode != http.StatusOK {
 		t.Errorf("Unexpected status: %d, Expected: %d, %#v", resp.StatusCode, http.StatusOK, resp)
 	}
+	if !selfLinker.called {
+		t.Errorf("Never set self link")
+	}
 }
 
 func TestErrorList(t *testing.T) {
@@ -262,7 +270,7 @@ func TestErrorList(t *testing.T) {
 		errors: map[string]error{"list": fmt.Errorf("test Error")},
 	}
 	storage["simple"] = &simpleStorage
-	handler := Handle(storage, codec, "/prefix/version")
+	handler := Handle(storage, codec, "/prefix/version", selfLinker)
 	server := httptest.NewServer(handler)
 
 	resp, err := http.Get(server.URL + "/prefix/version/simple")
@@ -286,7 +294,7 @@ func TestNonEmptyList(t *testing.T) {
 		},
 	}
 	storage["simple"] = &simpleStorage
-	handler := Handle(storage, codec, "/prefix/version")
+	handler := Handle(storage, codec, "/prefix/version", selfLinker)
 	server := httptest.NewServer(handler)
 
 	resp, err := http.Get(server.URL + "/prefix/version/simple")
@@ -320,8 +328,12 @@ func TestGet(t *testing.T) {
 			Name: "foo",
 		},
 	}
+	selfLinker := &setTestSelfLinker{
+		t:           t,
+		expectedSet: "/prefix/version/simple/id",
+	}
 	storage["simple"] = &simpleStorage
-	handler := Handle(storage, codec, "/prefix/version")
+	handler := Handle(storage, codec, "/prefix/version", selfLinker)
 	server := httptest.NewServer(handler)
 
 	resp, err := http.Get(server.URL + "/prefix/version/simple/id")
@@ -334,6 +346,9 @@ func TestGet(t *testing.T) {
 	if itemOut.Name != simpleStorage.item.Name {
 		t.Errorf("Unexpected data: %#v, expected %#v (%s)", itemOut, simpleStorage.item, string(body))
 	}
+	if !selfLinker.called {
+		t.Errorf("Never set self link")
+	}
 }
 
 func TestGetMissing(t *testing.T) {
@@ -342,7 +357,7 @@ func TestGetMissing(t *testing.T) {
 		errors: map[string]error{"get": apierrs.NewNotFound("simple", "id")},
 	}
 	storage["simple"] = &simpleStorage
-	handler := Handle(storage, codec, "/prefix/version")
+	handler := Handle(storage, codec, "/prefix/version", selfLinker)
 	server := httptest.NewServer(handler)
 
 	resp, err := http.Get(server.URL + "/prefix/version/simple/id")
@@ -360,7 +375,7 @@ func TestDelete(t *testing.T) {
 	simpleStorage := SimpleRESTStorage{}
 	ID := "id"
 	storage["simple"] = &simpleStorage
-	handler := Handle(storage, codec, "/prefix/version")
+	handler := Handle(storage, codec, "/prefix/version", selfLinker)
 	server := httptest.NewServer(handler)
 
 	client := http.Client{}
@@ -382,7 +397,7 @@ func TestDeleteMissing(t *testing.T) {
 		errors: map[string]error{"delete": apierrs.NewNotFound("simple", ID)},
 	}
 	storage["simple"] = &simpleStorage
-	handler := Handle(storage, codec, "/prefix/version")
+	handler := Handle(storage, codec, "/prefix/version", selfLinker)
 	server := httptest.NewServer(handler)
 
 	client := http.Client{}
@@ -402,7 +417,11 @@ func TestUpdate(t *testing.T) {
 	simpleStorage := SimpleRESTStorage{}
 	ID := "id"
 	storage["simple"] = &simpleStorage
-	handler := Handle(storage, codec, "/prefix/version")
+	selfLinker := &setTestSelfLinker{
+		t:           t,
+		expectedSet: "/prefix/version/simple/" + ID,
+	}
+	handler := Handle(storage, codec, "/prefix/version", selfLinker)
 	server := httptest.NewServer(handler)
 
 	item := &Simple{
@@ -423,6 +442,9 @@ func TestUpdate(t *testing.T) {
 	if simpleStorage.updated.Name != item.Name {
 		t.Errorf("Unexpected update value %#v, expected %#v.", simpleStorage.updated, item)
 	}
+	if !selfLinker.called {
+		t.Errorf("Never set self link")
+	}
 }
 
 func TestUpdateMissing(t *testing.T) {
@@ -432,7 +454,7 @@ func TestUpdateMissing(t *testing.T) {
 		errors: map[string]error{"update": apierrs.NewNotFound("simple", ID)},
 	}
 	storage["simple"] = &simpleStorage
-	handler := Handle(storage, codec, "/prefix/version")
+	handler := Handle(storage, codec, "/prefix/version", selfLinker)
 	server := httptest.NewServer(handler)
 
 	item := &Simple{
@@ -459,7 +481,7 @@ func TestCreate(t *testing.T) {
 	simpleStorage := &SimpleRESTStorage{}
 	handler := Handle(map[string]RESTStorage{
 		"foo": simpleStorage,
-	}, codec, "/prefix/version")
+	}, codec, "/prefix/version", selfLinker)
 	handler.(*defaultAPIServer).group.handler.asyncOpWait = 0
 	server := httptest.NewServer(handler)
 	client := http.Client{}
@@ -500,7 +522,7 @@ func TestCreateNotFound(t *testing.T) {
 			// See https://github.com/GoogleCloudPlatform/kubernetes/pull/486#discussion_r15037092.
 			errors: map[string]error{"create": apierrs.NewNotFound("simple", "id")},
 		},
-	}, codec, "/prefix/version")
+	}, codec, "/prefix/version", selfLinker)
 	server := httptest.NewServer(handler)
 	client := http.Client{}
 
@@ -533,21 +555,43 @@ func TestParseTimeout(t *testing.T) {
 	}
 }
 
+type setTestSelfLinker struct {
+	t           *testing.T
+	expectedSet string
+	id          string
+	called      bool
+}
+
+func (s *setTestSelfLinker) ID(runtime.Object) (string, error)     { return s.id, nil }
+func (*setTestSelfLinker) SelfLink(runtime.Object) (string, error) { return "", nil }
+func (s *setTestSelfLinker) SetSelfLink(obj runtime.Object, selfLink string) error {
+	if e, a := s.expectedSet, selfLink; e != a {
+		s.t.Errorf("expected '%v', got '%v'", e, a)
+	}
+	s.called = true
+	return nil
+}
+
 func TestSyncCreate(t *testing.T) {
 	storage := SimpleRESTStorage{
 		injectedFunction: func(obj runtime.Object) (runtime.Object, error) {
 			time.Sleep(5 * time.Millisecond)
 			return obj, nil
 		},
 	}
+	selfLinker := &setTestSelfLinker{
+		t:           t,
+		id:          "bar",
+		expectedSet: "/prefix/version/foo/bar",
+	}
 	handler := Handle(map[string]RESTStorage{
 		"foo": &storage,
-	}, codec, "/prefix/version")
+	}, codec, "/prefix/version", selfLinker)
 	server := httptest.NewServer(handler)
 	client := http.Client{}
 
 	simple := &Simple{
-		Name: "foo",
+		Name: "bar",
 	}
 	data, _ := codec.Encode(simple)
 	request, err := http.NewRequest("POST", server.URL+"/prefix/version/foo?sync=true", bytes.NewBuffer(data))
@@ -579,6 +623,9 @@ func TestSyncCreate(t *testing.T) {
 	if response.StatusCode != http.StatusOK {
 		t.Errorf("Unexpected status: %d, Expected: %d, %#v", response.StatusCode, http.StatusOK, response)
 	}
+	if !selfLinker.called {
+		t.Errorf("Never set self link")
+	}
 }
 
 func expectApiStatus(t *testing.T, method, url string, data []byte, code int) *api.Status {
@@ -611,7 +658,7 @@ func TestAsyncDelayReturnsError(t *testing.T) {
 			return nil, apierrs.NewAlreadyExists("foo", "bar")
 		},
 	}
-	handler := Handle(map[string]RESTStorage{"foo": &storage}, codec, "/prefix/version")
+	handler := Handle(map[string]RESTStorage{"foo": &storage}, codec, "/prefix/version", selfLinker)
 	handler.(*defaultAPIServer).group.handler.asyncOpWait = time.Millisecond / 2
 	server := httptest.NewServer(handler)
 
@@ -629,11 +676,16 @@ func TestAsyncCreateError(t *testing.T) {
 			return nil, apierrs.NewAlreadyExists("foo", "bar")
 		},
 	}
-	handler := Handle(map[string]RESTStorage{"foo": &storage}, codec, "/prefix/version")
+	selfLinker := &setTestSelfLinker{
+		t:           t,
+		id:          "bar",
+		expectedSet: "/prefix/version/foo/bar",
+	}
+	handler := Handle(map[string]RESTStorage{"foo": &storage}, codec, "/prefix/version", selfLinker)
 	handler.(*defaultAPIServer).group.handler.asyncOpWait = 0
 	server := httptest.NewServer(handler)
 
-	simple := &Simple{Name: "foo"}
+	simple := &Simple{Name: "bar"}
 	data, _ := codec.Encode(simple)
 
 	status := expectApiStatus(t, "POST", fmt.Sprintf("%s/prefix/version/foo", server.URL), data, http.StatusAccepted)
@@ -667,6 +719,9 @@ func TestAsyncCreateError(t *testing.T) {
 			t.Logf("Details %#v, Got %#v", *expectedStatus.Details, *finalStatus.Details)
 		}
 	}
+	if !selfLinker.called {
+		t.Errorf("Never set self link")
+	}
 }
 
 type UnregisteredAPIObject struct {
@@ -723,7 +778,7 @@ func TestSyncCreateTimeout(t *testing.T) {
 	}
 	handler := Handle(map[string]RESTStorage{
 		"foo": &storage,
-	}, codec, "/prefix/version")
+	}, codec, "/prefix/version", selfLinker)
 	server := httptest.NewServer(handler)
 
 	simple := &Simple{Name: "foo"}
@@ -753,7 +808,10 @@ func TestCORSAllowedOrigins(t *testing.T) {
 			t.Errorf("unexpected error: %v", err)
 		}
 
-		handler := CORS(Handle(map[string]RESTStorage{}, codec, "/prefix/version"), allowedOriginRegexps, nil, nil, "true")
+		handler := CORS(
+			Handle(map[string]RESTStorage{}, codec, "/prefix/version", selfLinker),
+			allowedOriginRegexps, nil, nil, "true",
+		)
 		server := httptest.NewServer(handler)
 		client := http.Client{}
 

pkg/apiserver/minionproxy_test.go

@@ -127,7 +127,7 @@ func TestApiServerMinionProxy(t *testing.T) {
 	proxyServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
 		w.Write([]byte(req.URL.Path))
 	}))
-	server := httptest.NewServer(Handle(nil, nil, "/prefix"))
+	server := httptest.NewServer(Handle(nil, nil, "/prefix", selfLinker))
 	proxy, _ := url.Parse(proxyServer.URL)
 	resp, err := http.Get(fmt.Sprintf("%s/proxy/minion/%s%s", server.URL, proxy.Host, "/test"))
 	if err != nil {