feat(app/list): add a parameter to return all app information (#2533)

Co-authored-by: Denis Aoki <[email protected]>
tsuru · Feb 8, 2022 · c3e3d08 · c3e3d08
1 parent 481e9e0
commit c3e3d08
Show file tree

Hide file tree

Showing 2 changed files with 80 additions and 14 deletions.
diff --git a/api/app.go b/api/app.go
@@ -128,20 +128,23 @@ func appDelete(w http.ResponseWriter, r *http.Request, t auth.Token) (err error)
 // miniApp is a minimal representation of the app, created to make appList
 // faster and transmit less data.
 type miniApp struct {
-	Name      string               `json:"name"`
-	Pool      string               `json:"pool"`
-	TeamOwner string               `json:"teamowner"`
-	Plan      appTypes.Plan        `json:"plan"`
-	Units     []provision.Unit     `json:"units"`
-	CName     []string             `json:"cname"`
-	IP        string               `json:"ip"`
-	Routers   []appTypes.AppRouter `json:"routers"`
-	Lock      appTypes.AppLock     `json:"lock"`
-	Tags      []string             `json:"tags"`
-	Error     string               `json:"error,omitempty"`
+	Name        string               `json:"name"`
+	Pool        string               `json:"pool"`
+	TeamOwner   string               `json:"teamowner"`
+	Plan        appTypes.Plan        `json:"plan"`
+	Units       []provision.Unit     `json:"units"`
+	CName       []string             `json:"cname"`
+	IP          string               `json:"ip"`
+	Routers     []appTypes.AppRouter `json:"routers"`
+	Lock        appTypes.AppLock     `json:"lock"`
+	Tags        []string             `json:"tags"`
+	Error       string               `json:"error,omitempty"`
+	Platform    string               `json:"platform,omitempty"`
+	Description string               `json:"description,omitempty"`
+	Metadata    appTypes.Metadata    `json:"metadata,omitempty"`
 }
 
-func minifyApp(app app.App, unitData app.AppUnitsResponse) (miniApp, error) {
+func minifyApp(app app.App, unitData app.AppUnitsResponse, extended bool) (miniApp, error) {
 	var errorStr string
 	if unitData.Err != nil {
 		errorStr = unitData.Err.Error()
@@ -164,6 +167,11 @@ func minifyApp(app app.App, unitData app.AppUnitsResponse) (miniApp, error) {
 	if len(ma.Routers) > 0 {
 		ma.IP = ma.Routers[0].Address
 	}
+	if extended {
+		ma.Platform = app.Platform
+		ma.Description = app.Description
+		ma.Metadata = app.Metadata
+	}
 	return ma, nil
 }
 
@@ -238,12 +246,13 @@ func appList(w http.ResponseWriter, r *http.Request, t auth.Token) error {
 		return nil
 	}
 	simple, _ := strconv.ParseBool(r.URL.Query().Get("simplified"))
+	extended, _ := strconv.ParseBool(r.URL.Query().Get("extended"))
 	w.Header().Set("Content-Type", "application/json")
 	miniApps := make([]miniApp, len(apps))
 	if simple {
 		for i, ap := range apps {
 			ur := app.AppUnitsResponse{Units: nil, Err: nil}
-			miniApps[i], err = minifyApp(ap, ur)
+			miniApps[i], err = minifyApp(ap, ur, extended)
 			if err != nil {
 				return err
 			}
@@ -254,8 +263,9 @@ func appList(w http.ResponseWriter, r *http.Request, t auth.Token) error {
 	if err != nil {
 		return err
 	}
+
 	for i, app := range apps {
-		miniApps[i], err = minifyApp(app, appUnits[app.Name])
+		miniApps[i], err = minifyApp(app, appUnits[app.Name], extended)
 		if err != nil {
 			return err
 		}

diff --git a/api/app_test.go b/api/app_test.go
@@ -433,12 +433,68 @@ func (s *S) TestSimplifiedAppList(c *check.C) {
 	c.Assert(err, check.IsNil)
 	c.Assert(apps, check.HasLen, 2)
 	c.Assert(apps[0].Name, check.Equals, app1.Name)
+	c.Assert(apps[0].Platform, check.Equals, "")
 	app1u, _ := apps[0].Units()
 	c.Assert(app1u, check.HasLen, 0)
 	c.Assert(apps[1].Name, check.Equals, app2.Name)
 	c.Assert(app1u, check.HasLen, 0)
 }
 
+func (s *S) TestExtendedAppList(c *check.C) {
+	p := pool.Pool{Name: "pool1"}
+	opts := pool.AddPoolOptions{Name: p.Name, Public: true}
+	err := pool.AddPool(context.TODO(), opts)
+	c.Assert(err, check.IsNil)
+	app1 := app.App{
+		Name:        "app1",
+		Platform:    "zend",
+		Description: "app1",
+		TeamOwner:   s.team.Name,
+		CName:       []string{"cname.app1"},
+		Pool:        "pool1",
+		Tags:        []string{},
+	}
+	err = app.CreateApp(context.TODO(), &app1, s.user)
+	c.Assert(err, check.IsNil)
+	acquireDate := time.Date(2015, time.February, 12, 12, 3, 0, 0, time.Local)
+	app2 := app.App{
+		Name:        "app2",
+		Platform:    "zend",
+		Description: "app2",
+		TeamOwner:   s.team.Name,
+		CName:       []string{"cname.app2"},
+		Pool:        "pool1",
+		Lock: appTypes.AppLock{
+			Locked:      true,
+			Reason:      "wanted",
+			Owner:       s.user.Email,
+			AcquireDate: acquireDate,
+		},
+		Tags: []string{"a"},
+	}
+	err = app.CreateApp(context.TODO(), &app2, s.user)
+	c.Assert(err, check.IsNil)
+	request, err := http.NewRequest("GET", "/apps?extended=true", nil)
+	c.Assert(err, check.IsNil)
+	request.Header.Set("Content-Type", "application/json")
+	request.Header.Set("Authorization", "b "+s.token.GetValue())
+	recorder := httptest.NewRecorder()
+	s.testServer.ServeHTTP(recorder, request)
+	c.Assert(recorder.Code, check.Equals, http.StatusOK)
+	c.Assert(recorder.Header().Get("Content-Type"), check.Equals, "application/json")
+	var apps []app.App
+	err = json.Unmarshal(recorder.Body.Bytes(), &apps)
+	c.Assert(err, check.IsNil)
+	c.Assert(apps, check.HasLen, 2)
+	c.Assert(apps[0].Name, check.Equals, app1.Name)
+	c.Assert(apps[0].Description, check.Equals, app1.Description)
+	c.Assert(apps[0].Platform, check.Equals, app1.Platform)
+	app1u, _ := apps[0].Units()
+	c.Assert(app1u, check.HasLen, 0)
+	c.Assert(apps[1].Name, check.Equals, app2.Name)
+	c.Assert(apps[1].Description, check.Equals, app2.Description)
+}
+
 func (s *S) TestAppList(c *check.C) {
 	p := pool.Pool{Name: "pool1"}
 	opts := pool.AddPoolOptions{Name: p.Name, Public: true}