mirror of
https://github.com/coder/coder.git
synced 2026-06-04 13:38:21 +00:00
Kacper Sawicki
6ca70d3618
## Summary
Adds a `--no-build` flag to `coder state push` that updates the
Terraform state directly without triggering a workspace build.
## Use Case
This enables state-only migrations, such as migrating Kubernetes
resources from deprecated types (e.g., `kubernetes_config_map`) to
versioned types (e.g., `kubernetes_config_map_v1`):
```bash
coder state pull my-workspace > state.json
terraform init
terraform state rm -state=state.json kubernetes_config_map.example
terraform import -state=state.json kubernetes_config_map_v1.example default/example
coder state push --no-build my-workspace state.json
```
## Changes
- Add `PUT /api/v2/workspacebuilds/{id}/state` endpoint to update state
without triggering a build
- Add `UpdateWorkspaceBuildState` SDK method
- Add `--no-build`/`-n` flag to `coder state push`
- Add confirmation prompt (can be skipped with `--yes`/`-y`) since this
is a potentially dangerous operation
- Add test for `--no-build` functionality
Fixes #21336
208 lines
8.1 KiB
Go
208 lines
8.1 KiB
Go
package cli_test
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
"strconv"
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/coder/coder/v2/cli/clitest"
|
|
"github.com/coder/coder/v2/coderd/coderdtest"
|
|
"github.com/coder/coder/v2/coderd/database"
|
|
"github.com/coder/coder/v2/coderd/database/dbauthz"
|
|
"github.com/coder/coder/v2/coderd/database/dbfake"
|
|
"github.com/coder/coder/v2/coderd/rbac"
|
|
"github.com/coder/coder/v2/provisioner/echo"
|
|
)
|
|
|
|
func TestStatePull(t *testing.T) {
|
|
t.Parallel()
|
|
t.Run("File", func(t *testing.T) {
|
|
t.Parallel()
|
|
client, store := coderdtest.NewWithDatabase(t, nil)
|
|
owner := coderdtest.CreateFirstUser(t, client)
|
|
templateAdmin, taUser := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID, rbac.RoleTemplateAdmin())
|
|
wantState := []byte("some state")
|
|
r := dbfake.WorkspaceBuild(t, store, database.WorkspaceTable{
|
|
OrganizationID: owner.OrganizationID,
|
|
OwnerID: taUser.ID,
|
|
}).
|
|
Seed(database.WorkspaceBuild{ProvisionerState: wantState}).
|
|
Do()
|
|
statefilePath := filepath.Join(t.TempDir(), "state")
|
|
inv, root := clitest.New(t, "state", "pull", r.Workspace.Name, statefilePath)
|
|
clitest.SetupConfig(t, templateAdmin, root)
|
|
err := inv.Run()
|
|
require.NoError(t, err)
|
|
gotState, err := os.ReadFile(statefilePath)
|
|
require.NoError(t, err)
|
|
require.Equal(t, wantState, gotState)
|
|
})
|
|
t.Run("Stdout", func(t *testing.T) {
|
|
t.Parallel()
|
|
client, store := coderdtest.NewWithDatabase(t, nil)
|
|
owner := coderdtest.CreateFirstUser(t, client)
|
|
templateAdmin, taUser := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID, rbac.RoleTemplateAdmin())
|
|
wantState := []byte("some state")
|
|
r := dbfake.WorkspaceBuild(t, store, database.WorkspaceTable{
|
|
OrganizationID: owner.OrganizationID,
|
|
OwnerID: taUser.ID,
|
|
}).
|
|
Seed(database.WorkspaceBuild{ProvisionerState: wantState}).
|
|
Do()
|
|
inv, root := clitest.New(t, "state", "pull", r.Workspace.Name)
|
|
var gotState bytes.Buffer
|
|
inv.Stdout = &gotState
|
|
clitest.SetupConfig(t, templateAdmin, root)
|
|
err := inv.Run()
|
|
require.NoError(t, err)
|
|
require.Equal(t, wantState, bytes.TrimSpace(gotState.Bytes()))
|
|
})
|
|
t.Run("OtherUserBuild", func(t *testing.T) {
|
|
t.Parallel()
|
|
client, store := coderdtest.NewWithDatabase(t, nil)
|
|
owner := coderdtest.CreateFirstUser(t, client)
|
|
_, taUser := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID, rbac.RoleTemplateAdmin())
|
|
wantState := []byte("some state")
|
|
r := dbfake.WorkspaceBuild(t, store, database.WorkspaceTable{
|
|
OrganizationID: owner.OrganizationID,
|
|
OwnerID: taUser.ID,
|
|
}).
|
|
Seed(database.WorkspaceBuild{ProvisionerState: wantState}).
|
|
Do()
|
|
inv, root := clitest.New(t, "state", "pull", taUser.Username+"/"+r.Workspace.Name,
|
|
"--build", fmt.Sprintf("%d", r.Build.BuildNumber))
|
|
var gotState bytes.Buffer
|
|
inv.Stdout = &gotState
|
|
//nolint: gocritic // this tests owner pulling another user's state
|
|
clitest.SetupConfig(t, client, root)
|
|
err := inv.Run()
|
|
require.NoError(t, err)
|
|
require.Equal(t, wantState, bytes.TrimSpace(gotState.Bytes()))
|
|
})
|
|
}
|
|
|
|
func TestStatePush(t *testing.T) {
|
|
t.Parallel()
|
|
t.Run("File", func(t *testing.T) {
|
|
t.Parallel()
|
|
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
|
|
owner := coderdtest.CreateFirstUser(t, client)
|
|
templateAdmin, _ := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID, rbac.RoleTemplateAdmin())
|
|
version := coderdtest.CreateTemplateVersion(t, client, owner.OrganizationID, &echo.Responses{
|
|
Parse: echo.ParseComplete,
|
|
ProvisionApply: echo.ApplyComplete,
|
|
})
|
|
coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID)
|
|
template := coderdtest.CreateTemplate(t, client, owner.OrganizationID, version.ID)
|
|
workspace := coderdtest.CreateWorkspace(t, templateAdmin, template.ID)
|
|
coderdtest.AwaitWorkspaceBuildJobCompleted(t, client, workspace.LatestBuild.ID)
|
|
stateFile, err := os.CreateTemp(t.TempDir(), "")
|
|
require.NoError(t, err)
|
|
wantState := []byte("some magic state")
|
|
_, err = stateFile.Write(wantState)
|
|
require.NoError(t, err)
|
|
err = stateFile.Close()
|
|
require.NoError(t, err)
|
|
inv, root := clitest.New(t, "state", "push", workspace.Name, stateFile.Name())
|
|
clitest.SetupConfig(t, templateAdmin, root)
|
|
err = inv.Run()
|
|
require.NoError(t, err)
|
|
})
|
|
|
|
t.Run("Stdin", func(t *testing.T) {
|
|
t.Parallel()
|
|
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
|
|
owner := coderdtest.CreateFirstUser(t, client)
|
|
templateAdmin, _ := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID, rbac.RoleTemplateAdmin())
|
|
version := coderdtest.CreateTemplateVersion(t, client, owner.OrganizationID, &echo.Responses{
|
|
Parse: echo.ParseComplete,
|
|
ProvisionApply: echo.ApplyComplete,
|
|
})
|
|
coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID)
|
|
template := coderdtest.CreateTemplate(t, client, owner.OrganizationID, version.ID)
|
|
workspace := coderdtest.CreateWorkspace(t, templateAdmin, template.ID)
|
|
coderdtest.AwaitWorkspaceBuildJobCompleted(t, client, workspace.LatestBuild.ID)
|
|
inv, root := clitest.New(t, "state", "push", "--build", strconv.Itoa(int(workspace.LatestBuild.BuildNumber)), workspace.Name, "-")
|
|
clitest.SetupConfig(t, templateAdmin, root)
|
|
inv.Stdin = strings.NewReader("some magic state")
|
|
err := inv.Run()
|
|
require.NoError(t, err)
|
|
})
|
|
|
|
t.Run("OtherUserBuild", func(t *testing.T) {
|
|
t.Parallel()
|
|
client := coderdtest.New(t, &coderdtest.Options{IncludeProvisionerDaemon: true})
|
|
owner := coderdtest.CreateFirstUser(t, client)
|
|
templateAdmin, taUser := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID, rbac.RoleTemplateAdmin())
|
|
version := coderdtest.CreateTemplateVersion(t, client, owner.OrganizationID, &echo.Responses{
|
|
Parse: echo.ParseComplete,
|
|
ProvisionApply: echo.ApplyComplete,
|
|
})
|
|
coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID)
|
|
template := coderdtest.CreateTemplate(t, client, owner.OrganizationID, version.ID)
|
|
workspace := coderdtest.CreateWorkspace(t, templateAdmin, template.ID)
|
|
coderdtest.AwaitWorkspaceBuildJobCompleted(t, client, workspace.LatestBuild.ID)
|
|
inv, root := clitest.New(t, "state", "push",
|
|
"--build", strconv.Itoa(int(workspace.LatestBuild.BuildNumber)),
|
|
taUser.Username+"/"+workspace.Name,
|
|
"-")
|
|
//nolint: gocritic // this tests owner pushing another user's state
|
|
clitest.SetupConfig(t, client, root)
|
|
inv.Stdin = strings.NewReader("some magic state")
|
|
err := inv.Run()
|
|
require.NoError(t, err)
|
|
})
|
|
|
|
t.Run("NoBuild", func(t *testing.T) {
|
|
t.Parallel()
|
|
client, store := coderdtest.NewWithDatabase(t, nil)
|
|
owner := coderdtest.CreateFirstUser(t, client)
|
|
templateAdmin, taUser := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID, rbac.RoleTemplateAdmin())
|
|
initialState := []byte("initial state")
|
|
r := dbfake.WorkspaceBuild(t, store, database.WorkspaceTable{
|
|
OrganizationID: owner.OrganizationID,
|
|
OwnerID: taUser.ID,
|
|
}).
|
|
Seed(database.WorkspaceBuild{ProvisionerState: initialState}).
|
|
Do()
|
|
wantState := []byte("updated state")
|
|
stateFile, err := os.CreateTemp(t.TempDir(), "")
|
|
require.NoError(t, err)
|
|
_, err = stateFile.Write(wantState)
|
|
require.NoError(t, err)
|
|
err = stateFile.Close()
|
|
require.NoError(t, err)
|
|
|
|
inv, root := clitest.New(t, "state", "push", "--no-build", r.Workspace.Name, stateFile.Name())
|
|
clitest.SetupConfig(t, templateAdmin, root)
|
|
var stdout bytes.Buffer
|
|
inv.Stdout = &stdout
|
|
err = inv.Run()
|
|
require.NoError(t, err)
|
|
require.Contains(t, stdout.String(), "State updated successfully")
|
|
|
|
// Verify the state was updated by pulling it.
|
|
inv, root = clitest.New(t, "state", "pull", r.Workspace.Name)
|
|
var gotState bytes.Buffer
|
|
inv.Stdout = &gotState
|
|
clitest.SetupConfig(t, templateAdmin, root)
|
|
err = inv.Run()
|
|
require.NoError(t, err)
|
|
require.Equal(t, wantState, bytes.TrimSpace(gotState.Bytes()))
|
|
|
|
// Verify no new build was created.
|
|
builds, err := store.GetWorkspaceBuildsByWorkspaceID(dbauthz.AsSystemRestricted(context.Background()), database.GetWorkspaceBuildsByWorkspaceIDParams{
|
|
WorkspaceID: r.Workspace.ID,
|
|
})
|
|
require.NoError(t, err)
|
|
require.Len(t, builds, 1, "expected only the initial build, no new build should be created")
|
|
})
|
|
}
|