From 27cd1908ef48c1267c3bf84788b7fc52c6457c3c Mon Sep 17 00:00:00 2001
From: zzxwill <zzxwill@gmail.com>
Date: Tue, 18 Aug 2020 19:48:31 +0800
Subject: [PATCH] Fix api response for error cases

when hitting issue, the response struct should be the same as
normal response as below.
```
type Response struct {
	Code int         `json:"code"`
	Data interface{} `json:"data"`
}
```
Fix #169
---
 e2e/apiserver/apiserver_test.go   | 24 ++++++++++++++++++++++++
 pkg/oam/env.go                    |  2 +-
 pkg/server/handler/appHandlers.go |  1 +
 pkg/server/util/errors.go         |  3 ++-
 4 files changed, 28 insertions(+), 2 deletions(-)

diff --git a/e2e/apiserver/apiserver_test.go b/e2e/apiserver/apiserver_test.go
index 42a3b5651..1054ffa11 100644
--- a/e2e/apiserver/apiserver_test.go
+++ b/e2e/apiserver/apiserver_test.go
@@ -29,7 +29,13 @@ var envWorldMeta = types.EnvMeta{
 	Namespace: "env-e2e-world",
 }
 
+var notExistedEnvMeta = types.EnvMeta{
+	Name:      "env-e2e-api-NOT-EXISTED-JUST-FOR-TEST",
+	Namespace: "env-e2e-api-NOT-EXISTED-JUST-FOR-TEST",
+}
+
 var _ = ginkgo.Describe("API Env", func() {
+	//API Env
 	e2e.APIEnvInitContext("post /envs/", envHelloMeta)
 
 	ginkgo.Context("get /envs/:envName", func() {
@@ -94,4 +100,22 @@ var _ = ginkgo.Describe("API Env", func() {
 			gomega.Expect(r.Data.(string)).To(gomega.ContainSubstring(envWorldMeta.Name + " deleted"))
 		})
 	})
+
+	// API Application
+	ginkgo.Context("get /envs/:envName/apps/", func() {
+		ginkgo.It("should report error for not existed env", func() {
+			envName := notExistedEnvMeta.Name
+			url := fmt.Sprintf("/envs/%s/apps/", envName)
+			resp, err := http.Get(util.URL(url))
+			gomega.Expect(err).NotTo(gomega.HaveOccurred())
+			defer resp.Body.Close()
+			result, err := ioutil.ReadAll(resp.Body)
+			gomega.Expect(err).NotTo(gomega.HaveOccurred())
+			var r apis.Response
+			err = json.Unmarshal(result, &r)
+			gomega.Expect(http.StatusInternalServerError).To(gomega.Equal(r.Code))
+			expectedContent := fmt.Sprintf("env %s not exist", envName)
+			gomega.Expect(r.Data.(string)).To(gomega.ContainSubstring(expectedContent))
+		})
+	})
 })
diff --git a/pkg/oam/env.go b/pkg/oam/env.go
index 771976dba..5b7cfa7f9 100644
--- a/pkg/oam/env.go
+++ b/pkg/oam/env.go
@@ -24,7 +24,7 @@ func GetEnvByName(name string) (*types.EnvMeta, error) {
 	data, err := ioutil.ReadFile(filepath.Join(system.GetEnvDirByName(name), system.EnvConfigName))
 	if err != nil {
 		if os.IsNotExist(err) {
-			return nil, fmt.Errorf("%s not exist", name)
+			return nil, fmt.Errorf("env %s not exist", name)
 		}
 		return nil, err
 	}
diff --git a/pkg/server/handler/appHandlers.go b/pkg/server/handler/appHandlers.go
index c2c337290..592cb996e 100644
--- a/pkg/server/handler/appHandlers.go
+++ b/pkg/server/handler/appHandlers.go
@@ -40,6 +40,7 @@ func ListApps(c *gin.Context) {
 	envMeta, err := oam.GetEnvByName(envName)
 	if err != nil {
 		util.HandleError(c, util.StatusInternalServerError, err)
+		return
 	}
 	namespace := envMeta.Namespace
 
diff --git a/pkg/server/util/errors.go b/pkg/server/util/errors.go
index a5ee2f14b..82de26c75 100644
--- a/pkg/server/util/errors.go
+++ b/pkg/server/util/errors.go
@@ -78,5 +78,6 @@ func SetErrorAndAbort(c *gin.Context, code Code, msg ...interface{}) {
 }
 
 func HandleError(c *gin.Context, code Code, msg ...interface{}) {
-	c.JSON(code.StatusCode(), gin.H{"error": ConstructError(code, msg...).Error()})
+	err := ConstructError(code, msg...)
+	AssembleResponse(c, nil, err)
 }