Skip to content

Commit

Permalink
feat: move device resource and datasource to separate package
Browse files Browse the repository at this point in the history
  • Loading branch information
ctreatma committed Jul 16, 2024
1 parent 76b4845 commit 4f403c8
Show file tree
Hide file tree
Showing 13 changed files with 357 additions and 317 deletions.
120 changes: 120 additions & 0 deletions equinix/common_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
package equinix

import (
"fmt"
"strings"
"time"
)

// list of plans and metros and os used as filter criteria to find available hardware to run tests
var (
preferable_plans = []string{"x1.small.x86", "t1.small.x86", "c2.medium.x86", "c3.small.x86", "c3.medium.x86", "m3.small.x86"}
preferable_metros = []string{"ch", "ny", "sv", "ty", "am"}
preferable_os = []string{"ubuntu_20_04"}
)

// Deprecated: use the identical TestDeviceTerminationTime from internal/acceptance instead
func testDeviceTerminationTime() string {
return time.Now().UTC().Add(60 * time.Minute).Format(time.RFC3339)
}

// This function should be used to find available plans in all test where a metal_device resource is needed.
//
// TODO consider adding a datasource for equinix_metal_operating_system and making the local.os conditional
//
// https://github.com/equinix/terraform-provider-equinix/pull/220#discussion_r915418418equinix_metal_operating_system
// https://github.com/equinix/terraform-provider-equinix/discussions/221
func confAccMetalDevice_base(plans, metros, os []string) string {
return fmt.Sprintf(`
data "equinix_metal_plans" "test" {
sort {
attribute = "id"
direction = "asc"
}
filter {
attribute = "name"
values = [%s]
}
filter {
attribute = "available_in_metros"
values = [%s]
}
filter {
attribute = "deployment_types"
values = ["on_demand", "spot_market"]
}
}
// Select a metal plan randomly and lock it in
// so that we don't pick a different one for
// every subsequent terraform plan
resource "random_integer" "plan_idx" {
min = 0
max = length(data.equinix_metal_plans.test.plans) - 1
}
resource "terraform_data" "plan" {
input = data.equinix_metal_plans.test.plans[random_integer.plan_idx.result]
lifecycle {
ignore_changes = ["input"]
}
}
resource "terraform_data" "facilities" {
input = sort(tolist(setsubtract(terraform_data.plan.output.available_in, ["nrt1", "dfw2", "ewr1", "ams1", "sjc1", "ld7", "sy4", "ny6"])))
lifecycle {
ignore_changes = ["input"]
}
}
// Select a metal facility randomly and lock it in
// so that we don't pick a different one for
// every subsequent terraform plan
resource "random_integer" "facility_idx" {
min = 0
max = length(local.facilities) - 1
}
resource "terraform_data" "facility" {
input = local.facilities[random_integer.facility_idx.result]
lifecycle {
ignore_changes = ["input"]
}
}
// Select a metal metro randomly and lock it in
// so that we don't pick a different one for
// every subsequent terraform plan
resource "random_integer" "metro_idx" {
min = 0
max = length(local.metros) - 1
}
resource "terraform_data" "metro" {
input = local.metros[random_integer.metro_idx.result]
lifecycle {
ignore_changes = ["input"]
}
}
locals {
// Select a random plan
plan = terraform_data.plan.output.slug
// Select a random facility from the facilities in which the selected plan is available, excluding decommed facilities
facilities = terraform_data.facilities.output
facility = terraform_data.facility.output
// Select a random metro from the metros in which the selected plan is available
metros = sort(tolist(terraform_data.plan.output.available_in_metros))
metro = terraform_data.metro.output
os = [%s][0]
}
`, fmt.Sprintf("\"%s\"", strings.Join(plans[:], `","`)), fmt.Sprintf("\"%s\"", strings.Join(metros[:], `","`)), fmt.Sprintf("\"%s\"", strings.Join(os[:], `","`)))
}
28 changes: 23 additions & 5 deletions equinix/data_source_metal_device_bgp_neighbors_acc_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ import (
)

func TestAccDataSourceMetalDeviceBgpNeighbors(t *testing.T) {
projectName := fmt.Sprintf("ds-device-%s", acctest.RandString(10))
projSuffix := fmt.Sprintf("ds-device-%s", acctest.RandString(10))

resource.ParallelTest(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
ExternalProviders: testExternalProviders,
ProtoV5ProviderFactories: testAccProtoV5ProviderFactories,
Steps: []resource.TestStep{
{
Config: testAccDataSourceMetalDeviceBgpNeighborsConfig(projectName),
Config: testAccDataSourceMetalDeviceBgpNeighborsConfig(projSuffix),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttrSet(
"data.equinix_metal_device_bgp_neighbors.test", "bgp_neighbors.#"),
Expand All @@ -27,16 +27,34 @@ func TestAccDataSourceMetalDeviceBgpNeighbors(t *testing.T) {
})
}

func testAccDataSourceMetalDeviceBgpNeighborsConfig(projectName string) string {
func testAccDataSourceMetalDeviceBgpNeighborsConfig(projSuffix string) string {
return fmt.Sprintf(`
%s
resource "equinix_metal_project" "test" {
name = "tfacc-project-%s"
}
resource "equinix_metal_device" "test" {
hostname = "tfacc-test-device"
plan = local.plan
metro = local.metro
operating_system = local.os
billing_cycle = "hourly"
project_id = "${equinix_metal_project.test.id}"
termination_time = "%s"
}
data "equinix_metal_device" "test" {
project_id = equinix_metal_project.test.id
hostname = equinix_metal_device.test.hostname
}
data "equinix_metal_device_bgp_neighbors" "test" {
device_id = equinix_metal_device.test.id
}
output "bgp_neighbors_listing" {
value = data.equinix_metal_device_bgp_neighbors.test.bgp_neighbors
}
`, testDataSourceMetalDeviceConfig_basic(projectName))
}`, confAccMetalDevice_base(preferable_plans, preferable_metros, preferable_os), projSuffix, testDeviceTerminationTime())
}
7 changes: 4 additions & 3 deletions equinix/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import (
"github.com/equinix/terraform-provider-equinix/internal/config"
fabric_connection "github.com/equinix/terraform-provider-equinix/internal/resources/fabric/connection"
fabric_network "github.com/equinix/terraform-provider-equinix/internal/resources/fabric/network"
metal_device "github.com/equinix/terraform-provider-equinix/internal/resources/metal/device"
metal_port "github.com/equinix/terraform-provider-equinix/internal/resources/metal/port"
"github.com/equinix/terraform-provider-equinix/internal/resources/metal/virtual_circuit"
"github.com/equinix/terraform-provider-equinix/internal/resources/metal/vrf"
Expand Down Expand Up @@ -102,8 +103,8 @@ func Provider() *schema.Provider {
"equinix_metal_precreated_ip_block": dataSourceMetalPreCreatedIPBlock(),
"equinix_metal_operating_system": dataSourceOperatingSystem(),
"equinix_metal_spot_market_price": dataSourceSpotMarketPrice(),
"equinix_metal_device": dataSourceMetalDevice(),
"equinix_metal_devices": dataSourceMetalDevices(),
"equinix_metal_device": metal_device.DataSource(),
"equinix_metal_devices": metal_device.ListDataSource(),
"equinix_metal_device_bgp_neighbors": dataSourceMetalDeviceBGPNeighbors(),
"equinix_metal_plans": dataSourceMetalPlans(),
"equinix_metal_port": metal_port.DataSource(),
Expand All @@ -127,7 +128,7 @@ func Provider() *schema.Provider {
"equinix_network_file": resourceNetworkFile(),
"equinix_metal_user_api_key": resourceMetalUserAPIKey(),
"equinix_metal_project_api_key": resourceMetalProjectAPIKey(),
"equinix_metal_device": resourceMetalDevice(),
"equinix_metal_device": metal_device.Resource(),
"equinix_metal_device_network_type": resourceMetalDeviceNetworkType(),
"equinix_metal_port": metal_port.Resource(),
"equinix_metal_reserved_ip_block": resourceMetalReservedIPBlock(),
Expand Down
5 changes: 5 additions & 0 deletions equinix/resource_metal_spot_market_request.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import (
"fmt"
"log"
"reflect"
"regexp"
"sort"
"strconv"
"time"
Expand All @@ -22,6 +23,10 @@ import (
"github.com/packethost/packngo"
)

var (
matchIPXEScript = regexp.MustCompile(`(?i)^#![i]?pxe`)
)

func resourceMetalSpotMarketRequest() *schema.Resource {
return &schema.Resource{
CreateContext: resourceMetalSpotMarketRequestCreate,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package equinix
package device

import (
"context"
Expand All @@ -17,7 +17,7 @@ import (
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/structure"
)

func dataSourceMetalDevice() *schema.Resource {
func DataSource() *schema.Resource {
return &schema.Resource{
Description: `The datasource can be used to fetch a single device.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,24 +1,25 @@
package equinix
package device_test

import (
"fmt"
"testing"

"github.com/equinix/terraform-provider-equinix/internal/acceptance"
"github.com/hashicorp/terraform-plugin-testing/helper/acctest"
"github.com/hashicorp/terraform-plugin-testing/helper/resource"
)

func TestAccDataSourceMetalDevice_basic(t *testing.T) {
projectName := fmt.Sprintf("ds-device-%s", acctest.RandString(10))
projSuffix := fmt.Sprintf("ds-device-%s", acctest.RandString(10))

resource.ParallelTest(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
ExternalProviders: testExternalProviders,
ProtoV5ProviderFactories: testAccProtoV5ProviderFactories,
PreCheck: func() { acceptance.TestAccPreCheck(t) },
ExternalProviders: acceptance.TestExternalProviders,
ProtoV5ProviderFactories: acceptance.ProtoV5ProviderFactories,
CheckDestroy: testAccMetalDeviceCheckDestroyed,
Steps: []resource.TestStep{
{
Config: testDataSourceMetalDeviceConfig_basic(projectName),
Config: testDataSourceMetalDeviceConfig_basic(projSuffix),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr(
"data.equinix_metal_device.test", "hostname", "tfacc-test-device"),
Expand Down Expand Up @@ -59,20 +60,20 @@ resource "equinix_metal_device" "test" {
data "equinix_metal_device" "test" {
project_id = equinix_metal_project.test.id
hostname = equinix_metal_device.test.hostname
}`, confAccMetalDevice_base(preferable_plans, preferable_metros, preferable_os), projSuffix, testDeviceTerminationTime())
}`, acceptance.ConfAccMetalDevice_base(acceptance.Preferable_plans, acceptance.Preferable_metros, acceptance.Preferable_os), projSuffix, acceptance.TestDeviceTerminationTime())
}

func TestAccDataSourceMetalDevice_byID(t *testing.T) {
projectName := fmt.Sprintf("ds-device-by-id-%s", acctest.RandString(10))
projSuffix := fmt.Sprintf("ds-device-by-id-%s", acctest.RandString(10))

resource.ParallelTest(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
ExternalProviders: testExternalProviders,
ProtoV5ProviderFactories: testAccProtoV5ProviderFactories,
PreCheck: func() { acceptance.TestAccPreCheck(t) },
ExternalProviders: acceptance.TestExternalProviders,
ProtoV5ProviderFactories: acceptance.ProtoV5ProviderFactories,
CheckDestroy: testAccMetalDeviceCheckDestroyed,
Steps: []resource.TestStep{
{
Config: testDataSourceMetalDeviceConfig_byID(projectName),
Config: testDataSourceMetalDeviceConfig_byID(projSuffix),
Check: resource.ComposeTestCheckFunc(
resource.TestCheckResourceAttr(
"data.equinix_metal_device.test", "hostname", "tfacc-test-device"),
Expand Down Expand Up @@ -112,5 +113,5 @@ resource "equinix_metal_device" "test" {
data "equinix_metal_device" "test" {
device_id = equinix_metal_device.test.id
}`, confAccMetalDevice_base(preferable_plans, preferable_metros, preferable_os), projSuffix, testDeviceTerminationTime())
}`, acceptance.ConfAccMetalDevice_base(acceptance.Preferable_plans, acceptance.Preferable_metros, acceptance.Preferable_os), projSuffix, acceptance.TestDeviceTerminationTime())
}
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package equinix
package device

import (
"context"
Expand Down Expand Up @@ -71,6 +71,10 @@ func getNetworkInfo(ips []metalv1.IPAssignment) NetworkInfo {
return ni
}

// Deprecated: this exists for backwards compatibility with
// packngo-based resources. It relies on the deprecated packngo
// SDK and either the logic from packngo should be pulled in to
// the provider or this functionality should be removed entirely
func getNetworkType(device *metalv1.Device) (*string, error) {
pgDevice := packngo.Device{}
res, err := device.MarshalJSON()
Expand Down Expand Up @@ -131,7 +135,7 @@ func hwReservationStateRefreshFunc(ctx context.Context, client *metalv1.APIClien
}
}

func waitUntilReservationProvisionable(ctx context.Context, client *metalv1.APIClient, reservationId, instanceId string, delay, timeout, minTimeout time.Duration) error {
func WaitUntilReservationProvisionable(ctx context.Context, client *metalv1.APIClient, reservationId, instanceId string, delay, timeout, minTimeout time.Duration) error {
stateConf := &retry.StateChangeConf{
Pending: []string{deprovisioning},
Target: []string{provisionable, reprovisioned},
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package equinix
package device_test

import (
"context"
Expand All @@ -10,9 +10,10 @@ import (

"github.com/equinix/equinix-sdk-go/services/metalv1"
"github.com/equinix/terraform-provider-equinix/internal/config"
"github.com/equinix/terraform-provider-equinix/internal/resources/metal/device"
)

func Test_waitUntilReservationProvisionable(t *testing.T) {
func Test_WaitUntilReservationProvisionable(t *testing.T) {
type args struct {
reservationId string
instanceId string
Expand Down Expand Up @@ -162,7 +163,7 @@ func Test_waitUntilReservationProvisionable(t *testing.T) {
meta.Load(ctx)

Check failure on line 163 in internal/resources/metal/device/helpers_test.go

View workflow job for this annotation

GitHub Actions / lint

Error return value of `meta.Load` is not checked (errcheck)

client := meta.NewMetalClientForTesting()
if err := waitUntilReservationProvisionable(ctx, client, tt.args.reservationId, tt.args.instanceId, 50*time.Millisecond, 1*time.Second, 50*time.Millisecond); (err != nil) != tt.wantErr {
if err := device.WaitUntilReservationProvisionable(ctx, client, tt.args.reservationId, tt.args.instanceId, 50*time.Millisecond, 1*time.Second, 50*time.Millisecond); (err != nil) != tt.wantErr {
t.Errorf("waitUntilReservationProvisionable() error = %v, wantErr %v", err, tt.wantErr)
}

Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
package equinix
package device

import (
"context"
Expand All @@ -11,8 +11,8 @@ import (
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
)

func dataSourceMetalDevices() *schema.Resource {
dsmd := dataSourceMetalDevice()
func ListDataSource() *schema.Resource {
dsmd := DataSource()
sch := dsmd.Schema
for _, v := range sch {
if v.Optional {
Expand Down
Loading

0 comments on commit 4f403c8

Please sign in to comment.