/* Copyright 2021 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 spec3_test import ( "encoding/json" "testing" "github.com/google/go-cmp/cmp" "github.com/stretchr/testify/require" "k8s.io/kube-openapi/pkg/spec3" jsontesting "k8s.io/kube-openapi/pkg/util/jsontesting" "k8s.io/kube-openapi/pkg/validation/spec" ) func TestParameterRoundTrip(t *testing.T) { cases := []jsontesting.RoundTripTestCase{ { Name: "Basic Roundtrip", Object: &spec3.Parameter{ spec.Refable{Ref: spec.MustCreateRef("Dog")}, spec3.ParameterProps{ Description: "foo", }, spec.VendorExtensible{Extensions: spec.Extensions{ "x-framework": "go-swagger", }}, }, }, } for _, tcase := range cases { t.Run(tcase.Name, func(t *testing.T) { require.NoError(t, tcase.RoundTripTest(&spec3.Parameter{})) }) } } func TestParameterJSONSerialization(t *testing.T) { cases := []struct { name string target *spec3.Parameter expectedOutput string }{ { name: "header parameter", target: &spec3.Parameter{ ParameterProps: spec3.ParameterProps{ Name: "token", In: "header", Description: "token to be passed as a header", Required: true, Schema: &spec.Schema{ SchemaProps: spec.SchemaProps{ Type: []string{"integer"}, Format: "int64", }, }, Style: "simple", }, }, expectedOutput: `{"name":"token","in":"header","description":"token to be passed as a header","required":true,"style":"simple","schema":{"type":"integer","format":"int64"}}`, }, { name: "path parameter", target: &spec3.Parameter{ ParameterProps: spec3.ParameterProps{ Name: "username", In: "path", Description: "username to fetch", Required: true, Schema: &spec.Schema{ SchemaProps: spec.SchemaProps{ Type: []string{"string"}, }, }, }, }, expectedOutput: `{"name":"username","in":"path","description":"username to fetch","required":true,"schema":{"type":"string"}}`, }, } for _, tc := range cases { t.Run(tc.name, func(t *testing.T) { rawTarget, err := json.Marshal(tc.target) if err != nil { t.Fatal(err) } serializedTarget := string(rawTarget) if !cmp.Equal(serializedTarget, tc.expectedOutput) { t.Fatalf("diff %s", cmp.Diff(serializedTarget, tc.expectedOutput)) } }) } }