Float64 `AtLeast`, `AtMost` and `Between` validators #18

ewbankkit · 2022-05-20T21:12:36Z

Closes #1.

Copied wholesale from https://github.com/hashicorp/terraform-provider-awscc/tree/main/internal/validate.

% go test -v ./validate   
=== RUN   TestFloatBetweenValidator
=== PAUSE TestFloatBetweenValidator
=== RUN   TestFloatAtLeastValidator
=== PAUSE TestFloatAtLeastValidator
=== RUN   TestFloatAtMostValidator
=== PAUSE TestFloatAtMostValidator
=== CONT  TestFloatBetweenValidator
=== CONT  TestFloatAtMostValidator
=== RUN   TestFloatBetweenValidator/not_a_number
=== RUN   TestFloatAtMostValidator/valid_float_as_Number
=== CONT  TestFloatAtLeastValidator
=== RUN   TestFloatAtLeastValidator/unknown_number
=== RUN   TestFloatBetweenValidator/unknown_number
=== RUN   TestFloatAtMostValidator/valid_float_as_Float64_max
=== RUN   TestFloatBetweenValidator/valid_integer_as_Number
=== RUN   TestFloatAtLeastValidator/null_number
=== RUN   TestFloatBetweenValidator/valid_float_as_Number_min
=== RUN   TestFloatAtLeastValidator/valid_integer_as_Number
=== RUN   TestFloatAtMostValidator/too_large_float_as_Number
=== RUN   TestFloatBetweenValidator/valid_float_as_Float64_min
=== RUN   TestFloatBetweenValidator/valid_float_as_Float64_max
=== RUN   TestFloatAtMostValidator/valid_integer_as_Number
=== RUN   TestFloatAtLeastValidator/valid_integer_as_Float64
=== RUN   TestFloatAtMostValidator/valid_integer_as_Float64
=== RUN   TestFloatBetweenValidator/null_number
=== RUN   TestFloatAtLeastValidator/not_a_number
=== RUN   TestFloatAtMostValidator/null_number
=== RUN   TestFloatBetweenValidator/valid_integer_as_Float64
=== RUN   TestFloatAtLeastValidator/valid_float_as_Number
=== RUN   TestFloatAtMostValidator/valid_float_as_Float64
=== RUN   TestFloatAtLeastValidator/valid_float_as_Float64
=== RUN   TestFloatBetweenValidator/valid_float_as_Number
=== RUN   TestFloatBetweenValidator/valid_float_as_Float64
=== RUN   TestFloatAtMostValidator/valid_float_as_Number_max
=== RUN   TestFloatAtLeastValidator/valid_float_as_Number_min
=== RUN   TestFloatBetweenValidator/valid_float_as_Number_max
=== RUN   TestFloatAtMostValidator/not_a_number
=== RUN   TestFloatBetweenValidator/too_small_float_as_Number
=== RUN   TestFloatAtLeastValidator/valid_float_as_Float64_min
=== RUN   TestFloatAtMostValidator/unknown_number
=== RUN   TestFloatBetweenValidator/too_large_float_as_Number
=== RUN   TestFloatAtLeastValidator/too_small_float_as_Number
--- PASS: TestFloatBetweenValidator (0.00s)
    --- PASS: TestFloatBetweenValidator/not_a_number (0.00s)
    --- PASS: TestFloatBetweenValidator/unknown_number (0.00s)
    --- PASS: TestFloatBetweenValidator/valid_integer_as_Number (0.00s)
    --- PASS: TestFloatBetweenValidator/valid_float_as_Number_min (0.00s)
    --- PASS: TestFloatBetweenValidator/valid_float_as_Float64_min (0.00s)
    --- PASS: TestFloatBetweenValidator/valid_float_as_Float64_max (0.00s)
    --- PASS: TestFloatBetweenValidator/null_number (0.00s)
    --- PASS: TestFloatBetweenValidator/valid_integer_as_Float64 (0.00s)
    --- PASS: TestFloatBetweenValidator/valid_float_as_Number (0.00s)
    --- PASS: TestFloatBetweenValidator/valid_float_as_Float64 (0.00s)
    --- PASS: TestFloatBetweenValidator/valid_float_as_Number_max (0.00s)
    --- PASS: TestFloatBetweenValidator/too_small_float_as_Number (0.00s)
    --- PASS: TestFloatBetweenValidator/too_large_float_as_Number (0.00s)
--- PASS: TestFloatAtMostValidator (0.00s)
    --- PASS: TestFloatAtMostValidator/valid_float_as_Number (0.00s)
    --- PASS: TestFloatAtMostValidator/valid_float_as_Float64_max (0.00s)
    --- PASS: TestFloatAtMostValidator/too_large_float_as_Number (0.00s)
    --- PASS: TestFloatAtMostValidator/valid_integer_as_Number (0.00s)
    --- PASS: TestFloatAtMostValidator/valid_integer_as_Float64 (0.00s)
    --- PASS: TestFloatAtMostValidator/null_number (0.00s)
    --- PASS: TestFloatAtMostValidator/valid_float_as_Float64 (0.00s)
    --- PASS: TestFloatAtMostValidator/valid_float_as_Number_max (0.00s)
    --- PASS: TestFloatAtMostValidator/not_a_number (0.00s)
    --- PASS: TestFloatAtMostValidator/unknown_number (0.00s)
--- PASS: TestFloatAtLeastValidator (0.00s)
    --- PASS: TestFloatAtLeastValidator/unknown_number (0.00s)
    --- PASS: TestFloatAtLeastValidator/null_number (0.00s)
    --- PASS: TestFloatAtLeastValidator/valid_integer_as_Number (0.00s)
    --- PASS: TestFloatAtLeastValidator/valid_integer_as_Float64 (0.00s)
    --- PASS: TestFloatAtLeastValidator/not_a_number (0.00s)
    --- PASS: TestFloatAtLeastValidator/valid_float_as_Number (0.00s)
    --- PASS: TestFloatAtLeastValidator/valid_float_as_Float64 (0.00s)
    --- PASS: TestFloatAtLeastValidator/valid_float_as_Number_min (0.00s)
    --- PASS: TestFloatAtLeastValidator/valid_float_as_Float64_min (0.00s)
    --- PASS: TestFloatAtLeastValidator/too_small_float_as_Number (0.00s)
PASS
ok  	github.com/hashicorp/terraform-plugin-framework-validators/validate	0.877s

bflad

Very exciting! Thank you for starting this. Some meta feedback first. 😄 Please reach out with any questions.

validate/float.go

validate/float_test.go

ewbankkit · 2022-05-20T21:29:35Z

@bflad Any thoughts on Diagnostic format / error messages?

bflad · 2022-05-23T11:25:24Z

@bflad Any thoughts on Diagnostic format / error messages?

I'd suggest adding the word "Attribute" to the summary and capitalizing Value, e.g. Invalid Attribute Value and capitalizing the first letter of the detail. It might be nice to use the Description() method in the detail, then append the , got: value. Maybe worth creating a small helper function that could be shared across all validations that helps with this. e.g.

package validatordiag

func AttributeValueDiagnostic(path *tftypes.AttributePath, description string, value string) diag.Diagnostic {
	return diag.NewAttributeErrorDiagnostic(
		path,
		"Invalid Attribute Value",
		capitalize(description) + ", got: " + value,
	)
}

// capitalize will uppercase the first letter in a UTF-8 string.
func capitalize(str string) string {
	if str == "" {
		return ""
	}

	firstRune, size := utf8.DecodeRuneInString(str)

	return string(unicode.ToUpper(firstRune)) + str[size:]
}

With callers:

response.Diagnostics.Append(validatordiag.AttributeValueDiagnostic(
	request.AttributePath,
	validator.Description(ctx),
	fmt.Sprintf("%f", f),
))

…lementation.

ewbankkit · 2022-05-23T15:02:14Z

All review comments addressed.

float64validator/at_most.go

bflad

@bflad Are we OK with these Float validators working for both Float64 and Number?

At first I was thinking it might be best if it was strictly just types.Float64, however we could validate Number as long as it can be represented with big.Exact accuracy from (*big.Float).Float64(). That said, I think it is okay if we simplify it only work with Float64 for now, since Number can have up to 512 bits and should likely require specialized validation via the math/big package anyways.

float64validator/at_least.go

float64validator/at_most.go

float64validator/between.go

Co-authored-by: Brian Flad <[email protected]>

This reverts commit 1f1f3c0.

ewbankkit · 2022-05-24T14:40:03Z

Now disallowing types.Number.

bflad

Awesome!!! This is looking fantastic. Do you mind making a go-changelog entry? e.g. .changelog/18.txt

```release-note:feature
Introduced `float64validator` package with `AtLeast()`, `AtMost()`, and `Between()` validation functions
```

github-actions · 2022-06-25T02:38:52Z

I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions.
If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further.

ewbankkit added 2 commits May 20, 2022 17:10

Add Float validators from 'terraform-provider-awscc'.

28e3544

Run 'go mod tidy -compat=1.17'.

332a134

ewbankkit requested a review from a team as a code owner May 20, 2022 21:12

bflad added the enhancement New feature or request label May 20, 2022

ewbankkit marked this pull request as draft May 20, 2022 21:15

bflad added this to the v0.1.0 milestone May 20, 2022

This comment was marked as outdated.

Sign in to view

bflad reviewed May 20, 2022

View reviewed changes

validate/float.go Outdated Show resolved Hide resolved

validate/float.go Outdated Show resolved Hide resolved

validate/float.go Outdated Show resolved Hide resolved

validate/float_test.go Outdated Show resolved Hide resolved

bflad self-assigned this May 20, 2022

ewbankkit added 7 commits May 23, 2022 09:56

Rename package 'validate' -> 'float64validator'.

04d5da6

Split each validator into its own source file.

03944bd

Remove 'float'/'Float' from type and function names.

0c6ff1f

Use 'var _ tfsdk.AttributeValidator =' syntax to ensure interface imp…

dcb9247

…lementation.

Add 'validatordiag' package.

f3ccdf9

Use 'validatordiag.AttributeValueDiagnostic'.

d63b3d2

Use 'attr.Value' for test values, not 'tftypes.Value'.

2329511

ewbankkit marked this pull request as ready for review May 23, 2022 15:01

ewbankkit commented May 23, 2022

View reviewed changes

float64validator/at_most.go Show resolved Hide resolved

ewbankkit commented May 23, 2022

View reviewed changes

float64validator/at_most.go Outdated Show resolved Hide resolved

Unknown and Null float values are not valid.

1f1f3c0

bflad reviewed May 24, 2022

View reviewed changes

float64validator/at_least.go Outdated Show resolved Hide resolved

float64validator/at_most.go Outdated Show resolved Hide resolved

float64validator/between.go Outdated Show resolved Hide resolved

ewbankkit and others added 4 commits May 24, 2022 09:33

Update float64validator/between.go

578816e

Co-authored-by: Brian Flad <[email protected]>

Update float64validator/at_most.go

1adb12c

Co-authored-by: Brian Flad <[email protected]>

Update float64validator/at_least.go

9e4e780

Co-authored-by: Brian Flad <[email protected]>

Revert "Unknown and Null float values are not valid."

b391503

This reverts commit 1f1f3c0.

Do not allow 'types.Number'.

43e028f

bflad approved these changes May 24, 2022

View reviewed changes

Add CHANGELOG entry.

fca3710

bflad merged commit 44393e4 into hashicorp:main May 24, 2022

ewbankkit deleted the f-add-float64-validators branch May 24, 2022 15:35

bflad added the type/float64 types.Float64 validators label May 25, 2022

github-actions bot locked as resolved and limited conversation to collaborators Jun 25, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Float64 `AtLeast`, `AtMost` and `Between` validators #18

Float64 `AtLeast`, `AtMost` and `Between` validators #18

Uh oh!

ewbankkit commented May 20, 2022 •

edited

Loading

Uh oh!

This comment was marked as outdated.

bflad left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ewbankkit commented May 20, 2022

Uh oh!

bflad commented May 23, 2022 •

edited

Loading

Uh oh!

ewbankkit commented May 23, 2022

Uh oh!

Uh oh!

Uh oh!

bflad left a comment •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ewbankkit commented May 24, 2022

Uh oh!

bflad left a comment

Uh oh!

github-actions bot commented Jun 25, 2022

Uh oh!

Uh oh!

Float64 AtLeast, AtMost and Between validators #18

Float64 AtLeast, AtMost and Between validators #18

Uh oh!

Conversation

ewbankkit commented May 20, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment was marked as outdated.

bflad left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ewbankkit commented May 20, 2022

Uh oh!

bflad commented May 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ewbankkit commented May 23, 2022

Uh oh!

Uh oh!

Uh oh!

bflad left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ewbankkit commented May 24, 2022

Uh oh!

bflad left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jun 25, 2022

Uh oh!

Uh oh!

Float64 `AtLeast`, `AtMost` and `Between` validators #18

Float64 `AtLeast`, `AtMost` and `Between` validators #18

ewbankkit commented May 20, 2022 •

edited

Loading

bflad commented May 23, 2022 •

edited

Loading

bflad left a comment •

edited

Loading