Handle LogicalID for Softlayer instances (#548)

The current LogicalID processing in the terraform instance provider has
two issues:
- The LogicalID tag is only added to the tags if the tags object type is
  map but, for Softlayer, the tags object type is a list
- Softlayer only supports lower-case chars in tags so all tag checks for
  "LogicalID" must support case-insensitive key checks

This also moves the logic to make the Softlayer tags all lower case to one
common place; allowing the code to process tags generically and then we
manipulate at the end.

Closes #546

Signed-off-by: Steven Kaufer <[email protected]>

Author: kaufers

examples/instance/terraform/plugin.go

@@ -362,25 +362,28 @@ func (p *plugin) Provision(spec instance.Spec) (*instance.ID, error) {
 		return nil, fmt.Errorf("no-vm-instance-in-spec")
 	}
 
-	// set the tags.
-	// add a name
+	// Add the name to the tags if it does not exist, issue case-insensitive
+	// check for the "name" key
 	if spec.Tags != nil {
-		switch vmType {
-		case VMSoftLayer:
-			// Set the "name" tag to be lowercase to meet platform requirements
-			if _, has := spec.Tags["name"]; !has {
-				spec.Tags["name"] = string(id)
-			}
-		default:
-			// Set the first character of the "Name" tag to be uppercase to meet platform requirements
-			if _, has := spec.Tags["Name"]; !has {
-				spec.Tags["Name"] = string(id)
+		match := false
+		for key := range spec.Tags {
+			if strings.ToLower(key) == "name" {
+				match = true
+				break
 			}
 		}
+		if !match {
+			spec.Tags["Name"] = string(id)
+		}
+	}
+	// Use tag to store the logical id
+	if spec.LogicalID != nil {
+		spec.Tags["LogicalID"] = string(*spec.LogicalID)
 	}
 
 	p.optionalProcessHostname(vmType, TResourceName(name), properties)
 
+	// Merge any user-defined tags and convert to platform specific tag type
 	switch vmType {
 	case VMAmazon, VMAzure, VMDigitalOcean, VMGoogleCloud:
 		if t, exists := properties["tags"]; !exists {
@@ -402,12 +405,6 @@ func (p *plugin) Provision(spec instance.Spec) (*instance.ID, error) {
 		}
 	}
 
-	// Use tag to store the logical id
-	if spec.LogicalID != nil {
-		if m, ok := properties["tags"].(map[string]interface{}); ok {
-			m["LogicalID"] = string(*spec.LogicalID)
-		}
-	}
 	switch vmType {
 	case VMAmazon:
 		if p, exists := properties["private_ip"]; exists {
@@ -444,6 +441,16 @@ func (p *plugin) Provision(spec instance.Spec) (*instance.ID, error) {
 		addUserData(properties, "metadata_startup_script", spec.Init)
 	}
 
+	// On Softlayer the tags must be lowercase
+	switch vmType {
+	case VMSoftLayer:
+		tagsLower := []string{}
+		for _, val := range properties["tags"].([]string) {
+			tagsLower = append(tagsLower, strings.ToLower(val))
+		}
+		properties["tags"] = tagsLower
+	}
+
 	// Write out each resource again with the instance name
 	for resourceType, resourceObj := range tf.Resource {
 		vmList := mapset.NewSetFromSlice(VMTypes)
@@ -656,19 +663,29 @@ func terraformTags(m TResourceProperties, key string) map[string]string {
 	}
 	return tags
 }
-func terraformLogicalID(v interface{}) *instance.LogicalID {
-	m, ok := v.(map[string]interface{})
-	if !ok {
-		return nil
-	}
-	tags, ok := m["tags"].(map[string]interface{})
-	if !ok {
-		return nil
-	}
-	v, exists := tags["LogicalID"]
-	if exists {
-		id := instance.LogicalID(fmt.Sprintf("%v", v))
-		return &id
+
+// terraformLogicalID parses the LogicalID (case insensitive key check) from
+// either the map of tags or the list of tags
+func terraformLogicalID(props TResourceProperties) *instance.LogicalID {
+	if propsTag, ok := props["tags"]; ok {
+		if tagsMap, ok := propsTag.(map[string]interface{}); ok {
+			for key, val := range tagsMap {
+				if strings.ToLower(key) == "logicalid" {
+					id := instance.LogicalID(fmt.Sprintf("%v", val))
+					return &id
+				}
+			}
+		} else if tagsList, ok := propsTag.([]interface{}); ok {
+			for _, tag := range tagsList {
+				if tagString, ok := tag.(string); ok {
+					if strings.HasPrefix(strings.ToLower(tagString), "logicalid:") {
+						logicalID := strings.SplitN(strings.ToLower(tagString), ":", 2)[1]
+						id := instance.LogicalID(fmt.Sprintf("%v", logicalID))
+						return &id
+					}
+				}
+			}
+		}
 	}
 	return nil
 }

examples/instance/terraform/plugin_test.go

@@ -182,14 +182,17 @@ func run(t *testing.T, resourceType, properties string) {
 	require.NoError(t, err)
 
 	// Instance with tags that will not be updated
+	logicalID1 := instance.LogicalID("logical.id-1")
 	instanceSpec1 := instance.Spec{
 		Properties: config,
 		Tags: map[string]string{
 			"label1": "value1",
 			"label2": "value2",
+			"LABEL3": "VALUE3",
 		},
 		Init:        "",
 		Attachments: []instance.Attachment{},
+		LogicalID:   &logicalID1,
 	}
 	id1, err := terraform.Provision(instanceSpec1)
 	require.NoError(t, err)
@@ -198,6 +201,7 @@ func run(t *testing.T, resourceType, properties string) {
 	require.NoError(t, err)
 
 	// Instance with tags that will be updated
+	logicalID2 := instance.LogicalID("logical:id-2")
 	instanceSpec2 := instance.Spec{
 		Properties: config,
 		Tags: map[string]string{
@@ -211,6 +215,7 @@ func run(t *testing.T, resourceType, properties string) {
 				Type: "ebs",
 			},
 		},
+		LogicalID: &logicalID2,
 	}
 	id2, err := terraform.Provision(instanceSpec2)
 	require.NoError(t, err)
@@ -250,6 +255,7 @@ func run(t *testing.T, resourceType, properties string) {
 				"label1:value1",
 				"label2:value2",
 				"name:" + string(*id2),
+				"logicalid:logical:id-2",
 			}), conv(props["tags"].([]interface{})))
 			require.Equal(t, expectedUserData2, props["user_metadata"])
 
@@ -271,6 +277,7 @@ func run(t *testing.T, resourceType, properties string) {
 				"label1":         "value1",
 				"label2":         "value2",
 				"Name":           string(*id2),
+				"LogicalID":      "logical:id-2",
 			}, props["tags"])
 			require.Equal(t, base64.StdEncoding.EncodeToString([]byte(expectedUserData2)), props["user_data"])
 
@@ -305,8 +312,11 @@ func run(t *testing.T, resourceType, properties string) {
 				"terraform_demo_swarm_mgr_sl": "",
 				"label1":                      "value1",
 				"label2":                      "value2",
+				"label3":                      "value3",
 				"name":                        string(*id1),
+				"logicalid":                   "logical.id-1",
 			},
+			LogicalID: &logicalID1,
 		}
 		inst2 = instance.Description{
 			ID: *id2,
@@ -315,7 +325,9 @@ func run(t *testing.T, resourceType, properties string) {
 				"label1":                      "value1",
 				"label2":                      "value2",
 				"name":                        string(*id2),
+				"logicalid":                   "logical:id-2",
 			},
+			LogicalID: &logicalID2,
 		}
 	case VMAmazon:
 		inst1 = instance.Description{
@@ -324,8 +336,11 @@ func run(t *testing.T, resourceType, properties string) {
 				"InstancePlugin": "terraform",
 				"label1":         "value1",
 				"label2":         "value2",
+				"LABEL3":         "VALUE3",
 				"Name":           string(*id1),
+				"LogicalID":      "logical.id-1",
 			},
+			LogicalID: &logicalID1,
 		}
 		inst2 = instance.Description{
 			ID: *id2,
@@ -334,7 +349,9 @@ func run(t *testing.T, resourceType, properties string) {
 				"label1":         "value1",
 				"label2":         "value2",
 				"Name":           string(*id2),
+				"LogicalID":      "logical:id-2",
 			},
+			LogicalID: &logicalID2,
 		}
 	}
 
@@ -370,6 +387,7 @@ func run(t *testing.T, resourceType, properties string) {
 			"label2:value2",
 			"label3:value3",
 			"name:" + string(*id2),
+			"logicalid:logical:id-2",
 		}), conv(props["tags"].([]interface{})))
 	case VMAmazon:
 		require.Equal(t, map[string]interface{}{
@@ -378,6 +396,7 @@ func run(t *testing.T, resourceType, properties string) {
 			"label2":         "value2",
 			"label3":         "value3",
 			"Name":           string(*id2),
+			"LogicalID":      "logical:id-2",
 		}, props["tags"])
 	}