move experimental flag to internal package

alexzielenski · alexzielenski · commit 94f2c15562ed · 2022-09-27T10:52:54.000-07:00
needed to expose in a separate package so can be accessed from v3 tests
diff --git a/pkg/internal/flags.go b/pkg/internal/flags.go
@@ -0,0 +1,20 @@
+/*
+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 internal
+
+// Used by tests to selectively disable experimental JSON unmarshaler
+var UseExperimentalJSONUnmarshaling bool = true
diff --git a/pkg/validation/spec/header.go b/pkg/validation/spec/header.go
@@ -19,6 +19,7 @@ import (
 
 	jsonv2 "github.com/go-json-experiment/json"
 	"github.com/go-openapi/swag"
+	"k8s.io/kube-openapi/pkg/internal"
 )
 
 const (
@@ -63,7 +64,7 @@ func (h Header) MarshalJSON() ([]byte, error) {
 
 // UnmarshalJSON unmarshals this header from JSON
 func (h *Header) UnmarshalJSON(data []byte) error {
-	if UseExperimentalJSONUnmarshaling {
+	if internal.UseExperimentalJSONUnmarshaling {
 		return jsonv2.Unmarshal(data, h)
 	}
 
diff --git a/pkg/validation/spec/info.go b/pkg/validation/spec/info.go
@@ -20,6 +20,7 @@ import (
 
 	jsonv2 "github.com/go-json-experiment/json"
 	"github.com/go-openapi/swag"
+	"k8s.io/kube-openapi/pkg/internal"
 )
 
 // Extensions vendor specific extensions
@@ -193,7 +194,7 @@ func (i Info) MarshalJSON() ([]byte, error) {
 
 // UnmarshalJSON marshal this from JSON
 func (i *Info) UnmarshalJSON(data []byte) error {
-	if UseExperimentalJSONUnmarshaling {
+	if internal.UseExperimentalJSONUnmarshaling {
 		return jsonv2.Unmarshal(data, i)
 	}
 
diff --git a/pkg/validation/spec/items.go b/pkg/validation/spec/items.go
@@ -19,6 +19,7 @@ import (
 
 	jsonv2 "github.com/go-json-experiment/json"
 	"github.com/go-openapi/swag"
+	"k8s.io/kube-openapi/pkg/internal"
 )
 
 const (
@@ -65,7 +66,7 @@ type Items struct {
 
 // UnmarshalJSON hydrates this items instance with the data from JSON
 func (i *Items) UnmarshalJSON(data []byte) error {
-	if UseExperimentalJSONUnmarshaling {
+	if internal.UseExperimentalJSONUnmarshaling {
 		return jsonv2.Unmarshal(data, i)
 	}
 
diff --git a/pkg/validation/spec/operation.go b/pkg/validation/spec/operation.go
@@ -19,6 +19,7 @@ import (
 
 	jsonv2 "github.com/go-json-experiment/json"
 	"github.com/go-openapi/swag"
+	"k8s.io/kube-openapi/pkg/internal"
 )
 
 // OperationProps describes an operation
@@ -76,7 +77,7 @@ type Operation struct {
 
 // UnmarshalJSON hydrates this items instance with the data from JSON
 func (o *Operation) UnmarshalJSON(data []byte) error {
-	if UseExperimentalJSONUnmarshaling {
+	if internal.UseExperimentalJSONUnmarshaling {
 		return jsonv2.Unmarshal(data, o)
 	}
 
diff --git a/pkg/validation/spec/parameter.go b/pkg/validation/spec/parameter.go
@@ -19,6 +19,7 @@ import (
 
 	jsonv2 "github.com/go-json-experiment/json"
 	"github.com/go-openapi/swag"
+	"k8s.io/kube-openapi/pkg/internal"
 )
 
 // ParamProps describes the specific attributes of an operation parameter
@@ -76,7 +77,7 @@ type Parameter struct {
 
 // UnmarshalJSON hydrates this items instance with the data from JSON
 func (p *Parameter) UnmarshalJSON(data []byte) error {
-	if UseExperimentalJSONUnmarshaling {
+	if internal.UseExperimentalJSONUnmarshaling {
 		return jsonv2.Unmarshal(data, p)
 	}
 
diff --git a/pkg/validation/spec/path_item.go b/pkg/validation/spec/path_item.go
@@ -19,6 +19,7 @@ import (
 
 	jsonv2 "github.com/go-json-experiment/json"
 	"github.com/go-openapi/swag"
+	"k8s.io/kube-openapi/pkg/internal"
 )
 
 // PathItemProps the path item specific properties
@@ -47,7 +48,7 @@ type PathItem struct {
 
 // UnmarshalJSON hydrates this items instance with the data from JSON
 func (p *PathItem) UnmarshalJSON(data []byte) error {
-	if UseExperimentalJSONUnmarshaling {
+	if internal.UseExperimentalJSONUnmarshaling {
 		return jsonv2.Unmarshal(data, p)
 	}
 
diff --git a/pkg/validation/spec/paths.go b/pkg/validation/spec/paths.go
@@ -21,6 +21,7 @@ import (
 
 	jsonv2 "github.com/go-json-experiment/json"
 	"github.com/go-openapi/swag"
+	"k8s.io/kube-openapi/pkg/internal"
 )
 
 // Paths holds the relative paths to the individual endpoints.
@@ -36,7 +37,7 @@ type Paths struct {
 
 // UnmarshalJSON hydrates this items instance with the data from JSON
 func (p *Paths) UnmarshalJSON(data []byte) error {
-	if UseExperimentalJSONUnmarshaling {
+	if internal.UseExperimentalJSONUnmarshaling {
 		return jsonv2.Unmarshal(data, p)
 	}
 
diff --git a/pkg/validation/spec/response.go b/pkg/validation/spec/response.go
@@ -19,6 +19,7 @@ import (
 
 	jsonv2 "github.com/go-json-experiment/json"
 	"github.com/go-openapi/swag"
+	"k8s.io/kube-openapi/pkg/internal"
 )
 
 // ResponseProps properties specific to a response
@@ -40,7 +41,7 @@ type Response struct {
 
 // UnmarshalJSON hydrates this items instance with the data from JSON
 func (r *Response) UnmarshalJSON(data []byte) error {
-	if UseExperimentalJSONUnmarshaling {
+	if internal.UseExperimentalJSONUnmarshaling {
 		return jsonv2.Unmarshal(data, r)
 	}
 
diff --git a/pkg/validation/spec/responses.go b/pkg/validation/spec/responses.go
@@ -22,6 +22,7 @@ import (
 
 	jsonv2 "github.com/go-json-experiment/json"
 	"github.com/go-openapi/swag"
+	"k8s.io/kube-openapi/pkg/internal"
 )
 
 // Responses is a container for the expected responses of an operation.
@@ -92,7 +93,7 @@ func (r ResponsesProps) MarshalJSON() ([]byte, error) {
 
 // UnmarshalJSON unmarshals responses from JSON
 func (r *ResponsesProps) UnmarshalJSON(data []byte) error {
-	if UseExperimentalJSONUnmarshaling {
+	if internal.UseExperimentalJSONUnmarshaling {
 		return jsonv2.Unmarshal(data, r)
 	}
 
diff --git a/pkg/validation/spec/schema.go b/pkg/validation/spec/schema.go
@@ -22,6 +22,7 @@ import (
 
 	jsonv2 "github.com/go-json-experiment/json"
 	"github.com/go-openapi/swag"
+	"k8s.io/kube-openapi/pkg/internal"
 )
 
 // BooleanProperty creates a boolean property
@@ -466,7 +467,7 @@ func (s Schema) MarshalJSON() ([]byte, error) {
 
 // UnmarshalJSON marshal this from JSON
 func (s *Schema) UnmarshalJSON(data []byte) error {
-	if UseExperimentalJSONUnmarshaling {
+	if internal.UseExperimentalJSONUnmarshaling {
 		return jsonv2.Unmarshal(data, s)
 	}
 
diff --git a/pkg/validation/spec/swagger.go b/pkg/validation/spec/swagger.go
@@ -20,11 +20,9 @@ import (
 
 	jsonv2 "github.com/go-json-experiment/json"
 	"github.com/go-openapi/swag"
+	"k8s.io/kube-openapi/pkg/internal"
 )
 
-// Used by tests to selectively disable experimental JSON unmarshaler
-var UseExperimentalJSONUnmarshaling bool = true
-
 // Swagger this is the root document object for the API specification.
 // It combines what previously was the Resource Listing and API Declaration (version 1.2 and earlier)
 // together into one document.
@@ -50,7 +48,7 @@ func (s Swagger) MarshalJSON() ([]byte, error) {
 
 // UnmarshalJSON unmarshals a swagger spec from json
 func (s *Swagger) UnmarshalJSON(data []byte) error {
-	if UseExperimentalJSONUnmarshaling {
+	if internal.UseExperimentalJSONUnmarshaling {
 		return jsonv2.Unmarshal(data, s)
 	}
 
@@ -135,7 +133,7 @@ func (s SchemaOrBool) MarshalJSON() ([]byte, error) {
 
 // UnmarshalJSON converts this bool or schema object from a JSON structure
 func (s *SchemaOrBool) UnmarshalJSON(data []byte) error {
-	if UseExperimentalJSONUnmarshaling {
+	if internal.UseExperimentalJSONUnmarshaling {
 		return jsonv2.Unmarshal(data, s)
 	}
 
@@ -185,7 +183,7 @@ func (s SchemaOrStringArray) MarshalJSON() ([]byte, error) {
 
 // UnmarshalJSON converts this schema object or array from a JSON structure
 func (s *SchemaOrStringArray) UnmarshalJSON(data []byte) error {
-	if UseExperimentalJSONUnmarshaling {
+	if internal.UseExperimentalJSONUnmarshaling {
 		return jsonv2.Unmarshal(data, s)
 	}
 
@@ -252,7 +250,7 @@ func (s StringOrArray) Contains(value string) bool {
 
 // UnmarshalJSON unmarshals this string or array object from a JSON array or JSON string
 func (s *StringOrArray) UnmarshalJSON(data []byte) error {
-	if UseExperimentalJSONUnmarshaling {
+	if internal.UseExperimentalJSONUnmarshaling {
 		return jsonv2.Unmarshal(data, s)
 	}
 
@@ -343,7 +341,7 @@ func (s SchemaOrArray) MarshalJSON() ([]byte, error) {
 
 // UnmarshalJSON converts this schema object or array from a JSON structure
 func (s *SchemaOrArray) UnmarshalJSON(data []byte) error {
-	if UseExperimentalJSONUnmarshaling {
+	if internal.UseExperimentalJSONUnmarshaling {
 		return jsonv2.Unmarshal(data, s)
 	}
 
diff --git a/pkg/validation/spec/swagger_test.go b/pkg/validation/spec/swagger_test.go
@@ -26,6 +26,7 @@ import (
 	fuzz "github.com/google/gofuzz"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+	"k8s.io/kube-openapi/pkg/internal"
 )
 
 var SpecV2DiffOptions = []cmp.Option{
@@ -162,12 +163,12 @@ func TestSwaggerSpec_ExperimentalUnmarshal(t *testing.T) {
 	t.Log("Specimen", string(jsonBytes))
 
 	actual := Swagger{}
-	UseExperimentalJSONUnmarshaling = true
+	internal.UseExperimentalJSONUnmarshaling = true
 	err = json.Unmarshal(jsonBytes, &actual)
 	require.NoError(t, err)
 
 	control := Swagger{}
-	UseExperimentalJSONUnmarshaling = false
+	internal.UseExperimentalJSONUnmarshaling = false
 	err = json.Unmarshal(jsonBytes, &control)
 	require.NoError(t, err)
 
@@ -199,7 +200,7 @@ func BenchmarkSwaggerSpec_ExperimentalUnmarshal(b *testing.B) {
 
 	// Parse into kube-openapi types
 	b.Run("jsonv1", func(b2 *testing.B) {
-		UseExperimentalJSONUnmarshaling = false
+		internal.UseExperimentalJSONUnmarshaling = false
 		for i := 0; i < b2.N; i++ {
 			var result *Swagger
 			if err := json.Unmarshal(originalJSON, &result); err != nil {
@@ -209,7 +210,7 @@ func BenchmarkSwaggerSpec_ExperimentalUnmarshal(b *testing.B) {
 	})
 
 	b.Run("jsonv2 via jsonv1", func(b2 *testing.B) {
-		UseExperimentalJSONUnmarshaling = true
+		internal.UseExperimentalJSONUnmarshaling = true
 		for i := 0; i < b2.N; i++ {
 			var result *Swagger
 			if err := json.Unmarshal(originalJSON, &result); err != nil {
@@ -218,8 +219,10 @@ func BenchmarkSwaggerSpec_ExperimentalUnmarshal(b *testing.B) {
 		}
 	})
 
+	// Our UnmarshalJSON implementation which defers to jsonv2 causes the
+	// text to be parsed/validated twice. This costs a significant amount of time.
 	b.Run("jsonv2", func(b2 *testing.B) {
-		UseExperimentalJSONUnmarshaling = true
+		internal.UseExperimentalJSONUnmarshaling = true
 		for i := 0; i < b2.N; i++ {
 			var result *Swagger
 			if err := jsonv2.Unmarshal(originalJSON, &result); err != nil {
diff --git a/pkg/validation/spec/tag.go b/pkg/validation/spec/tag.go
@@ -19,6 +19,7 @@ import (
 
 	jsonv2 "github.com/go-json-experiment/json"
 	"github.com/go-openapi/swag"
+	"k8s.io/kube-openapi/pkg/internal"
 )
 
 // TagProps describe a tag entry in the top level tags section of a swagger spec
@@ -53,7 +54,7 @@ func (t Tag) MarshalJSON() ([]byte, error) {
 
 // UnmarshalJSON marshal this from JSON
 func (t *Tag) UnmarshalJSON(data []byte) error {
-	if UseExperimentalJSONUnmarshaling {
+	if internal.UseExperimentalJSONUnmarshaling {
 		return jsonv2.Unmarshal(data, t)
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ import (`
`19`	`19`
`20`	`20`	`jsonv2 "github.com/go-json-experiment/json"`
`21`	`21`	`"github.com/go-openapi/swag"`
	`22`	`+ "k8s.io/kube-openapi/pkg/internal"`
`22`	`23`	`)`
`23`	`24`
`24`	`25`	`const (`
`@@ -63,7 +64,7 @@ func (h Header) MarshalJSON() ([]byte, error) {`
`63`	`64`
`64`	`65`	`// UnmarshalJSON unmarshals this header from JSON`
`65`	`66`	`func (h *Header) UnmarshalJSON(data []byte) error {`
`66`		`- if UseExperimentalJSONUnmarshaling {`
	`67`	`+ if internal.UseExperimentalJSONUnmarshaling {`
`67`	`68`	`return jsonv2.Unmarshal(data, h)`
`68`	`69`	`}`
`69`	`70`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ import (`
`20`	`20`
`21`	`21`	`jsonv2 "github.com/go-json-experiment/json"`
`22`	`22`	`"github.com/go-openapi/swag"`
	`23`	`+ "k8s.io/kube-openapi/pkg/internal"`
`23`	`24`	`)`
`24`	`25`
`25`	`26`	`// Extensions vendor specific extensions`
`@@ -193,7 +194,7 @@ func (i Info) MarshalJSON() ([]byte, error) {`
`193`	`194`
`194`	`195`	`// UnmarshalJSON marshal this from JSON`
`195`	`196`	`func (i *Info) UnmarshalJSON(data []byte) error {`
`196`		`- if UseExperimentalJSONUnmarshaling {`
	`197`	`+ if internal.UseExperimentalJSONUnmarshaling {`
`197`	`198`	`return jsonv2.Unmarshal(data, i)`
`198`	`199`	`}`
`199`	`200`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ import (`
`21`	`21`
`22`	`22`	`jsonv2 "github.com/go-json-experiment/json"`
`23`	`23`	`"github.com/go-openapi/swag"`
	`24`	`+ "k8s.io/kube-openapi/pkg/internal"`
`24`	`25`	`)`
`25`	`26`
`26`	`27`	`// Paths holds the relative paths to the individual endpoints.`
`@@ -36,7 +37,7 @@ type Paths struct {`
`36`	`37`
`37`	`38`	`// UnmarshalJSON hydrates this items instance with the data from JSON`
`38`	`39`	`func (p *Paths) UnmarshalJSON(data []byte) error {`
`39`		`- if UseExperimentalJSONUnmarshaling {`
	`40`	`+ if internal.UseExperimentalJSONUnmarshaling {`
`40`	`41`	`return jsonv2.Unmarshal(data, p)`
`41`	`42`	`}`
`42`	`43`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ import (`
`22`	`22`
`23`	`23`	`jsonv2 "github.com/go-json-experiment/json"`
`24`	`24`	`"github.com/go-openapi/swag"`
	`25`	`+ "k8s.io/kube-openapi/pkg/internal"`
`25`	`26`	`)`
`26`	`27`
`27`	`28`	`// Responses is a container for the expected responses of an operation.`
`@@ -92,7 +93,7 @@ func (r ResponsesProps) MarshalJSON() ([]byte, error) {`
`92`	`93`
`93`	`94`	`// UnmarshalJSON unmarshals responses from JSON`
`94`	`95`	`func (r *ResponsesProps) UnmarshalJSON(data []byte) error {`
`95`		`- if UseExperimentalJSONUnmarshaling {`
	`96`	`+ if internal.UseExperimentalJSONUnmarshaling {`
`96`	`97`	`return jsonv2.Unmarshal(data, r)`
`97`	`98`	`}`
`98`	`99`