APPS-985 Return map of all backups (#48)

* add validation for storage path * Make filter by policy optional in the /backup/full/list endpoint * update swag spec * add tests * indentation * pre-allocate * pre-allocate
aerospike · Nov 12, 2023 · 20412c8 · 20412c8
1 parent d4ad103
commit 20412c8
Show file tree

Hide file tree

Showing 5 changed files with 63 additions and 39 deletions.
diff --git a/docs/swagger.json b/docs/swagger.json
@@ -47,11 +47,14 @@
                 ],
                 "responses": {
                     "200": {
-                        "description": "Full backups",
-                        "schema": {
-                            "type": "array",
-                            "items": {
-                                "$ref": "#/definitions/model.BackupDetails"
+                        "description": "Full backups by policy",
+                        "schema": {
+                            "type": "object",
+                            "additionalProperties": {
+                                "type": "array",
+                                "items": {
+                                    "$ref": "#/definitions/model.BackupDetails"
+                                }
                             }
                         }
                     },
@@ -85,11 +88,14 @@
                 ],
                 "responses": {
                     "200": {
-                        "description": "Incremental backups",
-                        "schema": {
-                            "type": "array",
-                            "items": {
-                                "$ref": "#/definitions/model.BackupDetails"
+                        "description": "Incremental backups by policy",
+                        "schema": {
+                            "type": "object",
+                            "additionalProperties": {
+                                "type": "array",
+                                "items": {
+                                    "$ref": "#/definitions/model.BackupDetails"
+                                }
                             }
                         }
                     },

diff --git a/docs/swagger.yaml b/docs/swagger.yaml
@@ -269,11 +269,13 @@ paths:
       - application/json
       responses:
         "200":
-          description: Full backups
+          description: Full backups by policy
           schema:
-            items:
-              $ref: '#/definitions/model.BackupDetails'
-            type: array
+            additionalProperties:
+              items:
+                $ref: '#/definitions/model.BackupDetails'
+              type: array
+            type: object
         "404":
           description: Not Found
           schema:
@@ -294,11 +296,13 @@ paths:
       - application/json
       responses:
         "200":
-          description: Incremental backups
+          description: Incremental backups by policy
           schema:
-            items:
-              $ref: '#/definitions/model.BackupDetails'
-            type: array
+            additionalProperties:
+              items:
+                $ref: '#/definitions/model.BackupDetails'
+              type: array
+            type: object
         "404":
           description: Not Found
           schema:

diff --git a/internal/server/backup_handlers.go b/internal/server/backup_handlers.go
@@ -15,7 +15,7 @@ import (
 // @Produce  json
 // @Param    name query string true "Backup policy name"
 // @Router   /backup/full/list [get]
-// @Success  200 {array} model.BackupDetails "Full backups"
+// @Success  200 {object} map[string][]model.BackupDetails "Full backups by policy"
 // @Failure  404 {string} string ""
 func (ws *HTTPServer) getAvailableFullBackups(w http.ResponseWriter, r *http.Request) {
 	ws.getAvailableBackups(w, r, func(backend service.BackupBackend) ([]model.BackupDetails, error) {
@@ -29,7 +29,7 @@ func (ws *HTTPServer) getAvailableFullBackups(w http.ResponseWriter, r *http.Req
 // @Produce  json
 // @Param    name query string true "Backup policy name"
 // @Router   /backup/incremental/list [get]
-// @Success  200 {array} model.BackupDetails "Incremental backups"
+// @Success  200 {object} map[string][]model.BackupDetails "Incremental backups by policy"
 // @Failure  404 {string} string ""
 func (ws *HTTPServer) getAvailableIncrementalBackups(w http.ResponseWriter, r *http.Request) {
 	ws.getAvailableBackups(w, r, func(backend service.BackupBackend) ([]model.BackupDetails, error) {
@@ -42,26 +42,23 @@ func (ws *HTTPServer) getAvailableBackups(
 	r *http.Request,
 	backupListFunc func(service.BackupBackend) ([]model.BackupDetails, error)) {
 
-	policyName := r.URL.Query().Get("name")
-	if policyName == "" {
-		http.Error(w, "Undefined policy name", http.StatusBadRequest)
-		return
-	}
-
-	backend, exists := ws.backupBackends[policyName]
-	if !exists {
-		http.Error(w, "Backup backend does not exist for "+policyName, http.StatusNotFound)
-		return
+	policies := ws.requestedPolicies(r)
+	policyToBackups := make(map[string][]model.BackupDetails)
+	for _, policyName := range policies {
+		backend, exists := ws.backupBackends[policyName]
+		if !exists {
+			http.Error(w, "Backup backend does not exist for "+policyName, http.StatusNotFound)
+			return
+		}
+		list, err := backupListFunc(backend)
+		if err != nil {
+			slog.Error("Failed to retrieve backup list", "err", err)
+			http.Error(w, "Failed to retrieve backup list", http.StatusInternalServerError)
+			return
+		}
+		policyToBackups[policyName] = list
 	}
-
-	list, err := backupListFunc(backend)
-	if err != nil {
-		slog.Error("Failed to retrieve backup list", "err", err)
-		http.Error(w, "Failed to retrieve backup list", http.StatusInternalServerError)
-		return
-	}
-
-	response, err := json.Marshal(list)
+	response, err := json.Marshal(policyToBackups)
 	if err != nil {
 		slog.Error("Failed to parse backup list", "err", err)
 		http.Error(w, "Failed to parse backup list", http.StatusInternalServerError)
@@ -72,3 +69,16 @@ func (ws *HTTPServer) getAvailableBackups(
 	w.WriteHeader(http.StatusOK)
 	_, _ = w.Write(response)
 }
+
+// return an array containing single policy from request (if present), or all policies
+func (ws *HTTPServer) requestedPolicies(r *http.Request) []string {
+	queryPolicyName := r.URL.Query().Get("name")
+	if queryPolicyName != "" {
+		return []string{queryPolicyName}
+	}
+	policies := make([]string, len(ws.config.BackupPolicy))
+	for i, p := range ws.config.BackupPolicy {
+		policies[i] = *p.Name
+	}
+	return policies
+}
diff --git a/pkg/service/configuration_service_storage.go b/pkg/service/configuration_service_storage.go
@@ -65,5 +65,8 @@ func validate(b *model.BackupStorage) error {
 	if b.Type == nil {
 		return errors.New("storage type is required")
 	}
+	if b.Path == nil {
+		return errors.New("storage path is required")
+	}
 	return nil
 }
diff --git a/pkg/service/configuration_service_storage_test.go b/pkg/service/configuration_service_storage_test.go
@@ -17,6 +17,7 @@ func TestAddStorage(t *testing.T) {
 	newStorage := &model.BackupStorage{
 		Name: ptr.String("storage"),
 		Type: util.Ptr(model.Local),
+		Path: ptr.String("path"),
 	}
 
 	err := AddStorage(config, newStorage)