Merge pull request kubernetes#2180 from wojtek-t/prod_readiness_approvals

k8s-ci-robot · web-flow · commit 13ddec132b20 · 2020-12-21T18:34:25.000-08:00
Tracker for production-readiness approvals
diff --git a/cmd/kepval/main.go b/cmd/kepval/main.go
diff --git a/cmd/kepval/main_test.go b/cmd/kepval/main_test.go
@@ -17,15 +17,18 @@ limitations under the License.
 package main
 
 import (
-	"bytes"
 	"os"
 	"path/filepath"
 	"strings"
 	"testing"
+
+	"k8s.io/enhancements/pkg/kepval/keps"
+	"k8s.io/enhancements/pkg/kepval/prrs"
 )
 
 const (
 	kepsDir     = "keps"
+	prrsDir     = "keps/prod-readiness"
 	kepMetadata = "kep.yaml"
 )
 
@@ -70,14 +73,61 @@ func TestValidation(t *testing.T) {
 		t.Fatal("must find more than 0 keps")
 	}
 
-	// Overwrite the command line argument for the run() function
-	os.Args = []string{"", ""}
-	for _, file := range files {
-		t.Run(file, func(t *testing.T) {
-			os.Args[1] = file
-			var b bytes.Buffer
-			if exit := run(&b); exit != 0 {
-				t.Fatalf("exit code was %d and not 0. Output:\n%s", exit, b.String())
+	kepParser := &keps.Parser{}
+	prrParser := &prrs.Parser{}
+	prrsDir := filepath.Join("..", "..", prrsDir)
+
+	for _, filename := range files {
+		t.Run(filename, func(t *testing.T) {
+			kepFile, err := os.Open(filename)
+			if err != nil {
+				t.Fatalf("could not open file %s: %v\n", filename, err)
+			}
+			defer kepFile.Close()
+
+			kep := kepParser.Parse(kepFile)
+			if kep.Error != nil {
+				t.Errorf("%v has an error: %v", filename, kep.Error)
+			}
+
+			requiredPRRApproval := len(kep.Number) > 0 && kep.LatestMilestone >= "v1.21"
+			if !requiredPRRApproval {
+				return
+			}
+
+			prrFilename := filepath.Join(prrsDir, kep.OwningSIG, kep.Number)
+			prrFile, err := os.Open(prrFilename)
+			if os.IsNotExist(err) {
+				t.Errorf("missing PRR Approval file under: %s", prrFilename)
+				return
+			}
+			if err != nil {
+				t.Fatalf("could not open file %s: %v\n", prrFilename, err)
+			}
+			prr := prrParser.Parse(prrFile)
+			if prr.Error != nil {
+				t.Errorf("PRR approval file %v has an error: %v", prrFilename, prr.Error)
+				return
+			}
+
+			var stageMilestone string
+			var stagePRRApprover string
+			switch kep.Stage {
+			case "alpha":
+				stageMilestone = kep.Milestone.Alpha
+				stagePRRApprover = prr.Alpha.Approver
+			case "beta":
+				stageMilestone = kep.Milestone.Beta
+				stagePRRApprover = prr.Beta.Approver
+			case "stable":
+				stageMilestone = kep.Milestone.Stable
+				stagePRRApprover = prr.Stable.Approver
+			}
+			if len(stageMilestone) > 0 && stageMilestone >= "v1.21" {
+				// PRR approval is needed.
+				if len(stagePRRApprover) == 0 {
+					t.Errorf("PRR not approved for: %s", kep.Stage)
+				}
 			}
 		})
 	}
diff --git a/keps/prod-readiness/OWNERS b/keps/prod-readiness/OWNERS
@@ -0,0 +1,8 @@
+# Disable inheritance as this is production-readiness directory.
+options:
+  no_parent_owners: true
+
+approvers:
+  - prod-readiness-approvers
+
+# TODO: Tag PRs with PRR-related label.
diff --git a/keps/prod-readiness/sig-api-machinery/1040.yaml b/keps/prod-readiness/sig-api-machinery/1040.yaml
@@ -0,0 +1,3 @@
+kep-number: 1040
+beta:
+  approver: "@wojtek-t"
diff --git a/keps/sig-cloud-provider/1959-service-lb-class-field/kep.yaml b/keps/sig-cloud-provider/1959-service-lb-class-field/kep.yaml
@@ -24,7 +24,7 @@ stage: alpha
 # The most recent milestone for which work toward delivery of this KEP has been
 # done. This can be the current (upcoming) milestone, if it is being actively
 # worked on.
-latest-milestone: "v1.21"
+# latest-milestone: "v1.21"
 
 # The milestone at which this feature was, or is targeted to be, at each stage.
 milestone:
diff --git a/keps/sig-network/1860-kube-proxy-IP-node-binding/kep.yaml b/keps/sig-network/1860-kube-proxy-IP-node-binding/kep.yaml
@@ -16,12 +16,11 @@ approvers:
 
 stage: "alpha"
 
-latest-milestone: "v1.21"
+# latest-milestone: "v1.21"
 
 milestone:
   alpha: "v1.21"
   beta: "v1.22"
-  stable: "v1.22"
 
 feature-gates:
   - name: LoadBalancerIPMode
diff --git a/keps/sig-network/2004-topology-aware-subsetting/kep.yaml b/keps/sig-network/2004-topology-aware-subsetting/kep.yaml
@@ -26,7 +26,7 @@ stage: alpha
 # The most recent milestone for which work toward delivery of this KEP has been
 # done. This can be the current (upcoming) milestone, if it is being actively
 # worked on.
-latest-milestone: "v1.21"
+# latest-milestone: "v1.21"
 
 # The milestone at which this feature was, or is targeted to be, at each stage.
 milestone:
diff --git a/keps/sig-network/2030-endpointslice-subsetting/kep.yaml b/keps/sig-network/2030-endpointslice-subsetting/kep.yaml
@@ -24,7 +24,7 @@ stage: alpha
 # The most recent milestone for which work toward delivery of this KEP has been
 # done. This can be the current (upcoming) milestone, if it is being actively
 # worked on.
-latest-milestone: "v1.21"
+# latest-milestone: "v1.21"
 
 # The milestone at which this feature was, or is targeted to be, at each stage.
 milestone:
diff --git a/keps/sig-network/2079-network-policy-port-range/kep.yaml b/keps/sig-network/2079-network-policy-port-range/kep.yaml
@@ -18,7 +18,7 @@ stage: alpha
 # The most recent milestone for which work toward delivery of this KEP has been
 # done. This can be the current (upcoming) milestone, if it is being actively
 # worked on.
-latest-milestone: "v1.21"
+# latest-milestone: "v1.21"
 
 # The milestone at which this feature was, or is targeted to be, at each stage.
 milestone:
diff --git a/keps/sig-network/2086-service-internal-traffic-policy/kep.yaml b/keps/sig-network/2086-service-internal-traffic-policy/kep.yaml
@@ -23,7 +23,7 @@ stage: alpha
 # The most recent milestone for which work toward delivery of this KEP has been
 # done. This can be the current (upcoming) milestone, if it is being actively
 # worked on.
-latest-milestone: "v1.21"
+# latest-milestone: "v1.21"
 
 # The milestone at which this feature was, or is targeted to be, at each stage.
 milestone:
diff --git a/keps/sig-node/2043-pod-resource-concrete-assigments/kep.yaml b/keps/sig-node/2043-pod-resource-concrete-assigments/kep.yaml
@@ -27,7 +27,7 @@ stage: stable
 # The most recent milestone for which work toward delivery of this KEP has been
 # done. This can be the current (upcoming) milestone, if it is being actively
 # worked on.
-latest-milestone: "v1.21"
+# latest-milestone: "v1.21"
 
 # The milestone at which this feature was, or is targeted to be, at each stage.
 milestone:
diff --git a/keps/sig-scheduling/1923-prefer-nominated-node/kep.yaml b/keps/sig-scheduling/1923-prefer-nominated-node/kep.yaml
@@ -15,7 +15,7 @@ approvers:
   - "@Huang-Wei"
   - "@ahg-g"
 stage: alpha
-latest-milestone: "v1.21"
+# latest-milestone: "v1.21"
 milestone:
   alpha: "v1.21"
   beta: "v1.22"
diff --git a/pkg/kepval/prrs/approvals.go b/pkg/kepval/prrs/approvals.go
@@ -0,0 +1,77 @@
+/*
+Copyright 2020 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 prrs
+
+import (
+	"bufio"
+	"bytes"
+	"io"
+
+	"github.com/pkg/errors"
+	"gopkg.in/yaml.v2"
+	"k8s.io/enhancements/pkg/kepval/prrs/validations"
+)
+
+type Approvals []*Approval
+
+func (a *Approvals) AddApproval(approval *Approval) {
+	*a = append(*a, approval)
+}
+
+type Milestone struct {
+	Approver string `json:"approver" yaml:"approver"`
+}
+
+type Approval struct {
+	Number string    `json:"kep-number" yaml:"kep-number"`
+	Alpha  Milestone `json:"alpha" yaml:"alpha"`
+	Beta   Milestone `json:"beta" yaml:"beta"`
+	Stable Milestone `json:"stable" yaml:"stable"`
+
+	Error    error  `json:"-" yaml:"-"`
+}
+
+type Parser struct{}
+
+func (p *Parser) Parse(in io.Reader) *Approval {
+	scanner := bufio.NewScanner(in)
+	var body bytes.Buffer
+	for scanner.Scan() {
+		line := scanner.Text() + "\n"
+		body.WriteString(line)
+	}
+
+	approval := &Approval{}
+	if err := scanner.Err(); err != nil {
+		approval.Error = errors.Wrap(err, "error reading file")
+		return approval
+	}
+
+	// First do structural checks
+	test := map[interface{}]interface{}{}
+	if err := yaml.Unmarshal(body.Bytes(), test); err != nil {
+		approval.Error = errors.Wrap(err, "error unmarshaling YAML")
+		return approval
+	}
+	if err := validations.ValidateStructure(test); err != nil {
+		approval.Error = errors.Wrap(err, "error validating PRR approval metadata")
+		return approval
+	}
+
+	approval.Error = yaml.UnmarshalStrict(body.Bytes(), approval)
+	return approval
+}
diff --git a/pkg/kepval/prrs/approvals_test.go b/pkg/kepval/prrs/approvals_test.go
@@ -0,0 +1,53 @@
+/*
+Copyright 2020 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 prrs
+
+import (
+	"strings"
+	"testing"
+)
+
+func TestValidParsing(t *testing.T) {
+	testcases := []struct {
+		name         string
+		fileContents string
+	}{
+		{
+			"simple test",
+			`
+kep-number: 12345
+beta:
+  approver: "@wojtek-t"
+stable:
+  approver: "johnbelamaric"
+`,
+		},
+	}
+	for _, tc := range testcases {
+		t.Run(tc.name, func(t *testing.T) {
+			p := &Parser{}
+			contents := strings.NewReader(tc.fileContents)
+			out := p.Parse(contents)
+			if out.Error != nil {
+				t.Fatalf("expected no error but got one: %v", out.Error)
+			}
+			if out == nil {
+				t.Fatal("out should not be nil")
+			}
+		})
+	}
+}
diff --git a/pkg/kepval/prrs/validations/yaml.go b/pkg/kepval/prrs/validations/yaml.go
diff --git a/pkg/kepval/prrs/validations/yaml_test.go b/pkg/kepval/prrs/validations/yaml_test.go

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+kep-number: 1040`
	`2`	`+beta:`
	`3`	`+ approver: "@wojtek-t"`