chore: cover supervisor package with unit tests (#12)

* chore: cover supervisor package with unit tests

this commit covers 84.1% of the supervisor package with unit tests.

* chore: fix lint warnings.

- keep lines shorter.
- added a package comment to the supervisor package.

* chore: fixed wrong unit tests

these tests were wrong.

Author: ricardomaraschini

pkg/controller/k0scontroller.go

@@ -5,7 +5,6 @@ import (
 	"context"
 	"encoding/csv"
 	"fmt"
-	"io"
 	"os"
 	"os/user"
 	"path/filepath"
@@ -28,8 +27,7 @@ import (
 type K0sController struct {
 	Options config.K0sControllerOptions
 
-	supervisor supervisor.Supervisor
-	Output     io.Writer
+	supervisor *supervisor.Supervisor
 	uid        int
 	gid        int
 }
@@ -68,16 +66,9 @@ func (k *K0sController) Init(_ context.Context) error {
 	if k.Options.CmdLogLevels != nil {
 		args = append(args, fmt.Sprintf("--logging=%s", createS2SFlag(k.Options.CmdLogLevels)))
 	}
-	k.supervisor = supervisor.Supervisor{
-		Name:          "k0s",
-		UID:           k.uid,
-		GID:           k.gid,
-		BinPath:       assets.BinPath("k0s", k.Options.BinDir()),
-		Output:        k.Output,
-		RunDir:        k.Options.RunDir(),
-		DataDir:       k.Options.DataDir,
-		KeepEnvPrefix: true,
-		Args:          args,
+	k0spath := assets.BinPath("k0s", k.Options.BinDir())
+	if k.supervisor, err = supervisor.New(k0spath, args); err != nil {
+		return fmt.Errorf("failed to create supervisor: %w", err)
 	}
 	return nil
 }

pkg/supervisor/detachattr.go

@@ -0,0 +1,53 @@
+package supervisor
+
+import (
+	"fmt"
+	"time"
+)
+
+// Option sets an option on a Supervisor reference.
+type Option func(*Supervisor)
+
+// WithName sets the name of the Supervisor.
+func WithName(name string) Option {
+	return func(s *Supervisor) {
+		s.name = name
+		s.log = s.log.WithField("component", name)
+		s.pidFile = fmt.Sprintf("/run/replicated/%s.pid", name)
+	}
+}
+
+// WithTimeoutRespawn sets the timeout for respawning a process.
+func WithTimeoutRespawn(timeoutRespawn time.Duration) Option {
+	return func(s *Supervisor) {
+		s.timeoutRespawn = timeoutRespawn
+	}
+}
+
+// WithTimeoutStop sets the timeout for stopping a process.
+func WithTimeoutStop(timeoutStop time.Duration) Option {
+	return func(s *Supervisor) {
+		s.timeoutStop = timeoutStop
+	}
+}
+
+// WithUID sets the UID of the Supervisor.
+func WithUID(uid int) Option {
+	return func(s *Supervisor) {
+		s.uid = uid
+	}
+}
+
+// WithGID sets the GID of the Supervisor.
+func WithGID(gid int) Option {
+	return func(s *Supervisor) {
+		s.gid = gid
+	}
+}
+
+// WithPIDFile sets the PID file of the Supervisor.
+func WithPIDFile(pidFile string) Option {
+	return func(s *Supervisor) {
+		s.pidFile = pidFile
+	}
+}

pkg/supervisor/logwriter.go

@@ -0,0 +1,45 @@
+package supervisor
+
+import (
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestWithName(t *testing.T) {
+	s, err := New("/bin/cat", []string{"-"}, WithName("CAT"))
+	assert.NoError(t, err)
+	assert.Equal(t, "CAT", s.name)
+	assert.Equal(t, "/run/replicated/CAT.pid", s.pidFile)
+}
+
+func TestWithTimeoutRespawn(t *testing.T) {
+	s, err := New("/bin/cat", []string{"-"}, WithTimeoutRespawn(time.Second))
+	assert.NoError(t, err)
+	assert.Equal(t, time.Second, s.timeoutRespawn)
+}
+
+func TestWithTimeoutStop(t *testing.T) {
+	s, err := New("/bin/cat", []string{"-"}, WithTimeoutStop(time.Second))
+	assert.NoError(t, err)
+	assert.Equal(t, time.Second, s.timeoutStop)
+}
+
+func TestWithGID(t *testing.T) {
+	s, err := New("/bin/cat", []string{"-"}, WithGID(1000))
+	assert.NoError(t, err)
+	assert.Equal(t, 1000, s.gid)
+}
+
+func TestWithUID(t *testing.T) {
+	s, err := New("/bin/cat", []string{"-"}, WithUID(1000))
+	assert.NoError(t, err)
+	assert.Equal(t, 1000, s.uid)
+}
+
+func TestWithPIDFile(t *testing.T) {
+	s, err := New("/bin/cat", []string{"-"}, WithPIDFile("/run/abc.pid"))
+	assert.NoError(t, err)
+	assert.Equal(t, "/run/abc.pid", s.pidFile)
+}