Implement basic structures and testing over ssh connection

ChriMarMe · ChriMarMe · commit a1d80ed1f321 · 2026-01-23T14:58:06.000+01:00
Signed-off-by: Christopher Meis &lt;christopher.meis@9elements.com&gt;
diff --git a/Taskfile.yml b/Taskfile.yml
@@ -12,7 +12,7 @@ tasks:
           matrix:
             OS: ['linux']
             ARCH: ['amd64', 'arm', 'arm64']
-        cmd: GOOS="{{.ITEM.OS}}" GOARCH="{{.ITEM.ARCH}}" go build -ldflags="-s -w" -o "bin/bmc-test-go-{{.ITEM.OS}}-{{.ITEM.ARCH}}-{{.SEMVER}}"
+        cmd: GOOS="{{.ITEM.OS}}" GOARCH="{{.ITEM.ARCH}}" go build ./cmds/openbmc-tests -ldflags="-s -w" -o "bin/bmc-test-go-{{.ITEM.OS}}-{{.ITEM.ARCH}}-{{.SEMVER}}"
 
   lint:
     desc: Run linters
diff --git a/cmds/openbmc-tests/cmdline.go b/cmds/openbmc-tests/cmdline.go
@@ -0,0 +1,26 @@
+package main
+
+import (
+	"flag"
+)
+
+type flags struct {
+	configPath string
+	execEnv    string
+	user       string
+	password   string
+	ip         string
+	sshPort    int
+}
+
+func parseFlags() *flags {
+	f := &flags{}
+	flag.StringVar(&f.configPath, "config", "contrib/example_config.yaml", "Path to device specific test case configuration file")
+	flag.StringVar(&f.execEnv, "execEnv", "remote", "Runtime locality switch. Default: remote")
+	flag.StringVar(&f.user, "user", "root", "OpenBMC username for remote access. Default: 'root'")
+	flag.StringVar(&f.password, "password", "0penBmc", "OpenBMC user password for remote access Default: '0penBmc'")
+	flag.StringVar(&f.ip, "ip", "", "IP address to the remote BMC. Default: localhost")
+	flag.IntVar(&f.sshPort, "port", 22, "Port to access the BMC via SSH. Default: 22")
+	flag.Parse()
+	return f
+}
diff --git a/cmds/openbmc-tests/main.go b/cmds/openbmc-tests/main.go
@@ -0,0 +1,48 @@
+// SPDX-License-Identifier: BSD-3-Clause
+
+// Package main implements the core logic
+package main
+
+import (
+	"log"
+	"os"
+
+	"github.com/9elements/bmc-test-go/pkg/bmc"
+	"github.com/9elements/bmc-test-go/pkg/configuration"
+	"github.com/9elements/bmc-test-go/pkg/tests"
+)
+
+func run() error {
+	flags := parseFlags()
+
+	cfg, err := configuration.LoadConfig(flags.configPath)
+	if err != nil {
+		log.Print(err)
+		os.Exit(1)
+	}
+
+	bmc, err := bmc.NewBMC(flags.execEnv, cfg)
+	if err != nil {
+		return err
+	}
+
+	ipmiPre := &tests.IPMIPreconditions{}
+	if err := ipmiPre.Run(bmc); err != nil {
+		return err
+	}
+
+	for _, test := range tests.IPMITests {
+		if !test.Run(bmc, cfg, ipmiPre) {
+			return err
+		}
+	}
+
+	return nil
+}
+
+func main() {
+	if err := run(); err != nil {
+		log.Print(err)
+		os.Exit(1)
+	}
+}
diff --git a/contrib/example_config.yaml b/contrib/example_config.yaml
@@ -1,7 +1,20 @@
 ---
 version: 0
 name: ExampleServer
-requirements:
+bmc_ip: bmcIP
+bmc_user: root
+bmc_password: 0penBmc
+numHosts: 1
+hosts:
+  - host1:
+      ip: hostIP1
+      user: hostUser1
+      password: hostPassword1
+  - host2:
+      ip: hostIP2
+      user: hostUser2
+      password: hostPassword2
+testdata:
   redfish:
     general:
       cpuvendor: "TestVendor"
@@ -22,7 +35,11 @@ requirements:
       vendor: TestDimmmVendor
       capacity: 1336
   fru:
-    fruExpected:
-      vendor: TestFruVendor
-      name: TestFruName
-      serial: TestSerial001
+    - fruExpected:
+        manufacturer: TestFruVendor
+        name: TestFruName
+        serial: TestSerial001
+    - fruExpected:
+        manufacturer: TestFruVendor
+        name: TestFruName
+        serial: TestSerial001
diff --git a/go.mod b/go.mod
@@ -1,5 +1,13 @@
 module github.com/9elements/bmc-test-go
 
-go 1.23
+go 1.24.0
+
+toolchain go1.24.12
 
 require gopkg.in/yaml.v3 v3.0.1
+
+require (
+	github.com/stmcginnis/gofish v0.20.0 // indirect
+	golang.org/x/crypto v0.47.0 // indirect
+	golang.org/x/sys v0.40.0 // indirect
+)
diff --git a/go.sum b/go.sum
@@ -1,3 +1,9 @@
+github.com/stmcginnis/gofish v0.20.0 h1:hH2V2Qe898F2wWT1loApnkDUrXXiLKqbSlMaH3Y1n08=
+github.com/stmcginnis/gofish v0.20.0/go.mod h1:PzF5i8ecRG9A2ol8XT64npKUunyraJ+7t0kYMpQAtqU=
+golang.org/x/crypto v0.47.0 h1:V6e3FRj+n4dbpw86FJ8Fv7XVOql7TEwpHapKoMJ/GO8=
+golang.org/x/crypto v0.47.0/go.mod h1:ff3Y9VzzKbwSSEzWqJsJVBnWmRwRSHt/6Op5n9bQc4A=
+golang.org/x/sys v0.40.0 h1:DBZZqJ2Rkml6QMQsZywtnjnnGvHza6BTfYFWY9kjEWQ=
+golang.org/x/sys v0.40.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
diff --git a/main.go b/main.go
diff --git a/pkg/bmc/bmc.go b/pkg/bmc/bmc.go
@@ -0,0 +1,36 @@
+package bmc
+
+import (
+	"fmt"
+
+	"github.com/9elements/bmc-test-go/pkg/configuration"
+)
+
+type BMC struct {
+	con BMCConnection
+}
+
+type ExecType string
+
+var (
+	localExec  ExecType = "local"
+	remoteExec ExecType = "remote"
+)
+
+func NewBMC(execEnv string, cfg *configuration.Config) (*BMC, error) {
+	switch execEnv {
+	case "local":
+		return &BMC{con: &LocalConn{}}, nil
+	case "remote":
+		remoteConn, err := NewRemoteConn(cfg.BMCIP, cfg.BMCUser, cfg.BMCPassword)
+		if err != nil {
+			return nil, err
+		}
+		return &BMC{con: remoteConn}, nil
+	}
+	return nil, fmt.Errorf("unknown connection type: %s", execEnv)
+}
+
+func (b *BMC) ExecuteCommandLine(cmd string) ([]byte, error) {
+	return b.con.ExecuteCmdline(cmd)
+}
diff --git a/pkg/bmc/interface.go b/pkg/bmc/interface.go
@@ -0,0 +1,5 @@
+package bmc
+
+type BMCConnection interface {
+	ExecuteCmdline(cmd string) ([]byte, error)
+}
diff --git a/pkg/bmc/localconn.go b/pkg/bmc/localconn.go
@@ -0,0 +1,14 @@
+package bmc
+
+import "os/exec"
+
+type LocalConn struct{}
+
+func (l *LocalConn) ExecuteCmdline(cmd string) ([]byte, error) {
+	command := exec.Command(cmd)
+	resp, err := command.Output()
+	if err != nil {
+		return []byte{}, err
+	}
+	return resp, nil
+}
diff --git a/pkg/bmc/remoteconn.go b/pkg/bmc/remoteconn.go
@@ -0,0 +1,52 @@
+package bmc
+
+import (
+	"io"
+	"log"
+
+	"golang.org/x/crypto/ssh"
+)
+
+type RemoteConn struct {
+	IP       string
+	User     string
+	Password string
+	client   *ssh.Client
+}
+
+func NewRemoteConn(ip string, user string, password string) (*RemoteConn, error) {
+	sshConfig := &ssh.ClientConfig{
+		User: user,
+		Auth: []ssh.AuthMethod{ssh.Password(password)},
+	}
+	sshConfig.HostKeyCallback = ssh.InsecureIgnoreHostKey()
+
+	client, err := ssh.Dial("tcp", ip, sshConfig)
+	if err != nil {
+		return nil, err
+	}
+
+	return &RemoteConn{
+		IP:       ip,
+		User:     user,
+		Password: password,
+		client:   client,
+	}, nil
+}
+
+func (r *RemoteConn) ExecuteCmdline(cmd string) ([]byte, error) {
+	session, err := r.client.NewSession()
+	if err != nil {
+		return nil, err
+	}
+	defer func() {
+		if err := session.Close(); err != nil && err != io.EOF {
+			log.Print(err)
+		}
+	}()
+	resp, err := session.CombinedOutput(cmd)
+	if err != nil {
+		return []byte{}, err
+	}
+	return resp, nil
+}
diff --git a/pkg/configuration/config.go b/pkg/configuration/config.go
@@ -1,9 +1,79 @@
 package configuration
 
-import "github.com/9elements/bmc-test-go/pkg/framework"
+import (
+	"os"
 
-type Device struct {
-	Version                int
-	Name                   string
-	framework.Requirements `yaml:"requirements"`
+	"gopkg.in/yaml.v3"
+)
+
+func LoadConfig(path string) (*Config, error) {
+	file, err := os.ReadFile(path)
+	if err != nil {
+		return nil, err
+	}
+	var cfg Config
+
+	if err = yaml.Unmarshal(file, &cfg); err != nil {
+		return nil, err
+	}
+
+	return &cfg, nil
+}
+
+type TestData struct {
+	System       `yaml:"system"`
+	CPU          `yaml:"cpu"`
+	PSU          `yaml:"psu"`
+	Voltage      []string `yaml:"voltage"`
+	Temperatures []string
+	Fans         []string
+	Dimms        DimmInfo `yaml:"dimms"`
+	Fru          []FruExpect
+}
+
+type System struct {
+	GUID string
+}
+
+type PSU struct {
+	NumPSU       int
+	Name         string
+	Manufacturer string
+	Model        string
+}
+
+type FruExpect struct {
+	ProductManufacturer string `yaml:"productManufacturer"`
+	ProductName         string `yaml:"productName"`
+	ProductSerial       string `yaml:"productSerial"`
+	BoardManufacturer   string `yaml:"boardManufacturer"`
+}
+
+type DimmInfo struct {
+	Count    int
+	PartNo   string
+	Vendor   string
+	Capacity int
+}
+
+type CPU struct {
+	CPUVendor string
+	CPUModel  string
+}
+
+type Host struct {
+	IP       string
+	Username string
+	Password string
+}
+
+type Config struct {
+	Version     int
+	Name        string
+	BMCIP       string  `yaml:"bmc_ip"`
+	BMCUser     string  `yaml:"bmc_user"`
+	BMCPassword string  `yaml:"bmc_password"`
+	NumHosts    int     `yaml:"numHosts"`
+	Hosts       []*Host `yaml:"hosts"`
+	TestData    `yaml:"testdata"`
 }
diff --git a/pkg/framework/framework.go b/pkg/framework/framework.go
diff --git a/pkg/framework/requirements.go b/pkg/framework/requirements.go
diff --git a/pkg/tests/ipmi.go b/pkg/tests/ipmi.go
diff --git a/pkg/tests/ipmi_sensor.go b/pkg/tests/ipmi_sensor.go
