Use FileMappings when calculating the GoalState

Author: jimmylewis

src/LibraryManager/Json/LibraryStateToFileConverter.cs

@@ -35,7 +35,7 @@ public ILibraryInstallationState ConvertToLibraryInstallationState(LibraryInstal
                 ProviderId = provider,
                 DestinationPath = destination,
                 Files = stateOnDisk.Files,
-                FileMappings = stateOnDisk.FileMappings.Select(f => new Contracts.FileMapping { Destination = f.Destination, Root = f.Root, Files = f.Files }).ToList(),
+                FileMappings = stateOnDisk.FileMappings?.Select(f => new Contracts.FileMapping { Destination = f.Destination, Root = f.Root, Files = f.Files }).ToList(),
             };
 
             (state.Name, state.Version) = LibraryIdToNameAndVersionConverter.Instance.GetLibraryNameAndVersion(stateOnDisk.LibraryId, provider);

src/LibraryManager/Providers/BaseProvider.cs

@@ -247,48 +247,92 @@ public async Task<OperationResult<LibraryInstallationGoalState>> GetInstallation
 
         private OperationResult<LibraryInstallationGoalState> GenerateGoalState(ILibraryInstallationState desiredState, ILibrary library)
         {
+            var mappings = new List<FileMapping>(desiredState.FileMappings ?? []);
             List<IError> errors = null;
-
-            if (string.IsNullOrEmpty(desiredState.DestinationPath))
-            {
-                return OperationResult<LibraryInstallationGoalState>.FromError(PredefinedErrors.DestinationNotSpecified(desiredState.Name));
-            }
-
-            IEnumerable<string> outFiles;
-            if (desiredState.Files == null || desiredState.Files.Count == 0)
+            if (desiredState.Files is { Count: > 0 })
             {
-                outFiles = library.Files.Keys;
+                mappings.Add(new FileMapping { Destination = desiredState.DestinationPath, Files = desiredState.Files });
             }
-            else
+            else if (desiredState.FileMappings is null or { Count: 0 })
             {
-                outFiles = FileGlobbingUtility.ExpandFileGlobs(desiredState.Files, library.Files.Keys);
+                // no files specified and no file mappings => include all files
+                mappings.Add(new FileMapping { Destination = desiredState.DestinationPath });
             }
 
             Dictionary<string, string> installFiles = new();
-            if (library.GetInvalidFiles(outFiles.ToList()) is IReadOnlyList<string> invalidFiles
-                && invalidFiles.Count > 0)
-            {
-                errors ??= [];
-                errors.Add(PredefinedErrors.InvalidFilesInLibrary(desiredState.Name, invalidFiles, library.Files.Keys));
-            }
 
-            foreach (string outFile in outFiles)
+            foreach (FileMapping fileMapping in mappings)
             {
-                // strip the source prefix
-                string destinationFile = Path.Combine(HostInteraction.WorkingDirectory, desiredState.DestinationPath, outFile);
-                if (!FileHelpers.IsUnderRootDirectory(destinationFile, HostInteraction.WorkingDirectory))
+                // if Root is not specified, assume it's the root of the library
+                string mappingRoot = fileMapping.Root ?? string.Empty;
+                // if Destination is not specified, inherit from the library entry
+                string destination = fileMapping.Destination ?? desiredState.DestinationPath;
+
+                if (destination is null)
+                {
+                    errors ??= [];
+                    string libraryId = LibraryNamingScheme.GetLibraryId(desiredState.Name, desiredState.Version);
+                    errors.Add(PredefinedErrors.DestinationNotSpecified(libraryId));
+                    continue;
+                }
+
+                IReadOnlyList<string> fileFilters;
+                if (fileMapping.Files is { Count: > 0 })
+                {
+                    fileFilters = fileMapping.Files;
+                }
+                else
+                {
+                    fileFilters = ["**"];
+                }
+
+                if (mappingRoot.Length > 0)
+                {
+                    // prefix mappingRoot to each fileFilter item
+                    fileFilters = fileFilters.Select(f => $"{mappingRoot}/{f}").ToList();
+                }
+
+                List<string> outFiles = FileGlobbingUtility.ExpandFileGlobs(fileFilters, library.Files.Keys).ToList();
+
+                if (library.GetInvalidFiles(outFiles) is IReadOnlyList<string> invalidFiles
+    && invalidFiles.Count > 0)
                 {
                     errors ??= [];
-                    errors.Add(PredefinedErrors.PathOutsideWorkingDirectory());
+                    errors.Add(PredefinedErrors.InvalidFilesInLibrary(desiredState.Name, invalidFiles, library.Files.Keys));
                 }
-                destinationFile = FileHelpers.NormalizePath(destinationFile);
 
-                // don't forget to include the cache folder in the path
-                string sourceFile = GetCachedFileLocalPath(desiredState, outFile);
-                sourceFile = FileHelpers.NormalizePath(sourceFile);
+                foreach (string outFile in outFiles)
+                {
+                    // strip the source prefix
+                    string relativeOutFile = mappingRoot.Length > 0 ? outFile.Substring(mappingRoot.Length + 1) : outFile;
+                    string destinationFile = Path.Combine(HostInteraction.WorkingDirectory, destination, relativeOutFile);
+                    destinationFile = FileHelpers.NormalizePath(destinationFile);
+
+                    if (!FileHelpers.IsUnderRootDirectory(destinationFile, HostInteraction.WorkingDirectory))
+                    {
+                        errors ??= [];
+                        errors.Add(PredefinedErrors.PathOutsideWorkingDirectory());
+                        continue;
+                    }
 
-                // map destination back to the library-relative file it originated from
-                installFiles.Add(destinationFile, sourceFile);
+                    // include the cache folder in the path
+                    string sourceFile = GetCachedFileLocalPath(desiredState, outFile);
+                    sourceFile = FileHelpers.NormalizePath(sourceFile);
+
+                    // map destination back to the library-relative file it originated from
+                    if (installFiles.ContainsKey(destinationFile))
+                    {
+                        // this file is already being installed from another mapping
+                        errors ??= [];
+                        string libraryId = LibraryNamingScheme.GetLibraryId(desiredState.Name, desiredState.Version);
+                        errors.Add(PredefinedErrors.LibraryCannotBeInstalledDueToConflicts(destinationFile, [libraryId]));
+                        continue;
+                    }
+                    else
+                    {
+                        installFiles.Add(destinationFile, sourceFile);
+                    }
+                }
             }
 
             if (errors is not null)