- Notifications
You must be signed in to change notification settings - Fork1k
feat: add filtering by initiator to provisioner job listing in the CLI#20137
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
8 commits Select commitHold shift + click to select a range
c0d3650 feat: allow the provisioner jobs list command to filter by initiator
SasSwart89febea add a shorthand flag for the initiator
SasSwart14d2906 add API level tests for provisioner job listing with initiator filter
SasSwart8cc77d0 make -B gen
SasSwart1a797ac add missing property in testHelpers
SasSwartd5c16c4 rename parameter to allow more flexible use in a follow-up
SasSwart39bcac2 make -B gen
SasSwartc4a89d0 Merge branch 'main' into jjs/internal-934
SasSwartFile 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
27 changes: 23 additions & 4 deletionscli/provisionerjobs.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
192 changes: 168 additions & 24 deletionscli/provisionerjobs_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 |
|---|---|---|
| @@ -5,6 +5,7 @@ import ( | ||
| "database/sql" | ||
| "encoding/json" | ||
| "fmt" | ||
| "strings" | ||
| "testing" | ||
| "time" | ||
| @@ -26,33 +27,32 @@ import ( | ||
| func TestProvisionerJobs(t *testing.T) { | ||
| t.Parallel() | ||
| t.Run("Cancel", func(t *testing.T) { | ||
| t.Parallel() | ||
| db, ps := dbtestutil.NewDB(t) | ||
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. Moving this inside the subtest to properly isolate these tests from the list subcommand tests | ||
| client, _, coderdAPI := coderdtest.NewWithAPI(t, &coderdtest.Options{ | ||
| IncludeProvisionerDaemon: false, | ||
| Database: db, | ||
| Pubsub: ps, | ||
| }) | ||
| owner := coderdtest.CreateFirstUser(t, client) | ||
| templateAdminClient, templateAdmin := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID, rbac.ScopedRoleOrgTemplateAdmin(owner.OrganizationID)) | ||
| memberClient, member := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID) | ||
| // These CLI tests are related to provisioner job CRUD operations and as such | ||
| // do not require the overhead of starting a provisioner. Other provisioner job | ||
| // functionalities (acquisition etc.) are tested elsewhere. | ||
| template := dbgen.Template(t, db, database.Template{ | ||
| OrganizationID: owner.OrganizationID, | ||
| CreatedBy: owner.UserID, | ||
| AllowUserCancelWorkspaceJobs: true, | ||
| }) | ||
| version := dbgen.TemplateVersion(t, db, database.TemplateVersion{ | ||
| OrganizationID: owner.OrganizationID, | ||
| CreatedBy: owner.UserID, | ||
| TemplateID: uuid.NullUUID{UUID: template.ID, Valid: true}, | ||
| }) | ||
| // Test helper to create a provisioner job of a given type with a given input. | ||
| prepareJob := func(t *testing.T, jobType database.ProvisionerJobType, input json.RawMessage) database.ProvisionerJob { | ||
| t.Helper() | ||
| @@ -178,4 +178,148 @@ func TestProvisionerJobs(t *testing.T) { | ||
| }) | ||
| } | ||
| }) | ||
| t.Run("List", func(t *testing.T) { | ||
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. There were no tests for the list subcommand. I've added some basic test cases as a scouting effort, but I focus on the tests to prove my own work right now. | ||
| t.Parallel() | ||
| db, ps := dbtestutil.NewDB(t) | ||
| client, _, coderdAPI := coderdtest.NewWithAPI(t, &coderdtest.Options{ | ||
| IncludeProvisionerDaemon: false, | ||
| Database: db, | ||
| Pubsub: ps, | ||
| }) | ||
| owner := coderdtest.CreateFirstUser(t, client) | ||
| _, member := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID) | ||
| // These CLI tests are related to provisioner job CRUD operations and as such | ||
| // do not require the overhead of starting a provisioner. Other provisioner job | ||
| // functionalities (acquisition etc.) are tested elsewhere. | ||
| template := dbgen.Template(t, db, database.Template{ | ||
| OrganizationID: owner.OrganizationID, | ||
| CreatedBy: owner.UserID, | ||
| AllowUserCancelWorkspaceJobs: true, | ||
| }) | ||
| version := dbgen.TemplateVersion(t, db, database.TemplateVersion{ | ||
| OrganizationID: owner.OrganizationID, | ||
| CreatedBy: owner.UserID, | ||
| TemplateID: uuid.NullUUID{UUID: template.ID, Valid: true}, | ||
| }) | ||
| // Create some test jobs | ||
| job1 := dbgen.ProvisionerJob(t, db, coderdAPI.Pubsub, database.ProvisionerJob{ | ||
| OrganizationID: owner.OrganizationID, | ||
| InitiatorID: owner.UserID, | ||
| Type: database.ProvisionerJobTypeTemplateVersionImport, | ||
| Input: []byte(`{"template_version_id":"` + version.ID.String() + `"}`), | ||
| Tags: database.StringMap{provisionersdk.TagScope: provisionersdk.ScopeOrganization}, | ||
| }) | ||
| job2 := dbgen.ProvisionerJob(t, db, coderdAPI.Pubsub, database.ProvisionerJob{ | ||
| OrganizationID: owner.OrganizationID, | ||
| InitiatorID: member.ID, | ||
| Type: database.ProvisionerJobTypeWorkspaceBuild, | ||
| Input: []byte(`{"workspace_build_id":"` + uuid.New().String() + `"}`), | ||
| Tags: database.StringMap{provisionersdk.TagScope: provisionersdk.ScopeOrganization}, | ||
| }) | ||
| // Test basic list command | ||
| t.Run("Basic", func(t *testing.T) { | ||
| t.Parallel() | ||
| inv, root := clitest.New(t, "provisioner", "jobs", "list") | ||
| clitest.SetupConfig(t, client, root) | ||
| var buf bytes.Buffer | ||
| inv.Stdout = &buf | ||
| err := inv.Run() | ||
| require.NoError(t, err) | ||
| // Should contain both jobs | ||
| output := buf.String() | ||
| assert.Contains(t, output, job1.ID.String()) | ||
| assert.Contains(t, output, job2.ID.String()) | ||
| }) | ||
| // Test list with JSON output | ||
| t.Run("JSON", func(t *testing.T) { | ||
| t.Parallel() | ||
| inv, root := clitest.New(t, "provisioner", "jobs", "list", "--output", "json") | ||
| clitest.SetupConfig(t, client, root) | ||
| var buf bytes.Buffer | ||
| inv.Stdout = &buf | ||
| err := inv.Run() | ||
| require.NoError(t, err) | ||
| // Parse JSON output | ||
| var jobs []codersdk.ProvisionerJob | ||
| err = json.Unmarshal(buf.Bytes(), &jobs) | ||
| require.NoError(t, err) | ||
| // Should contain both jobs | ||
| jobIDs := make([]uuid.UUID, len(jobs)) | ||
| for i, job := range jobs { | ||
| jobIDs[i] = job.ID | ||
| } | ||
| assert.Contains(t, jobIDs, job1.ID) | ||
| assert.Contains(t, jobIDs, job2.ID) | ||
| }) | ||
| // Test list with limit | ||
| t.Run("Limit", func(t *testing.T) { | ||
| t.Parallel() | ||
| inv, root := clitest.New(t, "provisioner", "jobs", "list", "--limit", "1") | ||
| clitest.SetupConfig(t, client, root) | ||
| var buf bytes.Buffer | ||
| inv.Stdout = &buf | ||
| err := inv.Run() | ||
| require.NoError(t, err) | ||
| // Should contain at most 1 job | ||
| output := buf.String() | ||
| jobCount := 0 | ||
| if strings.Contains(output, job1.ID.String()) { | ||
| jobCount++ | ||
| } | ||
| if strings.Contains(output, job2.ID.String()) { | ||
| jobCount++ | ||
| } | ||
| assert.LessOrEqual(t, jobCount, 1) | ||
| }) | ||
| // Test list with initiator filter | ||
| t.Run("InitiatorFilter", func(t *testing.T) { | ||
| t.Parallel() | ||
| // Get owner user details to access username | ||
| ctx := testutil.Context(t, testutil.WaitShort) | ||
| ownerUser, err := client.User(ctx, owner.UserID.String()) | ||
| require.NoError(t, err) | ||
| // Test filtering by initiator (using username) | ||
| inv, root := clitest.New(t, "provisioner", "jobs", "list", "--initiator", ownerUser.Username) | ||
| clitest.SetupConfig(t, client, root) | ||
| var buf bytes.Buffer | ||
| inv.Stdout = &buf | ||
| err = inv.Run() | ||
| require.NoError(t, err) | ||
| // Should only contain job1 (initiated by owner) | ||
| output := buf.String() | ||
| assert.Contains(t, output, job1.ID.String()) | ||
| assert.NotContains(t, output, job2.ID.String()) | ||
| }) | ||
| // Test list with invalid user | ||
| t.Run("InvalidUser", func(t *testing.T) { | ||
| t.Parallel() | ||
| // Test with non-existent user | ||
| inv, root := clitest.New(t, "provisioner", "jobs", "list", "--initiator", "nonexistent-user") | ||
| clitest.SetupConfig(t, client, root) | ||
| var buf bytes.Buffer | ||
| inv.Stdout = &buf | ||
| err := inv.Run() | ||
| require.Error(t, err) | ||
| assert.Contains(t, err.Error(), "initiator not found: nonexistent-user") | ||
| }) | ||
| }) | ||
| } | ||
1 change: 1 addition & 0 deletionscli/testdata/coder_list_--output_json.golden
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
5 changes: 4 additions & 1 deletioncli/testdata/coder_provisioner_jobs_list_--help.golden
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
2 changes: 2 additions & 0 deletionscli/testdata/coder_provisioner_jobs_list_--output_json.golden
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
11 changes: 11 additions & 0 deletionscoderd/apidoc/docs.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.
11 changes: 11 additions & 0 deletionscoderd/apidoc/swagger.json
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.
2 changes: 2 additions & 0 deletionscoderd/database/dbauthz/dbauthz_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
5 changes: 4 additions & 1 deletioncoderd/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.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
Oops, something went wrong.
Uh oh!
There was an error while loading.Please reload this page.
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.