Ensuring intermediate output path exists

Fixes #2815

Author: Jeff Peirson

src/GitVersion.MsBuild.Tests/Tasks/GenerateGitVersionInformationTest.cs

@@ -104,7 +104,101 @@ public void GenerateGitVersionInformationTaskShouldCreateFileWhenRunWithMsBuildI
         fileContent.ShouldContain($@"{nameof(VersionVariables.FullSemVer)} = ""1.0.1+1""");
     }
 
-    private static void AddGenerateGitVersionInformationTask(ProjectCreator project, string targetToRun, string taskName, string outputProperty)
+    [Test]
+    public void GenerateGitVersionInformationTaskShouldCreateFileWhenIntermediateOutputPathDoesNotExist()
+    {
+        var task = new GenerateGitVersionInformation { IntermediateOutputPath = Guid.NewGuid().ToString("N") };
+
+        using var result = ExecuteMsBuildTask(task);
+
+        result.Success.ShouldBe(true);
+        result.Errors.ShouldBe(0);
+        result.Task.GitVersionInformationFilePath.ShouldNotBeNull();
+
+        var fileContent = File.ReadAllText(result.Task.GitVersionInformationFilePath);
+        fileContent.ShouldContain($@"{nameof(VersionVariables.Major)} = ""1""");
+        fileContent.ShouldContain($@"{nameof(VersionVariables.Minor)} = ""2""");
+        fileContent.ShouldContain($@"{nameof(VersionVariables.Patch)} = ""4""");
+        fileContent.ShouldContain($@"{nameof(VersionVariables.MajorMinorPatch)} = ""1.2.4""");
+        fileContent.ShouldContain($@"{nameof(VersionVariables.FullSemVer)} = ""1.2.4+1""");
+    }
+
+    [Test]
+    public void GenerateGitVersionInformationTaskShouldCreateFileInBuildServerWhenIntermediateOutputPathDoesNotExist()
+    {
+        var task = new GenerateGitVersionInformation { IntermediateOutputPath = Guid.NewGuid().ToString("N") };
+
+        using var result = ExecuteMsBuildTaskInAzurePipeline(task);
+
+        result.Success.ShouldBe(true);
+        result.Errors.ShouldBe(0);
+        result.Task.GitVersionInformationFilePath.ShouldNotBeNull();
+
+        var fileContent = File.ReadAllText(result.Task.GitVersionInformationFilePath);
+        fileContent.ShouldContain($@"{nameof(VersionVariables.Major)} = ""1""");
+        fileContent.ShouldContain($@"{nameof(VersionVariables.Minor)} = ""0""");
+        fileContent.ShouldContain($@"{nameof(VersionVariables.Patch)} = ""1""");
+        fileContent.ShouldContain($@"{nameof(VersionVariables.MajorMinorPatch)} = ""1.0.1""");
+        fileContent.ShouldContain($@"{nameof(VersionVariables.FullSemVer)} = ""1.0.1+1""");
+    }
+
+    [Test]
+    [Category(NoNet48)]
+    [Category(NoMono)]
+    public void GenerateGitVersionInformationTaskShouldCreateFileWhenRunWithMsBuildAndIntermediateOutputPathDoesNotExist()
+    {
+        const string taskName = nameof(GenerateGitVersionInformation);
+        const string outputProperty = nameof(GenerateGitVersionInformation.GitVersionInformationFilePath);
+        var randDir = Guid.NewGuid().ToString("N");
+
+        using var result = ExecuteMsBuildExe(project => AddGenerateGitVersionInformationTask(project, taskName, taskName, outputProperty, Path.Combine("$(MSBuildProjectDirectory)", randDir)));
+
+        result.ProjectPath.ShouldNotBeNullOrWhiteSpace();
+        result.MsBuild.Count.ShouldBeGreaterThan(0);
+        result.MsBuild.OverallSuccess.ShouldBe(true);
+        result.MsBuild.ShouldAllBe(x => x.Succeeded);
+        result.Output.ShouldNotBeNullOrWhiteSpace();
+
+        var generatedFilePath = PathHelper.Combine(Path.GetDirectoryName(result.ProjectPath), randDir, "GitVersionInformation.g.cs");
+        result.Output.ShouldContain($"{outputProperty}: {generatedFilePath}");
+
+        var fileContent = File.ReadAllText(generatedFilePath);
+        fileContent.ShouldContain($@"{nameof(VersionVariables.Major)} = ""1""");
+        fileContent.ShouldContain($@"{nameof(VersionVariables.Minor)} = ""2""");
+        fileContent.ShouldContain($@"{nameof(VersionVariables.Patch)} = ""4""");
+        fileContent.ShouldContain($@"{nameof(VersionVariables.MajorMinorPatch)} = ""1.2.4""");
+        fileContent.ShouldContain($@"{nameof(VersionVariables.FullSemVer)} = ""1.2.4+1""");
+    }
+
+    [Test]
+    [Category(NoNet48)]
+    [Category(NoMono)]
+    public void GenerateGitVersionInformationTaskShouldCreateFileWhenRunWithMsBuildAndIntermediateOutputPathDoesNotExistInBuildServer()
+    {
+        const string taskName = nameof(GenerateGitVersionInformation);
+        const string outputProperty = nameof(GenerateGitVersionInformation.GitVersionInformationFilePath);
+        var randDir = Guid.NewGuid().ToString("N");
+
+        using var result = ExecuteMsBuildExeInAzurePipeline(project => AddGenerateGitVersionInformationTask(project, taskName, taskName, outputProperty, Path.Combine("$(MSBuildProjectDirectory)", randDir)));
+
+        result.ProjectPath.ShouldNotBeNullOrWhiteSpace();
+        result.MsBuild.Count.ShouldBeGreaterThan(0);
+        result.MsBuild.OverallSuccess.ShouldBe(true);
+        result.MsBuild.ShouldAllBe(x => x.Succeeded);
+        result.Output.ShouldNotBeNullOrWhiteSpace();
+
+        var generatedFilePath = PathHelper.Combine(Path.GetDirectoryName(result.ProjectPath), randDir, "GitVersionInformation.g.cs");
+        result.Output.ShouldContain($"{outputProperty}: {generatedFilePath}");
+
+        var fileContent = File.ReadAllText(generatedFilePath);
+        fileContent.ShouldContain($@"{nameof(VersionVariables.Major)} = ""1""");
+        fileContent.ShouldContain($@"{nameof(VersionVariables.Minor)} = ""0""");
+        fileContent.ShouldContain($@"{nameof(VersionVariables.Patch)} = ""1""");
+        fileContent.ShouldContain($@"{nameof(VersionVariables.MajorMinorPatch)} = ""1.0.1""");
+        fileContent.ShouldContain($@"{nameof(VersionVariables.FullSemVer)} = ""1.0.1+1""");
+    }
+
+    private static void AddGenerateGitVersionInformationTask(ProjectCreator project, string targetToRun, string taskName, string outputProperty, string intermediateOutputPath = "$(MSBuildProjectDirectory)")
     {
         var assemblyFileLocation = typeof(GitVersionTaskBase).Assembly.Location;
         project.UsingTaskAssemblyFile(taskName, assemblyFileLocation)
@@ -115,7 +209,7 @@ private static void AddGenerateGitVersionInformationTask(ProjectCreator project,
                 { "SolutionDirectory", "$(MSBuildProjectDirectory)" },
                 { "VersionFile", "$(MSBuildProjectDirectory)/gitversion.json" },
                 { "ProjectFile", "$(MSBuildProjectFullPath)" },
-                { "IntermediateOutputPath", "$(MSBuildProjectDirectory)" },
+                { "IntermediateOutputPath", intermediateOutputPath },
                 { "Language", "$(Language)" }
             })
             .TaskOutputProperty(outputProperty, outputProperty)

src/GitVersion.MsBuild/GitVersionTaskExecutor.cs

@@ -50,6 +50,13 @@ public void UpdateAssemblyInfo(UpdateAssemblyInfo task)
     public void GenerateGitVersionInformation(GenerateGitVersionInformation task)
     {
         var versionVariables = VersionVariables.FromFile(task.VersionFile, fileSystem);
+
+        if (!string.IsNullOrEmpty(task.IntermediateOutputPath))
+        {
+            // Ensure provided output path exists first. Fixes issue #2815.
+            this.fileSystem.CreateDirectory(task.IntermediateOutputPath);
+        }
+
         var fileWriteInfo = task.IntermediateOutputPath.GetFileWriteInfo(task.Language, task.ProjectFile, "GitVersionInformation");
         task.GitVersionInformationFilePath = PathHelper.Combine(fileWriteInfo.WorkingDirectory, fileWriteInfo.FileName);