k8s.io/kube-openapi@v0.0.0-20240826222958-65a50c78dec5/pkg/schemaconv/smd_test.go

/*
Copyright 2017 The Kubernetes 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 schemaconv

import (
	"os"
	"path/filepath"
	"testing"

	"github.com/google/go-cmp/cmp"
	yaml "gopkg.in/yaml.v2"

	"k8s.io/kube-openapi/pkg/util/proto"
	prototesting "k8s.io/kube-openapi/pkg/util/proto/testing"
)

func TestToSchema(t *testing.T) {
	tests := []struct {
		name                   string
		openAPIFilename        string
		expectedSchemaFilename string
	}{
		{
			name:                   "kubernetes",
			openAPIFilename:        "swagger.json",
			expectedSchemaFilename: "new-schema.yaml",
		},
		{
			name:                   "atomics",
			openAPIFilename:        "atomic-types.json",
			expectedSchemaFilename: "atomic-types.yaml",
		},
		{
			name:                   "defaults",
			openAPIFilename:        "defaults.json",
			expectedSchemaFilename: "defaults.yaml",
		},
		{
			name:                   "preserve-unknown",
			openAPIFilename:        "preserve-unknown.json",
			expectedSchemaFilename: "preserve-unknown.yaml",
		},
	}
	for _, tc := range tests {
		t.Run(tc.name, func(t *testing.T) {
			openAPIPath := filepath.Join("testdata", tc.openAPIFilename)
			expectedNewSchemaPath := filepath.Join("testdata", tc.expectedSchemaFilename)
			testToSchema(t, openAPIPath, expectedNewSchemaPath)
		})
	}
}

func testToSchema(t *testing.T, openAPIPath, expectedNewSchemaPath string) {
	fakeSchema := prototesting.Fake{Path: openAPIPath}
	s, err := fakeSchema.OpenAPISchema()
	if err != nil {
		t.Fatalf("failed to get schema for %s: %v", openAPIPath, err)
	}
	models, err := proto.NewOpenAPIData(s)
	if err != nil {
		t.Fatal(err)
	}

	ns, err := ToSchema(models)
	if err != nil {
		t.Fatal(err)
	}
	got, err := yaml.Marshal(ns)
	if err != nil {
		t.Fatal(err)
	}

	expect, err := os.ReadFile(expectedNewSchemaPath)
	if err != nil {
		t.Fatalf("Unable to read golden data file %q: %v", expectedNewSchemaPath, err)
	}

	if string(expect) != string(got) {
		t.Errorf("Computed schema did not match %q.", expectedNewSchemaPath)
		t.Logf("To recompute this file, run:\n\tgo run ./cmd/openapi2smd/openapi2smd.go < %q > %q",
			filepath.Join("pkg", "schemaconv", openAPIPath),
			filepath.Join("pkg", "schemaconv", expectedNewSchemaPath),
		)
		t.Log("You can then use `git diff` to see the changes.")
		t.Error(cmp.Diff(string(expect), string(got)))
	}
}

func TestFieldLevelAnnotation(t *testing.T) {
	openAPIPath := filepath.Join("testdata", "field-level-annotation.json")
	fakeSchema := prototesting.Fake{Path: openAPIPath}
	s, err := fakeSchema.OpenAPISchema()
	if err != nil {
		t.Fatalf("failed to get schema for %s: %v", openAPIPath, err)
	}
	models, err := proto.NewOpenAPIData(s)
	if err != nil {
		t.Fatal(err)
	}

	ns, err := ToSchema(models)
	if err != nil {
		t.Fatal(err)
	}

	_ = ns

	// Test to make sure that MapElementRelationship is populated correctly
	// after being converted from proto type
	endpointAddress, ok := ns.FindNamedType("io.k8s.api.core.v1.EndpointAddress")
	if !ok {
		t.Fatalf("expected to find EndpointAddress")
	}

	targetRef, ok := endpointAddress.FindField("targetRef")
	if !ok {
		t.Fatalf("expected to find EndpointAddress field 'targetRef'")
	}

	if targetRef.Type.ElementRelationship == nil {
		t.Fatalf("expected targetRef MapElementRelationship to be atomic")
	}

	// Test to make sure that schema.Resolve overrides the ElementRelationship
	// when asked to resolve a reference
	resolved, ok := ns.Resolve(targetRef.Type)
	if !ok {
		t.Fatalf("failed to resolve targetRef type")
	}

	if resolved.Map == nil {
		t.Fatalf("expected to resolve to a Map")
	}

	if resolved.Map.ElementRelationship != *targetRef.Type.ElementRelationship {
		t.Fatalf("resolved element relationship not converted")
	}

	// Make sure our test is actually testing something by ensuring the original
	// relationship is different from what we are changing it to.
	targetRefWithoutRelationship := targetRef
	targetRefWithoutRelationship.Type.ElementRelationship = nil

	originalResolved, ok := ns.Resolve(targetRefWithoutRelationship.Type)
	if !ok {
		t.Fatalf("failed to resolve targetRef type")
	}

	if originalResolved.Map.ElementRelationship == *targetRef.Type.ElementRelationship {
		t.Fatalf("expected original element relationship to differ from field-level override for test")
	}
}