- Notifications
You must be signed in to change notification settings - Fork928
fix(coderd): only allow untagged provisioners to pick up untagged jobs#12269
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
Changes fromall commits
Commits
Show all changes
4 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
39 changes: 27 additions & 12 deletionscoderd/database/dbmem/dbmem.go
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
9 changes: 7 additions & 2 deletionscoderd/database/queries.sql.go
Some generated files are not rendered by default. Learn more abouthow customized files appear on GitHub.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
9 changes: 7 additions & 2 deletionscoderd/database/queries/provisionerjobs.sql
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 |
|---|---|---|
| @@ -21,8 +21,13 @@ WHERE | ||
| nested.started_at IS NULL | ||
| -- Ensure the caller has the correct provisioner. | ||
| AND nested.provisioner = ANY(@types :: provisioner_type [ ]) | ||
| AND CASE | ||
| -- Special case for untagged provisioners: only match untagged jobs. | ||
| WHEN nested.tags :: jsonb = '{"scope": "organization", "owner": ""}' :: jsonb | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. When we assign @ tags, will it always contain MemberAuthor There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. We make sure to call | ||
| THEN nested.tags :: jsonb = @tags :: jsonb | ||
| -- Ensure the caller satisfies all job tags. | ||
| ELSE nested.tags :: jsonb <@ @tags :: jsonb | ||
| END | ||
| ORDER BY | ||
| nested.created_at | ||
| FOR UPDATE | ||
130 changes: 130 additions & 0 deletionscoderd/provisionerdserver/acquirer_test.go
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 |
|---|---|---|
| @@ -9,6 +9,7 @@ import ( | ||
| "time" | ||
| "github.com/google/uuid" | ||
| "github.com/sqlc-dev/pqtype" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| "go.uber.org/goleak" | ||
| @@ -18,6 +19,8 @@ import ( | ||
| "cdr.dev/slog/sloggers/slogtest" | ||
| "github.com/coder/coder/v2/coderd/database" | ||
| "github.com/coder/coder/v2/coderd/database/dbmem" | ||
| "github.com/coder/coder/v2/coderd/database/dbtestutil" | ||
| "github.com/coder/coder/v2/coderd/database/dbtime" | ||
| "github.com/coder/coder/v2/coderd/database/provisionerjobs" | ||
| "github.com/coder/coder/v2/coderd/database/pubsub" | ||
| "github.com/coder/coder/v2/coderd/provisionerdserver" | ||
| @@ -315,6 +318,133 @@ func TestAcquirer_UnblockOnCancel(t *testing.T) { | ||
| require.Equal(t, jobID, job.ID) | ||
| } | ||
| func TestAcquirer_MatchTags(t *testing.T) { | ||
| t.Parallel() | ||
| if testing.Short() { | ||
| t.Skip("skipping this test due to -short") | ||
| } | ||
| someID := uuid.NewString() | ||
| someOtherID := uuid.NewString() | ||
| for _, tt := range []struct { | ||
| name string | ||
| provisionerJobTags map[string]string | ||
| acquireJobTags map[string]string | ||
| expectAcquire bool | ||
| }{ | ||
| { | ||
| name: "untagged provisioner and untagged job", | ||
| provisionerJobTags: map[string]string{"scope": "organization", "owner": ""}, | ||
| acquireJobTags: map[string]string{"scope": "organization", "owner": ""}, | ||
| expectAcquire: true, | ||
| }, | ||
| { | ||
| name: "untagged provisioner and tagged job", | ||
| provisionerJobTags: map[string]string{"scope": "organization", "owner": "", "foo": "bar"}, | ||
| acquireJobTags: map[string]string{"scope": "organization", "owner": ""}, | ||
| expectAcquire: false, | ||
| }, | ||
| { | ||
| name: "tagged provisioner and untagged job", | ||
| provisionerJobTags: map[string]string{"scope": "organization", "owner": ""}, | ||
| acquireJobTags: map[string]string{"scope": "organization", "owner": "", "foo": "bar"}, | ||
| expectAcquire: false, | ||
| }, | ||
Comment on lines +348 to +353 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others.Learn more. review: this is the behaviour that changes | ||
| { | ||
| name: "tagged provisioner and tagged job", | ||
| provisionerJobTags: map[string]string{"scope": "organization", "owner": "", "foo": "bar"}, | ||
| acquireJobTags: map[string]string{"scope": "organization", "owner": "", "foo": "bar"}, | ||
| expectAcquire: true, | ||
| }, | ||
| { | ||
| name: "tagged provisioner and double-tagged job", | ||
| provisionerJobTags: map[string]string{"scope": "organization", "owner": "", "foo": "bar", "baz": "zap"}, | ||
| acquireJobTags: map[string]string{"scope": "organization", "owner": "", "foo": "bar"}, | ||
| expectAcquire: false, | ||
| }, | ||
| { | ||
| name: "double-tagged provisioner and tagged job", | ||
| provisionerJobTags: map[string]string{"scope": "organization", "owner": "", "foo": "bar"}, | ||
| acquireJobTags: map[string]string{"scope": "organization", "owner": "", "foo": "bar", "baz": "zap"}, | ||
| expectAcquire: true, | ||
| }, | ||
| { | ||
| name: "double-tagged provisioner and double-tagged job", | ||
| provisionerJobTags: map[string]string{"scope": "organization", "owner": "", "foo": "bar", "baz": "zap"}, | ||
| acquireJobTags: map[string]string{"scope": "organization", "owner": "", "foo": "bar", "baz": "zap"}, | ||
| expectAcquire: true, | ||
| }, | ||
| { | ||
| name: "owner-scoped provisioner and untagged job", | ||
| provisionerJobTags: map[string]string{"scope": "organization", "owner": ""}, | ||
| acquireJobTags: map[string]string{"scope": "owner", "owner": someID}, | ||
| expectAcquire: false, | ||
| }, | ||
| { | ||
| name: "owner-scoped provisioner and owner-scoped job", | ||
| provisionerJobTags: map[string]string{"scope": "owner", "owner": someID}, | ||
| acquireJobTags: map[string]string{"scope": "owner", "owner": someID}, | ||
| expectAcquire: true, | ||
| }, | ||
| { | ||
| name: "owner-scoped provisioner and different owner-scoped job", | ||
| provisionerJobTags: map[string]string{"scope": "owner", "owner": someOtherID}, | ||
| acquireJobTags: map[string]string{"scope": "owner", "owner": someID}, | ||
| expectAcquire: false, | ||
| }, | ||
| { | ||
| name: "org-scoped provisioner and owner-scoped job", | ||
| provisionerJobTags: map[string]string{"scope": "owner", "owner": someID}, | ||
| acquireJobTags: map[string]string{"scope": "organization", "owner": ""}, | ||
| expectAcquire: false, | ||
| }, | ||
| } { | ||
| tt := tt | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| t.Parallel() | ||
| ctx := testutil.Context(t, testutil.WaitShort/2) | ||
| // NOTE: explicitly not using fake store for this test. | ||
| db, ps := dbtestutil.NewDB(t) | ||
| log := slogtest.Make(t, nil).Leveled(slog.LevelDebug) | ||
| org, err := db.InsertOrganization(ctx, database.InsertOrganizationParams{ | ||
| ID: uuid.New(), | ||
| Name: "test org", | ||
| Description: "the organization of testing", | ||
| CreatedAt: dbtime.Now(), | ||
| UpdatedAt: dbtime.Now(), | ||
| }) | ||
| require.NoError(t, err) | ||
| pj, err := db.InsertProvisionerJob(ctx, database.InsertProvisionerJobParams{ | ||
| ID: uuid.New(), | ||
| CreatedAt: dbtime.Now(), | ||
| UpdatedAt: dbtime.Now(), | ||
| OrganizationID: org.ID, | ||
| InitiatorID: uuid.New(), | ||
| Provisioner: database.ProvisionerTypeEcho, | ||
| StorageMethod: database.ProvisionerStorageMethodFile, | ||
| FileID: uuid.New(), | ||
| Type: database.ProvisionerJobTypeWorkspaceBuild, | ||
| Input: []byte("{}"), | ||
| Tags: tt.provisionerJobTags, | ||
| TraceMetadata: pqtype.NullRawMessage{}, | ||
| }) | ||
| require.NoError(t, err) | ||
| ptypes := []database.ProvisionerType{database.ProvisionerTypeEcho} | ||
| acq := provisionerdserver.NewAcquirer(ctx, log, db, ps) | ||
| aj, err := acq.AcquireJob(ctx, uuid.New(), ptypes, tt.acquireJobTags) | ||
| if tt.expectAcquire { | ||
| assert.NoError(t, err) | ||
| assert.Equal(t, pj.ID, aj.ID) | ||
| } else { | ||
| assert.Empty(t, aj, "should not have acquired job") | ||
| assert.ErrorIs(t, err, context.DeadlineExceeded, "should have timed out") | ||
| } | ||
| }) | ||
| } | ||
| } | ||
| func postJob(t *testing.T, ps pubsub.Pubsub, pt database.ProvisionerType, tags provisionerdserver.Tags) { | ||
| t.Helper() | ||
| msg, err := json.Marshal(provisionerjobs.JobPosting{ | ||
5 changes: 2 additions & 3 deletionsenterprise/cli/provisionerdaemons.go
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
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.