Merge pull request #90 from fredbi/fix-gob-security

Fixed gob encoding/decoding for SwaggerProps

Author: casualjim

.golangci.yml

@@ -8,7 +8,7 @@ linters-settings:
   maligned:
     suggest-new: true
   dupl:
-    threshold: 100
+    threshold: 200
   goconst:
     min-len: 2
     min-occurrences: 2

go.mod

@@ -1,16 +1,9 @@
 module github.com/go-openapi/spec
 
 require (
-	github.com/PuerkitoBio/purell v1.1.0 // indirect
-	github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578 // indirect
-	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/go-openapi/jsonpointer v0.17.0
 	github.com/go-openapi/jsonreference v0.17.0
 	github.com/go-openapi/swag v0.17.0
-	github.com/mailru/easyjson v0.0.0-20180823135443-60711f1a8329 // indirect
-	github.com/pmezard/go-difflib v1.0.0 // indirect
 	github.com/stretchr/testify v1.2.2
-	golang.org/x/net v0.0.0-20181005035420-146acd28ed58 // indirect
-	golang.org/x/text v0.3.0 // indirect
 	gopkg.in/yaml.v2 v2.2.1
 )

go.sum

@@ -4,19 +4,22 @@ github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578 h1:d+Bc7a5rLufV
 github.com/PuerkitoBio/urlesc v0.0.0-20170810143723-de5bf2ad4578/go.mod h1:uGdkoq3SwY9Y+13GIhn11/XLaGBb4BfwItxLd5jeuXE=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
-github.com/go-openapi/jsonpointer v0.17.0 h1:Bpl2DtZ6k7wKqfFs7e+4P08+M9I3FQgn09a1UsRUQbk=
-github.com/go-openapi/jsonpointer v0.17.0/go.mod h1:+35s3my2LFTysnkMfxsJBAMHj/DoqoB9knIWoYG/Vk0=
-github.com/go-openapi/jsonreference v0.17.0 h1:d/o7/fsLWWQZACbihvZxcyLQ59jfUVs7WOJv/ak7T7A=
-github.com/go-openapi/jsonreference v0.17.0/go.mod h1:W3Z9FmVs9qj+KR4zFKmDPGiLdk1D9Rlm7cyMvf57TTg=
-github.com/go-openapi/swag v0.17.0 h1:7wu+dZ5k83kvUWeAb+WUkFiUhDzwGqzTR/NhWzeo1JU=
-github.com/go-openapi/swag v0.17.0/go.mod h1:DXUve3Dpr1UfpPtxFw+EFuQ41HhCWZfha5jSVRG7C7I=
+github.com/go-openapi/jsonpointer v0.17.0 h1:nH6xp8XdXHx8dqveo0ZuJBluCO2qGrPbDNZ0dwoRHP0=
+github.com/go-openapi/jsonpointer v0.17.0/go.mod h1:cOnomiV+CVVwFLk0A/MExoFMjwdsUdVpsRhURCKh+3M=
+github.com/go-openapi/jsonreference v0.17.0 h1:yJW3HCkTHg7NOA+gZ83IPHzUSnUzGXhGmsdiCcMexbA=
+github.com/go-openapi/jsonreference v0.17.0/go.mod h1:g4xxGn04lDIRh0GJb5QlpE3HfopLOL6uZrK/VgnsK9I=
+github.com/go-openapi/swag v0.17.0 h1:iqrgMg7Q7SvtbWLlltPrkMs0UBJI6oTSs79JFRUi880=
+github.com/go-openapi/swag v0.17.0/go.mod h1:AByQ+nYG6gQg71GINrmuDXCPWdL640yX49/kXLo40Tg=
 github.com/mailru/easyjson v0.0.0-20180823135443-60711f1a8329 h1:2gxZ0XQIU/5z3Z3bUBu+FXuk2pFbkN6tcwi/pjyaDic=
 github.com/mailru/easyjson v0.0.0-20180823135443-60711f1a8329/go.mod h1:C1wdFJiN94OJF2b5HbByQZoLdCWB1Yqtg26g4irojpc=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 golang.org/x/net v0.0.0-20181005035420-146acd28ed58 h1:otZG8yDCO4LVps5+9bxOeNiCvgmOyt96J3roHTYs7oE=
 golang.org/x/net v0.0.0-20181005035420-146acd28ed58/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
+golang.org/x/text v0.3.0 h1:g61tztE5qeGQ89tm6NTjjM9VPIm088od1l6aSorWRWg=
 golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v2 v2.2.1 h1:mUhvW9EsL+naU5Q3cakzfE91YhliOondGd6ZrsDBHQE=
 gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

operation_test.go

@@ -286,63 +286,62 @@ func TestOperationGobEncoding(t *testing.T) {
 
 	// 2. nil security requirements
 	doTestOperationGobEncoding(t, `{
-	"description": "operation description",
-	"x-framework": "go-swagger",
-	"consumes": [ "application/json", "application/x-yaml" ],
-	"produces": [ "application/json", "application/x-yaml" ],
-	"schemes": ["http", "https"],
-	"tags": ["dogs"],
-	"summary": "the summary of the operation",
-	"operationId": "sendCat",
-	"deprecated": true,
-	"parameters": [{"$ref":"Cat"}],
-	"responses": {
-		"default": {
-			"description": "void response"
-		}
-	}
-}`)
+			"description": "operation description",
+			"x-framework": "go-swagger",
+			"consumes": [ "application/json", "application/x-yaml" ],
+			"produces": [ "application/json", "application/x-yaml" ],
+			"schemes": ["http", "https"],
+			"tags": ["dogs"],
+			"summary": "the summary of the operation",
+			"operationId": "sendCat",
+			"deprecated": true,
+			"parameters": [{"$ref":"Cat"}],
+			"responses": {
+				"default": {
+					"description": "void response"
+				}
+			}
+		}`)
 
 	// 3. empty security requirement
 	doTestOperationGobEncoding(t, `{
-	"description": "operation description",
-	"x-framework": "go-swagger",
-	"consumes": [ "application/json", "application/x-yaml" ],
-	"produces": [ "application/json", "application/x-yaml" ],
-	"schemes": ["http", "https"],
-	"tags": ["dogs"],
-	"security": [],
-	"summary": "the summary of the operation",
-	"operationId": "sendCat",
-	"deprecated": true,
-	"parameters": [{"$ref":"Cat"}],
-	"responses": {
-		"default": {
-			"description": "void response"
-		}
-	}
-}`)
+			"description": "operation description",
+			"x-framework": "go-swagger",
+			"consumes": [ "application/json", "application/x-yaml" ],
+			"produces": [ "application/json", "application/x-yaml" ],
+			"schemes": ["http", "https"],
+			"tags": ["dogs"],
+			"security": [],
+			"summary": "the summary of the operation",
+			"operationId": "sendCat",
+			"deprecated": true,
+			"parameters": [{"$ref":"Cat"}],
+			"responses": {
+				"default": {
+					"description": "void response"
+				}
+			}
+		}`)
 
 	// 4. non-empty security requirements
 	doTestOperationGobEncoding(t, `{
-	"description": "operation description",
-	"x-framework": "go-swagger",
-	"consumes": [ "application/json", "application/x-yaml" ],
-	"produces": [ "application/json", "application/x-yaml" ],
-	"schemes": ["http", "https"],
-	"tags": ["dogs"],
-	"summary": "the summary of the operation",
-	"security": [ { "scoped-auth": [ "phone", "email" ] , "api-key": []} ],
-	"operationId": "sendCat",
-	"deprecated": true,
-	"parameters": [{"$ref":"Cat"}],
-	"responses": {
-		"default": {
-			"description": "void response"
-		}
-	}
-}`)
-
+			"description": "operation description",
+			"x-framework": "go-swagger",
+			"consumes": [ "application/json", "application/x-yaml" ],
+			"produces": [ "application/json", "application/x-yaml" ],
+			"schemes": ["http", "https"],
+			"tags": ["dogs"],
+			"summary": "the summary of the operation",
+			"security": [ { "scoped-auth": [ "phone", "email" ] , "api-key": []} ],
+			"operationId": "sendCat",
+			"deprecated": true,
+			"parameters": [{"$ref":"Cat"}],
+			"responses": {
+				"default": {
+					"description": "void response"
+				}
+			}
+		}`)
 }
 
 func doTestOperationGobEncoding(t *testing.T, fixture string) {

swagger.go

@@ -15,6 +15,8 @@
 package spec
 
 import (
+	"bytes"
+	"encoding/gob"
 	"encoding/json"
 	"fmt"
 	"strconv"
@@ -68,6 +70,36 @@ func (s *Swagger) UnmarshalJSON(data []byte) error {
 	return nil
 }
 
+// GobEncode provides a safe gob encoder for Swagger, including extensions
+func (s Swagger) GobEncode() ([]byte, error) {
+	var b bytes.Buffer
+	raw := struct {
+		Props SwaggerProps
+		Ext   VendorExtensible
+	}{
+		Props: s.SwaggerProps,
+		Ext:   s.VendorExtensible,
+	}
+	err := gob.NewEncoder(&b).Encode(raw)
+	return b.Bytes(), err
+}
+
+// GobDecode provides a safe gob decoder for Swagger, including extensions
+func (s *Swagger) GobDecode(b []byte) error {
+	var raw struct {
+		Props SwaggerProps
+		Ext   VendorExtensible
+	}
+	buf := bytes.NewBuffer(b)
+	err := gob.NewDecoder(buf).Decode(&raw)
+	if err != nil {
+		return err
+	}
+	s.SwaggerProps = raw.Props
+	s.VendorExtensible = raw.Ext
+	return nil
+}
+
 // SwaggerProps captures the top-level properties of an Api specification
 //
 // NOTE: validation rules
@@ -93,6 +125,98 @@ type SwaggerProps struct {
 	ExternalDocs        *ExternalDocumentation `json:"externalDocs,omitempty"`
 }
 
+type swaggerPropsAlias SwaggerProps
+
+type gobSwaggerPropsAlias struct {
+	Security []map[string]struct {
+		List []string
+		Pad  bool
+	}
+	Alias           *swaggerPropsAlias
+	SecurityIsEmpty bool
+}
+
+// GobEncode provides a safe gob encoder for SwaggerProps, including empty security requirements
+func (o SwaggerProps) GobEncode() ([]byte, error) {
+	raw := gobSwaggerPropsAlias{
+		Alias: (*swaggerPropsAlias)(&o),
+	}
+
+	var b bytes.Buffer
+	if o.Security == nil {
+		// nil security requirement
+		err := gob.NewEncoder(&b).Encode(raw)
+		return b.Bytes(), err
+	}
+
+	if len(o.Security) == 0 {
+		// empty, but non-nil security requirement
+		raw.SecurityIsEmpty = true
+		raw.Alias.Security = nil
+		err := gob.NewEncoder(&b).Encode(raw)
+		return b.Bytes(), err
+	}
+
+	raw.Security = make([]map[string]struct {
+		List []string
+		Pad  bool
+	}, 0, len(o.Security))
+	for _, req := range o.Security {
+		v := make(map[string]struct {
+			List []string
+			Pad  bool
+		}, len(req))
+		for k, val := range req {
+			v[k] = struct {
+				List []string
+				Pad  bool
+			}{
+				List: val,
+			}
+		}
+		raw.Security = append(raw.Security, v)
+	}
+
+	err := gob.NewEncoder(&b).Encode(raw)
+	return b.Bytes(), err
+}
+
+// GobDecode provides a safe gob decoder for SwaggerProps, including empty security requirements
+func (o *SwaggerProps) GobDecode(b []byte) error {
+	var raw gobSwaggerPropsAlias
+
+	buf := bytes.NewBuffer(b)
+	err := gob.NewDecoder(buf).Decode(&raw)
+	if err != nil {
+		return err
+	}
+	if raw.Alias == nil {
+		return nil
+	}
+
+	switch {
+	case raw.SecurityIsEmpty:
+		// empty, but non-nil security requirement
+		raw.Alias.Security = []map[string][]string{}
+	case len(raw.Alias.Security) == 0:
+		// nil security requirement
+		raw.Alias.Security = nil
+	default:
+		raw.Alias.Security = make([]map[string][]string, 0, len(raw.Security))
+		for _, req := range raw.Security {
+			v := make(map[string][]string, len(req))
+			for k, val := range req {
+				v[k] = make([]string, 0, len(val.List))
+				v[k] = append(v[k], val.List...)
+			}
+			raw.Alias.Security = append(raw.Alias.Security, v)
+		}
+	}
+
+	*o = *(*SwaggerProps)(raw.Alias)
+	return nil
+}
+
 // Dependencies represent a dependencies property
 type Dependencies map[string]SchemaOrStringArray
 

swagger_test.go

@@ -329,8 +329,7 @@ func TestOptionalSwaggerProps_Serialize(t *testing.T) {
 	}
 }
 
-func TestSecurityRequirements(t *testing.T) {
-	minimalJSONSpec := []byte(`{
+var minimalJSONSpec = []byte(`{
 		"swagger": "2.0",
 		"info": {
 			"version": "0.0.0",
@@ -375,6 +374,7 @@ func TestSecurityRequirements(t *testing.T) {
 		}
 	}`)
 
+func TestSecurityRequirements(t *testing.T) {
 	var minimalSpec Swagger
 	err := json.Unmarshal(minimalJSONSpec, &minimalSpec)
 	if assert.NoError(t, err) {
@@ -387,3 +387,19 @@ func TestSecurityRequirements(t *testing.T) {
 		assert.Contains(t, sec[2], "queryKey")
 	}
 }
+
+func TestSwaggerGobEncoding(t *testing.T) {
+	doTestSwaggerGobEncoding(t, specJSON)
+
+	doTestSwaggerGobEncoding(t, string(minimalJSONSpec))
+}
+
+func doTestSwaggerGobEncoding(t *testing.T, fixture string) {
+	var src, dst Swagger
+
+	if !assert.NoError(t, json.Unmarshal([]byte(fixture), &src)) {
+		t.FailNow()
+	}
+
+	doTestAnyGobEncoding(t, &src, &dst)
+}