fix app.config up-to-date status

fixes #11
closes #374

commit f677819e9f4258eeee5577c23ad107132a901b07
Author: enricosada <[email protected]>
Date:   Wed Feb 25 00:02:18 2015 +0100

    fix app.config up-to-date status

commit bc419357eccfd52c6e46103409521052f5321071
Author: enricosada <[email protected]>
Date:   Wed May 6 17:17:25 2015 +0200

    fix test build up-to-date should fail if the .exe.config doesn't exists

commit 8219016c1f3009218a26545c1c96b6dddc26d515
Author: enricosada <[email protected]>
Date:   Wed May 6 16:47:31 2015 +0200

    add assert AssertBuildSuccessful to check if a build is successful

Author: enricosada

vsintegration/src/unittests/TestLib.Utils.fs

@@ -47,6 +47,9 @@ module Asserts =
         | Some(msg) -> Assert.Fail(msg)
         | None -> ()
 
+    let AssertBuildSuccessful (result: Microsoft.VisualStudio.FSharp.ProjectSystem.BuildResult) =
+        Assert.IsTrue(result.IsSuccessful, "Expected build to succeed")
+
 module UIStuff =
     let SetupSynchronizationContext() =
         Microsoft.VisualStudio.FSharp.LanguageService.UIThread.InitUnitTestingMode()

vsintegration/src/unittests/Tests.ProjectSystem.UpToDate.fs

@@ -59,7 +59,7 @@ type UpToDate() =
             File.AppendAllText(embedPath, "some embedded resource")
 
             Assert.IsFalse(config.IsUpToDate(logger, true))
-            project.Build(configNameDebug, output, "Build") |> ignore
+            project.Build(configNameDebug, output, "Build") |> AssertBuildSuccessful
             Assert.IsTrue(config.IsUpToDate(logger, true))
 
             // None items should not affect up-to-date (unless captured by well-known items, e.g. App.config)
@@ -111,7 +111,7 @@ type UpToDate() =
 
             project.SetConfiguration(config.ConfigCanonicalName);
             Assert.IsFalse(config.IsUpToDate(logger, true))
-            project.Build(configNameDebug, output, "Build") |> ignore
+            project.Build(configNameDebug, output, "Build") |> AssertBuildSuccessful
             Assert.IsTrue(config.IsUpToDate(logger, true))
 
             for path in [verPath; keyPath] do
@@ -146,7 +146,7 @@ type UpToDate() =
             File.AppendAllText(absFilePath, "printfn \"hello\"")
 
             Assert.IsFalse(config.IsUpToDate(logger, true))
-            project.Build(configNameDebug, output, "Build") |> ignore
+            project.Build(configNameDebug, output, "Build") |> AssertBuildSuccessful
             Assert.IsTrue(config.IsUpToDate(logger, true))
 
             // touch proj file
@@ -177,7 +177,7 @@ type UpToDate() =
             let config1 = project1.ConfigProvider.GetProjectConfiguration(configNameDebug)
 
             Assert.IsFalse(config1.IsUpToDate(logger, true))
-            project1.Build(configNameDebug, output, "Build") |> ignore
+            project1.Build(configNameDebug, output, "Build") |> AssertBuildSuccessful
             Assert.IsTrue(config1.IsUpToDate(logger, true))
 
             let output1 = Path.Combine(project1.ProjectFolder, "bin\\debug", project1.OutputFileName)
@@ -196,7 +196,7 @@ type UpToDate() =
                 let startTime = DateTime.Now
 
                 Assert.IsFalse(config2.IsUpToDate(logger, true))
-                project2.Build(configNameDebug, output, "Build") |> ignore
+                project2.Build(configNameDebug, output, "Build") |> AssertBuildSuccessful
                 Assert.IsTrue(config2.IsUpToDate(logger, true))
 
                 // reference is updated
@@ -214,6 +214,9 @@ type UpToDate() =
     [<Test>]
     member public this.OutputFiles () =
         this.MakeProjectAndDo(["file1.fs"], [], @"
+               <ItemGroup>
+                   <None Include=""App.config"" />
+               </ItemGroup>
                <PropertyGroup>
                    <DocumentationFile>bin\Debug\Test.XML</DocumentationFile>
                    <DebugSymbols>true</DebugSymbols>
@@ -224,22 +227,25 @@ type UpToDate() =
             let output = VsMocks.vsOutputWindowPane(ref [])
             let logger = OutputWindowLogger.CreateUpToDateCheckLogger(output)
             let sourcePath = Path.Combine(project.ProjectFolder, "file1.fs")
+            let appConfigPath = Path.Combine(project.ProjectFolder, "App.config")
 
             let exeObjPath = Path.Combine(project.ProjectFolder, "obj\\x86\\debug", project.OutputFileName)
             let exeBinpath = Path.Combine(project.ProjectFolder, "bin\\debug\\", project.OutputFileName)
             let pdbObjPath = Regex.Replace(exeObjPath, "exe$", "pdb")
             let pdbBinPath = Regex.Replace(exeBinpath, "exe$", "pdb")
             let xmlDocPath = Regex.Replace(exeBinpath, "exe$", "xml")
+            let exeConfigPath = Regex.Replace(exeBinpath, "exe$", "exe.config")
 
             File.AppendAllText(sourcePath, "printfn \"hello\"")
+            File.AppendAllText(appConfigPath, """<?xml version="1.0" encoding="utf-8" ?><configuration></configuration>""")
 
             Assert.IsFalse(config.IsUpToDate(logger, true))
-            project.Build(configNameDebug, output, "Build") |> ignore
+            project.Build(configNameDebug, output, "Build") |> AssertBuildSuccessful
             Assert.IsTrue(config.IsUpToDate(logger, true))
 
             let startTime = DateTime.Now
 
-            for path in [exeObjPath; exeBinpath; pdbObjPath; pdbBinPath; xmlDocPath] do
+            for path in [exeObjPath; exeBinpath; pdbObjPath; pdbBinPath; xmlDocPath; exeConfigPath] do
                 printfn "Testing output %s" path
 
                 // touch file
@@ -283,25 +289,25 @@ type UpToDate() =
             Assert.IsFalse(debugConfigAnyCPU.IsUpToDate(logger, true))
             Assert.IsFalse(releaseConfigAnyCPU.IsUpToDate(logger, true))
 
-            project.Build(configNameDebugx86, output, "Build") |> ignore
+            project.Build(configNameDebugx86, output, "Build") |> AssertBuildSuccessful
             Assert.IsTrue(debugConfigx86.IsUpToDate(logger, true))
             Assert.IsFalse(releaseConfigx86.IsUpToDate(logger, true))
             Assert.IsFalse(debugConfigAnyCPU.IsUpToDate(logger, true))
             Assert.IsFalse(releaseConfigAnyCPU.IsUpToDate(logger, true))
 
-            project.Build(configNameReleasex86, output, "Build") |> ignore
+            project.Build(configNameReleasex86, output, "Build") |> AssertBuildSuccessful
             Assert.IsTrue(debugConfigx86.IsUpToDate(logger, true))
             Assert.IsTrue(releaseConfigx86.IsUpToDate(logger, true))
             Assert.IsFalse(debugConfigAnyCPU.IsUpToDate(logger, true))
             Assert.IsFalse(releaseConfigAnyCPU.IsUpToDate(logger, true))
 
-            project.Build(configNameDebugAnyCPU, output, "Build") |> ignore
+            project.Build(configNameDebugAnyCPU, output, "Build") |> AssertBuildSuccessful
             Assert.IsTrue(debugConfigx86.IsUpToDate(logger, true))
             Assert.IsTrue(releaseConfigx86.IsUpToDate(logger, true))
             Assert.IsTrue(debugConfigAnyCPU.IsUpToDate(logger, true))
             Assert.IsFalse(releaseConfigAnyCPU.IsUpToDate(logger, true))
 
-            project.Build(configNameReleaseAnyCPU, output, "Build") |> ignore
+            project.Build(configNameReleaseAnyCPU, output, "Build") |> AssertBuildSuccessful
             Assert.IsTrue(debugConfigx86.IsUpToDate(logger, true))
             Assert.IsTrue(releaseConfigx86.IsUpToDate(logger, true))
             Assert.IsTrue(debugConfigAnyCPU.IsUpToDate(logger, true))
@@ -320,3 +326,55 @@ type UpToDate() =
 
             Assert.IsFalse(config.IsFastUpToDateCheckEnabled())
             ))
+
+[<TestFixture>]
+type ``UpToDate PreserveNewest`` () = 
+
+    [<Test>]
+    member public this.IsUpToDatePreserveNewest () =
+
+        let test (input, inputTimestamp) (output, outputTimestamp) =
+            let logs = ref []
+            let outputPanel = VsMocks.vsOutputWindowPane(logs)
+            let logger = OutputWindowLogger.CreateUpToDateCheckLogger(outputPanel)
+        
+            let tryTimestamp (path: string) (_l: OutputWindowLogger) =
+                let toN = function Some d -> Nullable<_>(d) | None -> Nullable<_>()
+                match path with
+                | x when x = input -> toN inputTimestamp
+                | x when x = output -> toN outputTimestamp
+                | _ -> failwithf "unexpected %s" path
+
+            let u = ProjectConfig.IsUpToDatePreserveNewest(logger, (Func<_,_,_>(tryTimestamp)), input, output)
+            u, !logs
+            
+        let now = System.DateTime.Now
+        let before = now.AddHours(-1.0)
+
+        let ``no input -> not up-to-date and log`` =
+            let u, logs = test ("readme.md", None) ("leggimi.md", None)
+            Assert.IsFalse(u)
+            logs
+            |> List.exists (fun s -> s.Contains("readme.md") && s.Contains("can't find expected input"))
+            |> Assert.IsTrue
+
+        let ``no output -> not up-to-date and log`` =
+            let u, logs = test ("from.txt", Some now) ("to.txt", None)
+            Assert.IsFalse(u)
+            logs
+            |> List.exists (fun s -> s.Contains("to.txt") && s.Contains("can't find expected output"))
+            |> Assert.IsTrue
+
+        let ``a newer version of output file is ok`` =
+            let u, logs = test ("before.doc", Some before) ("after.doc", Some now)
+            Assert.True(u)
+            logs |> AssertEqual []
+
+        let ``stale output file -> not up-to-date and log`` =
+            let u, logs = test ("logo.png", Some now) ("animatedlogo.gif", Some before)
+            Assert.IsFalse(u)
+            logs
+            |> List.exists (fun s -> s.Contains("animatedlogo.gif") && s.Contains("stale"))
+            |> Assert.IsTrue
+            
+        ()        

vsintegration/src/vs/FsPkgs/FSharp.Project/Common.Source.CSharp/Project/ProjectConfig.cs

@@ -1197,7 +1197,7 @@ public virtual int QueryDebugTargets(uint grfLaunch, uint cTargets, VsDebugTarge
         public virtual int OpenOutputGroup(string szCanonicalName, out IVsOutputGroup ppIVsOutputGroup)
         {
             ppIVsOutputGroup = null;
-            // Search through our list of groups to find the one they are looking forgroupName
+            // Search through our list of groups to find the one they are looking for groupName
             foreach (OutputGroup group in OutputGroups)
             {
                 string groupName;
@@ -1458,7 +1458,7 @@ private static bool IsPossibleOutputGroup(string groupName)
             return null;
         }
 
-        internal bool GetUTDCheckInputs(ref HashSet<string> inputs)
+        internal bool GetUTDCheckInputs(HashSet<string> inputs)
         {
             // the project file itself
             inputs.Add(Utilities.CanonicalizeFileNameNoThrow(this.project.BuildProject.FullPath));
@@ -1527,8 +1527,10 @@ internal bool GetUTDCheckInputs(ref HashSet<string> inputs)
             return true;
         }
 
-        internal bool GetUTDCheckOutputs(ref HashSet<string> outputs, HashSet<string> inputs)
+        internal void GetUTDCheckOutputs(HashSet<string> inputs, HashSet<string> outputs, out List<Tuple<string, string>> preserveNewestOutputs)
         {
+            preserveNewestOutputs = new List<Tuple<string, string>>();
+
             // Output groups give us the paths to the following outputs
             //   result EXE or DLL in "obj" dir
             //   PDB file in "obj" dir (if project is configured to create this)
@@ -1546,15 +1548,29 @@ internal bool GetUTDCheckOutputs(ref HashSet<string> outputs, HashSet<string> in
             var outputAssembly = this.project.GetOutputAssembly(this.ConfigCanonicalName);
             outputs.Add(Utilities.CanonicalizeFileNameNoThrow(outputAssembly));
 
+            bool isExe = outputAssembly.EndsWith(".exe", StringComparison.OrdinalIgnoreCase);
+
             // final PDB path
             if (this.DebugSymbols &&
-                (outputAssembly.EndsWith(".exe", StringComparison.OrdinalIgnoreCase) || outputAssembly.EndsWith(".dll", StringComparison.OrdinalIgnoreCase)))
+                (isExe || outputAssembly.EndsWith(".dll", StringComparison.OrdinalIgnoreCase)))
             {
                 var pdbPath = outputAssembly.Remove(outputAssembly.Length - 4) + ".pdb";
                 outputs.Add(Utilities.CanonicalizeFileNameNoThrow(pdbPath));
             }
 
-            return true;
+            if (isExe)
+            {
+                var appConfig = inputs.FirstOrDefault(x => String.Compare(Path.GetFileName(x), "app.config", StringComparison.OrdinalIgnoreCase) == 0);
+                if (appConfig != null)
+                {
+                    // the app.config is not removed from the inputs to maintain 
+                    // the same behavior of a C# project:
+                    // When a app.config is changed, after the build, the project 
+                    // is not up-to-date until a rebuild
+                    var exeConfig = Utilities.CanonicalizeFileNameNoThrow(outputAssembly + ".config");
+                    preserveNewestOutputs.Add(Tuple.Create(appConfig, exeConfig));
+                }
+            }
         }
 
         // there is a well-known property users can specify that signals for UTD check to be disabled
@@ -1584,12 +1600,12 @@ internal bool IsUpToDate(OutputWindowLogger logger, bool testing)
             }
 
             var inputs = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
-            if (!GetUTDCheckInputs(ref inputs))
+            if (!GetUTDCheckInputs(inputs))
                 return false;
 
             var outputs = new HashSet<string>(StringComparer.OrdinalIgnoreCase);
-            if (!GetUTDCheckOutputs(ref outputs, inputs))
-                return false;
+            List<Tuple<string, string>> preserveNewestOutputs;
+            GetUTDCheckOutputs(inputs, outputs, out preserveNewestOutputs);
 
             // determine the oldest output timestamp
             DateTime stalestOutputTime = DateTime.MaxValue.ToUniversalTime();
@@ -1625,13 +1641,48 @@ internal bool IsUpToDate(OutputWindowLogger logger, bool testing)
                     freshestInputTime = timeStamp.Value;
             }
 
+            // check 1-1 Preserve Newest mappings
+            foreach (var kv in preserveNewestOutputs)
+            {
+                if (!IsUpToDatePreserveNewest(logger, TryGetLastWriteTimeUtc, kv.Item1, kv.Item2)) 
+                    return false;
+            }
+
             logger.WriteLine("Freshest input: {0}", freshestInputTime.ToLocalTime());
             logger.WriteLine("Stalest output: {0}", stalestOutputTime.ToLocalTime());
             logger.WriteLine("Up to date: {0}", freshestInputTime <= stalestOutputTime);
 
-            // if all outputs are younger than all inuts, we are up to date
+            // if all outputs are younger than all inputs, we are up to date
             return freshestInputTime <= stalestOutputTime;
         }
+
+        public static bool IsUpToDatePreserveNewest(OutputWindowLogger logger, Func<string, OutputWindowLogger, DateTime?> tryGetLastWriteTimeUtc, string input, string output)
+        {
+            var inputTime = tryGetLastWriteTimeUtc(input, logger);
+            if (!inputTime.HasValue)
+            {
+                logger.WriteLine("Declaring project NOT up to date, can't find expected input {0}", input);
+                return false;
+            }
+
+            var outputTime = tryGetLastWriteTimeUtc(output, logger);
+            if (!outputTime.HasValue)
+            {
+                logger.WriteLine("Declaring project NOT up to date, can't find expected output {0}", output);
+                return false;
+            }
+
+            var inputTimeValue = inputTime.Value;
+            var outputTimeValue = outputTime.Value;
+
+            if (outputTimeValue < inputTimeValue)
+            {
+                logger.WriteLine("Declaring project NOT up to date, ouput {0} is stale", output);
+                return false;
+            }
+
+            return true;
+        }
     }
 
     internal class ClassLibraryCannotBeStartedDirectlyException : COMException