k8sutil_test.go

// Copyright 2018 The Operator-SDK 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 k8sutil

import (
	"testing"

	"github.com/stretchr/testify/assert"
	"k8s.io/apimachinery/pkg/api/meta"
	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
	"k8s.io/apimachinery/pkg/runtime"
	"k8s.io/apimachinery/pkg/runtime/schema"
)

func TestGetDisplayName(t *testing.T) {
	cases := []struct {
		input, wanted string
	}{
		{"Appoperator", "Appoperator"},
		{"appoperator", "Appoperator"},
		{"appoperatoR", "Appoperato R"},
		{"AppOperator", "App Operator"},
		{"appOperator", "App Operator"},
		{"app-operator", "App Operator"},
		{"app-_operator", "App Operator"},
		{"App-operator", "App Operator"},
		{"app-_Operator", "App Operator"},
		{"app--Operator", "App Operator"},
		{"app--_Operator", "App Operator"},
		{"APP", "APP"},
		{"another-AppOperator_againTwiceThrice More", "Another App Operator Again Twice Thrice More"},
	}

	for _, c := range cases {
		dn := GetDisplayName(c.input)
		if dn != c.wanted {
			t.Errorf("Wanted %s, got %s", c.wanted, dn)
		}
	}
}

func TestSupportsOwnerReference(t *testing.T) {
	type testcase struct {
		name         string
		restMapper   meta.RESTMapper
		owner        runtime.Object
		dependent    runtime.Object
		result       bool
		depNamespace string
	}

	var defaultVersion []schema.GroupVersion
	restMapper := meta.NewDefaultRESTMapper(defaultVersion)

	GVK1 := schema.GroupVersionKind{
		Group:   "apps",
		Version: "v1alpha1",
		Kind:    "MyNamespaceKind",
	}
	GVK2 := schema.GroupVersionKind{
		Group:   "rbac",
		Version: "v1alpha1",
		Kind:    "MyClusterKind",
	}

	restMapper.Add(GVK1, meta.RESTScopeNamespace)
	restMapper.Add(GVK2, meta.RESTScopeRoot)

	cases := []testcase{
		{
			name:       "Returns false when owner is Namespaced and dependent resource is Clusterscoped.",
			restMapper: restMapper,
			owner: &unstructured.Unstructured{
				Object: map[string]interface{}{
					"kind":       "MyNamespaceKind",
					"apiVersion": "apps/v1alpha1",
					"metadata": map[string]interface{}{
						"name":      "example-nginx-controller",
						"namespace": "ns",
					},
				},
			},
			dependent: &unstructured.Unstructured{
				Object: map[string]interface{}{
					"kind":       "MyClusterKind",
					"apiVersion": "rbac/v1alpha1",
					"metadata": map[string]interface{}{
						"name":      "example-nginx-role",
						"namespace": "ns",
					},
				},
			},
			result: false,
		},
		{
			name:       "Returns true for owner and dependant are both ClusterScoped.",
			restMapper: restMapper,
			owner: &unstructured.Unstructured{
				Object: map[string]interface{}{
					"kind":       "MyClusterKind",
					"apiVersion": "rbac/v1alpha1",
					"metadata": map[string]interface{}{
						"name":      "example-nginx-controller",
						"namespace": "ns",
					},
				},
			},
			dependent: &unstructured.Unstructured{
				Object: map[string]interface{}{
					"kind":       "MyClusterKind",
					"apiVersion": "rbac/v1alpha1",
					"metadata": map[string]interface{}{
						"name":      "example-nginx-role",
						"namespace": "ns",
					},
				},
			},
			result: true,
		},
		{
			name:       "Returns true when owner and dependant are Namespaced with in same namespace.",
			restMapper: restMapper,
			owner: &unstructured.Unstructured{
				Object: map[string]interface{}{
					"kind":       "MyNamespaceKind",
					"apiVersion": "apps/v1alpha1",
					"metadata": map[string]interface{}{
						"name":      "example-nginx-controller",
						"namespace": "ns",
					},
				},
			},
			dependent: &unstructured.Unstructured{
				Object: map[string]interface{}{
					"kind":       "MyNamespaceKind",
					"apiVersion": "apps/v1alpha1",
					"metadata": map[string]interface{}{
						"name":      "example-nginx-role",
						"namespace": "ns",
					},
				},
			},
			result: true,
		},
		{
			name:       "Returns false when owner,and dependant are Namespaced, with different namespaces.",
			restMapper: restMapper,
			owner: &unstructured.Unstructured{
				Object: map[string]interface{}{
					"kind":       "MyNamespaceKind",
					"apiVersion": "apps/v1alpha1",
					"metadata": map[string]interface{}{
						"name":      "example-nginx-controller",
						"namespace": "ns1",
					},
				},
			},
			dependent: &unstructured.Unstructured{
				Object: map[string]interface{}{
					"kind":       "MyNamespaceKind",
					"apiVersion": "apps/v1alpha1",
					"metadata": map[string]interface{}{
						"name":      "example-nginx-role",
						"namespace": "ns",
					},
				},
			},
			result: false,
		},
		{
			name:       "Returns false for invalid Owner Kind.",
			restMapper: restMapper,
			owner: &unstructured.Unstructured{
				Object: map[string]interface{}{
					"kind":       "Dummy",
					"apiVersion": "apps/v1alpha1",
					"metadata": map[string]interface{}{
						"name":      "example-nginx-controller",
						"namespace": "ns1",
					},
				},
			},
			dependent: &unstructured.Unstructured{
				Object: map[string]interface{}{
					"kind":       "MyNamespaceKind",
					"apiVersion": "apps/v1alpha1",
					"metadata": map[string]interface{}{
						"name":      "example-nginx-role",
						"namespace": "ns",
					},
				},
			},
			result: false,
		},
		{
			name:       "Returns false for invalid dependant Kind.",
			restMapper: restMapper,
			owner: &unstructured.Unstructured{
				Object: map[string]interface{}{
					"kind":       "MyNamespaceKind",
					"apiVersion": "apps/v1alpha1",
					"metadata": map[string]interface{}{
						"name":      "example-nginx-controller",
						"namespace": "ns1",
					},
				},
			},
			dependent: &unstructured.Unstructured{
				Object: map[string]interface{}{
					"kind":       "Dummy",
					"apiVersion": "apps/v1alpha1",
					"metadata": map[string]interface{}{
						"name":      "example-nginx-role",
						"namespace": "ns",
					},
				},
			},
			result: false,
		},
		{
			name:         "Returns true if depNamespace provided and matches.",
			restMapper:   restMapper,
			depNamespace: "ns",
			owner: &unstructured.Unstructured{
				Object: map[string]interface{}{
					"kind":       "MyNamespaceKind",
					"apiVersion": "apps/v1alpha1",
					"metadata": map[string]interface{}{
						"name":      "example-nginx-controller",
						"namespace": "ns",
					},
				},
			},
			dependent: &unstructured.Unstructured{
				Object: map[string]interface{}{
					"kind":       "MyNamespaceKind",
					"apiVersion": "apps/v1alpha1",
					"metadata": map[string]interface{}{
						"name": "example-nginx-role",
					},
				},
			},
			result: true,
		},
		{
			name:         "Returns false if depNamespace provided and doesn't match.",
			restMapper:   restMapper,
			depNamespace: "ns1",
			owner: &unstructured.Unstructured{
				Object: map[string]interface{}{
					"kind":       "MyNamespaceKind",
					"apiVersion": "apps/v1alpha1",
					"metadata": map[string]interface{}{
						"name":      "example-nginx-controller",
						"namespace": "ns",
					},
				},
			},
			dependent: &unstructured.Unstructured{
				Object: map[string]interface{}{
					"kind":       "MyNamespaceKind",
					"apiVersion": "apps/v1alpha1",
					"metadata": map[string]interface{}{
						"name": "example-nginx-role",
					},
				},
			},
			result: false,
		},
	}

	for _, c := range cases {
		t.Run(c.name, func(t *testing.T) {
			useOwner, err := SupportsOwnerReference(c.restMapper, c.owner, c.dependent, c.depNamespace)
			if err != nil {
				assert.Error(t, err)
			}
			assert.Equal(t, c.result, useOwner)
		})
	}
}

func TestTrimDNS1123Label(t *testing.T) {
	type testcase struct {
		name     string
		label    string
		expected string
	}
	testcases := []testcase{
		{
			name:     "return valid truncated values",
			label:    "quay-io-raffaelespazzoli-proactive-node-scaling-operator-bundle-latest",
			expected: "raffaelespazzoli-proactive-node-scaling-operator-bundle-latest",
		},
		{
			name:     "valid labels with proper length are noops",
			label:    "raffaelespazzoli-proactive-node-scaling-operator-bundle-latest",
			expected: "raffaelespazzoli-proactive-node-scaling-operator-bundle-latest",
		},
		{
			name:     "short invalid labels are left alone",
			label:    "-$*@*#fixed-invalid(__$)@+==-name-#$($",
			expected: "-$*@*#fixed-invalid(__$)@+==-name-#$($",
		},
	}
	for _, tc := range testcases {
		t.Run(tc.name, func(t *testing.T) {
			result := TrimDNS1123Label(tc.label)
			assert.Equal(t, tc.expected, result)
		})
	}
}

func TestFormatOperatorNameDNS1123(t *testing.T) {
	type testcase struct {
		name     string
		label    string
		expected string
	}
	testcases := []testcase{
		{
			name:     "should not start with -",
			label:    "-doesnot-start-with-hyphen",
			expected: "doesnot-start-with-hyphen",
		},
		{
			name:     "should not start with non-alphanumeric",
			label:    "$@*#(@does-notstart-garbage",
			expected: "does-notstart-garbage",
		},
		{
			name:     "should not have non-alphanumeric",
			label:    "sample-1234$@*#(@does-notstart-garbage",
			expected: "sample-1234-does-notstart-garbage",
		},
		{
			name:     "should not end with non-alphanumeric",
			label:    "sample-1234-does-notstart-garbage#$*@#*($_!-_@(",
			expected: "sample-1234-does-notstart-garbage",
		},
		{
			name:     "should not start or end with hyphen",
			label:    "-does-not-start-or-end-with-hyphen---",
			expected: "does-not-start-or-end-with-hyphen",
		},
		{
			name:     "empty string is a noop",
			label:    "",
			expected: "",
		},
		{
			name:     "string of invalid characters results in empty string",
			label:    "@#@#)$*!!_$#*$*!@",
			expected: "",
		},
		{
			name:     "valid long names are not trimmed",
			label:    "quay-io-raffaelespazzoli-proactive-node-scaling-operator-bundle-latest",
			expected: "quay-io-raffaelespazzoli-proactive-node-scaling-operator-bundle-latest",
		},
		{
			name:     "should not contain capital letters",
			label:    "QUAY-IO-gobble-gobBLE",
			expected: "quay-io-gobble-gobble",
		},
	}
	for _, tc := range testcases {
		t.Run(tc.name, func(t *testing.T) {
			result := FormatOperatorNameDNS1123(tc.label)
			assert.Equal(t, tc.expected, result)
		})
	}
}