Pulse/internal/truenas/types.go

package truenas

import "time"

// FixtureSnapshot represents a deterministic TrueNAS API snapshot used for contract testing.
type FixtureSnapshot struct {
	CollectedAt      time.Time
	System           SystemInfo
	Pools            []Pool
	Datasets         []Dataset
	Disks            []Disk
	Alerts           []Alert
	Apps             []App
	ZFSSnapshots     []ZFSSnapshot
	ReplicationTasks []ReplicationTask
}

// SystemInfo mirrors high-level TrueNAS system identity/status data.
type SystemInfo struct {
	Hostname             string
	Version              string
	Build                string
	UptimeSeconds        int64
	Healthy              bool
	MachineID            string
	CPUCount             int
	MemoryTotalBytes     int64
	MemoryAvailableBytes int64
	CPUPercent           float64
	NetInRate            float64
	NetOutRate           float64
	DiskReadRate         float64
	DiskWriteRate        float64
	TemperatureCelsius   map[string]float64
	IntervalSeconds      int
	CollectedAt          time.Time
}

// Pool mirrors the subset of TrueNAS pool fields needed for unified mapping.
type Pool struct {
	ID         string
	Name       string
	Status     string
	TotalBytes int64
	UsedBytes  int64
	FreeBytes  int64
}

// Dataset mirrors the subset of TrueNAS dataset fields needed for unified mapping.
type Dataset struct {
	ID         string
	Name       string
	Pool       string
	UsedBytes  int64
	AvailBytes int64
	Mounted    bool
	ReadOnly   bool
}

// Disk mirrors a TrueNAS disk listing entry.
type Disk struct {
	ID                   string
	Name                 string
	Pool                 string
	Status               string
	Model                string
	Serial               string
	SizeBytes            int64
	Temperature          int
	TemperatureAggregate DiskTemperatureAggregate
	Transport            string
	Rotational           bool
}

// DiskTemperatureAggregate stores recent aggregate disk-temperature history
// derived from the native TrueNAS disk.temperature_agg API.
type DiskTemperatureAggregate struct {
	WindowDays int
	MinCelsius float64
	AvgCelsius float64
	MaxCelsius float64
}

// TimeSeriesPoint stores one provider-native metric point before it is mapped
// onto the canonical monitoring/chart surface.
type TimeSeriesPoint struct {
	Timestamp time.Time
	Value     float64
}

// SystemMetricHistory stores provider-native TrueNAS system history before it
// is normalized onto the canonical monitoring guest-chart surface.
type SystemMetricHistory struct {
	CPUPercent           []TimeSeriesPoint
	MemoryPercent        []TimeSeriesPoint
	MemoryUsedBytes      []TimeSeriesPoint
	MemoryAvailableBytes []TimeSeriesPoint
	MemoryTotalBytes     []TimeSeriesPoint
	NetInRate            []TimeSeriesPoint
	NetOutRate           []TimeSeriesPoint
	DiskReadRate         []TimeSeriesPoint
	DiskWriteRate        []TimeSeriesPoint
}

// Alert mirrors a TrueNAS alert listing entry.
type Alert struct {
	ID        string
	Level     string
	Message   string
	Source    string
	Dismissed bool
	Datetime  time.Time
}

// App mirrors the subset of TrueNAS application fields needed for unified
// workload mapping.
type App struct {
	ID                    string
	Name                  string
	State                 string
	Version               string
	HumanVersion          string
	CustomApp             bool
	UpgradeAvailable      bool
	ImageUpdatesAvailable bool
	Notes                 string
	ContainerCount        int
	UsedHostIPs           []string
	UsedPorts             []AppPort
	Containers            []AppContainer
	Volumes               []AppVolume
	Images                []string
	Networks              []AppNetwork
	Stats                 *AppStats
}

// AppStats contains live API-backed workload telemetry for one TrueNAS app.
type AppStats struct {
	CPUPercent      float64
	MemoryBytes     int64
	NetInRate       float64
	NetOutRate      float64
	BlockReadBytes  int64
	BlockWriteBytes int64
	DiskReadRate    float64
	DiskWriteRate   float64
	IntervalSeconds int
	CollectedAt     time.Time
	Interfaces      []AppInterfaceStats
}

// AppInterfaceStats stores per-interface throughput from TrueNAS app.stats.
type AppInterfaceStats struct {
	Name      string
	RxBytesPS float64
	TxBytesPS float64
}

// AppPort describes an app-level published port mapping.
type AppPort struct {
	ContainerPort int
	Protocol      string
	HostPorts     []AppHostPort
}

// AppHostPort describes a host-bound port used by a TrueNAS app.
type AppHostPort struct {
	HostPort int
	HostIP   string
}

// AppContainer describes one runtime container inside a TrueNAS app.
type AppContainer struct {
	ID           string
	ServiceName  string
	Image        string
	State        string
	PortConfig   []AppPort
	VolumeMounts []AppVolume
}

// AppLogLine stores one bounded log entry returned by the TrueNAS app log API.
type AppLogLine struct {
	Timestamp string
	Data      string
}

// AppLogResult captures a bounded log read for one TrueNAS app container.
type AppLogResult struct {
	Host      string
	App       App
	Container AppContainer
	Lines     []AppLogLine
	TailLines int
}

// AppConfigResult captures the current configuration/runtime shape of one
// TrueNAS application.
type AppConfigResult struct {
	Host string
	App  App
}

// AppVolume describes a bind or named volume mount exposed by a TrueNAS app.
type AppVolume struct {
	Source      string
	Destination string
	Mode        string
	Type        string
}

// AppNetwork describes a Docker network attached to a TrueNAS app.
type AppNetwork struct {
	ID     string
	Name   string
	Labels map[string]string
}

// ZFSSnapshot mirrors the subset of snapshot fields needed for recovery-point mapping.
type ZFSSnapshot struct {
	ID         string
	Dataset    string
	Name       string // snapshot name (without dataset prefix), best-effort
	FullName   string // dataset@snapshot, best-effort
	CreatedAt  *time.Time
	UsedBytes  *int64
	Referenced *int64
}

// ReplicationTask mirrors the subset of replication task fields needed for recovery-point mapping.
type ReplicationTask struct {
	ID             string
	Name           string
	SourceDatasets []string
	TargetDataset  string
	Direction      string

	LastRun   *time.Time
	LastState string // SUCCESS / FAILED / RUNNING / etc, best-effort
	LastError string

	// Best-effort last snapshot name/identifier if exposed by API.
	LastSnapshot string
}