Terraform Support for Managing Reserved IP Addresses #1598

AniJ98 · 2024-09-26T15:15:52Z

📝 Description

This PR introduces comprehensive functionality and tests for Reserved IP Addresses in the terraform provider. The changes are necessary to provide robust support for managing Reserved IP addresses through terraform. The changes include:

Implementation of core Reserved IP operations:

Listing Reserved IPs
Getting a specific Reserved IP
Reserving a new IP
Deleting a Reserved IP

Test coverage:

Resource test - Covers testing the functionality of reserving and deleting a reserved IP Address
Datasource test - Covers testing the functionality of listing all reserved IP addresses and fetching a particular reserved IP Address.

✔️ How to Test

What are the steps to reproduce the issue or verify the changes?

Ensure you have a valid Linode API token. Set up your environment: 

export LINODE_TOKEN="your_token_here" 
To run only Reserved IP related tests: 

make int-test PKG_NAME="linode/networkreservedips"

To run a specific test:

  make int-test PKG_NAME="linode/networkreservedips" ARGS="-run TestAccDataSource_reservedIP"

Verify the test output for any failures or unexpected behavior.

Note:

Ensure you have proper permissions and sufficient quota in your Linode account to perform Reserved IP operations. Some tests may create and delete resources, so use a testing environment if possible. This test expects the account to have 0 prior reservations.

… respective tests

…anch before next release

… tests from being run by unit test targets

zliang-akamai · 2024-10-02T18:44:01Z

go.mod

@@ -26,7 +26,7 @@ require (
 	github.com/hashicorp/terraform-plugin-mux v0.16.0
 	github.com/hashicorp/terraform-plugin-sdk/v2 v2.34.0
 	github.com/hashicorp/terraform-plugin-testing v1.10.0
-	github.com/linode/linodego v1.41.0
+	github.com/linode/linodego v1.41.1-0.20240925173015-b20be2e986e0


Let's wait for next linodego release

… to the latest release

yec-akamai

Thank you for your hard work on the IP reserve resource and data source. I left some suggestions to build this resource better:

yec-akamai · 2024-10-15T19:12:24Z

linode/networkreservedips/framework_datasource.go

+		// List all reserved IPs
+		filter := ""
+		ips, err := d.Meta.Client.ListReservedIPAddresses(ctx, &linodego.ListOptions{Filter: filter})
+		if err != nil {
+			resp.Diagnostics.AddError(
+				"Unable to list Reserved IP Addresses",
+				err.Error(),
+			)
+			return
+		}
+
+		reservedIPs := make([]ReservedIPObject, len(ips))
+		for i, ip := range ips {
+			reservedIPs[i] = ReservedIPObject{
+				ID:         types.StringValue(ip.Address),
+				Address:    types.StringValue(ip.Address),
+				Region:     types.StringValue(ip.Region),
+				Gateway:    types.StringValue(ip.Gateway),
+				SubnetMask: types.StringValue(ip.SubnetMask),
+				Prefix:     types.Int64Value(int64(ip.Prefix)),
+				Type:       types.StringValue(string(ip.Type)),
+				Public:     types.BoolValue(ip.Public),
+				RDNS:       types.StringValue(ip.RDNS),
+				LinodeID:   types.Int64Value(int64(ip.LinodeID)),
+				Reserved:   types.BoolValue(ip.Reserved),
+			}
+		}
+
+		reservedIPsValue, diags := types.ListValueFrom(ctx, reservedIPObjectType, reservedIPs)
+		resp.Diagnostics.Append(diags...)
+		if resp.Diagnostics.HasError() {
+			return
+		}
+		data.ReservedIPs = reservedIPsValue
+
+		// If there are IPs, populate the first one's details for backwards compatibility
+		if len(ips) > 0 {
+			data.parseIP(&ips[0])
+		}


Are we trying to get a list of reserved_ips for a customer? If so, you will need to create a new data source, i.e., network_reserved_ips only for listing and filtering reserved ips. Terraform don't mix it in a single data source.

You can take a look at other list data source in our code base for reference.

Makes sense! I will be creating a new datasource for the list functionality.

yec-akamai · 2024-10-15T19:13:12Z

linode/networkreservedips/framework_datasource.go

+type DataSourceModel struct {
+	ID          types.String `tfsdk:"id"`
+	Address     types.String `tfsdk:"address"`
+	Region      types.String `tfsdk:"region"`
+	Gateway     types.String `tfsdk:"gateway"`
+	SubnetMask  types.String `tfsdk:"subnet_mask"`
+	Prefix      types.Int64  `tfsdk:"prefix"`
+	Type        types.String `tfsdk:"type"`
+	Public      types.Bool   `tfsdk:"public"`
+	RDNS        types.String `tfsdk:"rdns"`
+	LinodeID    types.Int64  `tfsdk:"linode_id"`
+	Reserved    types.Bool   `tfsdk:"reserved"`
+	ReservedIPs types.List   `tfsdk:"reserved_ips"`
+}
+
+func (data *DataSourceModel) parseIP(ip *linodego.InstanceIP) {
+	data.ID = types.StringValue(ip.Address)
+	data.Address = types.StringValue(ip.Address)
+	data.Region = types.StringValue(ip.Region)
+	data.Gateway = types.StringValue(ip.Gateway)
+	data.SubnetMask = types.StringValue(ip.SubnetMask)
+	data.Prefix = types.Int64Value(int64(ip.Prefix))
+	data.Type = types.StringValue(string(ip.Type))
+	data.Public = types.BoolValue(ip.Public)
+	data.RDNS = types.StringValue(ip.RDNS)
+	data.LinodeID = types.Int64Value(int64(ip.LinodeID))
+	data.Reserved = types.BoolValue(ip.Reserved)
+}


Can you move this data source model and parsing function to framwork_models to keep the data source short and clear?

Yeah I will be doing it the next commit

yec-akamai · 2024-10-15T19:13:41Z

linode/networkreservedips/framework_datasource.go

+	RDNS        types.String `tfsdk:"rdns"`
+	LinodeID    types.Int64  `tfsdk:"linode_id"`
+	Reserved    types.Bool   `tfsdk:"reserved"`
+	ReservedIPs types.List   `tfsdk:"reserved_ips"`


You may need to build another data source for listing reserved IPs, instead of having it here.

Yeah I will be having a new datasource for this

yec-akamai · 2024-10-15T19:17:03Z

linode/networkreservedips/framework_datasource_schema.go

+		"region": schema.StringAttribute{
+			Description: "The Region in which to reserve the IP address.",
+			Optional:    true,
+		},
+		"address": schema.StringAttribute{
+			Description: "The reserved IP address.",
+			Optional:    true,
+		},


Not sure if I understand the endpoint correctly, but it looks like address is a required attribute to get this data source?

I have made it optional since I am implementing both fetch and list endpoints in the same datasource. But now it seems like it is indeed a better idea to separate the functionalities into individual datasources. I will be doing that in the next commit.

yec-akamai · 2024-10-15T19:18:08Z

linode/networkreservedips/framework_datasource_schema.go

+		"reserved_ips": schema.ListAttribute{
+			Description: "A list of all reserved IPs.",
+			Computed:    true,
+			ElementType: reservedIPObjectType,
+		},


Like I mentioned above, we can remove this list to its own data source.

Yeah will be separating it into a new datasource

yec-akamai · 2024-10-15T19:37:25Z

linode/networkreservedips/framework_models.go

+	ip linodego.InstanceIP,
+	preserveKnown bool,
+) diag.Diagnostics {
+	var diags diag.Diagnostics


Looks like no diags is raised from this function. You can just remove it.

I will look into it. I will remove it if it is not being triggered.

yec-akamai · 2024-10-15T19:38:26Z

linode/networkreservedips/resource_test.go

+	t.Logf("Starting TestAccResource_reserveIP with resName: %s, instanceName: %s, region: %s", resName, instanceName, testRegion)
+


I think it's ok not to log this info here.

yec-akamai · 2024-10-15T19:38:48Z

linode/networkreservedips/resource_test.go

+
+	resource.Test(t, resource.TestCase{
+		PreCheck: func() {
+			t.Log("Running PreCheck")


May need to clean this up too.

yec-akamai · 2024-10-15T19:38:57Z

linode/networkreservedips/resource_test.go

+				Config: tmpl.ReserveIP(t, instanceName, testRegion),
+				Check: resource.ComposeTestCheckFunc(
+					func(s *terraform.State) error {
+						t.Log("Running Check function")


Suggested change

t.Log("Running Check function")

I will remove this line

yec-akamai · 2024-10-15T19:39:59Z

linode/networkreservedips/tmpl/reserved_ip.gotf

+{{ define "reserved_ip_data_list" }}
+
+data "linode_reserved_ip" "test" {}
+
+{{ end }}


Suggested change

{{ define "reserved_ip_data_list" }}

data "linode_reserved_ip" "test" {}

{{ end }}

We usually don't define two script in one file.

…responding test. Removed unnessary logs

AniJ98 added 2 commits September 26, 2024 10:13

Registered the resource and data source within the provider

c0451aa

Implemented framework_resource, framework_datasource along with their…

3d09656

… respective tests

AniJ98 requested a review from a team as a code owner September 26, 2024 15:15

AniJ98 requested review from zliang-akamai and yec-akamai and removed request for a team September 26, 2024 15:15

AniJ98 added 3 commits September 26, 2024 13:59

temporarily changed linodego to point to the latest commit on main br…

c9196b8

…anch before next release

Merge branch 'dev' into ipreservation-newendpoints

950ab3b

added go buil inegration || networkreservedips to prevent integration…

b6638d8

… tests from being run by unit test targets

zliang-akamai reviewed Oct 2, 2024

View reviewed changes

Merge branch 'dev' into ipreservation-newendpoints

2b18460

AniJ98 requested review from zliang-akamai October 7, 2024 21:24

AniJ98 added 2 commits October 8, 2024 11:20

removed unused import statement and changed linodego version to point…

be57ac7

… to the latest release

removed unnecessary region filter from datasource

38195df

yec-akamai requested changes Oct 15, 2024

View reviewed changes

Created a separate datasource for listing reserved IPs, added the cor…

24493f8

…responding test. Removed unnessary logs

AniJ98 requested a review from yec-akamai October 16, 2024 08:10

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Terraform Support for Managing Reserved IP Addresses #1598

Terraform Support for Managing Reserved IP Addresses #1598

AniJ98 commented Sep 26, 2024

zliang-akamai Oct 2, 2024

yec-akamai left a comment

yec-akamai Oct 15, 2024

AniJ98 Oct 15, 2024 •

edited

Loading

yec-akamai Oct 15, 2024

AniJ98 Oct 15, 2024

yec-akamai Oct 15, 2024

AniJ98 Oct 15, 2024

yec-akamai Oct 15, 2024

AniJ98 Oct 15, 2024

yec-akamai Oct 15, 2024

AniJ98 Oct 15, 2024

yec-akamai Oct 15, 2024

AniJ98 Oct 15, 2024

yec-akamai Oct 15, 2024

yec-akamai Oct 15, 2024

AniJ98 Oct 15, 2024

yec-akamai Oct 15, 2024

AniJ98 Oct 15, 2024

yec-akamai Oct 15, 2024

		t.Logf("Starting TestAccResource_reserveIP with resName: %s, instanceName: %s, region: %s", resName, instanceName, testRegion)

Terraform Support for Managing Reserved IP Addresses #1598

Are you sure you want to change the base?

Terraform Support for Managing Reserved IP Addresses #1598

Conversation

AniJ98 commented Sep 26, 2024

📝 Description

✔️ How to Test

Choose a reason for hiding this comment

yec-akamai left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AniJ98 Oct 15, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AniJ98 Oct 15, 2024 •

edited

Loading