feat: add independent bench and site cloning

README.md

@@ -157,6 +157,7 @@ See [Admin UI](docs/admin-ui.md) and [Admin API](docs/admin-api.md).
 - [Admin UI](docs/admin-ui.md)
 - [Production](docs/production.md)
 - [Domain Provider](docs/domain-provider.md)
+- [Bench and site cloning](docs/cloning.md)
 
 ## Development
 

admin/backend/api/v1/benches/__init__.py

@@ -30,6 +30,20 @@
 benches_bp.before_request(guard_bench_management)
 
 
+@benches_bp.post("/<name>/actions/clone")
+def clone_bench(name: str):
+    from admin.backend.api.v1.cloning import clone_bench as submit
+
+    return submit(name)
+
+
+@benches_bp.get("/<name>/clone-branch-options")
+def clone_branch_options(name: str):
+    from admin.backend.api.v1.cloning import clone_branch_options as read
+
+    return read(name)
+
+
 @benches_bp.get("")
 def list_benches():
     bench_root = Path(current_app.config["BENCH_ROOT"])

admin/backend/api/v1/cloning.py

@@ -0,0 +1,139 @@
+from __future__ import annotations
+
+import secrets
+from pathlib import Path
+
+from flask import current_app, jsonify, request
+
+from admin.backend.api.responses import accepted_task_response, error_response
+from admin.backend.api.v1.benches.support import BENCH_NAME_RE, guard_bench_management, target_bench_dir
+from admin.backend.api.v1.sites.shared import host_resource_key, task_failure
+from admin.backend.providers.apps import AppProvider
+from pilot.config import BenchConfig
+from pilot.core.bench import Bench
+from pilot.core.bench.cloning.branches import validate_branches
+from pilot.core.site.clone import SiteClone
+from pilot.exceptions import BenchError, TaskConflictError
+from pilot.internal.validators import validate_site_name
+from pilot.tasks.clone_bench import CloneBenchTask
+from pilot.tasks.clone_site import CloneSiteTask
+
+
+def clone_branch_options(name: str):
+    root = Path(current_app.config["BENCH_ROOT"])
+    if not BENCH_NAME_RE.fullmatch(name):
+        return error_response("invalid_bench_name", "Invalid bench name.", 422)
+    try:
+        path = target_bench_dir(root, name)
+        if not (path / "bench.toml").is_file():
+            return error_response("bench_not_found", "Source bench not found.", 404)
+        source = Bench(path)
+        apps = source.get_clone_branch_options()
+        provider = AppProvider(path)
+        for app in apps:
+            title, _description = provider.get_pyproject_meta(path / "apps" / app["name"], app["name"])
+            app["title"] = title or app["name"]
+        return jsonify({"apps": apps})
+    except BenchError as error:
+        return error_response("clone_branches_unavailable", str(error), 422)
+    except ValueError:
+        return error_response("bench_not_found", "Source bench not found.", 404)
+    except Exception:
+        return error_response("clone_branches_unavailable", "Could not load app branches.", 503)
+
+
+def get_clone_bench_name(name: str, data: dict) -> str:
+    if not isinstance(data.get("name"), str):
+        raise BenchError("Enter a destination bench name.")
+    target = data["name"].strip()
+    if not BENCH_NAME_RE.fullmatch(name) or not BENCH_NAME_RE.fullmatch(target):
+        raise BenchError("Invalid bench name.")
+    return target
+
+
+def clone_bench(name: str):
+    root = Path(current_app.config["BENCH_ROOT"])
+    data = request.get_json(silent=True)
+    if not isinstance(data, dict):
+        return error_response("invalid_clone", "Enter a destination bench name.", 422)
+    try:
+        target = get_clone_bench_name(name, data)
+        branch = data.get("branch", "default")
+        app_branches = data.get("app_branches", {})
+        validate_branches(branch, app_branches)
+        BenchConfig.default(target).validate()
+        source = Bench(target_bench_dir(root, name))
+        args = dict(source_bench=source.path.name, name=target, branch=branch, app_branches=app_branches)
+        existing = Bench(root).tasks.find_idempotent_task(
+            "clone-bench", args, request.headers.get("Idempotency-Key")
+        )
+        if existing:
+            return accepted_task_response(root, existing)
+        if target_bench_dir(root, target).exists():
+            return error_response("bench_exists", "Destination bench already exists.", 409)
+        task_id = CloneBenchTask.queue(
+            Bench(root),
+            source_bench=source.path.name,
+            name=target,
+            branch=branch,
+            app_branches=app_branches,
+            idempotency_key=request.headers.get("Idempotency-Key"),
+            resource_key=[f"bench:{name}", f"bench:{target}"],
+        )
+    except TaskConflictError as error:
+        return task_failure(error)
+    except BenchError as error:
+        return error_response("invalid_clone", str(error), 422)
+    except Exception as error:
+        return task_failure(error)
+    return accepted_task_response(root, task_id)
+
+
+def get_clone_site_names(name: str, data) -> tuple[str, str]:
+    if not isinstance(data, dict) or not all(
+        isinstance(data.get(key), str) for key in ("name", "target_bench")
+    ):
+        raise BenchError("Enter a site name and destination bench.")
+    target = data["name"].strip()
+    bench_name = data["target_bench"].strip()
+    if validate_site_name(name) or validate_site_name(target) or not BENCH_NAME_RE.fullmatch(bench_name):
+        raise BenchError("Invalid site or bench name.")
+    return target, bench_name
+
+
+def clone_site(name: str):
+    root = Path(current_app.config["BENCH_ROOT"])
+    data = request.get_json(silent=True)
+    try:
+        target, bench_name = get_clone_site_names(name, data)
+    except BenchError as error:
+        return error_response("invalid_clone", str(error), 422)
+    if bench_name != root.name and (response := guard_bench_management()):
+        return response
+    try:
+        bench = Bench(root)
+        destination = Bench(target_bench_dir(root, bench_name))
+        password = secrets.token_urlsafe(24)
+        args = dict(site=name, name=target, target_bench=bench_name, admin_password=password)
+        existing = bench.tasks.find_idempotent_task(
+            "clone-site", args, request.headers.get("Idempotency-Key")
+        )
+        if existing:
+            return accepted_task_response(root, existing)
+        SiteClone(bench.site(name), destination, target, password).validate()
+        task_id = CloneSiteTask.queue(
+            bench,
+            site=name,
+            name=target,
+            target_bench=bench_name,
+            admin_password=password,
+            idempotency_key=request.headers.get("Idempotency-Key"),
+            resource_key=[f"site:{name.lower()}", f"bench:{bench_name}", host_resource_key(target)],
+        )
+    except TaskConflictError as error:
+        return task_failure(error)
+    except BenchError as error:
+        return error_response("invalid_clone", str(error), 422)
+    except Exception as error:
+        return task_failure(error)
+    return accepted_task_response(root, task_id)

admin/backend/api/v1/sites/core.py

@@ -154,6 +154,13 @@ def create_site():
     return accepted_task_response(bench_root, task_id)
 
 
+@sites_bp.post("/<name>/actions/clone")
+def clone_site(name: str):
+    from admin.backend.api.v1.cloning import clone_site as submit
+
+    return submit(name)
+
+
 @sites_bp.delete("/<name>")
 @require_scope(site_name)
 def drop_site(name: str):

admin/backend/api/v1/types/benches.py

@@ -25,3 +25,14 @@ class CreatedBench(BenchResource):
 
 class BenchReadiness(TypedDict):
     ready: bool
+
+
+class CloneAppBranches(TypedDict):
+    name: str
+    title: str
+    default_branch: str
+    branches: list[str]
+
+
+class CloneBranchOptions(TypedDict):
+    apps: list[CloneAppBranches]

admin/frontend/dashboard/src/api/benches.ts

@@ -1,10 +1,31 @@
 import { request } from '@/api/client'
-import type { BenchReadiness, BenchResource, CreatedBench } from '@/types/benches'
+import type {
+  BenchReadiness,
+  BenchResource,
+  CreatedBench,
+  CloneBranchOptions,
+} from '@/types/benches'
 import type { WildcardDomains } from '@/types/sites'
+import type { TaskPayload } from '@/types/tasks'
 
 export const benchesApi = {
   list: (): Promise<BenchResource[]> => request.get('benches').json(),
 
+  cloneBranchOptions: (source: string): Promise<CloneBranchOptions> =>
+    request.get(`benches/${encodeURIComponent(source)}/clone-branch-options`).json(),
+
+  clone: (
+    source: string,
+    name: string,
+    branch = 'default',
+    app_branches: Record<string, string> = {},
+  ): Promise<TaskPayload> =>
+    request
+      .post(`benches/${encodeURIComponent(source)}/actions/clone`, {
+        json: { name, branch, app_branches },
+      })
+      .json(),
+
   start: (name: string): Promise<BenchResource> =>
     request.post(`benches/${encodeURIComponent(name)}/actions/start`).json(),
 

admin/frontend/dashboard/src/api/sites.ts

@@ -39,6 +39,13 @@ export const sitesApi = {
   create: (payload: Record<string, unknown>): Promise<TaskPayload> =>
     request.post('sites', { json: payload }).json(),
 
+  clone: (source: string, name: string, targetBench: string): Promise<TaskPayload> =>
+    request
+      .post(`sites/${encodeURIComponent(source)}/actions/clone`, {
+        json: { name, target_bench: targetBench },
+      })
+      .json(),
+
   loginLink: (name: string): Promise<SiteLoginLink> =>
     request.post(`sites/${encodeURIComponent(name)}/login`).json(),
 
@@ -47,7 +54,11 @@ export const sitesApi = {
       unwrap(request.get(`sites/${encodeURIComponent(name)}/configuration`).json()),
     update: (name: string, patch: SiteConfig): Promise<SiteConfig> =>
       unwrap(
-        request.patch(`sites/${encodeURIComponent(name)}/configuration`, { json: patch }).json(),
+        request
+          .patch(`sites/${encodeURIComponent(name)}/configuration`, {
+            json: patch,
+          })
+          .json(),
       ),
   },
 
@@ -201,7 +212,10 @@ export const sitesApi = {
       request.get(`sites/${encodeURIComponent(name)}/apps`).json(),
     install: (name: string, payload: Record<string, unknown>): Promise<EnabledApp | TaskPayload> =>
       request
-        .post(`sites/${encodeURIComponent(name)}/apps`, { json: payload, timeout: inlineTimeout })
+        .post(`sites/${encodeURIComponent(name)}/apps`, {
+          json: payload,
+          timeout: inlineTimeout,
+        })
         .json(),
     remove: (
       name: string,
@@ -226,7 +240,9 @@ export const sitesApi = {
       request.get(`sites/${encodeURIComponent(name)}/domains`).json(),
     add: (name: string, domain: string, email = ''): Promise<TaskPayload> =>
       request
-        .post(`sites/${encodeURIComponent(name)}/domains`, { json: email ? { domain, email } : { domain } })
+        .post(`sites/${encodeURIComponent(name)}/domains`, {
+          json: email ? { domain, email } : { domain },
+        })
         .json(),
     remove: (name: string, domain: string): Promise<TaskPayload> =>
       request
@@ -248,19 +264,27 @@ export const sitesApi = {
   monitoring: {
     get: (name: string, window: string): Promise<SiteAnalytics> =>
       request
-        .get(`sites/${encodeURIComponent(name)}/monitoring`, { searchParams: { window } })
+        .get(`sites/${encodeURIComponent(name)}/monitoring`, {
+          searchParams: { window },
+        })
         .json(),
   },
 
   uptime: {
     get: (name: string, window: string): Promise<SiteUptime> =>
-      request.get(`sites/${encodeURIComponent(name)}/uptime`, { searchParams: { window } }).json(),
+      request
+        .get(`sites/${encodeURIComponent(name)}/uptime`, {
+          searchParams: { window },
+        })
+        .json(),
   },
 
   backups: {
     list: (name: string, limit?: number): Promise<Backup[]> =>
       request
-        .get(`sites/${encodeURIComponent(name)}/backups`, { searchParams: limit ? { limit } : {} })
+        .get(`sites/${encodeURIComponent(name)}/backups`, {
+          searchParams: limit ? { limit } : {},
+        })
         .json(),
     create: (name: string): Promise<TaskPayload> =>
       request.post(`sites/${encodeURIComponent(name)}/backups`).json(),
@@ -278,7 +302,11 @@ export const sitesApi = {
       get: (name: string): Promise<BackupSchedule> =>
         request.get(`sites/${encodeURIComponent(name)}/backup-schedule`).json(),
       set: (name: string, payload: Record<string, unknown>): Promise<BackupSchedule> =>
-        request.put(`sites/${encodeURIComponent(name)}/backup-schedule`, { json: payload }).json(),
+        request
+          .put(`sites/${encodeURIComponent(name)}/backup-schedule`, {
+            json: payload,
+          })
+          .json(),
       remove: (name: string) => request.delete(`sites/${encodeURIComponent(name)}/backup-schedule`),
     },
   },

admin/frontend/dashboard/src/components/benches/BenchSwitcherDialog.vue

@@ -15,6 +15,7 @@ import LucidePlay from '~icons/lucide/play'
 import LucideRotateCw from '~icons/lucide/rotate-cw'
 import LucideSquare from '~icons/lucide/square'
 import LucideTrash2 from '~icons/lucide/trash-2'
+import LucideCopy from '~icons/lucide/copy'
 
 import ActionMenu from '@/components/common/ActionMenu.vue'
 import type { ActionMenuOption } from '@/components/common/actionMenu'
@@ -28,7 +29,7 @@ interface Props {
 }
 
 const props = defineProps<Props>()
-const emit = defineEmits(['update:modelValue', 'new-bench'])
+const emit = defineEmits(['update:modelValue', 'new-bench', 'clone-bench'])
 
 const show = computed({
   get: () => props.modelValue,
@@ -138,8 +139,20 @@ const openBench = (bench: BenchResource) => {
 
 const menuOptions = (bench: BenchResource) => {
   const opts: ActionMenuOption[] = []
+  opts.push({
+    label: 'Clone bench',
+    icon: LucideCopy,
+    onClick: () => {
+      show.value = false
+      emit('clone-bench', bench.name)
+    },
+  })
   if (canOpen(bench))
-    opts.push({ label: 'Open', icon: LucideExternalLink, onClick: () => openBench(bench) })
+    opts.push({
+      label: 'Open',
+      icon: LucideExternalLink,
+      onClick: () => openBench(bench),
+    })
   if (bench.production) {
     const running = bench.workload_running
     const current = isCurrentBench(bench)
@@ -251,7 +264,11 @@ watch(show, (open) => {
   <Dialog v-model="showDropConfirm" title="Drop Bench" size="sm">
     <div class="flex flex-col gap-4" @pointerdown.stop>
       <div class="flex flex-col gap-2 text-ink-gray-7 text-sm leading-relaxed">
-        <p>Permanently delete <strong class="text-ink-gray-9">{{ benchToDrop?.name }}</strong>?</p>
+        <p>
+          Permanently delete
+          <strong class="text-ink-gray-9">{{ benchToDrop?.name }}</strong
+          >?
+        </p>
 
         <p>
           This tears down its production services, nginx config and MariaDB instance, then removes