-
Notifications
You must be signed in to change notification settings - Fork 53
feat: add stack state pull command
#410
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # `spacectl stack state` | ||
|
|
||
| `spacectl stack state` manages Terraform/OpenTofu state files for Spacelift stacks. | ||
|
|
||
| ## `pull` | ||
|
|
||
| Downloads the current state file for a stack. | ||
|
|
||
| ```bash | ||
| # Output to stdout | ||
| spacectl stack state pull --id my-stack | ||
|
|
||
| # Save to file | ||
| spacectl stack state pull --id my-stack -o terraform.tfstate | ||
|
|
||
| # Auto-detect stack from current directory | ||
| spacectl stack state pull | ||
|
|
||
| # Pretty-print | ||
| spacectl stack state pull --id my-stack | jq . | ||
| ``` | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| The stack must have: | ||
|
|
||
| - **Manages state** enabled (Spacelift manages the Terraform state) | ||
| - **External state access** enabled (stack setting) | ||
|
|
||
| The user must have **State download** permission or Space admin role. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| package stack | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "io" | ||
| "net/http" | ||
| "os" | ||
| "path/filepath" | ||
|
|
||
| "github.com/shurcooL/graphql" | ||
| "github.com/urfave/cli/v3" | ||
|
|
||
| "github.com/spacelift-io/spacectl/internal/cmd/authenticated" | ||
| ) | ||
|
|
||
| var flagOutputFile = &cli.StringFlag{ | ||
| Name: "output", | ||
| Aliases: []string{"o"}, | ||
| Usage: "[Optional] `PATH` to write the state file to (defaults to stdout)", | ||
| } | ||
|
|
||
| func statePull() cli.ActionFunc { | ||
| return func(ctx context.Context, cliCmd *cli.Command) error { | ||
| stackID, err := getStackID(ctx, cliCmd) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| var mutation struct { | ||
| StateDownloadURL struct { | ||
| URL string `graphql:"url"` | ||
| } `graphql:"stateDownloadUrl(input: $input)"` | ||
| } | ||
|
|
||
| variables := map[string]any{ | ||
| "input": StateDownloadUrlInput{StackID: graphql.ID(stackID)}, | ||
| } | ||
|
|
||
| if err := authenticated.Client().Mutate(ctx, &mutation, variables); err != nil { | ||
| return fmt.Errorf("failed to get state download URL for stack %q: %w", stackID, err) | ||
| } | ||
|
|
||
| req, err := http.NewRequestWithContext(ctx, http.MethodGet, mutation.StateDownloadURL.URL, nil) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to create download request: %w", err) | ||
| } | ||
|
|
||
| resp, err := http.DefaultClient.Do(req) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to download state: %w", err) | ||
| } | ||
| defer resp.Body.Close() | ||
|
|
||
| if resp.StatusCode != http.StatusOK { | ||
| body, _ := io.ReadAll(io.LimitReader(resp.Body, 512)) | ||
| return fmt.Errorf("failed to download state: HTTP %d: %s", resp.StatusCode, string(body)) | ||
| } | ||
|
|
||
| outputPath := cliCmd.String(flagOutputFile.Name) | ||
| if outputPath == "" { | ||
| if _, err := io.Copy(os.Stdout, resp.Body); err != nil { | ||
| return fmt.Errorf("failed to write state: %w", err) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| f, err := os.OpenFile(filepath.Clean(outputPath), os.O_CREATE|os.O_WRONLY|os.O_TRUNC, 0o600) | ||
| if err != nil { | ||
| return fmt.Errorf("failed to create output file: %w", err) | ||
| } | ||
|
|
||
| if _, err := io.Copy(f, resp.Body); err != nil { | ||
| f.Close() | ||
| os.Remove(filepath.Clean(outputPath)) | ||
| return fmt.Errorf("failed to write state: %w", err) | ||
| } | ||
|
|
||
| if err := f.Close(); err != nil { | ||
| os.Remove(filepath.Clean(outputPath)) | ||
| return fmt.Errorf("failed to flush state file: %w", err) | ||
| } | ||
|
|
||
| return nil | ||
| } | ||
| } | ||
|
|
||
| type StateDownloadUrlInput struct { //nolint:staticcheck // type name must match GraphQL schema exactly | ||
| StackID graphql.ID `json:"stackId"` | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.