kepctl output: use logrus vs. Fprint Repo Out/Err

The Fprintf calls seem to be about avoiding logging to stdout so that
tools like `jq` could consume structured output from `kepctl query`.
Fortunately, logrus is already configured to do this, so use it instead.

Changes were basically:

- Where things wrote to r.Err, they are now logrus.Warns
- Where things wrote to r.Out, they are now logrus.Infos
- Drop the '\n' from the former Fprintf statements
- Drop the StructuredFormats / suppressOuput logic

`kepctl query --log-level debug --output json | jq .` is happy

Author: spiffxp

pkg/proposal/create.go

@@ -25,6 +25,7 @@ import (
 	"time"
 
 	"github.com/pkg/errors"
+	"github.com/sirupsen/logrus"
 
 	"k8s.io/enhancements/api"
 	"k8s.io/enhancements/pkg/repo"
@@ -74,7 +75,7 @@ func (c *CreateOpts) Validate(args []string) error {
 func Create(opts *CreateOpts) error {
 	r := opts.Repo
 
-	fmt.Fprintf(r.Out, "Creating KEP %s %s %s\n", opts.SIG, opts.Number, opts.Name)
+	logrus.Infof("Creating KEP %s %s %s", opts.SIG, opts.Number, opts.Name)
 
 	kep := &api.Proposal{}
 
@@ -96,7 +97,7 @@ func Create(opts *CreateOpts) error {
 func createKEP(kep *api.Proposal, opts *CreateOpts) error {
 	r := opts.Repo
 
-	fmt.Fprintf(r.Out, "Generating new KEP %s in %s ===>\n", opts.Name, opts.SIG)
+	logrus.Infof("Generating new KEP %s in %s ===>", opts.Name, opts.SIG)
 
 	err := r.WriteKEP(kep)
 	if err != nil {

pkg/proposal/promote.go

@@ -19,6 +19,7 @@ package proposal
 import (
 	"fmt"
 
+	"github.com/sirupsen/logrus"
 	"k8s.io/enhancements/pkg/repo"
 )
 
@@ -48,7 +49,7 @@ func (o *PromoteOpts) Validate(args []string) error {
 func Promote(opts *PromoteOpts) error {
 	r := opts.Repo
 
-	fmt.Fprintf(r.Out, "Updating KEP %s/%s\n", opts.SIG, opts.Name)
+	logrus.Infof("Updating KEP %s/%s", opts.SIG, opts.Name)
 
 	p, err := r.ReadKEP(opts.SIG, opts.Name)
 	if err != nil {
@@ -65,7 +66,7 @@ func Promote(opts *PromoteOpts) error {
 	}
 
 	// TODO: Implement ticketing workflow artifact generation
-	fmt.Fprintf(r.Out, "KEP %s/%s updated\n", opts.SIG, opts.Name)
+	logrus.Infof("KEP %s/%s updated", opts.SIG, opts.Name)
 
 	return nil
 }

pkg/repo/query.go

@@ -37,12 +37,6 @@ var (
 
 	// DefaultOutputOpt is the default output format for kepctl query
 	DefaultOutputOpt = "table"
-
-	StructuredOutputFormats = []string{
-		"json",
-		"yaml",
-		"csv",
-	}
 )
 
 type QueryOpts struct {
@@ -104,19 +98,7 @@ func (r *Repo) PrepareQueryOpts(opts *QueryOpts) error {
 // Query searches the local repo and possibly GitHub for KEPs
 // that match the search criteria.
 func (r *Repo) Query(opts *QueryOpts) error {
-	// if output format is json/yaml, suppress other outputs
-	// json/yaml are structured formats, logging events which
-	// do not conform to the spec will create formatting issues
-	var suppressOutputs bool
-	if sliceContains(StructuredOutputFormats, opts.Output) {
-		suppressOutputs = true
-	} else {
-		suppressOutputs = false
-	}
-
-	if !suppressOutputs {
-		fmt.Fprintf(r.Out, "Searching for KEPs...\n")
-	}
+	logrus.Info("Searching for KEPs...")
 
 	err := r.PrepareQueryOpts(opts)
 	if err != nil {
@@ -145,7 +127,7 @@ func (r *Repo) Query(opts *QueryOpts) error {
 		if opts.IncludePRs {
 			prKeps, err := r.loadKEPPullRequests(sig)
 			if err != nil {
-				fmt.Fprintf(r.Err, "error searching for KEP PRs from %s: %s\n", sig, err)
+				logrus.Warnf("error searching for KEP PRs from %s: %s", sig, err)
 			}
 			if prKeps != nil {
 				allKEPs = append(allKEPs, prKeps...)

pkg/repo/repo.go

@@ -414,7 +414,7 @@ func (r *Repo) loadKEPPullRequests(sig string) ([]*api.Proposal, error) {
 		for k := range kepNames {
 			kep, err := r.ReadKEP(sig, k)
 			if err != nil {
-				fmt.Fprintf(r.Err, "ERROR READING KEP %s: %s\n", k, err)
+				logrus.Warnf("error reading KEP %v: %v", k, err)
 			} else {
 				kep.PRNumber = strconv.Itoa(pr.GetNumber())
 				allKEPs = append(allKEPs, kep)

pkg/repo/write.go

@@ -17,12 +17,13 @@ limitations under the License.
 package repo
 
 import (
+	"errors"
 	"fmt"
 	"io/ioutil"
 	"os"
 	"path/filepath"
 
-	"github.com/pkg/errors"
+	"github.com/sirupsen/logrus"
 	"gopkg.in/yaml.v3"
 	"k8s.io/enhancements/api"
 )
@@ -44,25 +45,15 @@ func (r *Repo) WriteKEP(kep *api.Proposal) error {
 		return errors.New("KEP name must be populated")
 	}
 
-	if mkErr := os.MkdirAll(
-		filepath.Join(
-			r.ProposalPath,
-			sig,
-			kepName,
-		),
-		os.ModePerm,
-	); mkErr != nil {
-		return errors.Wrapf(mkErr, "creating KEP directory")
+	kepPath := filepath.Join(r.ProposalPath, sig, kepName)
+	logrus.Infof("creating KEP directory: %s", kepPath)
+	if err = os.MkdirAll(kepPath, os.ModePerm); err != nil {
+		return fmt.Errorf("unable to create KEP path %s: %w", kepPath, err)
 	}
 
-	newPath := filepath.Join(
-		r.ProposalPath,
-		sig,
-		kepName,
-		ProposalMetadataFilename,
-	)
+	kepYamlPath := filepath.Join(kepPath, ProposalMetadataFilename)
 
-	fmt.Fprintf(r.Out, "writing KEP to %s\n", newPath)
+	logrus.Infof("writing KEP metadata to %s", kepYamlPath)
 
-	return ioutil.WriteFile(newPath, b, os.ModePerm)
+	return ioutil.WriteFile(kepYamlPath, b, os.ModePerm)
 }