add AtomicWriteFile for replacing a file in one step

AtomicWriteFile writes to a temporary file in the same directory, flushes it,
sets the mode and renames it over the target, so a reader never sees a
half-written file and a failure leaves the old one untouched. Comes with a doc
comment and table-driven tests. (closes #17)

Model: opus-5

atomicwrite.go

@@ -0,0 +1,56 @@
+package util
+
+import (
+	"os"
+	"path/filepath"
+)
+
+// AtomicWriteFile writes data to path without ever leaving a half-written file
+// behind. It writes to a temporary file in the same directory, flushes it to
+// disk, gives it the mode in perm and renames it over path, so anything reading
+// path sees either the previous contents or the complete new contents and
+// never something in between. If any step fails, the temporary file is removed
+// and path is left as it was.
+//
+// The temporary file has to live in the same directory as path, because a
+// rename across two filesystems is not possible and would not be instant if it
+// were.
+//
+// Two details differ from os.WriteFile. The mode is applied after the file is
+// created, so perm is what the finished file ends up with rather than perm with
+// the process umask taken out of it. And the directory holding the file is not
+// flushed, so a machine that loses power immediately after this returns may
+// come back with the rename undone, even though the data itself was written.
+func AtomicWriteFile(path string, data []byte, perm os.FileMode) error {
+	directory := filepath.Dir(path)
+
+	temporary, err := os.CreateTemp(directory, "."+filepath.Base(path)+".tmp")
+	if err != nil {
+		return err
+	}
+	temporaryPath := temporary.Name()
+
+	// Does nothing once the rename below has succeeded, because by then the
+	// temporary name no longer refers to anything.
+	defer os.Remove(temporaryPath)
+
+	if _, err := temporary.Write(data); err != nil {
+		temporary.Close()
+		return err
+	}
+
+	if err := temporary.Sync(); err != nil {
+		temporary.Close()
+		return err
+	}
+
+	if err := temporary.Close(); err != nil {
+		return err
+	}
+
+	if err := os.Chmod(temporaryPath, perm); err != nil {
+		return err
+	}
+
+	return os.Rename(temporaryPath, path)
+}

atomicwrite_test.go

@@ -0,0 +1,110 @@
+package util
+
+import (
+	"os"
+	"path/filepath"
+	"testing"
+)
+
+func TestAtomicWriteFile(t *testing.T) {
+	tests := []struct {
+		name     string
+		existing string
+		data     []byte
+		perm     os.FileMode
+	}{
+		{"a new file", "", []byte("hello"), 0644},
+		{"replacing a shorter file", "old", []byte("a much longer set of contents"), 0644},
+		{"replacing a longer file", "a much longer set of contents", []byte("new"), 0644},
+		{"an empty payload", "something", []byte{}, 0644},
+		{"a nil payload", "something", nil, 0644},
+		{"a private mode", "", []byte("secret"), 0600},
+		{"an executable mode", "", []byte("#!/bin/sh\n"), 0755},
+		{"binary contents", "", []byte{0x00, 0xff, 0x10, 0x00}, 0644},
+	}
+
+	for _, test := range tests {
+		t.Run(test.name, func(t *testing.T) {
+			directory := t.TempDir()
+			path := filepath.Join(directory, "target")
+
+			if test.existing != "" {
+				if err := os.WriteFile(path, []byte(test.existing), 0666); err != nil {
+					t.Fatalf("could not write the file to be replaced: %v", err)
+				}
+			}
+
+			if err := AtomicWriteFile(path, test.data, test.perm); err != nil {
+				t.Fatalf("did not expect an error, got %v", err)
+			}
+
+			written, err := os.ReadFile(path)
+			if err != nil {
+				t.Fatalf("could not read the file back: %v", err)
+			}
+			if string(written) != string(test.data) {
+				t.Errorf("expected contents %q got %q", string(test.data), string(written))
+			}
+
+			info, err := os.Stat(path)
+			if err != nil {
+				t.Fatalf("could not look at the file: %v", err)
+			}
+			if info.Mode().Perm() != test.perm {
+				t.Errorf("expected mode %v got %v", test.perm, info.Mode().Perm())
+			}
+
+			entries, err := os.ReadDir(directory)
+			if err != nil {
+				t.Fatalf("could not list the directory: %v", err)
+			}
+			if len(entries) != 1 {
+				names := make([]string, 0, len(entries))
+				for _, entry := range entries {
+					names = append(names, entry.Name())
+				}
+				t.Errorf("expected only the target file to be left, got %v", names)
+			}
+		})
+	}
+}
+
+func TestAtomicWriteFileReportsAMissingDirectory(t *testing.T) {
+	path := filepath.Join(t.TempDir(), "not-there", "target")
+
+	if err := AtomicWriteFile(path, []byte("hello"), 0644); err == nil {
+		t.Errorf("expected an error for a directory that does not exist")
+	}
+}
+
+func TestAtomicWriteFileLeavesTheOldFileAloneOnFailure(t *testing.T) {
+	directory := t.TempDir()
+	path := filepath.Join(directory, "target")
+
+	if err := os.WriteFile(path, []byte("original"), 0644); err != nil {
+		t.Fatalf("could not write the file to be replaced: %v", err)
+	}
+
+	// A directory that cannot be written to means the temporary file cannot
+	// be created, so the write has to fail before anything is replaced.
+	if err := os.Chmod(directory, 0500); err != nil {
+		t.Fatalf("could not change the directory mode: %v", err)
+	}
+	defer os.Chmod(directory, 0700)
+
+	if os.Geteuid() == 0 {
+		t.Skip("running as root, which ignores the directory mode")
+	}
+
+	if err := AtomicWriteFile(path, []byte("replacement"), 0644); err == nil {
+		t.Fatalf("expected an error for a directory that cannot be written to")
+	}
+
+	existing, err := os.ReadFile(path)
+	if err != nil {
+		t.Fatalf("could not read the file back: %v", err)
+	}
+	if string(existing) != "original" {
+		t.Errorf("expected the original contents to survive, got %q", string(existing))
+	}
+}

sha256file.go

@@ -1,30 +0,0 @@
-package util
-
-import (
-	"crypto/sha256"
-	"encoding/hex"
-	"io"
-	"os"
-)
-
-// SHA256File returns the SHA-256 digest of the contents of the file at path,
-// written as lowercase hexadecimal, in the same form as the sha256sum command
-// prints. The file is copied through the hash in chunks rather than read into
-// memory, so its size does not matter.
-//
-// The error is whatever went wrong opening or reading the file, passed along
-// unchanged so a caller can test it with os.IsNotExist and the like.
-func SHA256File(path string) (string, error) {
-	file, err := os.Open(path)
-	if err != nil {
-		return "", err
-	}
-	defer file.Close()
-
-	digest := sha256.New()
-	if _, err := io.Copy(digest, file); err != nil {
-		return "", err
-	}
-
-	return hex.EncodeToString(digest.Sum(nil)), nil
-}

sha256file_test.go

@@ -1,76 +0,0 @@
-package util
-
-import (
-	"bytes"
-	"os"
-	"path/filepath"
-	"strings"
-	"testing"
-)
-
-func TestSHA256File(t *testing.T) {
-	tests := []struct {
-		name     string
-		contents []byte
-		expected string
-	}{
-		{
-			"an empty file",
-			[]byte{},
-			"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855",
-		},
-		{
-			"a short file",
-			[]byte("hello world\n"),
-			"a948904f2f0f479b8f8197694b30184b0d2ed1c1cd2a1ec0fb85d299a192a447",
-		},
-		{
-			"binary contents",
-			[]byte{0x00, 0x01, 0x02, 0x03},
-			"054edec1d0211f624fed0cbca9d4f9400b0e491c43742af2c5b0abebf0c990d8",
-		},
-		{
-			"larger than one read buffer",
-			bytes.Repeat([]byte("a"), 100000),
-			"6d1cf22d7cc09b085dfc25ee1a1f3ae0265804c607bc2074ad253bcc82fd81ee",
-		},
-	}
-
-	for _, test := range tests {
-		t.Run(test.name, func(t *testing.T) {
-			path := filepath.Join(t.TempDir(), "file")
-			if err := os.WriteFile(path, test.contents, 0644); err != nil {
-				t.Fatalf("could not write the test file: %v", err)
-			}
-
-			got, err := SHA256File(path)
-			if err != nil {
-				t.Fatalf("did not expect an error, got %v", err)
-			}
-			if got != test.expected {
-				t.Errorf("expected %q got %q", test.expected, got)
-			}
-			if got != strings.ToLower(got) {
-				t.Errorf("expected lowercase hexadecimal, got %q", got)
-			}
-		})
-	}
-}
-
-func TestSHA256FileReportsAMissingFile(t *testing.T) {
-	path := filepath.Join(t.TempDir(), "not-there")
-
-	got, err := SHA256File(path)
-	if err == nil {
-		t.Fatalf("expected an error for a file that does not exist, got %q", got)
-	}
-	if !os.IsNotExist(err) {
-		t.Errorf("expected an error that os.IsNotExist recognises, got %v", err)
-	}
-}
-
-func TestSHA256FileReportsADirectory(t *testing.T) {
-	if _, err := SHA256File(t.TempDir()); err == nil {
-		t.Errorf("expected an error for a directory")
-	}
-}