fix: do not skip parameter validation if min or max = 0 (#7707)

mtojek · web-flow · commit 702c9081e0b9 · 2023-05-30T14:57:06.000+02:00
diff --git a/cli/create_test.go b/cli/create_test.go
@@ -15,6 +15,7 @@ import (
 	"github.com/coder/coder/cli/clitest"
 	"github.com/coder/coder/coderd/coderdtest"
 	"github.com/coder/coder/coderd/gitauth"
+	"github.com/coder/coder/coderd/util/ptr"
 	"github.com/coder/coder/codersdk"
 	"github.com/coder/coder/provisioner/echo"
 	"github.com/coder/coder/provisionersdk/proto"
@@ -494,7 +495,7 @@ func TestCreateValidateRichParameters(t *testing.T) {
 	)
 
 	numberRichParameters := []*proto.RichParameter{
-		{Name: numberParameterName, Type: "number", Mutable: true, ValidationMin: 3, ValidationMax: 10},
+		{Name: numberParameterName, Type: "number", Mutable: true, ValidationMin: ptr.Ref(int32(3)), ValidationMax: ptr.Ref(int32(10))},
 	}
 
 	stringRichParameters := []*proto.RichParameter{
diff --git a/cli/update_test.go b/cli/update_test.go
@@ -11,6 +11,7 @@ import (
 
 	"github.com/coder/coder/cli/clitest"
 	"github.com/coder/coder/coderd/coderdtest"
+	"github.com/coder/coder/coderd/util/ptr"
 	"github.com/coder/coder/codersdk"
 	"github.com/coder/coder/provisioner/echo"
 	"github.com/coder/coder/provisionersdk/proto"
@@ -245,7 +246,7 @@ func TestUpdateValidateRichParameters(t *testing.T) {
 	)
 
 	numberRichParameters := []*proto.RichParameter{
-		{Name: numberParameterName, Type: "number", Mutable: true, ValidationMin: 3, ValidationMax: 10},
+		{Name: numberParameterName, Type: "number", Mutable: true, ValidationMin: ptr.Ref(int32(3)), ValidationMax: ptr.Ref(int32(10))},
 	}
 
 	stringRichParameters := []*proto.RichParameter{
diff --git a/coderd/database/db2sdk/db2sdk.go b/coderd/database/db2sdk/db2sdk.go
@@ -46,6 +46,17 @@ func TemplateVersionParameter(param database.TemplateVersionParameter) (codersdk
 	if err != nil {
 		return codersdk.TemplateVersionParameter{}, err
 	}
+
+	var validationMin *int32
+	if param.ValidationMin.Valid {
+		validationMin = &param.ValidationMin.Int32
+	}
+
+	var validationMax *int32
+	if param.ValidationMax.Valid {
+		validationMax = &param.ValidationMax.Int32
+	}
+
 	return codersdk.TemplateVersionParameter{
 		Name:                 param.Name,
 		DisplayName:          param.DisplayName,
@@ -57,8 +68,8 @@ func TemplateVersionParameter(param database.TemplateVersionParameter) (codersdk
 		Icon:                 param.Icon,
 		Options:              options,
 		ValidationRegex:      param.ValidationRegex,
-		ValidationMin:        param.ValidationMin,
-		ValidationMax:        param.ValidationMax,
+		ValidationMin:        validationMin,
+		ValidationMax:        validationMax,
 		ValidationError:      param.ValidationError,
 		ValidationMonotonic:  codersdk.ValidationMonotonicOrder(param.ValidationMonotonic),
 		Required:             param.Required,
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000124_validation_min_max_nullable.down.sql b/coderd/database/migrations/000124_validation_min_max_nullable.down.sql
@@ -0,0 +1,6 @@
+BEGIN;
+UPDATE template_version_parameters SET validation_min = 0 WHERE validation_min = NULL;
+UPDATE template_version_parameters SET validation_max = 0 WHERE validation_max = NULL;
+ALTER TABLE template_version_parameters ALTER COLUMN validation_min SET NOT NULL;
+ALTER TABLE template_version_parameters ALTER COLUMN validation_max SET NOT NULL;
+COMMIT;
diff --git a/coderd/database/migrations/000124_validation_min_max_nullable.up.sql b/coderd/database/migrations/000124_validation_min_max_nullable.up.sql
@@ -0,0 +1,6 @@
+BEGIN;
+ALTER TABLE template_version_parameters ALTER COLUMN validation_min DROP NOT NULL;
+ALTER TABLE template_version_parameters ALTER COLUMN validation_max DROP NOT NULL;
+UPDATE template_version_parameters SET validation_min = NULL WHERE validation_min = 0;
+UPDATE template_version_parameters SET validation_max = NULL WHERE validation_max = 0;
+COMMIT;
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/provisionerdserver/provisionerdserver.go b/coderd/provisionerdserver/provisionerdserver.go
@@ -919,6 +919,21 @@ func (server *Server) CompleteJob(ctx context.Context, completed *proto.Complete
 			if err != nil {
 				return nil, xerrors.Errorf("marshal parameter options: %w", err)
 			}
+
+			var validationMin, validationMax sql.NullInt32
+			if richParameter.ValidationMin != nil {
+				validationMin = sql.NullInt32{
+					Int32: *richParameter.ValidationMin,
+					Valid: true,
+				}
+			}
+			if richParameter.ValidationMax != nil {
+				validationMax = sql.NullInt32{
+					Int32: *richParameter.ValidationMax,
+					Valid: true,
+				}
+			}
+
 			_, err = server.Database.InsertTemplateVersionParameter(ctx, database.InsertTemplateVersionParameterParams{
 				TemplateVersionID:   input.TemplateVersionID,
 				Name:                richParameter.Name,
@@ -931,8 +946,8 @@ func (server *Server) CompleteJob(ctx context.Context, completed *proto.Complete
 				Options:             options,
 				ValidationRegex:     richParameter.ValidationRegex,
 				ValidationError:     richParameter.ValidationError,
-				ValidationMin:       richParameter.ValidationMin,
-				ValidationMax:       richParameter.ValidationMax,
+				ValidationMin:       validationMin,
+				ValidationMax:       validationMax,
 				ValidationMonotonic: richParameter.ValidationMonotonic,
 				Required:            richParameter.Required,
 				LegacyVariableName:  richParameter.LegacyVariableName,
diff --git a/coderd/templateversions.go b/coderd/templateversions.go
@@ -1706,6 +1706,15 @@ func convertTemplateVersionParameter(param database.TemplateVersionParameter) (c
 	if err != nil {
 		return codersdk.TemplateVersionParameter{}, err
 	}
+
+	var validationMin, validationMax *int32
+	if param.ValidationMin.Valid {
+		validationMin = &param.ValidationMin.Int32
+	}
+	if param.ValidationMax.Valid {
+		validationMax = &param.ValidationMax.Int32
+	}
+
 	return codersdk.TemplateVersionParameter{
 		Name:                 param.Name,
 		DisplayName:          param.DisplayName,
@@ -1717,8 +1726,8 @@ func convertTemplateVersionParameter(param database.TemplateVersionParameter) (c
 		Icon:                 param.Icon,
 		Options:              options,
 		ValidationRegex:      param.ValidationRegex,
-		ValidationMin:        param.ValidationMin,
-		ValidationMax:        param.ValidationMax,
+		ValidationMin:        validationMin,
+		ValidationMax:        validationMax,
 		ValidationError:      param.ValidationError,
 		ValidationMonotonic:  codersdk.ValidationMonotonicOrder(param.ValidationMonotonic),
 		Required:             param.Required,
diff --git a/coderd/workspaces_test.go b/coderd/workspaces_test.go
@@ -1973,8 +1973,8 @@ func TestWorkspaceWithRichParameters(t *testing.T) {
 								DisplayName:         secondParameterDisplayName,
 								Type:                secondParameterType,
 								Description:         secondParameterDescription,
-								ValidationMin:       1,
-								ValidationMax:       3,
+								ValidationMin:       ptr.Ref(int32(1)),
+								ValidationMax:       ptr.Ref(int32(3)),
 								ValidationMonotonic: string(secondParameterValidationMonotonic),
 							},
 						},
diff --git a/codersdk/richparameters.go b/codersdk/richparameters.go
@@ -79,15 +79,23 @@ func ValidateWorkspaceBuildParameter(richParameter TemplateVersionParameter, bui
 	}
 
 	validation := &provider.Validation{
-		Min:       int(richParameter.ValidationMin),
-		Max:       int(richParameter.ValidationMax),
+		Min:       ptrInt(richParameter.ValidationMin),
+		Max:       ptrInt(richParameter.ValidationMax),
 		Regex:     richParameter.ValidationRegex,
 		Error:     richParameter.ValidationError,
 		Monotonic: string(richParameter.ValidationMonotonic),
 	}
 	return validation.Valid(richParameter.Type, value)
 }
 
+func ptrInt(number *int32) *int {
+	if number == nil {
+		return nil
+	}
+	n := int(*number)
+	return &n
+}
+
 func findBuildParameter(params []WorkspaceBuildParameter, parameterName string) (*WorkspaceBuildParameter, bool) {
 	if params == nil {
 		return nil, false
@@ -111,7 +119,8 @@ func parameterValuesAsArray(options []TemplateVersionParameterOption) []string {
 
 func validationEnabled(param TemplateVersionParameter) bool {
 	return len(param.ValidationRegex) > 0 ||
-		(param.ValidationMin != 0 && param.ValidationMax != 0) ||
+		param.ValidationMin != nil ||
+		param.ValidationMax != nil ||
 		len(param.ValidationMonotonic) > 0 ||
 		param.Type == "bool" || // boolean type doesn't have any custom validation rules, but the value must be checked (true/false).
 		param.Type == "list(string)" // list(string) type doesn't have special validation, but we need to check if this is a correct list.
diff --git a/codersdk/richparameters_test.go b/codersdk/richparameters_test.go
@@ -5,6 +5,7 @@ import (
 
 	"github.com/stretchr/testify/require"
 
+	"github.com/coder/coder/coderd/util/ptr"
 	"github.com/coder/coder/codersdk"
 )
 
@@ -72,8 +73,8 @@ func TestParameterResolver_ValidateResolve_PrevInvalid(t *testing.T) {
 	p := codersdk.TemplateVersionParameter{
 		Name:          "n",
 		Type:          "number",
-		ValidationMax: 10,
-		ValidationMin: 1,
+		ValidationMax: ptr.Ref(int32(10)),
+		ValidationMin: ptr.Ref(int32(1)),
 	}
 	v, err := uut.ValidateResolve(p, nil)
 	require.Error(t, err)
@@ -89,8 +90,8 @@ func TestParameterResolver_ValidateResolve_DefaultInvalid(t *testing.T) {
 	p := codersdk.TemplateVersionParameter{
 		Name:          "n",
 		Type:          "number",
-		ValidationMax: 10,
-		ValidationMin: 1,
+		ValidationMax: ptr.Ref(int32(10)),
+		ValidationMin: ptr.Ref(int32(1)),
 		DefaultValue:  "11",
 	}
 	v, err := uut.ValidateResolve(p, nil)
@@ -221,19 +222,19 @@ func TestRichParameterValidation(t *testing.T) {
 
 		numberRichParameters := []codersdk.TemplateVersionParameter{
 			{Name: stringParameterName, Type: "string", Mutable: true},
-			{Name: numberParameterName, Type: "number", Mutable: true, ValidationMin: 3, ValidationMax: 10},
+			{Name: numberParameterName, Type: "number", Mutable: true, ValidationMin: ptr.Ref(int32(3)), ValidationMax: ptr.Ref(int32(10))},
 			{Name: boolParameterName, Type: "bool", Mutable: true},
 		}
 
 		monotonicIncreasingNumberRichParameters := []codersdk.TemplateVersionParameter{
 			{Name: stringParameterName, Type: "string", Mutable: true},
-			{Name: numberParameterName, Type: "number", Mutable: true, ValidationMin: 3, ValidationMax: 10, ValidationMonotonic: "increasing"},
+			{Name: numberParameterName, Type: "number", Mutable: true, ValidationMin: ptr.Ref(int32(3)), ValidationMax: ptr.Ref(int32(10)), ValidationMonotonic: "increasing"},
 			{Name: boolParameterName, Type: "bool", Mutable: true},
 		}
 
 		monotonicDecreasingNumberRichParameters := []codersdk.TemplateVersionParameter{
 			{Name: stringParameterName, Type: "string", Mutable: true},
-			{Name: numberParameterName, Type: "number", Mutable: true, ValidationMin: 3, ValidationMax: 10, ValidationMonotonic: "decreasing"},
+			{Name: numberParameterName, Type: "number", Mutable: true, ValidationMin: ptr.Ref(int32(3)), ValidationMax: ptr.Ref(int32(10)), ValidationMonotonic: "decreasing"},
 			{Name: boolParameterName, Type: "bool", Mutable: true},
 		}
 
diff --git a/codersdk/templateversions.go b/codersdk/templateversions.go
@@ -59,8 +59,8 @@ type TemplateVersionParameter struct {
 	Options              []TemplateVersionParameterOption `json:"options"`
 	ValidationError      string                           `json:"validation_error,omitempty"`
 	ValidationRegex      string                           `json:"validation_regex,omitempty"`
-	ValidationMin        int32                            `json:"validation_min,omitempty"`
-	ValidationMax        int32                            `json:"validation_max,omitempty"`
+	ValidationMin        *int32                           `json:"validation_min,omitempty"`
+	ValidationMax        *int32                           `json:"validation_max,omitempty"`
 	ValidationMonotonic  ValidationMonotonicOrder         `json:"validation_monotonic,omitempty" enums:"increasing,decreasing"`
 	Required             bool                             `json:"required"`
 	LegacyVariableName   string                           `json:"legacy_variable_name,omitempty"`
diff --git a/go.mod b/go.mod
@@ -75,7 +75,7 @@ require (
 	github.com/codeclysm/extract v2.2.0+incompatible
 	github.com/coder/flog v1.1.0
 	github.com/coder/retry v1.3.1-0.20230210155434-e90a2e1e091d
-	github.com/coder/terraform-provider-coder v0.6.23
+	github.com/coder/terraform-provider-coder v0.8.1
 	github.com/coder/wgtunnel v0.1.5
 	github.com/coreos/go-oidc/v3 v3.6.0
 	github.com/coreos/go-systemd v0.0.0-20191104093116-d3cd4ed1dbcf
diff --git a/go.sum b/go.sum
@@ -336,8 +336,8 @@ github.com/coder/ssh v0.0.0-20230421140225-04bb837133e1 h1:LBw76rEDuhNJyohve11mb
 github.com/coder/ssh v0.0.0-20230421140225-04bb837133e1/go.mod h1:ZSS+CUoKHDrqVakTfTWUlKSr9MtMFkC4UvtQKD7O914=
 github.com/coder/tailscale v0.0.0-20230522123520-74712221d00f h1:F0Xr1d8h8dAHn7tab1HXuzYFkcjmCydnEfdMbkOhlVk=
 github.com/coder/tailscale v0.0.0-20230522123520-74712221d00f/go.mod h1:jpg+77g19FpXL43U1VoIqoSg1K/Vh5CVxycGldQ8KhA=
-github.com/coder/terraform-provider-coder v0.6.23 h1:O2Rcj0umez4DfVdGnKZi63z1Xzxd0IQOn9VQDB8YU8g=
-github.com/coder/terraform-provider-coder v0.6.23/go.mod h1:UIfU3bYNeSzJJvHyJ30tEKjD6Z9utloI+HUM/7n94CY=
+github.com/coder/terraform-provider-coder v0.8.1 h1:i/LhvFi+Ei0gL+h4GItJfwtxjcITTlQhS+R8J+0vRo8=
+github.com/coder/terraform-provider-coder v0.8.1/go.mod h1:UIfU3bYNeSzJJvHyJ30tEKjD6Z9utloI+HUM/7n94CY=
 github.com/coder/wgtunnel v0.1.5 h1:WP3sCj/3iJ34eKvpMQEp1oJHvm24RYh0NHbj1kfUKfs=
 github.com/coder/wgtunnel v0.1.5/go.mod h1:bokoUrHnUFY4lu9KOeSYiIcHTI2MO1KwqumU4DPDyJI=
 github.com/containerd/aufs v0.0.0-20200908144142-dab0cbea06f4/go.mod h1:nukgQABAEopAHvB6j7cnP5zJ+/3aVcE7hCYqvIwAHyE=
diff --git a/provisioner/terraform/resources.go b/provisioner/terraform/resources.go
@@ -483,8 +483,8 @@ func ConvertState(modules []*tfjson.StateModule, rawGraph string, rawParameterNa
 		if len(param.Validation) == 1 {
 			protoParam.ValidationRegex = param.Validation[0].Regex
 			protoParam.ValidationError = param.Validation[0].Error
-			protoParam.ValidationMax = int32(param.Validation[0].Max)
-			protoParam.ValidationMin = int32(param.Validation[0].Min)
+			protoParam.ValidationMax = ptrInt32(param.Validation[0].Max)
+			protoParam.ValidationMin = ptrInt32(param.Validation[0].Min)
 			protoParam.ValidationMonotonic = param.Validation[0].Monotonic
 		}
 		if len(param.Option) > 0 {
@@ -527,6 +527,15 @@ func ConvertState(modules []*tfjson.StateModule, rawGraph string, rawParameterNa
 	}, nil
 }
 
+func ptrInt32(number *int) *int32 {
+	var n int32
+	if number == nil {
+		return &n
+	}
+	n = int32(*number)
+	return &n
+}
+
 // convertAddressToLabel returns the Terraform address without the count
 // specifier.
 // eg. "module.ec2_dev.ec2_instance.dev[0]" becomes "module.ec2_dev.ec2_instance.dev"
diff --git a/provisionersdk/proto/provisioner.pb.go b/provisionersdk/proto/provisioner.pb.go
diff --git a/provisionersdk/proto/provisioner.proto b/provisionersdk/proto/provisioner.proto
diff --git a/site/src/i18n/en/createWorkspacePage.json b/site/src/i18n/en/createWorkspacePage.json
diff --git a/site/src/utils/richParameters.ts b/site/src/utils/richParameters.ts

Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ import (`
`15`	`15`	`"github.com/coder/coder/cli/clitest"`
`16`	`16`	`"github.com/coder/coder/coderd/coderdtest"`
`17`	`17`	`"github.com/coder/coder/coderd/gitauth"`
	`18`	`+ "github.com/coder/coder/coderd/util/ptr"`
`18`	`19`	`"github.com/coder/coder/codersdk"`
`19`	`20`	`"github.com/coder/coder/provisioner/echo"`
`20`	`21`	`"github.com/coder/coder/provisionersdk/proto"`
`@@ -494,7 +495,7 @@ func TestCreateValidateRichParameters(t *testing.T) {`
`494`	`495`	`)`
`495`	`496`
`496`	`497`	`numberRichParameters := []*proto.RichParameter{`
`497`		`- {Name: numberParameterName, Type: "number", Mutable: true, ValidationMin: 3, ValidationMax: 10},`
	`498`	`+ {Name: numberParameterName, Type: "number", Mutable: true, ValidationMin: ptr.Ref(int32(3)), ValidationMax: ptr.Ref(int32(10))},`
`498`	`499`	`}`
`499`	`500`
`500`	`501`	`stringRichParameters := []*proto.RichParameter{`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ import (`
`11`	`11`
`12`	`12`	`"github.com/coder/coder/cli/clitest"`
`13`	`13`	`"github.com/coder/coder/coderd/coderdtest"`
	`14`	`+ "github.com/coder/coder/coderd/util/ptr"`
`14`	`15`	`"github.com/coder/coder/codersdk"`
`15`	`16`	`"github.com/coder/coder/provisioner/echo"`
`16`	`17`	`"github.com/coder/coder/provisionersdk/proto"`
`@@ -245,7 +246,7 @@ func TestUpdateValidateRichParameters(t *testing.T) {`
`245`	`246`	`)`
`246`	`247`
`247`	`248`	`numberRichParameters := []*proto.RichParameter{`
`248`		`- {Name: numberParameterName, Type: "number", Mutable: true, ValidationMin: 3, ValidationMax: 10},`
	`249`	`+ {Name: numberParameterName, Type: "number", Mutable: true, ValidationMin: ptr.Ref(int32(3)), ValidationMax: ptr.Ref(int32(10))},`
`249`	`250`	`}`
`250`	`251`
`251`	`252`	`stringRichParameters := []*proto.RichParameter{`