use atomicfile to create the file

Author: elee1766

account_test.go

@@ -29,25 +29,25 @@ import (
 	"go.uber.org/zap"
 )
 
-// testingMemoryStorage is an in-memory storage implementation with known contents *and* fixed iteration order for List.
-type testingMemoryStorage struct {
-	contents []testingMemoryStorageItem
+// memoryStorage is an in-memory storage implementation with known contents *and* fixed iteration order for List.
+type memoryStorage struct {
+	contents []memoryStorageItem
 }
 
-type testingMemoryStorageItem struct {
+type memoryStorageItem struct {
 	key  string
 	data []byte
 }
 
-func (m *testingMemoryStorage) lookup(_ context.Context, key string) *testingMemoryStorageItem {
+func (m *memoryStorage) lookup(_ context.Context, key string) *memoryStorageItem {
 	for _, item := range m.contents {
 		if item.key == key {
 			return &item
 		}
 	}
 	return nil
 }
-func (m *testingMemoryStorage) Delete(ctx context.Context, key string) error {
+func (m *memoryStorage) Delete(ctx context.Context, key string) error {
 	for i, item := range m.contents {
 		if item.key == key {
 			m.contents = append(m.contents[:i], m.contents[i+1:]...)
@@ -56,14 +56,14 @@ func (m *testingMemoryStorage) Delete(ctx context.Context, key string) error {
 	}
 	return fs.ErrNotExist
 }
-func (m *testingMemoryStorage) Store(ctx context.Context, key string, value []byte) error {
-	m.contents = append(m.contents, testingMemoryStorageItem{key: key, data: value})
+func (m *memoryStorage) Store(ctx context.Context, key string, value []byte) error {
+	m.contents = append(m.contents, memoryStorageItem{key: key, data: value})
 	return nil
 }
-func (m *testingMemoryStorage) Exists(ctx context.Context, key string) bool {
+func (m *memoryStorage) Exists(ctx context.Context, key string) bool {
 	return m.lookup(ctx, key) != nil
 }
-func (m *testingMemoryStorage) List(ctx context.Context, path string, recursive bool) ([]string, error) {
+func (m *memoryStorage) List(ctx context.Context, path string, recursive bool) ([]string, error) {
 	if recursive {
 		panic("unimplemented")
 	}
@@ -88,22 +88,22 @@ nextitem:
 	}
 	return result, nil
 }
-func (m *testingMemoryStorage) Load(ctx context.Context, key string) ([]byte, error) {
+func (m *memoryStorage) Load(ctx context.Context, key string) ([]byte, error) {
 	if item := m.lookup(ctx, key); item != nil {
 		return item.data, nil
 	}
 	return nil, fs.ErrNotExist
 }
-func (m *testingMemoryStorage) Stat(ctx context.Context, key string) (KeyInfo, error) {
+func (m *memoryStorage) Stat(ctx context.Context, key string) (KeyInfo, error) {
 	if item := m.lookup(ctx, key); item != nil {
 		return KeyInfo{Key: key, Size: int64(len(item.data))}, nil
 	}
 	return KeyInfo{}, fs.ErrNotExist
 }
-func (m *testingMemoryStorage) Lock(ctx context.Context, name string) error   { panic("unimplemented") }
-func (m *testingMemoryStorage) Unlock(ctx context.Context, name string) error { panic("unimplemented") }
+func (m *memoryStorage) Lock(ctx context.Context, name string) error   { panic("unimplemented") }
+func (m *memoryStorage) Unlock(ctx context.Context, name string) error { panic("unimplemented") }
 
-var _ Storage = (*testingMemoryStorage)(nil)
+var _ Storage = (*memoryStorage)(nil)
 
 type recordingStorage struct {
 	Storage
@@ -293,7 +293,7 @@ func TestGetAccountAlreadyExistsSkipsBroken(t *testing.T) {
 	am := &ACMEIssuer{CA: dummyCA, Logger: zap.NewNop(), mu: new(sync.Mutex)}
 	testConfig := &Config{
 		Issuers:   []Issuer{am},
-		Storage:   &testingMemoryStorage{},
+		Storage:   &memoryStorage{},
 		Logger:    defaultTestLogger,
 		certCache: new(Cache),
 	}
@@ -342,7 +342,7 @@ func TestGetAccountWithEmailAlreadyExists(t *testing.T) {
 	am := &ACMEIssuer{CA: dummyCA, Logger: zap.NewNop(), mu: new(sync.Mutex)}
 	testConfig := &Config{
 		Issuers:   []Issuer{am},
-		Storage:   &recordingStorage{Storage: &testingMemoryStorage{}},
+		Storage:   &recordingStorage{Storage: &memoryStorage{}},
 		Logger:    defaultTestLogger,
 		certCache: new(Cache),
 	}

filestorage.go

@@ -289,7 +289,7 @@ func fileLockIsStale(meta lockMeta) bool {
 // identified by filename. A successfully created
 // lockfile should be removed with removeLockfile.
 func createLockfile(filename string) error {
-	err := atomicallyCreateFile(filename, true)
+	err := atomicallyCreateFile(filename)
 	if err != nil {
 		return err
 	}
@@ -376,29 +376,26 @@ func updateLockfileFreshness(filename string) (bool, error) {
 
 // atomicallyCreateFile atomically creates the file
 // identified by filename if it doesn't already exist.
-func atomicallyCreateFile(filename string, writeLockInfo bool) error {
+func atomicallyCreateFile(filename string) error {
 	// no need to check this error, we only really care about the file creation error
 	_ = os.MkdirAll(filepath.Dir(filename), 0700)
-	f, err := os.OpenFile(filename, os.O_CREATE|os.O_WRONLY|os.O_EXCL, 0644)
+	fp, err := atomicfile.New(filename, 0o600)
 	if err != nil {
+		// cancel the write if file creation fails and error out
 		return err
 	}
-	defer f.Close()
-	if writeLockInfo {
-		now := time.Now()
-		meta := lockMeta{
-			Created: now,
-			Updated: now,
-		}
-		if err := json.NewEncoder(f).Encode(meta); err != nil {
-			return err
-		}
-		// see https://github.com/caddyserver/caddy/issues/3954
-		if err := f.Sync(); err != nil {
-			return err
-		}
+	now := time.Now()
+	meta := lockMeta{
+		Created: now,
+		Updated: now,
 	}
-	return nil
+	if err := json.NewEncoder(fp).Encode(meta); err != nil {
+		// cancel the write if json encoding fails and error out
+		fp.Cancel()
+		return err
+	}
+	// close, thereby flushing the write
+	return fp.Close()
 }
 
 // homeDir returns the best guess of the current user's home