feat: Add "coder projects create" command (#246)

* Refactor parameter parsing to return nil values if none computed * Refactor parameter to allow for hiding redisplay * Refactor parameters to enable schema matching * Refactor provisionerd to dynamically update parameter schemas * Refactor job update for provisionerd * Handle multiple states correctly when provisioning a project * Add project import job resource table * Basic creation flow works! * Create project fully works!!! * Only show job status if completed * Add create workspace support * Replace Netflix/go-expect with ActiveState * Fix linting errors * Use forked chzyer/readline * Add create workspace CLI * Add CLI test * Move jobs to their own APIs * Remove go-expect * Fix requested changes * Skip workspacecreate test on windows
2025-07-06 15:41:45 +00:00 · 2022-02-12 13:34:04 -06:00
parent df13fef161
commit 154b9bce57
65 changed files with 3215 additions and 2241 deletions
--- a/coderd/projectimport.go
+++ b/coderd/projectimport.go
@ -0,0 +1,185 @@
+package coderd
+
+import (
+	"database/sql"
+	"errors"
+	"fmt"
+	"net/http"
+
+	"github.com/go-chi/render"
+	"github.com/google/uuid"
+
+	"github.com/coder/coder/coderd/parameter"
+	"github.com/coder/coder/database"
+	"github.com/coder/coder/httpapi"
+	"github.com/coder/coder/httpmw"
+)
+
+// ParameterSchema represents a parameter parsed from project version source.
+type ParameterSchema database.ParameterSchema
+
+// ComputedParameterValue represents a computed parameter value.
+type ComputedParameterValue parameter.ComputedValue
+
+// ProjectImportJobResource is a resource created by a project import job.
+type ProjectImportJobResource database.ProjectImportJobResource
+
+// CreateProjectImportJobRequest provides options to create a project import job.
+type CreateProjectImportJobRequest struct {
+	StorageMethod database.ProvisionerStorageMethod `json:"storage_method" validate:"oneof=file,required"`
+	StorageSource string                            `json:"storage_source" validate:"required"`
+	Provisioner   database.ProvisionerType          `json:"provisioner" validate:"oneof=terraform echo,required"`
+	// ParameterValues allows for additional parameters to be provided
+	// during the dry-run provision stage.
+	ParameterValues []CreateParameterValueRequest `json:"parameter_values"`
+}
+
+// Create a new project import job!
+func (api *api) postProjectImportByOrganization(rw http.ResponseWriter, r *http.Request) {
+	apiKey := httpmw.APIKey(r)
+	organization := httpmw.OrganizationParam(r)
+	var req CreateProjectImportJobRequest
+	if !httpapi.Read(rw, r, &req) {
+		return
+	}
+	file, err := api.Database.GetFileByHash(r.Context(), req.StorageSource)
+	if errors.Is(err, sql.ErrNoRows) {
+		httpapi.Write(rw, http.StatusBadRequest, httpapi.Response{
+			Message: "file not found",
+		})
+		return
+	}
+	if err != nil {
+		httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
+			Message: fmt.Sprintf("get file: %s", err),
+		})
+		return
+	}
+
+	jobID := uuid.New()
+	for _, parameterValue := range req.ParameterValues {
+		_, err = api.Database.InsertParameterValue(r.Context(), database.InsertParameterValueParams{
+			ID:                uuid.New(),
+			Name:              parameterValue.Name,
+			CreatedAt:         database.Now(),
+			UpdatedAt:         database.Now(),
+			Scope:             database.ParameterScopeImportJob,
+			ScopeID:           jobID.String(),
+			SourceScheme:      parameterValue.SourceScheme,
+			SourceValue:       parameterValue.SourceValue,
+			DestinationScheme: parameterValue.DestinationScheme,
+		})
+		if err != nil {
+			httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
+				Message: fmt.Sprintf("insert parameter value: %s", err),
+			})
+			return
+		}
+	}
+
+	job, err := api.Database.InsertProvisionerJob(r.Context(), database.InsertProvisionerJobParams{
+		ID:             jobID,
+		CreatedAt:      database.Now(),
+		UpdatedAt:      database.Now(),
+		OrganizationID: organization.ID,
+		InitiatorID:    apiKey.UserID,
+		Provisioner:    req.Provisioner,
+		StorageMethod:  database.ProvisionerStorageMethodFile,
+		StorageSource:  file.Hash,
+		Type:           database.ProvisionerJobTypeProjectVersionImport,
+		Input:          []byte{'{', '}'},
+	})
+	if err != nil {
+		httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
+			Message: fmt.Sprintf("insert provisioner job: %s", err),
+		})
+		return
+	}
+
+	render.Status(r, http.StatusCreated)
+	render.JSON(rw, r, convertProvisionerJob(job))
+}
+
+// Returns imported parameter schemas from a completed job!
+func (api *api) projectImportJobSchemasByID(rw http.ResponseWriter, r *http.Request) {
+	job := httpmw.ProvisionerJobParam(r)
+	if !convertProvisionerJob(job).Status.Completed() {
+		httpapi.Write(rw, http.StatusPreconditionFailed, httpapi.Response{
+			Message: "Job hasn't completed!",
+		})
+		return
+	}
+
+	schemas, err := api.Database.GetParameterSchemasByJobID(r.Context(), job.ID)
+	if errors.Is(err, sql.ErrNoRows) {
+		err = nil
+	}
+	if err != nil {
+		httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
+			Message: fmt.Sprintf("list parameter schemas: %s", err),
+		})
+		return
+	}
+	if schemas == nil {
+		schemas = []database.ParameterSchema{}
+	}
+	render.Status(r, http.StatusOK)
+	render.JSON(rw, r, schemas)
+}
+
+// Returns computed parameters for an import job by ID.
+func (api *api) projectImportJobParametersByID(rw http.ResponseWriter, r *http.Request) {
+	apiKey := httpmw.APIKey(r)
+	job := httpmw.ProvisionerJobParam(r)
+	if !convertProvisionerJob(job).Status.Completed() {
+		httpapi.Write(rw, http.StatusPreconditionFailed, httpapi.Response{
+			Message: "Job hasn't completed!",
+		})
+		return
+	}
+	values, err := parameter.Compute(r.Context(), api.Database, parameter.ComputeScope{
+		ProjectImportJobID: job.ID,
+		OrganizationID:     job.OrganizationID,
+		UserID:             apiKey.UserID,
+	}, &parameter.ComputeOptions{
+		// We *never* want to send the client secret parameter values.
+		HideRedisplayValues: true,
+	})
+	if err != nil {
+		httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
+			Message: fmt.Sprintf("compute values: %s", err),
+		})
+		return
+	}
+	if values == nil {
+		values = []parameter.ComputedValue{}
+	}
+	render.Status(r, http.StatusOK)
+	render.JSON(rw, r, values)
+}
+
+// Returns resources for an import job by ID.
+func (api *api) projectImportJobResourcesByID(rw http.ResponseWriter, r *http.Request) {
+	job := httpmw.ProvisionerJobParam(r)
+	if !convertProvisionerJob(job).Status.Completed() {
+		httpapi.Write(rw, http.StatusPreconditionFailed, httpapi.Response{
+			Message: "Job hasn't completed!",
+		})
+		return
+	}
+	resources, err := api.Database.GetProjectImportJobResourcesByJobID(r.Context(), job.ID)
+	if errors.Is(err, sql.ErrNoRows) {
+		err = nil
+	}
+	if err != nil {
+		httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
+			Message: fmt.Sprintf("get project import job resources: %s", err),
+		})
+		return
+	}
+	if resources == nil {
+		resources = []database.ProjectImportJobResource{}
+	}
+	render.Status(r, http.StatusOK)
+	render.JSON(rw, r, resources)
+}