Merge pull request kubernetes#2346 from justaugustus/api

api: Initial commit

Author: k8s-ci-robot

api/proposal.go

@@ -0,0 +1,68 @@
+/*
+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 api
+
+type Proposals []*Proposal
+
+func (p *Proposals) AddProposal(proposal *Proposal) {
+	*p = append(*p, proposal)
+}
+
+type Proposal struct {
+	ID       string `json:"id"`
+	PRNumber string `json:"prNumber,omitempty"`
+	Name     string `json:"name,omitempty"`
+
+	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"`
+	Reviewers         []string `json:"reviewers" yaml:",flow"`
+	Approvers         []string `json:"approvers" yaml:",flow"`
+	PRRApprovers      []string `json:"prrApprovers" yaml:"prr-approvers,flow"`
+	Editor            string   `json:"editor" yaml:"editor,omitempty"`
+	CreationDate      string   `json:"creationDate" yaml:"creation-date"`
+	LastUpdated       string   `json:"lastUpdated" yaml:"last-updated"`
+	Status            string   `json:"status" yaml:"status"`
+	SeeAlso           []string `json:"seeAlso" yaml:"see-also,omitempty"`
+	Replaces          []string `json:"replaces" yaml:"replaces,omitempty"`
+	SupersededBy      []string `json:"supersededBy" yaml:"superseded-by,omitempty"`
+
+	Stage           string    `json:"stage" yaml:"stage"`
+	LatestMilestone string    `json:"latestMilestone" yaml:"latest-milestone"`
+	Milestone       Milestone `json:"milestone" yaml:"milestone"`
+
+	FeatureGates     []FeatureGate `json:"featureGates" yaml:"feature-gates"`
+	DisableSupported bool          `json:"disableSupported" yaml:"disable-supported"`
+	Metrics          []string      `json:"metrics" yaml:"metrics"`
+
+	Filename string `json:"-" yaml:"-"`
+	Error    error  `json:"-" yaml:"-"`
+	Contents string `json:"markdown" yaml:"-"`
+}
+
+type Milestone struct {
+	Alpha  string `json:"alpha" yaml:"alpha"`
+	Beta   string `json:"beta" yaml:"beta"`
+	Stable string `json:"stable" yaml:"stable"`
+}
+
+type FeatureGate struct {
+	Name       string   `json:"name" yaml:"name"`
+	Components []string `json:"components" yaml:"components"`
+}

cmd/kepify/main.go

@@ -25,6 +25,7 @@ import (
 	"path/filepath"
 	"strings"
 
+	"k8s.io/enhancements/api"
 	"k8s.io/enhancements/pkg/kepval/keps"
 )
 
@@ -104,8 +105,8 @@ func findMarkdownFiles(dirPath *string) ([]string, error) {
 	return files, err
 }
 
-func parseFiles(files []string) (keps.Proposals, error) {
-	var proposals keps.Proposals
+func parseFiles(files []string) (api.Proposals, error) {
+	var proposals api.Proposals
 	for _, filename := range files {
 		parser := &keps.Parser{}
 		file, err := os.Open(filename)
@@ -124,7 +125,7 @@ func parseFiles(files []string) (keps.Proposals, error) {
 	return proposals, nil
 }
 
-func printJSONOutput(filePath string, proposals keps.Proposals) error {
+func printJSONOutput(filePath string, proposals api.Proposals) error {
 	fmt.Printf("Output file: %s\n", filePath)
 	file, err := os.Create(filePath)
 	if err != nil {

pkg/kepctl/create.go

@@ -25,7 +25,7 @@ import (
 	"strings"
 	"time"
 
-	"k8s.io/enhancements/pkg/kepval/keps"
+	"k8s.io/enhancements/api"
 )
 
 type CreateOpts struct {
@@ -82,7 +82,7 @@ func (c *Client) Create(opts CreateOpts) error {
 	return nil
 }
 
-func updateTemplate(t *keps.Proposal, opts CreateOpts) {
+func updateTemplate(t *api.Proposal, opts CreateOpts) {
 	if opts.State != "" {
 		t.Status = opts.State
 	}
@@ -134,7 +134,7 @@ func updatePersonReference(names []string) []string {
 	return persons
 }
 
-func (c *Client) createKEP(kep *keps.Proposal, opts CreateOpts) error {
+func (c *Client) createKEP(kep *api.Proposal, opts CreateOpts) error {
 
 	fmt.Fprintf(c.Out, "Generating new KEP %s in %s ===>\n", opts.Name, opts.SIG)
 

pkg/kepctl/create_test.go

@@ -25,7 +25,8 @@ import (
 
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
-	"k8s.io/enhancements/pkg/kepval/keps"
+
+	"k8s.io/enhancements/api"
 	"sigs.k8s.io/yaml"
 )
 
@@ -87,7 +88,7 @@ func TestWriteKep(t *testing.T) {
 			c := newTestClient(t, repoPath)
 			b, err := ioutil.ReadFile(tc.kepFile)
 			require.NoError(t, err)
-			var p keps.Proposal
+			var p api.Proposal
 			err = yaml.Unmarshal(b, &p)
 			require.NoError(t, err)
 			tc.opts.CommonArgs.RepoPath = repoPath

pkg/kepctl/kepctl.go

@@ -35,6 +35,7 @@ import (
 	"golang.org/x/oauth2"
 	"gopkg.in/yaml.v2"
 
+	"k8s.io/enhancements/api"
 	"k8s.io/enhancements/pkg/kepval/keps"
 	"k8s.io/test-infra/prow/git"
 )
@@ -127,8 +128,8 @@ func (c *Client) SetGitHubToken(opts CommonArgs) error {
 // getKepTemplate reads the kep.yaml template from the local
 // (per c.RepoPath) k/enhancements, but this could be replaced with a
 // template via packr or fetched from Github?
-func (c *Client) getKepTemplate(repoPath string) (*keps.Proposal, error) {
-	var p keps.Proposal
+func (c *Client) getKepTemplate(repoPath string) (*api.Proposal, error) {
+	var p api.Proposal
 	path := filepath.Join(repoPath, "keps", "NNNN-kep-template", "kep.yaml")
 	b, err := ioutil.ReadFile(path)
 	if err != nil {
@@ -148,7 +149,7 @@ func (c *Client) getReadmeTemplate(repoPath string) ([]byte, error) {
 	return ioutil.ReadFile(path)
 }
 
-func validateKEP(p *keps.Proposal) error {
+func validateKEP(p *api.Proposal) error {
 	b, err := yaml.Marshal(p)
 	if err != nil {
 		return err
@@ -200,14 +201,14 @@ func findLocalKEPMeta(repoPath, sig string) ([]string, error) {
 	return keps, err
 }
 
-func (c *Client) loadLocalKEPs(repoPath, sig string) ([]*keps.Proposal) {
+func (c *Client) loadLocalKEPs(repoPath, sig string) []*api.Proposal {
 	// KEPs in the local filesystem
 	files, err := findLocalKEPMeta(repoPath, sig)
 	if err != nil {
 		fmt.Fprintf(c.Err, "error searching for local KEPs from %s: %s\n", sig, err)
 	}
 
-	var allKEPs []*keps.Proposal
+	var allKEPs []*api.Proposal
 	for _, k := range files {
 		if filepath.Ext(k) == ".yaml" {
 			kep, err := c.loadKEPFromYaml(k)
@@ -228,7 +229,7 @@ func (c *Client) loadLocalKEPs(repoPath, sig string) ([]*keps.Proposal) {
 	return allKEPs
 }
 
-func (c *Client) loadKEPPullRequests(sig string) ([]*keps.Proposal, error) {
+func (c *Client) loadKEPPullRequests(sig string) ([]*api.Proposal, error) {
 	var auth *http.Client
 	ctx := context.Background()
 	if c.Token != "" {
@@ -289,7 +290,7 @@ func (c *Client) loadKEPPullRequests(sig string) ([]*keps.Proposal, error) {
 
 	// read out each PR, and create a Proposal for each KEP that is
 	// touched by a PR. This may result in multiple versions of the same KEP.
-	var allKEPs []*keps.Proposal
+	var allKEPs []*api.Proposal
 	for _, pr := range kepPRs {
 		files, _, err := gh.PullRequests.ListFiles(context.Background(), "kubernetes", "enhancements",
 			pr.GetNumber(), &github.ListOptions{})
@@ -338,7 +339,7 @@ func (c *Client) loadKEPPullRequests(sig string) ([]*keps.Proposal, error) {
 	return allKEPs, nil
 }
 
-func (c *Client) readKEP(repoPath string, sig, name string) (*keps.Proposal, error) {
+func (c *Client) readKEP(repoPath string, sig, name string) (*api.Proposal, error) {
 	kepPath := filepath.Join(
 		repoPath,
 		"keps",
@@ -361,12 +362,12 @@ func (c *Client) readKEP(repoPath string, sig, name string) (*keps.Proposal, err
 	return c.loadKEPFromOldStyle(kepPath)
 }
 
-func (c *Client) loadKEPFromYaml(kepPath string) (*keps.Proposal, error) {
+func (c *Client) loadKEPFromYaml(kepPath string) (*api.Proposal, error) {
 	b, err := ioutil.ReadFile(kepPath)
 	if err != nil {
 		return nil, fmt.Errorf("unable to read KEP metadata: %s", err)
 	}
-	var p keps.Proposal
+	var p api.Proposal
 	err = yaml.Unmarshal(b, &p)
 	if err != nil {
 		return nil, fmt.Errorf("unable to load KEP metadata: %s", err)
@@ -375,7 +376,7 @@ func (c *Client) loadKEPFromYaml(kepPath string) (*keps.Proposal, error) {
 	return &p, nil
 }
 
-func (c *Client) loadKEPFromOldStyle(kepPath string) (*keps.Proposal, error) {
+func (c *Client) loadKEPFromOldStyle(kepPath string) (*api.Proposal, error) {
 	b, err := ioutil.ReadFile(kepPath)
 	if err != nil {
 		return nil, fmt.Errorf("no kep.yaml, but failed to read as old-style KEP: %s", err)
@@ -391,7 +392,7 @@ func (c *Client) loadKEPFromOldStyle(kepPath string) (*keps.Proposal, error) {
 	return kep, nil
 }
 
-func (c *Client) writeKEP(kep *keps.Proposal, opts CommonArgs) error {
+func (c *Client) writeKEP(kep *api.Proposal, opts CommonArgs) error {
 	path, err := c.findEnhancementsRepo(opts)
 	if err != nil {
 		return fmt.Errorf("unable to write KEP: %s", err)
@@ -417,39 +418,39 @@ func (c *Client) writeKEP(kep *keps.Proposal, opts CommonArgs) error {
 
 type PrintConfig interface {
 	Title() string
-	Value(*keps.Proposal) string
+	Value(*api.Proposal) string
 }
 
 type printConfig struct {
 	title     string
-	valueFunc func(*keps.Proposal) string
+	valueFunc func(*api.Proposal) string
 }
 
 func (p *printConfig) Title() string { return p.title }
-func (p *printConfig) Value(k *keps.Proposal) string {
+func (p *printConfig) Value(k *api.Proposal) string {
 	return p.valueFunc(k)
 }
 
 var defaultConfig = map[string]printConfig{
-	"Authors":     {"Authors", func(k *keps.Proposal) string { return strings.Join(k.Authors, ", ") }},
-	"LastUpdated": {"Updated", func(k *keps.Proposal) string { return k.LastUpdated }},
-	"SIG": {"SIG", func(k *keps.Proposal) string {
+	"Authors":     {"Authors", func(k *api.Proposal) string { return strings.Join(k.Authors, ", ") }},
+	"LastUpdated": {"Updated", func(k *api.Proposal) string { return k.LastUpdated }},
+	"SIG": {"SIG", func(k *api.Proposal) string {
 		if strings.HasPrefix(k.OwningSIG, "sig-") {
 			return k.OwningSIG[4:]
 		} else {
 			return k.OwningSIG
 		}
 	}},
-	"Stage":  {"Stage", func(k *keps.Proposal) string { return k.Stage }},
-	"Status": {"Status", func(k *keps.Proposal) string { return k.Status }},
-	"Title": {"Title", func(k *keps.Proposal) string {
+	"Stage":  {"Stage", func(k *api.Proposal) string { return k.Stage }},
+	"Status": {"Status", func(k *api.Proposal) string { return k.Status }},
+	"Title": {"Title", func(k *api.Proposal) string {
 		if k.PRNumber == "" {
 			return k.Title
 		} else {
 			return "PR#" + k.PRNumber + " - " + k.Title
 		}
 	}},
-	"Link": {"Link", func(k *keps.Proposal) string {
+	"Link": {"Link", func(k *api.Proposal) string {
 		if k.PRNumber == "" {
 			return "https://git.k8s.io/enhancements/keps/" + k.OwningSIG + "/" + k.Name
 		} else {
@@ -468,7 +469,7 @@ func DefaultPrintConfigs(names ...string) []PrintConfig {
 	return configs
 }
 
-func (c *Client) PrintTable(configs []PrintConfig, proposals []*keps.Proposal) {
+func (c *Client) PrintTable(configs []PrintConfig, proposals []*api.Proposal) {
 	if len(configs) == 0 {
 		return
 	}
@@ -493,7 +494,7 @@ func (c *Client) PrintTable(configs []PrintConfig, proposals []*keps.Proposal) {
 }
 
 // PrintYAML outputs keps array as YAML to c.Out
-func (c *Client) PrintYAML(proposals []*keps.Proposal) {
+func (c *Client) PrintYAML(proposals []*api.Proposal) {
 	data, err := yaml.Marshal(proposals)
 	if err != nil {
 		fmt.Fprintf(c.Err, "error printing keps as YAML: %s", err)
@@ -504,7 +505,7 @@ func (c *Client) PrintYAML(proposals []*keps.Proposal) {
 }
 
 // PrintJSON outputs keps array as YAML to c.Out
-func (c *Client) PrintJSON(proposals []*keps.Proposal) {
+func (c *Client) PrintJSON(proposals []*api.Proposal) {
 	data, err := json.Marshal(proposals)
 	if err != nil {
 		fmt.Fprintf(c.Err, "error printing keps as JSON: %s", err)

pkg/kepctl/kepctl_test.go

@@ -24,7 +24,8 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 	"gopkg.in/yaml.v2"
-	"k8s.io/enhancements/pkg/kepval/keps"
+
+	"k8s.io/enhancements/api"
 )
 
 func TestValidate(t *testing.T) {
@@ -49,7 +50,7 @@ func TestValidate(t *testing.T) {
 		t.Run(tc.name, func(t *testing.T) {
 			b, err := ioutil.ReadFile(tc.file)
 			require.NoError(t, err)
-			var p keps.Proposal
+			var p api.Proposal
 			err = yaml.Unmarshal(b, &p)
 			require.NoError(t, err)
 			err = validateKEP(&p)

pkg/kepctl/query.go

@@ -22,7 +22,7 @@ import (
 
 	"github.com/pkg/errors"
 
-	"k8s.io/enhancements/pkg/kepval/keps"
+	"k8s.io/enhancements/api"
 	"k8s.io/enhancements/pkg/kepval/util"
 )
 
@@ -101,7 +101,7 @@ func (c *Client) Query(opts QueryOpts) error {
 
 	c.SetGitHubToken(opts.CommonArgs)
 
-	var allKEPs []*keps.Proposal
+	var allKEPs []*api.Proposal
 	// load the KEPs for each listed SIG
 	for _, sig := range opts.SIG {
 		// KEPs in the local filesystem
@@ -126,7 +126,7 @@ func (c *Client) Query(opts QueryOpts) error {
 	allowedAuthor := sliceToMap(opts.Author)
 	allowedApprover := sliceToMap(opts.Approver)
 
-	var keep []*keps.Proposal
+	var keps []*api.Proposal
 	for _, k := range allKEPs {
 		if len(opts.Status) > 0 && !allowedStatus[k.Status] {
 			continue
@@ -143,16 +143,16 @@ func (c *Client) Query(opts QueryOpts) error {
 		if len(opts.Approver) > 0 && !atLeastOne(k.Approvers, allowedApprover) {
 			continue
 		}
-		keep = append(keep, k)
+		keps = append(keps, k)
 	}
 
 	switch opts.Output {
 	case "table":
-		c.PrintTable(DefaultPrintConfigs("LastUpdated", "Stage", "Status", "SIG", "Authors", "Title", "Link"), keep)
+		c.PrintTable(DefaultPrintConfigs("LastUpdated", "Stage", "Status", "SIG", "Authors", "Title", "Link"), keps)
 	case "yaml":
-		c.PrintYAML(keep)
+		c.PrintYAML(keps)
 	case "json":
-		c.PrintJSON(keep)
+		c.PrintJSON(keps)
 	default:
 		// this check happens as a validation step in cobra as well
 		// added it for additional verbosity