Merge pull request kubernetes#1467 from dims/kepify-to-generate-json-for-netlify

kepify: New command to generate KEP json for Netlify

Author: k8s-ci-robot

cmd/kepify/main.go

@@ -0,0 +1,189 @@
+/*
+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 main
+
+import (
+	"crypto/md5"
+	"encoding/json"
+	"flag"
+	"fmt"
+	"os"
+	"path/filepath"
+	"strings"
+
+	"k8s.io/enhancements/pkg/kepval/keps"
+)
+
+func Usage() {
+	fmt.Fprintf(os.Stderr, `
+Usage: %s [-dir <kep-directory>] [-output <path-to-json-file>]
+Command line flags override config values.
+`, os.Args[0])
+	flag.PrintDefaults()
+}
+
+func main() {
+	dirPath := flag.String("dir", "keps", "root directory for the KEPs")
+	filePath := flag.String("output", "keps.json", "output json file")
+
+	flag.Usage = Usage
+	flag.Parse()
+
+	if len(*dirPath) == 0 {
+		fmt.Fprintf(os.Stderr, "please specify the root directory for KEPs using '--dir'\n")
+		os.Exit(1)
+	}
+	if _, err := os.Stat(*dirPath); os.IsNotExist(err) {
+		fmt.Printf("directory does not exist : %s", *dirPath)
+		os.Exit(1)
+	}
+
+	if len(*filePath) == 0 {
+		fmt.Fprintf(os.Stderr, "please specify the file path for the output json using '--output'\n")
+		os.Exit(1)
+	}
+
+	// Find all the keps
+	files, err := findMarkdownFiles(dirPath)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "unable to find markdown files: %v\n", err)
+		os.Exit(1)
+	}
+	if len(files) == 0 {
+		fmt.Fprintf(os.Stderr, "did not find any KEPs\n")
+		os.Exit(1)
+	}
+
+	// Parse the files
+	proposals, err := parseFiles(files)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "error parsing files: %q\n", err)
+		os.Exit(1)
+	}
+
+	// Generate the json output
+	err = printJSONOutput(*filePath, proposals)
+	if err != nil {
+		fmt.Fprintf(os.Stderr, "could not open file: %v\n", err)
+		os.Exit(1)
+	}
+}
+
+func findMarkdownFiles(dirPath *string) ([]string, error) {
+	files := []string{}
+	err := filepath.Walk(
+		*dirPath,
+		func(path string, info os.FileInfo, err error) error {
+			if err != nil {
+				return err
+			}
+			if info.IsDir() {
+				return nil
+			}
+			if ignore(info.Name()) {
+				return nil
+			}
+			files = append(files, path)
+			return nil
+		},
+	)
+	return files, err
+}
+
+func parseFiles(files []string) (keps.Proposals, error) {
+	var proposals keps.Proposals
+	for _, filename := range files {
+		parser := &keps.Parser{}
+		file, err := os.Open(filename)
+		if err != nil {
+			return nil, fmt.Errorf("could not open file: %v\n", err)
+		}
+		defer file.Close()
+		kep := parser.Parse(file)
+		// if error is nil we can move on
+		if kep.Error != nil {
+			return nil, fmt.Errorf("%v has an error: %q\n", filename, kep.Error.Error())
+		}
+		fmt.Printf(">>>> parsed file successfully: %s\n", filename)
+		proposals.AddProposal(kep)
+	}
+	return proposals, nil
+}
+
+func printJSONOutput(filePath string, proposals keps.Proposals) error {
+	fmt.Printf("Output file: %s\n", filePath)
+	file, err := os.Create(filePath)
+	if err != nil {
+		return err
+	}
+	defer file.Close()
+
+	total := len(proposals)
+	fmt.Printf("Total KEPs: %d\n", total)
+
+	fmt.Fprintln(file, "{")
+	for i, kep := range proposals {
+		fmt.Fprintf(file, "\t\"%s\": {\n", hash(kep.OwningSIG+":"+kep.Title))
+		fmt.Fprintf(file, "\t\t\"%s\": \"%s\",\n", "title", kep.Title)
+		fmt.Fprintf(file, "\t\t\"%s\": \"%s\",\n", "owning-sig", kep.OwningSIG)
+		fmt.Fprintf(file, "\t\t\"%s\": %s,\n", "participating-sigs", marshal(kep.ParticipatingSIGs))
+		fmt.Fprintf(file, "\t\t\"%s\": %s,\n", "reviewers", marshal(kep.Reviewers))
+		fmt.Fprintf(file, "\t\t\"%s\": %s,\n", "authors", marshal(kep.Authors))
+		fmt.Fprintf(file, "\t\t\"%s\": \"%s\",\n", "editor", kep.Editor)
+		fmt.Fprintf(file, "\t\t\"%s\": \"%s\",\n", "creation-date", kep.CreationDate)
+		fmt.Fprintf(file, "\t\t\"%s\": \"%s\",\n", "last-updated", kep.LastUpdated)
+		fmt.Fprintf(file, "\t\t\"%s\": \"%s\",\n", "status", kep.Status)
+		fmt.Fprintf(file, "\t\t\"%s\": %s,\n", "see-also", marshal(kep.SeeAlso))
+		fmt.Fprintf(file, "\t\t\"%s\": %s,\n", "replaces", marshal(kep.Replaces))
+		fmt.Fprintf(file, "\t\t\"%s\": %s,\n", "superseded-by", marshal(kep.SupersededBy))
+		contents, _ := json.Marshal(kep.Contents)
+		fmt.Fprintf(file, "\t\t\"%s\": %s\n", "markdown", contents)
+		if i < total-1 {
+			fmt.Fprintln(file, "\t},")
+		} else {
+			fmt.Fprintln(file, "\t}")
+		}
+	}
+	fmt.Fprintln(file, "}")
+	return nil
+}
+
+func marshal(array []string) string {
+	contents, _ := json.Marshal(array)
+	return string(contents)
+}
+
+func hash(s string) string {
+	return fmt.Sprintf("%x", md5.Sum([]byte(s)))
+}
+
+/// ignore certain files in the keps/ subdirectory
+func ignore(name string) bool {
+	if !strings.HasSuffix(name, "md") {
+		return true
+	}
+	if name == "0023-documentation-for-images.md" ||
+		name == "0004-cloud-provider-template.md" ||
+		name == "0001a-meta-kep-implementation.md" ||
+		name == "0001-kubernetes-enhancement-proposal-process.md" ||
+		name == "YYYYMMDD-kep-template.md" ||
+		name == "README.md" ||
+		name == "kep-faq.md" {
+		return true
+	}
+	return false
+}

pkg/kepval/keps/proposals.go

@@ -62,16 +62,14 @@ func (p *Parser) Parse(in io.Reader) *Proposal {
 	var body bytes.Buffer
 	for scanner.Scan() {
 		line := scanner.Text() + "\n"
-		body.WriteString(line)
-		if count == 2 {
-			continue
-		}
 		if strings.Contains(line, "---") {
 			count++
 			continue
 		}
 		if count == 1 {
 			metadata = append(metadata, []byte(line)...)
+		} else {
+			body.WriteString(line)
 		}
 	}
 	proposal := &Proposal{