Merge pull request #13 from RaghavRoy145/return-errors

MadhavJivrajani · web-flow · commit 63773f8a6fd2 · 2022-02-25T17:47:11.000+05:30
Return errors using RunE
diff --git a/cmd/audit.go b/cmd/audit.go
@@ -60,11 +60,11 @@ var auditCmd = &cobra.Command{
 	Args:  cobra.MinimumNArgs(1),
 	Short: "ensure OWNERS, OWNERS_ALIASES and sigs.yaml have the correct data structure",
 	Long:  ``,
-	Run: func(cmd *cobra.Command, args []string) {
+	RunE: func(cmd *cobra.Command, args []string) error {
 		fmt.Printf("Running script : %s\n", time.Now().Format("01-02-2006 15:04:05"))
 		pwd, err := os.Getwd()
 		if err != nil {
-			panic(err)
+			return err
 		}
 
 		if _, err := os.Stat(kubernetesDirectory); errors.Is(err, os.ErrNotExist) {
@@ -75,18 +75,19 @@ var auditCmd = &cobra.Command{
 
 		sigsYamlPath, err := utils.GetSigsYamlFile(pwd)
 		if err != nil {
-			panic(fmt.Errorf("ERROR: unable to find sigs.yaml file: %w", err))
+			return err
 		}
 		context, err := utils.GetSigsYaml(sigsYamlPath)
 		if err != nil {
-			panic(fmt.Errorf("ERROR: parsing file: %s - %w", sigsYamlPath, err))
+			return err
 		}
 
 		if auditSpecifiedGroups(pwd, context, args) {
 			auditGithubIDs(context)
 			auditLocalOwnersFiles(context, args)
 		}
 		fmt.Printf("Done.\n")
+		return nil
 	},
 }
 
diff --git a/cmd/checkurl.go b/cmd/checkurl.go
@@ -40,23 +40,24 @@ var checkURLsCmd = &cobra.Command{
 	Use:   "check-urls",
 	Short: "ensure all the urls in yaml file are still valid",
 	Long:  ``,
-	Run: func(cmd *cobra.Command, args []string) {
+	RunE: func(cmd *cobra.Command, args []string) error {
 		fmt.Printf("Running script : %s\n", time.Now().Format("01-02-2006 15:04:05"))
 		fmt.Printf("Processing %s\n", yamlFile)
 		sourceYaml, err := ioutil.ReadFile(yamlFile)
 		if err != nil {
-			panic(err)
+			return err
 		}
 		rootNode := yaml.Node{}
 		err = yaml.Unmarshal(sourceYaml, &rootNode)
 		if err != nil {
-			panic(err)
+			return err
 		}
 		ok := processNode(&rootNode)
 		fmt.Println("done")
 		if !ok {
 			os.Exit(1)
 		}
+		return nil
 	},
 }
 
diff --git a/cmd/export.go b/cmd/export.go
@@ -35,16 +35,17 @@ var exportCmd = &cobra.Command{
 	Use:   "export",
 	Short: "export contents of OWNERS and OWNERS_ALIASES as parsable csv file",
 	Long:  ``,
-	Run: func(cmd *cobra.Command, args []string) {
+	RunE: func(cmd *cobra.Command, args []string) error {
 		fmt.Printf("Running script : %s\n", time.Now().Format("01-02-2006 15:04:05"))
 		pwd, err := os.Getwd()
 		if err != nil {
-			panic(err)
+			return err
 		}
 		err = exportOwnersAndAliases(pwd)
 		if err != nil {
-			panic(err)
+			return err
 		}
+		return nil
 	},
 }
 
diff --git a/cmd/labels.go b/cmd/labels.go
@@ -18,11 +18,12 @@ package cmd
 
 import (
 	"fmt"
-	"github.com/spf13/cobra"
 	"os"
 	"sort"
 	"time"
 
+	"github.com/spf13/cobra"
+
 	"k8s.io/apimachinery/pkg/util/sets"
 
 	"github.com/dims/maintainers/pkg/utils"
@@ -33,16 +34,17 @@ var labelsCmd = &cobra.Command{
 	Use:   "labels",
 	Short: "print a list of OWNERS files for labels",
 	Long:  ``,
-	Run: func(cmd *cobra.Command, args []string) {
+	RunE: func(cmd *cobra.Command, args []string) error {
 		fmt.Printf("Running script : %s\n", time.Now().Format("01-02-2006 15:04:05"))
 		pwd, err := os.Getwd()
 		if err != nil {
-			panic(err)
+			return err
 		}
 		err = printFilesForLabels(pwd)
 		if err != nil {
-			panic(err)
+			return err
 		}
+		return nil
 	},
 }
 
diff --git a/cmd/prettify.go b/cmd/prettify.go
@@ -42,16 +42,16 @@ var prettifyCmd = &cobra.Command{
 	Use:   "prettify",
 	Short: "ensure all OWNERS related files are valid yaml and look the same",
 	Long:  ``,
-	Run: func(cmd *cobra.Command, args []string) {
+	RunE: func(cmd *cobra.Command, args []string) error {
 		fmt.Printf("Running script : %s\n", time.Now().Format("01-02-2006 15:04:05"))
 		pwd, err := os.Getwd()
 		if err != nil {
-			panic(err)
+			return err
 		}
 
 		files, err := utils.GetOwnerFiles(pwd)
 		if err != nil {
-			panic(err)
+			return err
 		}
 
 		aliasPath, err := utils.GetOwnersAliasesFile(pwd)
@@ -69,21 +69,22 @@ var prettifyCmd = &cobra.Command{
 		for _, path := range files {
 			sourceYaml, err := ioutil.ReadFile(path)
 			if err != nil {
-				panic(err)
+				return err
 			}
 			rootNode, err := fetchYaml(sourceYaml)
 			if err != nil {
-				panic(err)
+				return err
 			}
 			writer, err := os.OpenFile(path, os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0666)
 			if err != nil {
-				panic(err)
+				return err
 			}
 			err = streamYaml(writer, indent, rootNode)
 			if err != nil {
-				panic(err)
+				return err
 			}
 		}
+		return nil
 	},
 }
 
diff --git a/cmd/prune.go b/cmd/prune.go
@@ -55,16 +55,16 @@ var pruneCmd = &cobra.Command{
 	Use:   "prune",
 	Short: "Remove stale github ids from OWNERS and OWNERS_ALIASES",
 	Long:  ``,
-	Run: func(cmd *cobra.Command, args []string) {
+	RunE: func(cmd *cobra.Command, args []string) error {
 		fmt.Printf("Running script : %s\n", time.Now().Format("01-02-2006 15:04:05"))
 		pwd, err := os.Getwd()
 		if err != nil {
-			panic(err)
+			return err
 		}
 
 		userIDs, repoAliases, files, err := getOwnersAndAliases(pwd)
 		if err != nil {
-			panic(err)
+			return err
 		}
 		for _, file := range files {
 			fmt.Printf("Processed %s\n", file)
@@ -78,7 +78,7 @@ var pruneCmd = &cobra.Command{
 		if !skipDS {
 			contribs, err := utils.GetContributionsForAYear(repositoryDS, periodDS)
 			if err != nil {
-				panic(err)
+				return err
 			}
 			if len(contribs) == 0 {
 				panic("unable to find any contributions in repository : " + repositoryDS)
@@ -154,11 +154,12 @@ var pruneCmd = &cobra.Command{
 		if !dryRun {
 			err = fixupOwnersFiles(files, missingIDs, lowPRComments)
 			if err != nil {
-				panic(err)
+				return err
 			}
 		} else {
 			fmt.Printf("--dryrun is set to true, will skip updating OWNERS and OWNER_ALIASES")
 		}
+		return nil
 	},
 }
 
diff --git a/cmd/validate.go b/cmd/validate.go
@@ -32,18 +32,18 @@ var validateCmd = &cobra.Command{
 	Use:   "validate",
 	Short: "ensure OWNERS, OWNERS_ALIASES and sigs.yaml have the correct data structure",
 	Long:  ``,
-	Run: func(cmd *cobra.Command, args []string) {
+	RunE: func(cmd *cobra.Command, args []string) error {
 		fmt.Printf("Running script : %s\n", time.Now().Format("01-02-2006 15:04:05"))
 		pwd, err := os.Getwd()
 		if err != nil {
-			panic(err)
+			return err
 		}
 
 		aliasPath, err := utils.GetOwnersAliasesFile(pwd)
 		if err == nil && len(aliasPath) > 0 {
 			_, err := utils.GetOwnerAliases(aliasPath)
 			if err != nil {
-				panic(fmt.Errorf("error parsing file: %s - %w", aliasPath, err))
+				return err
 			}
 		}
 
@@ -52,19 +52,19 @@ var validateCmd = &cobra.Command{
 		if err == nil && len(sigsYamlPath) > 0 {
 			context, err = utils.GetSigsYaml(sigsYamlPath)
 			if err != nil {
-				panic(fmt.Errorf("error parsing file: %s - %w", sigsYamlPath, err))
+				return err
 			}
 		}
 
 		files, err := utils.GetOwnerFiles(pwd)
 		if err != nil {
-			panic(err)
+			return err
 		}
 
 		for _, path := range files {
 			_, err := utils.GetOwnersInfo(path)
 			if err != nil {
-				panic(fmt.Errorf("error parsing file: %s - %w", path, err))
+				return err
 			}
 		}
 
@@ -79,6 +79,7 @@ var validateCmd = &cobra.Command{
 			}
 			//panic("please see errors above")
 		}
+		return nil
 	},
 }
 

Original file line number	Diff line number	Diff line change
`@@ -42,16 +42,16 @@ var prettifyCmd = &cobra.Command{`
`42`	`42`	`Use: "prettify",`
`43`	`43`	`Short: "ensure all OWNERS related files are valid yaml and look the same",`
`44`	`44`	Long: ``,
`45`		`- Run: func(cmd *cobra.Command, args []string) {`
	`45`	`+ RunE: func(cmd *cobra.Command, args []string) error {`
`46`	`46`	`fmt.Printf("Running script : %s\n", time.Now().Format("01-02-2006 15:04:05"))`
`47`	`47`	`pwd, err := os.Getwd()`
`48`	`48`	`if err != nil {`
`49`		`- panic(err)`
	`49`	`+ return err`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`files, err := utils.GetOwnerFiles(pwd)`
`53`	`53`	`if err != nil {`
`54`		`- panic(err)`
	`54`	`+ return err`
`55`	`55`	`}`
`56`	`56`
`57`	`57`	`aliasPath, err := utils.GetOwnersAliasesFile(pwd)`
`@@ -69,21 +69,22 @@ var prettifyCmd = &cobra.Command{`
`69`	`69`	`for _, path := range files {`
`70`	`70`	`sourceYaml, err := ioutil.ReadFile(path)`
`71`	`71`	`if err != nil {`
`72`		`- panic(err)`
	`72`	`+ return err`
`73`	`73`	`}`
`74`	`74`	`rootNode, err := fetchYaml(sourceYaml)`
`75`	`75`	`if err != nil {`
`76`		`- panic(err)`
	`76`	`+ return err`
`77`	`77`	`}`
`78`	`78`	`writer, err := os.OpenFile(path, os.O_WRONLY\|os.O_CREATE\|os.O_TRUNC, 0666)`
`79`	`79`	`if err != nil {`
`80`		`- panic(err)`
	`80`	`+ return err`
`81`	`81`	`}`
`82`	`82`	`err = streamYaml(writer, indent, rootNode)`
`83`	`83`	`if err != nil {`
`84`		`- panic(err)`
	`84`	`+ return err`
`85`	`85`	`}`
`86`	`86`	`}`
	`87`	`+ return nil`
`87`	`88`	`},`
`88`	`89`	`}`
`89`	`90`
Original file line number	Diff line number	Diff line change
`@@ -32,18 +32,18 @@ var validateCmd = &cobra.Command{`
`32`	`32`	`Use: "validate",`
`33`	`33`	`Short: "ensure OWNERS, OWNERS_ALIASES and sigs.yaml have the correct data structure",`
`34`	`34`	Long: ``,
`35`		`- Run: func(cmd *cobra.Command, args []string) {`
	`35`	`+ RunE: func(cmd *cobra.Command, args []string) error {`
`36`	`36`	`fmt.Printf("Running script : %s\n", time.Now().Format("01-02-2006 15:04:05"))`
`37`	`37`	`pwd, err := os.Getwd()`
`38`	`38`	`if err != nil {`
`39`		`- panic(err)`
	`39`	`+ return err`
`40`	`40`	`}`
`41`	`41`
`42`	`42`	`aliasPath, err := utils.GetOwnersAliasesFile(pwd)`
`43`	`43`	`if err == nil && len(aliasPath) > 0 {`
`44`	`44`	`_, err := utils.GetOwnerAliases(aliasPath)`
`45`	`45`	`if err != nil {`
`46`		`- panic(fmt.Errorf("error parsing file: %s - %w", aliasPath, err))`
	`46`	`+ return err`
`47`	`47`	`}`
`48`	`48`	`}`
`49`	`49`
`@@ -52,19 +52,19 @@ var validateCmd = &cobra.Command{`
`52`	`52`	`if err == nil && len(sigsYamlPath) > 0 {`
`53`	`53`	`context, err = utils.GetSigsYaml(sigsYamlPath)`
`54`	`54`	`if err != nil {`
`55`		`- panic(fmt.Errorf("error parsing file: %s - %w", sigsYamlPath, err))`
	`55`	`+ return err`
`56`	`56`	`}`
`57`	`57`	`}`
`58`	`58`
`59`	`59`	`files, err := utils.GetOwnerFiles(pwd)`
`60`	`60`	`if err != nil {`
`61`		`- panic(err)`
	`61`	`+ return err`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`for _, path := range files {`
`65`	`65`	`_, err := utils.GetOwnersInfo(path)`
`66`	`66`	`if err != nil {`
`67`		`- panic(fmt.Errorf("error parsing file: %s - %w", path, err))`
	`67`	`+ return err`
`68`	`68`	`}`
`69`	`69`	`}`
`70`	`70`
`@@ -79,6 +79,7 @@ var validateCmd = &cobra.Command{`
`79`	`79`	`}`
`80`	`80`	`//panic("please see errors above")`
`81`	`81`	`}`
	`82`	`+ return nil`
`82`	`83`	`},`
`83`	`84`	`}`
`84`	`85`