Skip to content

Commit

Permalink
fix(serving): Remove hardcoded GVK and look it up from schema
Browse files Browse the repository at this point in the history
  • Loading branch information
rhuss committed Jun 14, 2019
1 parent 5d26faa commit 0571168
Show file tree
Hide file tree
Showing 13 changed files with 156 additions and 22 deletions.
9 changes: 4 additions & 5 deletions pkg/kn/commands/revision/revision_describe.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ import (
"github.com/knative/client/pkg/kn/commands"
"github.com/spf13/cobra"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/cli-runtime/pkg/genericclioptions"
)

Expand Down Expand Up @@ -52,10 +51,10 @@ func NewRevisionDescribeCommand(p *commands.KnParams) *cobra.Command {
if err != nil {
return err
}
revision.GetObjectKind().SetGroupVersionKind(schema.GroupVersionKind{
Group: "knative.dev",
Version: "v1alpha1",
Kind: "Revision"})
if err := client.UpdateGroupVersionKind(revision); err != nil {
return err
}

err = printer.PrintObj(revision, cmd.OutOrStdout())
if err != nil {
return err
Expand Down
5 changes: 3 additions & 2 deletions pkg/kn/commands/revision/revision_describe_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (

"github.com/knative/client/pkg/kn/commands"
"github.com/knative/serving/pkg/apis/serving/v1alpha1"
"github.com/knative/serving/pkg/client/clientset/versioned/typed/serving/v1alpha1/fake"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/equality"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
Expand All @@ -29,8 +30,8 @@ import (
)

func fakeRevision(args []string, response *v1alpha1.Revision) (action client_testing.Action, output string, err error) {
knParams := &commands.KnParams{}
cmd, fakeServing, buf := commands.CreateTestKnCommand(NewRevisionCommand(knParams), knParams)
knParams := &commands.KnParams{}
cmd, fakeServing, buf := commands.CreateTestKnCommand(NewRevisionCommand(knParams), knParams)
fakeServing.AddReactor("*", "*",
func(a client_testing.Action) (bool, runtime.Object, error) {
action = a
Expand Down
9 changes: 4 additions & 5 deletions pkg/kn/commands/revision/revision_list.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ import (
"github.com/knative/client/pkg/kn/commands"
"github.com/spf13/cobra"
"k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
)

// NewRevisionListCommand represents 'kn revision list' command
Expand All @@ -47,10 +46,10 @@ func NewRevisionListCommand(p *commands.KnParams) *cobra.Command {
fmt.Fprintf(cmd.OutOrStdout(), "No resources found.\n")
return nil
}
revision.GetObjectKind().SetGroupVersionKind(schema.GroupVersionKind{
Group: "knative.dev",
Version: "v1alpha1",
Kind: "revision"})
if err := client.UpdateGroupVersionKind(revision); err != nil {
return err
}

printer, err := revisionListFlags.ToPrinter()
if err != nil {
return err
Expand Down
3 changes: 3 additions & 0 deletions pkg/kn/commands/revision/revision_list_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,9 @@ import (
"strings"
"testing"

"github.com/knative/serving/pkg/apis/serving"
"github.com/knative/serving/pkg/apis/serving/v1alpha1"
"github.com/knative/serving/pkg/client/clientset/versioned/typed/serving/v1alpha1/fake"
"github.com/knative/client/pkg/kn/commands"
serving "github.com/knative/serving/pkg/apis/serving"
v1alpha1 "github.com/knative/serving/pkg/apis/serving/v1alpha1"
Expand Down
17 changes: 17 additions & 0 deletions pkg/kn/commands/root_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
package commands

import (
"github.com/knative/client/pkg/serving"
serving_v1alpha1_api "github.com/knative/serving/pkg/apis/serving/v1alpha1"
"github.com/knative/serving/pkg/client/clientset/versioned/typed/serving/v1alpha1/fake"
"k8s.io/apimachinery/pkg/runtime"
)

// Helper struct to adding UpdateGroupVersionKind to the fake client, too
type fakeServingV1alpha1Wrapper struct {
*fake.FakeServingV1alpha1
}

func (fakeServingV1alpha1Wrapper) UpdateGroupVersionKind(obj runtime.Object) error {
return serving.UpdateGroupVersionKind(obj, serving_v1alpha1_api.SchemeGroupVersion)
}
9 changes: 4 additions & 5 deletions pkg/kn/commands/service/service_describe.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ import (
"github.com/knative/client/pkg/kn/commands"
"github.com/spf13/cobra"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/cli-runtime/pkg/genericclioptions"
)

Expand Down Expand Up @@ -51,10 +50,10 @@ func NewServiceDescribeCommand(p *commands.KnParams) *cobra.Command {
if err != nil {
return err
}
describeService.GetObjectKind().SetGroupVersionKind(schema.GroupVersionKind{
Group: "knative.dev",
Version: "v1alpha1",
Kind: "Service"})
if err := client.UpdateGroupVersionKind(describeService); err != nil {
return err
}

err = printer.PrintObj(describeService, cmd.OutOrStdout())
if err != nil {
return err
Expand Down
1 change: 1 addition & 0 deletions pkg/kn/commands/service/service_describe_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (

"github.com/knative/client/pkg/kn/commands"
"github.com/knative/serving/pkg/apis/serving/v1alpha1"
"github.com/knative/serving/pkg/client/clientset/versioned/typed/serving/v1alpha1/fake"
"k8s.io/apimachinery/pkg/api/equality"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
Expand Down
8 changes: 3 additions & 5 deletions pkg/kn/commands/service/service_list.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ import (
"github.com/knative/client/pkg/kn/commands"
"github.com/spf13/cobra"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime/schema"
)

// NewServiceListCommand represents 'kn service list' command
Expand All @@ -47,10 +46,9 @@ func NewServiceListCommand(p *commands.KnParams) *cobra.Command {
fmt.Fprintf(cmd.OutOrStdout(), "No resources found.\n")
return nil
}
service.GetObjectKind().SetGroupVersionKind(schema.GroupVersionKind{
Group: "knative.dev",
Version: "v1alpha1",
Kind: "Service"})
if err := client.UpdateGroupVersionKind(service); err != nil {
return err
}

printer, err := serviceListFlags.ToPrinter()
if err != nil {
Expand Down
2 changes: 2 additions & 0 deletions pkg/kn/commands/service/service_list_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ import (

"github.com/knative/client/pkg/kn/commands"
duckv1beta1 "github.com/knative/pkg/apis/duck/v1beta1"
"github.com/knative/serving/pkg/apis/serving/v1alpha1"
"github.com/knative/serving/pkg/client/clientset/versioned/typed/serving/v1alpha1/fake"
v1alpha1 "github.com/knative/serving/pkg/apis/serving/v1alpha1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
Expand Down
1 change: 1 addition & 0 deletions pkg/kn/commands/service/service_update_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import (
"github.com/knative/client/pkg/kn/commands"
servinglib "github.com/knative/client/pkg/serving"
"github.com/knative/serving/pkg/apis/serving/v1alpha1"
"github.com/knative/serving/pkg/client/clientset/versioned/typed/serving/v1alpha1/fake"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
Expand Down
51 changes: 51 additions & 0 deletions pkg/kn/core/root.go
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,15 @@ package core
import (
"flag"
"fmt"
servinglib "github.com/knative/client/pkg/serving"
"io"
"k8s.io/apimachinery/pkg/runtime"
"os"
"path/filepath"

serving_v1alpha1_api "github.com/knative/serving/pkg/apis/serving/v1alpha1"
serving_v1alpha1_client "github.com/knative/serving/pkg/client/clientset/versioned/typed/serving/v1alpha1"
"github.com/mitchellh/go-homedir"
"github.com/knative/client/pkg/kn/commands"
"github.com/knative/client/pkg/kn/commands/revision"
"github.com/knative/client/pkg/kn/commands/service"
Expand All @@ -29,6 +35,39 @@ import (
_ "k8s.io/client-go/plugin/pkg/client/auth/oidc"
)

var cfgFile string
var kubeCfgFile string

// Extend v1alpha1 serving client by a method for updating GVK
type ServingV1alpha1InterfaceWithGvkUpdater interface {
serving_v1alpha1_client.ServingV1alpha1Interface

// Update with the registered V1alpha1 GVK
UpdateGroupVersionKind(obj runtime.Object) error
}

// Delegate to v1alpha1 client
type ServingV1alphaClientWithGvkUpdater struct {
*serving_v1alpha1_client.ServingV1alpha1Client
}

// Update GVK from v1alpha1 schema. Needs to be called by any object returned from the client
func (cl ServingV1alphaClientWithGvkUpdater) UpdateGroupVersionKind(obj runtime.Object) error {
return servinglib.UpdateGroupVersionKind(obj, serving_v1alpha1_api.SchemeGroupVersion)
}

// Parameters for creating commands. Useful for inserting mocks for testing.
type KnParams struct {
Output io.Writer
ServingFactory func() (ServingV1alpha1InterfaceWithGvkUpdater, error)
}

func (c *KnParams) Initialize() {
if c.ServingFactory == nil {
c.ServingFactory = GetConfig
}
}

// rootCmd represents the base command when called without any subcommands
func NewKnCommand(params ...commands.KnParams) *cobra.Command {
var p *commands.KnParams
Expand Down Expand Up @@ -93,3 +132,15 @@ func initKubeConfig() {
commands.KubeCfgFile = filepath.Join(home, ".kube", "config")
}
}

func GetConfig() (ServingV1alpha1InterfaceWithGvkUpdater, error) {
config, err := clientcmd.BuildConfigFromFlags("", kubeCfgFile)
if err != nil {
return nil, err
}
client, err := serving_v1alpha1_client.NewForConfig(config)
if err != nil {
return nil, err
}
return ServingV1alphaClientWithGvkUpdater{client}, nil
}
34 changes: 34 additions & 0 deletions pkg/serving/schema_handling.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package serving

import (
"errors"
"fmt"

"github.com/knative/serving/pkg/client/clientset/versioned/scheme"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
)

// Update the GVK on the given object, based on the GVK registered in into the serving scheme
// for the given GroupVersion
func UpdateGroupVersionKind(obj runtime.Object, gv schema.GroupVersion) error {
gvk, err := getGroupVersionKind(obj, gv)
if err != nil {
return err
}
obj.GetObjectKind().SetGroupVersionKind(*gvk)
return nil
}

func getGroupVersionKind(obj runtime.Object, gv schema.GroupVersion) (*schema.GroupVersionKind, error) {
gvks, _, err := scheme.Scheme.ObjectKinds(obj)
if err != nil {
return nil, err
}
for _, gvk := range gvks {
if gvk.GroupVersion() == gv {
return &gvk, nil
}
}
return nil, errors.New(fmt.Sprintf("no group version %s registered in %s", gv, scheme.Scheme.Name()))
}
29 changes: 29 additions & 0 deletions pkg/serving/schema_handling_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
package serving

import (
"github.com/knative/serving/pkg/apis/serving/v1alpha1"
"k8s.io/apimachinery/pkg/runtime/schema"
"testing"
)

func TestGVKUpdate(t *testing.T) {
service := v1alpha1.Service{}
err := UpdateGroupVersionKind(&service, v1alpha1.SchemeGroupVersion)
if err != nil {
t.Fatalf("cannot update GVK to a service %v", err)
}
if service.Kind != "Service" {
t.Fatalf("wrong kind '%s'", service.Kind)
}
if service.APIVersion != v1alpha1.SchemeGroupVersion.Group+"/"+v1alpha1.SchemeGroupVersion.Version {
t.Fatalf("wrong version '%s'", service.APIVersion)
}
}

func TestGVKUpdateNegative(t *testing.T) {
service := v1alpha1.Service{}
err := UpdateGroupVersionKind(&service, schema.GroupVersion{Group: "bla", Version: "blub"})
if err == nil {
t.Fatal("expect an error for an unregistered group version")
}
}

0 comments on commit 0571168

Please sign in to comment.