add: name and tag fields into output

After some testing in lab I decided that some additional info about found VM will be useful (to add source image name into notes or copy tags from source).

Author: castorsky

.web-docs/components/data-source/template/README.md

@@ -78,14 +78,18 @@ When datasource cannot return only one (zero or >1) guest identifiers it will re
 
 - `vm_id` (uint) - Identifier of the found guest.
 
+- `vm_name` (string) - Name of the found guest.
+
+- `vm_tags` (string) - Tags of the found guest separated with semicolon.
+
 <!-- End of code generated from the comments of the DatasourceOutput struct in datasource/proxmox/data.go; -->
 
 
 ## Example Usage
 
-This is a very basic example which connects to localhost, finds the latest guest
-which name matches the regex `image-.*` and which type is `template`. The ID is
-then printed to console as output variable.
+This is a very basic example which connects to local PVE host, finds the latest
+guest which name matches the regex `image-.*` and which type is `template`. The
+ID is then printed to console as output variable.
 
 ```hcl
 data "proxmox-template" "default" {
@@ -117,5 +121,4 @@ build {
     ]
   }
 }
-
 ```

datasource/proxmox/data.go

@@ -91,6 +91,10 @@ type Datasource struct {
 type DatasourceOutput struct {
 	// Identifier of the found guest.
 	VmId uint `mapstructure:"vm_id"`
+	// Name of the found guest.
+	VmName string `mapstructure:"vm_name"`
+	// Tags of the found guest separated with semicolon.
+	VmTags string `mapstructure:"vm_tags"`
 }
 
 type vmConfig map[string]interface{}
@@ -162,6 +166,7 @@ func (d *Datasource) OutputSpec() hcldec.ObjectSpec {
 func (d *Datasource) Execute() (cty.Value, error) {
 	// This value of VM ID the function should return
 	var vmId uint
+	var vmName, vmTags string
 
 	client, err := newProxmoxClient(d.config)
 	if err != nil {
@@ -190,15 +195,21 @@ func (d *Datasource) Execute() (cty.Value, error) {
 		}
 
 		vmId = latestConfig["vmid"].(uint)
+		vmName = latestConfig["name"].(string)
+		vmTags = latestConfig["tags"].(string)
 	} else {
 		if len(filteredVms) > 1 {
 			return cty.NullVal(cty.EmptyObject), errors.New("more than one guest passed filters, cannot return vm_id")
 		}
 		vmId = filteredVms[0].Id
+		vmName = filteredVms[0].Name
+		vmTags = joinTags(filteredVms[0].Tags, ";")
 	}
 
 	output := DatasourceOutput{
-		VmId: vmId,
+		VmId:   vmId,
+		VmName: vmName,
+		VmTags: vmTags,
 	}
 	return hcl2helper.HCL2ValueFromConfig(output, d.OutputSpec()), nil
 }
@@ -391,3 +402,11 @@ func parseMetaField(field string) (int, error) {
 	}
 	return value, nil
 }
+
+func joinTags(tags []proxmox.Tag, separator string) string {
+	tagsAsStrings := make([]string, len(tags))
+	for i, tag := range tags {
+		tagsAsStrings[i] = string(tag)
+	}
+	return strings.Join(tagsAsStrings, separator)
+}

datasource/proxmox/data.hcl2spec.go

@@ -166,6 +166,9 @@ func TestExecute(t *testing.T) {
 			}
 			if err == nil {
 				vmIdInt64, _ := result.GetAttr("vm_id").AsBigFloat().Int64()
+				vmName := result.GetAttr("vm_name").AsString()
+				vmTags := result.GetAttr("vm_tags").AsString()
+				t.Logf("Returned: vmId=%d, vmName=%s, vmTags=%s", vmIdInt64, vmName, vmTags)
 				require.Equal(t, dsTestConfig.expectedVmId, vmIdInt64)
 			}
 		})

datasource/proxmox/data_test.go

@@ -2,4 +2,8 @@
 
 - `vm_id` (uint) - Identifier of the found guest.
 
+- `vm_name` (string) - Name of the found guest.
+
+- `vm_tags` (string) - Tags of the found guest separated with semicolon.
+
 <!-- End of code generated from the comments of the DatasourceOutput struct in datasource/proxmox/data.go; -->