chore: Migrate gateways command from packngo to metal-go client #376

aayushrangwala · 2023-11-01T16:18:54Z

Issue Task as part of migrating metal-cli from packngo to metal-go client, added the support of gateways subcommand to use metal-go
Fixes: #333

Add tests for gateway subcommand Signed-off-by: Ayush Rangwala <ayush.rangwala@gmail.com>

Signed-off-by: Ayush Rangwala <ayush.rangwala@gmail.com>

displague · 2023-11-09T20:10:51Z

=== RUN   TestGateways_Retrieve
Error when calling `DevicesApi.FindDeviceById`: 403 Forbidden
    helper.go:323: 403 Forbidden
    helper.go:326: Timeout while waiting for device: 501ed6e8-b24c-4bb8-b5db-bf187152c77a to be active
Error when calling `DevicesApi.FindDeviceById`: 403 Forbidden
    helper.go:331: 403 Forbidden
=== RUN   TestGateways_Retrieve/retrieve_gateways_by_projectId
--- FAIL: TestGateways_Retrieve (220.20s)
    --- FAIL: TestGateways_Retrieve/retrieve_gateways_by_projectId (0.22s)
panic: runtime error: invalid memory address or nil pointer dereference [recovered]
	panic: runtime error: invalid memory address or nil pointer dereference
[signal SIGSEGV: segmentation violation code=0x1 addr=0xa0 pc=0xb7587b]

goroutine 45 [running]:
testing.tRunner.func1.2({0xc34f00, 0x12d9410})
	/opt/hostedtoolcache/go/1.19.13/x64/src/testing/testing.go:13[96](https://github.com/equinix/metal-cli/actions/runs/6786304964/job/18533442407?pr=376#step:5:97) +0x24e
testing.tRunner.func1()
	/opt/hostedtoolcache/go/1.19.13/x64/src/testing/testing.go:13[99](https://github.com/equinix/metal-cli/actions/runs/6786304964/job/18533442407?pr=376#step:5:100) +0x39f
panic({0xc34f00, 0x12d9410})
	/opt/hostedtoolcache/go/1.19.13/x64/src/runtime/panic.go:884 +0x212
github.com/equinix/metal-cli/test/e2e/gateways.TestGateways_Retrieve.func4(0xc000453380, 0xc000206f50?)
	/home/runner/work/metal-cli/metal-cli/test/e2e/gateways/retrieve_test.go:83 +0x2bb
github.com/equinix/metal-cli/test/e2e/gateways.TestGateways_Retrieve.func5(0x1?)
	/home/runner/work/metal-cli/metal-cli/test/e2e/gateways/retrieve_test.go:92 +0x74
testing.tRunner(0xc000453380, 0xc0002bfae8)
	/opt/hostedtoolcache/go/1.19.13/x64/src/testing/testing.go:1446 +0x10b
created by testing.(*T).Run
	/opt/hostedtoolcache/go/1.19.13/x64/src/testing/testing.go:1493 +0x35f
FAIL	github.com/equinix/metal-cli/test/e2e/gateways	587.683s

displague · 2023-11-13T13:05:33Z

=== RUN   TestPorts_VLANs
Error when calling `DevicesApi.FindDeviceById`: 403 Forbidden You are not authorized to view this device
    helper.go:323: 403 Forbidden You are not authorized to view this device
    helper.go:326: Timeout while waiting for device: 6a494e07-2687-4ff2-88e7-892e9d7583b2 to be active
Error when calling `DevicesApi.FindDeviceById`: 403 Forbidden You are not authorized to view this device
    helper.go:331: 403 Forbidden You are not authorized to view this device
--- FAIL: TestPorts_VLANs (107.45s)
panic: runtime error: index out of range [2] with length 0 [recovered]
	panic: runtime error: index out of range [2] with length 0

goroutine 33 [running]:
testing.tRunner.func1.2({0xcac120, 0xc000362420})
	/opt/hostedtoolcache/go/1.19.13/x64/src/testing/testing.go:1396 +0x24e
testing.tRunner.func1()
	/opt/hostedtoolcache/go/1.19.13/x64/src/testing/testing.go:1399 +0x39f
panic({0xcac120, 0xc000362420})
	/opt/hostedtoolcache/go/1.19.13/x64/src/runtime/panic.go:884 +0x212
github.com/equinix/metal-cli/test/e2e/ports.TestPorts_VLANs(0xc0002c16c0)
	/home/runner/work/metal-cli/metal-cli/test/e2e/ports/vlans_test.go:28 +0x4dc
testing.tRunner(0xc0002c16c0, 0xd6d890)
	/opt/hostedtoolcache/go/1.19.13/x64/src/testing/testing.go:1446 +0x10b
created by testing.(*T).Run
	/opt/hostedtoolcache/go/1.19.13/x64/src/testing/testing.go:1493 +0x35f
FAIL	github.com/equinix/metal-cli/test/e2e/ports	535.031s

displague · 2023-11-13T13:16:19Z

I think SetupDeviceAndProject may need to t.Fatalf instead of t.Errorf when a device and project can't be created or loaded. We are finding cases where the tests failed early on during setup and we are only detecting that when device properties are being accessed (device.Metro.GetCode()).

displague · 2023-11-13T13:18:13Z

We should also be calling t.Helper() in

metal-cli/test/helper/helper.go

Line 308 in 4b87ce6

    
           func SetupProjectAndDevice(t *testing.T, projectId, deviceId *string) *openapiclient.Device {

aayushrangwala · 2023-11-15T10:29:59Z

I think SetupDeviceAndProject may need to t.Fatalf instead of t.Errorf when a device and project can't be created or loaded. We are finding cases where the tests failed early on during setup and we are only detecting that when device properties are being accessed (device.Metro.GetCode()).

it was kept with t.Errorf(err) because I wanted to make the defer funcs run at every test function return. For t.Fatal() cleanups wont happen via defer and dangling resources will remain.
But fixed the calls to return an error from setup func when there is an error

Signed-off-by: Ayush Rangwala <ayush.rangwala@gmail.com>

aayushrangwala · 2023-11-15T13:00:49Z

@displague @ctreatma Please trigger E2E tests

test/helper/helper.go

aayushrangwala · 2023-11-16T14:55:16Z

test/e2e/gateways/create_test.go

+	rootClient := root.NewClient(consumerToken, apiURL, Version)
+
+	device, err := helper.SetupProjectAndDevice(t, &projectId, &deviceId)
+	defer func() {


use t.Cleanup() refer here

aayushrangwala · 2023-11-16T14:59:28Z

test/helper/helper.go

@@ -72,6 +72,27 @@ func CreateTestVLAN(projectId string) (*openapiclient.VirtualNetwork, error) {
 	return vlan, nil
 }

+func CreateTestGateway(projectId, vlanId string, privateIPv4SubnetSize *int32) (*openapiclient.MetalGateway, error) {
+	TestApiClient := TestClient()


All the Helpers in this file needs to call t.Helper

Handle that under a separate Issue and PR

Signed-off-by: Ayush Rangwala <ayush.rangwala@gmail.com>

aayushrangwala · 2023-11-21T15:27:48Z

Ran the tests locally for gateway and its running fine

❯ go test ./test/e2e/gateways
ok  	github.com/equinix/metal-cli/test/e2e/gateways	377.900s

Signed-off-by: Ayush Rangwala <ayush.rangwala@gmail.com>

docs/metal_gateway_create.md

aayushrangwala · 2023-11-22T17:02:34Z

@ctreatma E2E tests failed but with a device test related error

=== RUN   TestCli_Devices_Update/reinstall_device
Error when calling `DevicesApi.FindDeviceById`: 403 Forbidden You are not authorized to view this device
Error when calling `DevicesApi.FindDeviceById`: 403 Forbidden You are not authorized to view this device
    device_reinstall_test.go:53: 403 Forbidden You are not authorized to view this device
--- FAIL: TestCli_Devices_Update (88.43s)
    --- FAIL: TestCli_Devices_Update/reinstall_device (88.43s)

All the ports, gateway tests are passing
Is it good to merge the PR

ctreatma · 2023-11-22T17:39:18Z

I re-ran the tests a few times to try to get a passing run again, but couldn't. That's a bit concerning, but outside the scope of this PR, so this is fine to merge.

feat: Migrate metal cli from packngo to metal-go for gateways subcommand

10efbb5

Add tests for gateway subcommand Signed-off-by: Ayush Rangwala <ayush.rangwala@gmail.com>

aayushrangwala had a problem deploying to external November 1, 2023 16:19 — with GitHub Actions Error

Update docs

4686ba2

Signed-off-by: Ayush Rangwala <ayush.rangwala@gmail.com>

aayushrangwala temporarily deployed to external November 1, 2023 16:26 — with GitHub Actions Inactive

Merge branch 'main' into gateways

246f280

aayushrangwala temporarily deployed to external November 7, 2023 15:00 — with GitHub Actions Inactive

aayushrangwala changed the title ~~fix: Migrate gateways command from packngo to metal-go client~~ chore: Migrate gateways command from packngo to metal-go client Nov 7, 2023

Merge branch 'main' into gateways

4b87ce6

aayushrangwala temporarily deployed to external November 10, 2023 07:25 — with GitHub Actions Inactive

fixed helper setup function return signature

c8b87d4

Signed-off-by: Ayush Rangwala <ayush.rangwala@gmail.com>

aayushrangwala temporarily deployed to external November 15, 2023 11:17 — with GitHub Actions Inactive

aayushrangwala commented Nov 16, 2023

View reviewed changes

test/helper/helper.go Show resolved Hide resolved

aayushrangwala commented Nov 16, 2023

View reviewed changes

aayushrangwala added 2 commits November 16, 2023 22:47

fix: output for convert layer2 to layer 3 command

d7b015f

Signed-off-by: Ayush Rangwala <ayush.rangwala@gmail.com>

fix: Test case

f5b1b0a

Signed-off-by: Ayush Rangwala <ayush.rangwala@gmail.com>

aayushrangwala temporarily deployed to external November 17, 2023 17:27 — with GitHub Actions Inactive

Merge branch 'main' into gateways

90fc801

aayushrangwala had a problem deploying to external November 20, 2023 15:14 — with GitHub Actions Error

aayushrangwala temporarily deployed to external November 20, 2023 15:17 — with GitHub Actions Inactive

aayushrangwala requested a deployment to external November 20, 2023 17:40 — with GitHub Actions Abandoned

aayushrangwala mentioned this pull request Nov 21, 2023

fix: Updated metal-go client for sub-commands gateways #289

Closed

fix: lint issues

937c467

Signed-off-by: Ayush Rangwala <ayush.rangwala@gmail.com>

aayushrangwala force-pushed the gateways branch from 29dc3d0 to 937c467 Compare November 21, 2023 15:29

aayushrangwala temporarily deployed to external November 21, 2023 15:29 — with GitHub Actions Inactive

ctreatma reviewed Nov 21, 2023

View reviewed changes

docs/metal_gateway_create.md Show resolved Hide resolved

aayushrangwala had a problem deploying to external November 21, 2023 17:24 — with GitHub Actions Error

aayushrangwala force-pushed the gateways branch from 970c25d to ab368df Compare November 21, 2023 18:44

aayushrangwala had a problem deploying to external November 21, 2023 18:44 — with GitHub Actions Error

aayushrangwala force-pushed the gateways branch from ab368df to 3b01e6a Compare November 22, 2023 15:13

aayushrangwala temporarily deployed to external November 22, 2023 15:13 — with GitHub Actions Inactive

aayushrangwala force-pushed the gateways branch from 3b01e6a to 937c467 Compare November 22, 2023 15:15

aayushrangwala temporarily deployed to external November 22, 2023 15:15 — with GitHub Actions Inactive

aayushrangwala requested a deployment to external November 22, 2023 15:56 — with GitHub Actions Abandoned

aayushrangwala requested a deployment to external November 22, 2023 16:27 — with GitHub Actions Abandoned

aayushrangwala requested a deployment to external November 22, 2023 17:01 — with GitHub Actions Abandoned

ctreatma approved these changes Nov 22, 2023

View reviewed changes

ctreatma merged commit 1994e1e into equinix:main Nov 22, 2023
14 of 15 checks passed

aayushrangwala mentioned this pull request Nov 24, 2023

E2E tests (run in CI) are not cleaning up server and project artifacts #343

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Migrate gateways command from packngo to metal-go client #376

chore: Migrate gateways command from packngo to metal-go client #376

aayushrangwala commented Nov 1, 2023

displague commented Nov 9, 2023

displague commented Nov 13, 2023

displague commented Nov 13, 2023

displague commented Nov 13, 2023 •

edited

Loading

aayushrangwala commented Nov 15, 2023

aayushrangwala commented Nov 15, 2023

aayushrangwala Nov 16, 2023 •

edited

Loading

aayushrangwala Nov 16, 2023

aayushrangwala Nov 16, 2023

aayushrangwala commented Nov 21, 2023 •

edited

Loading

aayushrangwala commented Nov 22, 2023

ctreatma commented Nov 22, 2023

chore: Migrate gateways command from packngo to metal-go client #376

chore: Migrate gateways command from packngo to metal-go client #376

Conversation

aayushrangwala commented Nov 1, 2023

displague commented Nov 9, 2023

displague commented Nov 13, 2023

displague commented Nov 13, 2023

displague commented Nov 13, 2023 • edited Loading

aayushrangwala commented Nov 15, 2023

aayushrangwala commented Nov 15, 2023

aayushrangwala Nov 16, 2023 • edited Loading

Choose a reason for hiding this comment

aayushrangwala Nov 16, 2023

Choose a reason for hiding this comment

aayushrangwala Nov 16, 2023

Choose a reason for hiding this comment

aayushrangwala commented Nov 21, 2023 • edited Loading

aayushrangwala commented Nov 22, 2023

ctreatma commented Nov 22, 2023

displague commented Nov 13, 2023 •

edited

Loading

aayushrangwala Nov 16, 2023 •

edited

Loading

aayushrangwala commented Nov 21, 2023 •

edited

Loading