Improve Generator Logging

v2/tools/generator/gen_kustomize.go

@@ -6,15 +6,12 @@
 package main
 
 import (
-	"fmt"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 	kerrors "k8s.io/apimachinery/pkg/util/errors"
-	"k8s.io/klog/v2"
 
 	"github.com/Azure/azure-service-operator/v2/tools/generator/internal/kustomization"
 )
@@ -34,22 +31,28 @@ func NewGenKustomizeCommand() (*cobra.Command, error) {
 			const bases = "bases"
 			const patches = "patches"
 
+			log := CreateLogger()
+
 			// We have an expectation that the folder structure is: .../config/crd/generated/bases and .../config/crd/generated/patches
 			basesPath := filepath.Join(crdPath, bases)
 			patchesPath := filepath.Join(crdPath, patches)
 
 			destination := filepath.Join(crdPath, "kustomization.yaml")
 
-			klog.V(3).Infof("Scanning %q for resources", basesPath)
+			log.Info(
+				"Scanning for resources",
+				"basePath", basesPath)
 
-			files, err := ioutil.ReadDir(basesPath)
+			files, err := os.ReadDir(basesPath)
 			if err != nil {
-				return logAndExtractStack(fmt.Sprintf("Unable to scan folder %q", basesPath), err)
+				log.Error(err, "Unable to scan folder", "folder", basesPath)
+				return err
 			}
 
 			err = os.MkdirAll(patchesPath, os.ModePerm)
 			if err != nil {
-				return logAndExtractStack(fmt.Sprintf("Unable to create output folder %s", patchesPath), err)
+				log.Error(err, "Unable to create output folder", "folder", patchesPath)
+				return err
 			}
 
 			var errs []error
@@ -60,7 +63,9 @@ func NewGenKustomizeCommand() (*cobra.Command, error) {
 					continue
 				}
 
-				klog.V(3).Infof("Found resource file %s", f.Name())
+				log.V(1).Info(
+					"Found resource file",
+					"file", f.Name())
 
 				patchFile := "webhook-conversion-" + f.Name()
 				var def *kustomization.ResourceDefinition
@@ -70,7 +75,9 @@ func NewGenKustomizeCommand() (*cobra.Command, error) {
 					continue
 				}
 
-				klog.V(4).Infof("Resource is %q", def.Name())
+				log.V(1).Info(
+					"Loaded Resource",
+					"name", def.Name())
 
 				patch := kustomization.NewConversionPatchFile(def.Name())
 				err = patch.Save(filepath.Join(patchesPath, patchFile))
@@ -84,17 +91,28 @@ func NewGenKustomizeCommand() (*cobra.Command, error) {
 			}
 
 			if len(errs) > 0 {
-				return logAndExtractStack("Error creating conversion patches", kerrors.NewAggregate(errs))
+				err = kerrors.NewAggregate(errs)
+				log.Error(
+					err,
+					"Error creating conversion patches")
+				return err
 			}
 
 			if len(result.Resources) == 0 {
 				err = errors.Errorf("no files found in %q", basesPath)
-				return logAndExtractStack("No CRD files found", err)
+				log.Error(
+					err,
+					"No CRD files found")
+				return err
 			}
 
 			err = result.Save(destination)
 			if err != nil {
-				return logAndExtractStack("Error generating "+destination, err)
+				log.Error(
+					err,
+					"Error generating",
+					"destination", destination)
+				return err
 			}
 
 			return nil
@@ -103,14 +121,3 @@ func NewGenKustomizeCommand() (*cobra.Command, error) {
 
 	return cmd, nil
 }
-
-func logAndExtractStack(str string, err error) error {
-	klog.Errorf("%s:\n%s\n", str, err)
-	if tr, ok := findDeepestTrace(err); ok {
-		for _, fr := range tr {
-			klog.Errorf("%n (%s:%d)", fr, fr, fr)
-		}
-	}
-
-	return err
-}

v2/tools/generator/gen_types.go

@@ -12,7 +12,6 @@ import (
 
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
-	"k8s.io/klog/v2"
 
 	"github.com/Azure/azure-service-operator/v2/tools/generator/internal/codegen"
 )
@@ -32,32 +31,39 @@ func NewGenTypesCommand() (*cobra.Command, error) {
 			configFile := args[0]
 			ctx := cmd.Context()
 
-			cg, err := codegen.NewCodeGeneratorFromConfigFile(configFile)
+			log := CreateLogger()
+
+			cg, err := codegen.NewCodeGeneratorFromConfigFile(configFile, log)
 			if err != nil {
-				klog.Errorf("Error creating code generator: %s\n", err)
+				log.Error(err, "Error creating code generator")
 				return err
 			}
 
 			if debugMode != nil && *debugMode != "" {
 				var tmpDir string
 				tmpDir, err = ioutil.TempDir("", createDebugPrefix(*debugMode))
 				if err != nil {
-					klog.Errorf("Error creating temporary directory: %s\n", err)
+					log.Error(err, "Error creating temporary directory")
 					return err
 				}
 
-				klog.V(0).Infof("Debug output will be written to the folder %s\n", tmpDir)
+				log.Info(
+					"Debug output will be written",
+					"folder", tmpDir)
 				cg.UseDebugMode(*debugMode, tmpDir)
 				defer func() {
 					// Write the debug folder again so the user doesn't have to scroll back
-					klog.V(0).Infof("Debug output is available in folder %s\n", tmpDir)
+					log.Info(
+						"Debug output available",
+						"folder", tmpDir)
 				}()
 			}
 
-			err = cg.Generate(ctx)
+			err = cg.Generate(ctx, log)
 
 			if err != nil {
-				return logAndExtractStack("Error during code generation", err)
+				log.Error(err, "Error generating code generation")
+				return err
 			}
 
 			return nil

v2/tools/generator/go.mod

@@ -9,47 +9,50 @@ replace github.com/Azure/azure-service-operator/v2 => ../../
 replace github.com/xeipuuv/gojsonschema => github.com/devigned/gojsonschema v1.2.1-0.20191231010529-c593123f1e5d
 
 require (
-	github.com/Azure/azure-service-operator/v2 v2.0.0-00010101000000-000000000000
+	github.com/Azure/azure-service-operator/v2 v2.0.0
 	github.com/bmatcuk/doublestar v1.3.4
-	github.com/dave/dst v0.26.2
+	github.com/dave/dst v0.27.2
 	github.com/devigned/tab v0.1.1
-	github.com/go-openapi/jsonpointer v0.19.5
-	github.com/go-openapi/spec v0.20.4
+	github.com/go-logr/logr v1.2.4
+	github.com/go-logr/zerologr v1.2.3
+	github.com/go-openapi/jsonpointer v0.19.6
+	github.com/go-openapi/spec v0.20.9
 	github.com/gobuffalo/flect v1.0.2
 	github.com/google/go-cmp v0.5.9
 	github.com/hbollon/go-edlib v1.6.0
-	github.com/kr/pretty v0.3.0
+	github.com/kr/pretty v0.3.1
 	github.com/kylelemons/godebug v1.1.0
 	github.com/leanovate/gopter v0.2.9
-	github.com/onsi/gomega v1.20.1
+	github.com/onsi/gomega v1.27.6
 	github.com/pkg/errors v0.9.1
+	github.com/rs/zerolog v1.29.1
 	github.com/sebdah/goldie/v2 v2.5.3
-	github.com/spf13/cobra v1.6.1
+	github.com/spf13/cobra v1.7.0
 	github.com/spf13/pflag v1.0.5
 	github.com/xeipuuv/gojsonschema v1.2.0
-	golang.org/x/exp v0.0.0-20220414153411-bcd21879b8fd
-	golang.org/x/mod v0.8.0
-	golang.org/x/net v0.9.0
-	golang.org/x/sync v0.1.0
+	golang.org/x/exp v0.0.0-20230510235704-dd950f8aeaea
+	golang.org/x/mod v0.10.0
+	golang.org/x/net v0.10.0
+	golang.org/x/sync v0.2.0
+	golang.org/x/text v0.9.0
 	gopkg.in/yaml.v3 v3.0.1
-	k8s.io/apimachinery v0.25.2
-	k8s.io/klog/v2 v2.80.1
+	k8s.io/apimachinery v0.27.1
 )
 
 require (
-	github.com/go-logr/logr v1.2.3 // indirect
-	github.com/go-openapi/jsonreference v0.20.0 // indirect
+	github.com/go-openapi/jsonreference v0.20.2 // indirect
 	github.com/go-openapi/swag v0.22.3 // indirect
-	github.com/inconshreveable/mousetrap v1.0.1 // indirect
+	github.com/inconshreveable/mousetrap v1.1.0 // indirect
 	github.com/josharian/intern v1.0.0 // indirect
 	github.com/kr/text v0.2.0 // indirect
 	github.com/mailru/easyjson v0.7.7 // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.18 // indirect
 	github.com/pmezard/go-difflib v1.0.0 // indirect
-	github.com/rogpeppe/go-internal v1.6.1 // indirect
-	github.com/sergi/go-diff v1.0.0 // indirect
-	github.com/xeipuuv/gojsonpointer v0.0.0-20180127040702-4e3ac2762d5f // indirect
+	github.com/rogpeppe/go-internal v1.10.0 // indirect
+	github.com/sergi/go-diff v1.3.1 // indirect
+	github.com/xeipuuv/gojsonpointer v0.0.0-20190905194746-02993c407bfb // indirect
 	github.com/xeipuuv/gojsonreference v0.0.0-20180127040603-bd5ef7bd5415 // indirect
-	golang.org/x/sys v0.7.0 // indirect
-	golang.org/x/text v0.9.0 // indirect
-	golang.org/x/tools v0.6.0 // indirect
+	golang.org/x/sys v0.8.0 // indirect
+	golang.org/x/tools v0.9.1 // indirect
 )