pkg/environment: Migrate fs functions to fsx

pkg/environment/environment.go

@@ -1,25 +1,3 @@
 package environment
 
-import (
-	"io"
-	"io/fs"
-)
-
-// Environment represents an environment that a program can run it.
-// It mostly mimics the interfaces of the [os] package.
-type Environment interface {
-	isEnv()
-
-	Create(path string, mode fs.FileMode) (WritableFile, error)
-	Mkdir(path string, mode fs.FileMode) error
-	MkdirAll(path string, mode fs.FileMode) error
-}
-
-type WritableFile interface {
-	fs.File
-	io.Writer
-}
-
-func init() {
-	var _ Environment = new(Native)
-}
+type Environment struct{}

pkg/environment/globals.go

@@ -1,61 +0,0 @@
-package environment
-
-import (
-	"io"
-	"io/fs"
-	"os"
-
-	"github.com/tkw1536/pkglib/pools"
-)
-
-// DefaultFilePerm is the default mode to use for files
-const DefaultFilePerm fs.FileMode = 0666
-
-// DefaultDirPerm is the default mode to use for directories
-const DefaultDirPerm fs.FileMode = fs.ModeDir | fs.ModePerm
-
-// IsExist checks if the provided error represents a 'does not exist' errror
-func IsExist(err error) bool {
-	return os.IsExist(err)
-}
-
-// IsNotExist checks if the provided error represents a 'does exist' error
-func IsNotExist(err error) bool {
-	return os.IsNotExist(err)
-}
-
-// WriteFile is like [os.WriteFile].
-func WriteFile(env Environment, path string, data []byte, mode fs.FileMode) error {
-	handle, err := env.Create(path, mode)
-	if err != nil {
-		return err
-	}
-	defer handle.Close()
-
-	if _, err := handle.Write(data); err != nil {
-		return err
-	}
-
-	return nil
-}
-
-// ReadFile is like [os.ReadFile]
-func ReadFile(env Environment, path string) ([]byte, error) {
-	// open the file!
-	file, err := os.Open(path)
-	if err != nil {
-		return nil, err
-	}
-	defer file.Close()
-
-	// copy everything into a buffer!
-	buffer := pools.GetBuffer()
-	defer pools.ReleaseBuffer(buffer)
-
-	if _, err := io.Copy(buffer, file); err != nil {
-		return nil, err
-	}
-
-	// return the buffer contents!
-	return buffer.Bytes(), nil
-}

pkg/environment/native_fs.go

@@ -1,51 +0,0 @@
-package environment
-
-import (
-	"io/fs"
-	"os"
-	"sync"
-	"syscall"
-	"time"
-)
-
-type Native struct {
-	ulock sync.Mutex
-	umask int
-}
-
-func (*Native) isEnv() {}
-
-func (n *Native) setMask(umask int) {
-	n.ulock.Lock()
-	n.umask = syscall.Umask(umask)
-}
-
-func (n *Native) resetMask() {
-	syscall.Umask(n.umask)
-	n.ulock.Unlock()
-}
-
-func (n *Native) Create(path string, mode fs.FileMode) (WritableFile, error) {
-	n.ulock.Lock()
-	defer n.ulock.Unlock()
-
-	return os.OpenFile(path, os.O_RDWR|os.O_CREATE|os.O_TRUNC, mode)
-}
-
-func (*Native) Chtimes(name string, atime time.Time, mtime time.Time) error {
-	return os.Chtimes(name, atime, mtime)
-}
-
-func (n *Native) Mkdir(path string, mode fs.FileMode) error {
-	n.setMask(0)
-	defer n.resetMask()
-
-	return os.Mkdir(path, fs.ModeDir|mode)
-}
-
-func (n *Native) MkdirAll(path string, mode fs.FileMode) error {
-	n.setMask(0)
-	defer n.resetMask()
-
-	return os.MkdirAll(path, fs.ModeDir|mode)
-}

pkg/fsx/copy.go

@@ -18,6 +18,8 @@ var ErrCopySameFile = errors.New("src and dst must be different")
 //
 // When dst and src are the same file, returns ErrCopySameFile.
 // When ctx is closed, the file is not copied.
+//
+// Ignores the umask.
 func CopyFile(ctx context.Context, env environment.Environment, dst, src string) error {
 	if err := ctx.Err(); err != nil {
 		return err
@@ -41,7 +43,7 @@ func CopyFile(ctx context.Context, env environment.Environment, dst, src string)
 	}
 
 	// open or create the destination
-	dstFile, err := env.Create(dst, srcStat.Mode())
+	dstFile, err := Create(dst, srcStat.Mode())
 	if err != nil {
 		return err
 	}
@@ -141,8 +143,8 @@ func CopyDirectory(ctx context.Context, env environment.Environment, dst, src st
 
 		// create the directory, but ignore an error if the directory already exists.
 		// this is so that we can copy one tree into another tree.
-		err = env.Mkdir(dst, info.Mode())
-		if environment.IsExist(err) && IsDirectory(env, dst) {
+		err = Mkdir(dst, info.Mode())
+		if os.IsExist(err) && IsDirectory(env, dst) {
 			err = nil
 		}
 

pkg/fsx/fsx.go

@@ -0,0 +1,16 @@
+// Package fsx provides additional file system functionality.
+//
+// Several functions in this package provide umask-ignoring functions.
+// Using these functions intervenes with the global umask.
+//
+// It is not safe to use functions provided by the standard go library concurrently with this function.
+// Users should take care that no other code in their application uses these functions.
+package fsx
+
+import "io/fs"
+
+// DefaultFilePerm should be used by callers to use a consistent file mode for new files.
+const DefaultFilePerm fs.FileMode = 0666
+
+// DefaultDirPerm should be used by callers to use a consistent mode for new directories.
+const DefaultDirPerm fs.FileMode = fs.ModeDir | fs.ModePerm

pkg/fsx/same.go

@@ -62,7 +62,7 @@ func couldBeSameFile(env environment.Environment, path1, path2 string) (same, au
 		}
 
 		// only 1 file does not exist => they could be different
-		if environment.IsNotExist(err1) != environment.IsNotExist(err2) {
+		if os.IsNotExist(err1) != os.IsNotExist(err2) {
 			return
 		}
 	}

pkg/fsx/touch.go

@@ -1,35 +0,0 @@
-package fsx
-
-import (
-	"io/fs"
-	"os"
-	"time"
-
-	"github.com/FAU-CDI/wisski-distillery/pkg/environment"
-)
-
-// Touch touches a file.
-// It is similar to the unix 'touch' command.
-//
-// If the file does not exist exists, it is created using [env.Create].
-// If the file does exist, it's access and modification times are updated to the current time.
-func Touch(env environment.Environment, path string, perm fs.FileMode) error {
-	if perm == 0 {
-		perm = environment.DefaultFilePerm
-	}
-	_, err := os.Stat(path)
-	switch {
-	case environment.IsNotExist(err):
-		f, err := env.Create(path, perm)
-		if err != nil {
-			return err
-		}
-		defer f.Close()
-		return nil
-	case err != nil:
-		return err
-	default:
-		now := time.Now().Local()
-		return os.Chtimes(path, now, now)
-	}
-}

pkg/fsx/unmasked.go

@@ -0,0 +1,101 @@
+package fsx
+
+import (
+	"io/fs"
+	"os"
+	"sync"
+	"syscall"
+	"time"
+)
+
+// mask is the global mask lock
+var m mask
+
+// mask allows disabling and re-enabling the global umask.
+// it is used by allow functions of this package.
+type mask struct {
+	l     sync.Mutex // locked?
+	umask int        // previous mask
+}
+
+// Lock blocks until no other function is using this umask
+// and then sets it to 0.
+func (mask *mask) Lock() {
+	mask.l.Lock()
+	mask.umask = syscall.Umask(0)
+}
+
+func (mask *mask) Unlock() {
+	mask.umask = syscall.Umask(mask.umask)
+	mask.l.Unlock()
+}
+
+// WriteFile is like [os.WriteFile], but ignores the umask.
+func WriteFile(path string, data []byte, mode fs.FileMode) error {
+	handle, err := Create(path, mode)
+	if err != nil {
+		return err
+	}
+	defer handle.Close()
+
+	if _, err := handle.Write(data); err != nil {
+		return err
+	}
+
+	return nil
+}
+
+// Create creates a new file with the given mode.
+// This function ignores the umask.
+func Create(path string, mode fs.FileMode) (*os.File, error) {
+	m.Lock()
+	defer m.Unlock()
+
+	return os.OpenFile(path, os.O_RDWR|os.O_CREATE|os.O_TRUNC, mode)
+}
+
+// Mkdir creates a new directory with the given mode.
+// This function ignores the umask.
+func Mkdir(path string, mode fs.FileMode) error {
+	m.Lock()
+	defer m.Unlock()
+
+	return os.Mkdir(path, fs.ModeDir|mode)
+}
+
+// MkdirAll creates a new directory and all potentially missing parent directories.
+// This function ignores the umask.
+func MkdirAll(path string, mode fs.FileMode) error {
+	m.Lock()
+	defer m.Unlock()
+
+	return os.MkdirAll(path, fs.ModeDir|mode)
+}
+
+// Touch touches a file.
+// It is similar to the unix 'touch' command.
+//
+// If the file does not exist exists, it is created using [Create].
+// If the file does exist, it's access and modification times are updated to the current time.
+//
+// This function ignores the umask.
+func Touch(path string, perm fs.FileMode) error {
+	if perm == 0 {
+		perm = DefaultFilePerm
+	}
+	_, err := os.Stat(path)
+	switch {
+	case os.IsNotExist(err):
+		f, err := Create(path, perm)
+		if err != nil {
+			return err
+		}
+		defer f.Close()
+		return nil
+	case err != nil:
+		return err
+	default:
+		now := time.Now().Local()
+		return os.Chtimes(path, now, now)
+	}
+}

pkg/targz/targz.go

@@ -10,6 +10,7 @@ import (
 	"path/filepath"
 
 	"github.com/FAU-CDI/wisski-distillery/pkg/environment"
+	"github.com/FAU-CDI/wisski-distillery/pkg/fsx"
 )
 
 // Package packages the source directory into a 'tar.gz' file into destination.
@@ -18,7 +19,7 @@ import (
 // onCopy, when not nil, is called for each file being copied into the archive.
 func Package(env environment.Environment, dst, src string, onCopy func(rel string, src string)) (count int64, err error) {
 	// create the target archive
-	archive, err := env.Create(dst, environment.DefaultFilePerm)
+	archive, err := fsx.Create(dst, fsx.DefaultFilePerm)
 	if err != nil {
 		return 0, err
 	}

pkg/unpack/resource.go

@@ -7,6 +7,7 @@ import (
 	"path/filepath"
 
 	"github.com/FAU-CDI/wisski-distillery/pkg/environment"
+	"github.com/FAU-CDI/wisski-distillery/pkg/fsx"
 	"github.com/pkg/errors"
 )
 
@@ -83,8 +84,8 @@ func installDir(env environment.Environment, dst string, srcInfo fs.FileInfo, sr
 	// create the destination
 	dstStat, dstErr := os.Stat(dst)
 	switch {
-	case environment.IsNotExist(dstErr):
-		if err := env.MkdirAll(dst, srcInfo.Mode()); err != nil {
+	case os.IsNotExist(dstErr):
+		if err := fsx.MkdirAll(dst, srcInfo.Mode()); err != nil {
 			return errors.Wrapf(err, "Error creating destination directory %s", dst)
 		}
 	case dstErr != nil:
@@ -121,7 +122,7 @@ func installDir(env environment.Environment, dst string, srcInfo fs.FileInfo, sr
 
 func installFile(env environment.Environment, dst string, srcInfo fs.FileInfo, src fs.File) error {
 	// create the file using the right mode!
-	file, err := env.Create(dst, srcInfo.Mode())
+	file, err := fsx.Create(dst, srcInfo.Mode())
 	if err != nil {
 		return err
 	}

pkg/unpack/template.go

@@ -9,6 +9,7 @@ import (
 	"strings"
 
 	"github.com/FAU-CDI/wisski-distillery/pkg/environment"
+	"github.com/FAU-CDI/wisski-distillery/pkg/fsx"
 	"golang.org/x/exp/maps"
 	"golang.org/x/exp/slices"
 )
@@ -222,7 +223,7 @@ func InstallTemplate(env environment.Environment, dst string, context map[string
 	}
 
 	// open the destination file
-	file, err := env.Create(dst, srcInfo.Mode())
+	file, err := fsx.Create(dst, srcInfo.Mode())
 	if err != nil {
 		return err
 	}