From a0c4808d057db578e80677075c49b48b3c2a3ca7 Mon Sep 17 00:00:00 2001 From: Samuel Mutel <12967891+smutel@users.noreply.github.com> Date: Fri, 31 Mar 2023 14:07:02 +0200 Subject: [PATCH] feat: Add netbox_dcim_rack_role resource --- .../resources/netbox_dcim_rack_role/import.sh | 2 + .../netbox_dcim_rack_role/resource.tf | 83 ++++++ netbox/dcim/resource_netbox_dcim_rack_role.go | 278 ++++++++++++++++++ .../resource_netbox_dcim_rack_role_test.go | 122 ++++++++ netbox/provider.go | 1 + 5 files changed, 486 insertions(+) create mode 100644 examples/resources/netbox_dcim_rack_role/import.sh create mode 100644 examples/resources/netbox_dcim_rack_role/resource.tf create mode 100644 netbox/dcim/resource_netbox_dcim_rack_role.go create mode 100644 netbox/dcim/resource_netbox_dcim_rack_role_test.go diff --git a/examples/resources/netbox_dcim_rack_role/import.sh b/examples/resources/netbox_dcim_rack_role/import.sh new file mode 100644 index 000000000..efb2e38b6 --- /dev/null +++ b/examples/resources/netbox_dcim_rack_role/import.sh @@ -0,0 +1,2 @@ +# Rack roles can be imported by id +terraform import netbox_dcim_rack_role.rack_role_test 1 diff --git a/examples/resources/netbox_dcim_rack_role/resource.tf b/examples/resources/netbox_dcim_rack_role/resource.tf new file mode 100644 index 000000000..3fc44d5c7 --- /dev/null +++ b/examples/resources/netbox_dcim_rack_role/resource.tf @@ -0,0 +1,83 @@ +resource "netbox_dcim_rack_role" "rack_role_test" { + name = "Test rack role" + slug = "Test rack role" + description = "Rack role for testing" + color = "00ff00" + + tag { + name = "tag1" + slug = "tag1" + } + + custom_field { + name = "cf_boolean" + type = "boolean" + value = "true" + } + + custom_field { + name = "cf_date" + type = "date" + value = "2020-12-25" + } + + custom_field { + name = "cf_text" + type = "text" + value = "some text" + } + + custom_field { + name = "cf_integer" + type = "integer" + value = "10" + } + + custom_field { + name = "cf_selection" + type = "select" + value = "1" + } + + custom_field { + name = "cf_url" + type = "url" + value = "https://github.com" + } + + custom_field { + name = "cf_multi_selection" + type = "multiselect" + value = jsonencode([ + "0", + "1" + ]) + } + + custom_field { + name = "cf_json" + type = "json" + value = jsonencode({ + stringvalue = "string" + boolvalue = false + dictionary = { + numbervalue = 5 + } + }) + } + + custom_field { + name = "cf_object" + type = "object" + value = 1 + } + + custom_field { + name = "cf_multi_object" + type = "multiobject" + value = jsonencode([ + 1, + 2 + ]) + } +} diff --git a/netbox/dcim/resource_netbox_dcim_rack_role.go b/netbox/dcim/resource_netbox_dcim_rack_role.go new file mode 100644 index 000000000..7266a0d9f --- /dev/null +++ b/netbox/dcim/resource_netbox_dcim_rack_role.go @@ -0,0 +1,278 @@ +package dcim + +import ( + "context" + "regexp" + "strconv" + + "github.com/hashicorp/terraform-plugin-sdk/v2/diag" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation" + netboxclient "github.com/smutel/go-netbox/v3/netbox/client" + "github.com/smutel/go-netbox/v3/netbox/client/dcim" + "github.com/smutel/go-netbox/v3/netbox/models" + "github.com/smutel/terraform-provider-netbox/v6/netbox/internal/customfield" + "github.com/smutel/terraform-provider-netbox/v6/netbox/internal/requestmodifier" + "github.com/smutel/terraform-provider-netbox/v6/netbox/internal/tag" +) + +func ResourceNetboxDcimRackRole() *schema.Resource { + return &schema.Resource{ + Description: "Manage a rack role (dcim module) within Netbox.", + CreateContext: resourceNetboxDcimRackRoleCreate, + ReadContext: resourceNetboxDcimRackRoleRead, + UpdateContext: resourceNetboxDcimRackRoleUpdate, + DeleteContext: resourceNetboxDcimRackRoleDelete, + Exists: resourceNetboxDcimRackRoleExists, + Importer: &schema.ResourceImporter{ + StateContext: schema.ImportStatePassthroughContext, + }, + + Schema: map[string]*schema.Schema{ + "color": { + Type: schema.TypeString, + Optional: true, + Default: "9e9e9e", + ValidateFunc: validation.All( + validation.StringLenBetween(1, 6), + validation.StringMatch( + regexp.MustCompile("^[0-9a-f]{1,6}$"), + "^[0-9a-f]{1,6})$")), + Description: "The color of this rack role. Default is grey (#9e9e9e).", + }, + "created": { + Type: schema.TypeString, + Computed: true, + Description: "Date when this rack role was created.", + }, + "custom_field": &customfield.CustomFieldSchema, + "description": { + Type: schema.TypeString, + Optional: true, + ValidateFunc: validation.StringLenBetween(0, 100), + Description: "The description of this rack role (dcim module).", + }, + "rack_count": { + Type: schema.TypeInt, + Computed: true, + Description: "The number of racks with this rack role.", + }, + "last_updated": { + Type: schema.TypeString, + Computed: true, + Description: "Date when this rack role was last updated.", + }, + "name": { + Type: schema.TypeString, + Required: true, + ValidateFunc: validation.StringLenBetween(1, 100), + Description: "The name of this rack role (dcim module).", + }, + "slug": { + Type: schema.TypeString, + Required: true, + ValidateFunc: validation.StringLenBetween(1, 100), + Description: "The slug of this rack role (dcim module).", + }, + "tag": &tag.TagSchema, + "url": { + Type: schema.TypeString, + Computed: true, + Description: "The link to this rack role (dcim module).", + }, + }, + } +} + +var rackRoleRequiredFields = []string{ + "created", + "last_updated", + "name", + "slug", + "tags", +} + +func resourceNetboxDcimRackRoleCreate(ctx context.Context, d *schema.ResourceData, + m interface{}) diag.Diagnostics { + client := m.(*netboxclient.NetBoxAPI) + + resourceCustomFields := d.Get("custom_field").(*schema.Set).List() + customFields := customfield.ConvertCustomFieldsFromTerraformToAPI(nil, resourceCustomFields) + name := d.Get("name").(string) + slug := d.Get("slug").(string) + tags := d.Get("tag").(*schema.Set).List() + + newResource := &models.RackRole{ + Color: d.Get("color").(string), + CustomFields: customFields, + Description: d.Get("description").(string), + Name: &name, + Slug: &slug, + Tags: tag.ConvertTagsToNestedTags(tags), + } + + dropFields := []string{} + emptyFields := make(map[string]interface{}) + + resource := dcim.NewDcimRackRolesCreateParams().WithData(newResource) + + resourceCreated, err := client.Dcim.DcimRackRolesCreate(resource, nil, requestmodifier.NewRequestModifierOperation(emptyFields, dropFields)) + if err != nil { + return diag.FromErr(err) + } + + d.SetId(strconv.FormatInt(resourceCreated.Payload.ID, 10)) + + return resourceNetboxDcimRackRoleRead(ctx, d, m) +} + +func resourceNetboxDcimRackRoleRead(ctx context.Context, d *schema.ResourceData, + m interface{}) diag.Diagnostics { + client := m.(*netboxclient.NetBoxAPI) + + resourceID := d.Id() + params := dcim.NewDcimRackRolesListParams().WithID(&resourceID) + resources, err := client.Dcim.DcimRackRolesList(params, nil) + if err != nil { + return diag.FromErr(err) + } + + if len(resources.Payload.Results) != 1 { + d.SetId("") + return nil + } + + resource := resources.Payload.Results[0] + + if err = d.Set("color", resource.Color); err != nil { + return diag.FromErr(err) + } + if err = d.Set("created", resource.Created.String()); err != nil { + return diag.FromErr(err) + } + resourceCustomFields := d.Get("custom_field").(*schema.Set).List() + customFields := customfield.UpdateCustomFieldsFromAPI(resourceCustomFields, resource.CustomFields) + + if err = d.Set("custom_field", customFields); err != nil { + return diag.FromErr(err) + } + if err = d.Set("description", resource.Description); err != nil { + return diag.FromErr(err) + } + if err = d.Set("rack_count", resource.RackCount); err != nil { + return diag.FromErr(err) + } + if err = d.Set("last_updated", resource.LastUpdated.String()); err != nil { + return diag.FromErr(err) + } + if err = d.Set("name", resource.Name); err != nil { + return diag.FromErr(err) + } + if err = d.Set("slug", resource.Slug); err != nil { + return diag.FromErr(err) + } + if err = d.Set("tag", tag.ConvertNestedTagsToTags(resource.Tags)); err != nil { + return diag.FromErr(err) + } + if err = d.Set("url", resource.URL); err != nil { + return diag.FromErr(err) + } + + return nil +} + +func resourceNetboxDcimRackRoleUpdate(ctx context.Context, d *schema.ResourceData, + m interface{}) diag.Diagnostics { + client := m.(*netboxclient.NetBoxAPI) + modifiedFields := make(map[string]interface{}) + + resourceID, err := strconv.ParseInt(d.Id(), 10, 64) + if err != nil { + return diag.Errorf("Unable to convert ID into int64") + } + + params := &models.RackRole{} + + if d.HasChange("color") { + params.Color = d.Get("color").(string) + } + if d.HasChange("custom_field") { + stateCustomFields, resourceCustomFields := d.GetChange("custom_field") + customFields := customfield.ConvertCustomFieldsFromTerraformToAPI(stateCustomFields.(*schema.Set).List(), resourceCustomFields.(*schema.Set).List()) + params.CustomFields = &customFields + } + if d.HasChange("description") { + params.Description = d.Get("description").(string) + modifiedFields["description"] = params.Description + } + if d.HasChange("name") { + name := d.Get("name").(string) + params.Name = &name + } + if d.HasChange("slug") { + slug := d.Get("slug").(string) + params.Slug = &slug + } + if d.HasChange("tag") { + tags := d.Get("tag").(*schema.Set).List() + params.Tags = tag.ConvertTagsToNestedTags(tags) + } + + resource := dcim.NewDcimRackRolesPartialUpdateParams().WithData(params) + + resource.SetID(resourceID) + + _, err = client.Dcim.DcimRackRolesPartialUpdate(resource, nil, requestmodifier.NewNetboxRequestModifier(modifiedFields, rackRoleRequiredFields)) + if err != nil { + return diag.FromErr(err) + } + + return resourceNetboxDcimRackRoleRead(ctx, d, m) +} + +func resourceNetboxDcimRackRoleDelete(ctx context.Context, d *schema.ResourceData, + m interface{}) diag.Diagnostics { + client := m.(*netboxclient.NetBoxAPI) + + resourceExists, err := resourceNetboxDcimRackRoleExists(d, m) + if err != nil { + return diag.FromErr(err) + } + + if !resourceExists { + return nil + } + + id, err := strconv.ParseInt(d.Id(), 10, 64) + if err != nil { + return diag.Errorf("Unable to convert ID into int64") + } + + resource := dcim.NewDcimRackRolesDeleteParams().WithID(id) + if _, err := client.Dcim.DcimRackRolesDelete(resource, nil); err != nil { + return diag.FromErr(err) + } + + return nil +} + +func resourceNetboxDcimRackRoleExists(d *schema.ResourceData, + m interface{}) (b bool, e error) { + client := m.(*netboxclient.NetBoxAPI) + resourceExist := false + + resourceID := d.Id() + params := dcim.NewDcimRackRolesListParams().WithID(&resourceID) + resources, err := client.Dcim.DcimRackRolesList(params, nil) + if err != nil { + return resourceExist, err + } + + for _, resource := range resources.Payload.Results { + if strconv.FormatInt(resource.ID, 10) == d.Id() { + resourceExist = true + } + } + + return resourceExist, nil +} diff --git a/netbox/dcim/resource_netbox_dcim_rack_role_test.go b/netbox/dcim/resource_netbox_dcim_rack_role_test.go new file mode 100644 index 000000000..47296b4c3 --- /dev/null +++ b/netbox/dcim/resource_netbox_dcim_rack_role_test.go @@ -0,0 +1,122 @@ +package dcim_test + +import ( + "strconv" + "testing" + + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/acctest" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" + "github.com/smutel/terraform-provider-netbox/v6/netbox/internal/util" +) + +const resourceNameNetboxDcimRackRole = "netbox_dcim_rack_role.test" + +func TestAccNetboxDcimRackRoleMinimal(t *testing.T) { + nameSuffix := acctest.RandStringFromCharSet(10, acctest.CharSetAlphaNum) + + resource.Test(t, resource.TestCase{ + PreCheck: func() { util.TestAccPreCheck(t) }, + Providers: testAccProviders, + Steps: []resource.TestStep{ + { + Config: testAccCheckNetboxDcimRackRoleConfig(nameSuffix, false, false), + Check: resource.ComposeTestCheckFunc( + util.TestAccResourceExists(resourceNameNetboxDcimRackRole), + ), + }, + { + ResourceName: resourceNameNetboxDcimRackRole, + ImportState: true, + ImportStateVerify: true, + }, + }, + }) +} + +func TestAccNetboxDcimRackRoleFull(t *testing.T) { + nameSuffix := acctest.RandStringFromCharSet(10, acctest.CharSetAlphaNum) + + resource.Test(t, resource.TestCase{ + PreCheck: func() { util.TestAccPreCheck(t) }, + Providers: testAccProviders, + Steps: []resource.TestStep{ + { + Config: testAccCheckNetboxDcimRackRoleConfig(nameSuffix, true, true), + Check: resource.ComposeTestCheckFunc( + util.TestAccResourceExists(resourceNameNetboxDcimRackRole), + ), + }, + { + ResourceName: resourceNameNetboxDcimRackRole, + ImportState: true, + ImportStateVerify: true, + }, + }, + }) +} + +func TestAccNetboxDcimRackRoleMinimalFullMinimal(t *testing.T) { + nameSuffix := acctest.RandStringFromCharSet(10, acctest.CharSetAlphaNum) + + resource.Test(t, resource.TestCase{ + PreCheck: func() { util.TestAccPreCheck(t) }, + Providers: testAccProviders, + Steps: []resource.TestStep{ + { + Config: testAccCheckNetboxDcimRackRoleConfig(nameSuffix, false, false), + Check: resource.ComposeTestCheckFunc( + util.TestAccResourceExists(resourceNameNetboxDcimRackRole), + ), + }, + { + Config: testAccCheckNetboxDcimRackRoleConfig(nameSuffix, true, true), + Check: resource.ComposeTestCheckFunc( + util.TestAccResourceExists(resourceNameNetboxDcimRackRole), + ), + }, + { + Config: testAccCheckNetboxDcimRackRoleConfig(nameSuffix, false, true), + Check: resource.ComposeTestCheckFunc( + util.TestAccResourceExists(resourceNameNetboxDcimRackRole), + ), + }, + { + Config: testAccCheckNetboxDcimRackRoleConfig(nameSuffix, false, false), + Check: resource.ComposeTestCheckFunc( + util.TestAccResourceExists(resourceNameNetboxDcimRackRole), + ), + }, + }, + }) +} + +func testAccCheckNetboxDcimRackRoleConfig(nameSuffix string, resourceFull, extraResources bool) string { + template := ` + {{ if eq .extraresources "true" }} + resource "netbox_extras_tag" "test" { + name = "test-{{ .namesuffix }}" + slug = "test-{{ .namesuffix }}" + } + {{ end }} + + resource "netbox_dcim_rack_role" "test" { + name = "test-{{ .namesuffix }}" + slug = "test-{{ .namesuffix }}" + {{ if eq .resourcefull "true" }} + description = "Test rack role" + color = "00ff00" + + tag { + name = netbox_extras_tag.test.name + slug = netbox_extras_tag.test.slug + } + {{ end }} + } + ` + data := map[string]string{ + "namesuffix": nameSuffix, + "resourcefull": strconv.FormatBool(resourceFull), + "extraresources": strconv.FormatBool(extraResources), + } + return util.RenderTemplate(template, data) +} diff --git a/netbox/provider.go b/netbox/provider.go index 50ffb2dfc..fa86965d6 100644 --- a/netbox/provider.go +++ b/netbox/provider.go @@ -168,6 +168,7 @@ func Provider() *schema.Provider { "netbox_dcim_manufacturer": dcim.ResourceNetboxDcimManufacturer(), "netbox_dcim_device_role": dcim.ResourceNetboxDcimDeviceRole(), "netbox_dcim_platform": dcim.ResourceNetboxDcimPlatform(), + "netbox_dcim_rack_role": dcim.ResourceNetboxDcimRackRole(), "netbox_dcim_site": dcim.ResourceNetboxDcimSite(), "netbox_extras_custom_field": extras.ResourceNetboxExtrasCustomField(), "netbox_extras_tag": extras.ResourceNetboxExtrasTag(),