cmd/contour: Replace check() by kingpin.Fatalf() in cli.go #2824

ShaileshSurya · 2020-08-23T08:53:35Z

There are quite a few places in Contour that call a
local check helper that prints to standard error and exits.
This approach loses error context and makes it difficult for
aggregated log collectors to recognize that this is a fatal error message

This commit replaces check functions in cmd/contour/cli.go by log.Fatal

Fixes #2811

Signed-off-by: Shailesh Suryawanshi [email protected]

codecov · 2020-08-23T08:57:15Z

Codecov Report

Merging #2824 into main will increase coverage by 0.03%.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##             main    #2824      +/-   ##
==========================================
+ Coverage   76.57%   76.61%   +0.03%     
==========================================
  Files          79       79              
  Lines        5866     5866              
==========================================
+ Hits         4492     4494       +2     
+ Misses       1283     1282       -1     
+ Partials       91       90       -1

Impacted Files	Coverage Δ
cmd/contour/cli.go	`0.00% <0.00%> (ø)`
internal/dag/cache.go	`96.42% <0.00%> (+0.71%)`	⬆️

jpeach

This code is only used by the contour cli * subcommands, so exiting manually is appropriate here. The log.Fatal in (*Client) dial() is actually a bug.

We have a few options with this code:

Assume that it is library code and propagate errors out to the caller, who can exit with an error
Replace check with a function ErrExit which does the same thing, but has a clearer name
Replace check with calls to kingpin.FatalIfError
Leave it for now :)

The first option is a fair bit of churn, so you may want to consider the other options :)

ShaileshSurya · 2020-08-24T14:27:24Z

Hi @jpeach,

I find the third option Replace check with calls to the kingpin.FatalIfError intuitive. I will make the changes accordingly and update the PR.

I will also update the existing log.fatal with the kingpin.FatalIfError.

Thank you for the suggestions.

ShaileshSurya · 2020-08-24T15:00:00Z

cmd/contour/cli.go

 		if ok := certPool.AppendCertsFromPEM(ca); !ok {
 			// TODO(nyoung) OMG yuck, thanks for this, crypto/tls. Suggestions on alternates welcomed.
-			log.Fatal("failed to append ca certs")
+			kingpin.Fatalf("failed to append ca certs")


I am not very sure about this. I checked kingpins' documentation and could not find kingpin.Fatal. Please advise.

Fatalf seems fine to me. Please update the message to say "CA certificates" instead of "ca certs".

Suggested change

kingpin.Fatalf("failed to append ca certs")

kingpin.Fatalf("failed to append CA certs")

@ShaileshSurya ^^^

Fixed this.

go.sum

go.mod

jpeach

Good progress, just need to update the exit messages. Can you manually trigger some of then and show the output?

Can you please update the log.Fatal on line 48 as well?

cmd/contour/cli.go

jpeach · 2020-08-25T00:53:22Z

cmd/contour/cli.go

 		certificate, err := tls.LoadX509KeyPair(c.ClientCert, c.ClientKey)
-		check(err)
-
+		kingpin.FatalIfError(err, "err: %v", err)


This will print the error twice, see https://play.golang.org/p/I9qfq3XMT-5

What you want here is:

kingpin.FatalIfError(err, "failed to load key pair")

Please update all the other places that format the error.

It's better to provide a message string to give the context of the failure. For example, this:

$ contour cli cds --cafile=/tmp/t --cert-file=/tmp/t --key-file=/tmp/t contour: error: failed to load CA certificates: open /tmp/t: no such file or directory

is a better message than this:

$ contour cli cds --cafile=/tmp/t --cert-file=/tmp/t --key-file=/tmp/t contour: error: open /tmp/t: no such file or directory

Could you please add a message string to each call to kingpin.FatalIfError?

Could you please add a message string to each call to kingpin.FatalIfError?

@ShaileshSurya ^^^

I have made the required changes. We might want to check the wording for each and every error message once.

jpeach · 2020-08-25T00:54:59Z

cmd/contour/cli.go

 		if ok := certPool.AppendCertsFromPEM(ca); !ok {
 			// TODO(nyoung) OMG yuck, thanks for this, crypto/tls. Suggestions on alternates welcomed.
-			log.Fatal("failed to append ca certs")
+			kingpin.Fatalf("failed to append ca certs")


Fatalf seems fine to me. Please update the message to say "CA certificates" instead of "ca certs".

There are quite a few places in Contour that call a local check helper that prints to standard error and exits. This approach loses error context and makes it difficult for aggregated log collectors to recognize that this is a fatal error message This commit replaces check functions in cmd/contour/cli.go by kingpin libraries fatal logs Fixes projectcontour#2811 Signed-off-by: Shailesh Suryawanshi <[email protected]>

ShaileshSurya · 2020-08-26T12:45:43Z

cmd/contour/cli.go

 		}
 		err := st.Send(req)
-		check(err)
+		kingpin.FatalIfError(err, "")


Please Check https://play.golang.org/p/1WiDkfYYoLp for the output.

ShaileshSurya · 2020-08-26T12:46:10Z

cmd/contour/cli.go

 		certificate, err := tls.LoadX509KeyPair(c.ClientCert, c.ClientKey)
-		check(err)
-
+		kingpin.FatalIfError(err, "")


Please check https://play.golang.org/p/1WiDkfYYoLp for the output.

This should be

kingpin.FatalIfError(err, "failed to load certificate")

Made the changes to all FtalIfError. Added Error messages

ShaileshSurya · 2020-08-26T12:47:51Z

@jpeach I have made the requested changes. Can you please have a look.

cmd/contour/cli.go

fixing the error message to make more consistent fixes projectcontour#2811 Signed-off-by: Shailesh Suryawanshi <[email protected]>

ShaileshSurya · 2020-08-29T16:59:07Z

@jpeach Please have a look, I have addressed the review comments.

jpeach

This looks good, thanks @ShaileshSurya

ShaileshSurya force-pushed the fix-replace-check-to-fatal branch from ff4d8cb to 8b9e3b5 Compare August 23, 2020 08:56

jpeach suggested changes Aug 23, 2020

View reviewed changes

ShaileshSurya force-pushed the fix-replace-check-to-fatal branch from 3183bdc to fc9f789 Compare August 24, 2020 14:58

ShaileshSurya commented Aug 24, 2020

View reviewed changes

ShaileshSurya force-pushed the fix-replace-check-to-fatal branch from fc9f789 to 3d75c25 Compare August 24, 2020 15:15

ShaileshSurya commented Aug 24, 2020

View reviewed changes

go.sum Outdated Show resolved Hide resolved

ShaileshSurya commented Aug 24, 2020

View reviewed changes

go.mod Outdated Show resolved Hide resolved

ShaileshSurya changed the title ~~cmd/contour: Replace check function by log.Fatal()~~ cmd/contour: Replace check() by kingpin.Fatalf() in cli.go Aug 24, 2020

jpeach suggested changes Aug 25, 2020

View reviewed changes

ShaileshSurya force-pushed the fix-replace-check-to-fatal branch from 3d75c25 to bc15f89 Compare August 26, 2020 12:34

ShaileshSurya force-pushed the fix-replace-check-to-fatal branch from bc15f89 to 3250d08 Compare August 26, 2020 12:44

ShaileshSurya commented Aug 26, 2020

View reviewed changes

jpeach reviewed Aug 27, 2020

View reviewed changes

cmd/contour/cli.go Outdated Show resolved Hide resolved

Fixing Review Comments

2b7e9e4

fixing the error message to make more consistent fixes projectcontour#2811 Signed-off-by: Shailesh Suryawanshi <[email protected]>

ShaileshSurya requested a review from jpeach August 31, 2020 05:04

Fix Review Comment: Added Err Msg

3cc4487

jpeach approved these changes Sep 7, 2020

View reviewed changes

Merge branch 'main' into fix-replace-check-to-fatal

eb53037

jpeach merged commit 78eb83f into projectcontour:main Sep 7, 2020

	kingpin.Fatalf("failed to append ca certs")
	kingpin.Fatalf("failed to append CA certs")

cmd/contour: Replace check() by kingpin.Fatalf() in cli.go #2824

cmd/contour: Replace check() by kingpin.Fatalf() in cli.go #2824

Uh oh!

Conversation

ShaileshSurya commented Aug 23, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Aug 23, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

jpeach left a comment

Choose a reason for hiding this comment

Uh oh!

ShaileshSurya commented Aug 24, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jpeach left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ShaileshSurya commented Aug 26, 2020

Uh oh!

Uh oh!

ShaileshSurya commented Aug 29, 2020

Uh oh!

jpeach left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ShaileshSurya commented Aug 23, 2020 •

edited

Loading

codecov bot commented Aug 23, 2020 •

edited

Loading