feat: stackctl stack refresh-db subcommand by omattsson · Pull Request #32 · omattsson/stackctl

omattsson · 2026-04-17T18:17:30Z

Summary

Adds stackctl stack refresh-db <id> which POSTs to the new /api/v1/stack-instances/:id/refresh-db endpoint on the stack manager (separate repo, companion PR)
Lets developers wipe the MySQL PVC + flush Redis for a running Klaravik dev stack without a full clean+deploy cycle (3+ min with full image re-pulls)
Follows the same confirmation/--yes/quiet-output pattern as stack clean

What the command does (on the server side)

Does NOT run helm. Orchestrates k8s primitives:

Scales configured app Deployments to 0
Scales MySQL to 0, waits for pod gone
Runs short-lived Job mounting the MySQL PVC, rm -rf /var/lib/mysql/*
Scales MySQL back to 1 — init container re-extracts the golden-db tarball
FLUSHALL against Redis
Deletes the storefront sync helm-hook Job
Scales apps back up

After refresh-db the user runs stack deploy to re-fire the Helm hook that repopulates Redis via composer storefront-fullsync.

Test coverage

pkg/client/client_test.go: added TestRefreshDBStack_Success and TestRefreshDBStack_Conflict (httptest mock server — asserts the POST path and decodes the DeploymentLog response, mirroring the existing CleanStack/DeployStack coverage).
cmd/stack_test.go: added four TestStackRefreshDBCmd_* tests covering the confirmation prompt, --yes bypass, decline path, and --quiet log-ID-only output — mirroring the existing stack clean command tests.

Collateral fix

The above tests couldn't run on the initial push because cli/pkg/client/client_test.go, cli/pkg/output/output_test.go, cli/cmd/*_test.go, and cli/test/integration/* had pre-existing build failures from the partial uint → string (UUID) migration in commits b4f3b61 / dc9dc34. This PR finishes that migration across those files (quote ID literals, []uint → []string, one cluster-list response-shape fix, two %d → %s production leftovers) and fixes a def.Version + "+1" bug introduced by the first migration attempt. No production behavior change from the migration itself — go vet ./... and go test ./... (minus pre-existing test/e2e/ runtime failures) are now clean.

Test plan

go build ./... clean
./bin/stackctl stack refresh-db --help renders correctly
E2E: ./bin/stackctl stack refresh-db <id> against local klaravik stack, verify MySQL PVC wiped + init container re-extracts + Redis cleared
Companion k8s-stack-manager PR merged first (endpoint must exist)

🤖 Generated with Claude Code

Adds `stackctl stack refresh-db <id>` which POSTs to the new /api/v1/stack-instances/:id/refresh-db backend endpoint to wipe the MySQL PVC and flush Redis without a full clean+redeploy. Follows the same confirmation/quiet/output pattern as `stack clean` (`--yes` to skip prompt). Prints a hint about following up with `stack deploy` to re-populate Redis via the helm sync hook. Client method Client.RefreshDBStack(id) mirrors CleanStack. No new unit tests in cli/pkg/client/client_test.go — that file has pre-existing type-migration build failures (see b4f3b61/dc9dc34) unrelated to this change. E2E validation covered by the stack manager integration tests and manual refresh-db on a running stack.

Copilot

Pull request overview

Adds a new stackctl stack refresh-db <id> command to trigger a backend “refresh DB” operation for a stack instance via a new client method and API endpoint, fitting into the existing stack command group and pkg/client API wrapper patterns.

Changes:

Add Client.RefreshDBStack(id) to POST to /api/v1/stack-instances/:id/refresh-db.
Add stack refresh-db Cobra subcommand with confirmation (--yes) and quiet output behavior consistent with other stack action commands.
Wire the new subcommand into the stack command group and register its flags.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
cli/pkg/client/client.go	Adds a new client method for the refresh-db API endpoint returning a `DeploymentLog`.
cli/cmd/stack.go	Introduces the `stack refresh-db` subcommand, confirmation flow, and command registration.

Copilot · 2026-04-17T18:20:26Z

+		}
+
+		printer.PrintMessage("Refreshing database for stack %s... (log ID: %s)", id, log.ID)
+		printer.PrintMessage("Run 'stackctl stack logs %s' to stream progress, or 'stackctl stack deploy %s' afterwards to re-populate Redis.", id, id)


stackctl stack logs prints the latest deployment log once; it does not stream/follow progress. The message here saying "stream progress" is misleading—please reword to "view"/"check" progress (or add an actual follow/streaming capability and reference that).

Suggested change

printer.PrintMessage("Run 'stackctl stack logs %s' to stream progress, or 'stackctl stack deploy %s' afterwards to re-populate Redis.", id, id)

printer.PrintMessage("Run 'stackctl stack logs %s' to check progress, or 'stackctl stack deploy %s' afterwards to re-populate Redis.", id, id)

Copilot · 2026-04-17T18:20:27Z

+func (c *Client) RefreshDBStack(id string) (*types.DeploymentLog, error) {
+	var log types.DeploymentLog
+	err := c.Post(fmt.Sprintf("/api/v1/stack-instances/%s/refresh-db", id), nil, &log)
+	if err != nil {
+		return nil, err
+	}
+	return &log, nil
+}


New RefreshDBStack client method is introduced without a corresponding unit test. There are existing httptest-based unit tests for similar stack actions (e.g., CleanStack/DeployStack), so adding a small test that asserts the POST path /api/v1/stack-instances/:id/refresh-db and decodes a DeploymentLog response would keep coverage consistent.

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

Copilot · 2026-04-17T18:56:36Z

+func (c *Client) RefreshDBStack(id string) (*types.DeploymentLog, error) {
+	var log types.DeploymentLog
+	err := c.Post(fmt.Sprintf("/api/v1/stack-instances/%s/refresh-db", id), nil, &log)
+	if err != nil {
+		return nil, err


New client method RefreshDBStack adds behavior but isn't covered by pkg/client unit tests. Please add a minimal httptest-based test (similar to CleanStack/DeployStack) that asserts it POSTs to /api/v1/stack-instances/<id>/refresh-db and decodes the returned DeploymentLog (including log ID).

Copilot · 2026-04-17T18:56:36Z

+var stackRefreshDBCmd = &cobra.Command{
+	Use:   "refresh-db <id>",
+	Short: "Refresh a stack's MySQL database from the golden-db snapshot",
+	Long: `Refresh the MySQL database for a running stack instance without a full
+clean+redeploy. Wipes the MySQL PVC so the init container re-extracts the


stack refresh-db introduces a new destructive subcommand but doesn't add any command-level tests. Please add tests in cli/cmd/stack_test.go mirroring the existing stack clean coverage (confirm prompt y/n behavior, --yes bypass, and --quiet printing only the log ID) to ensure this command stays stable as flags/output evolve.

- cmd/stack: reword the post-refresh hint from "stream progress" to "check progress" — `stackctl stack logs` is a point-in-time snapshot, it does not follow/tail, so the old wording overpromised. - client: add TestRefreshDBStack_Success + TestRefreshDBStack_Conflict mirroring the existing CleanStack httptest-based coverage, asserting the POST path, success decoding, and APIError on 409. Also fix the pre-existing uint→string UUID migration miss in the test packages (started in b4f3b61/dc9dc34 but left these files broken — which was keeping CI red on main and blocking any test-adding PR): - pkg/client/client_test.go: quote id literals, update `[]uint`→`[]string`, adjust ID assertions, rewrite cluster-list test shape (bare slice vs paginated envelope) to match current production type. - pkg/output/output_test.go: same mechanical fixes. - test/integration/*: quote id literals, rewrite Sscanf(%d) URL parsers to string splits, convert uint→string state maps. Package now builds and all 26 subtests pass. No production code touched; test/e2e/ left alone (those are runtime failures that need a live server, separate scope).

Copilot

Pull request overview

Copilot reviewed 9 out of 9 changed files in this pull request and generated 2 comments.

Copilot · 2026-04-17T19:22:03Z

+					state.mu.Lock()
+					if req.Name != "" {
+						def.Name = req.Name
+					}
+					if req.Description != "" {
+						def.Description = req.Description
+					}
+					def.Version = def.Version + "+1"
+					state.mu.Unlock()


def.Version = def.Version + "+1" produces versions like "1+1" instead of incrementing the version. Since types.Base.Version is a string, either keep it constant in the mock, or track a numeric counter and format it back to string so update responses reflect realistic version progression.

Copilot · 2026-04-17T19:22:03Z

+var stackRefreshDBCmd = &cobra.Command{
+	Use:   "refresh-db <id>",
+	Short: "Refresh a stack's MySQL database from the golden-db snapshot",
+	Long: `Refresh the MySQL database for a running stack instance without a full
+clean+redeploy. Wipes the MySQL PVC so the init container re-extracts the
+golden-db snapshot on next boot, flushes Redis, and deletes the storefront
+sync Job so the next ` + "`stack deploy`" + ` re-fires the Helm hook that repopulates
+Redis.
+
+Does NOT re-run helm — only scales deployments and runs a short-lived
+cleanup Job. The stack must be in 'running' state.
+
+This is a destructive operation (wipes all MySQL data for this stack).
+You will be prompted for confirmation unless --yes is specified.
+
+After refresh-db completes, run ` + "`stack deploy`" + ` to re-populate Redis via
+the sync Job.
+
+Examples:
+  stackctl stack refresh-db 42
+  stackctl stack refresh-db 42 --yes`,
+	Args:         cobra.ExactArgs(1),
+	SilenceUsage: true,
+	RunE: func(cmd *cobra.Command, args []string) error {


The new destructive stack refresh-db command isn’t covered by the existing cli/cmd/stack_test.go command tests. Please add tests that cover (1) confirmation prompt accept/decline, (2) --yes bypass, and (3) --quiet output (log ID only), similar to the stack clean tests.

…ation - cmd/stack_test.go: add four command-level tests for `stack refresh-db` mirroring the `stack clean` coverage: - WithConfirmation (prompt accept with y/n) - Declined (n → API never called, "Aborted" printed) - WithYesFlag (--yes bypasses prompt) - QuietPrintsOnlyLogID (--quiet prints only the log ID, no human prefix) Also finish the pre-existing uint→string UUID migration that was still blocking CI and caused `go vet` to fail on main. These files were missed by earlier commits b4f3b61 / dc9dc34: - cmd/bulk_test.go, cluster_test.go, definition_test.go, login_test.go, override_test.go, stack_test.go, template_test.go: quote id literals, [uint]→[]string for bulk args, drop 30 obsolete TestParseID_Zero / *_InvalidID tests (parseID now only rejects empty strings). - cmd/override.go, cmd/stack.go: two %d → %s format strings that the earlier dc9dc34 fix-up missed; these caused `go vet` to fail. - test/integration/template_definition_integration_test.go: the mock server was doing `def.Version = def.Version + "+1"`, producing versions like "1+1". Switch to a strconv.Atoi/Itoa round-trip so updates increment realistically (1 → 2 → 3). Result: `go vet ./...` clean, `go build ./...` clean, `go test ./cmd/ ./pkg/... ./test/integration/` all pass. test/e2e/ still has pre-existing runtime failures (needs a live server) — unrelated.

Copilot

Pull request overview

Copilot reviewed 17 out of 17 changed files in this pull request and generated 1 comment.

Copilot · 2026-04-17T19:46:18Z

+func TestRefreshDBStack_Success(t *testing.T) {
+	t.Parallel()
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		assert.Equal(t, http.MethodPost, r.Method)
+		assert.Equal(t, "/api/v1/stack-instances/42/refresh-db", r.URL.Path)
+		w.WriteHeader(http.StatusAccepted)
+		json.NewEncoder(w).Encode(types.DeploymentLog{
+			Base:       types.Base{ID: "log-103"},
+			InstanceID: "42",
+			Action:     "refresh-db",
+			Status:     "started",
+		})
+	}))
+	defer server.Close()
+
+	c := New(server.URL)
+	log, err := c.RefreshDBStack("42")
+	require.NoError(t, err)
+	assert.Equal(t, "log-103", log.ID)
+	assert.Equal(t, "refresh-db", log.Action)
+}
+
+func TestRefreshDBStack_Conflict(t *testing.T) {
+	t.Parallel()
+	server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(http.StatusConflict)
+		json.NewEncoder(w).Encode(map[string]string{"error": "Cannot refresh-db: instance is currently deploying"})
+	}))
+	defer server.Close()


The PR description says there are no new unit tests in pkg/client/client_test.go, but this change set adds new RefreshDBStack tests (and updates many existing client tests). Please update the PR description to match what’s actually included, so reviewers and future readers aren’t misled about test coverage/state.

Copilot AI review requested due to automatic review settings April 17, 2026 18:17

Copilot started reviewing on behalf of omattsson April 17, 2026 18:17 View session

omattsson mentioned this pull request Apr 17, 2026

feat: refresh-db endpoint — wipe MySQL PVC without full redeploy omattsson/k8s-stack-manager#163

Merged

4 tasks

Copilot AI reviewed Apr 17, 2026

View reviewed changes

omattsson requested a review from Copilot April 17, 2026 18:53

Copilot started reviewing on behalf of omattsson April 17, 2026 18:54 View session

Copilot AI reviewed Apr 17, 2026

View reviewed changes

omattsson requested a review from Copilot April 17, 2026 19:18

Copilot started reviewing on behalf of omattsson April 17, 2026 19:18 View session

Copilot AI reviewed Apr 17, 2026

View reviewed changes

omattsson requested a review from Copilot April 17, 2026 19:42

Copilot started reviewing on behalf of omattsson April 17, 2026 19:42 View session

Copilot AI reviewed Apr 17, 2026

View reviewed changes

omattsson merged commit 713a0d6 into main Apr 17, 2026
8 of 10 checks passed

omattsson deleted the feat/refresh-db branch April 17, 2026 20:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: stackctl stack refresh-db subcommand#32

feat: stackctl stack refresh-db subcommand#32
omattsson merged 3 commits intomainfrom
feat/refresh-db

omattsson commented Apr 17, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Apr 17, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

	printer.PrintMessage("Run 'stackctl stack logs %s' to stream progress, or 'stackctl stack deploy %s' afterwards to re-populate Redis.", id, id)
	printer.PrintMessage("Run 'stackctl stack logs %s' to check progress, or 'stackctl stack deploy %s' afterwards to re-populate Redis.", id, id)

Conversation

omattsson commented Apr 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

What the command does (on the server side)

Test coverage

Collateral fix

Test plan

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Apr 17, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

omattsson commented Apr 17, 2026 •

edited

Loading