feat(test): add skeleton structs

Define multiple structs to implement the tests.

Signed-off-by: Alexander Hansen <[email protected]>

.cspell.json

@@ -26,7 +26,8 @@
     "golangci",
     "goreleaser",
     "libc",
-    "wagoid"
+    "wagoid",
+    "ipmitool"
   ],
   "ignoreWords": [],
   "version": "0.2"

main.go

@@ -5,10 +5,29 @@ package main
 
 import (
 	"fmt"
+
+	"github.com/9elements/bmc-test-go/pkg/test"
 )
 
 const bmcTestGoVersion = "v0.0.0"
 
+func printResult(result test.Result) {
+
+	fmt.Printf("TEST [%s]:", result.Name);
+
+	if (result.Error != nil) {
+		fmt.Printf(" Error: %v", result.Error);
+	} else {
+		fmt.Printf(" PASS");
+	}
+
+	fmt.Println();
+}
+
 func main() {
 	fmt.Println(bmcTestGoVersion)
+
+	var result = test.Result{Name:"nop test", Error:nil};
+
+	printResult(result);
 }

pkg/test/test.go

@@ -0,0 +1,38 @@
+// Package test implements the common structs used for defining
+// testcases.
+package test
+
+// Config struct is used to pass arbitrary information into the tests
+// such as IP address, expected FRU content, expected sensors
+type Config struct {
+
+	Host string;
+	Username string;
+	Password string;
+
+	// ... to be extended
+}
+
+// Result struct is used for returning test results from running a test
+type Result struct {
+
+	// what was tested
+	Name string
+
+	// != nil in case something went wrong,
+	// this should contain a descriptive string for the logs.
+	// e.g. "while running command X, expected A but output was B'
+	Error error
+}
+
+// Test struct is used to define a test which can return one or more results
+type Test struct {
+
+	// e.g. "IPMI Sensor"
+	Name string
+
+	// e.g. "Testing the 'ipmitool sensor' output
+	Description string
+
+	Function func(tc Config) []Result
+}