Replace logrus with slog

Author: eikendev

cmd/hackenv/main.go

@@ -2,12 +2,10 @@
 package main
 
 import (
-	"os"
-
 	"github.com/alecthomas/kong"
-	log "github.com/sirupsen/logrus"
 
 	"github.com/eikendev/hackenv/internal/commands"
+	"github.com/eikendev/hackenv/internal/logging"
 	"github.com/eikendev/hackenv/internal/options"
 )
 
@@ -23,23 +21,15 @@ var cmd struct {
 	Version commands.VersionCommand `cmd:"version" help:"Print the version of hackenv"`
 }
 
-func init() {
-	log.SetOutput(os.Stderr)
-	log.SetLevel(log.InfoLevel)
-	log.SetFormatter(&log.TextFormatter{
-		DisableTimestamp: true,
-	})
-}
-
 func main() {
-	ctx := kong.Parse(&cmd)
+	kctx := kong.Parse(&cmd,
+		kong.Description("hackenv provisions and manages preconfigured VMs for security research."),
+		kong.UsageOnError(),
+		kong.Bind(&cmd.Options),
+	)
 
-	if cmd.Verbose {
-		log.SetLevel(log.DebugLevel)
-	}
+	logging.Setup(cmd.Verbose)
 
-	err := ctx.Run(&cmd.Options)
-	if err != nil {
-		os.Exit(1)
-	}
+	err := kctx.Run()
+	kctx.FatalIfErrorf(err)
 }

go.mod

@@ -8,7 +8,6 @@ require (
 	github.com/fatih/color v1.18.0
 	github.com/melbahja/goph v1.4.0
 	github.com/schollz/progressbar/v3 v3.18.0
-	github.com/sirupsen/logrus v1.9.3
 	libvirt.org/go/libvirt v1.11006.0
 )
 

go.sum

@@ -38,8 +38,6 @@ github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
 github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
 github.com/schollz/progressbar/v3 v3.18.0 h1:uXdoHABRFmNIjUfte/Ex7WtuyVslrw2wVPQmCN62HpA=
 github.com/schollz/progressbar/v3 v3.18.0/go.mod h1:IsO3lpbaGuzh8zIMzgY3+J8l4C8GjO0Y9S69eFvNsec=
-github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
-github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
 github.com/stretchr/testify v1.10.0 h1:Xv5erBjTwe/5IxqUQTdXv5kgmIvbHo3QQyRwhJsOfJA=
@@ -65,7 +63,6 @@ golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7w
 golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=

internal/banner/banner.go

@@ -3,10 +3,10 @@ package banner
 
 import (
 	"fmt"
+	"log/slog"
 	"os"
 
 	"github.com/fatih/color"
-	log "github.com/sirupsen/logrus"
 )
 
 const banner = `
@@ -24,7 +24,7 @@ func PrintBanner() {
 
 	_, err := color.New(color.FgBlue).Fprintln(os.Stderr, "                @eikendev")
 	if err != nil {
-		log.Warnf("Cannot print banner: %s", err)
+		slog.Warn("Cannot print banner", "err", err)
 	}
 
 	fmt.Fprintln(os.Stderr, "")

internal/commands/down.go

@@ -1,7 +1,7 @@
 package commands
 
 import (
-	log "github.com/sirupsen/logrus"
+	"log/slog"
 
 	"github.com/eikendev/hackenv/internal/handling"
 	"github.com/eikendev/hackenv/internal/images"
@@ -24,7 +24,7 @@ func (c *DownCommand) Run(s *options.Options) error {
 
 	err := dom.Destroy()
 	if err != nil {
-		log.Errorf("Cannot destroy domain: %s\n", err)
+		slog.Error("Cannot destroy domain", "err", err)
 		return err
 	}
 

internal/commands/fix.go

@@ -2,11 +2,10 @@ package commands
 
 import (
 	"fmt"
+	"log/slog"
 	"os/exec"
 	"strings"
 
-	log "github.com/sirupsen/logrus"
-
 	"github.com/eikendev/hackenv/internal/options"
 	"github.com/eikendev/hackenv/internal/scripts"
 )
@@ -47,7 +46,7 @@ func (c *all) Run(s *options.Options) error {
 func execCommand(scripts []string, verbose bool) error {
 	for i, script := range scripts {
 		cmd := exec.Command("bash")
-		log.Infof("Running script %v/%v...\n\n", i, len(scripts)-1)
+		slog.Info("Running script", "index", i+1, "total", len(scripts))
 		cmd.Stdin = strings.NewReader(script)
 		b, err := cmd.CombinedOutput()
 		if verbose {

internal/commands/get.go

@@ -4,11 +4,11 @@ import (
 	"crypto/sha256"
 	"fmt"
 	"io"
+	"log/slog"
 	"net/http"
 	"os"
 
 	progressbar "github.com/schollz/progressbar/v3"
-	log "github.com/sirupsen/logrus"
 
 	"github.com/eikendev/hackenv/internal/handling"
 	"github.com/eikendev/hackenv/internal/images"
@@ -23,18 +23,18 @@ type GetCommand struct {
 
 // https://golang.org/pkg/crypto/sha256/#example_New_file
 func calculateFileChecksum(path string) (string, error) {
-	log.Printf("Calculating checksum of %s\n", path)
+	slog.Info("Calculating checksum", "path", path)
 
 	f, err := os.Open(path) //#nosec G304
 	if err != nil {
-		log.Errorf("Failed to open file: %s\n", err)
+		slog.Error("Failed to open file", "path", path, "err", err)
 		return "", err
 	}
 	defer handling.Close(f)
 
 	h := sha256.New()
 	if _, err := io.Copy(h, f); err != nil {
-		log.Errorf("Failed to copy file content: %s\n", err)
+		slog.Error("Failed to copy file content", "path", path, "err", err)
 		return "", err
 	}
 
@@ -43,18 +43,18 @@ func calculateFileChecksum(path string) (string, error) {
 
 // https://stackoverflow.com/a/11693049
 func downloadImage(path, url string) error {
-	log.Printf("Downloading image to %s\n", path)
+	slog.Info("Downloading image", "path", path, "url", url)
 
 	out, err := os.Create(path) //#nosec G304
 	if err != nil {
-		log.Errorf("Cannot write image file: %s\n", err)
+		slog.Error("Cannot create image file", "path", path, "err", err)
 		return err
 	}
 	defer handling.Close(out)
 
 	resp, err := http.Get(url) //#nosec G107
 	if err != nil {
-		log.Errorf("Cannot download image file: %s\n", err)
+		slog.Error("Cannot download image file", "url", url, "err", err)
 		return err
 	}
 	if resp == nil {
@@ -63,7 +63,7 @@ func downloadImage(path, url string) error {
 	defer handling.Close(resp.Body)
 
 	if resp.StatusCode != http.StatusOK {
-		log.Errorf("Cannot download image file: bad status %s\n", resp.Status)
+		slog.Error("Cannot download image file: bad status", "status", resp.Status)
 		return err
 	}
 
@@ -74,11 +74,11 @@ func downloadImage(path, url string) error {
 
 	_, err = io.Copy(io.MultiWriter(out, bar), resp.Body)
 	if err != nil {
-		log.Errorf("Cannot write image file: %s\n", err)
+		slog.Error("Cannot write image file", "path", path, "err", err)
 		return err
 	}
 
-	log.Println("Download successful")
+	slog.Info("Download successful")
 	return nil
 }
 
@@ -89,17 +89,17 @@ func validateChecksum(localPath, checksum string) error {
 	}
 
 	if newChecksum != checksum {
-		checksumMsg := fmt.Sprintf("Downloaded image has bad checksum: %s instead of %s", newChecksum, checksum)
-
 		err := os.Remove(localPath)
 		if err != nil {
-			log.Fatalf("%s. Unable to remove file.\n", checksumMsg)
+			slog.Error("Downloaded image has bad checksum and cannot be removed", "path", localPath, "expected", checksum, "actual", newChecksum, "err", err)
+			os.Exit(1)
 		}
 
-		log.Fatalf("%s. File removed.\n", checksumMsg)
+		slog.Error("Downloaded image has bad checksum and was removed", "path", localPath, "expected", checksum, "actual", newChecksum)
+		os.Exit(1)
 	}
 
-	log.Println("Checksum validated successfully")
+	slog.Info("Checksum validated successfully")
 	return nil
 }
 
@@ -111,7 +111,7 @@ func (c *GetCommand) Run(s *options.Options) error {
 		return fmt.Errorf("failed to get download information")
 	}
 
-	log.Printf("Found file %s with checksum %s\n", info.Filename, info.Checksum)
+	slog.Info("Found image to download", "filename", info.Filename, "checksum", info.Checksum)
 
 	localPath := image.GetLocalPath(info.Version)
 
@@ -120,18 +120,19 @@ func (c *GetCommand) Run(s *options.Options) error {
 		// The image already exists.
 
 		if !c.Update && !c.Force {
-			log.Println("An image is already installed; update with --update")
+			slog.Info("An image is already installed; use --update to refresh")
 			return nil
 		}
 
 		localVersion := image.FileVersion(localPath)
 
 		if !c.Force && image.VersionComparer.Eq(info.Version, localVersion) {
-			log.Println("Latest image is already installed; force with --force")
+			slog.Info("Latest image is already installed; use --force to overwrite")
 			return nil
 		}
 	} else if !os.IsNotExist(err) {
-		log.Fatalf("Unable to get file information for path %s\n", localPath)
+		slog.Error("Unable to get file information", "path", localPath, "err", err)
+		os.Exit(1)
 	}
 
 	err := downloadImage(localPath, image.ArchiveURL+"/"+info.Filename)
@@ -144,7 +145,7 @@ func (c *GetCommand) Run(s *options.Options) error {
 		return err
 	}
 
-	log.Info("When using SELinux, don't forget to label the image with the fix command before proceeding")
+	slog.Info("When using SELinux, label the image with the fix command before proceeding")
 
 	return nil
 }

internal/commands/gui.go

@@ -2,11 +2,10 @@ package commands
 
 import (
 	"fmt"
+	"log/slog"
 	"os"
 	"os/exec"
 
-	log "github.com/sirupsen/logrus"
-
 	"github.com/eikendev/hackenv/internal/constants"
 	"github.com/eikendev/hackenv/internal/handling"
 	"github.com/eikendev/hackenv/internal/images"
@@ -58,13 +57,13 @@ func (c *GuiCommand) Run(s *options.Options) error {
 			"SPICE://localhost",
 		}
 	} else {
-		log.Errorf("Unable to locate %s to connect to the VM.\n", c.Viewer)
+		slog.Error("Unable to locate viewer to connect to the VM", "viewer", c.Viewer)
 		return fmt.Errorf("unable to locate %s to connect to the VM", c.Viewer)
 	}
 
 	cwd, err := os.Getwd()
 	if err != nil {
-		log.Printf("Cannot get current working directory: %s\n", err)
+		slog.Warn("Cannot get current working directory", "err", err)
 	}
 
 	cmd := exec.Command(args[0], args[1:]...) //#nosec G204
@@ -73,7 +72,7 @@ func (c *GuiCommand) Run(s *options.Options) error {
 
 	err = cmd.Start()
 	if err != nil {
-		log.Printf("Cannot spawn process: %s\n", err)
+		slog.Error("Cannot spawn viewer process", "err", err)
 	}
 	defer handling.ReleaseProcess(cmd.Process)
 

internal/commands/ssh.go

@@ -2,11 +2,10 @@ package commands
 
 import (
 	"fmt"
+	"log/slog"
 	"os"
 	"syscall"
 
-	log "github.com/sirupsen/logrus"
-
 	"github.com/eikendev/hackenv/internal/constants"
 	"github.com/eikendev/hackenv/internal/handling"
 	"github.com/eikendev/hackenv/internal/images"
@@ -30,7 +29,7 @@ func (c *SSHCommand) Run(s *options.Options) error {
 
 	ipAddr, err := libvirt.GetDomainIPAddress(dom, &image)
 	if err != nil {
-		log.Errorf("Cannot retrieve guest's IP address\n")
+		slog.Error("Cannot retrieve guest IP address", "err", err)
 		return err
 	}
 
@@ -42,7 +41,7 @@ func (c *SSHCommand) Run(s *options.Options) error {
 	//#nosec G204
 	err = syscall.Exec(args[0], args, os.Environ())
 	if err != nil {
-		log.Printf("Cannot spawn process: %s\n", err)
+		slog.Error("Cannot spawn SSH process", "err", err)
 	}
 
 	return nil

internal/commands/status.go

@@ -2,8 +2,7 @@ package commands
 
 import (
 	"fmt"
-
-	log "github.com/sirupsen/logrus"
+	"log/slog"
 
 	"github.com/eikendev/hackenv/internal/handling"
 	"github.com/eikendev/hackenv/internal/images"
@@ -31,7 +30,7 @@ func (*StatusCommand) Run(_ *options.Options) error {
 
 			info, err := dom.GetInfo()
 			if err != nil {
-				log.Printf("Cannot get domain info: %s\n", err)
+				slog.Warn("Cannot get domain info", "err", err, "domain", image.Name)
 				continue
 			}