mirror of
https://github.com/coder/coder.git
synced 2025-07-03 16:13:58 +00:00
chore(coderd/database): enforce agent name unique within workspace build (#18052)
Adds a database trigger that runs on insert and update of the `workspace_agents` table. The trigger ensures that the agent name is unique within the context of the workspace build it is being inserted into.
This commit is contained in:
Danielle Maywood
GitHub
@ -4,12 +4,14 @@ import (
|
||||
"context"
|
||||
"database/sql"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"sort"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/google/uuid"
|
||||
"github.com/lib/pq"
|
||||
"github.com/prometheus/client_golang/prometheus"
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
@ -4720,6 +4722,238 @@ func TestGetPresetsAtFailureLimit(t *testing.T) {
|
||||
})
|
||||
}
|
||||
|
||||
func TestWorkspaceAgentNameUniqueTrigger(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
if !dbtestutil.WillUsePostgres() {
|
||||
t.Skip("This test makes use of a database trigger not implemented in dbmem")
|
||||
}
|
||||
|
||||
createWorkspaceWithAgent := func(t *testing.T, db database.Store, org database.Organization, agentName string) (database.WorkspaceBuild, database.WorkspaceResource, database.WorkspaceAgent) {
|
||||
t.Helper()
|
||||
|
||||
user := dbgen.User(t, db, database.User{})
|
||||
template := dbgen.Template(t, db, database.Template{
|
||||
OrganizationID: org.ID,
|
||||
CreatedBy: user.ID,
|
||||
})
|
||||
templateVersion := dbgen.TemplateVersion(t, db, database.TemplateVersion{
|
||||
TemplateID: uuid.NullUUID{Valid: true, UUID: template.ID},
|
||||
OrganizationID: org.ID,
|
||||
CreatedBy: user.ID,
|
||||
})
|
||||
workspace := dbgen.Workspace(t, db, database.WorkspaceTable{
|
||||
OrganizationID: org.ID,
|
||||
TemplateID: template.ID,
|
||||
OwnerID: user.ID,
|
||||
})
|
||||
job := dbgen.ProvisionerJob(t, db, nil, database.ProvisionerJob{
|
||||
Type: database.ProvisionerJobTypeWorkspaceBuild,
|
||||
OrganizationID: org.ID,
|
||||
})
|
||||
build := dbgen.WorkspaceBuild(t, db, database.WorkspaceBuild{
|
||||
BuildNumber: 1,
|
||||
JobID: job.ID,
|
||||
WorkspaceID: workspace.ID,
|
||||
TemplateVersionID: templateVersion.ID,
|
||||
})
|
||||
resource := dbgen.WorkspaceResource(t, db, database.WorkspaceResource{
|
||||
JobID: build.JobID,
|
||||
})
|
||||
agent := dbgen.WorkspaceAgent(t, db, database.WorkspaceAgent{
|
||||
ResourceID: resource.ID,
|
||||
Name: agentName,
|
||||
})
|
||||
|
||||
return build, resource, agent
|
||||
}
|
||||
|
||||
t.Run("DuplicateNamesInSameWorkspaceResource", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
db, _ := dbtestutil.NewDB(t)
|
||||
org := dbgen.Organization(t, db, database.Organization{})
|
||||
ctx := testutil.Context(t, testutil.WaitShort)
|
||||
|
||||
// Given: A workspace with an agent
|
||||
_, resource, _ := createWorkspaceWithAgent(t, db, org, "duplicate-agent")
|
||||
|
||||
// When: Another agent is created for that workspace with the same name.
|
||||
_, err := db.InsertWorkspaceAgent(ctx, database.InsertWorkspaceAgentParams{
|
||||
ID: uuid.New(),
|
||||
CreatedAt: time.Now(),
|
||||
UpdatedAt: time.Now(),
|
||||
Name: "duplicate-agent", // Same name as agent1
|
||||
ResourceID: resource.ID,
|
||||
AuthToken: uuid.New(),
|
||||
Architecture: "amd64",
|
||||
OperatingSystem: "linux",
|
||||
APIKeyScope: database.AgentKeyScopeEnumAll,
|
||||
})
|
||||
|
||||
// Then: We expect it to fail.
|
||||
require.Error(t, err)
|
||||
var pqErr *pq.Error
|
||||
require.True(t, errors.As(err, &pqErr))
|
||||
require.Equal(t, pq.ErrorCode("23505"), pqErr.Code) // unique_violation
|
||||
require.Contains(t, pqErr.Message, `workspace agent name "duplicate-agent" already exists in this workspace build`)
|
||||
})
|
||||
|
||||
t.Run("DuplicateNamesInSameProvisionerJob", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
db, _ := dbtestutil.NewDB(t)
|
||||
org := dbgen.Organization(t, db, database.Organization{})
|
||||
ctx := testutil.Context(t, testutil.WaitShort)
|
||||
|
||||
// Given: A workspace with an agent
|
||||
_, resource, agent := createWorkspaceWithAgent(t, db, org, "duplicate-agent")
|
||||
|
||||
// When: A child agent is created for that workspace with the same name.
|
||||
_, err := db.InsertWorkspaceAgent(ctx, database.InsertWorkspaceAgentParams{
|
||||
ID: uuid.New(),
|
||||
CreatedAt: time.Now(),
|
||||
UpdatedAt: time.Now(),
|
||||
Name: agent.Name,
|
||||
ResourceID: resource.ID,
|
||||
AuthToken: uuid.New(),
|
||||
Architecture: "amd64",
|
||||
OperatingSystem: "linux",
|
||||
APIKeyScope: database.AgentKeyScopeEnumAll,
|
||||
})
|
||||
|
||||
// Then: We expect it to fail.
|
||||
require.Error(t, err)
|
||||
var pqErr *pq.Error
|
||||
require.True(t, errors.As(err, &pqErr))
|
||||
require.Equal(t, pq.ErrorCode("23505"), pqErr.Code) // unique_violation
|
||||
require.Contains(t, pqErr.Message, `workspace agent name "duplicate-agent" already exists in this workspace build`)
|
||||
})
|
||||
|
||||
t.Run("DuplicateChildNamesOverMultipleResources", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
db, _ := dbtestutil.NewDB(t)
|
||||
org := dbgen.Organization(t, db, database.Organization{})
|
||||
ctx := testutil.Context(t, testutil.WaitShort)
|
||||
|
||||
// Given: A workspace with two agents
|
||||
_, resource1, agent1 := createWorkspaceWithAgent(t, db, org, "parent-agent-1")
|
||||
|
||||
resource2 := dbgen.WorkspaceResource(t, db, database.WorkspaceResource{JobID: resource1.JobID})
|
||||
agent2 := dbgen.WorkspaceAgent(t, db, database.WorkspaceAgent{
|
||||
ResourceID: resource2.ID,
|
||||
Name: "parent-agent-2",
|
||||
})
|
||||
|
||||
// Given: One agent has a child agent
|
||||
agent1Child := dbgen.WorkspaceAgent(t, db, database.WorkspaceAgent{
|
||||
ParentID: uuid.NullUUID{Valid: true, UUID: agent1.ID},
|
||||
Name: "child-agent",
|
||||
ResourceID: resource1.ID,
|
||||
})
|
||||
|
||||
// When: A child agent is inserted for the other parent.
|
||||
_, err := db.InsertWorkspaceAgent(ctx, database.InsertWorkspaceAgentParams{
|
||||
ID: uuid.New(),
|
||||
ParentID: uuid.NullUUID{Valid: true, UUID: agent2.ID},
|
||||
CreatedAt: time.Now(),
|
||||
UpdatedAt: time.Now(),
|
||||
Name: agent1Child.Name,
|
||||
ResourceID: resource2.ID,
|
||||
AuthToken: uuid.New(),
|
||||
Architecture: "amd64",
|
||||
OperatingSystem: "linux",
|
||||
APIKeyScope: database.AgentKeyScopeEnumAll,
|
||||
})
|
||||
|
||||
// Then: We expect it to fail.
|
||||
require.Error(t, err)
|
||||
var pqErr *pq.Error
|
||||
require.True(t, errors.As(err, &pqErr))
|
||||
require.Equal(t, pq.ErrorCode("23505"), pqErr.Code) // unique_violation
|
||||
require.Contains(t, pqErr.Message, `workspace agent name "child-agent" already exists in this workspace build`)
|
||||
})
|
||||
|
||||
t.Run("SameNamesInDifferentWorkspaces", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
agentName := "same-name-different-workspace"
|
||||
|
||||
db, _ := dbtestutil.NewDB(t)
|
||||
org := dbgen.Organization(t, db, database.Organization{})
|
||||
|
||||
// Given: A workspace with an agent
|
||||
_, _, agent1 := createWorkspaceWithAgent(t, db, org, agentName)
|
||||
require.Equal(t, agentName, agent1.Name)
|
||||
|
||||
// When: A second workspace is created with an agent having the same name
|
||||
_, _, agent2 := createWorkspaceWithAgent(t, db, org, agentName)
|
||||
require.Equal(t, agentName, agent2.Name)
|
||||
|
||||
// Then: We expect there to be different agents with the same name.
|
||||
require.NotEqual(t, agent1.ID, agent2.ID)
|
||||
require.Equal(t, agent1.Name, agent2.Name)
|
||||
})
|
||||
|
||||
t.Run("NullWorkspaceID", func(t *testing.T) {
|
||||
t.Parallel()
|
||||
|
||||
db, _ := dbtestutil.NewDB(t)
|
||||
org := dbgen.Organization(t, db, database.Organization{})
|
||||
ctx := testutil.Context(t, testutil.WaitShort)
|
||||
|
||||
// Given: A resource that does not belong to a workspace build (simulating template import)
|
||||
orphanJob := dbgen.ProvisionerJob(t, db, nil, database.ProvisionerJob{
|
||||
Type: database.ProvisionerJobTypeTemplateVersionImport,
|
||||
OrganizationID: org.ID,
|
||||
})
|
||||
orphanResource := dbgen.WorkspaceResource(t, db, database.WorkspaceResource{
|
||||
JobID: orphanJob.ID,
|
||||
})
|
||||
|
||||
// And this resource has a workspace agent.
|
||||
agent1, err := db.InsertWorkspaceAgent(ctx, database.InsertWorkspaceAgentParams{
|
||||
ID: uuid.New(),
|
||||
CreatedAt: time.Now(),
|
||||
UpdatedAt: time.Now(),
|
||||
Name: "orphan-agent",
|
||||
ResourceID: orphanResource.ID,
|
||||
AuthToken: uuid.New(),
|
||||
Architecture: "amd64",
|
||||
OperatingSystem: "linux",
|
||||
APIKeyScope: database.AgentKeyScopeEnumAll,
|
||||
})
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, "orphan-agent", agent1.Name)
|
||||
|
||||
// When: We created another resource that does not belong to a workspace build.
|
||||
orphanJob2 := dbgen.ProvisionerJob(t, db, nil, database.ProvisionerJob{
|
||||
Type: database.ProvisionerJobTypeTemplateVersionImport,
|
||||
OrganizationID: org.ID,
|
||||
})
|
||||
orphanResource2 := dbgen.WorkspaceResource(t, db, database.WorkspaceResource{
|
||||
JobID: orphanJob2.ID,
|
||||
})
|
||||
|
||||
// Then: We expect to be able to create an agent in this new resource that has the same name.
|
||||
agent2, err := db.InsertWorkspaceAgent(ctx, database.InsertWorkspaceAgentParams{
|
||||
ID: uuid.New(),
|
||||
CreatedAt: time.Now(),
|
||||
UpdatedAt: time.Now(),
|
||||
Name: "orphan-agent", // Same name as agent1
|
||||
ResourceID: orphanResource2.ID,
|
||||
AuthToken: uuid.New(),
|
||||
Architecture: "amd64",
|
||||
OperatingSystem: "linux",
|
||||
APIKeyScope: database.AgentKeyScopeEnumAll,
|
||||
})
|
||||
require.NoError(t, err)
|
||||
require.Equal(t, "orphan-agent", agent2.Name)
|
||||
require.NotEqual(t, agent1.ID, agent2.ID)
|
||||
})
|
||||
}
|
||||
|
||||
func requireUsersMatch(t testing.TB, expected []database.User, found []database.GetUsersRow, msg string) {
|
||||
t.Helper()
|
||||
require.ElementsMatch(t, expected, database.ConvertUserRows(found), msg)
|
||||
|
||||
Reference in New Issue
Block a user