[#2599] added option to upload a backup file from the Admin UI

2023-08-28 20:06:48 +03:00
parent 2a6b891a9b
commit f7f8f09336
41 changed files with 621 additions and 182 deletions
@@ -38,7 +38,7 @@ func TestBackupCreateValidateAndSubmit(t *testing.T) {
 	}

 	for _, s := range scenarios {
-		func() {
+		t.Run(s.name, func(t *testing.T) {
 			app, _ := tests.NewTestApp()
 			defer app.Cleanup()

@@ -56,47 +56,47 @@ func TestBackupCreateValidateAndSubmit(t *testing.T) {
 			// parse errors
 			errs, ok := result.(validation.Errors)
 			if !ok && result != nil {
-				t.Errorf("[%s] Failed to parse errors %v", s.name, result)
+				t.Fatalf("Failed to parse errors %v", result)
 				return
 			}

 			// check errors
 			if len(errs) > len(s.expectedErrors) {
-				t.Errorf("[%s] Expected error keys %v, got %v", s.name, s.expectedErrors, errs)
+				t.Fatalf("Expected error keys %v, got %v", s.expectedErrors, errs)
 			}
 			for _, k := range s.expectedErrors {
 				if _, ok := errs[k]; !ok {
-					t.Errorf("[%s] Missing expected error key %q in %v", s.name, k, errs)
+					t.Fatalf("Missing expected error key %q in %v", k, errs)
 				}
 			}

 			// retrieve all created backup files
 			files, err := fsys.List("")
 			if err != nil {
-				t.Errorf("[%s] Failed to retrieve backup files", s.name)
+				t.Fatal("Failed to retrieve backup files")
 				return
 			}

 			if result != nil {
 				if total := len(files); total != 0 {
-					t.Errorf("[%s] Didn't expected backup files, found %d", s.name, total)
+					t.Fatalf("Didn't expected backup files, found %d", total)
 				}
 				return
 			}

 			if total := len(files); total != 1 {
-				t.Errorf("[%s] Expected 1 backup file, got %d", s.name, total)
+				t.Fatalf("Expected 1 backup file, got %d", total)
 				return
 			}

 			if s.backupName == "" {
 				prefix := "pb_backup_"
 				if !strings.HasPrefix(files[0].Key, prefix) {
-					t.Errorf("[%s] Expected the backup file, to have prefix %q: %q", s.name, prefix, files[0].Key)
+					t.Fatalf("Expected the backup file, to have prefix %q: %q", prefix, files[0].Key)
 				}
 			} else if s.backupName != files[0].Key {
-				t.Errorf("[%s] Expected backup file %q, got %q", s.name, s.backupName, files[0].Key)
+				t.Fatalf("Expected backup file %q, got %q", s.backupName, files[0].Key)
 			}
-		}()
+		})
 	}
 }
@@ -0,0 +1,85 @@
+package forms
+
+import (
+	"context"
+
+	validation "github.com/go-ozzo/ozzo-validation/v4"
+	"github.com/pocketbase/pocketbase/core"
+	"github.com/pocketbase/pocketbase/forms/validators"
+	"github.com/pocketbase/pocketbase/tools/filesystem"
+)
+
+// BackupUpload is a request form for uploading a new app backup.
+type BackupUpload struct {
+	app core.App
+	ctx context.Context
+
+	File *filesystem.File `json:"file"`
+}
+
+// NewBackupUpload creates new BackupUpload request form.
+func NewBackupUpload(app core.App) *BackupUpload {
+	return &BackupUpload{
+		app: app,
+		ctx: context.Background(),
+	}
+}
+
+// SetContext replaces the default form upload context with the provided one.
+func (form *BackupUpload) SetContext(ctx context.Context) {
+	form.ctx = ctx
+}
+
+// Validate makes the form validatable by implementing [validation.Validatable] interface.
+func (form *BackupUpload) Validate() error {
+	return validation.ValidateStruct(form,
+		validation.Field(
+			&form.File,
+			validation.Required,
+			validation.By(validators.UploadedFileMimeType([]string{"application/zip"})),
+			validation.By(form.checkUniqueName),
+		),
+	)
+}
+
+func (form *BackupUpload) checkUniqueName(value any) error {
+	v, _ := value.(*filesystem.File)
+	if v == nil {
+		return nil // nothing to check
+	}
+
+	fsys, err := form.app.NewBackupsFilesystem()
+	if err != nil {
+		return err
+	}
+	defer fsys.Close()
+
+	fsys.SetContext(form.ctx)
+
+	if exists, err := fsys.Exists(v.OriginalName); err != nil || exists {
+		return validation.NewError("validation_backup_name_exists", "Backup file with the specified name already exists.")
+	}
+
+	return nil
+}
+
+// Submit validates the form and upload the backup file.
+//
+// You can optionally provide a list of InterceptorFunc to further
+// modify the form behavior before uploading the backup.
+func (form *BackupUpload) Submit(interceptors ...InterceptorFunc[*filesystem.File]) error {
+	if err := form.Validate(); err != nil {
+		return err
+	}
+
+	return runInterceptors(form.File, func(file *filesystem.File) error {
+		fsys, err := form.app.NewBackupsFilesystem()
+		if err != nil {
+			return err
+		}
+
+		fsys.SetContext(form.ctx)
+
+		return fsys.UploadFile(file, file.OriginalName)
+	}, interceptors...)
+}
@@ -0,0 +1,118 @@
+package forms_test
+
+import (
+	"archive/zip"
+	"bytes"
+	"testing"
+
+	validation "github.com/go-ozzo/ozzo-validation/v4"
+	"github.com/pocketbase/pocketbase/forms"
+	"github.com/pocketbase/pocketbase/tests"
+	"github.com/pocketbase/pocketbase/tools/filesystem"
+)
+
+func TestBackupUploadValidateAndSubmit(t *testing.T) {
+	var zb bytes.Buffer
+	zw := zip.NewWriter(&zb)
+	if err := zw.Close(); err != nil {
+		t.Fatal(err)
+	}
+
+	f0, _ := filesystem.NewFileFromBytes([]byte("test"), "existing")
+	f1, _ := filesystem.NewFileFromBytes([]byte("456"), "nozip")
+	f2, _ := filesystem.NewFileFromBytes(zb.Bytes(), "existing")
+	f3, _ := filesystem.NewFileFromBytes(zb.Bytes(), "zip")
+
+	scenarios := []struct {
+		name           string
+		file           *filesystem.File
+		expectedErrors []string
+	}{
+		{
+			"missing file",
+			nil,
+			[]string{"file"},
+		},
+		{
+			"non-zip file",
+			f1,
+			[]string{"file"},
+		},
+		{
+			"zip file with non-unique name",
+			f2,
+			[]string{"file"},
+		},
+		{
+			"zip file with unique name",
+			f3,
+			[]string{},
+		},
+	}
+
+	for _, s := range scenarios {
+		t.Run(s.name, func(t *testing.T) {
+			app, _ := tests.NewTestApp()
+			defer app.Cleanup()
+
+			fsys, err := app.NewBackupsFilesystem()
+			if err != nil {
+				t.Fatal(err)
+			}
+			defer fsys.Close()
+			// create a dummy backup file to simulate existing backups
+			if err := fsys.UploadFile(f0, f0.OriginalName); err != nil {
+				t.Fatal(err)
+			}
+
+			form := forms.NewBackupUpload(app)
+			form.File = s.file
+
+			result := form.Submit()
+
+			// parse errors
+			errs, ok := result.(validation.Errors)
+			if !ok && result != nil {
+				t.Fatalf("Failed to parse errors %v", result)
+			}
+
+			// check errors
+			if len(errs) > len(s.expectedErrors) {
+				t.Fatalf("Expected error keys %v, got %v", s.expectedErrors, errs)
+			}
+			for _, k := range s.expectedErrors {
+				if _, ok := errs[k]; !ok {
+					t.Fatalf("Missing expected error key %q in %v", k, errs)
+				}
+			}
+
+			expectedFiles := []*filesystem.File{f0}
+			if result == nil {
+				expectedFiles = append(expectedFiles, s.file)
+			}
+
+			// retrieve all uploaded backup files
+			files, err := fsys.List("")
+			if err != nil {
+				t.Fatal("Failed to retrieve backup files")
+			}
+
+			if len(files) != len(expectedFiles) {
+				t.Fatalf("Expected %d files, got %d", len(expectedFiles), len(files))
+			}
+
+			for _, ef := range expectedFiles {
+				exists := false
+				for _, f := range files {
+					if f.Key == ef.OriginalName {
+						exists = true
+						break
+					}
+				}
+				if !exists {
+					t.Fatalf("Missing expected backup file %v", ef.OriginalName)
+				}
+			}
+		})
+	}
+}