Invalid Argument errors provide per field details. (#110)

* Invalid Argument errors now return a per field error message.

* Creating an API error struct.

* SDK uses field error details proto.

* Adding tests specifically for handler helper error messages resulting in expected API output.

* Inlining the error checks into the table driven tests.  Use protocmp for assertions to make printing out diffs easier to parse.

* Aggregate the invalid argument fields detected to be wrong.

* Make the returned order of fields deterministic in the error details..

* Fixing formatting issue in errors_test.go.

* Test to confirm unimplemented results in a 405 and not 404.
This commit is contained in:
Todd Knight authored and GitHub committed 2020-06-09 10:51:50 -07:00
1 parent 5333482ff8
commit 2c3fbe3024
10 files changed
+317 -186

No files matched your search

+3 -3
View File
@@ -12,9 +12,9 @@ import (
type ErrorDetails struct {
defaultFields []string
TraceId *string `json:"TraceId,omitempty"`
RequestId *string `json:"request_id,omitempty"`
RequestFields []string `json:"request_fields,omitempty"`
TraceId *string `json:"TraceId,omitempty"`
RequestId *string `json:"request_id,omitempty"`
RequestFields []*FieldError `json:"request_fields,omitempty"`
}
func (s *ErrorDetails) SetDefault(key string) {
+36
View File
@@ -0,0 +1,36 @@
// Code generated by "make api"; DO NOT EDIT.
package api
import (
"encoding/json"
"github.com/fatih/structs"
"github.com/hashicorp/watchtower/api/internal/strutil"
)
type FieldError struct {
defaultFields []string
Name *string `json:"name,omitempty"`
Description *string `json:"description,omitempty"`
}
func (s *FieldError) SetDefault(key string) {
s.defaultFields = strutil.AppendIfMissing(s.defaultFields, key)
}
func (s *FieldError) UnsetDefault(key string) {
s.defaultFields = strutil.StrListDelete(s.defaultFields, key)
}
func (s FieldError) MarshalJSON() ([]byte, error) {
m := structs.Map(s)
if m == nil {
m = make(map[string]interface{})
}
for _, k := range s.defaultFields {
m[k] = nil
}
return json.Marshal(m)
}
+11
View File
@@ -37,6 +37,17 @@ var inputStructs = []*structInfo{
"",
templateTypeResource,
},
{
os.Getenv("GEN_BASEPATH") + "/internal/gen/controller/api/error.pb.go",
"FieldError",
os.Getenv("GEN_BASEPATH") + "/api/field_error.gen.go",
"FieldError",
"api",
"",
"",
"",
templateTypeResource,
},
{
os.Getenv("GEN_BASEPATH") + "/internal/gen/controller/api/resources/hosts/host.pb.go",
"Host",