Addressed PR comments

Author: bharathi-tenneti

pkg/log/zap/zap.go

@@ -245,7 +245,8 @@ func (o *Options) BindFlags(fs *flag.FlagSet) {
 		o.StacktraceLevel = fromFlag
 	}
 	fs.Var(&stackVal, "zap-stacktrace-level",
-		"Zap Level at and above which stacktraces are captured (one of 'warn' or 'error')")
+		"Zap Level at and above which stacktraces are captured (one of 'info', 'error', or 'disabled')."+
+			"--zap-stacktrace-level=disabled will set level to be 'fatal'.")
 }
 
 // UseFlagOptions configures the logger to use the Options set by parsing zap option flags from the CLI.

pkg/log/zap/zap_test.go

@@ -304,6 +304,9 @@ var _ = Describe("Zap log level flag options setup", func() {
 	var (
 		fromFlags Options
 		fs        flag.FlagSet
+		info      = "info text"
+		debug1    = "debug 1 text"
+		debug2    = "debug 2 text"
 	)
 
 	BeforeEach(func() {
@@ -315,77 +318,75 @@ var _ = Describe("Zap log level flag options setup", func() {
 		It("Should set info/debug zap-log-level flags.", func() {
 			args := []string{"--zap-log-level=debug"}
 			fromFlags.BindFlags(&fs)
-			if err := fs.Parse(args); err != nil {
-				Expect(err).ToNot(HaveOccurred())
-			}
+			err := fs.Parse(args)
+			Expect(err).ToNot(HaveOccurred())
 			logOut := new(bytes.Buffer)
 
 			logger := New(UseFlagOptions(&fromFlags), WriteTo(logOut))
-			logger.V(0).Info("info text")
-			logger.V(1).Info("debug 1 text")
+			logger.V(0).Info(info)
+			logger.V(1).Info(debug1)
 
 			outRaw := logOut.Bytes()
 
-			Expect(string(outRaw)).Should(ContainSubstring("info text"))
-			Expect(string(outRaw)).Should(ContainSubstring("debug 1 text"))
+			Expect(string(outRaw)).Should(ContainSubstring(info))
+			Expect(string(outRaw)).Should(ContainSubstring(debug1))
 
 		})
 
 		It("Should set error zap-log-level flags.", func() {
 			args := []string{"--zap-log-level=error"}
 			fromFlags.BindFlags(&fs)
-			if err := fs.Parse(args); err != nil {
-				Expect(err).ToNot(HaveOccurred())
-			}
+			err := fs.Parse(args)
+			Expect(err).ToNot(HaveOccurred())
+
 			logOut := new(bytes.Buffer)
 
 			logger := New(UseFlagOptions(&fromFlags), WriteTo(logOut))
-			logger.V(0).Info("info text")
-			logger.V(1).Info("debug 1 text")
+			logger.V(0).Info(info)
+			logger.V(1).Info(debug1)
 
 			outRaw := logOut.Bytes()
 
 			Expect(outRaw).To(BeEmpty())
 		})
 
-		It("Should set level 1 debug zap-log-level flags.", func() {
+	})
+
+	Context("with  zap-log-level  with increased verbosity.", func() {
+		It("Should set integer debug level 1 for zap-log-level flag.", func() {
 			args := []string{"--zap-log-level=1"}
 			fromFlags.BindFlags(&fs)
-			if err := fs.Parse(args); err != nil {
-				Expect(err).ToNot(HaveOccurred())
-			}
+			err := fs.Parse(args)
+			Expect(err).ToNot(HaveOccurred())
 			logOut := new(bytes.Buffer)
 
 			logger := New(UseFlagOptions(&fromFlags), WriteTo(logOut))
-			logger.V(0).Info("info text")
-			logger.V(1).Info("debug 1 text")
+			logger.V(0).Info(info)
+			logger.V(1).Info(debug1)
 
 			outRaw := logOut.Bytes()
 
-			Expect(string(outRaw)).Should(ContainSubstring("info text"))
-			Expect(string(outRaw)).Should(ContainSubstring("debug 1 text"))
+			Expect(string(outRaw)).Should(ContainSubstring(info))
+			Expect(string(outRaw)).Should(ContainSubstring(debug1))
 		})
-	})
 
-	Context("with  zap-log-level  with increased verbosity.", func() {
-		It("Should set Level 2 increased verbosity for zap-log-level flags.", func() {
+		It("Should set integer debug level 2 for zap-log-level flag.", func() {
 			args := []string{"--zap-log-level=2"}
 			fromFlags.BindFlags(&fs)
-			if err := fs.Parse(args); err != nil {
-				Expect(err).ToNot(HaveOccurred())
-			}
+			err := fs.Parse(args)
+			Expect(err).ToNot(HaveOccurred())
 			logOut := new(bytes.Buffer)
 
 			logger := New(UseFlagOptions(&fromFlags), WriteTo(logOut))
-			logger.V(0).Info("info text")
-			logger.V(1).Info("debug 1 text")
-			logger.V(2).Info("debug 2 text")
+			logger.V(0).Info(info)
+			logger.V(1).Info(debug1)
+			logger.V(2).Info(debug2)
 
 			outRaw := logOut.Bytes()
 
-			Expect(string(outRaw)).Should(ContainSubstring("info text"))
-			Expect(string(outRaw)).Should(ContainSubstring("debug 1 text"))
-			Expect(string(outRaw)).Should(ContainSubstring("debug 2 text"))
+			Expect(string(outRaw)).Should(ContainSubstring(info))
+			Expect(string(outRaw)).Should(ContainSubstring(debug1))
+			Expect(string(outRaw)).Should(ContainSubstring(debug2))
 
 		})
 
@@ -396,9 +397,8 @@ var _ = Describe("Zap log level flag options setup", func() {
 		It("Should set info stacktrace for zap-stacktrace-level flags.", func() {
 			args := []string{"--zap-stacktrace-level=info", "--zap-devel=true"}
 			fromFlags.BindFlags(&fs)
-			if err := fs.Parse(args); err != nil {
-				Expect(err).ToNot(HaveOccurred())
-			}
+			err := fs.Parse(args)
+			Expect(err).ToNot(HaveOccurred())
 			out := Options{}
 			UseFlagOptions(&fromFlags)(&out)
 
@@ -408,9 +408,8 @@ var _ = Describe("Zap log level flag options setup", func() {
 		It("Should set error stacktrace  for zap-stacktrace-level flags.", func() {
 			args := []string{"--zap-stacktrace-level=error", "--zap-devel=true"}
 			fromFlags.BindFlags(&fs)
-			if err := fs.Parse(args); err != nil {
-				Expect(err).ToNot(HaveOccurred())
-			}
+			err := fs.Parse(args)
+			Expect(err).ToNot(HaveOccurred())
 			out := Options{}
 			UseFlagOptions(&fromFlags)(&out)
 
@@ -420,9 +419,8 @@ var _ = Describe("Zap log level flag options setup", func() {
 		It("Should disable stacktrace for zap-stacktrace-level flags.", func() {
 			args := []string{"--zap-stacktrace-level=disabled", "--zap-devel=true"}
 			fromFlags.BindFlags(&fs)
-			if err := fs.Parse(args); err != nil {
-				Expect(err).ToNot(HaveOccurred())
-			}
+			err := fs.Parse(args)
+			Expect(err).ToNot(HaveOccurred())
 			out := Options{}
 			UseFlagOptions(&fromFlags)(&out)