chore: remove redundant comments, add todos, etc...

nixpig · Feb 2, 2025 · 59c5322 · 59c5322
1 parent 454336f
commit 59c5322
Show file tree

Hide file tree

Showing 17 changed files with 21 additions and 52 deletions.
diff --git a/internal/anosys/ioprio.go b/internal/anosys/ioprio.go
@@ -7,7 +7,7 @@ import (
 	"golang.org/x/sys/unix"
 )
 
-var IOPrioClassMapping = map[specs.IOPriorityClass]int{
+var ioprioClassMapping = map[specs.IOPriorityClass]int{
 	specs.IOPRIO_CLASS_RT:   1,
 	specs.IOPRIO_CLASS_BE:   2,
 	specs.IOPRIO_CLASS_IDLE: 3,
@@ -27,7 +27,7 @@ func SetIOPriority(ioprio *specs.LinuxIOPriority) error {
 }
 
 func ioprioToInt(iop *specs.LinuxIOPriority) (int, error) {
-	class, ok := IOPrioClassMapping[iop.Class]
+	class, ok := ioprioClassMapping[iop.Class]
 	if !ok {
 		return 0, fmt.Errorf("unknown ioprio class: %s", iop.Class)
 	}

diff --git a/internal/anosys/masked_paths.go b/internal/anosys/masked_paths.go
@@ -9,8 +9,8 @@ import (
 )
 
 func MountMaskedPaths(paths []string) error {
-	for _, path := range paths {
-		f, err := os.Stat(path)
+	for _, p := range paths {
+		f, err := os.Stat(p)
 		if err != nil {
 			// if it's not there, there's nothing to mask; skip it
 			continue
@@ -19,7 +19,7 @@ func MountMaskedPaths(paths []string) error {
 		if f.IsDir() {
 			if err := syscall.Mount(
 				"tmpfs",
-				path,
+				p,
 				"tmpfs",
 				unix.MS_RDONLY,
 				"",
@@ -29,7 +29,7 @@ func MountMaskedPaths(paths []string) error {
 		} else {
 			if err := syscall.Mount(
 				"/dev/null",
-				path,
+				p,
 				"bind",
 				unix.MS_BIND,
 				"",

diff --git a/internal/anosys/readonly_paths.go b/internal/anosys/readonly_paths.go
@@ -8,10 +8,10 @@ import (
 )
 
 func MountReadonlyPaths(paths []string) error {
-	for _, path := range paths {
+	for _, p := range paths {
 		if err := syscall.Mount(
-			path,
-			path,
+			p,
+			p,
 			"",
 			unix.MS_REC|unix.MS_BIND,
 			"",
@@ -20,8 +20,8 @@ func MountReadonlyPaths(paths []string) error {
 		}
 
 		if err := syscall.Mount(
-			path,
-			path,
+			p,
+			p,
 			"",
 			unix.MS_NOSUID|unix.MS_NODEV|unix.MS_NOEXEC|
 				unix.MS_BIND|unix.MS_REMOUNT|unix.MS_RDONLY,

diff --git a/internal/cli/create.go b/internal/cli/create.go
@@ -1,5 +1,3 @@
-// internal/cli/create.go
-
 package cli
 
 import (

diff --git a/internal/cli/delete.go b/internal/cli/delete.go
@@ -1,12 +1,9 @@
-// internal/cli/delete.go
-
 package cli
 
 import (
 	"fmt"
 
 	"github.com/nixpig/anocir/internal/operations"
-	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
@@ -26,7 +23,6 @@ func deleteCmd() *cobra.Command {
 				ID:    containerID,
 				Force: force,
 			}); err != nil {
-				logrus.Errorf("delete operation failed: %s", err)
 				return fmt.Errorf("delete: %w", err)
 			}
 

diff --git a/internal/cli/features.go b/internal/cli/features.go
@@ -6,7 +6,6 @@ import (
 	"fmt"
 
 	"github.com/nixpig/anocir/internal/operations"
-	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
@@ -34,7 +33,6 @@ func featuresCmd() *cobra.Command {
 			if _, err := cmd.OutOrStdout().Write(
 				formattedFeatures.Bytes(),
 			); err != nil {
-				logrus.Errorf("features operation failed: %s", err)
 				return fmt.Errorf("features: %w", err)
 			}
 

diff --git a/internal/cli/kill.go b/internal/cli/kill.go
@@ -1,12 +1,9 @@
-// internal/cli/kill.go
-
 package cli
 
 import (
 	"fmt"
 
 	"github.com/nixpig/anocir/internal/operations"
-	"github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 )
 
@@ -24,15 +21,14 @@ func killCmd() *cobra.Command {
 				ID:     containerID,
 				Signal: signal,
 			}); err != nil {
-				logrus.Errorf("kill operation failed: %s", err)
 				return fmt.Errorf("kill: %w", err)
 			}
 
 			return nil
 		},
 	}
 
-	// TODO: do something with this
+	// TODO: figure out why Docker needs this and implement it
 	cmd.Flags().BoolP("all", "a", false, "Kill all (Docker??)")
 
 	return cmd

diff --git a/internal/cli/reexec.go b/internal/cli/reexec.go
@@ -1,5 +1,3 @@
-// internal/cli/reexec.go
-
 package cli
 
 import (
@@ -20,6 +18,7 @@ func reexecCmd() *cobra.Command {
 		RunE: func(cmd *cobra.Command, args []string) error {
 			containerID := args[0]
 
+			// TODO: figure out a cleaner way of passing the console socket fd
 			var consoleSocketFD *int
 			if cmd.Flags().Changed("console-socket-fd") {
 				flag, _ := cmd.Flags().GetInt("console-socket-fd")

diff --git a/internal/cli/root.go b/internal/cli/root.go
@@ -1,5 +1,3 @@
-// internal/cli/root.go
-
 package cli
 
 import (
@@ -20,6 +18,7 @@ func RootCmd() *cobra.Command {
 		Version:      "0.0.1",
 		SilenceUsage: true,
 		PersistentPreRun: func(cmd *cobra.Command, args []string) {
+			// TODO: move all this logging stuff out into separate
 			logfile, _ := cmd.Flags().GetString("log")
 			if _, err := os.Stat(logfile); os.IsNotExist(err) {
 				if err := os.MkdirAll(filepath.Dir(logfile), os.ModeDir); err != nil {
@@ -72,7 +71,7 @@ func RootCmd() *cobra.Command {
 		"/var/log/anocir/log.txt",
 		"Location of log file",
 	)
-	// cmd.PersistentFlags().BoolP("debug", "d", false, "Enable debug logging")
+	cmd.PersistentFlags().BoolP("debug", "d", false, "Enable debug logging")
 
 	cmd.CompletionOptions.HiddenDefaultCmd = true
 

diff --git a/internal/cli/start.go b/internal/cli/start.go
@@ -1,5 +1,3 @@
-// internal/cli/start.go
-
 package cli
 
 import (

diff --git a/internal/cli/state.go b/internal/cli/state.go
@@ -1,5 +1,3 @@
-// internal/cli/state.go
-
 package cli
 
 import (

diff --git a/internal/container/container.go b/internal/container/container.go
@@ -15,12 +15,11 @@ import (
 	"syscall"
 	"time"
 
-	"github.com/sirupsen/logrus"
-
 	"github.com/nixpig/anocir/internal/anosys"
 	"github.com/nixpig/anocir/internal/hooks"
 	"github.com/nixpig/anocir/internal/terminal"
 	"github.com/opencontainers/runtime-spec/specs-go"
+	"github.com/sirupsen/logrus"
 	"golang.org/x/sys/unix"
 )
 
@@ -144,16 +143,13 @@ func (c *Container) Init() error {
 	}
 
 	if c.ConsoleSocketFD != nil {
-		csfd := strconv.Itoa(*c.ConsoleSocketFD)
-		args = append(args, "--console-socket-fd", csfd)
+		fd := strconv.Itoa(*c.ConsoleSocketFD)
+		args = append(args, "--console-socket-fd", fd)
 	}
 
 	args = append(args, c.State.ID)
 
-	cmd := exec.Command(
-		"/proc/self/exe",
-		args...,
-	)
+	cmd := exec.Command("/proc/self/exe", args...)
 
 	listener, err := net.Listen(
 		"unix",
@@ -382,7 +378,7 @@ func (c *Container) Reexec() error {
 	}
 
 	if c.ConsoleSocketFD != nil && c.Spec.Process.Terminal {
-
+		// TODO: move this out into function in terminal package?
 		target := filepath.Join(c.rootFS(), "dev/console")
 
 		if _, err := os.Stat(target); os.IsNotExist(err) {
@@ -407,6 +403,7 @@ func (c *Container) Reexec() error {
 	}
 
 	// wait a sec for init sock to be ready before dialing
+	// this is nasty - must be a better way
 	for i := 0; i < 10; i++ {
 		if _, err := os.Stat(filepath.Join(
 			containerRootDir,

diff --git a/internal/operations/create.go b/internal/operations/create.go
@@ -1,5 +1,3 @@
-// internal/operations/create.go
-
 package operations
 
 import (

diff --git a/internal/operations/delete.go b/internal/operations/delete.go
@@ -1,5 +1,3 @@
-// internal/operations/delete.go
-
 package operations
 
 import (

diff --git a/internal/operations/kill.go b/internal/operations/kill.go
@@ -1,5 +1,3 @@
-// internal/operations/kill.go
-
 package operations
 
 import (

diff --git a/internal/operations/start.go b/internal/operations/start.go
@@ -1,5 +1,3 @@
-// internal/operations/start.go
-
 package operations
 
 import (

diff --git a/internal/operations/state.go b/internal/operations/state.go
@@ -1,5 +1,3 @@
-// internal/operations/state.go
-
 package operations
 
 import (