[minor] define jobs using sitectls' new jobs SDK

Author: joecorall

Makefile

@@ -6,7 +6,7 @@ INSTALL_DIR ?= $(or $(dir $(shell which $(BINARY_NAME) 2>/dev/null)),/usr/local/
 deps: work
 	go mod tidy
 
-build: deps
+build:
 	go build -o $(BINARY_NAME) .
 
 install: work build

cmd/backup.go

@@ -12,7 +12,6 @@ import (
 	"strings"
 
 	"charm.land/lipgloss/v2"
-	"github.com/kballard/go-shellquote"
 	"github.com/libops/sitectl/pkg/config"
 	"github.com/libops/sitectl/pkg/docker"
 	"github.com/libops/sitectl/pkg/plugin"
@@ -110,7 +109,7 @@ func init() {
 	componentExtensionCmd.AddCommand(componentExtensionReconcileCmd)
 	componentExtensionCmd.AddCommand(componentExtensionSetCmd)
 
-	debugExtensionCmd.Flags().StringVar(&drupalRootfsPath, "drupal-rootfs", "drupal/rootfs/var/www/drupal", "Drupal rootfs path override")
+	debugExtensionCmd.Flags().StringVar(&drupalRootfsPath, "drupal-rootfs", "", "Drupal rootfs path override")
 }
 
 func renderDrupalDebug(runCtx context.Context) (string, error) {
@@ -130,8 +129,12 @@ func renderDrupalDebug(runCtx context.Context) (string, error) {
 	}
 	defer files.Close()
 
-	slog.Debug("resolving drupal root", "plugin", "drupal", "rootfs", drupalRootfsPath)
-	drupalRoot := resolveDrupalRoot(files, ctx.ProjectDir, drupalRootfsPath)
+	rootfs := strings.TrimSpace(drupalRootfsPath)
+	if rootfs == "" {
+		rootfs = ctx.EffectiveDrupalRootfs()
+	}
+	slog.Debug("resolving drupal root", "plugin", "drupal", "rootfs", rootfs)
+	drupalRoot := ctx.ResolveProjectPath(rootfs)
 	slog.Debug("resolved drupal root", "plugin", "drupal", "drupal_root", drupalRoot)
 	configDir := filepath.Join(drupalRoot, "config", "sync")
 	body := []string{
@@ -182,14 +185,14 @@ func renderDrupalDebug(runCtx context.Context) (string, error) {
 }
 
 func renderCachePageSummary(runCtx context.Context) (string, error) {
-	_, cli, containerName, err := getDrupalContainerForSDK(runCtx)
+	ctx, cli, containerName, err := getDrupalContainerForSDK(runCtx)
 	if err != nil {
 		return "", err
 	}
 	defer cli.Close()
 
 	query := "SELECT COALESCE(data_length + index_length, 0) FROM information_schema.TABLES WHERE table_schema = DATABASE() AND table_name = 'cache_page';"
-	output, err := execDrupalCommandCapture(runCtx, cli, containerName, []string{"drush", "sql:query", query, "--extra=--batch", "--extra=--skip-column-names"})
+	output, err := execDrupalCommandCapture(runCtx, cli, containerName, ctx.EffectiveDrupalContainerRoot(), []string{"drush", "sql:query", query, "--extra=--batch", "--extra=--skip-column-names"})
 	if err != nil {
 		return "", err
 	}
@@ -234,17 +237,15 @@ func getDrupalContainerForSDK(runCtx context.Context) (ctx *config.Context, cli
 	return ctx, cli, containerName, nil
 }
 
-func execDrupalCommandCapture(runCtx context.Context, cli *docker.DockerClient, containerName string, cmd []string) (string, error) {
+func execDrupalCommandCapture(runCtx context.Context, cli *docker.DockerClient, containerName, containerRoot string, cmd []string) (string, error) {
 	slog.Debug(strings.Join(cmd, " "), "plugin", "drupal", "container", containerName)
 	var stdout bytes.Buffer
 	var stderr bytes.Buffer
 
-	wrappedCmd := []string{"bash", "-lc", fmt.Sprintf("cd /var/www/drupal && %s", shellquote.Join(cmd...))}
-
 	exitCode, err := cli.Exec(runCtx, docker.ExecOptions{
 		Container:    containerName,
-		Cmd:          wrappedCmd,
-		WorkingDir:   "/var/www/drupal",
+		Cmd:          cmd,
+		WorkingDir:   containerRoot,
 		AttachStdout: true,
 		AttachStderr: true,
 		Stdout:       &stdout,
@@ -291,26 +292,6 @@ func humanBytes(size int64) string {
 	return fmt.Sprintf("%.1f%ciB", float64(size)/float64(div), "KMGTPE"[exp])
 }
 
-func resolveDrupalRoot(files *plugin.FileAccessor, projectDir, drupalRootPath string) string {
-	candidates := []string{}
-	if trimmed := strings.TrimSpace(drupalRootPath); trimmed != "" {
-		if filepath.IsAbs(trimmed) {
-			candidates = append(candidates, filepath.Clean(trimmed))
-		} else {
-			candidates = append(candidates, filepath.Join(projectDir, trimmed))
-		}
-	}
-	if strings.TrimSpace(projectDir) != "" {
-		candidates = append(candidates, projectDir)
-	}
-	for _, candidate := range candidates {
-		if _, err := files.ReadFile(filepath.Join(candidate, "config", "sync", "core.extension.yml")); err == nil {
-			return candidate
-		}
-	}
-	return ""
-}
-
 func readCoreExtension(runCtx context.Context, files *plugin.FileAccessor, path string) ([]string, []string, error) {
 	data, err := files.ReadFileContext(runCtx, path)
 	if err != nil {

cmd/extensions.go

@@ -70,7 +70,7 @@ func TestReadCoreExtensionMissingFileReturnsNilSlices(t *testing.T) {
 	}
 }
 
-func TestResolveDrupalRootFindsConfiguredRootfs(t *testing.T) {
+func TestDrupalRootUsesConfiguredRootfs(t *testing.T) {
 	projectDir := t.TempDir()
 	drupalRoot := filepath.Join(projectDir, "drupal", "rootfs", "var", "www", "drupal")
 	configDir := filepath.Join(drupalRoot, "config", "sync")
@@ -81,37 +81,18 @@ func TestResolveDrupalRootFindsConfiguredRootfs(t *testing.T) {
 		t.Fatalf("WriteFile() error = %v", err)
 	}
 
-	files, err := plugin.NewFileAccessor(&config.Context{DockerHostType: config.ContextLocal})
-	if err != nil {
-		t.Fatalf("NewFileAccessor() error = %v", err)
-	}
-	defer files.Close()
-
-	got := resolveDrupalRoot(files, projectDir, "drupal/rootfs/var/www/drupal")
+	got := (&config.Context{ProjectDir: projectDir, DrupalRootfs: "drupal/rootfs/var/www/drupal"}).ResolveProjectPath((&config.Context{ProjectDir: projectDir, DrupalRootfs: "drupal/rootfs/var/www/drupal"}).EffectiveDrupalRootfs())
 	if got != drupalRoot {
-		t.Fatalf("resolveDrupalRoot() = %q, want %q", got, drupalRoot)
+		t.Fatalf("drupal root = %q, want %q", got, drupalRoot)
 	}
 }
 
-func TestResolveDrupalRootFallsBackToProjectDir(t *testing.T) {
+func TestDrupalRootUsesProjectDirWhenConfigured(t *testing.T) {
 	projectDir := t.TempDir()
-	configDir := filepath.Join(projectDir, "config", "sync")
-	if err := os.MkdirAll(configDir, 0o755); err != nil {
-		t.Fatalf("MkdirAll() error = %v", err)
-	}
-	if err := os.WriteFile(filepath.Join(configDir, "core.extension.yml"), []byte("module: {}\ntheme: {}\n"), 0o644); err != nil {
-		t.Fatalf("WriteFile() error = %v", err)
-	}
-
-	files, err := plugin.NewFileAccessor(&config.Context{DockerHostType: config.ContextLocal})
-	if err != nil {
-		t.Fatalf("NewFileAccessor() error = %v", err)
-	}
-	defer files.Close()
-
-	got := resolveDrupalRoot(files, projectDir, "drupal/rootfs/var/www/drupal")
+	ctx := &config.Context{ProjectDir: projectDir, DrupalRootfs: "."}
+	got := ctx.ResolveProjectPath(ctx.EffectiveDrupalRootfs())
 	if got != projectDir {
-		t.Fatalf("resolveDrupalRoot() = %q, want %q", got, projectDir)
+		t.Fatalf("drupal root = %q, want %q", got, projectDir)
 	}
 }
 

cmd/extensions_test.go

@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	pluginjobs "github.com/libops/sitectl-drupal/pkg/jobs"
 	"github.com/libops/sitectl/pkg/plugin"
 )
 
@@ -11,16 +12,16 @@ var (
 
 func init() {
 	loginCmd.Flags().Uint("uid", 1, "Drupal user ID to provide a direct login link for")
-
-	backupCmd.Flags().StringVarP(drupalServiceName, "drupal-service", "d", "drupal", "The name of the drupal service in docker compose")
 }
 
 // RegisterCommands registers all drupal commands with the plugin SDK
 func RegisterCommands(s *plugin.SDK) {
 	sdk = s
-	sdk.AddCommand(backupCmd)
+	pluginjobs.Register(s)
+	sdk.AddCommand(sdk.GetMetadataCommand())
 	sdk.AddCommand(componentExtensionCmd)
 	sdk.AddCommand(debugExtensionCmd)
 	sdk.AddCommand(drushCmd)
 	sdk.AddCommand(loginCmd)
+	sdk.AddCommand(syncCmd)
 }