refactor: Rename ProjectParameter to ProjectVersionParameter (#170)

This was confusing with ParameterValue before. It still is a bit,
but this should help distinguish scope.
This commit is contained in:
Kyle Carberry
2022-02-07 15:40:08 -06:00
committed by GitHub
parent ed705f6af2
commit d55231cc0f
13 changed files with 309 additions and 294 deletions

View File

@ -40,11 +40,11 @@ func Compute(ctx context.Context, db database.Store, scope Scope) ([]Value, erro
compute := &compute{
db: db,
computedParameterByName: map[string]Value{},
projectVersionParametersByName: map[string]database.ProjectParameter{},
projectVersionParametersByName: map[string]database.ProjectVersionParameter{},
}
// All parameters for the project version!
projectVersionParameters, err := db.GetProjectParametersByVersionID(ctx, scope.ProjectVersionID)
projectVersionParameters, err := db.GetProjectVersionParametersByVersionID(ctx, scope.ProjectVersionID)
if errors.Is(err, sql.ErrNoRows) {
// This occurs when the project version has defined
// no parameters, so we have nothing to compute!
@ -144,7 +144,7 @@ func Compute(ctx context.Context, db database.Store, scope Scope) ([]Value, erro
type compute struct {
db database.Store
computedParameterByName map[string]Value
projectVersionParametersByName map[string]database.ProjectParameter
projectVersionParametersByName map[string]database.ProjectVersionParameter
}
// Validates and computes the value for parameters; setting the value on "parameterByName".

View File

@ -31,7 +31,7 @@ func TestCompute(t *testing.T) {
DefaultDestinationScheme database.ParameterDestinationScheme
ProjectVersionID uuid.UUID
}
generateProjectParameter := func(t *testing.T, db database.Store, opts projectParameterOptions) database.ProjectParameter {
generateProjectParameter := func(t *testing.T, db database.Store, opts projectParameterOptions) database.ProjectVersionParameter {
if opts.DefaultDestinationScheme == "" {
opts.DefaultDestinationScheme = database.ParameterDestinationSchemeEnvironmentVariable
}
@ -41,7 +41,7 @@ func TestCompute(t *testing.T) {
require.NoError(t, err)
destinationValue, err := cryptorand.String(8)
require.NoError(t, err)
param, err := db.InsertProjectParameter(context.Background(), database.InsertProjectParameterParams{
param, err := db.InsertProjectVersionParameter(context.Background(), database.InsertProjectVersionParameterParams{
ID: uuid.New(),
Name: name,
ProjectVersionID: opts.ProjectVersionID,
@ -66,7 +66,7 @@ func TestCompute(t *testing.T) {
t.Parallel()
db := databasefake.New()
scope := generateScope()
parameter, err := db.InsertProjectParameter(context.Background(), database.InsertProjectParameterParams{
parameter, err := db.InsertProjectVersionParameter(context.Background(), database.InsertProjectVersionParameterParams{
ID: uuid.New(),
ProjectVersionID: scope.ProjectVersionID,
Name: "hey",

View File

@ -31,8 +31,8 @@ type ProjectVersion struct {
Import ProvisionerJob `json:"import"`
}
// ProjectParameter represents a parameter parsed from project version source on creation.
type ProjectParameter struct {
// ProjectVersionParameter represents a parameter parsed from project version source on creation.
type ProjectVersionParameter struct {
ID uuid.UUID `json:"id"`
CreatedAt time.Time `json:"created_at"`
ProjectVersionID uuid.UUID `json:"project_version_id"`
@ -62,7 +62,7 @@ type CreateProjectVersionRequest struct {
func (api *api) projectVersionsByOrganization(rw http.ResponseWriter, r *http.Request) {
project := httpmw.ProjectParam(r)
version, err := api.Database.GetProjectVersionByProjectID(r.Context(), project.ID)
version, err := api.Database.GetProjectVersionsByProjectID(r.Context(), project.ID)
if errors.Is(err, sql.ErrNoRows) {
err = nil
}
@ -194,10 +194,10 @@ func (api *api) projectVersionParametersByOrganizationAndName(rw http.ResponseWr
return
}
parameters, err := api.Database.GetProjectParametersByVersionID(r.Context(), projectVersion.ID)
parameters, err := api.Database.GetProjectVersionParametersByVersionID(r.Context(), projectVersion.ID)
if errors.Is(err, sql.ErrNoRows) {
err = nil
parameters = []database.ProjectParameter{}
parameters = []database.ProjectVersionParameter{}
}
if err != nil {
httpapi.Write(rw, http.StatusInternalServerError, httpapi.Response{
@ -206,7 +206,7 @@ func (api *api) projectVersionParametersByOrganizationAndName(rw http.ResponseWr
return
}
apiParameters := make([]ProjectParameter, 0, len(parameters))
apiParameters := make([]ProjectVersionParameter, 0, len(parameters))
for _, parameter := range parameters {
apiParameters = append(apiParameters, convertProjectParameter(parameter))
}
@ -227,8 +227,8 @@ func convertProjectVersion(version database.ProjectVersion, job database.Provisi
}
}
func convertProjectParameter(parameter database.ProjectParameter) ProjectParameter {
return ProjectParameter{
func convertProjectParameter(parameter database.ProjectVersionParameter) ProjectVersionParameter {
return ProjectVersionParameter{
ID: parameter.ID,
CreatedAt: parameter.CreatedAt,
ProjectVersionID: parameter.ProjectVersionID,

View File

@ -378,14 +378,14 @@ func (server *provisionerdServer) CompleteJob(ctx context.Context, completed *pr
// Validate that all parameters send from the provisioner daemon
// follow the protocol.
projectParameters := make([]database.InsertProjectParameterParams, 0, len(jobType.ProjectImport.ParameterSchemas))
projectVersionParameters := make([]database.InsertProjectVersionParameterParams, 0, len(jobType.ProjectImport.ParameterSchemas))
for _, protoParameter := range jobType.ProjectImport.ParameterSchemas {
validationTypeSystem, err := convertValidationTypeSystem(protoParameter.ValidationTypeSystem)
if err != nil {
return nil, xerrors.Errorf("convert validation type system for %q: %w", protoParameter.Name, err)
}
projectParameter := database.InsertProjectParameterParams{
projectParameter := database.InsertProjectVersionParameterParams{
ID: uuid.New(),
CreatedAt: database.Now(),
ProjectVersionID: input.ProjectVersionID,
@ -430,7 +430,7 @@ func (server *provisionerdServer) CompleteJob(ctx context.Context, completed *pr
}
}
projectParameters = append(projectParameters, projectParameter)
projectVersionParameters = append(projectVersionParameters, projectParameter)
}
// This must occur in a transaction in case of failure.
@ -448,8 +448,8 @@ func (server *provisionerdServer) CompleteJob(ctx context.Context, completed *pr
}
// This could be a bulk-insert operation to improve performance.
// See the "InsertWorkspaceHistoryLogs" query.
for _, projectParameter := range projectParameters {
_, err = db.InsertProjectParameter(ctx, projectParameter)
for _, projectParameter := range projectVersionParameters {
_, err = db.InsertProjectVersionParameter(ctx, projectParameter)
if err != nil {
return xerrors.Errorf("insert project parameter %q: %w", projectParameter.Name, err)
}

View File

@ -24,5 +24,5 @@ func TestProvisionerDaemons(t *testing.T) {
daemons, err := client.ProvisionerDaemons(context.Background())
require.NoError(t, err)
return len(daemons) > 0
}, time.Second, 25*time.Millisecond)
}, 3*time.Second, 50*time.Millisecond)
}