implement export app

Author: mirkoCrobu

cmd/gendoc/docs.go

@@ -562,6 +562,31 @@ Contains a JSON object with the details of an error.
 				{StatusCode: http.StatusInternalServerError, Reference: "#/components/responses/InternalServerError"},
 			},
 		},
+		{
+			OperationId: "exportApp",
+			Method:      http.MethodGet,
+			Path:        "/v1/apps/{id}/export",
+			Request: (*struct {
+				ID string `path:"id" description:"application identifier."`
+			})(nil),
+			Parameters: (*struct {
+				IncludeData bool `query:"include_data" description:"If true, the exported archive will include the 'data' directory. Default is false."`
+			})(nil),
+			CustomSuccessResponse: &CustomResponseDef{
+				ContentType:   "application/zip",
+				DataStructure: []byte{},
+				Description:   "The ZIP archive containing the application structure.",
+				StatusCode:    http.StatusOK,
+			},
+			Description: "Exports the application folder structure as a ZIP file.",
+			Summary:     "Exports an app as ZIP",
+			Tags:        []Tag{ApplicationTag},
+			PossibleErrors: []ErrorResponse{
+				{StatusCode: http.StatusBadRequest, Reference: "#/components/responses/BadRequest"},
+				{StatusCode: http.StatusNotFound, Reference: "#/components/responses/NotFound"},
+				{StatusCode: http.StatusInternalServerError, Reference: "#/components/responses/InternalServerError"},
+			},
+		},
 		{
 			OperationId: "getAppEvents",
 			Method:      http.MethodGet,

internal/api/api.go

@@ -74,14 +74,14 @@ func NewHTTPRouter(
 	mux.Handle("GET /v1/apps", handlers.HandleAppList(dockerClient, idProvider, cfg))
 	mux.Handle("POST /v1/apps", handlers.HandleAppCreate(idProvider, cfg))
 	mux.Handle("GET /v1/apps/events", handlers.HandlerAppStatus(dockerClient, idProvider, cfg))
-
 	mux.Handle("GET /v1/apps/{appID}", handlers.HandleAppDetails(dockerClient, bricksIndex, idProvider, cfg))
 	mux.Handle("PATCH /v1/apps/{appID}", handlers.HandleAppDetailsEdits(dockerClient, bricksIndex, idProvider, cfg))
 	mux.Handle("GET /v1/apps/{appID}/logs", handlers.HandleAppLogs(dockerClient, idProvider, staticStore))
 	mux.Handle("POST /v1/apps/{appID}/start", handlers.HandleAppStart(dockerClient, provisioner, modelsIndex, bricksIndex, idProvider, cfg, staticStore))
 	mux.Handle("POST /v1/apps/{appID}/stop", handlers.HandleAppStop(dockerClient, idProvider))
 	mux.Handle("POST /v1/apps/{appID}/clone", handlers.HandleAppClone(dockerClient, idProvider, cfg))
 	mux.Handle("DELETE /v1/apps/{appID}", handlers.HandleAppDelete(dockerClient, idProvider))
+	mux.Handle("GET /v1/apps/{appID}/export", handlers.HandleAppExport(idProvider, cfg))
 	mux.Handle("GET /v1/apps/{appID}/exposed-ports", handlers.HandleAppPorts(bricksIndex, idProvider))
 	mux.Handle("PUT /v1/apps/{appID}/sketch/libraries/{libRef}", handlers.HandleSketchAddLibrary(idProvider))
 	mux.Handle("DELETE /v1/apps/{appID}/sketch/libraries/{libRef}", handlers.HandleSketchRemoveLibrary(idProvider))

internal/api/docs/openapi.yaml

@@ -522,6 +522,43 @@ paths:
       summary: Get application events
       tags:
       - Application
+  /v1/apps/{id}/export:
+    get:
+      description: Exports the application folder structure as a ZIP file.
+      operationId: exportApp
+      parameters:
+      - description: application identifier.
+        in: path
+        name: id
+        required: true
+        schema:
+          description: application identifier.
+          type: string
+      - description: If true, the exported archive will include the 'data' directory.
+          Default is false.
+        in: query
+        name: include_data
+        schema:
+          description: If true, the exported archive will include the 'data' directory.
+            Default is false.
+          type: boolean
+      responses:
+        "200":
+          content:
+            application/zip:
+              schema:
+                format: base64
+                type: string
+          description: The ZIP archive containing the application structure.
+        "400":
+          $ref: '#/components/responses/BadRequest'
+        "404":
+          $ref: '#/components/responses/NotFound'
+        "500":
+          $ref: '#/components/responses/InternalServerError'
+      summary: Exports an app as ZIP
+      tags:
+      - Application
   /v1/apps/{id}/logs:
     get:
       description: Obtain a ServerSentEvnt stream of logs. It is possible to apply

internal/api/handlers/app_export.go

@@ -0,0 +1,55 @@
+package handlers
+
+import (
+	"log/slog"
+	"net/http"
+	"strconv"
+
+	"github.com/arduino/arduino-app-cli/internal/api/models"
+	"github.com/arduino/arduino-app-cli/internal/orchestrator"
+	"github.com/arduino/arduino-app-cli/internal/orchestrator/app"
+	"github.com/arduino/arduino-app-cli/internal/orchestrator/config"
+	"github.com/arduino/arduino-app-cli/internal/render"
+)
+
+func HandleAppExport(
+	idProvider *app.IDProvider,
+	cfg config.Configuration,
+) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		id, err := idProvider.IDFromBase64(r.PathValue("appID"))
+		if err != nil {
+			render.EncodeResponse(w, http.StatusPreconditionFailed, models.ErrorResponse{Details: "invalid id"})
+			return
+		}
+		app, err := app.Load(id.ToPath())
+		if err != nil {
+			slog.Error("Unable to parse the app.yaml", slog.String("error", err.Error()), slog.String("path", id.String()))
+			render.EncodeResponse(w, http.StatusInternalServerError, models.ErrorResponse{Details: "unable to find the app"})
+			return
+		}
+
+		includeData := false
+		if val := r.URL.Query().Get("include_data"); val != "" {
+			var err error
+			includeData, err = strconv.ParseBool(val)
+			if err != nil {
+				render.EncodeResponse(w, http.StatusBadRequest, models.ErrorResponse{
+					Details: "The parameter 'include_data' must be a boolean.",
+				})
+				return
+			}
+		}
+
+		zipBytes, fileName, err := orchestrator.ExportApp(r.Context(), app, includeData)
+		if err != nil {
+			slog.Error("failed to export app", slog.String("app_id", id.String()), slog.String("error", err.Error()))
+			render.EncodeResponse(w, http.StatusInternalServerError, models.ErrorResponse{
+				Details: "Failed to generate archive.",
+			})
+			return
+		}
+
+		render.EncodeZipResponse(w, http.StatusOK, zipBytes, fileName)
+	}
+}

internal/e2e/client/client.gen.go

@@ -16,6 +16,7 @@
 package orchestrator
 
 import (
+	"archive/zip"
 	"bytes"
 	"context"
 	"fmt"
@@ -54,6 +55,7 @@ import (
 var (
 	ErrAppAlreadyExists = fmt.Errorf("app already exists")
 	ErrAppDoesntExists  = fmt.Errorf("app doesn't exist")
+	ErrAppNotFound      = fmt.Errorf("app not found")
 )
 
 const (
@@ -905,6 +907,96 @@ func DeleteApp(ctx context.Context, dockerClient command.Cli, app app.ArduinoApp
 	return app.FullPath.RemoveAll()
 }
 
+func ExportApp(
+	ctx context.Context,
+	app app.ArduinoApp,
+	includeData bool,
+) ([]byte, string, error) {
+
+	appName := sanitizeFilename(app.Name)
+	if appName == "" {
+		appName = "app-export"
+	}
+	filename := fmt.Sprintf("%s.zip", appName)
+	zipBytes, err := zipAppToBuffer(app.FullPath.String(), includeData)
+	if err != nil {
+		return nil, "", fmt.Errorf("failed to create zip archive: %w", err)
+	}
+	return zipBytes, filename, nil
+}
+
+func zipAppToBuffer(sourcePath string, includeData bool) ([]byte, error) {
+	buf := new(bytes.Buffer)
+	zipWriter := zip.NewWriter(buf)
+
+	err := filepath.Walk(sourcePath, func(path string, info os.FileInfo, err error) error {
+		if err != nil {
+			return err
+		}
+		relPath, err := filepath.Rel(sourcePath, path)
+		if err != nil {
+			return err
+		}
+		if relPath == "." {
+			return nil
+		}
+		if strings.HasPrefix(relPath, ".cache") {
+			if info.IsDir() {
+				return filepath.SkipDir
+			}
+			return nil
+		}
+		if !includeData && strings.HasPrefix(relPath, "data") {
+			if info.IsDir() {
+				return filepath.SkipDir
+			}
+			return nil
+		}
+		header, err := zip.FileInfoHeader(info)
+		if err != nil {
+			return err
+		}
+
+		header.Name = filepath.ToSlash(relPath)
+		if info.IsDir() {
+			header.Name += "/"
+		} else {
+			header.Method = zip.Deflate
+		}
+		writer, err := zipWriter.CreateHeader(header)
+		if err != nil {
+			return err
+		}
+
+		if info.IsDir() {
+			return nil
+		}
+		file, err := os.Open(path)
+		if err != nil {
+			return err
+		}
+		defer file.Close()
+		_, err = io.Copy(writer, file)
+		return err
+	})
+
+	if err != nil {
+		zipWriter.Close()
+		return nil, err
+	}
+
+	if err := zipWriter.Close(); err != nil {
+		return nil, err
+	}
+
+	return buf.Bytes(), nil
+}
+
+func sanitizeFilename(name string) string {
+	safe := strings.ReplaceAll(name, " ", "-")
+	return strings.ToLower(safe)
+}
+
 const defaultAppFileName = "default.app"
 
 func SetDefaultApp(app *app.ArduinoApp, cfg config.Configuration) error {