chore: Updated metal-go client for sub-commands hardware reservations #288
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
This has an extra commit in it and needs to be rebased. |
ctreatma
reviewed
Jul 3, 2023
ctreatma
reviewed
Jul 3, 2023
ctreatma
reviewed
Jul 3, 2023
codinja1188
force-pushed
the
hardware
branch
3 times, most recently
from
c24fc66
to
99b3d98
Compare
ctreatma
reviewed
Jul 24, 2023
displague
reviewed
Jul 25, 2023
|
This has a conflict and needs a rebase. |
displague
changed the title
codinja1188
force-pushed
the
hardware
branch
from
152fa80
to
f3f6923
Compare
displague
changed the title
displague
reviewed
Nov 14, 2023
| want: &cobra.Command{}, | ||
| cmdFunc: func(t *testing.T, c *cobra.Command) { | ||
| root := c.Root() | ||
| root.SetArgs([]string{subCommand, "get"}) |
There was a problem hiding this comment.
Looks like we need -i or -p and an ID here. Since we won't have any hardware reservations available to this E2E account, we should use a mocked client that will always return a stub reservation.
=== RUN TestCli_Hardware
=== RUN TestCli_Hardware/get
Error: either id or project-id should be set
Usage:
metal hardware-reservation get [-p <project_id>] | [-i <hardware_reservation_id>] [flags]
Aliases:
get, list
Examples:
# Retrieve all hardware reservations of a project:
metal hardware-reservations get -p $METAL_PROJECT_ID
# Retrieve the details of a specific hardware reservation:
metal hardware-reservations get -i 8404b73c-d18f-4190-8c49-20bb17501f88
Flags:
-h, --help help for get
-i, --id string The UUID of a hardware reservation.
-p, --project-id string A project's UUID.
Global Flags:
--config string Path to JSON or YAML configuration file
--exclude strings Comma separated Href references to collapse in results, may be dotted three levels deep
--filter stringArray Filter 'get' actions with name value pairs. Filter is not supported by all resources and is implemented as request query parameters.
--http-header strings Headers to add to requests (in format key=value)
--include strings Comma separated Href references to expand in results, may be dotted three levels deep
-o, --output string Output format (*table, json, yaml). env output formats are (*sh, terraform, capp).
--search string Search keyword for use in 'get' actions. Search is not supported by all resources.
--sort-by string Sort fields for use in 'get' actions. Sort is not supported by all resources.
--sort-dir string Sort field direction for use in 'get' actions. Sort is not supported by all resources.
--token string Metal API Token (METAL_AUTH_TOKEN)
hardware_test.go:45: either id or project-id should be set
hardware_test.go:56: expected output should include n3.xlarge.x86, m3.large.x86, s3.xlarge.x86, dc10.
--- FAIL: TestCli_Hardware (0.00s)
--- FAIL: TestCli_Hardware/get (0.00s)
FAIL
There was a problem hiding this comment.
The terraform provider has an example of setting up a mock API with httptest: https://github.com/equinix/terraform-provider-equinix/blob/main/equinix/resource_metal_device_acc_test.go#L1082-L1116
In this case, you would want to have your mock return a 200 with a JSON string that has the necessary fields. You could also consider the other mocking approaches documented here: https://medium.com/zus-health/mocking-outbound-http-requests-in-go-youre-probably-doing-it-wrong-60373a38d2aa
There was a problem hiding this comment.
updated mock client, and response
There was a problem hiding this comment.
The test mentioned earlier is still failing with the same error as before:
=== RUN TestCli_Hardware/get
Error: either id or project-id should be set
f3f6923
to
12ecbf2
Compare
displague
reviewed
Jan 11, 2024
internal/cli/root.go
Outdated
| @@ -108,6 +108,11 @@ func (c *Client) metalApiConnect(httpClient *http.Client) error { | |||
| configuration.Debug = checkEnvForDebug() | |||
| configuration.AddDefaultHeader("X-Auth-Token", c.Token()) | |||
| configuration.UserAgent = fmt.Sprintf("metal-cli/%s %s", c.Version, configuration.UserAgent) | |||
| configuration.Servers = metal.ServerConfigurations{ | |||
| metal.ServerConfiguration{ | |||
| URL: c.apiURL, | |||
There was a problem hiding this comment.
It appears that this value is empty because the E2E tests are failing with an invalid API URL (it does not contain https://api.equinix.com/metal/v1 so requests are being made directly to /path/...)
There was a problem hiding this comment.
fixed this in #432
|
ctreatma
reviewed
Jan 12, 2024
internal/hardware/retrieve.go
Outdated
| @@ -46,7 +27,8 @@ func (c *Client) Retrieve() *cobra.Command { | |||
|
|
|||
| header := []string{"ID", "Facility", "Metro", "Plan", "Created"} | |||
|
|
|||
| inc := []string{} | |||
| inc := c.Servicer.Includes(nil) | |||
There was a problem hiding this comment.
This should be moved to after the switch block a couple lines down so that we keep the user-specified includes in addition to the ones that are set automatically by the CLI.
ctreatma
reviewed
Jan 16, 2024
internal/hardware/retrieve.go
Outdated
|
|
||
| return c.Out.Output(r, header, &data) | ||
| } | ||
| request := c.Service.FindProjectHardwareReservations(context.Background(), projectID).Include(inc).Exclude(exc) |
There was a problem hiding this comment.
This request isn't wired up to the CLI flags for include and exclude
codinja1188
requested a deployment
to
external
GitHub Actions
Abandoned
codinja1188
requested a deployment
to
external
GitHub Actions
Abandoned
ctreatma
approved these changes
Jan 16, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Breakout from #270
What this PR does / why we need it:
This PR replaces packngo with metal-go for all interactions with the Equinix Metal API specifically for hardware sub commands
DISCUSSION POINTS:
Fixes #46