rsponse 404 when delete not exist email (#15383)

fix #15357

Signed-off-by: a1012112796 <[email protected]>

Author: a1012112796

integrations/api_user_email_test.go

@@ -0,0 +1,105 @@
+// Copyright 2021 The Gitea Authors. All rights reserved.
+// Use of this source code is governed by a MIT-style
+// license that can be found in the LICENSE file.
+
+package integrations
+
+import (
+	"net/http"
+	"testing"
+
+	api "code.gitea.io/gitea/modules/structs"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestAPIListEmails(t *testing.T) {
+	defer prepareTestEnv(t)()
+
+	normalUsername := "user2"
+	session := loginUser(t, normalUsername)
+	token := getTokenForLoggedInUser(t, session)
+
+	req := NewRequest(t, "GET", "/api/v1/user/emails?token="+token)
+	resp := session.MakeRequest(t, req, http.StatusOK)
+
+	var emails []*api.Email
+	DecodeJSON(t, resp, &emails)
+
+	assert.EqualValues(t, []*api.Email{
+		{
+			Email:    "[email protected]",
+			Verified: true,
+			Primary:  true,
+		},
+		{
+			Email:    "[email protected]",
+			Verified: false,
+			Primary:  false,
+		},
+	}, emails)
+}
+
+func TestAPIAddEmail(t *testing.T) {
+	defer prepareTestEnv(t)()
+
+	normalUsername := "user2"
+	session := loginUser(t, normalUsername)
+	token := getTokenForLoggedInUser(t, session)
+
+	opts := api.CreateEmailOption{
+		Emails: []string{"[email protected]"},
+	}
+
+	req := NewRequestWithJSON(t, "POST", "/api/v1/user/emails?token="+token, &opts)
+	session.MakeRequest(t, req, http.StatusUnprocessableEntity)
+
+	opts = api.CreateEmailOption{
+		Emails: []string{"[email protected]"},
+	}
+	req = NewRequestWithJSON(t, "POST", "/api/v1/user/emails?token="+token, &opts)
+	resp := session.MakeRequest(t, req, http.StatusCreated)
+
+	var emails []*api.Email
+	DecodeJSON(t, resp, &emails)
+	assert.EqualValues(t, []*api.Email{
+		{
+			Email:    "[email protected]",
+			Verified: true,
+			Primary:  false,
+		},
+	}, emails)
+}
+
+func TestAPIDeleteEmail(t *testing.T) {
+	defer prepareTestEnv(t)()
+
+	normalUsername := "user2"
+	session := loginUser(t, normalUsername)
+	token := getTokenForLoggedInUser(t, session)
+
+	opts := api.DeleteEmailOption{
+		Emails: []string{"[email protected]"},
+	}
+	req := NewRequestWithJSON(t, "DELETE", "/api/v1/user/emails?token="+token, &opts)
+	session.MakeRequest(t, req, http.StatusNotFound)
+
+	opts = api.DeleteEmailOption{
+		Emails: []string{"[email protected]"},
+	}
+	req = NewRequestWithJSON(t, "DELETE", "/api/v1/user/emails?token="+token, &opts)
+	session.MakeRequest(t, req, http.StatusNoContent)
+
+	req = NewRequest(t, "GET", "/api/v1/user/emails?token="+token)
+	resp := session.MakeRequest(t, req, http.StatusOK)
+
+	var emails []*api.Email
+	DecodeJSON(t, resp, &emails)
+	assert.EqualValues(t, []*api.Email{
+		{
+			Email:    "[email protected]",
+			Verified: true,
+			Primary:  true,
+		},
+	}, emails)
+}

models/error.go

@@ -222,6 +222,21 @@ func (err ErrEmailInvalid) Error() string {
 	return fmt.Sprintf("e-mail invalid [email: %s]", err.Email)
 }
 
+// ErrEmailAddressNotExist email address not exist
+type ErrEmailAddressNotExist struct {
+	Email string
+}
+
+// IsErrEmailAddressNotExist checks if an error is an ErrEmailAddressNotExist
+func IsErrEmailAddressNotExist(err error) bool {
+	_, ok := err.(ErrEmailAddressNotExist)
+	return ok
+}
+
+func (err ErrEmailAddressNotExist) Error() string {
+	return fmt.Sprintf("Email address does not exist [email: %s]", err.Email)
+}
+
 // ErrOpenIDAlreadyUsed represents a "OpenIDAlreadyUsed" kind of error.
 type ErrOpenIDAlreadyUsed struct {
 	OpenID string

models/user_mail.go

@@ -6,7 +6,6 @@
 package models
 
 import (
-	"errors"
 	"fmt"
 	"net/mail"
 	"strings"
@@ -18,9 +17,6 @@ import (
 	"xorm.io/builder"
 )
 
-// ErrEmailAddressNotExist email address not exist
-var ErrEmailAddressNotExist = errors.New("Email address does not exist")
-
 // EmailAddress is the list of all email addresses of a user. Can contain the
 // primary email address, but is not obligatory.
 type EmailAddress struct {
@@ -243,7 +239,7 @@ func DeleteEmailAddress(email *EmailAddress) (err error) {
 	if err != nil {
 		return err
 	} else if deleted != 1 {
-		return ErrEmailAddressNotExist
+		return ErrEmailAddressNotExist{Email: email.Email}
 	}
 	return nil
 }

routers/api/v1/user/email.go

@@ -111,6 +111,8 @@ func DeleteEmail(ctx *context.APIContext) {
 	// responses:
 	//   "204":
 	//     "$ref": "#/responses/empty"
+	//   "404":
+	//     "$ref": "#/responses/notFound"
 	form := web.GetForm(ctx).(*api.DeleteEmailOption)
 	if len(form.Emails) == 0 {
 		ctx.Status(http.StatusNoContent)
@@ -126,6 +128,10 @@ func DeleteEmail(ctx *context.APIContext) {
 	}
 
 	if err := models.DeleteEmailAddresses(emails); err != nil {
+		if models.IsErrEmailAddressNotExist(err) {
+			ctx.Error(http.StatusNotFound, "DeleteEmailAddresses", err)
+			return
+		}
 		ctx.Error(http.StatusInternalServerError, "DeleteEmailAddresses", err)
 		return
 	}

templates/swagger/v1_json.tmpl

@@ -10221,6 +10221,9 @@
         "responses": {
           "204": {
             "$ref": "#/responses/empty"
+          },
+          "404": {
+            "$ref": "#/responses/notFound"
           }
         }
       }