Adding configurable hostnames to the SoftLayer Terraform plugin. (#433)

Signed-off-by: Jacob Frericks <[email protected]>

Author: JacobFrericks

examples/instance/terraform/plugin.go

@@ -359,6 +359,23 @@ func (p *plugin) Provision(spec instance.Spec) (*instance.ID, error) {
 		}
 	}
 
+	// Use the given hostname value as a prefix if it is a non-empty string
+	if hostnamePrefix, is := properties.Value["@hostname_prefix"].(string); is {
+		hostnamePrefix = strings.Trim(hostnamePrefix, " ")
+		// Use the default behavior if hostnamePrefix was either not a string, or an empty string
+		if hostnamePrefix == "" {
+			properties.Value["hostname"] = name
+		} else {
+			// Remove "instance-" from "instance-XXXX", then append that string to the hostnamePrefix to create the new hostname
+			properties.Value["hostname"] = fmt.Sprintf("%s-%s", hostnamePrefix, strings.Replace(name, "instance-", "", -1))
+		}
+	} else {
+		properties.Value["hostname"] = name
+	}
+	// Delete hostnamePrefix so it will not be written in the *.tf.json file
+	delete(properties.Value, "@hostname_prefix")
+	log.Debugln("Adding hostname to properties: hostname=", properties.Value["hostname"])
+
 	switch properties.Type {
 	case "aws_instance", "azurerm_virtual_machine", "digitalocean_droplet", "google_compute_instance":
 		if t, exists := properties.Value["tags"]; !exists {
@@ -370,9 +387,6 @@ func (p *plugin) Provision(spec instance.Spec) (*instance.ID, error) {
 			}
 		}
 	case "softlayer_virtual_guest":
-		log.Debugln("softlayer_virtual_guest detected, adding hostname to properties: hostname=", name)
-		properties.Value["hostname"] = name
-
 		if _, has := properties.Value["tags"]; !has {
 			properties.Value["tags"] = []interface{}{}
 		}

examples/instance/terraform/plugin_test.go

@@ -1,10 +1,12 @@
 package main
 
 import (
+	"encoding/json"
 	"io/ioutil"
 	"os"
 	"path/filepath"
 	"sort"
+	"strings"
 	"testing"
 
 	"github.com/docker/infrakit/pkg/spi/instance"
@@ -13,10 +15,12 @@ import (
 )
 
 func TestUsage(t *testing.T) {
+	// Test a softlayer_virtual_guest with an @hostname_prefix
 	run(t, "softlayer_virtual_guest", `
 {
         "type": "softlayer_virtual_guest",
         "value": {
+          "@hostname_prefix": "softlayer-hostname",
           "cores": 2,
           "memory": 2048,
           "tags": [
@@ -39,6 +43,61 @@ func TestUsage(t *testing.T) {
       }
 `)
 
+	// Test a softlayer_virtual_guest without an @hostname_prefix
+	run(t, "softlayer_virtual_guest", `
+{
+		"type": "softlayer_virtual_guest",
+		"value": {
+			"cores": 2,
+			"memory": 2048,
+			"tags": [
+				"terraform_demo_swarm_mgr_sl"
+			],
+			"connection": {
+				"user": "root",
+				"private_key": "${file(\"~/.ssh/id_rsa_de\")}"
+			},
+			"hourly_billing": true,
+			"local_disk": true,
+			"network_speed": 100,
+			"datacenter": "dal10",
+			"os_reference_code": "UBUNTU_14_64",
+			"domain": "softlayer.com",
+			"ssh_key_ids": [
+				"${data.softlayer_ssh_key.public_key.id}"
+			]
+		}
+	}
+`)
+
+	// Test a softlayer_virtual_guest with an empty @hostname_prefix
+	run(t, "softlayer_virtual_guest", `
+{
+		"type": "softlayer_virtual_guest",
+		"value": {
+			"@hostname_prefix": "   ",
+			"cores": 2,
+			"memory": 2048,
+			"tags": [
+				"terraform_demo_swarm_mgr_sl"
+			],
+			"connection": {
+				"user": "root",
+				"private_key": "${file(\"~/.ssh/id_rsa_de\")}"
+			},
+			"hourly_billing": true,
+			"local_disk": true,
+			"network_speed": 100,
+			"datacenter": "dal10",
+			"os_reference_code": "UBUNTU_14_64",
+			"domain": "softlayer.com",
+			"ssh_key_ids": [
+				"${data.softlayer_ssh_key.public_key.id}"
+			]
+		}
+	}
+`)
+
 	run(t, "aws_instance", `
 {
         "type" : "aws_instance",
@@ -113,6 +172,24 @@ func run(t *testing.T, resourceType, properties string) {
 
 	props := parsed.Resource[resourceType][string(*id)]
 
+	// Unmarshal json for easy access
+	var testingData interface{}
+	json.Unmarshal([]byte(properties), &testingData)
+	m := testingData.(map[string]interface{})
+	value, _ := m["value"].(map[string]interface{})
+
+	// If a hostname was specified, the expectation is that the hostname is appended with the timestamp from the ID
+	if value["@hostname_prefix"] != nil && strings.Trim(value["@hostname_prefix"].(string), " ") != "" {
+		newID := strings.Replace(string(*id), "instance-", "", -1)
+		expectedHostname := "softlayer-hostname-" + newID
+		require.Equal(t, expectedHostname, props["hostname"])
+	} else {
+		// If no hostname was specified, the hostname should equal the ID
+		require.Equal(t, string(*id), props["hostname"])
+	}
+	// Verify the hostname prefix key/value is no longer in the props
+	require.Nil(t, props["@hostname_prefix"])
+
 	switch resourceType {
 	case "softlayer_virtual_guest":
 		require.Equal(t, conv([]interface{}{