From 560744fb3399b33b8006e5a6a54a473696cc5b34 Mon Sep 17 00:00:00 2001 From: 6543 <6543@obermui.de> Date: Thu, 28 May 2020 23:25:54 +0200 Subject: [PATCH] Handle expected errors in AddGPGkey API (#11644) * handle GPG Parse & Email Errors * correct TEST * update Swagger * more Docu --- integrations/api_gpg_keys_test.go | 2 +- models/gpg_key.go | 2 +- routers/api/v1/user/gpg_key.go | 12 ++++++++++-- templates/swagger/v1_json.tmpl | 6 ++++++ 4 files changed, 18 insertions(+), 4 deletions(-) diff --git a/integrations/api_gpg_keys_test.go b/integrations/api_gpg_keys_test.go index edae22205e..e664c3c256 100644 --- a/integrations/api_gpg_keys_test.go +++ b/integrations/api_gpg_keys_test.go @@ -32,7 +32,7 @@ func TestGPGKeys(t *testing.T) { results: []int{http.StatusUnauthorized, http.StatusUnauthorized, http.StatusUnauthorized, http.StatusUnauthorized, http.StatusUnauthorized, http.StatusUnauthorized, http.StatusUnauthorized, http.StatusUnauthorized}, }, {name: "LoggedAsUser2", makeRequest: session.MakeRequest, token: token, - results: []int{http.StatusOK, http.StatusOK, http.StatusNotFound, http.StatusNoContent, http.StatusInternalServerError, http.StatusInternalServerError, http.StatusCreated, http.StatusCreated}}, + results: []int{http.StatusOK, http.StatusOK, http.StatusNotFound, http.StatusNoContent, http.StatusUnprocessableEntity, http.StatusNotFound, http.StatusCreated, http.StatusCreated}}, } for _, tc := range tt { diff --git a/models/gpg_key.go b/models/gpg_key.go index a32312a12d..bebd33191a 100644 --- a/models/gpg_key.go +++ b/models/gpg_key.go @@ -273,7 +273,7 @@ func parseGPGKey(ownerID int64, e *openpgp.Entity) (*GPGKey, error) { for i, k := range e.Subkeys { subs, err := parseSubGPGKey(ownerID, pubkey.KeyIdString(), k.PublicKey, expiry) if err != nil { - return nil, err + return nil, ErrGPGKeyParsing{ParseError: err} } subkeys[i] = subs } diff --git a/routers/api/v1/user/gpg_key.go b/routers/api/v1/user/gpg_key.go index a4f6d0e924..d5fed96df1 100644 --- a/routers/api/v1/user/gpg_key.go +++ b/routers/api/v1/user/gpg_key.go @@ -144,6 +144,8 @@ func CreateGPGKey(ctx *context.APIContext, form api.CreateGPGKeyOption) { // responses: // "201": // "$ref": "#/responses/GPGKey" + // "404": + // "$ref": "#/responses/notFound" // "422": // "$ref": "#/responses/validationError" @@ -169,6 +171,8 @@ func DeleteGPGKey(ctx *context.APIContext) { // "$ref": "#/responses/empty" // "403": // "$ref": "#/responses/forbidden" + // "404": + // "$ref": "#/responses/notFound" if err := models.DeleteGPGKey(ctx.User, ctx.ParamsInt64(":id")); err != nil { if models.IsErrGPGKeyAccessDenied(err) { @@ -186,9 +190,13 @@ func DeleteGPGKey(ctx *context.APIContext) { func HandleAddGPGKeyError(ctx *context.APIContext, err error) { switch { case models.IsErrGPGKeyAccessDenied(err): - ctx.Error(http.StatusUnprocessableEntity, "", "You do not have access to this GPG key") + ctx.Error(http.StatusUnprocessableEntity, "GPGKeyAccessDenied", "You do not have access to this GPG key") case models.IsErrGPGKeyIDAlreadyUsed(err): - ctx.Error(http.StatusUnprocessableEntity, "", "A key with the same id already exists") + ctx.Error(http.StatusUnprocessableEntity, "GPGKeyIDAlreadyUsed", "A key with the same id already exists") + case models.IsErrGPGKeyParsing(err): + ctx.Error(http.StatusUnprocessableEntity, "GPGKeyParsing", err) + case models.IsErrGPGNoEmailFound(err): + ctx.Error(http.StatusNotFound, "GPGNoEmailFound", err) default: ctx.Error(http.StatusInternalServerError, "AddGPGKey", err) } diff --git a/templates/swagger/v1_json.tmpl b/templates/swagger/v1_json.tmpl index b7fa714a64..0cbe33bd24 100644 --- a/templates/swagger/v1_json.tmpl +++ b/templates/swagger/v1_json.tmpl @@ -9105,6 +9105,9 @@ "201": { "$ref": "#/responses/GPGKey" }, + "404": { + "$ref": "#/responses/notFound" + }, "422": { "$ref": "#/responses/validationError" } @@ -9165,6 +9168,9 @@ }, "403": { "$ref": "#/responses/forbidden" + }, + "404": { + "$ref": "#/responses/notFound" } } }