Add BMC emulator container management support to vbmctl

Add BMCEmulatorConfig API type and container lifecycle management for
BMC emulator containers (vbmc and sushy-tools).

- Add BMCEmulatorConfig API fields
- Add defaults and validation in vbmctl config
- Implement container creation helper with env conversion and volume mounts
- Update package docs to include BMC emulator usage

Signed-off-by: Tero Kauppinen <tero.kauppinen@est.tech>

Author: terror96

hack/ci-e2e.sh

@@ -114,10 +114,7 @@ IP_ADDRESS="192.168.222.1"
 
 if [[ "${BMO_E2E_EMULATOR}" == "vbmc" ]]; then
   # Start VBMC
-  docker start vbmc || docker run --name vbmc --network host -d \
-    -v /var/run/libvirt/libvirt-sock:/var/run/libvirt/libvirt-sock \
-    -v /var/run/libvirt/libvirt-sock-ro:/var/run/libvirt/libvirt-sock-ro \
-    quay.io/metal3-io/vbmc
+  ./bin/vbmctl create bmc-emulator --emulator-type "vbmc" --image "quay.io/metal3-io/vbmc"
 
   readarray -t BMCS < <(yq e -o=j -I=0 '.[]' "${E2E_BMCS_CONF_FILE}")
   for bmc in "${BMCS[@]}"; do
@@ -131,12 +128,7 @@ elif [[ "${BMO_E2E_EMULATOR}" == "sushy-tools" ]]; then
   # Sushy-tools variables
   SUSHY_EMULATOR_FILE="${REPO_ROOT}"/test/e2e/sushy-tools/sushy-emulator.conf
   # Start sushy-tools
-  docker start sushy-tools || docker run --name sushy-tools -d --network host \
-    -v "${SUSHY_EMULATOR_FILE}":/etc/sushy/sushy-emulator.conf:Z \
-    -v /var/run/libvirt:/var/run/libvirt:Z \
-    -e SUSHY_EMULATOR_CONFIG=/etc/sushy/sushy-emulator.conf \
-    quay.io/metal3-io/sushy-tools:latest sushy-emulator
-
+  ./bin/vbmctl create bmc-emulator --emulator-type "sushy-tools" --image "quay.io/metal3-io/sushy-tools:latest" --config-file "${SUSHY_EMULATOR_FILE}"
 else
   echo "FATAL: Invalid e2e emulator specified: ${BMO_E2E_EMULATOR}"
   exit 1

hack/clean-e2e.sh

@@ -3,9 +3,9 @@
 REPO_ROOT=$(dirname "${BASH_SOURCE[0]}")/..
 cd "${REPO_ROOT}" || exit 1
 
-docker rm -f vbmc
+docker rm -f vbmctl-vbmc
 docker rm -f vbmctl-image-server-e2e
-docker rm -f sushy-tools
+docker rm -f vbmctl-sushy-tools
 
 "${REPO_ROOT}/tools/bmh_test/clean_local_bmh_test_setup.sh" "^bmo-e2e-"
 

test/vbmctl/README.md

@@ -18,7 +18,7 @@ This tool is under active development.
 | `vbmctl status` | ✅ Implemented (basic) |
 | Configurable volumes |  ✅ Implemented |
 | Network management | ⚠️ Partially implemented (only libvirt networks) |
-| BMC emulator support | ❌ TODO |
+| BMC emulator support | ✅ Implemented (basic) |
 | Image server | ✅ Implemented (basic) |
 | State management (persistent state) | ❌ TODO |
 
@@ -31,6 +31,7 @@ This tool is under active development.
 - **Library Support**: Can be imported as a Go module for programmatic use
 - **Libvirt network management**: create and delete libvirt networks
 - **Image Server Management**: Create, delete, list image server
+- **BMC Emulator Management**: Create, delete, list server
 
 ## Build Tags
 
@@ -82,6 +83,9 @@ vbmctl create bml
 # a name is specified, vbmctl will automatically add the prefix `vbmctl-`.
 vbmctl create image-server
 
+# Create a BMC server with default settings.
+vbmctl create bmc-emulator
+
 # Check status
 vbmctl status
 
@@ -97,6 +101,9 @@ vbmctl delete network
 # Delete the image server
 vbmctl delete image-server
 
+# Delete the bmc emulator instance
+vbmctl delete bmc-emulator
+
 # Show help
 vbmctl --help
 ```
@@ -168,6 +175,10 @@ spec:
   imageServer:
     dataDir: "/tmp"
     port: 80
+  bmcEmulator:
+    type: "sushy-tools"
+    configFile: "vbmc-emulator-file"
+    image: "bmc-emulator:latest"`,
 ```
 
 The `spec.vms` section defines the VMs that will be created when you run `vbmctl
@@ -258,6 +269,16 @@ func main() {
         log.Fatal(err)
     }
 
+    // Create a BMC emulator
+    err = containers.CreateBMCEmulatorInstance(ctx, &api.BMCEmulatorConfig{
+        Image:         "my-bmc-emulator:latest",
+        Type:          "sushy-tools",
+        ConfigFile:    "/path/to/config/file",
+    })
+    if err != nil {
+        log.Fatal(err)
+    }
+
     fmt.Printf("Created VM: %s (UUID: %s)\n", vm.Config.Name, vm.UUID)
 }
 ```

test/vbmctl/cmd/vbmctl/main.go

@@ -88,6 +88,7 @@ func newCreateCmd() *cobra.Command {
 	cmd.AddCommand(newCreateBMLCmd())
 	cmd.AddCommand(newCreateNetworkCmd())
 	cmd.AddCommand(newCreateImageServerCmd())
+	cmd.AddCommand(newCreateBMCEmulatorCmd())
 	return cmd
 }
 
@@ -210,7 +211,11 @@ Example configuration:
       containerPort: 8080
       dataDir: "/var/lib/vbmctl/images"
       containerDataDir: "/usr/share/nginx/html",
-      containerName: "vbmctl-image-server"`,
+      containerName: "vbmctl-image-server"
+	bmcEmulator:
+	  type: "sushy-tools"
+	  configFile: "vbmc-emulator-file"
+	  image: "bmc-emulator:latest"`,
 		RunE: func(_ *cobra.Command, _ []string) error {
 			ctx, cancel := contextWithSignal()
 			defer cancel()
@@ -234,6 +239,16 @@ Example configuration:
 				fmt.Println("No image server configuration found in the config file.")
 			}
 
+			if cfg.Spec.BMCEmulator != nil {
+				err = containers.CreateBMCEmulatorInstance(ctx, cfg.Spec.BMCEmulator)
+				if err != nil {
+					return err
+				}
+			} else {
+				//nolint:forbidigo // CLI output is intentional
+				fmt.Println("No BMC emulator configuration found in the config file.")
+			}
+
 			conn, err := libvirtgo.NewConnect(cfg.Spec.Libvirt.URI)
 			if err != nil {
 				return fmt.Errorf("failed to connect to libvirt: %w", err)
@@ -420,6 +435,62 @@ func newCreateImageServerCmd() *cobra.Command {
 	return cmd
 }
 
+func newCreateBMCEmulatorCmd() *cobra.Command {
+	var (
+		emulatorType string
+		image        string
+		configFile   string
+	)
+
+	cmd := &cobra.Command{
+		Use:   "bmc-emulator",
+		Short: "Create a BMC emulator instance",
+		Long:  "Create a BMC emulator instance to be used for testing.",
+		RunE: func(_ *cobra.Command, _ []string) error {
+			ctx, cancel := contextWithSignal()
+			defer cancel()
+
+			cfg, err := loadConfig()
+			if err != nil {
+				return err
+			}
+
+			// Resolve effective BMC emulator config: config file values, falling back to defaults.
+			// Command-line flags take precedence over both.
+			effective := &vbmctlapi.BMCEmulatorConfig{
+				Type:       config.DefaultBMCEmulatorType,
+				Image:      config.DefaultBMCEmulatorImage,
+				ConfigFile: config.DefaultBMCEmulatorConfigFile,
+			}
+			if cfg.Spec.BMCEmulator != nil {
+				effective = cfg.Spec.BMCEmulator
+			}
+
+			if emulatorType == "" {
+				emulatorType = effective.Type
+			}
+			if image == "" {
+				image = effective.Image
+			}
+			if configFile == "" {
+				configFile = effective.ConfigFile
+			}
+
+			return containers.CreateBMCEmulatorInstance(ctx, &vbmctlapi.BMCEmulatorConfig{
+				Type:       emulatorType,
+				Image:      image,
+				ConfigFile: configFile,
+			})
+		},
+	}
+
+	cmd.Flags().StringVar(&emulatorType, "emulator-type", "", "type of the BMC emulator (vbmc or sushy-tools, default is "+config.DefaultBMCEmulatorType+" if not set in config file)")
+	cmd.Flags().StringVar(&image, "image", "", "container image to use for the BMC emulator (default is "+config.DefaultBMCEmulatorImage+" if not set in config file)")
+	cmd.Flags().StringVar(&configFile, "config-file", "", "configuration file to use for the BMC emulator in case of sushy-tools (default is "+config.DefaultBMCEmulatorConfigFile+" if not set in config file)")
+
+	return cmd
+}
+
 func newDeleteCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "delete",
@@ -431,6 +502,7 @@ func newDeleteCmd() *cobra.Command {
 	cmd.AddCommand(newDeleteBMLCmd())
 	cmd.AddCommand(newDeleteNetworkCmd())
 	cmd.AddCommand(newDeleteImageServerCmd())
+	cmd.AddCommand(newDeleteBMCEmulatorCmd())
 	return cmd
 }
 
@@ -565,6 +637,18 @@ func newDeleteBMLCmd() *cobra.Command {
 				fmt.Println("No image server configuration found in the config file.")
 			}
 
+			if cfg.Spec.BMCEmulator != nil {
+				err := containers.DeleteBMCEmulatorInstance(ctx, cfg.Spec.BMCEmulator.Type)
+				// don't fail the whole command if BMC emulator deletion fails, just log the error
+				if err != nil {
+					//nolint:forbidigo // CLI output is intentional
+					fmt.Printf("%v\n", err)
+				}
+			} else {
+				//nolint:forbidigo // CLI output is intentional
+				fmt.Println("No BMC emulator configuration found in the config file.")
+			}
+
 			return nil
 		},
 	}
@@ -646,8 +730,43 @@ func newDeleteImageServerCmd() *cobra.Command {
 	return cmd
 }
 
+func newDeleteBMCEmulatorCmd() *cobra.Command {
+	var emulatorType string
+
+	cmd := &cobra.Command{
+		Use:   "bmc-emulator",
+		Short: "Delete the BMC emulator instance",
+		Long:  "Delete the BMC emulator instance used for provisioning.",
+		RunE: func(_ *cobra.Command, _ []string) error {
+			ctx, cancel := contextWithSignal()
+			defer cancel()
+
+			cfg, err := loadConfig()
+			if err != nil {
+				return err
+			}
+
+			// command-line flag takes precedence over config file value
+			if emulatorType == "" {
+				if cfg.Spec.BMCEmulator != nil {
+					emulatorType = cfg.Spec.BMCEmulator.Type
+				} else {
+					emulatorType = config.DefaultBMCEmulatorType
+				}
+			}
+
+			return containers.DeleteBMCEmulatorInstance(ctx, emulatorType)
+		},
+	}
+
+	cmd.Flags().StringVar(&emulatorType, "emulator-type", "", "type of the BMC emulator container to delete (default is "+config.DefaultBMCEmulatorType+" if not set in config file)")
+
+	return cmd
+}
+
 func newStatusCmd() *cobra.Command {
 	var containerName string
+	var emulatorType string
 
 	cmd := &cobra.Command{
 		Use:   "status",
@@ -695,9 +814,25 @@ func newStatusCmd() *cobra.Command {
 				return err
 			}
 
+			// command-line flag takes precedence over config file value
+			if emulatorType == "" {
+				if cfg.Spec.BMCEmulator != nil {
+					emulatorType = cfg.Spec.BMCEmulator.Type
+				} else {
+					emulatorType = config.DefaultBMCEmulatorType
+				}
+			}
+			// check if the bmc emulator is present
+			emulatorInfo, err := containers.GetBMCEmulatorInfo(ctx, emulatorType)
+			if err != nil {
+				return err
+			}
+
 			//nolint:forbidigo // CLI output is intentional
 			fmt.Printf("Image Server container: %s\n", containerInfo)
 			//nolint:forbidigo // CLI output is intentional
+			fmt.Printf("BMC Emulator container: %s\n", emulatorInfo)
+			//nolint:forbidigo // CLI output is intentional
 			fmt.Println("Virtual Machines:")
 			//nolint:forbidigo // CLI output is intentional
 			fmt.Println("  NAME\t\tSTATE\t\tMEMORY\tVCPUs")
@@ -712,6 +847,7 @@ func newStatusCmd() *cobra.Command {
 	}
 
 	cmd.Flags().StringVar(&containerName, "name", "", "name of the image server container (default is "+config.DefaultImageServerContainerName+" if not set in config file)")
+	cmd.Flags().StringVar(&emulatorType, "emulator-type", "", "type of the BMC emulator container to check for (default is "+config.DefaultBMCEmulatorType+" if not set in config file)")
 
 	return cmd
 }
@@ -793,6 +929,14 @@ func newConfigViewCmd() *cobra.Command {
 					cfg.Spec.ImageServer.ContainerName)
 			}
 
+			if cfg.Spec.BMCEmulator != nil {
+				//nolint:forbidigo // CLI output is intentional
+				fmt.Printf("BMC Emulator:\n  Emulator Type: %s\n  Config File: %s\n  Image: %s\n",
+					cfg.Spec.BMCEmulator.Type,
+					cfg.Spec.BMCEmulator.ConfigFile,
+					cfg.Spec.BMCEmulator.Image)
+			}
+
 			return nil
 		},
 	}

test/vbmctl/pkg/api/types.go

@@ -50,6 +50,36 @@ type ImageServerConfig struct {
 	ContainerName string `json:"containerName" yaml:"containerName"`
 }
 
+// BMCEmulatorConfig represents the configuration for the BMC emulator.
+type BMCEmulatorConfig struct {
+	// BMC Emulator type
+	Type string `json:"type" yaml:"type"`
+
+	// BMC Emulator file
+	ConfigFile string `json:"configFile" yaml:"configFile"`
+
+	// Image is the container image to use for the BMC emulator.
+	Image string `json:"image" yaml:"image"`
+
+	// Env is a map of environment variables to set in the BMC emulator container.
+	Env map[string]string `json:"env,omitempty" yaml:"env,omitempty"`
+
+	// ContainerName is the name of the container to create for the BMC emulator.
+	ContainerName string `json:"containerName" yaml:"containerName"`
+
+	// Volume1HostPath is the host path for the first volume to mount.
+	Volume1HostPath string `json:"volume1HostPath" yaml:"volume1HostPath"`
+
+	// Volume1ContainerPath is the container path for the first volume to mount.
+	Volume1ContainerPath string `json:"volume1ContainerPath" yaml:"volume1ContainerPath"`
+
+	// Volume2HostPath is the host path for the second volume to mount.
+	Volume2HostPath string `json:"volume2HostPath" yaml:"volume2HostPath"`
+
+	// Volume2ContainerPath is the container path for the second volume to mount.
+	Volume2ContainerPath string `json:"volume2ContainerPath" yaml:"volume2ContainerPath"`
+}
+
 // NetworkAttachment represents a network interface attached to a VM.
 type NetworkAttachment struct {
 	// Network is the name of the libvirt network to attach to.