Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

all: Add float32 type, attribute, and function support #1014

Merged
merged 23 commits into from
Jul 1, 2024
Merged
Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changes/unreleased/FEATURES-20240626-123513.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kind: FEATURES
body: 'types/basetypes: Added `Float32Type` and `Float32Value` implementations for
Float32 value handling.'
time: 2024-06-26T12:35:13.705873-04:00
custom:
Issue: "1014"
7 changes: 7 additions & 0 deletions .changes/unreleased/FEATURES-20240626-123533.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
kind: FEATURES
body: 'types/basetypes: Added interfaces `basetypes.Float32Typable`, `basetypes.Float32Valuable`,
and `basetypes.Float32ValuableWithSemanticEquals` for Float32 custom type and value
implementations.'
time: 2024-06-26T12:35:33.490507-04:00
custom:
Issue: "1014"
6 changes: 6 additions & 0 deletions .changes/unreleased/FEATURES-20240626-123545.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kind: FEATURES
body: 'resource/schema: Added `Float32Attribute` implementation for Float32 value
handling.'
time: 2024-06-26T12:35:45.867977-04:00
custom:
Issue: "1014"
6 changes: 6 additions & 0 deletions .changes/unreleased/FEATURES-20240626-123615.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kind: FEATURES
body: 'datasource/schema: Added `Float32Attribute` implementation for Float32 value
handling.'
time: 2024-06-26T12:36:15.026076-04:00
custom:
Issue: "1014"
6 changes: 6 additions & 0 deletions .changes/unreleased/FEATURES-20240626-123640.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kind: FEATURES
body: 'provider/schema: Added `Float32Attribute` implementation for Float32 value
handling.'
time: 2024-06-26T12:36:40.047935-04:00
custom:
Issue: "1014"
5 changes: 5 additions & 0 deletions .changes/unreleased/FEATURES-20240626-123651.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
kind: FEATURES
body: 'function: Added `Float32Parameter` and `Float32Return` for Float32 value handling.'
time: 2024-06-26T12:36:51.027757-04:00
custom:
Issue: "1014"
6 changes: 6 additions & 0 deletions .changes/unreleased/FEATURES-20240626-123738.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kind: FEATURES
body: 'resource/schema/float32default: New package with `StaticValue` implementation
for Float32 schema-based default values.'
time: 2024-06-26T12:37:38.728292-04:00
custom:
Issue: "1014"
6 changes: 6 additions & 0 deletions .changes/unreleased/FEATURES-20240626-123820.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kind: FEATURES
body: 'resource/schema/float32planmodifier: New package with built-in implementations
for Float32 value plan modification.'
time: 2024-06-26T12:38:20.591646-04:00
custom:
Issue: "1014"
6 changes: 6 additions & 0 deletions .changes/unreleased/FEATURES-20240626-123836.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kind: FEATURES
body: 'resource/schema/defaults: New `Float32` interface for Float32 schema-based
default implementations.'
time: 2024-06-26T12:38:36.234337-04:00
custom:
Issue: "1014"
6 changes: 6 additions & 0 deletions .changes/unreleased/FEATURES-20240626-123909.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
kind: FEATURES
body: 'resource/schema/planmodifier: New `Float32` interface for Float32 value plan
modification implementations.'
time: 2024-06-26T12:39:09.284352-04:00
custom:
Issue: "1014"
5 changes: 5 additions & 0 deletions .changes/unreleased/FEATURES-20240626-123922.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
kind: FEATURES
body: 'schema/validator: New `Float32` interface for Float32 value schema validation.'
time: 2024-06-26T12:39:22.726132-04:00
custom:
Issue: "1014"
191 changes: 191 additions & 0 deletions datasource/schema/float32_attribute.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,191 @@
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0

package schema

import (
"github.com/hashicorp/terraform-plugin-go/tftypes"

"github.com/hashicorp/terraform-plugin-framework/attr"
"github.com/hashicorp/terraform-plugin-framework/internal/fwschema"
"github.com/hashicorp/terraform-plugin-framework/internal/fwschema/fwxschema"
"github.com/hashicorp/terraform-plugin-framework/schema/validator"
"github.com/hashicorp/terraform-plugin-framework/types"
"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
)

// Ensure the implementation satisifies the desired interfaces.
var (
_ Attribute = Float32Attribute{}
_ fwxschema.AttributeWithFloat32Validators = Float32Attribute{}
)

// Float32Attribute represents a schema attribute that is a 32-bit floating
// point number. When retrieving the value for this attribute, use
// types.Float32 as the value type unless the CustomType field is set.
//
// Use Int32Attribute for 32-bit integer attributes or NumberAttribute for
// 512-bit generic number attributes.
//
// Terraform configurations configure this attribute using expressions that
// return a number or directly via a floating point value.
//
// example_attribute = 123.45
//
// Terraform configurations reference this attribute using the attribute name.
//
// .example_attribute
type Float32Attribute struct {
// CustomType enables the use of a custom attribute type in place of the
// default basetypes.Float32Type. When retrieving data, the basetypes.Float32Valuable
// associated with this custom type must be used in place of types.Float32.
CustomType basetypes.Float32Typable

// Required indicates whether the practitioner must enter a value for
// this attribute or not. Required and Optional cannot both be true,
// and Required and Computed cannot both be true.
Required bool

// Optional indicates whether the practitioner can choose to enter a value
// for this attribute or not. Optional and Required cannot both be true.
Optional bool

// Computed indicates whether the provider may return its own value for
// this Attribute or not. Required and Computed cannot both be true. If
// Required and Optional are both false, Computed must be true, and the
// attribute will be considered "read only" for the practitioner, with
// only the provider able to set its value.
Computed bool

// Sensitive indicates whether the value of this attribute should be
// considered sensitive data. Setting it to true will obscure the value
// in CLI output. Sensitive does not impact how values are stored, and
// practitioners are encouraged to store their state as if the entire
// file is sensitive.
Sensitive bool

// Description is used in various tooling, like the language server, to
// give practitioners more information about what this attribute is,
// what it's for, and how it should be used. It should be written as
// plain text, with no special formatting.
Description string

// MarkdownDescription is used in various tooling, like the
// documentation generator, to give practitioners more information
// about what this attribute is, what it's for, and how it should be
// used. It should be formatted using Markdown.
MarkdownDescription string

// DeprecationMessage defines warning diagnostic details to display when
// practitioner configurations use this Attribute. The warning diagnostic
// summary is automatically set to "Attribute Deprecated" along with
// configuration source file and line information.
//
// Set this field to a practitioner actionable message such as:
//
// - "Configure other_attribute instead. This attribute will be removed
// in the next major version of the provider."
// - "Remove this attribute's configuration as it no longer is used and
// the attribute will be removed in the next major version of the
// provider."
//
// In Terraform 1.2.7 and later, this warning diagnostic is displayed any
// time a practitioner attempts to configure a value for this attribute and
// certain scenarios where this attribute is referenced.
//
// In Terraform 1.2.6 and earlier, this warning diagnostic is only
// displayed when the Attribute is Required or Optional, and if the
// practitioner configuration sets the value to a known or unknown value
// (which may eventually be null). It has no effect when the Attribute is
// Computed-only (read-only; not Required or Optional).
//
// Across any Terraform version, there are no warnings raised for
// practitioner configuration values set directly to null, as there is no
// way for the framework to differentiate between an unset and null
// configuration due to how Terraform sends configuration information
// across the protocol.
//
// Additional information about deprecation enhancements for read-only
// attributes can be found in:
//
// - https://github.com/hashicorp/terraform/issues/7569
//
DeprecationMessage string

// Validators define value validation functionality for the attribute. All
// elements of the slice of AttributeValidator are run, regardless of any
// previous error diagnostics.
//
// Many common use case validators can be found in the
// github.com/hashicorp/terraform-plugin-framework-validators Go module.
//
// If the Type field points to a custom type that implements the
// xattr.TypeWithValidate interface, the validators defined in this field
// are run in addition to the validation defined by the type.
Validators []validator.Float32
}

// ApplyTerraform5AttributePathStep always returns an error as it is not
// possible to step further into a Float32Attribute.
func (a Float32Attribute) ApplyTerraform5AttributePathStep(step tftypes.AttributePathStep) (interface{}, error) {
return a.GetType().ApplyTerraform5AttributePathStep(step)
}

// Equal returns true if the given Attribute is a Float32Attribute
// and all fields are equal.
func (a Float32Attribute) Equal(o fwschema.Attribute) bool {
if _, ok := o.(Float32Attribute); !ok {
return false
}

return fwschema.AttributesEqual(a, o)
}

// Float32Validators returns the Validators field value.
func (a Float32Attribute) Float32Validators() []validator.Float32 {
return a.Validators
}

// GetDeprecationMessage returns the DeprecationMessage field value.
func (a Float32Attribute) GetDeprecationMessage() string {
return a.DeprecationMessage
}

// GetDescription returns the Description field value.
func (a Float32Attribute) GetDescription() string {
return a.Description
}

// GetMarkdownDescription returns the MarkdownDescription field value.
func (a Float32Attribute) GetMarkdownDescription() string {
return a.MarkdownDescription
}

// GetType returns types.Float32Type or the CustomType field value if defined.
func (a Float32Attribute) GetType() attr.Type {
if a.CustomType != nil {
return a.CustomType
}

return types.Float32Type
}

// IsComputed returns the Computed field value.
func (a Float32Attribute) IsComputed() bool {
return a.Computed
}

// IsOptional returns the Optional field value.
func (a Float32Attribute) IsOptional() bool {
return a.Optional
}

// IsRequired returns the Required field value.
func (a Float32Attribute) IsRequired() bool {
return a.Required
}

// IsSensitive returns the Sensitive field value.
func (a Float32Attribute) IsSensitive() bool {
return a.Sensitive
}
Loading