Implement basic structures and testing over ssh connection

Signed-off-by: Christopher Meis <christopher.meis@9elements.com>

Author: ChriMarMe

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 -ldflags="-s -w" -o "bin/bmc-test-go-{{.ITEM.OS}}-{{.ITEM.ARCH}}-{{.SEMVER}}" ./cmds/openbmc-tests
 
   lint:
     desc: Run linters

cmds/openbmc-tests/cmdline.go

@@ -0,0 +1,63 @@
+package main
+
+import (
+	"flag"
+)
+
+var (
+	runSingleCmd string = "single"
+	runSuiteCmd  string = "suite"
+	runAllCmd    string = "run-all"
+	cfgCheckCmd  string = "cfg-check"
+)
+
+type flags struct {
+	cmd        string
+	configPath string
+	execEnv    string
+	testName   string
+}
+
+func parseFlags(args []string) (*flags, error) {
+	f := &flags{
+		cmd: args[0],
+	}
+
+	cfgCheckFS := flag.NewFlagSet(cfgCheckCmd, flag.ExitOnError)
+	cfgCheckFS.StringVar(&f.configPath, "config", "contrib/example_config.yaml", "Path to device specific test case configuration file")
+
+	runSingleFS := flag.NewFlagSet("run-single", flag.ExitOnError)
+	runSingleFS.StringVar(&f.testName, "testname", "", "Run a single test with 'testname'. No default")
+	runSingleFS.StringVar(&f.execEnv, "exec-env", "remote", "Run the test locally or remotely '<local, remote>'. Default: remote")
+	runSingleFS.StringVar(&f.configPath, "config", "contrib/example_config.yaml", "Path to device specific test case configuration file")
+
+	runSuiteFS := flag.NewFlagSet("suite", flag.ExitOnError)
+	runSuiteFS.StringVar(&f.execEnv, "exec-env", "remote", "Run the test locally or remotely '<local, remote>'. Default: remote")
+	runSuiteFS.StringVar(&f.configPath, "config", "contrib/example_config.yaml", "Path to device specific test case configuration file")
+
+	runAllFS := flag.NewFlagSet("run-all", flag.ExitOnError)
+	runAllFS.StringVar(&f.execEnv, "exec-env", "remote", "Run the test locally or remotely '<local, remote>'. Default: remote")
+	runAllFS.StringVar(&f.configPath, "config", "contrib/example_config.yaml", "Path to device specific test case configuration file")
+
+	var err error
+	switch args[0] {
+	case cfgCheckCmd:
+		err = cfgCheckFS.Parse(args[1:])
+	case runSingleCmd:
+		err = runSingleFS.Parse(args[1:])
+	case runSuiteCmd:
+		err = runSuiteFS.Parse(args[1:])
+	case runAllCmd:
+		err = runAllFS.Parse(args[1:])
+	default:
+		cfgCheckFS.Usage()
+		runSingleFS.Usage()
+		runSuiteFS.Usage()
+		runAllFS.Usage()
+	}
+	if err != nil {
+		return nil, err
+	}
+
+	return f, nil
+}

cmds/openbmc-tests/main.go

@@ -0,0 +1,138 @@
+// SPDX-License-Identifier: BSD-3-Clause
+
+// Package main implements the core logic
+package main
+
+import (
+	"fmt"
+	"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"
+	"github.com/9elements/bmc-test-go/pkg/tests/ipmi"
+)
+
+func runAll(bmc *bmc.BMC, cfg *configuration.Config) error {
+	ipmiPre := &ipmi.IPMISDRPrecondition{}
+	if err := ipmiPre.Run(bmc); err != nil {
+		return err
+	}
+
+	tests := tests.AllTests()
+	if len(tests) < 1 {
+		return fmt.Errorf("no tests to execute")
+	}
+
+	for _, test := range tests {
+		log.Printf("Running: %s", test.Name())
+		if !test.Run(bmc, cfg, ipmiPre) {
+			log.Printf("test: %s failed: %s", test.Name(), test.ErrorText())
+			continue
+		}
+	}
+	return nil
+}
+
+func runSingle(testname string, bmc *bmc.BMC, cfg *configuration.Config) error {
+	ipmiPre := &ipmi.IPMISDRPrecondition{}
+	if err := ipmiPre.Run(bmc); err != nil {
+		return err
+	}
+
+	tests := tests.AllTests()
+	if len(tests) < 1 {
+		return fmt.Errorf("no tests to execute")
+	}
+
+	for _, test := range tests {
+		if test.Name() == testname {
+			if !test.Run(bmc, cfg, ipmiPre) {
+				return fmt.Errorf("%s", test.ErrorText())
+			}
+		}
+	}
+
+	return nil
+}
+
+func runSuite(suite string, bmc *bmc.BMC, cfg *configuration.Config) error {
+	ipmiPre := &ipmi.IPMISDRPrecondition{}
+	if err := ipmiPre.Run(bmc); err != nil {
+		return err
+	}
+
+	tests := tests.GetSuite(suite)
+	if len(tests) < 1 {
+		return fmt.Errorf("no tests to execute")
+	}
+
+	for _, test := range tests {
+		if !test.Run(bmc, cfg, ipmiPre) {
+			return fmt.Errorf("%s", test.ErrorText())
+		}
+	}
+	return nil
+}
+
+func run() error {
+	flags, err := parseFlags(os.Args[1:])
+	if err != nil {
+		return err
+	}
+
+	cfg, err := configuration.LoadConfig(flags.configPath)
+	if err != nil {
+		return err
+	}
+
+	fmt.Printf("%v\n", cfg)
+
+	switch flags.cmd {
+	case runSingleCmd:
+		bmc, err := bmc.NewBMC(flags.execEnv, cfg)
+		if err != nil {
+			return err
+		}
+		defer func() {
+			if err := bmc.Close(); err != nil {
+				log.Print(err)
+			}
+		}()
+		return runSingle(flags.testName, bmc, cfg)
+	case runSuiteCmd:
+		bmc, err := bmc.NewBMC(flags.execEnv, cfg)
+		if err != nil {
+			return err
+		}
+		defer func() {
+			if err := bmc.Close(); err != nil {
+				log.Print(err)
+			}
+		}()
+		return runSuite(flags.testName, bmc, cfg)
+	case runAllCmd:
+		bmc, err := bmc.NewBMC(flags.execEnv, cfg)
+		if err != nil {
+			return err
+		}
+		defer func() {
+			if err := bmc.Close(); err != nil {
+				log.Print(err)
+			}
+		}()
+		return runAll(bmc, cfg)
+	case cfgCheckCmd:
+		return configuration.Validate(cfg)
+	default:
+		return fmt.Errorf("unknown command: %s", flags.cmd)
+	}
+}
+
+func main() {
+	if err := run(); err != nil {
+		log.Print(err)
+		os.Exit(1)
+	}
+}

contrib/example_config.yaml

@@ -1,28 +1,43 @@
 ---
 version: 0
 name: ExampleServer
-requirements:
-  redfish:
-    general:
-      cpuvendor: "TestVendor"
-      cpumodel: TestModel
-      psucount: 0
-    voltage:
-      - TestString 1
-      - TestString 2
-    temperatures:
-      - Test Temp 1
-      - Test Temp 2
-    fans:
-      - Test Fans 1
-      - Test Fans 2
-    dimms:
+bm_config:
+    bmc_host: bmcIP
+    bmc_user: root
+    bmc_password: 0penBmc
+    ssh_port: "22"
+numHosts: 1
+hosts:
+  - host1:
+      ip: hostIP1
+      user: hostUser1
+      password: hostPassword1
+  - host2:
+      ip: hostIP2
+      user: hostUser2
+      password: hostPassword2
+testdata:
+  system:
+    guid: guid-string
+  cpu:
+    cpuvendor: ""
+    cpumodel: ""
+  voltage:
+    - TestString 1
+    - TestString 2
+  temperatures:
+    - Test Temp 1
+    - Test Temp 2
+  fans:
+    - Test Fans 1
+    - Test Fans 2
+  dimms:
       count: 0
       partNo: 0123
       vendor: TestDimmmVendor
       capacity: 1336
   fru:
-    fruExpected:
-      vendor: TestFruVendor
-      name: TestFruName
-      serial: TestSerial001
+      - productManufacturer: TestVal
+        productName: 'testName'
+        productSerial: 'testSerial'
+        boardManufacturer: testManufacturer

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
+)

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=

main.go

@@ -0,0 +1,60 @@
+package bmc
+
+import (
+	"fmt"
+
+	"github.com/9elements/bmc-test-go/pkg/configuration"
+	"github.com/stmcginnis/gofish"
+)
+
+type BMC struct {
+	con            BMCConnection
+	redfishService *gofish.Service
+}
+
+func makeGofishConfig(config *configuration.Config) gofish.ClientConfig {
+	return gofish.ClientConfig{
+		Endpoint: "https://" + config.BMCHost,
+		Username: config.BMCUser,
+		Password: config.BMCPassword,
+		Insecure: true,
+	}
+}
+
+func NewBMC(execEnv string, cfg *configuration.Config) (*BMC, error) {
+	ret := &BMC{}
+	switch execEnv {
+	case "local":
+		ret.con = &LocalConn{}
+	case "remote":
+		hostport := fmt.Sprintf("%s:%s", cfg.BMCHost, cfg.SSHPort)
+		remoteConn, err := NewRemoteConn(hostport, cfg.BMCUser, cfg.BMCPassword)
+		if err != nil {
+			return nil, err
+		}
+		ret.con = remoteConn
+	default:
+		return nil, fmt.Errorf("unknown connection type: %s", execEnv)
+	}
+
+	conn, err := gofish.Connect(makeGofishConfig(cfg))
+	if err != nil {
+		return nil, err
+	}
+
+	ret.redfishService = conn.Service
+
+	return ret, nil
+}
+
+func (b *BMC) Close() error {
+	return b.con.Close()
+}
+
+func (b *BMC) ExecuteCommandLine(cmd string) ([]byte, error) {
+	return b.con.ExecuteCmdline(cmd)
+}
+
+func (b *BMC) RedfishService() *gofish.Service {
+	return b.redfishService
+}