feat(core): improve json format for CLI error (#1184)

jerome-quere · web-flow · commit 30c92276b598 · 2020-07-06T19:13:16.000+02:00
diff --git a/internal/core/error.go b/internal/core/error.go
@@ -76,14 +76,20 @@ func (s *CliError) MarshalJSON() ([]byte, error) {
 		type emptyRes struct{}
 		return json.Marshal(&emptyRes{})
 	}
+
+	message := s.Message
+	if message == "" && s.Err != nil {
+		message = s.Err.Error()
+	}
+
 	type tmpRes struct {
-		Message string `json:"message"`
-		Error   error  `json:"error"`
-		Details string `json:"details"`
-		Hint    string `json:"hint"`
+		Message string `json:"message,omitempty"`
+		Error   error  `json:"error,omitempty"`
+		Details string `json:"details,omitempty"`
+		Hint    string `json:"hint,omitempty"`
 	}
 	return json.Marshal(&tmpRes{
-		Message: s.Message,
+		Message: message,
 		Error:   s.Err,
 		Details: s.Details,
 		Hint:    s.Hint,
diff --git a/internal/e2e/testdata/test-human-create-invalid-boolean.golden b/internal/e2e/testdata/test-human-create-invalid-boolean.golden
@@ -6,8 +6,7 @@ Hint:
 Possible values: true, false
 🟥🟥🟥 JSON STDERR 🟥🟥🟥
 {
-  "message": "",
+  "message": "invalid value for 'is-happy' argument: invalid boolean value",
   "error": {},
-  "details": "",
   "hint": "Possible values: true, false"
 }
diff --git a/internal/e2e/testdata/test-human-get-invalid-arg-name.golden b/internal/e2e/testdata/test-human-get-invalid-arg-name.golden
@@ -6,8 +6,7 @@ Hint:
 Valid arguments are: human-id, region
 🟥🟥🟥 JSON STDERR 🟥🟥🟥
 {
-  "message": "",
+  "message": "unknown argument 'invalid'",
   "error": {},
-  "details": "",
   "hint": "Valid arguments are: human-id, region"
 }
diff --git a/internal/e2e/testdata/test-human-get-pass-human-uuid-without-arg.golden b/internal/e2e/testdata/test-human-get-pass-human-uuid-without-arg.golden
@@ -7,7 +7,5 @@ Cannot find resource 'human' with ID '11111111-1111-1111-1111-111111111111'
   "error": {
     "resource": "human",
     "resource_id": "11111111-1111-1111-1111-111111111111"
-  },
-  "details": "",
-  "hint": ""
+  }
 }
diff --git a/internal/e2e/testdata/test-sdk-standard-errors-out-of-stock.golden b/internal/e2e/testdata/test-sdk-standard-errors-out-of-stock.golden
@@ -10,6 +10,5 @@ Try again later :-)
   "error": {
     "resource": "ShoeSize60"
   },
-  "details": "",
   "hint": "Try again later :-)"
 }
diff --git a/internal/e2e/testdata/test-sdk-standard-errors-resource-not-found.golden b/internal/e2e/testdata/test-sdk-standard-errors-resource-not-found.golden
@@ -6,8 +6,7 @@ Hint:
 Try running: scw test human get 0194fdc2-fa2f-fcc0-41d3-ff12045b73c8 region=fr-par
 🟥🟥🟥 JSON STDERR 🟥🟥🟥
 {
-  "message": "",
+  "message": "a positional argument is required for this command",
   "error": {},
-  "details": "",
   "hint": "Try running: scw test human get 0194fdc2-fa2f-fcc0-41d3-ff12045b73c8 region=fr-par"
 }
diff --git a/internal/e2e/testdata/test-sdk-standard-errors-transient-state.golden b/internal/e2e/testdata/test-sdk-standard-errors-transient-state.golden
@@ -6,8 +6,7 @@ Hint:
 Try running: scw test human update 0194fdc2-fa2f-fcc0-41d3-ff12045b73c8 eyes-color=red region=fr-par
 🟥🟥🟥 JSON STDERR 🟥🟥🟥
 {
-  "message": "",
+  "message": "a positional argument is required for this command",
   "error": {},
-  "details": "",
   "hint": "Try running: scw test human update 0194fdc2-fa2f-fcc0-41d3-ff12045b73c8 eyes-color=red region=fr-par"
 }
diff --git a/internal/namespaces/baremetal/v1/testdata/test-reboot-server-errors-error-cannot-be-rebooted-while-not-delivered.golden b/internal/namespaces/baremetal/v1/testdata/test-reboot-server-errors-error-cannot-be-rebooted-while-not-delivered.golden
@@ -6,7 +6,5 @@ Server is not delivered
   "message": "server is not delivered",
   "error": {
     "message": "server is not delivered"
-  },
-  "details": "",
-  "hint": ""
+  }
 }
diff --git a/internal/namespaces/baremetal/v1/testdata/test-start-server-errors-error-cannot-be-started-while-not-delivered.golden b/internal/namespaces/baremetal/v1/testdata/test-start-server-errors-error-cannot-be-started-while-not-delivered.golden
@@ -6,7 +6,5 @@ Server is not delivered
   "message": "server is not delivered",
   "error": {
     "message": "server is not delivered"
-  },
-  "details": "",
-  "hint": ""
+  }
 }
diff --git a/internal/namespaces/baremetal/v1/testdata/test-stop-server-errors-error-cannot-be-stopped-while-not-delivered.golden b/internal/namespaces/baremetal/v1/testdata/test-stop-server-errors-error-cannot-be-stopped-while-not-delivered.golden
@@ -6,7 +6,5 @@ Server is not delivered
   "message": "server is not delivered",
   "error": {
     "message": "server is not delivered"
-  },
-  "details": "",
-  "hint": ""
+  }
 }
diff --git a/internal/namespaces/config/testdata/test-config-delete-profile-command-unknown-profile.golden b/internal/namespaces/config/testdata/test-config-delete-profile-command-unknown-profile.golden
@@ -3,8 +3,6 @@
 No profile named test
 🟥🟥🟥 JSON STDERR 🟥🟥🟥
 {
-  "message": "",
-  "error": {},
-  "details": "",
-  "hint": ""
+  "message": "no profile named test",
+  "error": {}
 }
diff --git a/internal/namespaces/config/testdata/test-config-get-command-unknown-profile.golden b/internal/namespaces/config/testdata/test-config-get-command-unknown-profile.golden
@@ -3,8 +3,6 @@
 No profile named test
 🟥🟥🟥 JSON STDERR 🟥🟥🟥
 {
-  "message": "",
-  "error": {},
-  "details": "",
-  "hint": ""
+  "message": "no profile named test",
+  "error": {}
 }
diff --git a/internal/namespaces/config/testdata/test-config-unset-command-unknown-profile.golden b/internal/namespaces/config/testdata/test-config-unset-command-unknown-profile.golden
@@ -3,8 +3,6 @@
 No profile named test
 🟥🟥🟥 JSON STDERR 🟥🟥🟥
 {
-  "message": "",
-  "error": {},
-  "details": "",
-  "hint": ""
+  "message": "no profile named test",
+  "error": {}
 }
diff --git a/internal/namespaces/instance/v1/testdata/test-create-server-errors-error-disallow-existing-root-volume-id.golden b/internal/namespaces/instance/v1/testdata/test-create-server-errors-error-disallow-existing-root-volume-id.golden
@@ -6,8 +6,7 @@ Details:
 You must create an image of this volume and use its ID in the 'image' argument.
 🟥🟥🟥 JSON STDERR 🟥🟥🟥
 {
-  "message": "",
+  "message": "you cannot use an existing volume as a root volume",
   "error": {},
-  "details": "You must create an image of this volume and use its ID in the 'image' argument.",
-  "hint": ""
+  "details": "You must create an image of this volume and use its ID in the 'image' argument."
 }
diff --git a/internal/namespaces/instance/v1/testdata/test-create-server-errors-error-invalid-instance-type.golden b/internal/namespaces/instance/v1/testdata/test-create-server-errors-error-invalid-instance-type.golden
@@ -6,8 +6,7 @@ Hint:
 Accepted values for 'type' are [GP1-XS GP1-S GP1-M GP1-L GP1-XL DEV1-S DEV1-M DEV1-L DEV1-XL RENDER-S]
 🟥🟥🟥 JSON STDERR 🟥🟥🟥
 {
-  "message": "",
+  "message": "invalid value 'MACBOOK1-S' for arg 'type'",
   "error": {},
-  "details": "",
   "hint": "Accepted values for 'type' are [GP1-XS GP1-S GP1-M GP1-L GP1-XL DEV1-S DEV1-M DEV1-L DEV1-XL RENDER-S]"
 }
diff --git a/internal/namespaces/instance/v1/testdata/test-create-server-errors-error-invalid-root-volume-format.golden b/internal/namespaces/instance/v1/testdata/test-create-server-errors-error-invalid-root-volume-format.golden
@@ -6,8 +6,7 @@ Hint:
 You must provide either a UUID ("11111111-1111-1111-1111-111111111111"), a local volume size ("local:100G" or "l:100G") or a block volume size ("block:100G" or "b:100G").
 🟥🟥🟥 JSON STDERR 🟥🟥🟥
 {
-  "message": "",
+  "message": "invalid volume format '20GB'",
   "error": {},
-  "details": "",
   "hint": "You must provide either a UUID (\"11111111-1111-1111-1111-111111111111\"), a local volume size (\"local:100G\" or \"l:100G\") or a block volume size (\"block:100G\" or \"b:100G\")."
 }
diff --git a/internal/namespaces/instance/v1/testdata/test-create-server-errors-error-invalid-total-local-volumes-size-too-high3.golden b/internal/namespaces/instance/v1/testdata/test-create-server-errors-error-invalid-total-local-volumes-size-too-high3.golden
@@ -6,8 +6,7 @@ Details:
 You must create an image of this volume and use its ID in the 'image' argument.
 🟥🟥🟥 JSON STDERR 🟥🟥🟥
 {
-  "message": "",
+  "message": "you cannot use an existing volume as a root volume",
   "error": {},
-  "details": "You must create an image of this volume and use its ID in the 'image' argument.",
-  "hint": ""
+  "details": "You must create an image of this volume and use its ID in the 'image' argument."
 }
diff --git a/internal/namespaces/instance/v1/testdata/test-create-server-errors-error-missing-image-label.golden b/internal/namespaces/instance/v1/testdata/test-create-server-errors-error-missing-image-label.golden
@@ -3,8 +3,6 @@
 Missing required argument 'image'
 🟥🟥🟥 JSON STDERR 🟥🟥🟥
 {
-  "message": "",
-  "error": {},
-  "details": "",
-  "hint": ""
+  "message": "missing required argument 'image'",
+  "error": {}
 }
diff --git a/internal/namespaces/instance/v1/testdata/test-create-volume-bad-size-unit.golden b/internal/namespaces/instance/v1/testdata/test-create-volume-bad-size-unit.golden
@@ -3,8 +3,6 @@
 Invalid value for 'size' argument: size must be defined using the G or GB unit
 🟥🟥🟥 JSON STDERR 🟥🟥🟥
 {
-  "message": "",
-  "error": {},
-  "details": "",
-  "hint": ""
+  "message": "invalid value for 'size' argument: size must be defined using the G or GB unit",
+  "error": {}
 }
diff --git a/internal/namespaces/instance/v1/testdata/test-server-ssh-stopped-server.golden b/internal/namespaces/instance/v1/testdata/test-server-ssh-stopped-server.golden
@@ -6,8 +6,7 @@ Hint:
 Start the instance with: scw instance server start 4bf4ea6f-88a0-4b9b-bf08-9c4791bc29a2 --wait
 🟥🟥🟥 JSON STDERR 🟥🟥🟥
 {
-  "message": "",
+  "message": "server is not running",
   "error": {},
-  "details": "",
   "hint": "Start the instance with: scw instance server start 4bf4ea6f-88a0-4b9b-bf08-9c4791bc29a2 --wait"
 }
diff --git a/internal/namespaces/instance/v1/testdata/test-server-update-no-initial-placement-group&-placement-group-id=valid,-but-non-existing-pg-id.golden b/internal/namespaces/instance/v1/testdata/test-server-update-no-initial-placement-group&-placement-group-id=valid,-but-non-existing-pg-id.golden
@@ -7,7 +7,5 @@ Cannot find resource '' with ID '11111111-1111-1111-1111-111111111111'
   "error": {
     "resource": "",
     "resource_id": "11111111-1111-1111-1111-111111111111"
-  },
-  "details": "",
-  "hint": ""
+  }
 }
diff --git a/internal/namespaces/instance/v1/testdata/test-server-volume-update-attach-invalid-volume-uuid.golden b/internal/namespaces/instance/v1/testdata/test-server-volume-update-attach-invalid-volume-uuid.golden
@@ -7,7 +7,5 @@ Cannot find resource '' with ID '11111111-1111-1111-1111-111111111111'
   "error": {
     "resource": "",
     "resource_id": "11111111-1111-1111-1111-111111111111"
-  },
-  "details": "",
-  "hint": ""
+  }
 }
diff --git a/internal/namespaces/instance/v1/testdata/test-server-volume-update-detach-invalid-volume-uuid.golden b/internal/namespaces/instance/v1/testdata/test-server-volume-update-detach-invalid-volume-uuid.golden
@@ -7,7 +7,5 @@ Cannot find resource '' with ID '11111111-1111-1111-1111-111111111111'
   "error": {
     "resource": "",
     "resource_id": "11111111-1111-1111-1111-111111111111"
-  },
-  "details": "",
-  "hint": ""
+  }
 }

Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,7 @@ Hint:`
`6`	`6`	`Possible values: true, false`
`7`	`7`	`🟥🟥🟥 JSON STDERR 🟥🟥🟥`
`8`	`8`	`{`
`9`		`- "message": "",`
	`9`	`+ "message": "invalid value for 'is-happy' argument: invalid boolean value",`
`10`	`10`	`"error": {},`
`11`		`- "details": "",`
`12`	`11`	`"hint": "Possible values: true, false"`
`13`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,7 @@ Hint:`
`6`	`6`	`Valid arguments are: human-id, region`
`7`	`7`	`🟥🟥🟥 JSON STDERR 🟥🟥🟥`
`8`	`8`	`{`
`9`		`- "message": "",`
	`9`	`+ "message": "unknown argument 'invalid'",`
`10`	`10`	`"error": {},`
`11`		`- "details": "",`
`12`	`11`	`"hint": "Valid arguments are: human-id, region"`
`13`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,5 @@ Cannot find resource 'human' with ID '11111111-1111-1111-1111-111111111111'`
`7`	`7`	`"error": {`
`8`	`8`	`"resource": "human",`
`9`	`9`	`"resource_id": "11111111-1111-1111-1111-111111111111"`
`10`		`- },`
`11`		`- "details": "",`
`12`		`- "hint": ""`
	`10`	`+ }`
`13`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,5 @@ Try again later :-)`
`10`	`10`	`"error": {`
`11`	`11`	`"resource": "ShoeSize60"`
`12`	`12`	`},`
`13`		`- "details": "",`
`14`	`13`	`"hint": "Try again later :-)"`
`15`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,7 @@ Hint:`
`6`	`6`	`Try running: scw test human get 0194fdc2-fa2f-fcc0-41d3-ff12045b73c8 region=fr-par`
`7`	`7`	`🟥🟥🟥 JSON STDERR 🟥🟥🟥`
`8`	`8`	`{`
`9`		`- "message": "",`
	`9`	`+ "message": "a positional argument is required for this command",`
`10`	`10`	`"error": {},`
`11`		`- "details": "",`
`12`	`11`	`"hint": "Try running: scw test human get 0194fdc2-fa2f-fcc0-41d3-ff12045b73c8 region=fr-par"`
`13`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,8 +6,7 @@ Hint:`
`6`	`6`	`Try running: scw test human update 0194fdc2-fa2f-fcc0-41d3-ff12045b73c8 eyes-color=red region=fr-par`
`7`	`7`	`🟥🟥🟥 JSON STDERR 🟥🟥🟥`
`8`	`8`	`{`
`9`		`- "message": "",`
	`9`	`+ "message": "a positional argument is required for this command",`
`10`	`10`	`"error": {},`
`11`		`- "details": "",`
`12`	`11`	`"hint": "Try running: scw test human update 0194fdc2-fa2f-fcc0-41d3-ff12045b73c8 eyes-color=red region=fr-par"`
`13`	`12`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,5 @@ Server is not delivered`
`6`	`6`	`"message": "server is not delivered",`
`7`	`7`	`"error": {`
`8`	`8`	`"message": "server is not delivered"`
`9`		`- },`
`10`		`- "details": "",`
`11`		`- "hint": ""`
	`9`	`+ }`
`12`	`10`	`}`