pkg/pidfile: remove PIDFile type, rename New() to Write()
This type felt really redundant; `pidfile.New()` takes the path of the file to create as an argument, so this is already known. The only thing the PIDFile type provided was a `Remove()` method, which was just calling `os.Remove()` on the path of the file. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
parent
dd8983f96c
commit
43d6eb7173
|
@ -139,13 +139,12 @@ func (cli *DaemonCli) start(opts *daemonOptions) (err error) {
|
||||||
potentiallyUnderRuntimeDir := []string{cli.Config.ExecRoot}
|
potentiallyUnderRuntimeDir := []string{cli.Config.ExecRoot}
|
||||||
|
|
||||||
if cli.Pidfile != "" {
|
if cli.Pidfile != "" {
|
||||||
pf, err := pidfile.New(cli.Pidfile)
|
if err := pidfile.Write(cli.Pidfile); err != nil {
|
||||||
if err != nil {
|
|
||||||
return errors.Wrap(err, "failed to start daemon")
|
return errors.Wrap(err, "failed to start daemon")
|
||||||
}
|
}
|
||||||
potentiallyUnderRuntimeDir = append(potentiallyUnderRuntimeDir, cli.Pidfile)
|
potentiallyUnderRuntimeDir = append(potentiallyUnderRuntimeDir, cli.Pidfile)
|
||||||
defer func() {
|
defer func() {
|
||||||
if err := pf.Remove(); err != nil {
|
if err := os.Remove(cli.Pidfile); err != nil {
|
||||||
logrus.Error(err)
|
logrus.Error(err)
|
||||||
}
|
}
|
||||||
}()
|
}()
|
||||||
|
|
|
@ -13,11 +13,6 @@ import (
|
||||||
"github.com/docker/docker/pkg/system"
|
"github.com/docker/docker/pkg/system"
|
||||||
)
|
)
|
||||||
|
|
||||||
// PIDFile is a file used to store the process ID of a running process.
|
|
||||||
type PIDFile struct {
|
|
||||||
path string
|
|
||||||
}
|
|
||||||
|
|
||||||
func checkPIDFileAlreadyExists(path string) error {
|
func checkPIDFileAlreadyExists(path string) error {
|
||||||
pidByte, err := os.ReadFile(path)
|
pidByte, err := os.ReadFile(path)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
|
@ -33,23 +28,15 @@ func checkPIDFileAlreadyExists(path string) error {
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// New creates a PIDfile using the specified path.
|
// Write writes a "PID file" at the specified path. It returns an error if the
|
||||||
func New(path string) (*PIDFile, error) {
|
// file exists and contains a valid PID of a running process, or when failing
|
||||||
|
// to write the file.
|
||||||
|
func Write(path string) error {
|
||||||
if err := checkPIDFileAlreadyExists(path); err != nil {
|
if err := checkPIDFileAlreadyExists(path); err != nil {
|
||||||
return nil, err
|
return err
|
||||||
}
|
}
|
||||||
// Note MkdirAll returns nil if a directory already exists
|
|
||||||
if err := system.MkdirAll(filepath.Dir(path), 0o755); err != nil {
|
if err := system.MkdirAll(filepath.Dir(path), 0o755); err != nil {
|
||||||
return nil, err
|
return err
|
||||||
}
|
}
|
||||||
if err := os.WriteFile(path, []byte(strconv.Itoa(os.Getpid())), 0o644); err != nil {
|
return os.WriteFile(path, []byte(strconv.Itoa(os.Getpid())), 0o644)
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return &PIDFile{path: path}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Remove removes the PIDFile.
|
|
||||||
func (file PIDFile) Remove() error {
|
|
||||||
return os.Remove(file.path)
|
|
||||||
}
|
}
|
||||||
|
|
|
@ -1,37 +1,19 @@
|
||||||
package pidfile // import "github.com/docker/docker/pkg/pidfile"
|
package pidfile // import "github.com/docker/docker/pkg/pidfile"
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"os"
|
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"testing"
|
"testing"
|
||||||
)
|
)
|
||||||
|
|
||||||
func TestNewAndRemove(t *testing.T) {
|
func TestWrite(t *testing.T) {
|
||||||
dir, err := os.MkdirTemp(os.TempDir(), "test-pidfile")
|
path := filepath.Join(t.TempDir(), "testfile")
|
||||||
if err != nil {
|
err := Write(path)
|
||||||
t.Fatal("Could not create test directory")
|
|
||||||
}
|
|
||||||
|
|
||||||
path := filepath.Join(dir, "testfile")
|
|
||||||
file, err := New(path)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
t.Fatal("Could not create test file", err)
|
t.Fatal("Could not create test file", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
_, err = New(path)
|
err = Write(path)
|
||||||
if err == nil {
|
if err == nil {
|
||||||
t.Fatal("Test file creation not blocked")
|
t.Fatal("Test file creation not blocked")
|
||||||
}
|
}
|
||||||
|
|
||||||
if err := file.Remove(); err != nil {
|
|
||||||
t.Fatal("Could not delete created test file")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRemoveInvalidPath(t *testing.T) {
|
|
||||||
file := PIDFile{path: filepath.Join("foo", "bar")}
|
|
||||||
|
|
||||||
if err := file.Remove(); err == nil {
|
|
||||||
t.Fatal("Non-existing file doesn't give an error on delete")
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue