terraform 0.12.x support

Author: Radoslav Mirchev

CHANGELOG.md

@@ -0,0 +1,42 @@
+## 0.3.0
+New version supporting new Terraform API version 5
+ * The whole provider was re-build around teeraform source code for version 0.12.x+
+   which add support (and makes possible to run the provider) on Terraform 0.12.x+
+
+## 0.2.0
+
+New version with some breaking changes regarding custom fields:
+
+ * Custom field searches are not done via the `custom_field_filter` attribute in
+   both the `phpipam_address` and `phpipam_subnet` data sources. This parameter
+   is a map that takes custom field names, and regular expressions to search for
+   against. A field does not match if any of the search criteria keys are
+   missing or do not match.
+
+Also have added two new data sources:
+
+ * `phpipam_address` will search addresses for a `description`  or `hostname`
+   exact match or a `custom_field_filter` match, much like the singular-form
+   `phpipam_address` data source. A list of IP address IDs are returned, which
+   can then be used to look up addresses with the `phpipam_address` data source.
+   This will work better in Terraform v0.9.x, or higher, which has support for a
+   computed `count` in data sources now.
+ * `phpipam_subnets` has been added in the same way. This one can search on
+   `description`, `description_match`, and `custom_field_filter`, in the same
+   way the singular-form `phpipam_address` data source can.
+
+## 0.1.2
+
+Added custom field support - this plugin now supports custom fields in
+addresses, subnets, and VLANs, as long as those fields are optional. Data source
+searching supports addresses and subnets only, due to limitations in VLAN
+searching capabilities.
+
+## 0.1.1
+
+Bumping release so that I have a consistent snapshot, and also so that I can
+correct some tests on the compat branch.
+
+## 0.1.0
+
+First release!

LICENSE

@@ -0,0 +1,13 @@
+Copyright 2017 PayByPhone Technologies, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

Makefile

@@ -0,0 +1,23 @@
+test:
+	go test -v $(shell go list ./... | grep -v /vendor/) 
+
+testacc:
+	TF_ACC=1 go test -v ./plugin/providers/phpipam -run="TestAcc"
+
+build: deps
+	gox -osarch="linux/amd64 windows/amd64 darwin/amd64" \
+	-output="pkg/{{.OS}}_{{.Arch}}/terraform-provider-phpipam" .
+
+release: release_bump release_build
+
+release_bump:
+	scripts/release_bump.sh
+
+release_build:
+	scripts/release_build.sh
+
+deps:
+	go get -u github.com/mitchellh/gox
+
+clean:
+	rm -rf pkg/

README.md

@@ -1,5 +1,5 @@
 # ATTENTION!!! 
-This repository is based on the original work of github user babyphone.
+This repository is based on the original work of github user paybyphone.
 However, the version of the provider in this repo is updated and revised to support working with Terraform 12.x+
 The build here is currently based on the babyphone original repo + hashicorp original terraform repo and was build around Terraform version 0.12.11
 All credit should go to https://github.com/paybyphone/terraform-provider-phpipam - I've just modernized his work!

main.go

@@ -0,0 +1,12 @@
+package main
+
+import (
+	"github.com/hashicorp/terraform/plugin"
+	"github.com/paybyphone/terraform-provider-phpipam/plugin/providers/phpipam"
+)
+
+func main() {
+	plugin.Serve(&plugin.ServeOpts{
+		ProviderFunc: phpipam.Provider,
+	})
+}

main_test.go

@@ -0,0 +1,19 @@
+package main
+
+import (
+	"testing"
+
+	"github.com/hashicorp/terraform/plugin"
+)
+
+// pluginVersionExpected provides the expected plugin version that this release
+// of the plugin is built with.
+const pluginVersionExpected = 4
+
+// TestPluginVersion tests the plugin API version of the vendored Terraform
+// libraries.
+func TestPluginVersion(t *testing.T) {
+	if plugin.Handshake.ProtocolVersion != pluginVersionExpected {
+		t.Fatalf("Expected vendored plugin version to be %d, got %d", pluginVersionExpected, plugin.Handshake.ProtocolVersion)
+	}
+}

plugin/providers/phpipam/address_structure.go

@@ -0,0 +1,258 @@
+package phpipam
+
+import (
+	"errors"
+	"strconv"
+
+	"github.com/hashicorp/terraform/helper/schema"
+	"github.com/paybyphone/phpipam-sdk-go/controllers/addresses"
+	"github.com/paybyphone/phpipam-sdk-go/phpipam"
+)
+
+// resourceAddressOptionalFields represents all the fields that are optional in
+// the phpipam_address resource. These fields get flagged as Optional, with zero
+// value defaults (the field is not set), in addition to being marked as
+// Computed. Any field not listed here cannot be supplied by the resource and
+// is solely computed.
+var resourceAddressOptionalFields = linearSearchSlice{
+	"is_gateway",
+	"description",
+	"hostname",
+	"mac_address",
+	"owner",
+	"state_tag_id",
+	"skip_ptr_record",
+	"ptr_record_id",
+	"device_id",
+	"switch_port_label",
+	"note",
+	"exclude_ping",
+}
+
+// bareAddressSchema returns a map[string]*schema.Schema with the schema used
+// to represent a PHPIPAM address resource. This output should then be modified
+// so that required and computed fields are set properly for both the data
+// source and the resource.
+func bareAddressSchema() map[string]*schema.Schema {
+	return map[string]*schema.Schema{
+		"address_id": &schema.Schema{
+			Type: schema.TypeInt,
+		},
+		"subnet_id": &schema.Schema{
+			Type: schema.TypeInt,
+		},
+		"ip_address": &schema.Schema{
+			Type: schema.TypeString,
+		},
+		"is_gateway": &schema.Schema{
+			Type: schema.TypeBool,
+		},
+		"description": &schema.Schema{
+			Type: schema.TypeString,
+		},
+		"hostname": &schema.Schema{
+			Type: schema.TypeString,
+		},
+		"mac_address": &schema.Schema{
+			Type: schema.TypeString,
+		},
+		"owner": &schema.Schema{
+			Type: schema.TypeString,
+		},
+		"state_tag_id": &schema.Schema{
+			Type: schema.TypeInt,
+		},
+		"skip_ptr_record": &schema.Schema{
+			Type: schema.TypeBool,
+		},
+		"ptr_record_id": &schema.Schema{
+			Type: schema.TypeInt,
+		},
+		"device_id": &schema.Schema{
+			Type: schema.TypeInt,
+		},
+		"switch_port_label": &schema.Schema{
+			Type: schema.TypeString,
+		},
+		"note": &schema.Schema{
+			Type: schema.TypeString,
+		},
+		"last_seen": &schema.Schema{
+			Type: schema.TypeString,
+		},
+		"exclude_ping": &schema.Schema{
+			Type: schema.TypeBool,
+		},
+		"edit_date": &schema.Schema{
+			Type: schema.TypeString,
+		},
+		"custom_fields": &schema.Schema{
+			Type: schema.TypeMap,
+		},
+	}
+}
+
+// resourceAddressSchema returns the schema for the phpipam_address resource.
+// It sets the required and optional fields, the latter defined in
+// resourceAddressRequiredFields, and ensures that all optional and
+// non-configurable fields are computed as well.
+func resourceAddressSchema() map[string]*schema.Schema {
+	s := bareAddressSchema()
+	for k, v := range s {
+		switch {
+		// IP Address and Subnet ID are ForceNew
+		case k == "subnet_id" || k == "ip_address":
+			v.Required = true
+			v.ForceNew = true
+		case k == "custom_fields":
+			v.Optional = true
+		case resourceAddressOptionalFields.Has(k):
+			v.Optional = true
+			v.Computed = true
+		default:
+			v.Computed = true
+		}
+	}
+	// Add the remove_dns_on_delete item to the schema. This is a meta-parameter
+	// that is not part of the API resource and exists to instruct PHPIPAM to
+	// gracefully remove the address from its DNS integrations as well when it is
+	// removed. The default on this option is true.
+	s["remove_dns_on_delete"] = &schema.Schema{
+		Type:     schema.TypeBool,
+		Optional: true,
+		Default:  true,
+	}
+	return s
+}
+
+// dataSourceAddressSchema returns the schema for the phpipam_address data
+// source. It sets the searchable fields and sets up the attribute conflicts
+// between IP address and address ID. It also ensures that all fields are
+// computed as well.
+func dataSourceAddressSchema() map[string]*schema.Schema {
+	s := bareAddressSchema()
+	for k, v := range s {
+		switch k {
+		case "address_id":
+			v.Optional = true
+			v.Computed = true
+			v.ConflictsWith = []string{"ip_address", "subnet_id", "description", "hostname", "custom_field_filter"}
+		case "ip_address":
+			v.Optional = true
+			v.Computed = true
+			v.ConflictsWith = []string{"address_id", "subnet_id", "description", "hostname", "custom_field_filter"}
+		case "subnet_id":
+			v.Optional = true
+			v.Computed = true
+			v.ConflictsWith = []string{"ip_address", "address_id"}
+		case "description":
+			v.Optional = true
+			v.Computed = true
+			v.ConflictsWith = []string{"ip_address", "address_id", "hostname", "custom_field_filter"}
+		case "hostname":
+			v.Optional = true
+			v.Computed = true
+			v.ConflictsWith = []string{"ip_address", "address_id", "description", "custom_field_filter"}
+		default:
+			v.Computed = true
+		}
+	}
+	// Add the custom_field_filter item to the schema. This is a meta-parameter
+	// that allows searching for a custom field value in the data source.
+	s["custom_field_filter"] = customFieldFilterSchema([]string{"ip_address", "address_id", "hostname", "description"})
+
+	return s
+}
+
+// expandAddress returns the addresses.Address structure for a
+// phpiapm_address resource or data source. Depending on if we are dealing with
+// the resource or data source, extra considerations may need to be taken.
+func expandAddress(d *schema.ResourceData) addresses.Address {
+	s := addresses.Address{
+		ID:          d.Get("address_id").(int),
+		SubnetID:    d.Get("subnet_id").(int),
+		IPAddress:   d.Get("ip_address").(string),
+		IsGateway:   phpipam.BoolIntString(d.Get("is_gateway").(bool)),
+		Description: d.Get("description").(string),
+		Hostname:    d.Get("hostname").(string),
+		MACAddress:  d.Get("mac_address").(string),
+		Owner:       d.Get("owner").(string),
+		Tag:         d.Get("state_tag_id").(int),
+		PTRIgnore:   phpipam.BoolIntString(d.Get("skip_ptr_record").(bool)),
+		PTRRecordID: d.Get("ptr_record_id").(int),
+		DeviceID:    d.Get("device_id").(int),
+		Port:        d.Get("switch_port_label").(string),
+		Note:        d.Get("note").(string),
+		LastSeen:    d.Get("last_seen").(string),
+		ExcludePing: phpipam.BoolIntString(d.Get("exclude_ping").(bool)),
+	}
+
+	return s
+}
+
+// flattenAddress sets fields in a *schema.ResourceData with fields supplied by
+// the input addresses.Address. This is used in read operations.
+func flattenAddress(a addresses.Address, d *schema.ResourceData) {
+	d.SetId(strconv.Itoa(a.ID))
+	d.Set("address_id", a.ID)
+	d.Set("subnet_id", a.SubnetID)
+	d.Set("ip_address", a.IPAddress)
+	d.Set("is_gateway", a.IsGateway)
+	d.Set("description", a.Description)
+	d.Set("hostname", a.Hostname)
+	d.Set("mac_address", a.MACAddress)
+	d.Set("owner", a.Owner)
+	d.Set("state_tag_id", a.Tag)
+	d.Set("skip_ptr_record", a.PTRIgnore)
+	d.Set("ptr_record_id", a.PTRRecordID)
+	d.Set("device_id", a.DeviceID)
+	d.Set("switch_port_label", a.Port)
+	d.Set("note", a.Note)
+	d.Set("last_seen", a.LastSeen)
+	d.Set("exclude_ping", a.ExcludePing)
+	d.Set("edit_date", a.EditDate)
+}
+
+// addressSearchInSubnet provides the address search functionality for both the
+// phpipam_address and phpipam_addresses data sources, returning an
+// []addresses.Address to the particular data source that is calling the
+// function. From here it's up to the specific data source to determine what
+// they want to do with the results (ie: reject it on matching nothing or more
+// than one for the singular data source, or extracting the IDs for the plural
+// one).
+func addressSearchInSubnet(d *schema.ResourceData, meta interface{}) ([]addresses.Address, error) {
+	c := meta.(*ProviderPHPIPAMClient).addressesController
+	s := meta.(*ProviderPHPIPAMClient).subnetsController
+	result := make([]addresses.Address, 0)
+	v, err := s.GetAddressesInSubnet(d.Get("subnet_id").(int))
+	if err != nil {
+		return result, err
+	}
+	if len(v) == 0 {
+		return result, errors.New("No addresses were found in the supplied subnet")
+	}
+	for _, r := range v {
+		switch {
+		// Double-assert that we don't have empty strings in the conditionals
+		// to ensure there there is no edge cases with matching zero values.
+		case d.Get("description").(string) != "" && r.Description == d.Get("description").(string):
+			result = append(result, r)
+		case d.Get("hostname").(string) != "" && r.Hostname == d.Get("hostname").(string):
+			result = append(result, r)
+		case len(d.Get("custom_field_filter").(map[string]interface{})) > 0:
+			fields, err := c.GetAddressCustomFields(r.ID)
+			if err != nil {
+				return result, err
+			}
+			search := d.Get("custom_field_filter").(map[string]interface{})
+			matched, err := customFieldFilter(fields, search)
+			if err != nil {
+				return result, err
+			}
+			if matched {
+				result = append(result, r)
+			}
+		}
+	}
+	return result, nil
+}