Add git auth providers to the API

coder · kylecarbs · Feb 27, 2023 · Feb 22, 2023 · Feb 22, 2023 · Feb 22, 2023
commit 3d67a0dff1f8455f4e4a9038f60502a37df9d626
diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -29,6 +29,7 @@ import (
 	"github.com/coder/coder/coderd/database/dbauthz"
 	"github.com/coder/coder/coderd/parameter"
 	"github.com/coder/coder/coderd/telemetry"
+	"github.com/coder/coder/coderd/util/slice"
 	"github.com/coder/coder/codersdk"
 	"github.com/coder/coder/provisioner"
 	"github.com/coder/coder/provisionerd/proto"
@@ -42,16 +43,17 @@ var (
 )
 
 type Server struct {
-	AccessURL      *url.URL
-	ID             uuid.UUID
-	Logger         slog.Logger
-	Provisioners   []database.ProvisionerType
-	Tags           json.RawMessage
-	Database       database.Store
-	Pubsub         database.Pubsub
-	Telemetry      telemetry.Reporter
-	QuotaCommitter *atomic.Pointer[proto.QuotaCommitter]
-	Auditor        *atomic.Pointer[audit.Auditor]
+	AccessURL        *url.URL
+	ID               uuid.UUID
+	Logger           slog.Logger
+	Provisioners     []database.ProvisionerType
+	GitAuthProviders []string
+	Tags             json.RawMessage
+	Database         database.Store
+	Pubsub           database.Pubsub
+	Telemetry        telemetry.Reporter
+	QuotaCommitter   *atomic.Pointer[proto.QuotaCommitter]
+	Auditor          *atomic.Pointer[audit.Auditor]
 
 	AcquireJobDebounce time.Duration
 }
@@ -810,6 +812,12 @@ func (server *Server) CompleteJob(ctx context.Context, completed *proto.Complete
 			}
 		}
 
+		for _, gitAuthProvider := range jobType.TemplateImport.GitAuthProviders {
+			if !slice.Contains(server.GitAuthProviders, gitAuthProvider) {
+				return nil, xerrors.Errorf("git auth provider %q is not configured", gitAuthProvider)
+			}
+		}
+
 		err = server.Database.UpdateTemplateVersionGitAuthProvidersByJobID(ctx, database.UpdateTemplateVersionGitAuthProvidersByJobIDParams{
 			JobID:            jobID,
 			GitAuthProviders: jobType.TemplateImport.GitAuthProviders,

diff --git a/coderd/provisionerdserver/provisionerdserver_test.go b/coderd/provisionerdserver/provisionerdserver_test.go
@@ -756,18 +756,26 @@ func TestCompleteJob(t *testing.T) {
 			Types: []database.ProvisionerType{database.ProvisionerTypeEcho},
 		})
 		require.NoError(t, err)
-		_, err = srv.CompleteJob(ctx, &proto.CompletedJob{
-			JobId: job.ID.String(),
-			Type: &proto.CompletedJob_TemplateImport_{
-				TemplateImport: &proto.CompletedJob_TemplateImport{
-					StartResources: []*sdkproto.Resource{{
-						Name: "hello",
-						Type: "aws_instance",
-					}},
-					StopResources: []*sdkproto.Resource{},
+		completeJob := func() error {
+			_, err = srv.CompleteJob(ctx, &proto.CompletedJob{
+				JobId: job.ID.String(),
+				Type: &proto.CompletedJob_TemplateImport_{
+					TemplateImport: &proto.CompletedJob_TemplateImport{
+						StartResources: []*sdkproto.Resource{{
+							Name: "hello",
+							Type: "aws_instance",
+						}},
+						StopResources:    []*sdkproto.Resource{},
+						GitAuthProviders: []string{"github"},
+					},
 				},
-			},
-		})
+			})
+			return err
+		}
+		err = completeJob()
+		require.ErrorContains(t, err, `git auth provider "github" is not configured`)
+		srv.GitAuthProviders = []string{"github"}
+		err = completeJob()
 		require.NoError(t, err)
 	})
 	t.Run("WorkspaceBuild", func(t *testing.T) {

diff --git a/coderd/templateversions.go b/coderd/templateversions.go
@@ -1461,15 +1461,16 @@ func convertTemplateVersion(version database.TemplateVersion, job codersdk.Provi
 	}
 
 	return codersdk.TemplateVersion{
-		ID:             version.ID,
-		TemplateID:     &version.TemplateID.UUID,
-		OrganizationID: version.OrganizationID,
-		CreatedAt:      version.CreatedAt,
-		UpdatedAt:      version.UpdatedAt,
-		Name:           version.Name,
-		Job:            job,
-		Readme:         version.Readme,
-		CreatedBy:      createdBy,
+		ID:               version.ID,
+		TemplateID:       &version.TemplateID.UUID,
+		OrganizationID:   version.OrganizationID,
+		CreatedAt:        version.CreatedAt,
+		UpdatedAt:        version.UpdatedAt,
+		GitAuthProviders: version.GitAuthProviders,
+		Name:             version.Name,
+		Job:              job,
+		Readme:           version.Readme,
+		CreatedBy:        createdBy,
 	}
 }
 

diff --git a/codersdk/templateversions.go b/codersdk/templateversions.go
@@ -13,15 +13,16 @@ import (
 
 // TemplateVersion represents a single version of a template.
 type TemplateVersion struct {
-	ID             uuid.UUID      `json:"id" format:"uuid"`
-	TemplateID     *uuid.UUID     `json:"template_id,omitempty" format:"uuid"`
-	OrganizationID uuid.UUID      `json:"organization_id,omitempty" format:"uuid"`
-	CreatedAt      time.Time      `json:"created_at" format:"date-time"`
-	UpdatedAt      time.Time      `json:"updated_at" format:"date-time"`
-	Name           string         `json:"name"`
-	Job            ProvisionerJob `json:"job"`
-	Readme         string         `json:"readme"`
-	CreatedBy      User           `json:"created_by"`
+	ID               uuid.UUID      `json:"id" format:"uuid"`
+	TemplateID       *uuid.UUID     `json:"template_id,omitempty" format:"uuid"`
+	OrganizationID   uuid.UUID      `json:"organization_id,omitempty" format:"uuid"`
+	CreatedAt        time.Time      `json:"created_at" format:"date-time"`
+	UpdatedAt        time.Time      `json:"updated_at" format:"date-time"`
+	GitAuthProviders []string       `json:"git_auth_providers"`
+	Name             string         `json:"name"`
+	Job              ProvisionerJob `json:"job"`
+	Readme           string         `json:"readme"`
+	CreatedBy        User           `json:"created_by"`
 }
 
 type ValidationMonotonicOrder string