Explain copy to output using None and Content items with CopyToOutput…

…Directory
KirillOsenkov · Dec 5, 2023 · c848a1b · c848a1b
1 parent a589546
commit c848a1b
Showing 1 changed file with 56 additions and 0 deletions.
diff --git a/src/StructuredLogger/Analyzers/FileCopyMap.cs b/src/StructuredLogger/Analyzers/FileCopyMap.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Linq;
 using StructuredLogViewer;
 
 namespace Microsoft.Build.Logging.StructuredLogger
@@ -225,6 +226,7 @@ public bool TryGetResults(NodeQueryMatcher matcher, IList<SearchResult> resultSe
                     if (resultSet.Count == 1)
                     {
                         FoundSingleFileCopy?.Invoke(fileData, resultSet);
+                        TryExplainSingleFileCopy(fileData, resultSet);
                     }
                 }
                 else
@@ -238,6 +240,60 @@ public bool TryGetResults(NodeQueryMatcher matcher, IList<SearchResult> resultSe
             return false;
         }
 
+        private void TryExplainSingleFileCopy(FileData fileData, IList<SearchResult> resultSet)
+        {
+            var fileCopyInfo = fileData.Incoming.FirstOrDefault() ?? fileData.Outgoing.FirstOrDefault();
+            var project = fileCopyInfo.Project;
+
+            var filePath = fileData.FilePath;
+            if (fileData.Incoming.Count == 1)
+            {
+                filePath = fileCopyInfo.FileCopyOperation.Source;
+            }
+
+            var fileName = Path.GetFileName(filePath);
+
+            var build = project.GetRoot() as Build;
+            if (build == null)
+            {
+                return;
+            }
+
+            var evaluation = build.FindEvaluation(project.EvaluationId);
+            if (evaluation == null)
+            {
+                return;
+            }
+
+            var itemsFolder = evaluation.FindChild<NamedNode>("Items");
+            if (itemsFolder == null)
+            {
+                return;
+            }
+
+            FindCopyToOutputDirectoryItem(resultSet, itemsFolder, fileName, "None");
+            FindCopyToOutputDirectoryItem(resultSet, itemsFolder, fileName, "Content");
+        }
+
+        private static void FindCopyToOutputDirectoryItem(IList<SearchResult> resultSet, NamedNode itemsFolder, string fileName, string itemName)
+        {
+            var addItem = itemsFolder.FindChild<AddItem>(itemName);
+            if (addItem != null)
+            {
+                foreach (var item in addItem.Children.OfType<Item>())
+                {
+                    string name = Path.GetFileName(item.Name);
+                    if (fileName.Equals(name, StringComparison.OrdinalIgnoreCase))
+                    {
+                        if (item.FindChild<Metadata>("CopyToOutputDirectory") is { } metadata && (metadata.Value == "Always" || metadata.Value == "PreserveNewest"))
+                        {
+                            resultSet.Add(new SearchResult(item));
+                        }
+                    }
+                }
+            }
+        }
+
         private void TryGetFiles(string text, IList<SearchResult> resultSet, int maxResults)
         {
             var results = new List<SearchResult>();