review

Author: Marcin Parafiniuk

docs/data-sources/wireless_ssid.md

@@ -24,15 +24,10 @@ data "meraki_wireless_ssid" "example" {
 
 ### Required
 
+- `id` (String) The id of the object
 - `network_id` (String) Network ID
 - `number` (String) Wireless SSID number
 
-### Optional
-
-- `id` (String) The id of the object
-- `name` (String) The name of the SSID
-- `named_vlans_radius_guest_vlan_name` (String) RADIUS guest VLAN name.
-
 ### Read-Only
 
 - `active_directory_credentials_logon_name` (String) The logon name of the Active Directory account.
@@ -74,7 +69,9 @@ data "meraki_wireless_ssid" "example" {
 - `local_radius_password_authentication_enabled` (Boolean) Whether or not to use EAP-TTLS/PAP or PEAP-GTC password-based authentication via LDAP lookup.
 - `mandatory_dhcp_enabled` (Boolean) If true, Mandatory DHCP will enforce that clients connecting to this SSID must use the IP address assigned by the DHCP server. Clients who use a static IP address won`t be able to associate.
 - `min_bitrate` (Number) The minimum bitrate in Mbps of this SSID in the default indoor RF profile. (`1`, `2`, `5.5`, `6`, `9`, `11`, `12`, `18`, `24`, `36`, `48` or `54`)
+- `name` (String) The name of the SSID
 - `named_vlans_radius_guest_vlan_enabled` (Boolean) Whether or not RADIUS guest named VLAN is enabled.
+- `named_vlans_radius_guest_vlan_name` (String) RADIUS guest VLAN name.
 - `named_vlans_tagging_by_ap_tags` (Attributes List) The list of AP tags and VLAN names used for named VLAN tagging. If an AP has a tag matching one in the list, then traffic on this SSID will be directed to use the VLAN name associated to the tag. (see [below for nested schema](#nestedatt--named_vlans_tagging_by_ap_tags))
 - `named_vlans_tagging_default_vlan_name` (String) The default VLAN name used to tag traffic in the absence of a matching AP tag.
 - `named_vlans_tagging_enabled` (Boolean) Whether or not traffic should be directed to use specific VLAN names.

gen/definitions/wireless_ssid.yaml

@@ -1,6 +1,5 @@
 name: Wireless SSID
 rest_endpoint: /networks/%v/wireless/ssids
-data_source_name_query: true
 doc_category: Wireless
 id_name: number
 attributes:
@@ -241,6 +240,7 @@ attributes:
       - model_name: host
         type: String
         mandatory: true
+        id: true
         description: IP address (or FQDN) of your Active Directory server.
         example: 127.0.0.1
       - model_name: port
@@ -318,6 +318,7 @@ attributes:
     example: '-----BEGIN CERTIFICATE-----\nMIIEKjCCAxKgAwIBAgIRANb+lsED3eb4+6YKLFFYqEkwDQYJKoZIhvcNAQELBQAw\ngYcxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApDYWxpZm9ybmlhMREwDwYDVQQHDAhT\nYW4gSm9zZTEcMBoGA1UECgwTQ2lzY28gU3lzdGVtcywgSW5jLjESMBAGA1UECwwJ\nRE5BU3BhY2VzMR4wHAYDVQQDDBVjaXNjby5vcGVucm9hbWluZy5vcmcwHhcNMjAx\nMTA1MjEzMzM1WhcNMjExMTA1MjIzMzM1WjCBpDEcMBoGCgmSJomT8ixkAQETDGRu\nYXNwYWNlczpVUzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAkNBMQ4wDAYDVQQKEwVD\naXNjbzEcMBoGA1UECxMTV0JBOldSSVggRW5kLUVudGl0eTE8MDoGA1UEAxMzNjQ3\nMDcwNDM4NDQ5NjQxMjAwMDAuMTg4MzQuaHMuY2lzY28ub3BlbnJvYW1pbmcub3Jn\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoqjP9QgRGyUO3p7SH9QK\nuTq6UYK7nAyjImgS4yQxeBkyZ5f2EUkX8m/AOcewpPxxPBhjPKRwxGeX3S50ksiA\nayFomUeslR0S0Z7RN9rzJa+CFyi9MwWIHMbLgXpB8tsSpgTAqwrzoTzOGq9fgC6u\npZhdZrBkg3FeJgD88goCi9mZDsY2YAoeGRLFJ2fR8iICqIVQy+Htq9pE22WBLpnS\nKjL3+mR9FArHNFtWlhKF2YHMUqyHHrnZnF/Ns7QNoMMF7/CK18iAKgnb+2wuGKM2\naEMddOeOTtz+i/rgjkp/RGMt011EdCsso0/cTo9qqX/bxOOCE4/Mne/ChMkQPnNU\nCwIDAQABo3IwcDAJBgNVHRMEAjAAMB8GA1UdIwQYMBaAFIG+4l5yiB01gP0sw4ML\nUSopqYcuMB0GA1UdDgQWBBSby1T9leYVOVVdOZXiHCSaDDEMiDAOBgNVHQ8BAf8E\nBAMCBaAwEwYDVR0lBAwwCgYIKwYBBQUHAwIwDQYJKoZIhvcNAQELBQADggEBAEyE\n1mjSUyY6uNp6W4l20w7SskALSJDRKkOeZxAgF3VMxlsCuEl70s9oEfntwIpyQtSa\njON/9yJHbwm/Az824bmk8Dc7AXIPhay+dftXb8j529gPuYB9AKoPNg0NctkyYCQh\na/3YQVdDWX7XgmEiXkL57M7G6+IdcPDONLArfjOcT9qHdkVVq1AIjlMSx3OQQmm/\nuoLb/G9q/97QA2/l8shG/Na8HjVqGLcl5TNZdbNhs2w9ogxr/GNzqdvym6RQ8vT/\nUR2n+uwH4n1MUxmHYYeyot5dnIV1IJ6hQ54JAncM9HvCLFk1WHz6RKshQUCuPBiJ\nwTw70BVktzJnb0VLeDg=\n-----END CERTIFICATE-----'
   - model_name: servers
     type: List
+    ordered_list: true
     data_path: [ldap]
     exclude_test: true
     description: The LDAP servers to be used for authentication.
@@ -408,6 +409,7 @@ attributes:
         type: String
         description: VLAN name that will be used to tag traffic.
         example: My VLAN
+        id: true
       - model_name: tags
         type: List
         element_type: String
@@ -446,6 +448,7 @@ attributes:
     example: tag1
   - model_name: radiusAccountingServers
     type: List
+    ordered_list: true
     exclude_test: true
     description: The RADIUS accounting 802.1X servers to be used for authentication. This param is only valid if the authMode is `open-with-radius`, `8021x-radius` or `ipsk-with-radius` and radiusAccountingEnabled is `true`
     attributes:
@@ -473,6 +476,7 @@ attributes:
   - model_name: radiusServers
     type: List
     exclude_test: true
+    ordered_list: true
     description: The RADIUS 802.1X servers to be used for authentication. This param is only valid if the authMode is `open-with-radius`, `8021x-radius` or `ipsk-with-radius`
     attributes:
       - model_name: caCertificate

internal/provider/data_source_meraki_wireless_ssid.go

@@ -23,10 +23,8 @@ import (
 	"fmt"
 	"net/url"
 
-	"github.com/hashicorp/terraform-plugin-framework-validators/datasourcevalidator"
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
 	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
-	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 	"github.com/hashicorp/terraform-plugin-log/tflog"
 	"github.com/netascode/go-meraki"
@@ -63,8 +61,7 @@ func (d *WirelessSSIDDataSource) Schema(ctx context.Context, req datasource.Sche
 		Attributes: map[string]schema.Attribute{
 			"id": schema.StringAttribute{
 				MarkdownDescription: "The id of the object",
-				Optional:            true,
-				Computed:            true,
+				Required:            true,
 			},
 			"network_id": schema.StringAttribute{
 				MarkdownDescription: "Network ID",
@@ -132,7 +129,6 @@ func (d *WirelessSSIDDataSource) Schema(ctx context.Context, req datasource.Sche
 			},
 			"name": schema.StringAttribute{
 				MarkdownDescription: "The name of the SSID",
-				Optional:            true,
 				Computed:            true,
 			},
 			"per_client_bandwidth_limit_down": schema.Int64Attribute{
@@ -370,7 +366,6 @@ func (d *WirelessSSIDDataSource) Schema(ctx context.Context, req datasource.Sche
 			},
 			"named_vlans_radius_guest_vlan_name": schema.StringAttribute{
 				MarkdownDescription: "RADIUS guest VLAN name.",
-				Optional:            true,
 				Computed:            true,
 			},
 			"named_vlans_tagging_default_vlan_name": schema.StringAttribute{
@@ -502,14 +497,6 @@ func (d *WirelessSSIDDataSource) Schema(ctx context.Context, req datasource.Sche
 		},
 	}
 }
-func (d *WirelessSSIDDataSource) ConfigValidators(ctx context.Context) []datasource.ConfigValidator {
-	return []datasource.ConfigValidator{
-		datasourcevalidator.ExactlyOneOf(
-			path.MatchRoot("id"),
-			path.MatchRoot("name"),
-		),
-	}
-}
 
 func (d *WirelessSSIDDataSource) Configure(_ context.Context, req datasource.ConfigureRequest, _ *datasource.ConfigureResponse) {
 	if req.ProviderData == nil {
@@ -537,29 +524,6 @@ func (d *WirelessSSIDDataSource) Read(ctx context.Context, req datasource.ReadRe
 
 	var res gjson.Result
 	var err error
-	if config.Id.IsNull() && !config.Name.IsNull() {
-		res, err = d.client.Get(config.getPath())
-		if err != nil {
-			resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to retrieve objects, got error: %s", err))
-			return
-		}
-		if len(res.Array()) > 0 {
-			res.ForEach(func(k, v gjson.Result) bool {
-				if config.Name.ValueString() == v.Get("name").String() {
-					config.Id = types.StringValue(v.Get("number").String())
-					tflog.Debug(ctx, fmt.Sprintf("%s: Found object with name '%v', id: %v", config.Id.String(), config.Name.ValueString(), config.Id.String()))
-					res = v
-					return false
-				}
-				return true
-			})
-		}
-
-		if config.Id.IsNull() {
-			resp.Diagnostics.AddError("Client Error", fmt.Sprintf("Failed to find object with name: %s", config.Name.ValueString()))
-			return
-		}
-	}
 
 	if !res.Exists() {
 		res, err = d.client.Get(config.getPath() + "/" + url.QueryEscape(config.Id.ValueString()))

internal/provider/data_source_meraki_wireless_ssid_test.go

@@ -65,10 +65,6 @@ func TestAccDataSourceMerakiWirelessSSID(t *testing.T) {
 				Config: testAccDataSourceMerakiWirelessSSIDPrerequisitesConfig + testAccDataSourceMerakiWirelessSSIDConfig(),
 				Check:  resource.ComposeTestCheckFunc(checks...),
 			},
-			{
-				Config: testAccDataSourceMerakiWirelessSSIDPrerequisitesConfig + testAccNamedDataSourceMerakiWirelessSSIDConfig(),
-				Check:  resource.ComposeTestCheckFunc(checks...),
-			},
 		},
 	})
 }
@@ -136,46 +132,4 @@ func testAccDataSourceMerakiWirelessSSIDConfig() string {
 	return config
 }
 
-func testAccNamedDataSourceMerakiWirelessSSIDConfig() string {
-	config := `resource "meraki_wireless_ssid" "test" {` + "\n"
-	config += `	network_id = meraki_network.test.id` + "\n"
-	config += `	number = "0"` + "\n"
-	config += `	auth_mode = "psk"` + "\n"
-	config += `	available_on_all_aps = false` + "\n"
-	config += `	band_selection = "5 GHz band only"` + "\n"
-	config += `	enabled = false` + "\n"
-	config += `	encryption_mode = "wpa"` + "\n"
-	config += `	ip_assignment_mode = "Bridge mode"` + "\n"
-	config += `	lan_isolation_enabled = false` + "\n"
-	config += `	mandatory_dhcp_enabled = false` + "\n"
-	config += `	min_bitrate = 5.5` + "\n"
-	config += `	name = "My SSID"` + "\n"
-	config += `	per_client_bandwidth_limit_down = 0` + "\n"
-	config += `	per_client_bandwidth_limit_up = 0` + "\n"
-	config += `	per_ssid_bandwidth_limit_down = 0` + "\n"
-	config += `	per_ssid_bandwidth_limit_up = 0` + "\n"
-	config += `	psk = "deadbeef"` + "\n"
-	config += `	splash_page = "Click-through splash page"` + "\n"
-	config += `	use_vlan_tagging = false` + "\n"
-	config += `	visible = false` + "\n"
-	config += `	walled_garden_enabled = false` + "\n"
-	config += `	wpa_encryption_mode = "WPA2 only"` + "\n"
-	config += `	dot11r_adaptive = false` + "\n"
-	config += `	dot11r_enabled = false` + "\n"
-	config += `	dot11w_enabled = false` + "\n"
-	config += `	dot11w_required = false` + "\n"
-	config += `	speed_burst_enabled = false` + "\n"
-	config += `	availability_tags = ["tag1"]` + "\n"
-	config += `}` + "\n"
-
-	config += `
-		data "meraki_wireless_ssid" "test" {
-			name = meraki_wireless_ssid.test.name
-			network_id = meraki_network.test.id
-			number = "0"
-		}
-	`
-	return config
-}
-
 // End of section. //template:end testAccDataSourceConfig

internal/provider/model_meraki_wireless_ssid.go

@@ -1259,8 +1259,8 @@ func (data *WirelessSSID) fromBodyPartial(ctx context.Context, res gjson.Result)
 		data.ActiveDirectoryCredentialsPassword = types.StringNull()
 	}
 	for i := 0; i < len(data.ActiveDirectoryServers); i++ {
-		keys := [...]string{"host", "port"}
-		keyValues := [...]string{data.ActiveDirectoryServers[i].Host.ValueString(), strconv.FormatInt(data.ActiveDirectoryServers[i].Port.ValueInt64(), 10)}
+		keys := [...]string{"host"}
+		keyValues := [...]string{data.ActiveDirectoryServers[i].Host.ValueString()}
 
 		parent := &data
 		data := (*parent).ActiveDirectoryServers[i]
@@ -1366,42 +1366,18 @@ func (data *WirelessSSID) fromBodyPartial(ctx context.Context, res gjson.Result)
 	} else {
 		data.LdapServerCaCertificateContents = types.StringNull()
 	}
-	for i := 0; i < len(data.LdapServers); i++ {
-		keys := [...]string{"host", "port"}
-		keyValues := [...]string{data.LdapServers[i].Host.ValueString(), strconv.FormatInt(data.LdapServers[i].Port.ValueInt64(), 10)}
-
+	{
+		l := len(res.Get("ldap.servers").Array())
+		tflog.Debug(ctx, fmt.Sprintf("ldap.servers array resizing from %d to %d", len(data.LdapServers), l))
+		if len(data.LdapServers) > l {
+			data.LdapServers = data.LdapServers[:l]
+		}
+	}
+	for i := range data.LdapServers {
 		parent := &data
 		data := (*parent).LdapServers[i]
 		parentRes := &res
-		var res gjson.Result
-
-		parentRes.Get("ldap.servers").ForEach(
-			func(_, v gjson.Result) bool {
-				found := false
-				for ik := range keys {
-					if v.Get(keys[ik]).String() != keyValues[ik] {
-						found = false
-						break
-					}
-					found = true
-				}
-				if found {
-					res = v
-					return false
-				}
-				return true
-			},
-		)
-		if !res.Exists() {
-			tflog.Debug(ctx, fmt.Sprintf("removing LdapServers[%d] = %+v",
-				i,
-				(*parent).LdapServers[i],
-			))
-			(*parent).LdapServers = slices.Delete((*parent).LdapServers, i, i+1)
-			i--
-
-			continue
-		}
+		res := parentRes.Get(fmt.Sprintf("ldap.servers.%d", i))
 		if value := res.Get("host"); value.Exists() && !data.Host.IsNull() {
 			data.Host = types.StringValue(value.String())
 		} else {
@@ -1580,42 +1556,18 @@ func (data *WirelessSSID) fromBodyPartial(ctx context.Context, res gjson.Result)
 	} else {
 		data.AvailabilityTags = types.ListNull(types.StringType)
 	}
-	for i := 0; i < len(data.RadiusAccountingServers); i++ {
-		keys := [...]string{"caCertificate", "host", "port", "radsecEnabled", "secret"}
-		keyValues := [...]string{data.RadiusAccountingServers[i].CaCertificate.ValueString(), data.RadiusAccountingServers[i].Host.ValueString(), strconv.FormatInt(data.RadiusAccountingServers[i].Port.ValueInt64(), 10), strconv.FormatBool(data.RadiusAccountingServers[i].RadsecEnabled.ValueBool()), data.RadiusAccountingServers[i].Secret.ValueString()}
-
+	{
+		l := len(res.Get("radiusAccountingServers").Array())
+		tflog.Debug(ctx, fmt.Sprintf("radiusAccountingServers array resizing from %d to %d", len(data.RadiusAccountingServers), l))
+		if len(data.RadiusAccountingServers) > l {
+			data.RadiusAccountingServers = data.RadiusAccountingServers[:l]
+		}
+	}
+	for i := range data.RadiusAccountingServers {
 		parent := &data
 		data := (*parent).RadiusAccountingServers[i]
 		parentRes := &res
-		var res gjson.Result
-
-		parentRes.Get("radiusAccountingServers").ForEach(
-			func(_, v gjson.Result) bool {
-				found := false
-				for ik := range keys {
-					if v.Get(keys[ik]).String() != keyValues[ik] {
-						found = false
-						break
-					}
-					found = true
-				}
-				if found {
-					res = v
-					return false
-				}
-				return true
-			},
-		)
-		if !res.Exists() {
-			tflog.Debug(ctx, fmt.Sprintf("removing RadiusAccountingServers[%d] = %+v",
-				i,
-				(*parent).RadiusAccountingServers[i],
-			))
-			(*parent).RadiusAccountingServers = slices.Delete((*parent).RadiusAccountingServers, i, i+1)
-			i--
-
-			continue
-		}
+		res := parentRes.Get(fmt.Sprintf("radiusAccountingServers.%d", i))
 		if value := res.Get("caCertificate"); value.Exists() && !data.CaCertificate.IsNull() {
 			data.CaCertificate = types.StringValue(value.String())
 		} else {
@@ -1643,42 +1595,18 @@ func (data *WirelessSSID) fromBodyPartial(ctx context.Context, res gjson.Result)
 		}
 		(*parent).RadiusAccountingServers[i] = data
 	}
-	for i := 0; i < len(data.RadiusServers); i++ {
-		keys := [...]string{"caCertificate", "host", "openRoamingCertificateId", "port", "radsecEnabled", "secret"}
-		keyValues := [...]string{data.RadiusServers[i].CaCertificate.ValueString(), data.RadiusServers[i].Host.ValueString(), strconv.FormatInt(data.RadiusServers[i].OpenRoamingCertificateId.ValueInt64(), 10), strconv.FormatInt(data.RadiusServers[i].Port.ValueInt64(), 10), strconv.FormatBool(data.RadiusServers[i].RadsecEnabled.ValueBool()), data.RadiusServers[i].Secret.ValueString()}
-
+	{
+		l := len(res.Get("radiusServers").Array())
+		tflog.Debug(ctx, fmt.Sprintf("radiusServers array resizing from %d to %d", len(data.RadiusServers), l))
+		if len(data.RadiusServers) > l {
+			data.RadiusServers = data.RadiusServers[:l]
+		}
+	}
+	for i := range data.RadiusServers {
 		parent := &data
 		data := (*parent).RadiusServers[i]
 		parentRes := &res
-		var res gjson.Result
-
-		parentRes.Get("radiusServers").ForEach(
-			func(_, v gjson.Result) bool {
-				found := false
-				for ik := range keys {
-					if v.Get(keys[ik]).String() != keyValues[ik] {
-						found = false
-						break
-					}
-					found = true
-				}
-				if found {
-					res = v
-					return false
-				}
-				return true
-			},
-		)
-		if !res.Exists() {
-			tflog.Debug(ctx, fmt.Sprintf("removing RadiusServers[%d] = %+v",
-				i,
-				(*parent).RadiusServers[i],
-			))
-			(*parent).RadiusServers = slices.Delete((*parent).RadiusServers, i, i+1)
-			i--
-
-			continue
-		}
+		res := parentRes.Get(fmt.Sprintf("radiusServers.%d", i))
 		if value := res.Get("caCertificate"); value.Exists() && !data.CaCertificate.IsNull() {
 			data.CaCertificate = types.StringValue(value.String())
 		} else {