Dec 2, 2024 · Nov 29, 2024 · Nov 29, 2024 · Dec 1, 2024 · Dec 1, 2024 · Dec 1, 2024
diff --git a/cli/create.go b/cli/create.go
 if err != nil {
 return nil, xerrors.Errorf("begin workspace dry-run: %w", err)
 }

 matchedProvisioners, err := client.TemplateVersionDryRunMatchedProvisioners(inv.Context(), templateVersion.ID, dryRun.ID)
 if err != nil {
 return nil, xerrors.Errorf("get matched provisioners: %w", err)
 }
 cliutil.WarnMatchedProvisioners(inv.Stdout, &matchedProvisioners, dryRun)
 _, _ = fmt.Fprintln(inv.Stdout, "Planning workspace...")
 err = cliui.ProvisionerJob(inv.Context(), inv.Stdout, cliui.ProvisionerJobOptions{
 Fetch: func() (codersdk.ProvisionerJob, error) {
diff --git a/coderd/apidoc/docs.go b/coderd/apidoc/docs.go
diff --git a/coderd/apidoc/swagger.json b/coderd/apidoc/swagger.json
diff --git a/coderd/coderd.go b/coderd/coderd.go
 r.Get("/{jobID}", api.templateVersionDryRun)
 r.Get("/{jobID}/resources", api.templateVersionDryRunResources)
 r.Get("/{jobID}/logs", api.templateVersionDryRunLogs)
 r.Get("/{jobID}/matched-provisioners", api.templateVersionDryRunMatchedProvisioners)
 r.Patch("/{jobID}/cancel", api.patchTemplateVersionDryRunCancel)
 })
 })
diff --git a/coderd/templateversions.go b/coderd/templateversions.go
 httpapi.Write(ctx, rw, http.StatusOK, convertProvisionerJob(job))
 }

 // @Summary Get template version dry-run matched provisioners
 // @ID get-template-version-dry-run-matched-provisioners
 // @Security CoderSessionToken
 // @Produce json
 // @Tags Templates
 // @Param templateversion path string true "Template version ID" format(uuid)
 // @Param jobID path string true "Job ID" format(uuid)
 // @Success 200 {object} codersdk.MatchedProvisioners
 // @Router /templateversions/{templateversion}/dry-run/{jobID}/matched-provisioners [get]
 func (api *API) templateVersionDryRunMatchedProvisioners(rw http.ResponseWriter, r *http.Request) {
 ctx := r.Context()
 job, ok := api.fetchTemplateVersionDryRunJob(rw, r)
 if !ok {
 return
 }

 // nolint:gocritic // The user may not have permissions to read all
 // provisioner daemons in the org.
 daemons, err := api.Database.GetProvisionerDaemonsByOrganization(dbauthz.AsSystemReadProvisionerDaemons(ctx), database.GetProvisionerDaemonsByOrganizationParams{
 OrganizationID: job.ProvisionerJob.OrganizationID,
 WantTags:       job.ProvisionerJob.Tags,
 })
 if err != nil {
 if !errors.Is(err, sql.ErrNoRows) {
 httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
 Message: "Internal error fetching provisioner daemons by organization.",
 Detail:  err.Error(),
 })
 return
 } else {
 daemons = []database.ProvisionerDaemon{}
 }
 }

 matchedProvisioners := db2sdk.MatchedProvisioners(daemons, dbtime.Now(), provisionerdserver.StaleInterval)
 httpapi.Write(ctx, rw, http.StatusOK, matchedProvisioners)
 }

 // @Summary Get template version dry-run resources by job ID
 // @ID get-template-version-dry-run-resources-by-job-id
 // @Security CoderSessionToken
diff --git a/coderd/templateversions_test.go b/coderd/templateversions_test.go
 require.NoError(t, err)
 require.Equal(t, job.ID, newJob.ID)

 // Check matched provisioners
 matched, err := client.TemplateVersionDryRunMatchedProvisioners(ctx, version.ID, job.ID)
 require.NoError(t, err)
 require.Equal(t, 1, matched.Count)
 require.Equal(t, 1, matched.Available)
 require.NotZero(t, matched.MostRecentlySeen.Time)

 // Stream logs
 logs, closer, err := client.TemplateVersionDryRunLogsAfter(ctx, version.ID, job.ID, 0)
 require.NoError(t, err)
 require.Equal(t, http.StatusBadRequest, apiErr.StatusCode())
 })
 })

 t.Run("Pending", func(t *testing.T) {
 t.Parallel()
 if !dbtestutil.WillUsePostgres() {
 t.Skip("this test requires postgres")
 }

 store, ps, db := dbtestutil.NewDBWithSQLDB(t)
 client, closer := coderdtest.NewWithProvisionerCloser(t, &coderdtest.Options{
 Database:                 store,
 Pubsub:                   ps,
 IncludeProvisionerDaemon: true,
 })
 defer closer.Close()

 owner := coderdtest.CreateFirstUser(t, client)
 version := coderdtest.CreateTemplateVersion(t, client, owner.OrganizationID, &echo.Responses{
 Parse:          echo.ParseComplete,
 ProvisionApply: echo.ApplyComplete,
 })
 version = coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID)
 require.Equal(t, codersdk.ProvisionerJobSucceeded, version.Job.Status)

 templateAdmin, _ := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID, rbac.RoleTemplateAdmin())
 ctx := testutil.Context(t, testutil.WaitShort)

 _, err := db.Exec("DELETE FROM provisioner_daemons")
 require.NoError(t, err)

 job, err := templateAdmin.CreateTemplateVersionDryRun(ctx, version.ID, codersdk.CreateTemplateVersionDryRunRequest{
 WorkspaceName:       "test",
 RichParameterValues: []codersdk.WorkspaceBuildParameter{},
 UserVariableValues:  []codersdk.VariableValue{},
 })
 require.NoError(t, err)
 require.Equal(t, codersdk.ProvisionerJobPending, job.Status)

 matched, err := templateAdmin.TemplateVersionDryRunMatchedProvisioners(ctx, version.ID, job.ID)
 require.NoError(t, err)
 require.Equal(t, 0, matched.Count)
 require.Equal(t, 0, matched.Available)
 require.Zero(t, matched.MostRecentlySeen.Time)
 })
 }

 // TestPaginatedTemplateVersions creates a list of template versions and paginate.
diff --git a/codersdk/templateversions.go b/codersdk/templateversions.go
 return j, json.NewDecoder(res.Body).Decode(&j)
 }

 // TemplateVersionDryRunMatchedProvisioners returns the matched provisioners for a
 // template version dry-run job.
 func (c *Client) TemplateVersionDryRunMatchedProvisioners(ctx context.Context, version, job uuid.UUID) (MatchedProvisioners, error) {
 res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/templateversions/%s/dry-run/%s/matched-provisioners", version, job), nil)
 if err != nil {
 return MatchedProvisioners{}, err
 }
 defer res.Body.Close()
 if res.StatusCode != http.StatusOK {
 return MatchedProvisioners{}, ReadBodyAsError(res)
 }

 var matched MatchedProvisioners
 return matched, json.NewDecoder(res.Body).Decode(&matched)
 }

 // TemplateVersionDryRunResources returns the resources of a finished template
 // version dry-run job.
 func (c *Client) TemplateVersionDryRunResources(ctx context.Context, version, job uuid.UUID) ([]WorkspaceResource, error) {
diff --git a/docs/reference/api/templates.md b/docs/reference/api/templates.md
Original file line number	Diff line number	Diff line change
Expand Up		@@ -436,6 +436,12 @@ func prepWorkspaceBuild(inv serpent.Invocation, client codersdk.Client, args p
		if err != nil {
		return nil, xerrors.Errorf("begin workspace dry-run: %w", err)
		}

		matchedProvisioners, err := client.TemplateVersionDryRunMatchedProvisioners(inv.Context(), templateVersion.ID, dryRun.ID)
		if err != nil {
		return nil, xerrors.Errorf("get matched provisioners: %w", err)
		}
		cliutil.WarnMatchedProvisioners(inv.Stdout, &matchedProvisioners, dryRun)
		_, _ = fmt.Fprintln(inv.Stdout, "Planning workspace...")
		err = cliui.ProvisionerJob(inv.Context(), inv.Stdout, cliui.ProvisionerJobOptions{
		Fetch: func() (codersdk.ProvisionerJob, error) {
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1055,6 +1055,7 @@ func New(options Options) API {
		r.Get("/{jobID}", api.templateVersionDryRun)
		r.Get("/{jobID}/resources", api.templateVersionDryRunResources)
		r.Get("/{jobID}/logs", api.templateVersionDryRunLogs)
		r.Get("/{jobID}/matched-provisioners", api.templateVersionDryRunMatchedProvisioners)
		r.Patch("/{jobID}/cancel", api.patchTemplateVersionDryRunCancel)
		})
		})
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -580,6 +580,44 @@
		httpapi.Write(ctx, rw, http.StatusOK, convertProvisionerJob(job))
		}

		// @Summary Get template version dry-run matched provisioners
		// @ID get-template-version-dry-run-matched-provisioners
		// @Security CoderSessionToken
		// @Produce json
		// @Tags Templates
		// @Param templateversion path string true "Template version ID" format(uuid)
		// @Param jobID path string true "Job ID" format(uuid)
		// @Success 200 {object} codersdk.MatchedProvisioners
		// @Router /templateversions/{templateversion}/dry-run/{jobID}/matched-provisioners [get]
		func (api API) templateVersionDryRunMatchedProvisioners(rw http.ResponseWriter, r http.Request) {
		ctx := r.Context()
		job, ok := api.fetchTemplateVersionDryRunJob(rw, r)
		if !ok {
		return
		}

		// nolint:gocritic // The user may not have permissions to read all
		// provisioner daemons in the org.
		daemons, err := api.Database.GetProvisionerDaemonsByOrganization(dbauthz.AsSystemReadProvisionerDaemons(ctx), database.GetProvisionerDaemonsByOrganizationParams{
		OrganizationID: job.ProvisionerJob.OrganizationID,
		WantTags: job.ProvisionerJob.Tags,
		})
		if err != nil {
		if !errors.Is(err, sql.ErrNoRows) {
		httpapi.Write(ctx, rw, http.StatusInternalServerError, codersdk.Response{
		Message: "Internal error fetching provisioner daemons by organization.",
		Detail: err.Error(),
		})
		return
		} else {
Check failure on line 612 in coderd/templateversions.go View workflow job for this annotation GitHub Actions/ lint `indent-error-flow: if block ends with a return statement, so drop this else and outdent its block (revive)`
		daemons = []database.ProvisionerDaemon{}
		}
		}

		matchedProvisioners := db2sdk.MatchedProvisioners(daemons, dbtime.Now(), provisionerdserver.StaleInterval)
		httpapi.Write(ctx, rw, http.StatusOK, matchedProvisioners)
		}

		// @Summary Get template version dry-run resources by job ID
		// @ID get-template-version-dry-run-resources-by-job-id
		// @Security CoderSessionToken
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1004,6 +1004,13 @@ func TestTemplateVersionDryRun(t *testing.T) {
		require.NoError(t, err)
		require.Equal(t, job.ID, newJob.ID)

		// Check matched provisioners
		matched, err := client.TemplateVersionDryRunMatchedProvisioners(ctx, version.ID, job.ID)
		require.NoError(t, err)
		require.Equal(t, 1, matched.Count)
		require.Equal(t, 1, matched.Available)
		require.NotZero(t, matched.MostRecentlySeen.Time)

		// Stream logs
		logs, closer, err := client.TemplateVersionDryRunLogsAfter(ctx, version.ID, job.ID, 0)
		require.NoError(t, err)
Expand DownExpand Up		@@ -1176,6 +1183,49 @@ func TestTemplateVersionDryRun(t *testing.T) {
		require.Equal(t, http.StatusBadRequest, apiErr.StatusCode())
		})
		})

		t.Run("Pending", func(t *testing.T) {
		t.Parallel()
		if !dbtestutil.WillUsePostgres() {
		t.Skip("this test requires postgres")
		}

		store, ps, db := dbtestutil.NewDBWithSQLDB(t)
		client, closer := coderdtest.NewWithProvisionerCloser(t, &coderdtest.Options{
		Database: store,
		Pubsub: ps,
		IncludeProvisionerDaemon: true,
		})
		defer closer.Close()

		owner := coderdtest.CreateFirstUser(t, client)
		version := coderdtest.CreateTemplateVersion(t, client, owner.OrganizationID, &echo.Responses{
		Parse: echo.ParseComplete,
		ProvisionApply: echo.ApplyComplete,
		})
		version = coderdtest.AwaitTemplateVersionJobCompleted(t, client, version.ID)
		require.Equal(t, codersdk.ProvisionerJobSucceeded, version.Job.Status)

		templateAdmin, _ := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID, rbac.RoleTemplateAdmin())
		ctx := testutil.Context(t, testutil.WaitShort)

		_, err := db.Exec("DELETE FROM provisioner_daemons")
		require.NoError(t, err)

		job, err := templateAdmin.CreateTemplateVersionDryRun(ctx, version.ID, codersdk.CreateTemplateVersionDryRunRequest{
		WorkspaceName: "test",
		RichParameterValues: []codersdk.WorkspaceBuildParameter{},
		UserVariableValues: []codersdk.VariableValue{},
		})
		require.NoError(t, err)
		require.Equal(t, codersdk.ProvisionerJobPending, job.Status)

		matched, err := templateAdmin.TemplateVersionDryRunMatchedProvisioners(ctx, version.ID, job.ID)
		require.NoError(t, err)
		require.Equal(t, 0, matched.Count)
		require.Equal(t, 0, matched.Available)
		require.Zero(t, matched.MostRecentlySeen.Time)
		})
		}

		// TestPaginatedTemplateVersions creates a list of template versions and paginate.
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -224,6 +224,22 @@ func (c *Client) TemplateVersionDryRun(ctx context.Context, version, job uuid.UU
		return j, json.NewDecoder(res.Body).Decode(&j)
		}

		// TemplateVersionDryRunMatchedProvisioners returns the matched provisioners for a
		// template version dry-run job.
		func (c *Client) TemplateVersionDryRunMatchedProvisioners(ctx context.Context, version, job uuid.UUID) (MatchedProvisioners, error) {
		res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/templateversions/%s/dry-run/%s/matched-provisioners", version, job), nil)
		if err != nil {
		return MatchedProvisioners{}, err
		}
		defer res.Body.Close()
		if res.StatusCode != http.StatusOK {
		return MatchedProvisioners{}, ReadBodyAsError(res)
		}

		var matched MatchedProvisioners
		return matched, json.NewDecoder(res.Body).Decode(&matched)
		}

		// TemplateVersionDryRunResources returns the resources of a finished template
		// version dry-run job.
		func (c *Client) TemplateVersionDryRunResources(ctx context.Context, version, job uuid.UUID) ([]WorkspaceResource, error) {
Expand Down