Skip to content

chore: provisioner acquirer to respect organization ID of jobs #13874

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.

Sign up for GitHub

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 3 commits into from
Jul 11, 2024
Merged

chore: provisioner acquirer to respect organization ID of jobs #13874

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
63bade6
test: add unit test to verify creation of templates in multiple orgs
Emyrk Jul 11, 2024
026d40d
chore: provisioner acquirer to respect organization ID of jobs
Emyrk Jul 11, 2024
32e9a7b
add comment and stricter check
Emyrk Jul 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions coderd/database/provisionerjobs/provisionerjobs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package provisionerjobs
import (
"encoding/json"

"github.com/google/uuid"
"golang.org/x/xerrors"

"github.com/coder/coder/v2/coderd/database"
Expand All @@ -12,12 +13,14 @@ import (
const EventJobPosted = "provisioner_job_posted"

type JobPosting struct {
OrganizationID uuid.UUID `json:"organization_id"`
ProvisionerType database.ProvisionerType `json:"type"`
Tags map[string]string `json:"tags"`
}

func PostJob(ps pubsub.Pubsub, job database.ProvisionerJob) error {
msg, err := json.Marshal(JobPosting{
OrganizationID: job.OrganizationID,
ProvisionerType: job.Provisioner,
Tags: job.Tags,
})
Expand Down
35 changes: 21 additions & 14 deletions coderd/provisionerdserver/acquirer.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -163,13 +163,14 @@ func (a *Acquirer) want(organization uuid.UUID, pt []database.ProvisionerType, t
if !ok {
ctx, cancel := context.WithCancel(a.ctx)
d = domain{
ctx: ctx,
cancel: cancel,
a: a,
key: dk,
pt: pt,
tags: tags,
acquirees: make(map[chan<- struct{}]*acquiree),
ctx: ctx,
cancel: cancel,
a: a,
key: dk,
pt: pt,
tags: tags,
organizationID: organization,
acquirees: make(map[chan<- struct{}]*acquiree),
}
a.q[dk] = d
go d.poll(a.backupPollDuration)
Expand Down Expand Up @@ -450,16 +451,22 @@ type acquiree struct {
// tags. Acquirees in the same domain are restricted such that only one queries
// the database at a time.
type domain struct {
ctx context.Context
cancel context.CancelFunc
a *Acquirer
key dKey
pt []database.ProvisionerType
tags Tags
acquirees map[chan<- struct{}]*acquiree
ctx context.Context
cancel context.CancelFunc
a *Acquirer
key dKey
pt []database.ProvisionerType
tags Tags
organizationID uuid.UUID
acquirees map[chan<- struct{}]*acquiree
}

func (d domain) contains(p provisionerjobs.JobPosting) bool {
// If the organization ID is 'uuid.Nil', this is a legacy job posting.
// Ignore this check in the legacy case.
if p.OrganizationID != uuid.Nil && p.OrganizationID != d.organizationID {
return false
}
if !slices.Contains(d.pt, p.ProvisionerType) {
return false
}
Expand Down
48 changes: 48 additions & 0 deletions enterprise/coderd/templates_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1829,3 +1829,51 @@ func TestTemplateAccess(t *testing.T) {
}
})
}

func TestMultipleOrganizationTemplates(t *testing.T) {
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test would always fail prior to this change.

t.Parallel()

ownerClient, first := coderdenttest.New(t, &coderdenttest.Options{
Options: &coderdtest.Options{
// This only affects the first org.
IncludeProvisionerDaemon: true,
},
LicenseOptions: &coderdenttest.LicenseOptions{
Features: license.Features{
codersdk.FeatureExternalProvisionerDaemons: 1,
},
},
})

templateAdmin, _ := coderdtest.CreateAnotherUser(t, ownerClient, first.OrganizationID, rbac.RoleTemplateAdmin())

second := coderdtest.CreateOrganization(t, ownerClient, coderdtest.CreateOrganizationOptions{
IncludeProvisionerDaemon: true,
})

third := coderdtest.CreateOrganization(t, ownerClient, coderdtest.CreateOrganizationOptions{
IncludeProvisionerDaemon: true,
})

t.Logf("First organization: %s", first.OrganizationID.String())
t.Logf("Second organization: %s", second.ID.String())
t.Logf("Third organization: %s", third.ID.String())

t.Logf("Creating template version in second organization")

start := time.Now()
version := coderdtest.CreateTemplateVersion(t, templateAdmin, second.ID, nil)
coderdtest.AwaitTemplateVersionJobCompleted(t, ownerClient, version.ID)
coderdtest.CreateTemplate(t, templateAdmin, second.ID, version.ID, func(request *codersdk.CreateTemplateRequest) {
request.Name = "random"
})

if time.Since(start) > time.Second*10 {
// The test can sometimes pass because 'AwaitTemplateVersionJobCompleted'
// allows 25s, and the provisioner will check every 30s if not awakened
// from the pubsub. So there is a chance it will pass. If it takes longer
// than 10s, then it's a problem. The provisioner is not getting clearance.
t.Error("Creating template version in second organization took too long")
t.FailNow()
}
}