Add unmanaged option to file proto (#964)

* add unmanaged option to file

Author: aphralG

api/grpc/mpi/v1/files.pb.go

@@ -92,6 +92,8 @@ message File {
     }
     // Optional action
     optional FileAction action = 2;
+    // Unmanaged files will not be modified
+    bool unmanaged = 3;
 }
 
 // Represents the get file request
@@ -290,4 +292,4 @@ message AttributeTypeAndValue {
 
     // The value associated with the attribute.
     string value = 2 [(buf.validate.field).string.min_len = 1];
-}
+}

api/grpc/mpi/v1/files.pb.validate.go

@@ -298,6 +298,7 @@ Represents meta data about a file
 | ----- | ---- | ----- | ----------- |
 | file_meta | [FileMeta](#mpi-v1-FileMeta) |  | Meta information about the file, the name (including path) and hash |
 | action | [File.FileAction](#mpi-v1-File-FileAction) | optional | Optional action |
+| unmanaged | [bool](#bool) |  | Unmanaged files will not be modified |
 
 
 

api/grpc/mpi/v1/files.proto

@@ -473,6 +473,11 @@ func (fms *FileManagerService) DetermineFileActions(currentFiles, modifiedFiles
 		currentFile, ok := currentFiles[file.GetFileMeta().GetName()]
 		// default to unchanged action
 		file.Action = &unchangedAction
+
+		// if file is unmanaged, action is set to unchanged so file is skipped when performing actions
+		if file.GetUnmanaged() {
+			continue
+		}
 		// if file doesn't exist in the current files, file has been added
 		// set file action
 		if !ok {

docs/proto/protos.md

@@ -462,6 +462,12 @@ func TestFileManagerService_DetermineFileActions(t *testing.T) {
 
 	addTestFileName := tempDir + "/nginx_add.conf"
 
+	unmanagedFile := helpers.CreateFileWithErrorCheck(t, tempDir, "nginx_unmanaged.conf")
+	defer helpers.RemoveFileWithErrorCheck(t, unmanagedFile.Name())
+	unmanagedFileContent := []byte("test unmanaged file")
+	unmanagedErr := os.WriteFile(unmanagedFile.Name(), unmanagedFileContent, 0o600)
+	require.NoError(t, unmanagedErr)
+
 	tests := []struct {
 		expectedError   error
 		modifiedFiles   map[string]*mpi.File
@@ -479,6 +485,10 @@ func TestFileManagerService_DetermineFileActions(t *testing.T) {
 				updateTestFile.Name(): {
 					FileMeta: protos.FileMeta(updateTestFile.Name(), files.GenerateHash(updatedFileContent)),
 				},
+				unmanagedFile.Name(): {
+					FileMeta:  protos.FileMeta(unmanagedFile.Name(), files.GenerateHash(unmanagedFileContent)),
+					Unmanaged: true,
+				},
 			},
 			currentFiles: map[string]*mpi.File{
 				deleteTestFile.Name(): {
@@ -487,6 +497,10 @@ func TestFileManagerService_DetermineFileActions(t *testing.T) {
 				updateTestFile.Name(): {
 					FileMeta: protos.FileMeta(updateTestFile.Name(), files.GenerateHash(fileContent)),
 				},
+				unmanagedFile.Name(): {
+					FileMeta:  protos.FileMeta(unmanagedFile.Name(), files.GenerateHash(fileContent)),
+					Unmanaged: true,
+				},
 			},
 			expectedCache: map[string]*mpi.File{
 				deleteTestFile.Name(): {