Rename WriteFiles to SyncDirectory

Author: tchap

pkg/operator/staticpod/certsyncpod/certsync_controller.go

@@ -152,7 +152,7 @@ func (c *CertSyncController) sync(ctx context.Context, syncCtx factory.SyncConte
 			continue
 		}
 
-		errors = append(errors, writeFiles(c.eventRecorder, "configmap", configMap.ObjectMeta, contentDir, data, 0644))
+		errors = append(errors, syncDirectory(c.eventRecorder, "configmap", configMap.ObjectMeta, contentDir, data, 0644))
 	}
 
 	klog.Infof("Syncing secrets: %v", c.secrets)
@@ -237,17 +237,17 @@ func (c *CertSyncController) sync(ctx context.Context, syncCtx factory.SyncConte
 			continue
 		}
 
-		errors = append(errors, writeFiles(c.eventRecorder, "secret", secret.ObjectMeta, contentDir, data, 0600))
+		errors = append(errors, syncDirectory(c.eventRecorder, "secret", secret.ObjectMeta, contentDir, data, 0600))
 	}
 	return utilerrors.NewAggregate(errors)
 }
 
-func writeFiles[C string | []byte](
+func syncDirectory[C string | []byte](
 	eventRecorder events.Recorder,
 	typeName string, o metav1.ObjectMeta,
 	targetDir string, files map[string]C, filePerm os.FileMode,
 ) error {
-	if err := atomicfiles.WriteFiles(typeName, o, targetDir, files, filePerm); err != nil {
+	if err := atomicfiles.SyncDirectory(typeName, o, targetDir, files, filePerm); err != nil {
 		eventRecorder.Warning("CertificateUpdateFailed", err.Error())
 		return err
 	}

pkg/operator/staticpod/installerpod/cmd.go

@@ -257,7 +257,7 @@ func (o *InstallOptions) copySecretsAndConfigMaps(ctx context.Context, resourceD
 			secretBaseName = o.prefixFor(secret.Name)
 		}
 		contentDir := path.Join(resourceDir, "secrets", secretBaseName)
-		if err := atomicfiles.WriteFiles("secret", secret.ObjectMeta, contentDir, secret.Data, 0600); err != nil {
+		if err := atomicfiles.SyncDirectory("secret", secret.ObjectMeta, contentDir, secret.Data, 0600); err != nil {
 			return err
 		}
 	}
@@ -267,7 +267,7 @@ func (o *InstallOptions) copySecretsAndConfigMaps(ctx context.Context, resourceD
 			configMapBaseName = o.prefixFor(configmap.Name)
 		}
 		contentDir := path.Join(resourceDir, "configmaps", configMapBaseName)
-		if err := atomicfiles.WriteFiles("configmap", configmap.ObjectMeta, contentDir, configmap.Data, 0600); err != nil {
+		if err := atomicfiles.SyncDirectory("configmap", configmap.ObjectMeta, contentDir, configmap.Data, 0600); err != nil {
 			return err
 		}
 	}

pkg/operator/staticpod/internal/atomicfiles/write_files.go renamed to pkg/operator/staticpod/internal/atomicfiles/sync_directory.go

@@ -9,12 +9,16 @@ import (
 	"k8s.io/klog/v2"
 )
 
-// WriteFiles can be used to atomically write given files into the target directory.
+// SyncDirectory can be used to atomically synchronize target directory with the given file content map.
 // This is done by populating a temporary directory, then atomically swapping it with the target directory.
-func WriteFiles[C string | []byte](
+// This effectively means that any extra files in the target directory are pruned.
+//
+// SyncDirectory is supposed to be used with secrets/configmaps, so typeName is expected to be "configmap" or "secret".
+// This does not affect the logic, but it's included in error messages.
+func SyncDirectory[C string | []byte](
 	typeName string, o metav1.ObjectMeta, targetDir string, files map[string]C, filePerm os.FileMode,
 ) error {
-	return writeFiles(&realFS, typeName, o, targetDir, files, filePerm)
+	return syncDirectory(&realFS, typeName, o, targetDir, files, filePerm)
 }
 
 type fileSystem struct {
@@ -33,7 +37,7 @@ var realFS = fileSystem{
 	SwapDirectoriesAtomic: SwapDirectories,
 }
 
-func writeFiles[C string | []byte](
+func syncDirectory[C string | []byte](
 	fs *fileSystem, typeName string, o metav1.ObjectMeta,
 	targetDir string, files map[string]C, filePerm os.FileMode,
 ) error {

pkg/operator/staticpod/internal/atomicfiles/write_files_test.go renamed to pkg/operator/staticpod/internal/atomicfiles/sync_directory_test.go

@@ -307,7 +307,7 @@ func TestWriteFiles(t *testing.T) {
 			}
 
 			// Replace with the object data.
-			err := writeFiles(tc.newFS(), typeName, om, contentDir, tc.objectData, 0600)
+			err := syncDirectory(tc.newFS(), typeName, om, contentDir, tc.objectData, 0600)
 
 			// Check the resulting state.
 			tc.checkState(t, contentDir, tc.directoryData, tc.objectData, err)