Merge pull request kubernetes#2870 from spiffxp/unmarshal-strict

k8s-ci-robot · web-flow · commit d03755373ba6 · 2021-08-17T10:59:13.000-07:00
keps: centralize yaml calls, use UnmarshalStrict
diff --git a/api/approval.go b/api/approval.go
@@ -23,7 +23,8 @@ import (
 
 	"github.com/go-playground/validator/v10"
 	"github.com/pkg/errors"
-	"gopkg.in/yaml.v3"
+
+	"k8s.io/enhancements/pkg/yaml"
 )
 
 type PRRApprovals []*PRRApproval
@@ -108,7 +109,7 @@ func (p *PRRHandler) Parse(in io.Reader) (*PRRApproval, error) {
 		return approval, errors.Wrap(err, "reading file")
 	}
 
-	if err := yaml.Unmarshal(body.Bytes(), &approval); err != nil {
+	if err := yaml.UnmarshalStrict(body.Bytes(), &approval); err != nil {
 		p.Errors = append(p.Errors, errors.Wrap(err, "error unmarshalling YAML"))
 		return approval, errors.Wrap(err, "unmarshalling YAML")
 	}
diff --git a/api/groups.go b/api/groups.go
@@ -26,7 +26,7 @@ import (
 
 	"github.com/pkg/errors"
 
-	"sigs.k8s.io/yaml"
+	"k8s.io/enhancements/pkg/yaml"
 )
 
 // GroupFetcher is responsible for getting informationg about groups in the
@@ -147,9 +147,10 @@ func (f *RemoteGroupFetcher) FetchPRRApprovers() ([]string, error) {
 	}
 
 	config := &struct {
-		Data map[string][]string `json:"aliases,omitempty"`
+		Data map[string][]string `json:"aliases,omitempty" yaml:"aliases,omitempty"`
 	}{}
-	if err := yaml.Unmarshal(body, config); err != nil {
+
+	if err := yaml.UnmarshalStrict(body, config); err != nil {
 		return nil, errors.Wrap(err, "unmarshalling owners aliases")
 	}
 
diff --git a/api/proposal.go b/api/proposal.go
@@ -26,7 +26,8 @@ import (
 
 	"github.com/go-playground/validator/v10"
 	"github.com/pkg/errors"
-	"gopkg.in/yaml.v3"
+
+	"k8s.io/enhancements/pkg/yaml"
 )
 
 var ValidStages = []string{
@@ -119,7 +120,7 @@ func (k *KEPHandler) Parse(in io.Reader) (*Proposal, error) {
 		kep.Contents = ""
 	}
 
-	if err := yaml.Unmarshal(metadata, &kep); err != nil {
+	if err := yaml.UnmarshalStrict(metadata, &kep); err != nil {
 		k.Errors = append(k.Errors, errors.Wrap(err, "error unmarshalling YAML"))
 		return kep, errors.Wrap(err, "unmarshalling YAML")
 	}
@@ -194,9 +195,11 @@ func (k *KEPHandler) Validate(p *Proposal) []error {
 }
 
 type Milestone struct {
-	Alpha  string `json:"alpha" yaml:"alpha"`
-	Beta   string `json:"beta" yaml:"beta"`
-	Stable string `json:"stable" yaml:"stable"`
+	Alpha      string `json:"alpha" yaml:"alpha"`
+	Beta       string `json:"beta" yaml:"beta"`
+	Stable     string `json:"stable" yaml:"stable"`
+	Deprecated string `json:"deprecated" yaml:"deprecated,omitempty"`
+	Removed    string `json:"removed" yaml:"removed,omitempty"`
 }
 
 type FeatureGate struct {
diff --git a/go.mod b/go.mod
@@ -18,5 +18,4 @@ require (
 	gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c
 	k8s.io/release v0.7.1-0.20210218090651-d71805402dab
 	k8s.io/test-infra v0.0.0-20200813194141-e9678d500461
-	sigs.k8s.io/yaml v1.2.0
 )
diff --git a/keps/sig-network/2595-expanded-dns-config/kep.yaml b/keps/sig-network/2595-expanded-dns-config/kep.yaml
@@ -31,7 +31,7 @@ latest-milestone: "v1.22"
 milestone:
   alpha: "v1.22"
   beta: "x.y"
-  GA: "x.y"
+  stable: "x.y"
 
 # The following PRR answers are required at alpha release
 # List the feature gate name and the components for which it must be enabled
diff --git a/keps/sig-node/2727-grpc-probe/kep.yaml b/keps/sig-node/2727-grpc-probe/kep.yaml
@@ -9,7 +9,7 @@ participating-sigs:
   - sig-network
 status: implementable
 creation-date: 2020-04-04
-modified-date: 2021-05-12
+last-updated: 2021-05-12
 reviewers:
   - "@thockin"
   - "@mrunalp"
diff --git a/pkg/output/output.go b/pkg/output/output.go
@@ -24,9 +24,9 @@ import (
 	"strings"
 
 	"github.com/olekukonko/tablewriter"
-	"gopkg.in/yaml.v3"
 
 	"k8s.io/enhancements/api"
+	"k8s.io/enhancements/pkg/yaml"
 )
 
 const (
diff --git a/pkg/repo/repo.go b/pkg/repo/repo.go
@@ -30,12 +30,13 @@ import (
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
 	"golang.org/x/oauth2"
-	"gopkg.in/yaml.v3"
 
-	"k8s.io/enhancements/api"
-	"k8s.io/enhancements/pkg/kepval"
 	krgh "k8s.io/release/pkg/github"
 	"k8s.io/test-infra/prow/git"
+
+	"k8s.io/enhancements/api"
+	"k8s.io/enhancements/pkg/kepval"
+	"k8s.io/enhancements/pkg/yaml"
 )
 
 const (
@@ -439,7 +440,7 @@ func (r *Repo) loadKEPFromYaml(kepPath string) (*api.Proposal, error) {
 	}
 
 	var p api.Proposal
-	err = yaml.Unmarshal(b, &p)
+	err = yaml.UnmarshalStrict(b, &p)
 	if err != nil {
 		return nil, fmt.Errorf("unable to load KEP metadata: %s", err)
 	}
diff --git a/pkg/repo/repo_test.go b/pkg/repo/repo_test.go
@@ -24,11 +24,11 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/require"
-	"gopkg.in/yaml.v3"
+	"k8s.io/release/pkg/log"
 
 	"k8s.io/enhancements/api"
 	"k8s.io/enhancements/pkg/repo"
-	"k8s.io/release/pkg/log"
+	"k8s.io/enhancements/pkg/yaml"
 )
 
 var fixture = struct {
@@ -91,7 +91,7 @@ func TestProposalValidate(t *testing.T) {
 			require.NoError(t, err)
 
 			var p api.Proposal
-			err = yaml.Unmarshal(b, &p)
+			err = yaml.UnmarshalStrict(b, &p)
 			require.NoError(t, err)
 
 			errs := parser.Validate(&p)
diff --git a/pkg/repo/write.go b/pkg/repo/write.go
@@ -24,8 +24,9 @@ import (
 	"path/filepath"
 
 	"github.com/sirupsen/logrus"
-	"gopkg.in/yaml.v3"
 	"k8s.io/enhancements/api"
+
+	"k8s.io/enhancements/pkg/yaml"
 )
 
 func (r *Repo) WriteKEP(kep *api.Proposal) error {
diff --git a/pkg/repo/write_test.go b/pkg/repo/write_test.go
@@ -27,7 +27,8 @@ import (
 
 	"k8s.io/enhancements/api"
 	"k8s.io/enhancements/pkg/repo"
-	"sigs.k8s.io/yaml"
+
+	"k8s.io/enhancements/pkg/yaml"
 )
 
 // TODO: Consider using afero to mock the filesystem here
@@ -126,7 +127,7 @@ func TestWriteKep(t *testing.T) {
 			require.NoError(t, err)
 
 			var p api.Proposal
-			err = yaml.Unmarshal(b, &p)
+			err = yaml.UnmarshalStrict(b, &p)
 			require.NoError(t, err)
 
 			p.OwningSIG = tc.sig
diff --git a/pkg/yaml/yaml.go b/pkg/yaml/yaml.go
@@ -0,0 +1,39 @@
+/*
+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 yaml
+
+import (
+	"bytes"
+
+	"gopkg.in/yaml.v3"
+)
+
+// UnmarshalStrict unmarshals the contents of body into the given interface,
+// and returns an error if any duplicate or unknown fields are encountered
+func UnmarshalStrict(body []byte, v interface{}) error {
+	r := bytes.NewReader(body)
+	d := yaml.NewDecoder(r)
+	d.KnownFields(true)
+	err := d.Decode(v)
+	return err
+}
+
+// Marshal returns a byte array containing a YAML representation of the
+// given interface, and a non-nil error if there was an error
+func Marshal(v interface{}) ([]byte, error) {
+	return yaml.Marshal(v)
+}

Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,8 @@ import (`
`23`	`23`
`24`	`24`	`"github.com/go-playground/validator/v10"`
`25`	`25`	`"github.com/pkg/errors"`
`26`		`- "gopkg.in/yaml.v3"`
	`26`	`+`
	`27`	`+ "k8s.io/enhancements/pkg/yaml"`
`27`	`28`	`)`
`28`	`29`
`29`	`30`	`type PRRApprovals []*PRRApproval`
`@@ -108,7 +109,7 @@ func (p PRRHandler) Parse(in io.Reader) (PRRApproval, error) {`
`108`	`109`	`return approval, errors.Wrap(err, "reading file")`
`109`	`110`	`}`
`110`	`111`
`111`		`- if err := yaml.Unmarshal(body.Bytes(), &approval); err != nil {`
	`112`	`+ if err := yaml.UnmarshalStrict(body.Bytes(), &approval); err != nil {`
`112`	`113`	`p.Errors = append(p.Errors, errors.Wrap(err, "error unmarshalling YAML"))`
`113`	`114`	`return approval, errors.Wrap(err, "unmarshalling YAML")`
`114`	`115`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ import (`
`26`	`26`
`27`	`27`	`"github.com/pkg/errors"`
`28`	`28`
`29`		`- "sigs.k8s.io/yaml"`
	`29`	`+ "k8s.io/enhancements/pkg/yaml"`
`30`	`30`	`)`
`31`	`31`
`32`	`32`	`// GroupFetcher is responsible for getting informationg about groups in the`
`@@ -147,9 +147,10 @@ func (f *RemoteGroupFetcher) FetchPRRApprovers() ([]string, error) {`
`147`	`147`	`}`
`148`	`148`
`149`	`149`	`config := &struct {`
`150`		- Data map[string][]string `json:"aliases,omitempty"`
	`150`	+ Data map[string][]string `json:"aliases,omitempty" yaml:"aliases,omitempty"`
`151`	`151`	`}{}`
`152`		`- if err := yaml.Unmarshal(body, config); err != nil {`
	`152`	`+`
	`153`	`+ if err := yaml.UnmarshalStrict(body, config); err != nil {`
`153`	`154`	`return nil, errors.Wrap(err, "unmarshalling owners aliases")`
`154`	`155`	`}`
`155`	`156`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,8 @@ import (`
`26`	`26`
`27`	`27`	`"github.com/go-playground/validator/v10"`
`28`	`28`	`"github.com/pkg/errors"`
`29`		`- "gopkg.in/yaml.v3"`
	`29`	`+`
	`30`	`+ "k8s.io/enhancements/pkg/yaml"`
`30`	`31`	`)`
`31`	`32`
`32`	`33`	`var ValidStages = []string{`
`@@ -119,7 +120,7 @@ func (k KEPHandler) Parse(in io.Reader) (Proposal, error) {`
`119`	`120`	`kep.Contents = ""`
`120`	`121`	`}`
`121`	`122`
`122`		`- if err := yaml.Unmarshal(metadata, &kep); err != nil {`
	`123`	`+ if err := yaml.UnmarshalStrict(metadata, &kep); err != nil {`
`123`	`124`	`k.Errors = append(k.Errors, errors.Wrap(err, "error unmarshalling YAML"))`
`124`	`125`	`return kep, errors.Wrap(err, "unmarshalling YAML")`
`125`	`126`	`}`
`@@ -194,9 +195,11 @@ func (k KEPHandler) Validate(p Proposal) []error {`
`194`	`195`	`}`
`195`	`196`
`196`	`197`	`type Milestone struct {`
`197`		- Alpha string `json:"alpha" yaml:"alpha"`
`198`		- Beta string `json:"beta" yaml:"beta"`
`199`		- Stable string `json:"stable" yaml:"stable"`
	`198`	+ Alpha string `json:"alpha" yaml:"alpha"`
	`199`	+ Beta string `json:"beta" yaml:"beta"`
	`200`	+ Stable string `json:"stable" yaml:"stable"`
	`201`	+ Deprecated string `json:"deprecated" yaml:"deprecated,omitempty"`
	`202`	+ Removed string `json:"removed" yaml:"removed,omitempty"`
`200`	`203`	`}`
`201`	`204`
`202`	`205`	`type FeatureGate struct {`
Original file line number	Diff line number	Diff line change
`@@ -18,5 +18,4 @@ require (`
`18`	`18`	`gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c`
`19`	`19`	`k8s.io/release v0.7.1-0.20210218090651-d71805402dab`
`20`	`20`	`k8s.io/test-infra v0.0.0-20200813194141-e9678d500461`
`21`		`- sigs.k8s.io/yaml v1.2.0`
`22`	`21`	`)`
Original file line number	Diff line number	Diff line change
`@@ -24,9 +24,9 @@ import (`
`24`	`24`	`"strings"`
`25`	`25`
`26`	`26`	`"github.com/olekukonko/tablewriter"`
`27`		`- "gopkg.in/yaml.v3"`
`28`	`27`
`29`	`28`	`"k8s.io/enhancements/api"`
	`29`	`+ "k8s.io/enhancements/pkg/yaml"`
`30`	`30`	`)`
`31`	`31`
`32`	`32`	`const (`
Original file line number	Diff line number	Diff line change
`@@ -24,8 +24,9 @@ import (`
`24`	`24`	`"path/filepath"`
`25`	`25`
`26`	`26`	`"github.com/sirupsen/logrus"`
`27`		`- "gopkg.in/yaml.v3"`
`28`	`27`	`"k8s.io/enhancements/api"`
	`28`	`+`
	`29`	`+ "k8s.io/enhancements/pkg/yaml"`
`29`	`30`	`)`
`30`	`31`
`31`	`32`	`func (r Repo) WriteKEP(kep api.Proposal) error {`