Support For Managing Reserved IP Addresses #579

AniJ98 · 2024-09-09T19:31:00Z

📝 Description

This PR introduces comprehensive functionality and tests for Reserved IP Addresses in the Linodego client. The changes are necessary to provide robust support for managing Reserved IP addresses through the Linode API. 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:

TestReservedIPAddresses_InsufficientPermissions: Verifies behavior when the user lacks necessary permissions.
TestReservedIPAddresses_EndToEndTest: Performs a complete workflow test for users with proper permissions.
TestReservedIPAddresses_ListIPAddressesVariants: Tests various scenarios for listing IP addresses.
TestReservedIPAddresses_GetIPAddressVariants: Covers different cases for retrieving a specific IP address.
TestReservedIPAddresses_ReserveIPVariants: Tests multiple scenarios for reserving an IP, including edge cases.
TestReservedIPAddresses_DeleteIPAddressVariants: Verifies deletion functionality under various conditions.

✔️ How to Test

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

To verify the changes related to Reserved IP functionality, follow these steps:

Ensure you have a valid Linode API token with the "can_reserve_ip" permission enabled. 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 only Reserved IP related tests: 

go test -v ./integration -run TestReservedIPAddresses 

To run a specific test:

go test -v ./integration -run TestReservedIPAddresses_EndToEndTest

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.

yec-akamai

LGTM. Great test coverage! Just one small comment:

yec-akamai · 2024-09-16T14:45:39Z

test/integration/network_reserved_ips_test.go

+	// Verify that we can't reserve more IPs
+	_, exceedErr := client.ReserveIPAddress(context.Background(), ReserveIPOptions{Region: "us-east"})
+	if exceedErr == nil {
+		t.Errorf("Expected error when exceeding reservation limit, got nil")
+	}


The reservation limit seems can be expanded. I think we might want to remove this verification to avoid unexpected failure.

Removed this check and re-recorded the fixture for this test.

I think it is still a good test coverage to have. I pushed a commit separating into a new test case.

The new test case works well, thank you @ykim-1!

yec-akamai

Tested and works well on my end, thank you for the contribution!

ykim-akamai

LGTM, test pass locally and thank you for the contribution!

…dresses

…d, InsuffecientPermission, ReserveIP, GetReservedIP, getReservedIPs, DeleteReservedIPs

…ns to reserve IP

…mission tests

…y appropriate error message along with code

…ord user with adequate permissions

…ther functions

…d fatalf wherever necessary

…es with latest error messages

… feature. Removed for loop to reserve IPs till limit is reached.

…d fixtures to reflect new error messages

* build(deps): bump golang.org/x/oauth2 from 0.22.0 to 0.23.0 Bumps [golang.org/x/oauth2](https://github.com/golang/oauth2) from 0.22.0 to 0.23.0. - [Commits](golang/oauth2@v0.22.0...v0.23.0) --- updated-dependencies: - dependency-name: golang.org/x/oauth2 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * Ran make tidy --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: ezilber-akamai <ezilber@akamai.com>

* build(deps): bump golang.org/x/text from 0.17.0 to 0.18.0 Bumps [golang.org/x/text](https://github.com/golang/text) from 0.17.0 to 0.18.0. - [Release notes](https://github.com/golang/text/releases) - [Commits](golang/text@v0.17.0...v0.18.0) --- updated-dependencies: - dependency-name: golang.org/x/text dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * make tidy --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Ye Chen <yechen@akamai.com>

…ing endpoints (linode#573) * Add LKE types endpoints * Support base struct; add NB types endpoints * Add volume types * Add network transfer prices * Add price and region price structs * Revert IPv6 fixtures * Add missing fixtures

ezilber-akamai

Nice work! Tests are passing on my end. Thanks for the contribution!

AniJ98 requested a review from a team as a code owner September 9, 2024 19:31

AniJ98 requested review from yec-akamai and ezilber-akamai and removed request for a team September 9, 2024 19:31

yec-akamai reviewed Sep 16, 2024

View reviewed changes

yec-akamai approved these changes Sep 16, 2024

View reviewed changes

ykim-akamai self-requested a review September 16, 2024 17:57

ykim-akamai approved these changes Sep 16, 2024

View reviewed changes

AniJ98 and others added 22 commits September 16, 2024 16:04

added reserved field to InstanceIP struct for IP Reservation response

1b87e78

Reserved IP resource for handling IP reservation API's

311ecfc

Added integration test covering multiple scenarios of reserving IP ad…

7fb337e

…dresses

The fixture files for different scenarios of IP Reservation - EndToEn…

1c6a8ab

…d, InsuffecientPermission, ReserveIP, GetReservedIP, getReservedIPs, DeleteReservedIPs

Updated the fixture files with responses after the user has permissio…

fd426cc

…ns to reserve IP

Changed the error message to relay invalid token for insufficient per…

bed7ce0

…mission tests

Updated the error message for Insufficient Permission tests to displa…

4cc42a6

…y appropriate error message along with code

Made changes to Delete, List, Get, Reserve, EndtoEnd fixtures to rec…

11fd3cb

…ord user with adequate permissions

changed variable name from id to address to keep it consistent with o…

4d24fd1

…ther functions

Made changes to variable names, achanged logf statements to errorf an…

a265fd4

…d fatalf wherever necessary

changed fixture file names to improve consistency, re-recorded fixtur…

49d14a6

…es with latest error messages

removed debugging fmt statement

bd106fa

Made changes to reserve IP addresses before listing them using fitler…

cd7fa48

… feature. Removed for loop to reserve IPs till limit is reached.

uncommenting unaffected tests

d52a33f

Made changes to error messages, added mandatory checks and re-recorde…

cb81bc2

…d fixtures to reflect new error messages

Added new middleware system (linode#571)

456d0f2

Add test case for ip limit exceed

3bb8dc0

add cleanup for TestReservedIPAddresses_ExceedLimit

ce34304

added interactions to fixture and changed the ecpected error message

8627e4f

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

ezilber-akamai approved these changes Sep 16, 2024

View reviewed changes

Added note indicating feature is currently not available to all users

663e798

yec-akamai approved these changes Sep 17, 2024

View reviewed changes

Merge branch 'main' into main

5bb2bc1

yec-akamai merged commit 108afdf into linode:main Sep 17, 2024
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support For Managing Reserved IP Addresses #579

Support For Managing Reserved IP Addresses #579

AniJ98 commented Sep 9, 2024

yec-akamai left a comment

yec-akamai Sep 16, 2024

AniJ98 Sep 16, 2024

ykim-akamai Sep 16, 2024 •

edited

Loading

yec-akamai Sep 16, 2024

yec-akamai left a comment

ykim-akamai left a comment

ezilber-akamai left a comment •

edited

Loading

Support For Managing Reserved IP Addresses #579

Support For Managing Reserved IP Addresses #579

Conversation

AniJ98 commented Sep 9, 2024

📝 Description

✔️ How to Test

yec-akamai left a comment

Choose a reason for hiding this comment

yec-akamai Sep 16, 2024

Choose a reason for hiding this comment

AniJ98 Sep 16, 2024

Choose a reason for hiding this comment

ykim-akamai Sep 16, 2024 • edited Loading

Choose a reason for hiding this comment

yec-akamai Sep 16, 2024

Choose a reason for hiding this comment

yec-akamai left a comment

Choose a reason for hiding this comment

ykim-akamai left a comment

Choose a reason for hiding this comment

ezilber-akamai left a comment • edited Loading

Choose a reason for hiding this comment

ykim-akamai Sep 16, 2024 •

edited

Loading

ezilber-akamai left a comment •

edited

Loading