example_test.go

Documentation: k8s.io/kube-openapi/pkg/spec3

     1  /*
     2  Copyright 2021 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package spec3_test
    18  
    19  import (
    20  	"encoding/json"
    21  	"testing"
    22  
    23  	"github.com/google/go-cmp/cmp"
    24  	"github.com/stretchr/testify/require"
    25  	"k8s.io/kube-openapi/pkg/spec3"
    26  	jsontesting "k8s.io/kube-openapi/pkg/util/jsontesting"
    27  	"k8s.io/kube-openapi/pkg/validation/spec"
    28  )
    29  
    30  func TestExampleRoundtrip(t *testing.T) {
    31  	cases := []jsontesting.RoundTripTestCase{
    32  		{
    33  			Name: "Basic Roundtrip",
    34  			Object: &spec3.Example{
    35  				spec.Refable{Ref: spec.MustCreateRef("Dog")},
    36  				spec3.ExampleProps{
    37  					Description: "foo",
    38  				},
    39  				spec.VendorExtensible{Extensions: spec.Extensions{
    40  					"x-framework": "go-swagger",
    41  				}},
    42  			},
    43  		},
    44  	}
    45  
    46  	for _, tcase := range cases {
    47  		t.Run(tcase.Name, func(t *testing.T) {
    48  			require.NoError(t, tcase.RoundTripTest(&spec3.Example{}))
    49  		})
    50  	}
    51  }
    52  
    53  func TestExampleJSONSerialization(t *testing.T) {
    54  	cases := []struct {
    55  		name           string
    56  		target         *spec3.Example
    57  		expectedOutput string
    58  	}{
    59  		{
    60  			name: "basic",
    61  			target: &spec3.Example{
    62  				ExampleProps: spec3.ExampleProps{
    63  					Summary: "An example",
    64  					Value:   map[string]string{"foo": "bar"},
    65  				},
    66  			},
    67  			expectedOutput: `{"summary":"An example","value":{"foo":"bar"}}`,
    68  		},
    69  	}
    70  	for _, tc := range cases {
    71  		t.Run(tc.name, func(t *testing.T) {
    72  			rawTarget, err := json.Marshal(tc.target)
    73  			if err != nil {
    74  				t.Fatal(err)
    75  			}
    76  			serializedTarget := string(rawTarget)
    77  			if !cmp.Equal(serializedTarget, tc.expectedOutput) {
    78  				t.Fatalf("diff %s", cmp.Diff(serializedTarget, tc.expectedOutput))
    79  			}
    80  		})
    81  	}
    82  }
    83
View as plain text