From b287022e797b0a5718f83c62f36f6bdf0b929817 Mon Sep 17 00:00:00 2001 From: Catalin Muresan Date: Mon, 23 Oct 2023 19:17:39 +0100 Subject: [PATCH 01/16] Initial commit libvirt_nodeinfo --- libvirt/data_source_libvirt_nodeinfo.go | 91 +++++++++++++++++++++++++ libvirt/provider.go | 1 + 2 files changed, 92 insertions(+) create mode 100644 libvirt/data_source_libvirt_nodeinfo.go diff --git a/libvirt/data_source_libvirt_nodeinfo.go b/libvirt/data_source_libvirt_nodeinfo.go new file mode 100644 index 000000000..373231200 --- /dev/null +++ b/libvirt/data_source_libvirt_nodeinfo.go @@ -0,0 +1,91 @@ +package libvirt + +import ( + "fmt" + "log" + "strconv" + + "github.com/dmacvicar/terraform-provider-libvirt/libvirt/helper/hashcode" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" +) + +// a libvirt nodeinfo datasource +// +// Datasource example: +// +// data "libvirt_nodeinfo" "info" { +// } +// +// output "cpus" { +// value = data.libvirt_nodeinfo.info.cpus +// } +func datasourceLibvirtNodeInfo() *schema.Resource { + return &schema.Resource{ + Read: resourceLibvirtNodeInfoRead, + Schema: map[string]*schema.Schema{ + "cpu_model": { + Type: schema.TypeString, + Computed: true, + }, + "memory_total": { + Type: schema.TypeInt, + Computed: true, + }, + "cpu_cores_total": { + Type: schema.TypeInt, + Computed: true, + }, + "numa_nodes": { + Type: schema.TypeInt, + Computed: true, + }, + "cpu_sockets": { + Type: schema.TypeInt, + Computed: true, + }, + "cpu_cores_per_socket": { + Type: schema.TypeInt, + Computed: true, + }, + "cpu_threads_per_core": { + Type: schema.TypeInt, + Computed: true, + }, + }, + } +} + +func resourceLibvirtNodeInfoRead(d *schema.ResourceData, meta interface{}) error { + log.Printf("[DEBUG] Read data source libvirt_nodeinfo") + + virConn := meta.(*Client).libvirt + if virConn == nil { + return fmt.Errorf(LibVirtConIsNil) + } + + model, memory, cpus, _, nodes, sockets, cores, threads, err := virConn.NodeGetInfo() + + if err != nil { + return fmt.Errorf("failed to retrieve domains: %v", err) + } + + d.Set("cpu_model", Int8ToString(model)) + d.Set("cpu_cores_total", cpus) + d.Set("cpu_cores_per_socket", cores) + d.Set("numa_nodes", nodes) + d.Set("cpu_sockets", sockets) + d.Set("cpu_threads_per_core", threads) + d.Set("numa_nodes", nodes) + d.Set("memory_total", memory) + d.SetId(strconv.Itoa(hashcode.String(fmt.Sprintf("%v%v%v%v%v%v%v", model, memory, cpus, nodes, sockets, cores, threads)))) + + return nil +} + +func Int8ToString(bs [32]int8) string { + ba := []uint8{} + for _, b := range bs { + ba = append(ba, uint8(b)) + } + return string(ba) +} \ No newline at end of file diff --git a/libvirt/provider.go b/libvirt/provider.go index 81bb05d03..c5e1216ed 100644 --- a/libvirt/provider.go +++ b/libvirt/provider.go @@ -31,6 +31,7 @@ func Provider() *schema.Provider { "libvirt_network_dns_host_template": datasourceLibvirtNetworkDNSHostTemplate(), "libvirt_network_dns_srv_template": datasourceLibvirtNetworkDNSSRVTemplate(), "libvirt_network_dnsmasq_options_template": datasourceLibvirtNetworkDnsmasqOptionsTemplate(), + "libvirt_nodeinfo": datasourceLibvirtNodeInfo(), }, ConfigureFunc: providerConfigure, From e03a29421f9a89214cf828389c34aca65d9160f5 Mon Sep 17 00:00:00 2001 From: Catalin Muresan Date: Tue, 24 Oct 2023 02:43:01 +0100 Subject: [PATCH 02/16] Added support for reading node devices and node device info --- libvirt/data_source_libvirt_nodedeviceinfo.go | 76 +++++++++++++++++++ libvirt/data_source_libvirt_nodedevices.go | 66 ++++++++++++++++ libvirt/provider.go | 2 + 3 files changed, 144 insertions(+) create mode 100644 libvirt/data_source_libvirt_nodedeviceinfo.go create mode 100644 libvirt/data_source_libvirt_nodedevices.go diff --git a/libvirt/data_source_libvirt_nodedeviceinfo.go b/libvirt/data_source_libvirt_nodedeviceinfo.go new file mode 100644 index 000000000..510d6176a --- /dev/null +++ b/libvirt/data_source_libvirt_nodedeviceinfo.go @@ -0,0 +1,76 @@ +package libvirt + +import ( + "fmt" + "log" + "strconv" + + "github.com/dmacvicar/terraform-provider-libvirt/libvirt/helper/hashcode" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" +) + +// a libvirt nodeinfo datasource +// +// Datasource example: +// +// data "libvirt_nodeinfo" "info" { +// } +// +// output "cpus" { +// value = data.libvirt_nodeinfo.info.cpus +// } +func datasourceLibvirtNodeDeviceInfo() *schema.Resource { + return &schema.Resource{ + Read: resourceLibvirtNodeDeviceInfoRead, + Schema: map[string]*schema.Schema{ + "name": { + Type: schema.TypeString, + Required: true, + }, + "path": { + Type: schema.TypeString, + Computed: true, + }, + "parent": { + Type: schema.TypeString, + Computed: true, + }, + "xml": { + Type: schema.TypeString, + Computed: true, + }, + }, + } +} + +func resourceLibvirtNodeDeviceInfoRead(d *schema.ResourceData, meta interface{}) error { + log.Printf("[DEBUG] Read data source libvirt_nodedevices") + + virConn := meta.(*Client).libvirt + if virConn == nil { + return fmt.Errorf(LibVirtConIsNil) + } + + var device_name string + + if name, ok := d.GetOk("name"); ok { + device_name = name.(string) + log.Printf("[DEBUG] Got name: %s", device_name) + } + + device, err := virConn.NodeDeviceLookupByName(device_name) + if err != nil { + return fmt.Errorf("failed to lookup node device: %v", err) + } + + xml, err := virConn.NodeDeviceGetXMLDesc(device.Name, 0) + if err != nil { + return fmt.Errorf("failed to get XML for node device: %v", err) + } + + d.Set("xml", xml) + //d.Set("devices", ) + d.SetId(strconv.Itoa(hashcode.String(fmt.Sprintf("%v", xml)))) + + return nil +} diff --git a/libvirt/data_source_libvirt_nodedevices.go b/libvirt/data_source_libvirt_nodedevices.go new file mode 100644 index 000000000..bb6a7faf4 --- /dev/null +++ b/libvirt/data_source_libvirt_nodedevices.go @@ -0,0 +1,66 @@ +package libvirt + +import ( + "fmt" + "log" + "strconv" + + libvirt "github.com/digitalocean/go-libvirt" + "github.com/dmacvicar/terraform-provider-libvirt/libvirt/helper/hashcode" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" +) + +// a libvirt nodeinfo datasource +// +// Datasource example: +// +// data "libvirt_nodeinfo" "info" { +// } +// +// output "cpus" { +// value = data.libvirt_nodeinfo.info.cpus +// } +func datasourceLibvirtNodeDevices() *schema.Resource { + return &schema.Resource{ + Read: resourceLibvirtNodeDevicesRead, + Schema: map[string]*schema.Schema{ + // "name": { + // Type: schema.TypeString, + // Required: true, + // }, + "devices": { + Type: schema.TypeList, + Computed: true, + Elem: &schema.Schema{ + Type: schema.TypeString, + }, + }, + }, + } +} + +func resourceLibvirtNodeDevicesRead(d *schema.ResourceData, meta interface{}) error { + log.Printf("[DEBUG] Read data source libvirt_nodedevices") + + virConn := meta.(*Client).libvirt + if virConn == nil { + return fmt.Errorf(LibVirtConIsNil) + } + + opts := libvirt.OptString{"pci"} + + rnum, err := virConn.NodeNumOfDevices(opts, 0) + if err != nil { + return fmt.Errorf("failed to retrieve number of devices: %v", err) + } + + devices, err := virConn.NodeListDevices(opts, rnum, 0) + if err != nil { + return fmt.Errorf("failed to retrieve list of node devices: %v", err) + } + + d.Set("devices", devices) + d.SetId(strconv.Itoa(hashcode.String(fmt.Sprintf("%v", devices)))) + + return nil +} diff --git a/libvirt/provider.go b/libvirt/provider.go index c5e1216ed..799438673 100644 --- a/libvirt/provider.go +++ b/libvirt/provider.go @@ -32,6 +32,8 @@ func Provider() *schema.Provider { "libvirt_network_dns_srv_template": datasourceLibvirtNetworkDNSSRVTemplate(), "libvirt_network_dnsmasq_options_template": datasourceLibvirtNetworkDnsmasqOptionsTemplate(), "libvirt_nodeinfo": datasourceLibvirtNodeInfo(), + "libvirt_nodedeviceinfo": datasourceLibvirtNodeDeviceInfo(), + "libvirt_nodedevices": datasourceLibvirtNodeDevices(), }, ConfigureFunc: providerConfigure, From 72e842911d79168ba74067410389e37cef12a3a9 Mon Sep 17 00:00:00 2001 From: Catalin Muresan Date: Tue, 24 Oct 2023 14:53:33 +0100 Subject: [PATCH 03/16] Add support to parse device XML to extract into to attributes --- .../data_source_libvirt_node_device_info.go | 183 ++++++++++++++++++ ...go => data_source_libvirt_node_devices.go} | 25 ++- ...fo.go => data_source_libvirt_node_info.go} | 22 +-- libvirt/data_source_libvirt_nodedeviceinfo.go | 76 -------- libvirt/provider.go | 6 +- 5 files changed, 212 insertions(+), 100 deletions(-) create mode 100644 libvirt/data_source_libvirt_node_device_info.go rename libvirt/{data_source_libvirt_nodedevices.go => data_source_libvirt_node_devices.go} (70%) rename libvirt/{data_source_libvirt_nodeinfo.go => data_source_libvirt_node_info.go} (85%) delete mode 100644 libvirt/data_source_libvirt_nodedeviceinfo.go diff --git a/libvirt/data_source_libvirt_node_device_info.go b/libvirt/data_source_libvirt_node_device_info.go new file mode 100644 index 000000000..d6d01f333 --- /dev/null +++ b/libvirt/data_source_libvirt_node_device_info.go @@ -0,0 +1,183 @@ +package libvirt + +import ( + "encoding/xml" + "fmt" + "log" + "strconv" + + "github.com/dmacvicar/terraform-provider-libvirt/libvirt/helper/hashcode" + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" +) + +// strutures to parse device XML +type Device struct { + Device xml.Name `xml:"device"` + Name string `xml:"name"` + Path string `xml:"path"` + Parent string `xml:"parent"` + Capability Capability `xml:"capability"` +} + +type Capability struct { + Capability xml.Name `xml:"capability"` + Type string `xml:"type,attr"` + // PCI + Class string `xml:"class"` + Domain int `xml:"domain"` + Bus int `xml:"bus"` + Slot int `xml:"slot"` + Function int `xml:"function"` + Product Product `xml:"product"` + Vendor Vendor `xml:"vendor"` + IommuGroup IommuGroup `xml:"iommuGroup"` + // STORAGE + Block string `xml:"block"` + DriveType string `xml:"drive_type"` + Model string `xml:"model"` + Serial string `xml:"serial"` + Size int `xml:"size"` + LogicalBlockSize int `xml:"logical_block_size"` + NumBlocks int `xml:"num_blocks"` + // USB + Number int `xml:"number"` + Subclass int `xml:"subclass"` + Protocol int `xml:"protocol"` +} + +type Product struct { + Name string `xml:",chardata"` + Id string `xml:"id,attr"` +} + +type Vendor struct { + Name string `xml:",chardata"` + Id string `xml:"id,attr"` +} + +type IommuGroup struct { + IommuGroup xml.Name `xml:"iommuGroup"` + Number int `xml:"number,attr"` + Addresses []Address `xml:"address"` +} + +type Address struct { + Address xml.Name `xml:"address"` + Domain string `xml:"domain,attr"` + Bus string `xml:"bus,attr"` + Slot string `xml:"slot,attr"` + Function string `xml:"function,attr"` +} + +// a libvirt nodeinfo datasource +// +// Datasource example: +// +// data "libvirt_node_device_info" "info" { +// } +// +// output "cpus" { +// value = data.libvirt_node_device_info.info.xml +// } +func datasourceLibvirtNodeDeviceInfo() *schema.Resource { + return &schema.Resource{ + Read: resourceLibvirtNodeDeviceInfoRead, + Schema: map[string]*schema.Schema{ + "name": { + Type: schema.TypeString, + Required: true, + }, + "path": { + Type: schema.TypeString, + Computed: true, + }, + "parent": { + Type: schema.TypeString, + Computed: true, + }, + "xml": { + Type: schema.TypeString, + Computed: true, + }, + "capability": { + Type: schema.TypeMap, + Computed: true, + }, + }, + } +} + +func resourceLibvirtNodeDeviceInfoRead(d *schema.ResourceData, meta interface{}) error { + log.Printf("[DEBUG] Read data source libvirt_nodedevices") + + virConn := meta.(*Client).libvirt + if virConn == nil { + return fmt.Errorf(LibVirtConIsNil) + } + + var device_name string + + if name, ok := d.GetOk("name"); ok { + device_name = name.(string) + log.Printf("[DEBUG] Got name: %s", device_name) + } + + device, err := virConn.NodeDeviceLookupByName(device_name) + if err != nil { + return fmt.Errorf("failed to lookup node device: %v", err) + } + + xml_desc, err := virConn.NodeDeviceGetXMLDesc(device.Name, 0) + if err != nil { + return fmt.Errorf("failed to get XML for node device: %v", err) + } + + var device_xml Device + + err = xml.Unmarshal([]byte(xml_desc), &device_xml) + if err != nil { + log.Fatalf("failed to unmarshal device_xml into XML: %v", err) + } + + capability := map[string]interface{}{} + if device_xml.Capability.Type == "pci" { + capability["type"] = device_xml.Capability.Type + capability["class"] = device_xml.Capability.Class + capability["domain"] = fmt.Sprintf("%d", device_xml.Capability.Domain) + capability["bus"] = fmt.Sprintf("%d", device_xml.Capability.Bus) + capability["slot"] = fmt.Sprintf("%d", device_xml.Capability.Slot) + capability["function"] = fmt.Sprintf("%d", device_xml.Capability.Function) + capability["product_id"] = device_xml.Capability.Product.Id + capability["product_name"] = device_xml.Capability.Product.Name + capability["vendor_id"] = device_xml.Capability.Vendor.Id + capability["vendor_name"] = device_xml.Capability.Vendor.Name + capability["iommu_group_number"] = fmt.Sprintf("%d", device_xml.Capability.IommuGroup.Number) + } + + if device_xml.Capability.Type == "storage" { + capability["type"] = device_xml.Capability.Type + capability["block"] = device_xml.Capability.Block + capability["drive_type"] = device_xml.Capability.DriveType + capability["mode"] = device_xml.Capability.Model + capability["serial"] = device_xml.Capability.Serial + capability["size"] = fmt.Sprintf("%d", device_xml.Capability.Size) + capability["logical_block_size"] = fmt.Sprintf("%d", device_xml.Capability.LogicalBlockSize) + capability["num_blocks"] = fmt.Sprintf("%d", device_xml.Capability.NumBlocks) + } + + if device_xml.Capability.Type == "usb" { + capability["type"] = device_xml.Capability.Type + capability["number"] = fmt.Sprintf("%d", device_xml.Capability.Number) + capability["class"] = device_xml.Capability.Class + capability["subclass"] = fmt.Sprintf("%d", device_xml.Capability.Subclass) + capability["protocol"] = fmt.Sprintf("%d", device_xml.Capability.Protocol) + } + + d.Set("xml", xml_desc) + d.Set("path", device_xml.Path) + d.Set("parent", device_xml.Parent) + d.Set("capability", capability) + d.SetId(strconv.Itoa(hashcode.String(fmt.Sprintf("%v", xml_desc)))) + + return nil +} diff --git a/libvirt/data_source_libvirt_nodedevices.go b/libvirt/data_source_libvirt_node_devices.go similarity index 70% rename from libvirt/data_source_libvirt_nodedevices.go rename to libvirt/data_source_libvirt_node_devices.go index bb6a7faf4..ce6e9bf5d 100644 --- a/libvirt/data_source_libvirt_nodedevices.go +++ b/libvirt/data_source_libvirt_node_devices.go @@ -14,24 +14,24 @@ import ( // // Datasource example: // -// data "libvirt_nodeinfo" "info" { +// data "libvirt_node_devices" "list" { // } // // output "cpus" { -// value = data.libvirt_nodeinfo.info.cpus +// value = data.libvirt_node_devices.list.devices // } func datasourceLibvirtNodeDevices() *schema.Resource { return &schema.Resource{ Read: resourceLibvirtNodeDevicesRead, Schema: map[string]*schema.Schema{ - // "name": { - // Type: schema.TypeString, - // Required: true, - // }, + "capability": { + Type: schema.TypeString, + Optional: true, + }, "devices": { Type: schema.TypeList, Computed: true, - Elem: &schema.Schema{ + Elem: &schema.Schema{ Type: schema.TypeString, }, }, @@ -47,14 +47,19 @@ func resourceLibvirtNodeDevicesRead(d *schema.ResourceData, meta interface{}) er return fmt.Errorf(LibVirtConIsNil) } - opts := libvirt.OptString{"pci"} + var cap libvirt.OptString + + if capability, ok := d.GetOk("capability"); ok { + cap = append(cap, capability.(string)) + log.Printf("[DEBUG] Got capability: %v", cap) + } - rnum, err := virConn.NodeNumOfDevices(opts, 0) + rnum, err := virConn.NodeNumOfDevices(libvirt.OptString(cap), 0) if err != nil { return fmt.Errorf("failed to retrieve number of devices: %v", err) } - devices, err := virConn.NodeListDevices(opts, rnum, 0) + devices, err := virConn.NodeListDevices(cap, rnum, 0) if err != nil { return fmt.Errorf("failed to retrieve list of node devices: %v", err) } diff --git a/libvirt/data_source_libvirt_nodeinfo.go b/libvirt/data_source_libvirt_node_info.go similarity index 85% rename from libvirt/data_source_libvirt_nodeinfo.go rename to libvirt/data_source_libvirt_node_info.go index 373231200..5d53e083e 100644 --- a/libvirt/data_source_libvirt_nodeinfo.go +++ b/libvirt/data_source_libvirt_node_info.go @@ -24,31 +24,31 @@ func datasourceLibvirtNodeInfo() *schema.Resource { Read: resourceLibvirtNodeInfoRead, Schema: map[string]*schema.Schema{ "cpu_model": { - Type: schema.TypeString, + Type: schema.TypeString, Computed: true, }, - "memory_total": { - Type: schema.TypeInt, + "memory_total_kb": { + Type: schema.TypeInt, Computed: true, }, "cpu_cores_total": { - Type: schema.TypeInt, + Type: schema.TypeInt, Computed: true, }, "numa_nodes": { - Type: schema.TypeInt, + Type: schema.TypeInt, Computed: true, }, "cpu_sockets": { - Type: schema.TypeInt, + Type: schema.TypeInt, Computed: true, }, "cpu_cores_per_socket": { - Type: schema.TypeInt, + Type: schema.TypeInt, Computed: true, }, "cpu_threads_per_core": { - Type: schema.TypeInt, + Type: schema.TypeInt, Computed: true, }, }, @@ -76,7 +76,7 @@ func resourceLibvirtNodeInfoRead(d *schema.ResourceData, meta interface{}) error d.Set("cpu_sockets", sockets) d.Set("cpu_threads_per_core", threads) d.Set("numa_nodes", nodes) - d.Set("memory_total", memory) + d.Set("memory_total_kb", memory) d.SetId(strconv.Itoa(hashcode.String(fmt.Sprintf("%v%v%v%v%v%v%v", model, memory, cpus, nodes, sockets, cores, threads)))) return nil @@ -85,7 +85,7 @@ func resourceLibvirtNodeInfoRead(d *schema.ResourceData, meta interface{}) error func Int8ToString(bs [32]int8) string { ba := []uint8{} for _, b := range bs { - ba = append(ba, uint8(b)) + ba = append(ba, uint8(b)) } return string(ba) -} \ No newline at end of file +} diff --git a/libvirt/data_source_libvirt_nodedeviceinfo.go b/libvirt/data_source_libvirt_nodedeviceinfo.go deleted file mode 100644 index 510d6176a..000000000 --- a/libvirt/data_source_libvirt_nodedeviceinfo.go +++ /dev/null @@ -1,76 +0,0 @@ -package libvirt - -import ( - "fmt" - "log" - "strconv" - - "github.com/dmacvicar/terraform-provider-libvirt/libvirt/helper/hashcode" - "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" -) - -// a libvirt nodeinfo datasource -// -// Datasource example: -// -// data "libvirt_nodeinfo" "info" { -// } -// -// output "cpus" { -// value = data.libvirt_nodeinfo.info.cpus -// } -func datasourceLibvirtNodeDeviceInfo() *schema.Resource { - return &schema.Resource{ - Read: resourceLibvirtNodeDeviceInfoRead, - Schema: map[string]*schema.Schema{ - "name": { - Type: schema.TypeString, - Required: true, - }, - "path": { - Type: schema.TypeString, - Computed: true, - }, - "parent": { - Type: schema.TypeString, - Computed: true, - }, - "xml": { - Type: schema.TypeString, - Computed: true, - }, - }, - } -} - -func resourceLibvirtNodeDeviceInfoRead(d *schema.ResourceData, meta interface{}) error { - log.Printf("[DEBUG] Read data source libvirt_nodedevices") - - virConn := meta.(*Client).libvirt - if virConn == nil { - return fmt.Errorf(LibVirtConIsNil) - } - - var device_name string - - if name, ok := d.GetOk("name"); ok { - device_name = name.(string) - log.Printf("[DEBUG] Got name: %s", device_name) - } - - device, err := virConn.NodeDeviceLookupByName(device_name) - if err != nil { - return fmt.Errorf("failed to lookup node device: %v", err) - } - - xml, err := virConn.NodeDeviceGetXMLDesc(device.Name, 0) - if err != nil { - return fmt.Errorf("failed to get XML for node device: %v", err) - } - - d.Set("xml", xml) - //d.Set("devices", ) - d.SetId(strconv.Itoa(hashcode.String(fmt.Sprintf("%v", xml)))) - - return nil -} diff --git a/libvirt/provider.go b/libvirt/provider.go index 799438673..f7720138a 100644 --- a/libvirt/provider.go +++ b/libvirt/provider.go @@ -31,9 +31,9 @@ func Provider() *schema.Provider { "libvirt_network_dns_host_template": datasourceLibvirtNetworkDNSHostTemplate(), "libvirt_network_dns_srv_template": datasourceLibvirtNetworkDNSSRVTemplate(), "libvirt_network_dnsmasq_options_template": datasourceLibvirtNetworkDnsmasqOptionsTemplate(), - "libvirt_nodeinfo": datasourceLibvirtNodeInfo(), - "libvirt_nodedeviceinfo": datasourceLibvirtNodeDeviceInfo(), - "libvirt_nodedevices": datasourceLibvirtNodeDevices(), + "libvirt_node_info": datasourceLibvirtNodeInfo(), + "libvirt_node_device_info": datasourceLibvirtNodeDeviceInfo(), + "libvirt_node_devices": datasourceLibvirtNodeDevices(), }, ConfigureFunc: providerConfigure, From c12cade66ba40191d593f701715c10cb9eb8372b Mon Sep 17 00:00:00 2001 From: Catalin Muresan Date: Tue, 24 Oct 2023 16:46:20 +0100 Subject: [PATCH 04/16] Added documentation for the data sources --- .../data_source_libvirt_node_device_info.go | 2 +- website/docs/d/node_device_info.html.markdown | 62 +++++++++++++++++++ website/docs/d/node_devices.html.markdown | 33 ++++++++++ website/docs/d/node_info.html.markdown | 35 +++++++++++ website/docs/data_sources.html.markdown | 9 +++ website/docs/toc.html.markdown | 1 + website/libvirt.erb | 9 +++ 7 files changed, 150 insertions(+), 1 deletion(-) create mode 100644 website/docs/d/node_device_info.html.markdown create mode 100644 website/docs/d/node_devices.html.markdown create mode 100644 website/docs/d/node_info.html.markdown create mode 100644 website/docs/data_sources.html.markdown diff --git a/libvirt/data_source_libvirt_node_device_info.go b/libvirt/data_source_libvirt_node_device_info.go index d6d01f333..cace62ba9 100644 --- a/libvirt/data_source_libvirt_node_device_info.go +++ b/libvirt/data_source_libvirt_node_device_info.go @@ -76,7 +76,7 @@ type Address struct { // data "libvirt_node_device_info" "info" { // } // -// output "cpus" { +// output "xml" { // value = data.libvirt_node_device_info.info.xml // } func datasourceLibvirtNodeDeviceInfo() *schema.Resource { diff --git a/website/docs/d/node_device_info.html.markdown b/website/docs/d/node_device_info.html.markdown new file mode 100644 index 000000000..62afab531 --- /dev/null +++ b/website/docs/d/node_device_info.html.markdown @@ -0,0 +1,62 @@ +--- +layout: "libvirt" +page_title: "Libvirt: libvirt_node_device_info" +sidebar_current: "docs-libvirt-node-device-info" +description: |- + Use this data source to get information about a specific device on the current node +--- + +# Data Source: libvirt\_node\_device\_info + +Retrieve information about a specific device on the current node + +## Example Usage + +```hcl +data "libvirt_node_device_info" "device" { + name = "pci_0000_00_00_0" +} +``` + +## Argument Reference + +* `name` - (Required) The name of the device name as expected by [libvirt](https://www.libvirt.org/manpages/virsh.html#nodedev-commands). + +## Attribute Reference + +This data source exports the following attributes in addition to the arguments above: + +* `capability` - A map of the various attributes for the device, depending on the type of device. + Currently implemented are `pci`, `storage`, `usb` + * `type` - Device type: `pci`, `storage`, `usb` + + For `pci` devices the attributes are: + * `class` - Device PCI class + * `domain` - Device PCI domain + * `bus` - Device PCI bus + * `slot` - Device PCI slot + * `function` - Device PCI function + * `product_id` - Device PCI product id + * `product_name` - Device PCI product name + * `vendor_id` - Device PCI product id + * `vendor_name` - Device PCI product name + * `iommu_group_number` - IOMMU Group number for the device + + For `storage` devices the attributes are: + * `block`: Block device name + * `drive_type`: Device drive type + * `model`: Device model + * `serial`: Device serial number + * `size`: Device size in bytes + * `logical_block_size`: Device logical block size + * `num_blocks`: Number of blocks on the device + + For `usb` devices the attributes are: + * `number`: Device number + * `class`: Device class + * `subclass`: Device subclass + * `protocol`: Device protocol + +* `parent` - The parent of this device in the hierarchy +* `path` - Full path of the device +* `xml` - The XML returned by the libvirt API call diff --git a/website/docs/d/node_devices.html.markdown b/website/docs/d/node_devices.html.markdown new file mode 100644 index 000000000..566f8568a --- /dev/null +++ b/website/docs/d/node_devices.html.markdown @@ -0,0 +1,33 @@ +--- +layout: "libvirt" +page_title: "Libvirt: libvirt_node_devices" +sidebar_current: "docs-libvirt-node-devices" +description: |- + Use this data source to get information about the devices present on current node +--- + +# Data Source: libvirt\_node\_devices + +Retrieve information about the devices present on the current node + +## Example Usage + +```hcl +data "libvirt_node_devices" "node" { + capability = "pci" +} +``` + +## Argument Reference + +* `capability` - (Optional) The type of device, used to filter the output by capability type. + Can be one of `system`, `pci`, `usb_device`, `usb`, `net`, `scsi_host`, + `scsi_target`, `scsi`, `storage`, `fc_host`, `vports`, `scsi_generic`, `drm`, + `mdev`, `mdev_types`, `ccw`, `css`, `ap_card`, `ap_queue`, `ap_matrix`. + Defaults to all active devices. + +## Attribute Reference + +This data source exports the following attributes in addition to the arguments above: + +* `devices` - A list of devices that match the selected capability diff --git a/website/docs/d/node_info.html.markdown b/website/docs/d/node_info.html.markdown new file mode 100644 index 000000000..c965e7ac3 --- /dev/null +++ b/website/docs/d/node_info.html.markdown @@ -0,0 +1,35 @@ +--- +layout: "libvirt" +page_title: "Libvirt: libvirt_node_info" +sidebar_current: "docs-libvirt-node-info" +description: |- + Use this data source to get information about the current node +--- + +# Data Source: libvirt\_node\_info + +Retrieve information about the current node + +## Example Usage + +```hcl +data "libvirt_node_info" "node" { + +} +``` + +## Argument Reference + +This data source has no arguments. + +## Attribute Reference + +This data source exports the following attributes in addition to the arguments above: + +* `cpu_cores_per_socket` - Number of CPU cores per each socket +* `cpu_cores_total` - Number of CPU cores in total +* `cpu_model` - CPU Architecture, usually `x86_64` +* `cpu_sockets` - How many CPU sockets are present +* `cpu_threads_per_core` - How many CPU Threads are available per each CPU core +* `memory_total_kb` - The amount of memory installed, in KiB +* `numa_nodes` - How many NUMA nodes/cells are available. diff --git a/website/docs/data_sources.html.markdown b/website/docs/data_sources.html.markdown new file mode 100644 index 000000000..5c1fbc25f --- /dev/null +++ b/website/docs/data_sources.html.markdown @@ -0,0 +1,9 @@ + +# Data Sources + +```eval_rst +.. toctree:: + :glob: + + d/** +``` diff --git a/website/docs/toc.html.markdown b/website/docs/toc.html.markdown index 5fe1fef79..66bf41cb6 100644 --- a/website/docs/toc.html.markdown +++ b/website/docs/toc.html.markdown @@ -11,4 +11,5 @@ :maxdepth: 2 resources + data_sources ``` diff --git a/website/libvirt.erb b/website/libvirt.erb index bdfaa8c56..3d794bc9c 100644 --- a/website/libvirt.erb +++ b/website/libvirt.erb @@ -30,6 +30,15 @@ + > + Data Sesources + + + <% end %> From 9c6e66d12436ad0faf40c2aaae79cfaaf1ac7bc6 Mon Sep 17 00:00:00 2001 From: Catalin Muresan Date: Tue, 24 Oct 2023 18:39:55 +0100 Subject: [PATCH 05/16] Added testing for data structures --- ...ta_source_libvirt_node_device_info_test.go | 40 ++++++++++++++++++ .../data_source_libvirt_node_devices_test.go | 41 +++++++++++++++++++ libvirt/data_source_libvirt_node_info_test.go | 35 ++++++++++++++++ 3 files changed, 116 insertions(+) create mode 100644 libvirt/data_source_libvirt_node_device_info_test.go create mode 100644 libvirt/data_source_libvirt_node_devices_test.go create mode 100644 libvirt/data_source_libvirt_node_info_test.go diff --git a/libvirt/data_source_libvirt_node_device_info_test.go b/libvirt/data_source_libvirt_node_device_info_test.go new file mode 100644 index 000000000..287b8140a --- /dev/null +++ b/libvirt/data_source_libvirt_node_device_info_test.go @@ -0,0 +1,40 @@ +package libvirt + +import ( + "regexp" + "testing" + + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" +) + +func TestAccLibvirtNodeDeviceInfoDataSource(t *testing.T) { + resource.Test(t, resource.TestCase{ + PreCheck: func() { testAccPreCheck(t) }, + Providers: testAccProviders, + Steps: []resource.TestStep{ + { + Config: testAccDataSourceNodeDeviceInfo_pci, + Check: resource.ComposeTestCheckFunc( + resource.TestMatchResourceAttr( + "data.libvirt_node_device_info.device", "name", regexp.MustCompile(`^pci_0000_00_00_0$`)), + ), + }, { + Config: testAccDataSourceNodeDeviceInfo_system, + Check: resource.ComposeTestCheckFunc( + resource.TestMatchResourceAttr( + "data.libvirt_node_device_info.device", "name", regexp.MustCompile(`^computer$`)), + ), + }, + }, + }) +} + +const testAccDataSourceNodeDeviceInfo_pci = ` +data "libvirt_node_device_info" "device" { + name = "pci_0000_00_00_0" +}` + +const testAccDataSourceNodeDeviceInfo_system = ` +data "libvirt_node_device_info" "device" { + name = "computer" +}` diff --git a/libvirt/data_source_libvirt_node_devices_test.go b/libvirt/data_source_libvirt_node_devices_test.go new file mode 100644 index 000000000..e149bca41 --- /dev/null +++ b/libvirt/data_source_libvirt_node_devices_test.go @@ -0,0 +1,41 @@ +package libvirt + +import ( + "regexp" + "testing" + + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" +) + +func TestAccLibvirtNodeDevicesDataSource(t *testing.T) { + resource.Test(t, resource.TestCase{ + PreCheck: func() { testAccPreCheck(t) }, + Providers: testAccProviders, + Steps: []resource.TestStep{ + { + Config: testAccDataSourceNodeDevices_pci, + Check: resource.ComposeTestCheckFunc( + resource.TestMatchResourceAttr( + "data.libvirt_node_devices.node", "devices[0]", regexp.MustCompile(`^pci_\d{4}_\d{2}_\d{2}_\d{1}`)), + ), + }, + { + Config: testAccDataSourceNodeDevices_system, + Check: resource.ComposeTestCheckFunc( + resource.TestMatchResourceAttr( + "data.libvirt_node_devices.node", "devices[0]", regexp.MustCompile(`^computer$`)), + ), + }, + }, + }) +} + +const testAccDataSourceNodeDevices_pci = ` +data "libvirt_node_devices" "node" { + capability = "pci" +}` + +const testAccDataSourceNodeDevices_system = ` +data "libvirt_node_devices" "node" { + capability = "system" +}` diff --git a/libvirt/data_source_libvirt_node_info_test.go b/libvirt/data_source_libvirt_node_info_test.go new file mode 100644 index 000000000..20eed1c59 --- /dev/null +++ b/libvirt/data_source_libvirt_node_info_test.go @@ -0,0 +1,35 @@ +package libvirt + +import ( + "regexp" + "testing" + + "github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource" +) + +func TestAccLibvirtNodeInfoDataSource(t *testing.T) { + resource.Test(t, resource.TestCase{ + PreCheck: func() { testAccPreCheck(t) }, + Providers: testAccProviders, + Steps: []resource.TestStep{ + { + Config: testAccDataSourceNodeInfo, + Check: resource.ComposeTestCheckFunc( + resource.TestMatchResourceAttr( + "data.libvirt_node_info.info", "cpus", regexp.MustCompile(`^\d+`)), + ), + }, { + Config: testAccDataSourceNodeInfo, + Check: resource.ComposeTestCheckFunc( + resource.TestMatchResourceAttr( + "data.libvirt_node_info.info", "numa_nodes", regexp.MustCompile(`^\d+`)), + ), + }, + }, + }) +} + +const testAccDataSourceNodeInfo = ` +data "libvirt_node_info" "info" { + +}` From 8657723bb034315a93164c5961fd86b9847a1a58 Mon Sep 17 00:00:00 2001 From: Catalin Muresan Date: Tue, 24 Oct 2023 18:47:49 +0100 Subject: [PATCH 06/16] Added the missing node_devices and node_device_info --- website/libvirt.erb | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/website/libvirt.erb b/website/libvirt.erb index 3d794bc9c..28d1f4e01 100644 --- a/website/libvirt.erb +++ b/website/libvirt.erb @@ -33,6 +33,12 @@ > Data Sesources
    + > + libvirt_node_devices + + > + libvirt_node_device_info + > libvirt_node_info From 6b8d6e23c0584eb8e492f63dd91408fd17701f63 Mon Sep 17 00:00:00 2001 From: Catalin Muresan Date: Tue, 24 Oct 2023 21:18:28 +0100 Subject: [PATCH 07/16] Update libvirt/data_source_libvirt_node_info.go Co-authored-by: Russell Bunch --- libvirt/data_source_libvirt_node_info.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/libvirt/data_source_libvirt_node_info.go b/libvirt/data_source_libvirt_node_info.go index 5d53e083e..1d601a60b 100644 --- a/libvirt/data_source_libvirt_node_info.go +++ b/libvirt/data_source_libvirt_node_info.go @@ -69,7 +69,7 @@ func resourceLibvirtNodeInfoRead(d *schema.ResourceData, meta interface{}) error return fmt.Errorf("failed to retrieve domains: %v", err) } - d.Set("cpu_model", Int8ToString(model)) + d.Set("cpu_model", int8ToString(model)) d.Set("cpu_cores_total", cpus) d.Set("cpu_cores_per_socket", cores) d.Set("numa_nodes", nodes) @@ -82,7 +82,7 @@ func resourceLibvirtNodeInfoRead(d *schema.ResourceData, meta interface{}) error return nil } -func Int8ToString(bs [32]int8) string { +func int8ToString(bs [32]int8) string { ba := []uint8{} for _, b := range bs { ba = append(ba, uint8(b)) From 04c176fe7a48a9b53df8ed997d2a6a7030ef43eb Mon Sep 17 00:00:00 2001 From: Catalin Muresan Date: Wed, 8 Nov 2023 19:59:43 +0000 Subject: [PATCH 08/16] Updates to add more device types --- .../data_source_libvirt_node_device_info.go | 736 ++++++++++++++++-- website/docs/d/node_device_info.html.markdown | 69 +- 2 files changed, 704 insertions(+), 101 deletions(-) diff --git a/libvirt/data_source_libvirt_node_device_info.go b/libvirt/data_source_libvirt_node_device_info.go index cace62ba9..2ef1f75ea 100644 --- a/libvirt/data_source_libvirt_node_device_info.go +++ b/libvirt/data_source_libvirt_node_device_info.go @@ -10,63 +10,188 @@ import ( "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" ) -// strutures to parse device XML -type Device struct { - Device xml.Name `xml:"device"` - Name string `xml:"name"` - Path string `xml:"path"` - Parent string `xml:"parent"` - Capability Capability `xml:"capability"` +// strutures to parse device XML just enough to get Capability.Type +type DeviceGeneric struct { + Device xml.Name `xml:"device"` + Name string `xml:"name"` + Path string `xml:"path"` + Parent string `xml:"parent"` + Capability struct { + Capability xml.Name `xml:"capability"` + Type string `xml:"type,attr"` + } `xml:"capability"` } -type Capability struct { - Capability xml.Name `xml:"capability"` - Type string `xml:"type,attr"` - // PCI - Class string `xml:"class"` - Domain int `xml:"domain"` - Bus int `xml:"bus"` - Slot int `xml:"slot"` - Function int `xml:"function"` - Product Product `xml:"product"` - Vendor Vendor `xml:"vendor"` - IommuGroup IommuGroup `xml:"iommuGroup"` - // STORAGE - Block string `xml:"block"` - DriveType string `xml:"drive_type"` - Model string `xml:"model"` - Serial string `xml:"serial"` - Size int `xml:"size"` - LogicalBlockSize int `xml:"logical_block_size"` - NumBlocks int `xml:"num_blocks"` - // USB - Number int `xml:"number"` - Subclass int `xml:"subclass"` - Protocol int `xml:"protocol"` +type DeviceSystem struct { + Device xml.Name `xml:"device"` + Name string `xml:"name"` + Path string `xml:"path"` + Parent string `xml:"parent"` + Capability struct { + Type string `xml:"type,attr"` + Product string `xml:"product"` + Hardware struct { + Vendor string `xml:"vendor"` + Version string `xml:"version"` + Serial string `xml:"serial"` + UUID string `xml:"uuid"` + } `xml:"hardware"` + Firmware struct { + Vendor string `xml:"vendor"` + Version string `xml:"version"` + ReleaseDate string `xml:"release_date"` + } `xml:"firmware"` + } `xml:"capability"` } -type Product struct { - Name string `xml:",chardata"` - Id string `xml:"id,attr"` +type DevicePCI struct { + Device xml.Name `xml:"device"` + Name string `xml:"name"` + Path string `xml:"path"` + Parent string `xml:"parent"` + Capability struct { + Type string `xml:"type,attr"` + Class string `xml:"class"` + Domain int `xml:"domain"` + Bus int `xml:"bus"` + Slot int `xml:"slot"` + Function int `xml:"function"` + Product struct { + Name string `xml:",chardata"` + Id string `xml:"id,attr"` + } `xml:"product"` + Vendor struct { + Name string `xml:",chardata"` + Id string `xml:"id,attr"` + } `xml:"vendor"` + IommuGroup struct { + IommuGroup xml.Name `xml:"iommuGroup"` + Number int `xml:"number,attr"` + Addresses []struct { + Address xml.Name `xml:"address"` + Domain string `xml:"domain,attr"` + Bus string `xml:"bus,attr"` + Slot string `xml:"slot,attr"` + Function string `xml:"function,attr"` + } `xml:"address"` + } `xml:"iommuGroup"` + } `xml:"capability"` } -type Vendor struct { - Name string `xml:",chardata"` - Id string `xml:"id,attr"` +type DeviceUSBDevice struct { + Device xml.Name `xml:"device"` + Name string `xml:"name"` + Path string `xml:"path"` + Parent string `xml:"parent"` + Capability struct { + Type string `xml:"type,attr"` + Bus string `xml:"bus"` + Device string `xml:"device"` + Product struct { + Name string `xml:",chardata"` + Id string `xml:"id,attr"` + } `xml:"product"` + Vendor struct { + Name string `xml:",chardata"` + Id string `xml:"id,attr"` + } `xml:"vendor"` + } `xml:"capability"` } -type IommuGroup struct { - IommuGroup xml.Name `xml:"iommuGroup"` - Number int `xml:"number,attr"` - Addresses []Address `xml:"address"` +type DeviceUSB struct { + Device xml.Name `xml:"device"` + Name string `xml:"name"` + Path string `xml:"path"` + Parent string `xml:"parent"` + Capability struct { + Type string `xml:"type,attr"` + Number int `xml:"number"` + Class int `xml:"class"` + Subclass int `xml:"subclass"` + Protocol int `xml:"protocol"` + Description string `xml:"description"` + } `xml:"capability"` } -type Address struct { - Address xml.Name `xml:"address"` - Domain string `xml:"domain,attr"` - Bus string `xml:"bus,attr"` - Slot string `xml:"slot,attr"` - Function string `xml:"function,attr"` +type DeviceNet struct { + Device xml.Name `xml:"device"` + Name string `xml:"name"` + Path string `xml:"path"` + Parent string `xml:"parent"` + Capability struct { + Type string `xml:"type,attr"` + Interface string `xml:"interface"` + Address string `xml:"address"` + Link struct { + Speed string `xml:"speed,attr"` + State string `xml:"state,attr"` + } `xml:"link"` + Feature struct { + Name []string `xml:"name,attr"` + } `xml:"feature"` + Cappability struct { + Type string `xml:"type,attr"` + } `xml:"capability"` + } `xml:"capability"` +} + +type DeviceSCSI struct { + Device xml.Name `xml:"device"` + Name string `xml:"name"` + Path string `xml:"path"` + Parent string `xml:"parent"` + Capability struct { + Type string `xml:"type,attr"` + Host int `xml:"host"` + Bus int `xml:"bus"` + Target int `xml:"target"` + Lun int `xml:"lun"` + ScsiType string `xml:"type"` + } `xml:"capability"` +} + +type DeviceSCSIHost struct { + Device xml.Name `xml:"device"` + Name string `xml:"name"` + Path string `xml:"path"` + Parent string `xml:"parent"` + Capability struct { + Type string `xml:"type,attr"` + Host int `xml:"host"` + UniqueID int `xml:"unique_id"` + } `xml:"capability"` +} + +type DeviceStorage struct { + Device xml.Name `xml:"device"` + Name string `xml:"name"` + Path string `xml:"path"` + Parent string `xml:"parent"` + Capability struct { + Type string `xml:"type,attr"` + Block string `xml:"block"` + DriveType string `xml:"drive_type"` + Model string `xml:"model"` + Serial string `xml:"serial"` + Size int `xml:"size"` + LogicalBlockSize int `xml:"logical_block_size"` + NumBlocks int `xml:"num_blocks"` + } `xml:"capability"` +} + +type DeviceDRM struct { + Device xml.Name `xml:"device"` + Name string `xml:"name"` + Path string `xml:"path"` + Parent string `xml:"parent"` + Devnode []struct { + Type string `xml:"type,attr"` + Path string `xml:",chardata"` + } `xml:"devnode"` + Capability struct { + Type string `xml:"type,attr"` + DRMType string `xml:"type"` + } `xml:"capability"` } // a libvirt nodeinfo datasource @@ -99,14 +224,252 @@ func datasourceLibvirtNodeDeviceInfo() *schema.Resource { Type: schema.TypeString, Computed: true, }, + "devnode": { + Type: schema.TypeSet, + Computed: true, + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "type": { // drm + Type: schema.TypeString, + Computed: true, + }, + "path": { // drm + Type: schema.TypeString, + Computed: true, + }, + }, + }, + }, "capability": { - Type: schema.TypeMap, + Type: schema.TypeList, + MaxItems: 1, + Optional: true, Computed: true, + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "type": { + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "class": { // pci, usb + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "domain": { // pci + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "bus": { // pci, usb_device + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "slot": { // pci + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "function": { // pci + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "block": { // storage + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "drive_type": { // storage + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "model": { // storage + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "serial": { // storage + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "size": { // storage + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "logical_block_size": { // storage + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "num_blocks": { // storage + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "hardware": { // system + Type: schema.TypeMap, + Optional: true, + Elem: &schema.Schema{ + Type: schema.TypeString, + }, + }, + "firmware": { // system + Type: schema.TypeMap, + Optional: true, + Elem: &schema.Schema{ + Type: schema.TypeString, + }, + }, + "product": { // pci, system, usb_device + Type: schema.TypeMap, + Optional: true, + Elem: &schema.Schema{ + Type: schema.TypeString, + }, + }, + "vendor": { // pci, usb_device + Type: schema.TypeMap, + Optional: true, + Elem: &schema.Schema{ + Type: schema.TypeString, + }, + }, + // "iommu_group": { // pci + // Type: schema.TypeMap, + // Optional: true, + // Elem: &schema.Schema{ + // Type: schema.TypeString, + // }, + // }, + "iommu_group": { + Type: schema.TypeList, + MaxItems: 1, + Optional: true, + Computed: true, + Elem: &schema.Resource{ + Schema: map[string]*schema.Schema{ + "number": { + Type: schema.TypeString, + Computed: true, + }, + "addresses": { + Type: schema.TypeList, + Computed: true, + Elem: &schema.Schema{ + Type: schema.TypeMap, + Elem: &schema.Schema{ + Type: schema.TypeString, + }, + }, + }, + }, + }, + }, + "device": { // usb_device + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "number": { // usb + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "subclass": { // usb + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "protocol": { // usb + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "description": { // usb + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "interface": { // net + Type: schema.TypeString, + Optional: true, + Elem: &schema.Schema{ + Type: schema.TypeString, + }, + }, + "address": { // net + Type: schema.TypeString, + Optional: true, + Elem: &schema.Schema{ + Type: schema.TypeString, + }, + }, + "link": { // net + Type: schema.TypeMap, + Optional: true, + Elem: &schema.Schema{ + Type: schema.TypeString, + }, + }, + "capability": { // net + Type: schema.TypeMap, + Optional: true, + Elem: &schema.Schema{ + Type: schema.TypeString, + }, + }, + "features": { // net + Type: schema.TypeList, + Optional: true, + Elem: &schema.Schema{ + Type: schema.TypeString, + }, + }, + "host": { // scsi, scsi_host + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "target": { // scsi + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "lun": { // scsi + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "scsi_type": { // scsi + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "unique_id": { // scsi_host + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + "drm_type": { // drm + Type: schema.TypeString, + Optional: true, + Computed: true, + }, + }, + }, }, }, } } +// https://github.com/hashicorp/terraform-plugin-sdk/issues/726 + func resourceLibvirtNodeDeviceInfoRead(d *schema.ResourceData, meta interface{}) error { log.Printf("[DEBUG] Read data source libvirt_nodedevices") @@ -132,50 +495,263 @@ func resourceLibvirtNodeDeviceInfoRead(d *schema.ResourceData, meta interface{}) return fmt.Errorf("failed to get XML for node device: %v", err) } - var device_xml Device + device_xml := DeviceGeneric{} + capability := []map[string]interface{}{} err = xml.Unmarshal([]byte(xml_desc), &device_xml) if err != nil { - log.Fatalf("failed to unmarshal device_xml into XML: %v", err) + log.Fatalf("failed to unmarshal XML into device_xml: %v", err) } + log.Printf("[DEBUG] Parsed device generic into device_xml: %v", device_xml) - capability := map[string]interface{}{} - if device_xml.Capability.Type == "pci" { - capability["type"] = device_xml.Capability.Type - capability["class"] = device_xml.Capability.Class - capability["domain"] = fmt.Sprintf("%d", device_xml.Capability.Domain) - capability["bus"] = fmt.Sprintf("%d", device_xml.Capability.Bus) - capability["slot"] = fmt.Sprintf("%d", device_xml.Capability.Slot) - capability["function"] = fmt.Sprintf("%d", device_xml.Capability.Function) - capability["product_id"] = device_xml.Capability.Product.Id - capability["product_name"] = device_xml.Capability.Product.Name - capability["vendor_id"] = device_xml.Capability.Vendor.Id - capability["vendor_name"] = device_xml.Capability.Vendor.Name - capability["iommu_group_number"] = fmt.Sprintf("%d", device_xml.Capability.IommuGroup.Number) - } + switch device_xml.Capability.Type { + ////////////////// SYSTEM ////////////////// + case "system": + device_xml := DeviceSystem{} + err = xml.Unmarshal([]byte(xml_desc), &device_xml) + if err != nil { + log.Fatalf("failed to unmarshal device system XML into device_xml: %v", err) + } + log.Printf("[DEBUG] Parsed device system into device_xml: %v", device_xml) - if device_xml.Capability.Type == "storage" { - capability["type"] = device_xml.Capability.Type - capability["block"] = device_xml.Capability.Block - capability["drive_type"] = device_xml.Capability.DriveType - capability["mode"] = device_xml.Capability.Model - capability["serial"] = device_xml.Capability.Serial - capability["size"] = fmt.Sprintf("%d", device_xml.Capability.Size) - capability["logical_block_size"] = fmt.Sprintf("%d", device_xml.Capability.LogicalBlockSize) - capability["num_blocks"] = fmt.Sprintf("%d", device_xml.Capability.NumBlocks) - } + c := map[string]interface{}{ + // clash with pci.product which is a map, converted to map. + "product": map[string]interface{}{ + "name": device_xml.Capability.Product, + }, + "hardware": map[string]interface{}{ + "vendor": device_xml.Capability.Hardware.Vendor, + "version": device_xml.Capability.Hardware.Version, + "serial": device_xml.Capability.Hardware.Serial, + "uuid": device_xml.Capability.Hardware.UUID, + }, + "firmware": map[string]interface{}{ + "vendor": device_xml.Capability.Firmware.Vendor, + "version": device_xml.Capability.Firmware.Version, + "release_date": device_xml.Capability.Firmware.ReleaseDate, + }, + } + + capability = append(capability, c) + log.Printf("[DEBUG] Set capability type system to : %v", capability) + + ///////////////// PCI ////////////////// + case "pci": + device_xml := DevicePCI{} + err = xml.Unmarshal([]byte(xml_desc), &device_xml) + if err != nil { + log.Fatalf("failed to unmarshal device pci XML into device_xml: %v", err) + } + log.Printf("[DEBUG] Parsed device pci into device_xml: %v", device_xml) + + iommu_group := []map[string]interface{}{} + addresses := []map[string]interface{}{} + + for _, v := range device_xml.Capability.IommuGroup.Addresses { + m := map[string]interface{}{ + "domain": v.Domain, + "bus": v.Bus, + "slot": v.Slot, + "function": v.Function, + } + addresses = append(addresses, m) + } + + ig := map[string]interface{}{ + "number": fmt.Sprintf("%d", device_xml.Capability.IommuGroup.Number), + "addresses": addresses, + } + c := map[string]interface{}{ + "type": device_xml.Capability.Type, + "class": device_xml.Capability.Class, + "domain": fmt.Sprintf("%d", device_xml.Capability.Domain), + "bus": fmt.Sprintf("%d", device_xml.Capability.Bus), + "slot": fmt.Sprintf("%d", device_xml.Capability.Slot), + "function": fmt.Sprintf("%d", device_xml.Capability.Function), + "product": map[string]interface{}{ + "id": device_xml.Capability.Product.Id, + "name": device_xml.Capability.Product.Name, + }, + "vendor": map[string]interface{}{ + "id": device_xml.Capability.Vendor.Id, + "name": device_xml.Capability.Vendor.Name, + }, + "iommu_group": append(iommu_group, ig), + } + log.Printf("[DEBUG] iommu_group device type pci to : %v", device_xml.Capability.IommuGroup.Addresses) + capability = append(capability, c) + log.Printf("[DEBUG] Set capability type pci to : %v", capability) + + ////////////////// USB Device ////////////////// + case "usb_device": + device_xml := DeviceUSBDevice{} + err = xml.Unmarshal([]byte(xml_desc), &device_xml) + if err != nil { + log.Fatalf("failed to unmarshal device usb_device XML into device_xml: %v", err) + } + log.Printf("[DEBUG] Parsed device usb_device into device_xml: %v", device_xml) + + c := map[string]interface{}{ + "type": device_xml.Capability.Type, + "bus": device_xml.Capability.Bus, + "device": device_xml.Capability.Device, + "product": map[string]interface{}{ + "id": device_xml.Capability.Product.Id, + "name": device_xml.Capability.Product.Name, + }, + "vendor": map[string]interface{}{ + "id": device_xml.Capability.Vendor.Id, + "name": device_xml.Capability.Vendor.Name, + }, + } + capability = append(capability, c) + log.Printf("[DEBUG] Set capability type usb_device to : %v", capability) + + ////////////////// USB Host ////////////////// + case "usb": + device_xml := DeviceUSB{} + err = xml.Unmarshal([]byte(xml_desc), &device_xml) + if err != nil { + log.Fatalf("failed to unmarshal device usb XML into device_xml: %v", err) + } + log.Printf("[DEBUG] Parsed device usb into device_xml: %v", device_xml) + + c := map[string]interface{}{ + "type": device_xml.Capability.Type, + "number": fmt.Sprintf("%d", device_xml.Capability.Number), + "class": fmt.Sprintf("%d", device_xml.Capability.Class), + "subclass": fmt.Sprintf("%d", device_xml.Capability.Subclass), + "protocol": fmt.Sprintf("%d", device_xml.Capability.Protocol), + "description": device_xml.Capability.Description, + } + capability = append(capability, c) + log.Printf("[DEBUG] Set capability type usb to : %v", capability) + + ////////////////// STORAGE ////////////////// + case "storage": + device_xml := DeviceStorage{} + err = xml.Unmarshal([]byte(xml_desc), &device_xml) + if err != nil { + log.Fatalf("failed to unmarshal device storage XML into device_xml: %v", err) + } + log.Printf("[DEBUG] Parsed device storage into device_xml: %v", device_xml) + + c := map[string]interface{}{ + "type": device_xml.Capability.Type, + "block": device_xml.Capability.Block, + "drive_type": device_xml.Capability.DriveType, + "model": device_xml.Capability.Model, + "serial": device_xml.Capability.Serial, + "size": fmt.Sprintf("%d", device_xml.Capability.Size), + "logical_block_size": fmt.Sprintf("%d", device_xml.Capability.LogicalBlockSize), + "num_blocks": fmt.Sprintf("%d", device_xml.Capability.NumBlocks), + } + + capability = append(capability, c) + log.Printf("[DEBUG] Set capability type storage to : %v", capability) + + ////////////////// NET ////////////////// + case "net": + device_xml := DeviceNet{} + err = xml.Unmarshal([]byte(xml_desc), &device_xml) + if err != nil { + log.Fatalf("failed to unmarshal device net XML into device_xml: %v", err) + } + log.Printf("[DEBUG] Parsed device net into device_xml: %v", device_xml) + + c := map[string]interface{}{ + "type": device_xml.Capability.Type, + "interface": device_xml.Capability.Interface, + "address": device_xml.Capability.Address, + "link": map[string]interface{}{ + "speed": device_xml.Capability.Link.Speed, + "state": device_xml.Capability.Link.State, + }, + "features": device_xml.Capability.Feature.Name, + "capability": map[string]interface{}{ + "type": device_xml.Capability.Cappability.Type, + }, + } + + capability = append(capability, c) + log.Printf("[DEBUG] Set capability type net to : %v", capability) + + ////////////////// SCSI ////////////////// + case "scsi": + device_xml := DeviceSCSI{} + err = xml.Unmarshal([]byte(xml_desc), &device_xml) + if err != nil { + log.Fatalf("failed to unmarshal device scsi XML into device_xml: %v", err) + } + log.Printf("[DEBUG] Parsed device scsi into device_xml: %v", device_xml) + + c := map[string]interface{}{ + "type": device_xml.Capability.Type, + "host": fmt.Sprintf("%d", device_xml.Capability.Host), + "bus": fmt.Sprintf("%d", device_xml.Capability.Bus), + "target": fmt.Sprintf("%d", device_xml.Capability.Target), + "lun": fmt.Sprintf("%d", device_xml.Capability.Lun), + "scsi_type": device_xml.Capability.ScsiType, + } + + capability = append(capability, c) + log.Printf("[DEBUG] Set capability type scsi to : %v", capability) + + ////////////////// SCSI Host ////////////////// + case "scsi_host": + device_xml := DeviceSCSIHost{} + err = xml.Unmarshal([]byte(xml_desc), &device_xml) + if err != nil { + log.Fatalf("failed to unmarshal device scsi_host XML into device_xml: %v", err) + } + log.Printf("[DEBUG] Parsed device scsi_host into device_xml: %v", device_xml) + + c := map[string]interface{}{ + "type": device_xml.Capability.Type, + "host": fmt.Sprintf("%d", device_xml.Capability.Host), + "unique_id": fmt.Sprintf("%d", device_xml.Capability.UniqueID), + } + + capability = append(capability, c) + log.Printf("[DEBUG] Set capability type scsi_host to : %v", capability) + + ////////////////// SCSI Host ////////////////// + case "drm": + device_xml := DeviceDRM{} + err = xml.Unmarshal([]byte(xml_desc), &device_xml) + if err != nil { + log.Fatalf("failed to unmarshal device drm XML into device_xml: %v", err) + } + log.Printf("[DEBUG] Parsed device drm into device_xml: %v", device_xml) + + c := map[string]interface{}{ + "type": device_xml.Capability.Type, + "drm_type": device_xml.Capability.DRMType, + } + + capability = append(capability, c) + + devnode := []map[string]interface{}{} + for _, v := range device_xml.Devnode { + m := map[string]interface{}{ + "type": v.Type, + "path": v.Path, + } + devnode = append(devnode, m) + } + + log.Printf("[DEBUG] Set capability type drm to : %v", capability) + d.Set("devnode", devnode) + log.Printf("[DEBUG] Set devnode type drm to : %v", device_xml.Devnode) - if device_xml.Capability.Type == "usb" { - capability["type"] = device_xml.Capability.Type - capability["number"] = fmt.Sprintf("%d", device_xml.Capability.Number) - capability["class"] = device_xml.Capability.Class - capability["subclass"] = fmt.Sprintf("%d", device_xml.Capability.Subclass) - capability["protocol"] = fmt.Sprintf("%d", device_xml.Capability.Protocol) + default: + log.Fatalf("Unknown device capability type: %v", device_xml.Capability.Type) } d.Set("xml", xml_desc) d.Set("path", device_xml.Path) d.Set("parent", device_xml.Parent) + log.Printf("[DEBUG] d.Set capability type %s : %s", capability[0]["type"], capability) d.Set("capability", capability) d.SetId(strconv.Itoa(hashcode.String(fmt.Sprintf("%v", xml_desc)))) diff --git a/website/docs/d/node_device_info.html.markdown b/website/docs/d/node_device_info.html.markdown index 62afab531..495b73cd5 100644 --- a/website/docs/d/node_device_info.html.markdown +++ b/website/docs/d/node_device_info.html.markdown @@ -29,34 +29,61 @@ This data source exports the following attributes in addition to the arguments a * `capability` - A map of the various attributes for the device, depending on the type of device. Currently implemented are `pci`, `storage`, `usb` * `type` - Device type: `pci`, `storage`, `usb` + * `devnode`: For devices with a `/dev` special file. A mandatory attribute type specify the kind of file `path`, which may be either dev for the main name, or `link` for additional symlinks. - For `pci` devices the attributes are: + For `pci` devices the additional attributes are: * `class` - Device PCI class * `domain` - Device PCI domain * `bus` - Device PCI bus * `slot` - Device PCI slot * `function` - Device PCI function - * `product_id` - Device PCI product id - * `product_name` - Device PCI product name - * `vendor_id` - Device PCI product id - * `vendor_name` - Device PCI product name - * `iommu_group_number` - IOMMU Group number for the device - - For `storage` devices the attributes are: - * `block`: Block device name - * `drive_type`: Device drive type - * `model`: Device model - * `serial`: Device serial number - * `size`: Device size in bytes - * `logical_block_size`: Device logical block size - * `num_blocks`: Number of blocks on the device - - For `usb` devices the attributes are: - * `number`: Device number - * `class`: Device class - * `subclass`: Device subclass - * `protocol`: Device protocol + * `product` - Device PCI product map of `id` and `name` + * `vendor` - Device PCI vendor map of `id` and `name` + * `iommu_group` - Structure that holds IOMMU Group `number` and the list of devices that are part of the group + + For `storage` devices the additional attributes are: + * `block` - Block device name + * `drive_type` - Device drive type + * `model` - Device model + * `serial` - Device serial number + * `size` - Device size in bytes + * `logical_block_size` - Device logical block size + * `num_blocks` - Number of blocks on the device + + For `usb` devices the additional attributes are: + * `number` - Device number + * `class` - Device class + * `subclass` - Device subclass + * `protocol` - Device protocol + + For `usb_device` devices the additional attributes are: + * `bus` - Which bus the device belongs to + * `device` - Which device within the \ + * `product` - If present, the product `id` and `name` from the device ROM + * `vendor` - If present, the vendor `id` and `name` from the device ROM + + For `net` devices the additional attributes are: + * `interface` - The interface name tied to this device + * `address` - If present, the MAC address of the device + * `link` - Optional to reflect the status of the link via `speed` and `state` keys + * `feature` - List of features supported by the network interface + * `capability` - Holds key `type` that describes the type of network interface: `80203` for IEEE 802.3 or `80211` for IEEE 802.11 + + For `scsi_host` devices the additional attributes are: + * `host` - The SCSI host number + * `unique_id` - This optionally provides the value from the 'unique_id' file found in the scsi_host's directory + + For `scsi` devices the additional attributes are: + * `host` - The SCSI host containing the device + * `bus` - The bus within the host + * `target` - The target within the bus + * `lun` - The lun within the target + * `scsi_type` - The type of SCSI device + + For `drm` devices the additional attributes are: + * `drm_type` - Type of DRM device: `render` or `card` * `parent` - The parent of this device in the hierarchy * `path` - Full path of the device * `xml` - The XML returned by the libvirt API call +* `devnode` - For type `drm` holds the `path` and `link` that point to the device From b39ea18df49983f80ff6defcbc5a0edf866ab1f1 Mon Sep 17 00:00:00 2001 From: Catalin Muresan Date: Wed, 8 Nov 2023 21:47:22 +0000 Subject: [PATCH 09/16] Changes to fix the golangci-lint run --- .../data_source_libvirt_node_device_info.go | 255 +++++++++--------- ...ta_source_libvirt_node_device_info_test.go | 8 +- libvirt/data_source_libvirt_node_devices.go | 4 +- libvirt/data_source_libvirt_node_info.go | 2 +- 4 files changed, 130 insertions(+), 139 deletions(-) diff --git a/libvirt/data_source_libvirt_node_device_info.go b/libvirt/data_source_libvirt_node_device_info.go index 2ef1f75ea..1b01b6c64 100644 --- a/libvirt/data_source_libvirt_node_device_info.go +++ b/libvirt/data_source_libvirt_node_device_info.go @@ -58,11 +58,11 @@ type DevicePCI struct { Function int `xml:"function"` Product struct { Name string `xml:",chardata"` - Id string `xml:"id,attr"` + ID string `xml:"id,attr"` } `xml:"product"` Vendor struct { Name string `xml:",chardata"` - Id string `xml:"id,attr"` + ID string `xml:"id,attr"` } `xml:"vendor"` IommuGroup struct { IommuGroup xml.Name `xml:"iommuGroup"` @@ -89,11 +89,11 @@ type DeviceUSBDevice struct { Device string `xml:"device"` Product struct { Name string `xml:",chardata"` - Id string `xml:"id,attr"` + ID string `xml:"id,attr"` } `xml:"product"` Vendor struct { Name string `xml:",chardata"` - Id string `xml:"id,attr"` + ID string `xml:"id,attr"` } `xml:"vendor"` } `xml:"capability"` } @@ -340,14 +340,7 @@ func datasourceLibvirtNodeDeviceInfo() *schema.Resource { Type: schema.TypeString, }, }, - // "iommu_group": { // pci - // Type: schema.TypeMap, - // Optional: true, - // Elem: &schema.Schema{ - // Type: schema.TypeString, - // }, - // }, - "iommu_group": { + "iommu_group": { // pci Type: schema.TypeList, MaxItems: 1, Optional: true, @@ -468,8 +461,6 @@ func datasourceLibvirtNodeDeviceInfo() *schema.Resource { } } -// https://github.com/hashicorp/terraform-plugin-sdk/issues/726 - func resourceLibvirtNodeDeviceInfoRead(d *schema.ResourceData, meta interface{}) error { log.Printf("[DEBUG] Read data source libvirt_nodedevices") @@ -478,57 +469,57 @@ func resourceLibvirtNodeDeviceInfoRead(d *schema.ResourceData, meta interface{}) return fmt.Errorf(LibVirtConIsNil) } - var device_name string + var deviceName string if name, ok := d.GetOk("name"); ok { - device_name = name.(string) - log.Printf("[DEBUG] Got name: %s", device_name) + deviceName = name.(string) + log.Printf("[DEBUG] Got name: %s", deviceName) } - device, err := virConn.NodeDeviceLookupByName(device_name) + device, err := virConn.NodeDeviceLookupByName(deviceName) if err != nil { - return fmt.Errorf("failed to lookup node device: %v", err) + return fmt.Errorf("failed to lookup node device: %w", err) } - xml_desc, err := virConn.NodeDeviceGetXMLDesc(device.Name, 0) + xmlDesc, err := virConn.NodeDeviceGetXMLDesc(device.Name, 0) if err != nil { - return fmt.Errorf("failed to get XML for node device: %v", err) + return fmt.Errorf("failed to get XML for node device: %w", err) } - device_xml := DeviceGeneric{} + deviceXML := DeviceGeneric{} capability := []map[string]interface{}{} - err = xml.Unmarshal([]byte(xml_desc), &device_xml) + err = xml.Unmarshal([]byte(xmlDesc), &deviceXML) if err != nil { - log.Fatalf("failed to unmarshal XML into device_xml: %v", err) + log.Fatalf("failed to unmarshal XML into deviceXML: %v", err) } - log.Printf("[DEBUG] Parsed device generic into device_xml: %v", device_xml) + log.Printf("[DEBUG] Parsed device generic into deviceXML: %v", deviceXML) - switch device_xml.Capability.Type { + switch deviceXML.Capability.Type { ////////////////// SYSTEM ////////////////// case "system": - device_xml := DeviceSystem{} - err = xml.Unmarshal([]byte(xml_desc), &device_xml) + deviceXML := DeviceSystem{} + err = xml.Unmarshal([]byte(xmlDesc), &deviceXML) if err != nil { - log.Fatalf("failed to unmarshal device system XML into device_xml: %v", err) + log.Fatalf("failed to unmarshal device system XML into deviceXML: %v", err) } - log.Printf("[DEBUG] Parsed device system into device_xml: %v", device_xml) + log.Printf("[DEBUG] Parsed device system into deviceXML: %v", deviceXML) c := map[string]interface{}{ - // clash with pci.product which is a map, converted to map. + // clash with pci.product which is a map, converted to map "product": map[string]interface{}{ - "name": device_xml.Capability.Product, + "name": deviceXML.Capability.Product, }, "hardware": map[string]interface{}{ - "vendor": device_xml.Capability.Hardware.Vendor, - "version": device_xml.Capability.Hardware.Version, - "serial": device_xml.Capability.Hardware.Serial, - "uuid": device_xml.Capability.Hardware.UUID, + "vendor": deviceXML.Capability.Hardware.Vendor, + "version": deviceXML.Capability.Hardware.Version, + "serial": deviceXML.Capability.Hardware.Serial, + "uuid": deviceXML.Capability.Hardware.UUID, }, "firmware": map[string]interface{}{ - "vendor": device_xml.Capability.Firmware.Vendor, - "version": device_xml.Capability.Firmware.Version, - "release_date": device_xml.Capability.Firmware.ReleaseDate, + "vendor": deviceXML.Capability.Firmware.Vendor, + "version": deviceXML.Capability.Firmware.Version, + "release_date": deviceXML.Capability.Firmware.ReleaseDate, }, } @@ -537,17 +528,17 @@ func resourceLibvirtNodeDeviceInfoRead(d *schema.ResourceData, meta interface{}) ///////////////// PCI ////////////////// case "pci": - device_xml := DevicePCI{} - err = xml.Unmarshal([]byte(xml_desc), &device_xml) + deviceXML := DevicePCI{} + err = xml.Unmarshal([]byte(xmlDesc), &deviceXML) if err != nil { - log.Fatalf("failed to unmarshal device pci XML into device_xml: %v", err) + log.Fatalf("failed to unmarshal device pci XML into deviceXML: %v", err) } - log.Printf("[DEBUG] Parsed device pci into device_xml: %v", device_xml) + log.Printf("[DEBUG] Parsed device pci into deviceXML: %v", deviceXML) - iommu_group := []map[string]interface{}{} + iommuGroup := []map[string]interface{}{} addresses := []map[string]interface{}{} - for _, v := range device_xml.Capability.IommuGroup.Addresses { + for _, v := range deviceXML.Capability.IommuGroup.Addresses { m := map[string]interface{}{ "domain": v.Domain, "bus": v.Bus, @@ -558,50 +549,50 @@ func resourceLibvirtNodeDeviceInfoRead(d *schema.ResourceData, meta interface{}) } ig := map[string]interface{}{ - "number": fmt.Sprintf("%d", device_xml.Capability.IommuGroup.Number), + "number": fmt.Sprintf("%d", deviceXML.Capability.IommuGroup.Number), "addresses": addresses, } c := map[string]interface{}{ - "type": device_xml.Capability.Type, - "class": device_xml.Capability.Class, - "domain": fmt.Sprintf("%d", device_xml.Capability.Domain), - "bus": fmt.Sprintf("%d", device_xml.Capability.Bus), - "slot": fmt.Sprintf("%d", device_xml.Capability.Slot), - "function": fmt.Sprintf("%d", device_xml.Capability.Function), + "type": deviceXML.Capability.Type, + "class": deviceXML.Capability.Class, + "domain": fmt.Sprintf("%d", deviceXML.Capability.Domain), + "bus": fmt.Sprintf("%d", deviceXML.Capability.Bus), + "slot": fmt.Sprintf("%d", deviceXML.Capability.Slot), + "function": fmt.Sprintf("%d", deviceXML.Capability.Function), "product": map[string]interface{}{ - "id": device_xml.Capability.Product.Id, - "name": device_xml.Capability.Product.Name, + "id": deviceXML.Capability.Product.ID, + "name": deviceXML.Capability.Product.Name, }, "vendor": map[string]interface{}{ - "id": device_xml.Capability.Vendor.Id, - "name": device_xml.Capability.Vendor.Name, + "id": deviceXML.Capability.Vendor.ID, + "name": deviceXML.Capability.Vendor.Name, }, - "iommu_group": append(iommu_group, ig), + "iommu_group": append(iommuGroup, ig), } - log.Printf("[DEBUG] iommu_group device type pci to : %v", device_xml.Capability.IommuGroup.Addresses) + log.Printf("[DEBUG] iommuGroup device type pci to : %v", deviceXML.Capability.IommuGroup.Addresses) capability = append(capability, c) log.Printf("[DEBUG] Set capability type pci to : %v", capability) ////////////////// USB Device ////////////////// case "usb_device": - device_xml := DeviceUSBDevice{} - err = xml.Unmarshal([]byte(xml_desc), &device_xml) + deviceXML := DeviceUSBDevice{} + err = xml.Unmarshal([]byte(xmlDesc), &deviceXML) if err != nil { - log.Fatalf("failed to unmarshal device usb_device XML into device_xml: %v", err) + log.Fatalf("failed to unmarshal device usb_device XML into deviceXML: %v", err) } - log.Printf("[DEBUG] Parsed device usb_device into device_xml: %v", device_xml) + log.Printf("[DEBUG] Parsed device usb_device into deviceXML: %v", deviceXML) c := map[string]interface{}{ - "type": device_xml.Capability.Type, - "bus": device_xml.Capability.Bus, - "device": device_xml.Capability.Device, + "type": deviceXML.Capability.Type, + "bus": deviceXML.Capability.Bus, + "device": deviceXML.Capability.Device, "product": map[string]interface{}{ - "id": device_xml.Capability.Product.Id, - "name": device_xml.Capability.Product.Name, + "id": deviceXML.Capability.Product.ID, + "name": deviceXML.Capability.Product.Name, }, "vendor": map[string]interface{}{ - "id": device_xml.Capability.Vendor.Id, - "name": device_xml.Capability.Vendor.Name, + "id": deviceXML.Capability.Vendor.ID, + "name": deviceXML.Capability.Vendor.Name, }, } capability = append(capability, c) @@ -609,42 +600,42 @@ func resourceLibvirtNodeDeviceInfoRead(d *schema.ResourceData, meta interface{}) ////////////////// USB Host ////////////////// case "usb": - device_xml := DeviceUSB{} - err = xml.Unmarshal([]byte(xml_desc), &device_xml) + deviceXML := DeviceUSB{} + err = xml.Unmarshal([]byte(xmlDesc), &deviceXML) if err != nil { - log.Fatalf("failed to unmarshal device usb XML into device_xml: %v", err) + log.Fatalf("failed to unmarshal device usb XML into deviceXML: %v", err) } - log.Printf("[DEBUG] Parsed device usb into device_xml: %v", device_xml) + log.Printf("[DEBUG] Parsed device usb into deviceXML: %v", deviceXML) c := map[string]interface{}{ - "type": device_xml.Capability.Type, - "number": fmt.Sprintf("%d", device_xml.Capability.Number), - "class": fmt.Sprintf("%d", device_xml.Capability.Class), - "subclass": fmt.Sprintf("%d", device_xml.Capability.Subclass), - "protocol": fmt.Sprintf("%d", device_xml.Capability.Protocol), - "description": device_xml.Capability.Description, + "type": deviceXML.Capability.Type, + "number": fmt.Sprintf("%d", deviceXML.Capability.Number), + "class": fmt.Sprintf("%d", deviceXML.Capability.Class), + "subclass": fmt.Sprintf("%d", deviceXML.Capability.Subclass), + "protocol": fmt.Sprintf("%d", deviceXML.Capability.Protocol), + "description": deviceXML.Capability.Description, } capability = append(capability, c) log.Printf("[DEBUG] Set capability type usb to : %v", capability) ////////////////// STORAGE ////////////////// case "storage": - device_xml := DeviceStorage{} - err = xml.Unmarshal([]byte(xml_desc), &device_xml) + deviceXML := DeviceStorage{} + err = xml.Unmarshal([]byte(xmlDesc), &deviceXML) if err != nil { - log.Fatalf("failed to unmarshal device storage XML into device_xml: %v", err) + log.Fatalf("failed to unmarshal device storage XML into deviceXML: %v", err) } - log.Printf("[DEBUG] Parsed device storage into device_xml: %v", device_xml) + log.Printf("[DEBUG] Parsed device storage into deviceXML: %v", deviceXML) c := map[string]interface{}{ - "type": device_xml.Capability.Type, - "block": device_xml.Capability.Block, - "drive_type": device_xml.Capability.DriveType, - "model": device_xml.Capability.Model, - "serial": device_xml.Capability.Serial, - "size": fmt.Sprintf("%d", device_xml.Capability.Size), - "logical_block_size": fmt.Sprintf("%d", device_xml.Capability.LogicalBlockSize), - "num_blocks": fmt.Sprintf("%d", device_xml.Capability.NumBlocks), + "type": deviceXML.Capability.Type, + "block": deviceXML.Capability.Block, + "drive_type": deviceXML.Capability.DriveType, + "model": deviceXML.Capability.Model, + "serial": deviceXML.Capability.Serial, + "size": fmt.Sprintf("%d", deviceXML.Capability.Size), + "logical_block_size": fmt.Sprintf("%d", deviceXML.Capability.LogicalBlockSize), + "num_blocks": fmt.Sprintf("%d", deviceXML.Capability.NumBlocks), } capability = append(capability, c) @@ -652,24 +643,24 @@ func resourceLibvirtNodeDeviceInfoRead(d *schema.ResourceData, meta interface{}) ////////////////// NET ////////////////// case "net": - device_xml := DeviceNet{} - err = xml.Unmarshal([]byte(xml_desc), &device_xml) + deviceXML := DeviceNet{} + err = xml.Unmarshal([]byte(xmlDesc), &deviceXML) if err != nil { - log.Fatalf("failed to unmarshal device net XML into device_xml: %v", err) + log.Fatalf("failed to unmarshal device net XML into deviceXML: %v", err) } - log.Printf("[DEBUG] Parsed device net into device_xml: %v", device_xml) + log.Printf("[DEBUG] Parsed device net into deviceXML: %v", deviceXML) c := map[string]interface{}{ - "type": device_xml.Capability.Type, - "interface": device_xml.Capability.Interface, - "address": device_xml.Capability.Address, + "type": deviceXML.Capability.Type, + "interface": deviceXML.Capability.Interface, + "address": deviceXML.Capability.Address, "link": map[string]interface{}{ - "speed": device_xml.Capability.Link.Speed, - "state": device_xml.Capability.Link.State, + "speed": deviceXML.Capability.Link.Speed, + "state": deviceXML.Capability.Link.State, }, - "features": device_xml.Capability.Feature.Name, + "features": deviceXML.Capability.Feature.Name, "capability": map[string]interface{}{ - "type": device_xml.Capability.Cappability.Type, + "type": deviceXML.Capability.Cappability.Type, }, } @@ -678,20 +669,20 @@ func resourceLibvirtNodeDeviceInfoRead(d *schema.ResourceData, meta interface{}) ////////////////// SCSI ////////////////// case "scsi": - device_xml := DeviceSCSI{} - err = xml.Unmarshal([]byte(xml_desc), &device_xml) + deviceXML := DeviceSCSI{} + err = xml.Unmarshal([]byte(xmlDesc), &deviceXML) if err != nil { - log.Fatalf("failed to unmarshal device scsi XML into device_xml: %v", err) + log.Fatalf("failed to unmarshal device scsi XML into deviceXML: %v", err) } - log.Printf("[DEBUG] Parsed device scsi into device_xml: %v", device_xml) + log.Printf("[DEBUG] Parsed device scsi into deviceXML: %v", deviceXML) c := map[string]interface{}{ - "type": device_xml.Capability.Type, - "host": fmt.Sprintf("%d", device_xml.Capability.Host), - "bus": fmt.Sprintf("%d", device_xml.Capability.Bus), - "target": fmt.Sprintf("%d", device_xml.Capability.Target), - "lun": fmt.Sprintf("%d", device_xml.Capability.Lun), - "scsi_type": device_xml.Capability.ScsiType, + "type": deviceXML.Capability.Type, + "host": fmt.Sprintf("%d", deviceXML.Capability.Host), + "bus": fmt.Sprintf("%d", deviceXML.Capability.Bus), + "target": fmt.Sprintf("%d", deviceXML.Capability.Target), + "lun": fmt.Sprintf("%d", deviceXML.Capability.Lun), + "scsi_type": deviceXML.Capability.ScsiType, } capability = append(capability, c) @@ -699,17 +690,17 @@ func resourceLibvirtNodeDeviceInfoRead(d *schema.ResourceData, meta interface{}) ////////////////// SCSI Host ////////////////// case "scsi_host": - device_xml := DeviceSCSIHost{} - err = xml.Unmarshal([]byte(xml_desc), &device_xml) + deviceXML := DeviceSCSIHost{} + err = xml.Unmarshal([]byte(xmlDesc), &deviceXML) if err != nil { - log.Fatalf("failed to unmarshal device scsi_host XML into device_xml: %v", err) + log.Fatalf("failed to unmarshal device scsi_host XML into deviceXML: %v", err) } - log.Printf("[DEBUG] Parsed device scsi_host into device_xml: %v", device_xml) + log.Printf("[DEBUG] Parsed device scsi_host into deviceXML: %v", deviceXML) c := map[string]interface{}{ - "type": device_xml.Capability.Type, - "host": fmt.Sprintf("%d", device_xml.Capability.Host), - "unique_id": fmt.Sprintf("%d", device_xml.Capability.UniqueID), + "type": deviceXML.Capability.Type, + "host": fmt.Sprintf("%d", deviceXML.Capability.Host), + "unique_id": fmt.Sprintf("%d", deviceXML.Capability.UniqueID), } capability = append(capability, c) @@ -717,22 +708,22 @@ func resourceLibvirtNodeDeviceInfoRead(d *schema.ResourceData, meta interface{}) ////////////////// SCSI Host ////////////////// case "drm": - device_xml := DeviceDRM{} - err = xml.Unmarshal([]byte(xml_desc), &device_xml) + deviceXML := DeviceDRM{} + err = xml.Unmarshal([]byte(xmlDesc), &deviceXML) if err != nil { - log.Fatalf("failed to unmarshal device drm XML into device_xml: %v", err) + log.Fatalf("failed to unmarshal device drm XML into deviceXML: %v", err) } - log.Printf("[DEBUG] Parsed device drm into device_xml: %v", device_xml) + log.Printf("[DEBUG] Parsed device drm into deviceXML: %v", deviceXML) c := map[string]interface{}{ - "type": device_xml.Capability.Type, - "drm_type": device_xml.Capability.DRMType, + "type": deviceXML.Capability.Type, + "drm_type": deviceXML.Capability.DRMType, } capability = append(capability, c) devnode := []map[string]interface{}{} - for _, v := range device_xml.Devnode { + for _, v := range deviceXML.Devnode { m := map[string]interface{}{ "type": v.Type, "path": v.Path, @@ -742,18 +733,18 @@ func resourceLibvirtNodeDeviceInfoRead(d *schema.ResourceData, meta interface{}) log.Printf("[DEBUG] Set capability type drm to : %v", capability) d.Set("devnode", devnode) - log.Printf("[DEBUG] Set devnode type drm to : %v", device_xml.Devnode) + log.Printf("[DEBUG] Set devnode type drm to : %v", deviceXML.Devnode) default: - log.Fatalf("Unknown device capability type: %v", device_xml.Capability.Type) + return fmt.Errorf("unknown device capability type: %v", deviceXML.Capability.Type) } - d.Set("xml", xml_desc) - d.Set("path", device_xml.Path) - d.Set("parent", device_xml.Parent) + d.Set("xml", xmlDesc) + d.Set("path", deviceXML.Path) + d.Set("parent", deviceXML.Parent) log.Printf("[DEBUG] d.Set capability type %s : %s", capability[0]["type"], capability) d.Set("capability", capability) - d.SetId(strconv.Itoa(hashcode.String(fmt.Sprintf("%v", xml_desc)))) + d.SetId(strconv.Itoa(hashcode.String(fmt.Sprintf("%v", xmlDesc)))) return nil } diff --git a/libvirt/data_source_libvirt_node_device_info_test.go b/libvirt/data_source_libvirt_node_device_info_test.go index 287b8140a..9eaaf68b9 100644 --- a/libvirt/data_source_libvirt_node_device_info_test.go +++ b/libvirt/data_source_libvirt_node_device_info_test.go @@ -13,13 +13,13 @@ func TestAccLibvirtNodeDeviceInfoDataSource(t *testing.T) { Providers: testAccProviders, Steps: []resource.TestStep{ { - Config: testAccDataSourceNodeDeviceInfo_pci, + Config: testAccDataSourceNodeDeviceInfoPCI, Check: resource.ComposeTestCheckFunc( resource.TestMatchResourceAttr( "data.libvirt_node_device_info.device", "name", regexp.MustCompile(`^pci_0000_00_00_0$`)), ), }, { - Config: testAccDataSourceNodeDeviceInfo_system, + Config: testAccDataSourceNodeDeviceInfoSystem, Check: resource.ComposeTestCheckFunc( resource.TestMatchResourceAttr( "data.libvirt_node_device_info.device", "name", regexp.MustCompile(`^computer$`)), @@ -29,12 +29,12 @@ func TestAccLibvirtNodeDeviceInfoDataSource(t *testing.T) { }) } -const testAccDataSourceNodeDeviceInfo_pci = ` +const testAccDataSourceNodeDeviceInfoPCI = ` data "libvirt_node_device_info" "device" { name = "pci_0000_00_00_0" }` -const testAccDataSourceNodeDeviceInfo_system = ` +const testAccDataSourceNodeDeviceInfoSystem = ` data "libvirt_node_device_info" "device" { name = "computer" }` diff --git a/libvirt/data_source_libvirt_node_devices.go b/libvirt/data_source_libvirt_node_devices.go index ce6e9bf5d..cca51811a 100644 --- a/libvirt/data_source_libvirt_node_devices.go +++ b/libvirt/data_source_libvirt_node_devices.go @@ -56,12 +56,12 @@ func resourceLibvirtNodeDevicesRead(d *schema.ResourceData, meta interface{}) er rnum, err := virConn.NodeNumOfDevices(libvirt.OptString(cap), 0) if err != nil { - return fmt.Errorf("failed to retrieve number of devices: %v", err) + return fmt.Errorf("failed to retrieve number of devices: %w", err) } devices, err := virConn.NodeListDevices(cap, rnum, 0) if err != nil { - return fmt.Errorf("failed to retrieve list of node devices: %v", err) + return fmt.Errorf("failed to retrieve list of node devices: %w", err) } d.Set("devices", devices) diff --git a/libvirt/data_source_libvirt_node_info.go b/libvirt/data_source_libvirt_node_info.go index 1d601a60b..b76a93db2 100644 --- a/libvirt/data_source_libvirt_node_info.go +++ b/libvirt/data_source_libvirt_node_info.go @@ -66,7 +66,7 @@ func resourceLibvirtNodeInfoRead(d *schema.ResourceData, meta interface{}) error model, memory, cpus, _, nodes, sockets, cores, threads, err := virConn.NodeGetInfo() if err != nil { - return fmt.Errorf("failed to retrieve domains: %v", err) + return fmt.Errorf("failed to retrieve domains: %w", err) } d.Set("cpu_model", int8ToString(model)) From ba9549654f74f00beb49688beb12e8f15913475e Mon Sep 17 00:00:00 2001 From: Catalin Muresan Date: Thu, 9 Nov 2023 16:20:21 +0000 Subject: [PATCH 10/16] Fixed [32]int8 to string conversion to ignore zeroes --- libvirt/data_source_libvirt_node_info.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/libvirt/data_source_libvirt_node_info.go b/libvirt/data_source_libvirt_node_info.go index b76a93db2..36ee8b9f9 100644 --- a/libvirt/data_source_libvirt_node_info.go +++ b/libvirt/data_source_libvirt_node_info.go @@ -85,6 +85,9 @@ func resourceLibvirtNodeInfoRead(d *schema.ResourceData, meta interface{}) error func int8ToString(bs [32]int8) string { ba := []uint8{} for _, b := range bs { + if b == 0 { + break + } ba = append(ba, uint8(b)) } return string(ba) From 4bc98a07ed37b8317c080b538f45f8f1b827fb17 Mon Sep 17 00:00:00 2001 From: Catalin Muresan Date: Tue, 14 Nov 2023 16:50:46 +0000 Subject: [PATCH 11/16] Fixed underscore in variable name --- libvirt/data_source_libvirt_node_device_info.go | 2 +- libvirt/data_source_libvirt_node_devices_test.go | 8 ++++---- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/libvirt/data_source_libvirt_node_device_info.go b/libvirt/data_source_libvirt_node_device_info.go index 1b01b6c64..90076eeb4 100644 --- a/libvirt/data_source_libvirt_node_device_info.go +++ b/libvirt/data_source_libvirt_node_device_info.go @@ -493,7 +493,7 @@ func resourceLibvirtNodeDeviceInfoRead(d *schema.ResourceData, meta interface{}) if err != nil { log.Fatalf("failed to unmarshal XML into deviceXML: %v", err) } - log.Printf("[DEBUG] Parsed device generic into deviceXML: %v", deviceXML) + log.Printf("[DEBUG] Parsed device generic into deviceXML: %#v", deviceXML) switch deviceXML.Capability.Type { ////////////////// SYSTEM ////////////////// diff --git a/libvirt/data_source_libvirt_node_devices_test.go b/libvirt/data_source_libvirt_node_devices_test.go index e149bca41..3f12b3707 100644 --- a/libvirt/data_source_libvirt_node_devices_test.go +++ b/libvirt/data_source_libvirt_node_devices_test.go @@ -13,14 +13,14 @@ func TestAccLibvirtNodeDevicesDataSource(t *testing.T) { Providers: testAccProviders, Steps: []resource.TestStep{ { - Config: testAccDataSourceNodeDevices_pci, + Config: testAccDataSourceNodeDevicesPci, Check: resource.ComposeTestCheckFunc( resource.TestMatchResourceAttr( "data.libvirt_node_devices.node", "devices[0]", regexp.MustCompile(`^pci_\d{4}_\d{2}_\d{2}_\d{1}`)), ), }, { - Config: testAccDataSourceNodeDevices_system, + Config: testAccDataSourceNodeDevicesSystem, Check: resource.ComposeTestCheckFunc( resource.TestMatchResourceAttr( "data.libvirt_node_devices.node", "devices[0]", regexp.MustCompile(`^computer$`)), @@ -30,12 +30,12 @@ func TestAccLibvirtNodeDevicesDataSource(t *testing.T) { }) } -const testAccDataSourceNodeDevices_pci = ` +const testAccDataSourceNodeDevicesPci = ` data "libvirt_node_devices" "node" { capability = "pci" }` -const testAccDataSourceNodeDevices_system = ` +const testAccDataSourceNodeDevicesSystem = ` data "libvirt_node_devices" "node" { capability = "system" }` From c355736958d5006b31e01c8ac25c49a7bee0f6ff Mon Sep 17 00:00:00 2001 From: Catalin Muresan Date: Tue, 14 Nov 2023 16:55:23 +0000 Subject: [PATCH 12/16] Fix comment warning --- libvirt/data_source_libvirt_node_device_info.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libvirt/data_source_libvirt_node_device_info.go b/libvirt/data_source_libvirt_node_device_info.go index 90076eeb4..d72d0346d 100644 --- a/libvirt/data_source_libvirt_node_device_info.go +++ b/libvirt/data_source_libvirt_node_device_info.go @@ -10,7 +10,7 @@ import ( "github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema" ) -// strutures to parse device XML just enough to get Capability.Type +// strutures to parse device XML just enough to get Capability.Type. type DeviceGeneric struct { Device xml.Name `xml:"device"` Name string `xml:"name"` From 95024d9e4eb18e54b2bc6a2f311ee28552e366c6 Mon Sep 17 00:00:00 2001 From: Catalin Muresan Date: Sun, 19 Nov 2023 11:47:36 +0000 Subject: [PATCH 13/16] Sorted devices since sometimes they are not --- libvirt/data_source_libvirt_node_devices.go | 2 ++ 1 file changed, 2 insertions(+) diff --git a/libvirt/data_source_libvirt_node_devices.go b/libvirt/data_source_libvirt_node_devices.go index cca51811a..fb8ac4284 100644 --- a/libvirt/data_source_libvirt_node_devices.go +++ b/libvirt/data_source_libvirt_node_devices.go @@ -3,6 +3,7 @@ package libvirt import ( "fmt" "log" + "sort" "strconv" libvirt "github.com/digitalocean/go-libvirt" @@ -64,6 +65,7 @@ func resourceLibvirtNodeDevicesRead(d *schema.ResourceData, meta interface{}) er return fmt.Errorf("failed to retrieve list of node devices: %w", err) } + sort.Strings(devices) d.Set("devices", devices) d.SetId(strconv.Itoa(hashcode.String(fmt.Sprintf("%v", devices)))) From a814d6e4f6938677171b8b9442b8e8bd2b57c147 Mon Sep 17 00:00:00 2001 From: Catalin Muresan Date: Thu, 23 Nov 2023 13:47:30 +0000 Subject: [PATCH 14/16] Changed output to set, since there are no duplicates --- libvirt/data_source_libvirt_node_devices.go | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libvirt/data_source_libvirt_node_devices.go b/libvirt/data_source_libvirt_node_devices.go index fb8ac4284..0f8339ac2 100644 --- a/libvirt/data_source_libvirt_node_devices.go +++ b/libvirt/data_source_libvirt_node_devices.go @@ -30,7 +30,7 @@ func datasourceLibvirtNodeDevices() *schema.Resource { Optional: true, }, "devices": { - Type: schema.TypeList, + Type: schema.TypeSet, Computed: true, Elem: &schema.Schema{ Type: schema.TypeString, From 42489117d36ba74842a5cc22980f078c4920ad8e Mon Sep 17 00:00:00 2001 From: Catalin Muresan Date: Mon, 27 Nov 2023 13:05:30 +0000 Subject: [PATCH 15/16] Update website/libvirt.erb Co-authored-by: Mike Beaumont --- website/libvirt.erb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/libvirt.erb b/website/libvirt.erb index 28d1f4e01..b7793cce0 100644 --- a/website/libvirt.erb +++ b/website/libvirt.erb @@ -31,7 +31,7 @@
> - Data Sesources + Data Resources
    > libvirt_node_devices From 4892b8f1710432eec8035aff8e12724e3eda9ce4 Mon Sep 17 00:00:00 2001 From: Catalin Muresan Date: Thu, 7 Dec 2023 14:12:40 +0000 Subject: [PATCH 16/16] Fixed typo in website --- website/libvirt.erb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/libvirt.erb b/website/libvirt.erb index b7793cce0..fbf6e288d 100644 --- a/website/libvirt.erb +++ b/website/libvirt.erb @@ -31,7 +31,7 @@
> - Data Resources + Data Sources