refactor(workspace): re-struct the workspace (#87)

ihexon · web-flow · commit 7720dce4254b · 2025-05-27T16:44:23.000+08:00
New workspace structure 
```
➜  workspace/    
.
├── default
│   ├── config
│   │   └── config.json
│   ├── data
│   │   ├── data.img
│   │   ├── default.img
│   │   ├── sshkey
│   │   └── sshkey.pub
│   ├── logs
│   │   └── ovm.log
│   ├── pids
│   │   ├── gvproxy.pid
│   │   └── krunkit.pid
│   └── socks
│       ├── gvproxy.sock
│       ├── gvproxy.sock-krun.sock
│       ├── oo-ssh-agent-host.sock
│       ├── ovm_restapi.socks
│       └── podman-api.sock

8 directories, 14 files
```
diff --git a/cmd/init.go b/cmd/init.go
@@ -7,14 +7,17 @@ import (
 	"context"
 	"fmt"
 	"math"
+	"os"
 	"path/filepath"
 	"runtime"
 
 	"bauklotze/pkg/machine/define"
 	"bauklotze/pkg/machine/events"
+	"bauklotze/pkg/machine/fs"
 	"bauklotze/pkg/machine/shim"
 	"bauklotze/pkg/machine/vmconfig"
 
+	"github.com/sirupsen/logrus"
 	"github.com/urfave/cli/v3"
 )
 
@@ -85,10 +88,12 @@ func initMachine(ctx context.Context, cli *cli.Command) error {
 		VMM:         cli.String("vmm"),
 	}
 
+	migrateData(opts)
+
 	// add a default mount point that store generated ignition scripts
 	opts.Volumes = append(opts.Volumes, define.IgnMnt)
 
-	vmcFile := filepath.Join(vmconfig.Workspace, define.ConfigPrefixDir, fmt.Sprintf("%s.json", opts.VMName))
+	vmcFile := opts.GetVMConfigPath()
 
 	var reinit bool
 	mc, err := vmconfig.LoadMachineFromPath(vmcFile)
@@ -117,3 +122,50 @@ func initMachine(ctx context.Context, cli *cli.Command) error {
 
 	return nil
 }
+
+func migrateData(opts *vmconfig.VMOpts) {
+	if err := os.RemoveAll(filepath.Join(opts.Workspace, "logs")); err != nil {
+		logrus.Warnf("remove logs failed: %v", err)
+	}
+
+	if err := os.RemoveAll(filepath.Join(opts.Workspace, "pids")); err != nil {
+		logrus.Warnf("remove pids failed: %v", err)
+	}
+
+	if err := os.RemoveAll(filepath.Join(opts.Workspace, "config")); err != nil {
+		logrus.Warnf("remove pids failed: %v", err)
+	}
+
+	if err := os.RemoveAll(filepath.Join(opts.Workspace, "socks")); err != nil {
+		logrus.Warnf("remove pids failed: %v", err)
+	}
+
+	f := filepath.Join(opts.Workspace, "data", "libkrun", "default-arm64-data.raw")
+	if runtime.GOARCH == "amd64" {
+		f = filepath.Join(opts.Workspace, "data", "vfkit", "default-amd64-data.raw")
+	}
+	oldDataDiskFile := fs.NewFile(f)
+
+	f = filepath.Join(opts.Workspace, opts.VMName, define.DataPrefixDir, "data.img")
+	newDataDiskFile := fs.NewFile(f)
+
+	if !oldDataDiskFile.IsExist() {
+		logrus.Info("old data disk does not exist, no need to migrate")
+		return
+	}
+
+	logrus.Infof("Move old data disk %q file to %q", oldDataDiskFile.GetPath(), newDataDiskFile.GetPath())
+	if err := os.MkdirAll(filepath.Dir(newDataDiskFile.GetPath()), 0755); err != nil {
+		logrus.Warnf("mkdir failed: %v", err)
+		return
+	}
+
+	if err := os.Rename(oldDataDiskFile.GetPath(), newDataDiskFile.GetPath()); err != nil {
+		logrus.Warnf("move old data disk file failed: %v", err)
+		return
+	}
+
+	if err := os.RemoveAll(filepath.Join(opts.Workspace, "data")); err != nil {
+		logrus.Warnf("remove data failed: %v", err)
+	}
+}
diff --git a/cmd/main.go b/cmd/main.go
@@ -5,6 +5,7 @@ package main
 
 import (
 	"context"
+	"errors"
 	"os"
 	"path/filepath"
 
@@ -51,8 +52,10 @@ func main() {
 		},
 		Before: func(ctx context.Context, command *cli.Command) (context.Context, error) {
 			events.SetReportURL(command.String("report-url"))
+			// a GLOB var that stores the workspace value, this var only need be initialized once
 			vmconfig.Workspace = command.String("workspace")
-			loggerSetup(command.String("log-out"), command.String("workspace"))
+			logFile := filepath.Join(vmconfig.Workspace, command.String("name"), define.LogPrefixDir, define.LogFileName)
+			loggerSetup(command.String("log-out"), logFile)
 			return ctx, nil
 		},
 	}
@@ -76,7 +79,7 @@ const MaxSizeInMB = 5
 // loggerSetup outType: file, stdout
 // if outType is file, workspace is required
 // if outType is terminal, workspace is not required, all output will be sent to Terminal's stdout/stderr
-func loggerSetup(outType string, workspace string) {
+func loggerSetup(outType string, f string) {
 	logrus.SetLevel(logrus.InfoLevel)
 	logrus.SetFormatter(&logrus.TextFormatter{
 		FullTimestamp:   true,
@@ -88,19 +91,28 @@ func loggerSetup(outType string, workspace string) {
 	logrus.SetOutput(os.Stderr)
 
 	if outType == define.LogOutFile {
-		logFile := fs.NewFile(filepath.Join(workspace, define.LogPrefixDir, define.LogFileName))
+		logFile := fs.NewFile(f)
 		if logFile.IsExist() {
-			logrus.Infof("Log file %q already exists, discarding the first 5 Mib", filepath.Join(workspace, define.LogPrefixDir, define.LogFileName))
+			logrus.Infof("Log file %q already exists, discarding the first 5 Mib", logFile.GetPath())
 			if err := logFile.DiscardBytesAtBegin(MaxSizeInMB); err != nil {
 				logrus.Warnf("failed to discard log file: %q", err)
 			}
 		}
 
-		logrus.Infof("Save log to %q", filepath.Join(workspace, define.LogPrefixDir, define.LogFileName))
-		if fd, err := os.OpenFile(filepath.Join(workspace, define.LogPrefixDir, define.LogFileName), os.O_CREATE|os.O_WRONLY|os.O_APPEND, os.ModePerm); err == nil {
-			os.Stdout = fd
-			os.Stderr = fd
-			logrus.SetOutput(fd)
+		logrus.Infof("Save log to %q", logFile.GetPath())
+		if err := logFile.MakeBaseDir(); err != nil {
+			logrus.Warnf("failed to create log directory: %q", err)
+			return
 		}
+
+		fd, err := os.OpenFile(logFile.GetPath(), os.O_CREATE|os.O_WRONLY|os.O_APPEND, 0666)
+		if err != nil && !errors.Is(err, os.ErrNotExist) {
+			logrus.Warnf("failed to open log file: %q", err)
+			return
+		}
+
+		os.Stdout = fd
+		os.Stderr = fd
+		logrus.SetOutput(fd)
 	}
 }
diff --git a/cmd/start.go b/cmd/start.go
@@ -8,12 +8,10 @@ import (
 	"fmt"
 	"os"
 	"os/signal"
-	"path/filepath"
 	"syscall"
 	"time"
 
 	"bauklotze/pkg/api/server"
-	"bauklotze/pkg/machine/define"
 	"bauklotze/pkg/machine/events"
 	"bauklotze/pkg/machine/krunkit"
 	"bauklotze/pkg/machine/shim"
@@ -39,11 +37,12 @@ var startCmd = cli.Command{
 
 func start(parentCtx context.Context, cli *cli.Command) error {
 	opts := &vmconfig.VMOpts{
-		VMName: cli.String("name"),
-		PPID:   cli.Int("ppid"),
+		Workspace: cli.String("workspace"),
+		VMName:    cli.String("name"),
+		PPID:      cli.Int("ppid"),
 	}
 
-	vmcFile := filepath.Join(vmconfig.Workspace, define.ConfigPrefixDir, fmt.Sprintf("%s.json", opts.VMName))
+	vmcFile := opts.GetVMConfigPath()
 
 	// We first check the status of the pid passed in via --ppid,
 	// and if it is inactive, exit immediately without running any of the following code
diff --git a/go.mod b/go.mod
@@ -45,4 +45,4 @@ require (
 	github.com/yusufpapurcu/wmi v1.2.4 // indirect
 	golang.org/x/net v0.36.0 // indirect
 	golang.org/x/text v0.25.0 // indirect
-)
+)
diff --git a/pkg/machine/define/define.go b/pkg/machine/define/define.go
@@ -45,6 +45,7 @@ const (
 
 	IgnMnt               = "/tmp/initfs:/tmp/initfs"
 	SSHAuthLocalSockName = "oo-ssh-agent-host.sock"
+	VMConfigJson         = "config.json"
 
 	LogOutFile     = "file"
 	LogOutTerminal = "terminal"
diff --git a/pkg/machine/machine_common.go b/pkg/machine/machine_common.go
@@ -14,6 +14,7 @@ import (
 	"bauklotze/pkg/httpclient"
 	"bauklotze/pkg/machine/define"
 	"bauklotze/pkg/machine/events"
+	"bauklotze/pkg/machine/fs"
 	"bauklotze/pkg/machine/ignition"
 	sshService "bauklotze/pkg/machine/ssh/service"
 	"bauklotze/pkg/machine/vmconfig"
@@ -110,7 +111,7 @@ func InitializeVM(opts *vmconfig.VMOpts) (*vmconfig.MachineConfig, error) {
 	}
 
 	logrus.Infof("create data disk image %q with sizeInGb %d", mc.DataDisk.Path, define.DataDiskSizeInGB)
-	if err := CreateAndResizeDisk(mc.DataDisk.Path, define.DataDiskSizeInGB); err != nil {
+	if err := CreateAndResizeDisk(mc.DataDisk.Path, define.DataDiskSizeInGB, false); err != nil {
 		return nil, fmt.Errorf("initialize vm failed: %w", err)
 	}
 
@@ -207,7 +208,20 @@ func VirtIOFsToVFKitVirtIODevice(mounts []volumes.Mount) ([]vfConfig.VirtioDevic
 }
 
 // CreateAndResizeDisk create a disk file with sizeInGB, and truncate it to sizeInGB.
-func CreateAndResizeDisk(f string, sizeInGB int64) error {
+func CreateAndResizeDisk(f string, sizeInGB int64, force bool) error {
+	disk := fs.NewFile(f)
+	if force {
+		if err := disk.Delete(); err != nil {
+			return fmt.Errorf("failed to delete %q: %w", f, err)
+		}
+	}
+
+	if disk.IsExist() {
+		logrus.Infof("data disk %q already exists, skip re-create data disk", f)
+		return nil
+	}
+
+	logrus.Infof("creating data disk %q and resize to %d GB", f, sizeInGB)
 	file, err := os.OpenFile(f, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0644)
 	if err != nil {
 		return fmt.Errorf("failed to create disk: %q, %w", f, err)
diff --git a/pkg/machine/shim/host.go b/pkg/machine/shim/host.go
@@ -53,7 +53,7 @@ func Update(mc *vmconfig.MachineConfig, opts *vmconfig.VMOpts) (*vmconfig.Machin
 
 	if mc.DataDisk.Version != opts.DataVersion {
 		logrus.Infof("Data image version is not match, try to update data image")
-		if err := machine.CreateAndResizeDisk(mc.DataDisk.Path, define.DataDiskSizeInGB); err != nil {
+		if err := machine.CreateAndResizeDisk(mc.DataDisk.Path, define.DataDiskSizeInGB, true); err != nil {
 			return nil, fmt.Errorf("update data image failed: %w", err)
 		}
 		mc.DataDisk.Version = opts.DataVersion
diff --git a/pkg/machine/vmconfig/config.go b/pkg/machine/vmconfig/config.go
@@ -3,6 +3,12 @@
 
 package vmconfig
 
+import (
+	"path/filepath"
+
+	"bauklotze/pkg/machine/define"
+)
+
 type ResourceConfig struct {
 	// CPUs to be assigned to the VM
 	CPUs int64 `json:"cpus,omitempty"`
@@ -26,3 +32,7 @@ type VMOpts struct {
 	ReportURL   string
 	VMM         string
 }
+
+func (opts *VMOpts) GetVMConfigPath() string {
+	return filepath.Join(opts.Workspace, opts.VMName, define.ConfigPrefixDir, define.VMConfigJson)
+}
diff --git a/pkg/machine/vmconfig/vmconfig.go b/pkg/machine/vmconfig/vmconfig.go
@@ -28,7 +28,9 @@ type VMState struct {
 	PodmanReady bool
 }
 
-var Workspace string
+var (
+	Workspace string
+)
 
 type VMProvider interface { //nolint:interfacebloat
 	InitializeVM(opts *VMOpts) (*MachineConfig, error)
@@ -178,13 +180,13 @@ func NewMachineConfig(opts *VMOpts) *MachineConfig {
 	mc.VMType = opts.VMM
 	mc.VMName = opts.VMName
 
-	mc.Dirs.ConfigDir = filepath.Join(Workspace, define.ConfigPrefixDir)
-	mc.Dirs.DataDir = filepath.Join(Workspace, define.DataPrefixDir)
-	mc.Dirs.LogsDir = filepath.Join(Workspace, define.LogPrefixDir)
-	mc.Dirs.SocksDir = filepath.Join(Workspace, define.SocksPrefixDir)
-	mc.Dirs.PidsDir = filepath.Join(Workspace, define.PidsPrefixDir)
+	mc.Dirs.ConfigDir = filepath.Join(Workspace, opts.VMName, define.ConfigPrefixDir)
+	mc.Dirs.DataDir = filepath.Join(Workspace, opts.VMName, define.DataPrefixDir)
+	mc.Dirs.LogsDir = filepath.Join(Workspace, opts.VMName, define.LogPrefixDir)
+	mc.Dirs.SocksDir = filepath.Join(Workspace, opts.VMName, define.SocksPrefixDir)
+	mc.Dirs.PidsDir = filepath.Join(Workspace, opts.VMName, define.PidsPrefixDir)
 
-	mc.ConfigFile = filepath.Join(mc.Dirs.ConfigDir, fmt.Sprintf("%s.json", opts.VMName))
+	mc.ConfigFile = filepath.Join(mc.Dirs.ConfigDir, define.VMConfigJson)
 	mc.Resources = ResourceConfig{
 		CPUs:           opts.CPUs,
 		DataDiskSizeGB: define.DataDiskSizeInGB,

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ func Update(mc vmconfig.MachineConfig, opts vmconfig.VMOpts) (*vmconfig.Machin`
`53`	`53`
`54`	`54`	`if mc.DataDisk.Version != opts.DataVersion {`
`55`	`55`	`logrus.Infof("Data image version is not match, try to update data image")`
`56`		`- if err := machine.CreateAndResizeDisk(mc.DataDisk.Path, define.DataDiskSizeInGB); err != nil {`
	`56`	`+ if err := machine.CreateAndResizeDisk(mc.DataDisk.Path, define.DataDiskSizeInGB, true); err != nil {`
`57`	`57`	`return nil, fmt.Errorf("update data image failed: %w", err)`
`58`	`58`	`}`
`59`	`59`	`mc.DataDisk.Version = opts.DataVersion`