Merge pull request #1706 from enj/enj/i/external_creds_ln

Add support for symlinks and KEP metadata files

cmd/kepval/main.go

@@ -32,7 +32,7 @@ func run() int {
 	for _, filename := range os.Args[1:] {
 		file, err := os.Open(filename)
 		if err != nil {
-			fmt.Printf("could not open file: %v", err)
+			fmt.Printf("could not open file %s: %v\n", filename, err)
 			return 1
 		}
 		defer file.Close()
@@ -46,6 +46,6 @@ func run() int {
 		return 1
 	}
 
-	fmt.Printf("No validation errors : %v\n", os.Args[1:])
+	fmt.Printf("No validation errors: %v\n", os.Args[1:])
 	return 0
 }

cmd/kepval/main_test.go

@@ -24,7 +24,8 @@ import (
 )
 
 const (
-	kepsDir = "keps"
+	kepsDir     = "keps"
+	kepMetadata = "kep.yaml"
 )
 
 // This is the actual validation check of all keps in this repo
@@ -40,7 +41,19 @@ func TestValidation(t *testing.T) {
 			if info.IsDir() {
 				return nil
 			}
-			if ignore(info.Name()) {
+
+			dir := filepath.Dir(path)
+			// true if the file is a symlink
+			if info.Mode()&os.ModeSymlink != 0 {
+				// assume symlink from old KEP location to new
+				newLocation, err := os.Readlink(path)
+				if err != nil {
+					return err
+				}
+				files = append(files, filepath.Join(dir, filepath.Dir(newLocation), kepMetadata))
+				return nil
+			}
+			if ignore(dir, info.Name()) {
 				return nil
 			}
 			files = append(files, path)
@@ -69,16 +82,26 @@ func TestValidation(t *testing.T) {
 }
 
 // ignore certain files in the keps/ subdirectory
-func ignore(name string) bool {
+func ignore(dir, name string) bool {
+	if dir == "../../keps/NNNN-kep-template" {
+		return true // ignore the template directory because its metadata file does not use a valid sig name
+	}
+
+	if name == kepMetadata {
+		return false // always check metadata files
+	}
+
 	if !strings.HasSuffix(name, "md") {
 		return true
 	}
+
 	if name == "0023-documentation-for-images.md" ||
 		name == "0004-cloud-provider-template.md" ||
 		name == "YYYYMMDD-kep-template.md" ||
 		name == "README.md" ||
 		name == "kep-faq.md" {
 		return true
 	}
+
 	return false
 }

keps/sig-architecture/617-improve-kep-implementation/kep.yaml

@@ -21,5 +21,5 @@ approvers:
   - "@bgrant0607"
   - "@jbeda"
 see-also:
-  - [/keps/0001-kubernetes-enhancement-proposal-process.md]
+  - /keps/0001-kubernetes-enhancement-proposal-process.md
 replaces: []

keps/sig-auth/20190711-external-credential-providers.md

@@ -0,0 +1 @@
+541-external-credential-providers/README.md

pkg/kepval/keps/proposals.go

@@ -38,6 +38,7 @@ func (p *Proposals) AddProposal(proposal *Proposal) {
 type Proposal struct {
 	ID                string   `json:"id"`
 	Title             string   `json:"title" yaml:"title"`
+	Number            string   `json:"kep-number" yaml:"kep-number"`
 	Authors           []string `json:"authors" yaml:",flow"`
 	OwningSIG         string   `json:"owningSig" yaml:"owning-sig"`
 	ParticipatingSIGs []string `json:"participatingSigs" yaml:"participating-sigs,flow,omitempty"`
@@ -83,6 +84,12 @@ func (p *Parser) Parse(in io.Reader) *Proposal {
 		return proposal
 	}
 
+	// this file is just the KEP metadata
+	if count == 0 {
+		metadata = body.Bytes()
+		proposal.Contents = ""
+	}
+
 	// First do structural checks
 	test := map[interface{}]interface{}{}
 	if err := yaml.Unmarshal(metadata, test); err != nil {

pkg/kepval/keps/validations/yaml.go

@@ -91,21 +91,25 @@ var listGroups []string
 func init() {
 	resp, err := http.Get("https://raw.githubusercontent.com/kubernetes/community/master/sigs.yaml")
 	if err != nil {
-		fmt.Fprintf(os.Stderr, "unable to fetch list of sigs: %v", err)
+		fmt.Fprintf(os.Stderr, "unable to fetch list of sigs: %v\n", err)
 		os.Exit(1)
 	}
 	defer resp.Body.Close()
+	if resp.StatusCode != http.StatusOK {
+		fmt.Fprintf(os.Stderr, "invalid status code when fetching list of sigs: %d\n", resp.StatusCode)
+		os.Exit(1)
+	}
 	re := regexp.MustCompile(`- dir: (.*)$`)
 
 	scanner := bufio.NewScanner(resp.Body)
 	for scanner.Scan() {
 		match := re.FindStringSubmatch(scanner.Text())
-		if len(match)>0 {
+		if len(match) > 0 {
 			listGroups = append(listGroups, match[1])
 		}
 	}
 	if err := scanner.Err(); err != nil {
-		fmt.Fprintf(os.Stderr, "unable to scan list of sigs: %v", err)
+		fmt.Fprintf(os.Stderr, "unable to scan list of sigs: %v\n", err)
 		os.Exit(1)
 	}
 	sort.Strings(listGroups)