Do interface{} -> runtime.Object rename everywhere

duda · Sep 8, 2014 · 0d30a65 · 0d30a65
1 parent 1c2b657
commit 0d30a65
Show file tree

Hide file tree

Showing 33 changed files with 190 additions and 198 deletions.
diff --git a/examples/examples_test.go b/examples/examples_test.go
@@ -31,7 +31,7 @@ import (
 	"github.com/golang/glog"
 )
 
-func validateObject(obj interface{}) (errors []error) {
+func validateObject(obj runtime.Object) (errors []error) {
 	switch t := obj.(type) {
 	case *api.ReplicationController:
 		errors = validation.ValidateManifest(&t.DesiredState.PodTemplate.DesiredState.Manifest)
@@ -85,7 +85,7 @@ func walkJSONFiles(inDir string, fn func(name, path string, data []byte)) error
 }
 
 func TestApiExamples(t *testing.T) {
-	expected := map[string]interface{}{
+	expected := map[string]runtime.Object{
 		"controller":       &api.ReplicationController{},
 		"controller-list":  &api.ReplicationControllerList{},
 		"pod":              &api.Pod{},
@@ -120,7 +120,7 @@ func TestApiExamples(t *testing.T) {
 }
 
 func TestExamples(t *testing.T) {
-	expected := map[string]interface{}{
+	expected := map[string]runtime.Object{
 		"frontend-controller":    &api.ReplicationController{},
 		"redis-slave-controller": &api.ReplicationController{},
 		"redis-master":           &api.Pod{},

diff --git a/pkg/apiserver/apiserver.go b/pkg/apiserver/apiserver.go
@@ -27,17 +27,11 @@ import (
 
 	"github.com/GoogleCloudPlatform/kubernetes/pkg/healthz"
 	"github.com/GoogleCloudPlatform/kubernetes/pkg/httplog"
+	"github.com/GoogleCloudPlatform/kubernetes/pkg/runtime"
 	"github.com/GoogleCloudPlatform/kubernetes/pkg/version"
 	"github.com/golang/glog"
 )
 
-// Codec defines methods for serializing and deserializing API objects.
-type Codec interface {
-	Encode(obj interface{}) (data []byte, err error)
-	Decode(data []byte) (interface{}, error)
-	DecodeInto(data []byte, obj interface{}) error
-}
-
 // mux is an object that can register http handlers.
 type mux interface {
 	Handle(pattern string, handler http.Handler)
@@ -53,7 +47,7 @@ type defaultAPIServer struct {
 // Handle returns a Handler function that expose 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 Codec, prefix string) http.Handler {
+func Handle(storage map[string]RESTStorage, codec runtime.Codec, prefix string) http.Handler {
 	group := NewAPIGroup(storage, codec)
 
 	mux := http.NewServeMux()
@@ -78,7 +72,7 @@ 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 Codec) *APIGroup {
+func NewAPIGroup(storage map[string]RESTStorage, codec runtime.Codec) *APIGroup {
 	return &APIGroup{RESTHandler{
 		storage: storage,
 		codec:   codec,
@@ -147,7 +141,7 @@ func handleVersion(w http.ResponseWriter, req *http.Request) {
 }
 
 // writeJSON renders an object as JSON to the response.
-func writeJSON(statusCode int, codec Codec, object interface{}, w http.ResponseWriter) {
+func writeJSON(statusCode int, codec runtime.Codec, object runtime.Object, w http.ResponseWriter) {
 	output, err := codec.Encode(object)
 	if err != nil {
 		errorJSON(err, codec, w)
@@ -159,7 +153,7 @@ func writeJSON(statusCode int, codec Codec, object interface{}, w http.ResponseW
 }
 
 // errorJSON renders an error to the response.
-func errorJSON(err error, codec Codec, w http.ResponseWriter) {
+func errorJSON(err error, codec runtime.Codec, w http.ResponseWriter) {
 	status := errToAPIStatus(err)
 	writeJSON(status.Code, codec, status, w)
 }

diff --git a/pkg/apiserver/async.go b/pkg/apiserver/async.go
@@ -17,18 +17,19 @@ limitations under the License.
 package apiserver
 
 import (
+	"github.com/GoogleCloudPlatform/kubernetes/pkg/runtime"
 	"github.com/GoogleCloudPlatform/kubernetes/pkg/util"
 )
 
 // WorkFunc is used to perform any time consuming work for an api call, after
 // the input has been validated. Pass one of these to MakeAsync to create an
 // appropriate return value for the Update, Delete, and Create methods.
-type WorkFunc func() (result interface{}, err error)
+type WorkFunc func() (result runtime.Object, err error)
 
 // MakeAsync takes a function and executes it, delivering the result in the way required
 // by RESTStorage's Update, Delete, and Create methods.
-func MakeAsync(fn WorkFunc) <-chan interface{} {
-	channel := make(chan interface{})
+func MakeAsync(fn WorkFunc) <-chan runtime.Object {
+	channel := make(chan runtime.Object)
 	go func() {
 		defer util.HandleCrash()
 		obj, err := fn()

diff --git a/pkg/apiserver/interfaces.go b/pkg/apiserver/interfaces.go
@@ -18,32 +18,33 @@ package apiserver
 
 import (
 	"github.com/GoogleCloudPlatform/kubernetes/pkg/labels"
+	"github.com/GoogleCloudPlatform/kubernetes/pkg/runtime"
 	"github.com/GoogleCloudPlatform/kubernetes/pkg/watch"
 )
 
 // RESTStorage is a generic interface for RESTful storage services.
 // Resources which are exported to the RESTful API of apiserver need to implement this interface.
 type RESTStorage interface {
 	// New returns an empty object that can be used with Create and Update after request data has been put into it.
-	// This object must be a pointer type for use with Codec.DecodeInto([]byte, interface{})
-	New() interface{}
+	// This object must be a pointer type for use with Codec.DecodeInto([]byte, runtime.Object)
+	New() runtime.Object
 
 	// List selects resources in the storage which match to the selector.
 	// TODO: add field selector in addition to label selector.
-	List(labels.Selector) (interface{}, error)
+	List(labels.Selector) (runtime.Object, error)
 
 	// Get finds a resource in the storage by id and returns it.
 	// Although it can return an arbitrary error value, IsNotFound(err) is true for the
 	// returned error value err when the specified resource is not found.
-	Get(id string) (interface{}, error)
+	Get(id string) (runtime.Object, error)
 
 	// Delete finds a resource in the storage and deletes it.
 	// Although it can return an arbitrary error value, IsNotFound(err) is true for the
 	// returned error value err when the specified resource is not found.
-	Delete(id string) (<-chan interface{}, error)
+	Delete(id string) (<-chan runtime.Object, error)
 
-	Create(interface{}) (<-chan interface{}, error)
-	Update(interface{}) (<-chan interface{}, error)
+	Create(runtime.Object) (<-chan runtime.Object, error)
+	Update(runtime.Object) (<-chan runtime.Object, error)
 }
 
 // ResourceWatcher should be implemented by all RESTStorage objects that

diff --git a/pkg/apiserver/operation.go b/pkg/apiserver/operation.go
@@ -25,12 +25,13 @@ import (
 	"time"
 
 	"github.com/GoogleCloudPlatform/kubernetes/pkg/api"
+	"github.com/GoogleCloudPlatform/kubernetes/pkg/runtime"
 	"github.com/GoogleCloudPlatform/kubernetes/pkg/util"
 )
 
 type OperationHandler struct {
 	ops   *Operations
-	codec Codec
+	codec runtime.Codec
 }
 
 func (h *OperationHandler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
@@ -63,8 +64,8 @@ func (h *OperationHandler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
 // Operation represents an ongoing action which the server is performing.
 type Operation struct {
 	ID       string
-	result   interface{}
-	awaiting <-chan interface{}
+	result   runtime.Object
+	awaiting <-chan runtime.Object
 	finished *time.Time
 	lock     sync.Mutex
 	notify   chan struct{}
@@ -90,7 +91,7 @@ func NewOperations() *Operations {
 }
 
 // NewOperation adds a new operation. It is lock-free.
-func (ops *Operations) NewOperation(from <-chan interface{}) *Operation {
+func (ops *Operations) NewOperation(from <-chan runtime.Object) *Operation {
 	id := atomic.AddInt64(&ops.lastID, 1)
 	op := &Operation{
 		ID:       strconv.FormatInt(id, 10),
@@ -110,7 +111,7 @@ func (ops *Operations) insert(op *Operation) {
 }
 
 // List lists operations for an API client.
-func (ops *Operations) List() api.ServerOpList {
+func (ops *Operations) List() *api.ServerOpList {
 	ops.lock.Lock()
 	defer ops.lock.Unlock()
 
@@ -119,7 +120,7 @@ func (ops *Operations) List() api.ServerOpList {
 		ids = append(ids, id)
 	}
 	sort.StringSlice(ids).Sort()
-	ol := api.ServerOpList{}
+	ol := &api.ServerOpList{}
 	for _, id := range ids {
 		ol.Items = append(ol.Items, api.ServerOp{JSONBase: api.JSONBase{ID: id}})
 	}
@@ -185,7 +186,7 @@ func (op *Operation) expired(limitTime time.Time) bool {
 
 // StatusOrResult returns status information or the result of the operation if it is complete,
 // with a bool indicating true in the latter case.
-func (op *Operation) StatusOrResult() (description interface{}, finished bool) {
+func (op *Operation) StatusOrResult() (description runtime.Object, finished bool) {
 	op.lock.Lock()
 	defer op.lock.Unlock()
 

diff --git a/pkg/apiserver/redirect.go b/pkg/apiserver/redirect.go
@@ -20,11 +20,12 @@ import (
 	"net/http"
 
 	"github.com/GoogleCloudPlatform/kubernetes/pkg/httplog"
+	"github.com/GoogleCloudPlatform/kubernetes/pkg/runtime"
 )
 
 type RedirectHandler struct {
 	storage map[string]RESTStorage
-	codec   Codec
+	codec   runtime.Codec
 }
 
 func (r *RedirectHandler) ServeHTTP(w http.ResponseWriter, req *http.Request) {

diff --git a/pkg/apiserver/resthandler.go b/pkg/apiserver/resthandler.go
@@ -23,11 +23,12 @@ import (
 	"github.com/GoogleCloudPlatform/kubernetes/pkg/api"
 	"github.com/GoogleCloudPlatform/kubernetes/pkg/httplog"
 	"github.com/GoogleCloudPlatform/kubernetes/pkg/labels"
+	"github.com/GoogleCloudPlatform/kubernetes/pkg/runtime"
 )
 
 type RESTHandler struct {
 	storage     map[string]RESTStorage
-	codec       Codec
+	codec       runtime.Codec
 	ops         *Operations
 	asyncOpWait time.Duration
 }
@@ -158,7 +159,7 @@ func (h *RESTHandler) handleRESTStorage(parts []string, req *http.Request, w htt
 }
 
 // createOperation creates an operation to process a channel response.
-func (h *RESTHandler) createOperation(out <-chan interface{}, sync bool, timeout time.Duration) *Operation {
+func (h *RESTHandler) createOperation(out <-chan runtime.Object, sync bool, timeout time.Duration) *Operation {
 	op := h.ops.NewOperation(out)
 	if sync {
 		op.WaitFor(timeout)
@@ -175,11 +176,6 @@ func (h *RESTHandler) finishReq(op *Operation, w http.ResponseWriter) {
 	if complete {
 		status := http.StatusOK
 		switch stat := obj.(type) {
-		case api.Status:
-			httplog.LogOf(w).Addf("programmer error: use *api.Status as a result, not api.Status.")
-			if stat.Code != 0 {
-				status = stat.Code
-			}
 		case *api.Status:
 			if stat.Code != 0 {
 				status = stat.Code

diff --git a/pkg/apiserver/watch.go b/pkg/apiserver/watch.go
@@ -32,7 +32,7 @@ import (
 
 type WatchHandler struct {
 	storage map[string]RESTStorage
-	codec   Codec
+	codec   runtime.Codec
 }
 
 func getWatchParams(query url.Values) (label, field labels.Selector, resourceVersion uint64) {

diff --git a/pkg/client/request.go b/pkg/client/request.go
@@ -187,7 +187,8 @@ func (r *Request) Timeout(d time.Duration) *Request {
 // If obj is a string, try to read a file of that name.
 // If obj is a []byte, send it directly.
 // If obj is an io.Reader, use it directly.
-// Otherwise, assume obj is an api type and marshall it correctly.
+// If obj is a runtime.Object, marshal it correctly.
+// Otherwise, set an error.
 func (r *Request) Body(obj interface{}) *Request {
 	if r.err != nil {
 		return r
@@ -204,13 +205,15 @@ func (r *Request) Body(obj interface{}) *Request {
 		r.body = bytes.NewBuffer(t)
 	case io.Reader:
 		r.body = t
-	default:
-		data, err := runtime.DefaultCodec.Encode(obj)
+	case runtime.Object:
+		data, err := runtime.DefaultCodec.Encode(t)
 		if err != nil {
 			r.err = err
 			return r
 		}
 		r.body = bytes.NewBuffer(data)
+	default:
+		r.err = fmt.Errorf("Unknown type used for body: %#v", obj)
 	}
 	return r
 }
@@ -314,15 +317,15 @@ func (r Result) Raw() ([]byte, error) {
 }
 
 // Get returns the result as an object.
-func (r Result) Get() (interface{}, error) {
+func (r Result) Get() (runtime.Object, error) {
 	if r.err != nil {
 		return nil, r.err
 	}
 	return runtime.DefaultCodec.Decode(r.body)
 }
 
 // Into stores the result into obj, if possible.
-func (r Result) Into(obj interface{}) error {
+func (r Result) Into(obj runtime.Object) error {
 	if r.err != nil {
 		return r.err
 	}

diff --git a/pkg/kubecfg/parse.go b/pkg/kubecfg/parse.go
@@ -43,7 +43,7 @@ func (p *Parser) ToWireFormat(data []byte, storage string) ([]byte, error) {
 		return nil, fmt.Errorf("unknown storage type: %v", storage)
 	}
 
-	obj := reflect.New(prototypeType).Interface()
+	obj := reflect.New(prototypeType).Interface().(runtime.Object)
 	err := runtime.DefaultCodec.DecodeInto(data, obj)
 	if err != nil {
 		return nil, err

diff --git a/pkg/kubecfg/proxy_server.go b/pkg/kubecfg/proxy_server.go
@@ -53,7 +53,7 @@ func (s *ProxyServer) Serve() error {
 func (s *ProxyServer) doError(w http.ResponseWriter, err error) {
 	w.WriteHeader(http.StatusInternalServerError)
 	w.Header().Add("Content-type", "application/json")
-	data, _ := runtime.DefaultCodec.Encode(api.Status{
+	data, _ := runtime.DefaultCodec.Encode(&api.Status{
 		Status:  api.StatusFailure,
 		Message: fmt.Sprintf("internal error: %#v", err),
 	})

diff --git a/pkg/kubecfg/resource_printer.go b/pkg/kubecfg/resource_printer.go
@@ -36,7 +36,7 @@ import (
 type ResourcePrinter interface {
 	// Print receives an arbitrary JSON body, formats it and prints it to a writer.
 	Print([]byte, io.Writer) error
-	PrintObj(interface{}, io.Writer) error
+	PrintObj(runtime.Object, io.Writer) error
 }
 
 // IdentityPrinter is an implementation of ResourcePrinter which simply copies the body out to the output stream.
@@ -49,7 +49,7 @@ func (i *IdentityPrinter) Print(data []byte, w io.Writer) error {
 }
 
 // PrintObj is an implementation of ResourcePrinter.PrintObj which simply writes the object to the Writer.
-func (i *IdentityPrinter) PrintObj(obj interface{}, output io.Writer) error {
+func (i *IdentityPrinter) PrintObj(obj runtime.Object, output io.Writer) error {
 	data, err := runtime.DefaultCodec.Encode(obj)
 	if err != nil {
 		return err
@@ -62,7 +62,7 @@ type YAMLPrinter struct{}
 
 // Print parses the data as JSON, re-formats as YAML and prints the YAML.
 func (y *YAMLPrinter) Print(data []byte, w io.Writer) error {
-	var obj interface{}
+	var obj runtime.Object
 	if err := json.Unmarshal(data, &obj); err != nil {
 		return err
 	}
@@ -75,7 +75,7 @@ func (y *YAMLPrinter) Print(data []byte, w io.Writer) error {
 }
 
 // PrintObj prints the data as YAML.
-func (y *YAMLPrinter) PrintObj(obj interface{}, w io.Writer) error {
+func (y *YAMLPrinter) PrintObj(obj runtime.Object, w io.Writer) error {
 	output, err := yaml.Marshal(obj)
 	if err != nil {
 		return err
@@ -251,7 +251,7 @@ func printStatus(status *api.Status, w io.Writer) error {
 // Print parses the data as JSON, then prints the parsed data in a human-friendly
 // format according to the type of the data.
 func (h *HumanReadablePrinter) Print(data []byte, output io.Writer) error {
-	var mapObj map[string]interface{}
+	var mapObj map[string]runtime.Object
 	if err := json.Unmarshal([]byte(data), &mapObj); err != nil {
 		return err
 	}
@@ -268,7 +268,7 @@ func (h *HumanReadablePrinter) Print(data []byte, output io.Writer) error {
 }
 
 // PrintObj prints the obj in a human-friendly format according to the type of the obj.
-func (h *HumanReadablePrinter) PrintObj(obj interface{}, output io.Writer) error {
+func (h *HumanReadablePrinter) PrintObj(obj runtime.Object, output io.Writer) error {
 	w := tabwriter.NewWriter(output, 20, 5, 3, ' ', 0)
 	defer w.Flush()
 	if handler := h.handlerMap[reflect.TypeOf(obj)]; handler != nil {
@@ -300,6 +300,6 @@ func (t *TemplatePrinter) Print(data []byte, w io.Writer) error {
 }
 
 // PrintObj formats the obj with the Go Template.
-func (t *TemplatePrinter) PrintObj(obj interface{}, w io.Writer) error {
+func (t *TemplatePrinter) PrintObj(obj runtime.Object, w io.Writer) error {
 	return t.Template.Execute(w, obj)
 }