SDK error revamp (#432)

SDK methods now return 1 error.  To differentiate between Client errors and Server errors I've also implemented the AsServerError function which returns an *api.Error if it is an error originating from the remote server or nil otherwise.
This commit is contained in:
Todd Knight authored and GitHub committed 2020-09-24 14:34:58 -07:00
1 parent 94f9d952be
commit fd0da998e8
53 files changed
+1512 -1635

No files matched your search

+34 -43
View File
@@ -25,16 +25,14 @@ func TestList(t *testing.T) {
client.SetToken(token.Token)
_, proj := iam.TestScopes(t, tc.IamRepo(), iam.WithUserId(token.UserId))
hc, apiErr, err := hostcatalogs.NewClient(client).Create(tc.Context(), "static", proj.GetPublicId())
hc, err := hostcatalogs.NewClient(client).Create(tc.Context(), "static", proj.GetPublicId())
require.NoError(err)
require.Nil(apiErr)
require.NotNil(hc)
hClient := hosts.NewClient(client)
ul, apiErr, err := hClient.List(tc.Context(), hc.Item.Id)
ul, err := hClient.List(tc.Context(), hc.Item.Id)
assert.NoError(err)
assert.Nil(apiErr)
assert.Empty(ul.Items)
var expected []*hosts.Host
@@ -42,25 +40,21 @@ func TestList(t *testing.T) {
expected = append(expected, &hosts.Host{Name: fmt.Sprint(i)})
}
hcr, apiErr, err := hClient.Create(tc.Context(), hc.Item.Id, hosts.WithName(expected[0].Name), hosts.WithStaticHostAddress("someaddress"))
hcr, err := hClient.Create(tc.Context(), hc.Item.Id, hosts.WithName(expected[0].Name), hosts.WithStaticHostAddress("someaddress"))
assert.NoError(err)
assert.Nil(apiErr)
expected[0] = hcr.Item
ul, apiErr, err = hClient.List(tc.Context(), hc.Item.Id)
ul, err = hClient.List(tc.Context(), hc.Item.Id)
assert.NoError(err)
assert.Nil(apiErr)
assert.ElementsMatch(comparableHostSlice(expected[:1]), comparableHostSlice(ul.Items))
for i := 1; i < 10; i++ {
hcr, apiErr, err = hClient.Create(tc.Context(), hc.Item.Id, hosts.WithName(expected[i].Name), hosts.WithStaticHostAddress("someaddress"))
hcr, err = hClient.Create(tc.Context(), hc.Item.Id, hosts.WithName(expected[i].Name), hosts.WithStaticHostAddress("someaddress"))
assert.NoError(err)
assert.Nil(apiErr)
expected[i] = hcr.Item
}
ul, apiErr, err = hClient.List(tc.Context(), hc.Item.Id)
ul, err = hClient.List(tc.Context(), hc.Item.Id)
require.NoError(err)
assert.Nil(apiErr)
assert.ElementsMatch(comparableHostSlice(expected), comparableHostSlice(ul.Items))
}
@@ -89,16 +83,12 @@ func TestCrud(t *testing.T) {
client.SetToken(token.Token)
_, proj := iam.TestScopes(t, tc.IamRepo(), iam.WithUserId(token.UserId))
hc, apiErr, err := hostcatalogs.NewClient(client).Create(tc.Context(), "static", proj.GetPublicId())
hc, err := hostcatalogs.NewClient(client).Create(tc.Context(), "static", proj.GetPublicId())
require.NoError(err)
require.Nil(apiErr)
require.NotNil(hc)
checkHost := func(step string, h *hosts.Host, apiErr *api.Error, err error, wantedName string, wantVersion uint32) {
checkHost := func(step string, h *hosts.Host, err error, wantedName string, wantVersion uint32) {
require.NoError(err, step)
if !assert.Nil(apiErr, step) && apiErr.Message != "" {
t.Errorf("ApiError message: %q", apiErr.Message)
}
assert.NotNil(h, "returned no resource", step)
gotName := ""
if h.Name != "" {
@@ -110,29 +100,28 @@ func TestCrud(t *testing.T) {
hClient := hosts.NewClient(client)
h, apiErr, err := hClient.Create(tc.Context(), hc.Item.Id, hosts.WithName("foo"), hosts.WithStaticHostAddress("someaddress"))
checkHost("create", h.Item, apiErr, err, "foo", 1)
h, err := hClient.Create(tc.Context(), hc.Item.Id, hosts.WithName("foo"), hosts.WithStaticHostAddress("someaddress"))
checkHost("create", h.Item, err, "foo", 1)
h, apiErr, err = hClient.Read(tc.Context(), h.Item.Id)
checkHost("read", h.Item, apiErr, err, "foo", 1)
h, err = hClient.Read(tc.Context(), h.Item.Id)
checkHost("read", h.Item, err, "foo", 1)
h, apiErr, err = hClient.Update(tc.Context(), h.Item.Id, h.Item.Version, hosts.WithName("bar"))
checkHost("update", h.Item, apiErr, err, "bar", 2)
h, err = hClient.Update(tc.Context(), h.Item.Id, h.Item.Version, hosts.WithName("bar"))
checkHost("update", h.Item, err, "bar", 2)
h, apiErr, err = hClient.Update(tc.Context(), h.Item.Id, h.Item.Version, hosts.DefaultName())
checkHost("update", h.Item, apiErr, err, "", 3)
h, err = hClient.Update(tc.Context(), h.Item.Id, h.Item.Version, hosts.DefaultName())
checkHost("update", h.Item, err, "", 3)
_, apiErr, err = hClient.Delete(tc.Context(), h.Item.Id)
_, err = hClient.Delete(tc.Context(), h.Item.Id)
assert.NoError(err)
assert.Nil(apiErr)
_, apiErr, err = hClient.Delete(tc.Context(), h.Item.Id)
require.NoError(err)
_, err = hClient.Delete(tc.Context(), h.Item.Id)
require.Error(err)
apiErr := api.AsServerError(err)
assert.NotNil(apiErr)
assert.EqualValues(http.StatusNotFound, apiErr.Status)
}
// TODO: Get better coverage for expected errors and error formats.
func TestErrors(t *testing.T) {
assert, require := assert.New(t), require.New(t)
tc := controller.NewTestController(t, nil)
@@ -143,35 +132,37 @@ func TestErrors(t *testing.T) {
client.SetToken(token.Token)
_, proj := iam.TestScopes(t, tc.IamRepo(), iam.WithUserId(token.UserId))
hc, apiErr, err := hostcatalogs.NewClient(client).Create(tc.Context(), "static", proj.GetPublicId())
hc, err := hostcatalogs.NewClient(client).Create(tc.Context(), "static", proj.GetPublicId())
require.NoError(err)
require.Nil(apiErr)
require.NotNil(hc)
hClient := hosts.NewClient(client)
h, apiErr, err := hClient.Create(tc.Context(), hc.Item.Id, hosts.WithName("foo"), hosts.WithStaticHostAddress("someaddress"))
h, err := hClient.Create(tc.Context(), hc.Item.Id, hosts.WithName("foo"), hosts.WithStaticHostAddress("someaddress"))
require.NoError(err)
require.Nil(apiErr)
assert.NotNil(h)
// Updating the wrong version should fail.
_, apiErr, err = hClient.Update(tc.Context(), h.Item.Id, 73, hosts.WithName("anything"))
require.NoError(err)
_, err = hClient.Update(tc.Context(), h.Item.Id, 73, hosts.WithName("anything"))
require.Error(err)
apiErr := api.AsServerError(err)
assert.NotNil(apiErr)
assert.EqualValues(http.StatusNotFound, apiErr.Status)
_, apiErr, err = hClient.Create(tc.Context(), hc.Item.Id, hosts.WithName("foo"), hosts.WithStaticHostAddress("someaddress"))
require.NoError(err)
_, err = hClient.Create(tc.Context(), hc.Item.Id, hosts.WithName("foo"), hosts.WithStaticHostAddress("someaddress"))
require.Error(err)
apiErr = api.AsServerError(err)
assert.NotNil(apiErr)
_, apiErr, err = hClient.Read(tc.Context(), static.HostPrefix+"_doesntexis")
require.NoError(err)
_, err = hClient.Read(tc.Context(), static.HostPrefix+"_doesntexis")
require.Error(err)
apiErr = api.AsServerError(err)
assert.NotNil(apiErr)
assert.EqualValues(http.StatusNotFound, apiErr.Status)
_, apiErr, err = hClient.Read(tc.Context(), "invalid id")
require.NoError(err)
_, err = hClient.Read(tc.Context(), "invalid id")
require.Error(err)
apiErr = api.AsServerError(err)
assert.NotNil(apiErr)
assert.EqualValues(http.StatusBadRequest, apiErr.Status)
}