pkg/apis/contexts_test.go

/*
Copyright 2019 The Knative Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package apis

import (
	"context"
	"net/http"
	"testing"

	"github.com/google/go-cmp/cmp"
	authenticationv1 "k8s.io/api/authentication/v1"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

func TestContexts(t *testing.T) {
	ctx := context.Background()

	tests := []struct {
		name  string
		ctx   context.Context
		check func(context.Context) bool
		want  bool
	}{{
		name:  "is in create",
		ctx:   WithinCreate(ctx),
		check: IsInCreate,
		want:  true,
	}, {
		name:  "not in create (bare)",
		ctx:   ctx,
		check: IsInCreate,
		want:  false,
	}, {
		name:  "not in create (update)",
		ctx:   WithinUpdate(ctx, struct{}{}),
		check: IsInCreate,
		want:  false,
	}, {
		name:  "is in delete",
		ctx:   WithinDelete(ctx),
		check: IsInDelete,
		want:  true,
	}, {
		name:  "not in delete (bare)",
		ctx:   ctx,
		check: IsInDelete,
		want:  false,
	}, {
		name:  "not in delete (create)",
		ctx:   WithinCreate(ctx),
		check: IsInDelete,
		want:  false,
	}, {
		name:  "is in update",
		ctx:   WithinUpdate(ctx, struct{}{}),
		check: IsInUpdate,
		want:  true,
	}, {
		name:  "is in update",
		ctx:   WithinUpdate(ctx, struct{}{}),
		check: IsInStatusUpdate,
		want:  false,
	}, {
		name:  "is in update (subresource)",
		ctx:   WithinSubResourceUpdate(ctx, struct{}{}, "scale"),
		check: IsInUpdate,
		want:  true,
	}, {
		name:  "is not in status update",
		ctx:   WithinSubResourceUpdate(ctx, struct{}{}, "scale"),
		check: IsInStatusUpdate,
		want:  false,
	}, {
		name:  "is in status update",
		ctx:   WithinSubResourceUpdate(ctx, struct{}{}, "status"),
		check: IsInStatusUpdate,
		want:  true,
	}, {
		name:  "not in update (bare)",
		ctx:   ctx,
		check: IsInUpdate,
		want:  false,
	}, {
		name:  "not in status update (bare)",
		ctx:   ctx,
		check: IsInStatusUpdate,
		want:  false,
	}, {
		name:  "not in update (create)",
		ctx:   WithinCreate(ctx),
		check: IsInUpdate,
		want:  false,
	}, {
		name:  "in spec",
		ctx:   WithinSpec(ctx),
		check: IsInSpec,
		want:  true,
	}, {
		name:  "not in spec",
		ctx:   WithinStatus(ctx),
		check: IsInSpec,
		want:  false,
	}, {
		name:  "in status",
		ctx:   WithinStatus(ctx),
		check: IsInStatus,
		want:  true,
	}, {
		name:  "not in status",
		ctx:   WithinSpec(ctx),
		check: IsInStatus,
		want:  false,
	}, {
		name:  "disallow deprecated",
		ctx:   DisallowDeprecated(ctx),
		check: IsDeprecatedAllowed,
		want:  false,
	}, {
		name:  "allow deprecated",
		ctx:   ctx,
		check: IsDeprecatedAllowed,
		want:  true,
	}, {
		name:  "allow different namespace",
		ctx:   AllowDifferentNamespace(ctx),
		check: IsDifferentNamespaceAllowed,
		want:  true,
	}, {
		name:  "don't allow different namespace",
		ctx:   ctx,
		check: IsDifferentNamespaceAllowed,
		want:  false,
	}, {
		name:  "not in dry run",
		ctx:   ctx,
		check: IsDryRun,
		want:  false,
	}, {
		name:  "in dry run",
		ctx:   WithDryRun(ctx),
		check: IsDryRun,
		want:  true,
	}, {
		name:  "within parent",
		ctx:   WithDryRun(ctx),
		check: IsWithinParent,
		want:  false,
	}, {
		name:  "in dry run",
		ctx:   WithinParent(ctx, metav1.ObjectMeta{Name: "jack"}),
		check: IsWithinParent,
		want:  true,
	}}

	for _, tc := range tests {
		t.Run(tc.name, func(t *testing.T) {
			got := tc.check(tc.ctx)
			if tc.want != got {
				t.Errorf("check() = %v, wanted %v", got, tc.want)
			}
		})
	}
}

func TestGetBaseline(t *testing.T) {
	ctx := context.Background()

	if got := GetBaseline(ctx); got != nil {
		t.Errorf("GetBaseline() = %v, wanted %v", got, nil)
	}

	var foo interface{} = "this is the object"
	ctx = WithinUpdate(ctx, foo)

	if want, got := foo, GetBaseline(ctx); got != want {
		t.Errorf("GetBaseline() = %v, wanted %v", got, want)
	}
}

func TestGetUserInfo(t *testing.T) {
	ctx := context.Background()

	if got := GetUserInfo(ctx); got != nil {
		t.Errorf("GetUserInfo() = %v, wanted %v", got, nil)
	}

	bob := &authenticationv1.UserInfo{Username: "bob"}
	ctx = WithUserInfo(ctx, bob)

	if want, got := bob, GetUserInfo(ctx); got != want {
		t.Errorf("GetUserInfo() = %v, wanted %v", got, want)
	}
}

func TestParentMeta(t *testing.T) {
	ctx := context.Background()

	if got, want := ParentMeta(ctx), (metav1.ObjectMeta{}); !cmp.Equal(want, got) {
		t.Errorf("ParentMeta() = %v, wanted %v", got, want)
	}

	want := metav1.ObjectMeta{
		Name:      "foo",
		Namespace: "bar",
	}
	ctx = WithinParent(ctx, want)

	if got := ParentMeta(ctx); !cmp.Equal(want, got) {
		t.Errorf("ParentMeta() = %v, wanted %v", got, want)
	}
}

func TestGetHTTPRequest(t *testing.T) {
	ctx := context.Background()

	if got := GetHTTPRequest(ctx); got != nil {
		t.Errorf("GetHTTPRequest() = %v, wanted %v", got, nil)
	}

	req, err := http.NewRequest(http.MethodGet, "https://google.com", nil)
	if err != nil {
		t.Fatalf("NewRequest() = %v", err)
	}
	ctx = WithHTTPRequest(ctx, req)

	if want, got := req, GetHTTPRequest(ctx); got != want {
		t.Errorf("GetHTTPRequest() = %v, wanted %v", got, want)
	}
}