Files
coder/coderd/workspacesecrets/workspacesecrets_test.go
Steven Masley 03cba25a63 feat: list a workspace build's secrets in coder secret list (#30388)
`coder secret list` now shows the current workspace build's secrets next to your user secrets, and which user secrets they replace. Part of [RELAY-7](https://linear.app/codercom/issue/RELAY-7/agent-relay-deliver-provider-credentials-via-coder-secrets-instead-of).

**Stack** (design decisions in #30248)
1. #30248 Database schema, queries, and RBAC
2. #30249 Encryption at rest
3. #30250 Set secrets on workspace builds
4. #30251 Deliver secrets to the agent
5. #30252 Docs
6. **#30388 List a build's secrets (this PR)**
7. #30459 Audit a build's secrets

- New `GET /workspacebuilds/{workspacebuild}/secrets` lists a build's secrets (metadata only, never values) and which user secret each one replaces.
- Inside a workspace, `coder secret list` includes the current build's secrets. Outside a workspace, use `--workspace` or `--build-id`.
- The agent now exposes `CODER_WORKSPACE_BUILD_ID`, so the CLI knows which build it is running in.
- The agent manifest and the new endpoint use one shared resolver, so they always agree on which secret wins.
- The user secret API is unchanged.

<details>
<summary>Implementation details</summary>

- The manifest carries `workspace_build_id`; the agent sets it as `CODER_WORKSPACE_BUILD_ID`.
- `coderd/workspacesecrets.Resolve(user, build, policy)` decides which secret is delivered on each env var and file. The manifest no longer relies on entry order.
- `codersdk.WorkspaceSecret` embeds `UserSecret` and adds `workspace_build_id`, `ephemeral`, `cleared_at`, `env_replaces`, and `file_replaces`. Secrets whose values a later build cleared are still listed, with `cleared_at` set.
- CLI columns: `source` and `replaced by` are shown by default only when a build is included; `ephemeral` is opt-in. The CLI makes two requests: user secrets, then build secrets.
- Agents that predate the build ID fall back to `CODER_WORKSPACE_ID` and its latest build.

</details>

<details>
<summary>Decision log</summary>

(existing decision log, unchanged)

</details>

---

*Created by Coder Agents on behalf of @Emyrk.*
2026-10-15 17:40:00 -05:00

71 lines
2.6 KiB
Go

package workspacesecrets_test
import (
"testing"
"github.com/google/uuid"
"github.com/stretchr/testify/require"
"github.com/coder/coder/v2/coderd/workspacesecrets"
)
func TestResolve(t *testing.T) {
t.Parallel()
secret := func(env, file string, enabled bool) workspacesecrets.Secret {
return workspacesecrets.Secret{ID: uuid.New(), EnvName: env, FilePath: file, Enabled: enabled}
}
var (
userBoth = secret("TOKEN", "/etc/token", true)
userFileOnly = secret("", "~/a/cert", true)
userDisabled = secret("DISABLED", "", false)
userPlain = secret("PLAIN", "", true)
buildEnv = secret("TOKEN", "", true)
// Written differently from userFileOnly's path, but the same file.
buildFile = secret("", "~/a//cert", true)
// Enabled is ignored for build secrets.
buildOnDis = secret("DISABLED", "", false)
)
user := []workspacesecrets.Secret{userBoth, userFileOnly, userDisabled, userPlain}
build := []workspacesecrets.Secret{buildEnv, buildFile, buildOnDis}
t.Run("FilePathAllowed", func(t *testing.T) {
t.Parallel()
gotUser, gotBuild := workspacesecrets.Resolve(user, build, workspacesecrets.FilePathAllowed)
require.Len(t, gotUser, len(user))
require.Len(t, gotBuild, len(build))
// Partial override: the env var is taken, the file is still delivered.
require.Empty(t, gotUser[0].DeliveredEnvName)
require.Equal(t, uuid.NullUUID{UUID: buildEnv.ID, Valid: true}, gotUser[0].EnvReplacedBy)
require.Equal(t, "/etc/token", gotUser[0].DeliveredFilePath)
require.False(t, gotUser[0].FileReplacedBy.Valid)
require.True(t, gotUser[0].Delivered())
// Full override, matched on the cleaned path.
require.False(t, gotUser[1].Delivered())
require.Equal(t, uuid.NullUUID{UUID: buildFile.ID, Valid: true}, gotUser[1].FileReplacedBy)
// Disabled user secrets are neither delivered nor replaced.
require.False(t, gotUser[2].Delivered())
require.False(t, gotUser[2].EnvReplacedBy.Valid)
require.Equal(t, "PLAIN", gotUser[3].DeliveredEnvName)
require.Equal(t, "TOKEN", gotBuild[0].DeliveredEnvName)
require.Equal(t, "~/a//cert", gotBuild[1].DeliveredFilePath, "the path is delivered as written")
require.Equal(t, "DISABLED", gotBuild[2].DeliveredEnvName)
})
t.Run("FilePathBlocked", func(t *testing.T) {
t.Parallel()
gotUser, gotBuild := workspacesecrets.Resolve(user, build, workspacesecrets.FilePathBlocked)
// No file is delivered, so no file target is reported as replaced.
require.False(t, gotUser[0].Delivered())
require.False(t, gotUser[1].Delivered())
require.False(t, gotUser[1].FileReplacedBy.Valid)
require.False(t, gotBuild[1].Delivered())
})
}