feat(internal/collector): MULTI-1736 implement sysinfo collection on Linux

internal/cmdutils/cmd.go

@@ -0,0 +1,34 @@
+// Package cmdutils provides utility functions for running commands.
+package cmdutils
+
+import (
+	"bytes"
+	"context"
+	"os"
+	"os/exec"
+	"time"
+)
+
+// Run executes the command specified by cmd with arguments args using the provided context.
+// Returns stdout and stderr output and error code.
+func Run(ctx context.Context, cmd string, args ...string) (stdout, stderr *bytes.Buffer, err error) {
+	stdout = &bytes.Buffer{}
+	stderr = &bytes.Buffer{}
+
+	c := exec.CommandContext(ctx, cmd, args...)
+	c.Stdout = stdout
+	c.Stderr = stderr
+	c.Env = append(c.Env, "LANG=C")
+	c.Env = append(c.Env, os.Environ()...)
+	err = c.Run()
+
+	return stdout, stderr, err
+}
+
+// RunWithTimeout calls Run but a timeout is added to the provided context.
+func RunWithTimeout(ctx context.Context, timeout time.Duration, cmd string, args ...string) (stdout, stderr *bytes.Buffer, err error) {
+	c, cancel := context.WithTimeout(ctx, timeout)
+	defer cancel()
+
+	return Run(c, cmd, args...)
+}

internal/collector/sysinfo/export_test.go

@@ -1,8 +1,29 @@
 package sysinfo
 
-// WithRoot overrides default root directory of the system.
-func WithRoot(root string) Options {
+import (
+	"log/slog"
+
+	"github.com/ubuntu/ubuntu-insights/internal/collector/sysinfo/hardware"
+	"github.com/ubuntu/ubuntu-insights/internal/collector/sysinfo/software"
+)
+
+// WithHardwareCollector overrides the default hardware collector.
+func WithHardwareCollector(hw CollectorT[hardware.Info]) Options {
+	return func(o *options) {
+		o.hw = hw
+	}
+}
+
+// WithSoftwareCollector overrides the default software collector.
+func WithSoftwareCollector(sw CollectorT[software.Info]) Options {
+	return func(o *options) {
+		o.sw = sw
+	}
+}
+
+// WithLogger overrides the default logger.
+func WithLogger(logger slog.Handler) Options {
 	return func(o *options) {
-		o.root = root
+		o.log = slog.New(logger)
 	}
 }

internal/collector/sysinfo/hardware/export_linux_test.go

@@ -0,0 +1,29 @@
+package hardware
+
+// WithRoot overrides default root directory of the system.
+func WithRoot(root string) Options {
+	return func(o *options) {
+		o.root = root
+	}
+}
+
+// WithCpuInfo overrides default cpu info.
+func WithCPUInfo(cmd []string) Options {
+	return func(o *options) {
+		o.cpuInfoCmd = cmd
+	}
+}
+
+// WithCpuInfo overrides default blk info.
+func WithBlkInfo(cmd []string) Options {
+	return func(o *options) {
+		o.lsblkCmd = cmd
+	}
+}
+
+// WithScreenInfo overrides default screen info.
+func WithScreenInfo(cmd []string) Options {
+	return func(o *options) {
+		o.screenCmd = cmd
+	}
+}

internal/collector/sysinfo/hardware/export_test.go

@@ -0,0 +1,12 @@
+package hardware
+
+import (
+	"log/slog"
+)
+
+// WithLogger overrides the default logger.
+func WithLogger(logger slog.Handler) Options {
+	return func(o *options) {
+		o.log = slog.New(logger)
+	}
+}

internal/collector/sysinfo/hardware/hardware.go

@@ -0,0 +1,100 @@
+// Package hardware handles collecting "common" hardware information for all insight reports.
+package hardware
+
+// Info aggregates hardware info.
+type Info struct {
+	Product product
+
+	CPU     cpu
+	GPUs    []gpu
+	Mem     memory
+	Blks    []disk
+	Screens []screen
+}
+
+type product map[string]string
+type cpu map[string]string
+type gpu map[string]string
+type memory map[string]int
+
+// DiskInfo contains information of a disk or partition.
+type disk struct {
+	Name string `json:"name"`
+	Size string `json:"size"`
+
+	Partitions []disk `json:"partitions,omitempty"`
+}
+
+// Screen contains information for a screen.
+type screen struct {
+	Name               string `json:"name"`
+	PhysicalResolution string `json:"physicalResolution"`
+	Size               string `json:"size"`
+	Resolution         string `json:"resolution"`
+	RefreshRate        string `json:"refreshRate"`
+}
+
+// Collector handles dependencies for collecting hardware information.
+// Collector implements CollectorT[hardware.Info].
+type Collector struct {
+	opts options
+}
+
+// Options are the variadic options available to the Collector.
+type Options func(*options)
+
+// New returns a new Collector.
+func New(args ...Options) Collector {
+	// options defaults are platform dependent.
+	opts := defaultOptions()
+	for _, opt := range args {
+		opt(opts)
+	}
+
+	return Collector{
+		opts: *opts,
+	}
+}
+
+// Collect aggregates the data from all the other hardware collect functions.
+func (s Collector) Collect() (info Info, err error) {
+	s.opts.log.Debug("collecting hardware info")
+
+	info.Product, err = s.collectProduct()
+	if err != nil {
+		s.opts.log.Warn("failed to collect Product info", "error", err)
+		info.Product = product{}
+	}
+
+	info.CPU, err = s.collectCPU()
+	if err != nil {
+		s.opts.log.Warn("failed to collect CPU info", "error", err)
+		info.CPU = cpu{}
+	}
+
+	info.GPUs, err = s.collectGPUs()
+	if err != nil {
+		s.opts.log.Warn("failed to collect GPU info", "error", err)
+		info.GPUs = []gpu{}
+	}
+
+	info.Mem, err = s.collectMemory()
+	if err != nil {
+		s.opts.log.Warn("failed to collect memory info", "error", err)
+		info.Mem = memory{}
+	}
+
+	info.Blks, err = s.collectDisks()
+	if err != nil {
+		s.opts.log.Warn("failed to collect disk info", "error", err)
+		info.Blks = []disk{}
+	}
+
+	info.Screens, err = s.collectScreens()
+	if err != nil {
+		s.opts.log.Warn("failed to collect screen info", "error", err)
+		info.Screens = []screen{}
+	}
+
+	return info, nil
+}

internal/collector/sysinfo/hardware/hardware_darwin.go

@@ -0,0 +1,35 @@
+package hardware
+
+import "log/slog"
+
+type options struct {
+	log *slog.Logger
+}
+
+func defaultOptions() *options {
+	return &options{}
+}
+
+func (s Collector) collectProduct() (product, error) {
+	return product{}, nil
+}
+
+func (s Collector) collectCPU() (cpu, error) {
+	return cpu{}, nil
+}
+
+func (s Collector) collectGPUs() ([]gpu, error) {
+	return []gpu{}, nil
+}
+
+func (s Collector) collectMemory() (memory, error) {
+	return memory{}, nil
+}
+
+func (s Collector) collectDisks() ([]disk, error) {
+	return []disk{}, nil
+}
+
+func (s Collector) collectScreens() ([]screen, error) {
+	return []screen{}, nil
+}