Merge pull request kubernetes#2409 from justaugustus/validate

api: Update field validations for `Document`s

Author: k8s-ci-robot

api/apifakes/fake_document.go

@@ -0,0 +1,135 @@
+/*
+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
+
+import (
+	"bufio"
+	"bytes"
+	"io"
+
+	"github.com/go-playground/validator/v10"
+	"github.com/pkg/errors"
+	"gopkg.in/yaml.v3"
+)
+
+type PRRApprovals []*PRRApproval
+
+func (p *PRRApprovals) AddPRRApproval(prrApproval *PRRApproval) {
+	*p = append(*p, prrApproval)
+}
+
+type PRRApproval struct {
+	Number string `json:"kep-number" yaml:"kep-number" validate:"required"`
+
+	// TODO: Need to validate these milestone pointers are not nil
+	Alpha  *PRRMilestone `json:"alpha" yaml:"alpha,omitempty"`
+	Beta   *PRRMilestone `json:"beta" yaml:"beta,omitempty"`
+	Stable *PRRMilestone `json:"stable" yaml:"stable,omitempty"`
+
+	// TODO(api): Move to separate struct for handling document parsing
+	Error error `json:"-" yaml:"-"`
+}
+
+func (prr *PRRApproval) Validate() error {
+	v := validator.New()
+	if err := v.Struct(prr); err != nil {
+		return errors.Wrap(err, "running validation")
+	}
+
+	return nil
+}
+
+func (prr *PRRApproval) ApproverForStage(stage string) (string, error) {
+	isValidStage := IsOneOf(stage, ValidStages)
+	if !isValidStage {
+		return "", ErrKEPStageIsInvalid(stage)
+	}
+
+	if prr.Alpha == nil && prr.Beta == nil && prr.Stable == nil {
+		return "", ErrPRRMilestonesAllEmpty
+	}
+
+	switch stage {
+	case "alpha":
+		if prr.Alpha == nil {
+			return "", ErrPRRMilestoneIsNil
+		}
+
+		return prr.Alpha.Approver, nil
+	case "beta":
+		if prr.Beta == nil {
+			return "", ErrPRRMilestoneIsNil
+		}
+
+		return prr.Beta.Approver, nil
+	case "stable":
+		if prr.Stable == nil {
+			return "", ErrPRRMilestoneIsNil
+		}
+
+		return prr.Stable.Approver, nil
+	}
+
+	return "", ErrPRRApproverUnknown
+}
+
+// TODO(api): Can we refactor the proposal `Milestone` to retrieve this?
+type PRRMilestone struct {
+	Approver string `json:"approver" yaml:"approver" validate:"required"`
+}
+
+type PRRHandler Parser
+
+func NewPRRHandler() (*PRRHandler, error) {
+	handler := &PRRHandler{}
+
+	approvers, err := FetchPRRApprovers()
+	if err != nil {
+		return nil, errors.Wrap(err, "fetching PRR approvers")
+	}
+
+	handler.PRRApprovers = approvers
+
+	return handler, nil
+}
+
+// TODO(api): Make this a generic parser for all `Document` types
+func (p *PRRHandler) Parse(in io.Reader) (*PRRApproval, error) {
+	scanner := bufio.NewScanner(in)
+	var body bytes.Buffer
+	for scanner.Scan() {
+		line := scanner.Text() + "\n"
+		body.WriteString(line)
+	}
+
+	approval := &PRRApproval{}
+	if err := scanner.Err(); err != nil {
+		return approval, errors.Wrap(err, "reading file")
+	}
+
+	if err := yaml.Unmarshal(body.Bytes(), &approval); err != nil {
+		p.Errors = append(p.Errors, errors.Wrap(err, "error unmarshalling YAML"))
+		return approval, errors.Wrap(err, "unmarshalling YAML")
+	}
+
+	if valErr := approval.Validate(); valErr != nil {
+		p.Errors = append(p.Errors, errors.Wrap(valErr, "validating PRR"))
+		return approval, errors.Wrap(valErr, "validating PRR")
+	}
+
+	return approval, nil
+}