Introduce type-specific integer value validation to apstra_freeform_resource

apstra/blueprint/datacenter_routing_zone.go

@@ -3,11 +3,13 @@ package blueprint
 import (
 	"context"
 	"fmt"
+	"net"
+	"regexp"
+
 	"github.com/Juniper/apstra-go-sdk/apstra"
 	apstravalidator "github.com/Juniper/terraform-provider-apstra/apstra/apstra_validator"
 	"github.com/Juniper/terraform-provider-apstra/apstra/constants"
 	"github.com/Juniper/terraform-provider-apstra/apstra/design"
-	"github.com/Juniper/terraform-provider-apstra/apstra/resources"
 	"github.com/Juniper/terraform-provider-apstra/apstra/utils"
 	"github.com/hashicorp/terraform-plugin-framework-validators/int64validator"
 	"github.com/hashicorp/terraform-plugin-framework-validators/setvalidator"
@@ -20,8 +22,6 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 	"github.com/hashicorp/terraform-plugin-framework/types"
-	"net"
-	"regexp"
 )
 
 var junosEvpnIrbModeDefault = apstra.JunosEvpnIrbModeAsymmetric.Value
@@ -236,7 +236,7 @@ func (o DatacenterRoutingZone) ResourceAttributes() map[string]resourceSchema.At
 				"automatically assigned from an allocated resource pool, or enter a specific value.",
 			Optional:   true,
 			Computed:   true,
-			Validators: []validator.Int64{int64validator.Between(resources.VniMin, resources.VniMax)},
+			Validators: []validator.Int64{int64validator.Between(constants.VniMin, constants.VniMax)},
 		},
 		"had_prior_vni_config": resourceSchema.BoolAttribute{
 			MarkdownDescription: "Used to trigger plan modification when `vni` has been removed from the " +

apstra/blueprint/datacenter_virtual_network.go

@@ -3,12 +3,15 @@ package blueprint
 import (
 	"context"
 	"fmt"
+	"net"
+	"regexp"
+	"strconv"
+
 	"github.com/Juniper/apstra-go-sdk/apstra"
 	apiversions "github.com/Juniper/terraform-provider-apstra/apstra/api_versions"
 	apstravalidator "github.com/Juniper/terraform-provider-apstra/apstra/apstra_validator"
 	"github.com/Juniper/terraform-provider-apstra/apstra/constants"
 	"github.com/Juniper/terraform-provider-apstra/apstra/design"
-	"github.com/Juniper/terraform-provider-apstra/apstra/resources"
 	"github.com/Juniper/terraform-provider-apstra/apstra/utils"
 	"github.com/hashicorp/go-version"
 	"github.com/hashicorp/terraform-plugin-framework-validators/helpers/validatordiag"
@@ -26,9 +29,6 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/resource/schema/stringplanmodifier"
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 	"github.com/hashicorp/terraform-plugin-framework/types"
-	"net"
-	"regexp"
-	"strconv"
 )
 
 type DatacenterVirtualNetwork struct {
@@ -340,7 +340,7 @@ func (o DatacenterVirtualNetwork) ResourceAttributes() map[string]resourceSchema
 			Optional: true,
 			Computed: true,
 			Validators: []validator.Int64{
-				int64validator.Between(resources.VniMin, resources.VniMax),
+				int64validator.Between(constants.VniMin, constants.VniMax),
 				apstravalidator.ForbiddenWhenValueIs(
 					path.MatchRelative().AtParent().AtName("type"),
 					types.StringValue(apstra.VnTypeVlan.String()),
@@ -746,7 +746,7 @@ func (o *DatacenterVirtualNetwork) Query(resultName string) apstra.QEQuery {
 	}
 
 	// not handling ipv6 subnet as a string match because of '::' expansion weirdness
-	//if !o.IPv6Subnet.IsNull() { nope! }
+	// if !o.IPv6Subnet.IsNull() { nope! }
 
 	if !o.IPv4GatewayEnabled.IsNull() {
 		nodeAttributes = append(nodeAttributes, apstra.QEEAttribute{
@@ -777,7 +777,7 @@ func (o *DatacenterVirtualNetwork) Query(resultName string) apstra.QEQuery {
 	}
 
 	// not handling ipv6 gateway as a string match because of '::' expansion weirdness
-	//if !o.IPv6Gateway.IsNull() { nope! }
+	// if !o.IPv6Gateway.IsNull() { nope! }
 
 	// Begin the query with the VN node
 	vnQuery := new(apstra.MatchQuery).Match(new(apstra.PathQuery).Node(nodeAttributes))

apstra/constants/numeric.go

@@ -26,4 +26,7 @@ const (
 
 	VlanMinUsable = 2
 	VlanMaxUsable = 4094
+
+	VniMin = 4096
+	VniMax = 16777214
 )

apstra/freeform/resource.go

@@ -146,8 +146,9 @@ func (o Resource) ResourceAttributes() map[string]resourceSchema.Attribute {
 		"type": resourceSchema.StringAttribute{
 			MarkdownDescription: "type of the Resource, must be one of :\n  - `" +
 				strings.Join(utils.AllFFResourceTypes(), "`\n  - `") + "`\n",
-			Optional:   true,
-			Validators: []validator.String{stringvalidator.OneOf(utils.AllFFResourceTypes()...)},
+			Required:      true,
+			PlanModifiers: []planmodifier.String{stringplanmodifier.RequiresReplace()},
+			Validators:    []validator.String{stringvalidator.OneOf(utils.AllFFResourceTypes()...)},
 		},
 		"integer_value": resourceSchema.Int64Attribute{
 			MarkdownDescription: fmt.Sprintf("Value used by integer type resources (`%s`, `%s`, `%s`, `%s`). "+

apstra/resource_freeform_resource.go

@@ -3,8 +3,10 @@ package tfapstra
 import (
 	"context"
 	"fmt"
+	"math"
 
 	"github.com/Juniper/apstra-go-sdk/apstra"
+	"github.com/Juniper/terraform-provider-apstra/apstra/constants"
 	"github.com/Juniper/terraform-provider-apstra/apstra/freeform"
 	"github.com/Juniper/terraform-provider-apstra/apstra/utils"
 	"github.com/hashicorp/terraform-plugin-framework/path"
@@ -57,17 +59,66 @@ func (o *resourceFreeformResource) ValidateConfig(ctx context.Context, req resou
 
 	// Reminder Logic: the unknown state in this function means a value was passed by reference
 	switch resourceType {
-	case apstra.FFResourceTypeAsn,
-		apstra.FFResourceTypeVni,
-		apstra.FFResourceTypeVlan,
-		apstra.FFResourceTypeInt:
+	case apstra.FFResourceTypeAsn:
 		if (config.AllocatedFrom.IsNull() && config.IntValue.IsNull()) ||
 			(!config.AllocatedFrom.IsNull() && !config.IntValue.IsNull()) {
 			resp.Diagnostics.AddError(
 				errInvalidConfig,
 				"Exactly one of `allocated_from` and `integer_value` must be set when `type` is set to "+config.Type.String(),
 			)
 		}
+		if !config.IntValue.IsNull() && (config.IntValue.ValueInt64() < constants.AsnMin || config.IntValue.ValueInt64() > constants.AsnMax) {
+			resp.Diagnostics.AddAttributeError(
+				path.Root("integer_value"),
+				errInvalidConfig,
+				fmt.Sprintf("When type is %s, value must be between %d and %d, got %s", config.Type, constants.AsnMin, constants.AsnMax, config.IntValue.String()),
+			)
+		}
+	case apstra.FFResourceTypeVni:
+		if (config.AllocatedFrom.IsNull() && config.IntValue.IsNull()) ||
+			(!config.AllocatedFrom.IsNull() && !config.IntValue.IsNull()) {
+			resp.Diagnostics.AddError(
+				errInvalidConfig,
+				"Exactly one of `allocated_from` and `integer_value` must be set when `type` is set to "+config.Type.String(),
+			)
+		}
+		if !config.IntValue.IsNull() && (config.IntValue.ValueInt64() < constants.VniMin || config.IntValue.ValueInt64() > constants.VniMax) {
+			resp.Diagnostics.AddAttributeError(
+				path.Root("integer_value"),
+				errInvalidConfig,
+				fmt.Sprintf("When type is %s, value must be between %d and %d, got %s", config.Type, constants.VniMin, constants.VniMax, config.IntValue.String()),
+			)
+		}
+	case apstra.FFResourceTypeVlan:
+		if (config.AllocatedFrom.IsNull() && config.IntValue.IsNull()) ||
+			(!config.AllocatedFrom.IsNull() && !config.IntValue.IsNull()) {
+			resp.Diagnostics.AddError(
+				errInvalidConfig,
+				"Exactly one of `allocated_from` and `integer_value` must be set when `type` is set to "+config.Type.String(),
+			)
+		}
+		if !config.IntValue.IsNull() && (config.IntValue.ValueInt64() < constants.VlanMinUsable || config.IntValue.ValueInt64() > constants.VlanMaxUsable) {
+			resp.Diagnostics.AddAttributeError(
+				path.Root("integer_value"),
+				errInvalidConfig,
+				fmt.Sprintf("When type is %s, value must be between %d and %d, got %s", config.Type, constants.VlanMinUsable, constants.VlanMaxUsable, config.IntValue.String()),
+			)
+		}
+	case apstra.FFResourceTypeInt:
+		if (config.AllocatedFrom.IsNull() && config.IntValue.IsNull()) ||
+			(!config.AllocatedFrom.IsNull() && !config.IntValue.IsNull()) {
+			resp.Diagnostics.AddError(
+				errInvalidConfig,
+				"Exactly one of `allocated_from` and `integer_value` must be set when `type` is set to "+config.Type.String(),
+			)
+		}
+		if !config.IntValue.IsNull() && (config.IntValue.ValueInt64() < 1 || config.IntValue.ValueInt64() > math.MaxUint32) {
+			resp.Diagnostics.AddAttributeError(
+				path.Root("integer_value"),
+				errInvalidConfig,
+				fmt.Sprintf("When type is %s, value must be between %d and %d, got %s", config.Type, 1, math.MaxUint32, config.IntValue.String()),
+			)
+		}
 	case apstra.FFResourceTypeHostIpv4:
 		if (config.AllocatedFrom.IsNull() && config.Ipv4Value.IsNull()) ||
 			(!config.AllocatedFrom.IsNull() && !config.Ipv4Value.IsNull()) {
@@ -104,6 +155,13 @@ func (o *resourceFreeformResource) ValidateConfig(ctx context.Context, req resou
 				"`integer_value` is used to indicate the Subnet Prefix Length. It must be set when `allocated_from` is set and `type` is set to "+config.Type.String(),
 			)
 		}
+		if !config.IntValue.IsNull() && (config.IntValue.ValueInt64() < 1 || config.IntValue.ValueInt64() > 32) {
+			resp.Diagnostics.AddAttributeError(
+				path.Root("integer_value"),
+				errInvalidConfig,
+				fmt.Sprintf("When type is %s, value must be between %d and %d, got %s", config.Type, 1, 32, config.IntValue.String()),
+			)
+		}
 	case apstra.FFResourceTypeIpv6:
 		if (config.AllocatedFrom.IsNull() && config.Ipv6Value.IsNull()) ||
 			(!config.AllocatedFrom.IsNull() && !config.Ipv6Value.IsNull()) {
@@ -124,6 +182,13 @@ func (o *resourceFreeformResource) ValidateConfig(ctx context.Context, req resou
 				"`integer_value` is used to indicate the Subnet Prefix Length. It must be set when `allocated_from` is set and `type` is set to "+config.Type.String(),
 			)
 		}
+		if !config.IntValue.IsNull() && (config.IntValue.ValueInt64() < 1 || config.IntValue.ValueInt64() > 128) {
+			resp.Diagnostics.AddAttributeError(
+				path.Root("integer_value"),
+				errInvalidConfig,
+				fmt.Sprintf("When type is %s, value must be between %d and %d, got %s", config.Type, 1, 128, config.IntValue.String()),
+			)
+		}
 	}
 }
 

apstra/resources/vni_pool_range.go

@@ -4,6 +4,7 @@ import (
 	"context"
 
 	"github.com/Juniper/apstra-go-sdk/apstra"
+	"github.com/Juniper/terraform-provider-apstra/apstra/constants"
 	"github.com/hashicorp/terraform-plugin-framework-validators/int64validator"
 	"github.com/hashicorp/terraform-plugin-framework/attr"
 	dataSourceSchema "github.com/hashicorp/terraform-plugin-framework/datasource/schema"
@@ -14,11 +15,6 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/types"
 )
 
-const (
-	VniMin = 4096
-	VniMax = 16777214
-)
-
 type VniPoolRange struct {
 	Status         types.String  `tfsdk:"status"`
 	First          types.Int64   `tfsdk:"first"`
@@ -72,12 +68,12 @@ func (o VniPoolRange) ResourceAttributes() map[string]resourceSchema.Attribute {
 	return map[string]resourceSchema.Attribute{
 		"first": resourceSchema.Int64Attribute{
 			Required:   true,
-			Validators: []validator.Int64{int64validator.Between(VniMin, VniMax)},
+			Validators: []validator.Int64{int64validator.Between(constants.VniMin, constants.VniMax)},
 		},
 		"last": resourceSchema.Int64Attribute{
 			Required: true,
 			Validators: []validator.Int64{
-				int64validator.Between(VniMin, VniMax),
+				int64validator.Between(constants.VniMin, constants.VniMax),
 				int64validator.AtLeastSumOf(path.MatchRelative().AtParent().AtName("first")),
 			},
 		},

docs/resources/freeform_resource.md

@@ -56,14 +56,6 @@ output "test_resource_out" { value = data.apstra_freeform_resource.test }
 - `blueprint_id` (String) Apstra Blueprint ID.
 - `group_id` (String) Group the Resource belongs to.
 - `name` (String) Freeform Resource name as shown in the Web UI.
-
-### Optional
-
-- `allocated_from` (String) ID of the node to be used as a source for this resource. This could be an ID of resource allocation group or another resource (in case of IP or Host IP allocations). This also can be empty. In that case it is required that value for this resource is provided by the user.
-- `assigned_to` (Set of String) Set of node IDs to which the resource is assigned
-- `integer_value` (Number) Value used by integer type resources (`asn`, `integer`, `vlan`, `vni`). Also used by IP prefix resources (`ipv4` and `ipv6`) to indicate the required prefix size for automatic allocations from another object or a resource pool.
-- `ipv4_value` (String) Value used by resources with type `ipv4` or `host_ipv4`. Must be CIDR notation.
-- `ipv6_value` (String) Value used by resources with type `ipv6` or `host_ipv6`. Must be CIDR notation.
 - `type` (String) type of the Resource, must be one of :
   - `asn`
   - `host_ipv4`
@@ -74,6 +66,14 @@ output "test_resource_out" { value = data.apstra_freeform_resource.test }
   - `vlan`
   - `vni`
 
+### Optional
+
+- `allocated_from` (String) ID of the node to be used as a source for this resource. This could be an ID of resource allocation group or another resource (in case of IP or Host IP allocations). This also can be empty. In that case it is required that value for this resource is provided by the user.
+- `assigned_to` (Set of String) Set of node IDs to which the resource is assigned
+- `integer_value` (Number) Value used by integer type resources (`asn`, `integer`, `vlan`, `vni`). Also used by IP prefix resources (`ipv4` and `ipv6`) to indicate the required prefix size for automatic allocations from another object or a resource pool.
+- `ipv4_value` (String) Value used by resources with type `ipv4` or `host_ipv4`. Must be CIDR notation.
+- `ipv6_value` (String) Value used by resources with type `ipv6` or `host_ipv6`. Must be CIDR notation.
+
 ### Read-Only
 
 - `generator_id` (String) ID of the Generator that created Resource Allocation Group. Always `null` because groups created via resource declaration were not generated.