Add collector to get pci and lsmod data

  and some debug to wrapper

Author: brett060102

build/packaging/suseconnect-ng.spec

@@ -56,6 +56,7 @@ Requires:       ca-certificates
 %endif
 
 Requires:       coreutils
+Requires:       pciutils
 Requires:       zypper
 Requires:       util-linux
 Recommends:     systemd

cmd/suseconnect/suseconnect.go

@@ -118,6 +118,7 @@ func main() {
 	flag.BoolVar(&info, "i", false, "")
 
 	flag.Parse()
+
 	if version {
 		fmt.Println(connect.GetShortenedVersion())
 		os.Exit(0)
@@ -263,6 +264,9 @@ func main() {
 		fmt.Println(output)
 		os.Exit(0)
 	} else if deRegister {
+		// Need to clear ProfileCache on deregister
+		// even if dereg does not succeed.
+		util.DeleteProfileCache()
 		err := connect.Deregister(api, opts)
 		if jsonFlag && err != nil {
 			out := connect.RegisterOut{Success: false, Message: err.Error()}
@@ -276,6 +280,9 @@ func main() {
 		if jsonFlag {
 			exitOnError(errors.New("cannot use the json option with the 'cleanup' command"), api, opts)
 		}
+		// Need to clear ProfileCache on cleanup
+		// even if cleanup does not succeed.
+		util.DeleteProfileCache()
 		err := connect.Cleanup(opts.BaseURL, opts.FsRoot)
 		exitOnError(err, api, opts)
 	} else if rollback {
@@ -285,7 +292,7 @@ func main() {
 		err := connect.Rollback(api.GetConnection(), opts)
 		exitOnError(err, api, opts)
 	} else if info {
-		sysInfo, err := connect.FetchSystemInformation()
+		sysInfo, err := connect.FetchSystemInformation("")
 		exitOnError(err, api, opts)
 
 		out, err := json.Marshal(sysInfo)
@@ -348,6 +355,10 @@ func exitOnError(err error, api connect.WrappedAPI, opts *connect.Options) {
 	if err == nil {
 		return
 	}
+	// If we take an error exit, delete the profile cache
+	// the worst thing that happens is we will send profile
+	// data when we don't need to, but that is OK.
+	util.DeleteProfileCache()
 	if ze, ok := err.(zypper.ZypperError); ok {
 		fmt.Println(ze)
 		os.Exit(ze.ExitCode)

internal/collectors/collectors.go

@@ -24,7 +24,7 @@ import (
 	"github.com/SUSE/connect-ng/internal/util"
 )
 
-type Result = map[string]interface{}
+type Result = util.Result
 
 const (
 	ARCHITECTURE_X86_64 = "x86_64"

internal/collectors/lsmod.go

@@ -0,0 +1,60 @@
+package collectors
+
+import (
+	"bufio"
+	"bytes"
+	"sort"
+	"strings"
+
+	"github.com/SUSE/connect-ng/internal/util"
+)
+
+type LSMOD struct {
+	UpdateDataIDs bool
+}
+
+const kernModChecksumFile = "kern-modules.txt"
+const lsmodTag = "mod_list"
+
+// process output from lsmod to remove dups and get sorted list of kernel mods.
+func getKernelMods(inputStream []byte) ([]string, error) {
+	scanner := bufio.NewScanner(bytes.NewReader(inputStream))
+
+	// Iterate through each line get module name
+	itemMap := make(map[string]bool)
+	// Skip header line
+	scanner.Scan()
+	for scanner.Scan() {
+		item := strings.Fields(scanner.Text())[0]
+		itemMap[item] = true // update item map
+	}
+	// Return nil and erroe if errors in scanning
+	if err := scanner.Err(); err != nil {
+		return nil, err
+	}
+
+	// Run through module list removing duplicates
+	var sortedList []string
+	for module := range itemMap {
+		sortedList = append(sortedList, module)
+	}
+
+	// Sort the list,
+	sort.Strings(sortedList)
+	return sortedList, nil
+}
+
+func (lsmod LSMOD) run(arch string) (Result, error) {
+	util.Debug.Print("lsmod.UpdateDataIDs: ", lsmod.UpdateDataIDs)
+	modInfo, err := util.Execute([]string{"lsmod"}, nil)
+	// Should not happen, but if command fails
+	// send nil Result if module data was unavailable.
+	if err != nil {
+		return Result{}, err
+	}
+
+	sortedMods, err := getKernelMods(modInfo)
+	result, err := util.UpdateCache(lsmod.UpdateDataIDs, lsmodTag, kernModChecksumFile, sortedMods)
+
+	return result, err
+}

internal/collectors/lsmod_test.go

@@ -0,0 +1,115 @@
+package collectors
+
+import (
+	"fmt"
+	"os"
+	"testing"
+
+	"github.com/SUSE/connect-ng/internal/util"
+	"github.com/stretchr/testify/assert"
+)
+
+var lsmodDataBlob util.Profile
+var kernModTestData string
+
+func setupLSMODTestData() {
+	testProfilePath, _ := os.MkdirTemp("/tmp/", "__suseconnect")
+	util.SetProfileFilePath(testProfilePath + "/")
+
+	lsmodDataBlob.ProfileID = "a27b6fd9514de9b56319922c0af28783ceec4d36230e16a32d35b060fa733c33"
+
+	lsmodDataBlob.ProfileData = []string{"acpi_tad", "autofs4", "ccp", "dmi_sysfs", "efi_pstore", "hid_generic", "i2c_algo_bit", "i2c_piix4", "i2c_smbus", "input_leds", "ip_tables", "joydev", "k10temp", "lp", "mac_hid", "mc", "msr", "nfnetlink", "nvme", "nvme_core", "parport", "parport_pc", "ppdev", "psmouse", "r8169", "rc_core", "realtek", "sch_fq_codel", "snd_pci_acp3x", "snd_soc_acpi", "soundcore", "usbhid", "x_tables"}
+
+	kernModTestData = `Module                  Size  Used by
+rc_core                73728  1 cec
+snd_soc_acpi           16384  3 snd_sof_amd_acp,snd_acp_config,snd_pci_ps
+i2c_piix4              32768  0
+mc                     81920  5 videodev,snd_usb_audio,videobuf2_v4l2,uvcvideo,videobuf2_common
+k10temp                16384  0
+i2c_algo_bit           16384  1 amdgpu
+i2c_smbus              20480  1 i2c_piix4
+soundcore              16384  1 snd
+ccp                   155648  1 kvm_amd
+snd_pci_acp3x          16384  0
+input_leds             12288  0
+joydev                 32768  0
+acpi_tad               20480  0
+mac_hid                12288  0
+sch_fq_codel           24576  4
+msr                    12288  0
+parport_pc             53248  0
+ppdev                  24576  0
+lp                     28672  0
+parport                73728  3 parport_pc,lp,ppdev
+efi_pstore             12288  0
+nfnetlink              20480  5 nft_compat,nf_tables,ip_set
+dmi_sysfs              24576  0
+ip_tables              32768  0
+x_tables               65536  9 xt_conntrack,nft_compat,xt_tcpudp,xt_addrtype,xt_CHECKSU,Mxt_set,ipt_REJECT,ip_tables,xt_MASQUERADE
+autofs4                57344  2
+hid_generic            12288  0
+usbhid                 77824  0
+nvme                   61440  2
+psmouse               217088  0
+r8169                 126976  0
+nvme_core             225280  3 nvme
+realtek                49152  2
+`
+}
+
+func TestLSMODRunSuccessNoUPdate(t *testing.T) {
+	assert := assert.New(t)
+	setupLSMODTestData()
+
+	mockUtilExecute(kernModTestData, nil)
+	expected := Result{lsmodTag: lsmodDataBlob}
+
+	collector := LSMOD{UpdateDataIDs: false}
+	result, err := collector.run(ARCHITECTURE_X86_64)
+
+	assert.Equal(expected, result)
+	assert.Nil(err)
+}
+
+func TestLSMODRunSuccessUpdate(t *testing.T) {
+	assert := assert.New(t)
+
+	mockUtilExecute(kernModTestData, nil)
+	expected := Result{lsmodTag: lsmodDataBlob}
+
+	collector := LSMOD{UpdateDataIDs: true}
+	result, err := collector.run(ARCHITECTURE_X86_64)
+
+	assert.Equal(expected, result)
+	assert.Nil(err)
+}
+
+func TestLSMODRunSumsMatch(t *testing.T) {
+	assert := assert.New(t)
+
+	mockUtilExecute(kernModTestData, nil)
+
+	collector := LSMOD{UpdateDataIDs: true}
+	result, err := collector.run(ARCHITECTURE_X86_64)
+
+	var expectedDataBlob util.Profile
+	expectedDataBlob.ProfileID = lsmodDataBlob.ProfileID
+	expected := Result{lsmodTag: expectedDataBlob}
+
+	assert.Equal(expected, result)
+	assert.Nil(err)
+}
+
+func TestLSMODRunFail(t *testing.T) {
+	assert := assert.New(t)
+
+	mockUtilExecute("", fmt.Errorf("forced error"))
+	expected := Result{}
+
+	collector := LSMOD{}
+	result, err := collector.run(ARCHITECTURE_X86_64)
+	util.DeleteProfileCache()
+
+	assert.Equal(expected, result)
+	assert.ErrorContains(err, "forced error")
+}

internal/collectors/pci.go

@@ -0,0 +1,27 @@
+package collectors
+
+import (
+	"github.com/SUSE/connect-ng/internal/util"
+)
+
+const pciChecksumFile = "pci-devices.txt"
+const pciTag = "pci_data"
+
+type PCI struct {
+	UpdateDataIDs bool
+}
+
+func (pci PCI) run(arch string) (Result, error) {
+	util.Debug.Print("pci.UpdateDataIDs: ", pci.UpdateDataIDs)
+	output, err := util.Execute([]string{"lspci", "-s", ".0"}, nil)
+	// Some systems may not have lspci command, so
+	// if the execute fails,
+	// returb nil Resukt if PCI data was unavailable.
+	if err != nil {
+		return Result{}, err
+	}
+	stringOutput := string(output)
+	result, err := util.UpdateCache(pci.UpdateDataIDs, pciTag, pciChecksumFile, stringOutput)
+
+	return result, err
+}

internal/collectors/pci_test.go

@@ -0,0 +1,77 @@
+package collectors
+
+import (
+	"fmt"
+	"os"
+	"testing"
+
+	"github.com/SUSE/connect-ng/internal/util"
+	"github.com/stretchr/testify/assert"
+)
+
+var pciDataBlob util.Profile
+
+func setupPciTestData() {
+	testProfilePath, _ := os.MkdirTemp("/tmp/", "__suseconnect")
+	util.SetProfileFilePath(testProfilePath + "/")
+
+	pciDataBlob.ProfileID = "de5b2af84042cbe8298be6864362a99bae3e087fea4efcdad9e33f58fa323185"
+
+	pciDataBlob.ProfileData = "00:00.0 Host bridge: Advanced Micro Devices, Inc. [AMD] Family 17h-19h PCIe Root Complex (rev 01)\n00:01.0 Host bridge: Advanced Micro Devices, Inc. [AMD] Family 17h-19h PCIe Dummy Host Bridge (rev 01)\n00:02.0 Host bridge: Advanced Micro Devices, Inc. [AMD] Family 17h-19h PCIe Dummy Host Bridge (rev 01)\n00:03.0 Host bridge: Advanced Micro Devices, Inc. [AMD] Family 17h-19h PCIe Dummy Host Bridge (rev 01)\n00:04.0 Host bridge: Advanced Micro Devices, Inc. [AMD] Family 17h-19h PCIe Dummy Host Bridge (rev 01)\n00:08.0 Host bridge: Advanced Micro Devices, Inc. [AMD] Family 17h-19h PCIe Dummy Host Bridge (rev 01)\n00:14.0 SMBus: Advanced Micro Devices, Inc. [AMD] FCH SMBus Controller (rev 71)\n00:18.0 Host bridge: Advanced Micro Devices, Inc. [AMD] Rembrandt Data Fabric: Device 18h; Function 0\n01:00.0 Non-Volatile memory controller: Micron/Crucial Technology Device 5426 (rev 01)\n02:00.0 Network controller: Intel Corporation Wi-Fi 6 AX200 (rev 1a)\n03:00.0 Ethernet controller: Realtek Semiconductor Co., Ltd. RTL8111/8168/8211/8411 PCI Express Gigabit Ethernet Controller (rev 15)\n04:00.0 Ethernet controller: Realtek Semiconductor Co., Ltd. RTL8111/8168/8211/8411 PCI Express Gigabit Ethernet Controller (rev 15)\n05:00.0 VGA compatible controller: Advanced Micro Devices, Inc. [AMD/ATI] Rembrandt [Radeon 680M] (rev c7)\n06:00.0 USB controller: Advanced Micro Devices, Inc. [AMD] Rembrandt USB4 XHCI controller #8"
+}
+
+func TestPCIRunSuccessNoUpdate(t *testing.T) {
+	assert := assert.New(t)
+	setupPciTestData()
+	mockUtilExecute(pciDataBlob.ProfileData.(string), nil)
+	expected := Result{pciTag: pciDataBlob}
+
+	collector := PCI{UpdateDataIDs: false}
+	result, err := collector.run(ARCHITECTURE_X86_64)
+	assert.Equal(expected, result)
+	assert.Nil(err)
+}
+
+func TestPCIRunSuccessUpdate(t *testing.T) {
+	assert := assert.New(t)
+
+	mockUtilExecute(pciDataBlob.ProfileData.(string), nil)
+	expected := Result{pciTag: pciDataBlob}
+
+	collector := PCI{UpdateDataIDs: true}
+	result, err := collector.run(ARCHITECTURE_X86_64)
+
+	assert.Equal(expected, result)
+	assert.Nil(err)
+}
+
+func TestPCIRunSumsMatch(t *testing.T) {
+	assert := assert.New(t)
+
+	mockUtilExecute(pciDataBlob.ProfileData.(string), nil)
+
+	collector := PCI{UpdateDataIDs: true}
+	result, err := collector.run(ARCHITECTURE_X86_64)
+	fmt.Println(result)
+
+	var expectedDataBlob util.Profile
+	expectedDataBlob.ProfileID = pciDataBlob.ProfileID
+	expected := Result{pciTag: expectedDataBlob}
+
+	assert.Equal(expected, result)
+	assert.Nil(err)
+}
+
+func TestPCIRunFail(t *testing.T) {
+	assert := assert.New(t)
+
+	mockUtilExecute("", fmt.Errorf("forced error"))
+	expected := Result{}
+
+	collector := PCI{}
+	result, err := collector.run(ARCHITECTURE_X86_64)
+
+	util.DeleteProfileCache()
+	assert.Equal(expected, result)
+	assert.ErrorContains(err, "forced error")
+}