Support for Adding Additional Reserved IP to Existing Linodes #5

AniJ98 · 2024-09-10T22:04:48Z

📝 Description

This PR introduces functionality and tests for creating Linodes with reserved IP addresses and adding additional reserved IPs to existing Linodes in the Linodego client. These changes are necessary to provide comprehensive support for managing Linodes with reserved IP addresses through the Linode API. The changes include:

Implementation of core operations:

Creating a Linode with a reserved IP
Adding an additional reserved IP to an existing Linode

Test coverage:

TestInstance_CreateWithReservedIPAddress: Tests creating a Linode with a reserved IP.
TestInstance_CreateWithReservedIPAddressVariants: Tests various scenarios for creating a Linode with a reserved IP.
TestInstance_AddReservedIPToInstance: Tests adding a reserved IP to an existing Linode.
TestInstance_AddReservedIPToInstanceVariants: Covers different cases for adding a reserved IP to an existing Linode.

✔️ 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" 

Additionally you need to set the following if you want to test it in a different environment:
```
export LINODE_URL="https://api.linode.com"
export LINODE_API_VERSION="v4beta"
```
Navigate to the test directory within the linodego project. Update the LINODE_TOKEN in the Makefile: 

LINODE_TOKEN="your_token_here" 

Run the tests using one of the following commands: To run all integration tests:

make testint 

To run a specific test: 

go test -v ./integration -run TestInstance_CreateWithReservedIPAddressVariants

Verify the test output for any failures or unexpected behavior.

Note:
Ensure that you have enough quota to reserve IP before adding it to an existing linode. Ensure the IPMAX limit is enough to add additional reserved IP addresses to the linode.

lalsheni · 2024-09-11T19:35:05Z

test/integration/instances_test.go

+	}
+	defer instanceTeardown()
+
+	fmt.Println(instance.IPv4)


You'll want to verify that the linode instnace IP matches the reserved IP adddress.

test/integration/instances_test.go

instances.go

test/integration/instances_test.go

lalenche · 2024-09-12T15:07:32Z

test/integration/instances_test.go

+		t.Logf("Correctly received error when using non-reserved address: %v", err)
+	}
+
+	// Test: Non-owned reserved address


Consider doing the tests in a way that ensures the IP passed in is 'on-owned', probably with multiple accounts.

Will push this change once I get a reserved IP address that doesnt belong to the same account.

test/integration/fixtures/TestInstance_AddReservedIPToInstance.yaml

lalenche · 2024-09-13T14:49:28Z

test/integration/instances_test.go

+	defer instanceTeardown()
+
+	// Now try to create another instance with the same IP
+	_, _, err = createInstanceWithReservedIP(t, client, reservedIP.Address)


No tear-down for this creation

Added teardown function to handle accidental instance creation

lalenche · 2024-09-13T14:50:25Z

test/integration/instances_test.go

+
+	_, _, err := createInstanceWithReservedIP(t, client, "198.51.100.1")
+	if err == nil {
+		t.Errorf("Expected error with non-owned reserved address, but got none")


No tear-down for this creation

Added teardown function to handle accidental instance creation

Same as above move it right after createInstanceWithReservedIP and before the error checks. Also, use defer

lalenche · 2024-09-13T14:50:34Z

test/integration/instances_test.go

+
+	_, _, err := createInstanceWithReservedIP(t, client, "")
+	if err == nil {
+		t.Errorf("Expected error with empty IP address, but got none")


No tear-down for this creation

Added teardown function to handle accidental instance creation

Same as above move it right after createInstanceWithReservedIP and before the error checks. Also, use defer

…th associated tests

… the corresponding tests and fixtures

…tance to instance_ips.go

…ual test funcitons and removed debugging log statements

…st functions, made changes to error messages

lalsheni · 2024-09-17T18:45:09Z

test/integration/instances_test.go

+	if err != nil {
+		t.Fatalf("Error creating instance with reserved IP: %s", err)
+	}
+	defer instanceTeardown()


This should be before the error check, so that the tear down still happens even when the t.Fatal is executed.

Added defer statement immediately after the creation statement.

lalsheni · 2024-09-17T18:47:38Z

test/integration/instances_test.go

+	if err != nil {
+		t.Errorf("Unexpected error with owned non-assigned reserved IP: %v", err)
+	} else {
+		instanceTeardown()


Same comment as above, you should run/defer the teardown before you do any of the checks since it's good practice. (createInstanceWithReservedIP returns an empty function for instanceTeardown if it encounters an error so it should be safe to call defer on it)

Added defer statement immediately after the creation statement.

lalsheni · 2024-09-17T18:48:26Z

test/integration/instances_test.go

+	if err != nil {
+		t.Fatalf("Failed to create initial instance: %v", err)
+	}
+	defer instanceTeardown()


Same as above move it right after createInstanceWithReservedIP and before the error checks.

Added defer statement immediately after the creation statement.

lalsheni · 2024-09-17T18:49:16Z

test/integration/instances_test.go

+	_, secondInstanceTeardown, err := createInstanceWithReservedIP(t, client, reservedIP.Address)
+	if err == nil {
+		t.Errorf("Expected error with already assigned reserved IP, but got none")
+		secondInstanceTeardown()


Same as above move it right after createInstanceWithReservedIP and before the error checks. Also, use defer

Added defer statement immediately after the creation statement.

lalsheni · 2024-09-17T18:49:41Z

test/integration/instances_test.go

+
+	_, _, err := createInstanceWithReservedIP(t, client, "198.51.100.1")
+	if err == nil {
+		t.Errorf("Expected error with non-owned reserved address, but got none")


Same as above move it right after createInstanceWithReservedIP and before the error checks. Also, use defer

lalsheni · 2024-09-17T18:49:50Z

test/integration/instances_test.go

+
+	_, _, err := createInstanceWithReservedIP(t, client, "")
+	if err == nil {
+		t.Errorf("Expected error with empty IP address, but got none")


Same as above move it right after createInstanceWithReservedIP and before the error checks. Also, use defer

lalsheni · 2024-09-17T18:49:56Z

test/integration/instances_test.go

+	if err != nil {
+		t.Errorf("Unexpected error with null IP address: %v", err)
+	} else {
+		instanceTeardown()


Same as above move it right after createInstanceWithReservedIP and before the error checks. Also, use defer

Added defer statement immediately after the creation statement.

lalsheni · 2024-09-17T18:50:12Z

test/integration/instances_test.go

+	})
+	if err == nil {
+		t.Errorf("Expected error with multiple IP addresses, but got none")
+		instanceTeardown()


Same as above move it right after createInstanceWithReservedIP and before the error checks. Also, use defer

Added defer statement immediately after the creation statement.

lalsheni · 2024-09-17T18:50:19Z

test/integration/instances_test.go

+	if err != nil {
+		t.Errorf("Unexpected error when omitting IPv4 field: %v", err)
+	} else {
+		instanceTeardown()


Same as above move it right after createInstanceWithReservedIP and before the error checks. Also, use defer

Added defer statement immediately after the creation statement.

lalsheni · 2024-09-17T18:52:08Z

test/integration/instances_test.go

Maybe move these tests to a new file? instances_reserved_ips_test.go?

Moved all the related tests to a new file

…additonal reserved IPs to a linode to a separate file

lalsheni · 2024-09-17T20:05:32Z

test/Makefile

@@ -2,7 +2,7 @@

 testint:
 	@LINODE_FIXTURE_MODE="play" \
-	LINODE_TOKEN="awesometokenawesometokenawesometoken" \
+	LINODE_TOKEN="9f08d4534157252421c964c7b9bf53dd545a242c1f7ef4fe1ada1701366acf7f" \


Accidental change?

Yeah need to remove it

This token is no longer valid. It has been revoked.

lalsheni reviewed Sep 11, 2024

View reviewed changes

lalenche reviewed Sep 12, 2024

View reviewed changes

test/integration/instances_test.go Outdated Show resolved Hide resolved

lalenche suggested changes Sep 12, 2024

View reviewed changes

lalenche suggested changes Sep 13, 2024

View reviewed changes

lalenche approved these changes Sep 13, 2024

View reviewed changes

AniJ98 force-pushed the main branch from 0d8f5be to 8627e4f Compare September 16, 2024 20:33

AniJ98 added 8 commits September 17, 2024 14:39

added support for creating a linode with reserved IP address along wi…

138c163

…th associated tests

Added support for adding additional reserved IP to linodes along with…

4b44bd8

… the corresponding tests and fixtures

added ipv4 field in the InstanceCreateOptions struct

35610a0

moved InstanceReservedIPOptions and the method to AddReservedIPToInsa…

809b407

…tance to instance_ips.go

Split the variants tests of createInstanceWithReservedIP into individ…

b559ee8

…ual test funcitons and removed debugging log statements

Re-recorded fixtures after splitting variants test into individual te…

402c77a

…st functions, made changes to error messages

added teardown funcitnality to handle accidental instance creations

30eeda7

removed unnecessary defer keyword from test functions

8909bd6

AniJ98 force-pushed the ipreservation-existingendpoints-clean branch from 57d6ddf to 8909bd6 Compare September 17, 2024 18:41

lalsheni suggested changes Sep 17, 2024

View reviewed changes

moved tests related to creating a linode with reserved IP and adding …

9b15909

…additonal reserved IPs to a linode to a separate file

lalsheni reviewed Sep 17, 2024

View reviewed changes

Removing the sensitive token from the previous commit

97ccd6b

lalsheni approved these changes Sep 17, 2024

View reviewed changes

AniJ98 merged commit be7b869 into main Sep 17, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support for Adding Additional Reserved IP to Existing Linodes #5

Support for Adding Additional Reserved IP to Existing Linodes #5

AniJ98 commented Sep 10, 2024

lalsheni Sep 11, 2024

lalenche Sep 12, 2024

AniJ98 Sep 12, 2024

lalenche Sep 13, 2024

AniJ98 Sep 13, 2024

lalenche Sep 13, 2024

AniJ98 Sep 13, 2024

lalsheni Sep 17, 2024

lalenche Sep 13, 2024

AniJ98 Sep 13, 2024

lalsheni Sep 17, 2024

lalsheni Sep 17, 2024

AniJ98 Sep 17, 2024

lalsheni Sep 17, 2024

AniJ98 Sep 17, 2024

lalsheni Sep 17, 2024

AniJ98 Sep 17, 2024

lalsheni Sep 17, 2024

AniJ98 Sep 17, 2024

lalsheni Sep 17, 2024

lalsheni Sep 17, 2024

lalsheni Sep 17, 2024

AniJ98 Sep 17, 2024

lalsheni Sep 17, 2024

AniJ98 Sep 17, 2024

lalsheni Sep 17, 2024

AniJ98 Sep 17, 2024

lalsheni Sep 17, 2024

AniJ98 Sep 17, 2024

lalsheni Sep 17, 2024

AniJ98 Sep 17, 2024

AniJ98 Sep 17, 2024

Support for Adding Additional Reserved IP to Existing Linodes #5

Support for Adding Additional Reserved IP to Existing Linodes #5

Conversation

AniJ98 commented Sep 10, 2024

📝 Description

✔️ How to Test

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

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