Merge pull request kubernetes#1465 from dims/strict-validation-of-KEPs

Strict validation of keps

Author: k8s-ci-robot

.gitignore

@@ -17,4 +17,7 @@
 [._]s[a-w][a-z]
 *.un~
 Session.vim
-.netrwhist
+.netrwhist
+
+# Files generated by JetBrains IDEs, e.g. IntelliJ IDEA
+.idea/

cmd/kepval/main.go

@@ -46,6 +46,6 @@ func run() int {
 		return 1
 	}
 
-	fmt.Println("No validation errors")
+	fmt.Printf("No validation errors : %v\n", os.Args[1:])
 	return 0
 }

cmd/kepval/main_test.go

@@ -73,7 +73,10 @@ func ignore(name string) bool {
 	if !strings.HasSuffix(name, "md") {
 		return true
 	}
-	if name == "0023-documentation-for-images.md" {
+	if name == "0023-documentation-for-images.md" ||
+		name == "0004-cloud-provider-template.md" ||
+		name == "README.md" ||
+		name == "kep-faq.md" {
 		return true
 	}
 	return false

keps/sig-cli/kustomize-extend-patch.md

@@ -10,8 +10,7 @@ reviewers:
  - "@mengqiy"
 approvers:
  - "@monopole"
-editors:
- - "@Liujingfang1"
+editor: "@Liujingfang1"
 creation-date: 2019-03-14
 last-updated: 2019-03-18
 status: implementable

keps/sig-instrumentation/0034-distributed-tracing-kep.md

@@ -2,8 +2,7 @@
 title: Leveraging Distributed Tracing to Understand Kubernetes Object Lifecycles
 authors:
   - "@Monkeyanator"
-editors:
-  - "@dashpole"
+editor: "@dashpole"
 owning-sig: sig-instrumentation
 participating-sigs:
   - sig-architecture

keps/sig-network/20190920-external-dns.md

@@ -1,3 +1,10 @@
+---
+title: Move ExternalDNS out of Kubernetes incubator
+authors:
+  - "@njuettner"
+owning-sig: sig-network
+---
+
 # Move ExternalDNS out of Kubernetes incubator
 
 ## Table of Contents

pkg/kepval/keps/proposals.go

@@ -93,6 +93,6 @@ func (p *Parser) Parse(in io.Reader) *Proposal {
 		return proposal
 	}
 
-	proposal.Error = yaml.Unmarshal(metadata, proposal)
+	proposal.Error = yaml.UnmarshalStrict(metadata, proposal)
 	return proposal
 }

pkg/kepval/keps/validations/yaml.go

@@ -21,6 +21,14 @@ import (
 	"strings"
 )
 
+type KeyMustBeSpecified struct {
+	key interface{}
+}
+
+func (k *KeyMustBeSpecified) Error() string {
+	return fmt.Sprintf("missing key %[1]v", k.key)
+}
+
 type KeyMustBeString struct {
 	key interface{}
 }
@@ -62,7 +70,16 @@ type MustHaveAtLeastOneValue struct {
 func (m *MustHaveAtLeastOneValue) Error() string {
 	return fmt.Sprintf("%q must have at least one value", m.key)
 }
+
+var mandatoryKeys = []string{"title", "owning-sig"}
+
 func ValidateStructure(parsed map[interface{}]interface{}) error {
+	for _, key := range mandatoryKeys {
+		if _, found := parsed[key]; !found {
+			return &KeyMustBeSpecified{key}
+		}
+	}
+
 	for key, value := range parsed {
 		// First off the key has to be a string. fact.
 		k, ok := key.(string)