Merge pull request #168 from benmerms/user/benmer/NewGetBuildVersionParameterForGitProjectRelativePath

Add optional GitRelativeProjectPath parameter to GetBuildVersion for …

Author: AArnott

src/NerdBank.GitVersioning.Tests/VersionOracleTests.cs

@@ -242,4 +242,41 @@ public void CanSetSemVer2ForNuGetPackageVersionNonPublicRelease()
         oracle.PublicRelease = false;
         Assert.Equal($"7.8.9-foo.25.g{this.CommitIdShort}", oracle.NuGetPackageVersion);
     }
+
+    [Fact]
+    public void CanUseGitProjectRelativePathWithGitRepoRoot()
+    {
+        VersionOptions rootVersion = new VersionOptions
+        {
+            Version = SemanticVersion.Parse("1.1"),
+        };
+
+        VersionOptions projectVersion = new VersionOptions
+        {
+            Version = SemanticVersion.Parse("2.2"),
+        };
+
+        string childProjectRelativeDir = "ChildProject1";
+        string childProjectAbsoluteDir = Path.Combine(this.RepoPath, childProjectRelativeDir);
+        this.WriteVersionFile(rootVersion);
+        this.WriteVersionFile(projectVersion, childProjectRelativeDir);
+
+        this.InitializeSourceControl();
+
+        // Check Root Version. Root version will be used
+        var oracle = VersionOracle.Create(this.RepoPath, this.RepoPath, null, null);
+        Assert.Equal("1.1", oracle.MajorMinorVersion.ToString());
+
+        // Check ChildProject with projectRelativeDir, with version file. Child project version will be used.
+        oracle = VersionOracle.Create(childProjectAbsoluteDir, this.RepoPath, null, null, childProjectRelativeDir);
+        Assert.Equal("2.2", oracle.MajorMinorVersion.ToString());
+
+        // Check ChildProject withOUT projectRelativeDir, with Version file. Child project version will be used.
+        oracle = VersionOracle.Create(childProjectAbsoluteDir, this.RepoPath);
+        Assert.Equal("2.2", oracle.MajorMinorVersion.ToString());
+
+        // Check ChildProject withOUT Version file. Root version will be used.
+        oracle = VersionOracle.Create(Path.Combine(this.RepoPath, "otherChildProject"), this.RepoPath, null, null, "otherChildProject");
+        Assert.Equal("1.1", oracle.MajorMinorVersion.ToString());
+    }
 }

src/NerdBank.GitVersioning/VersionOracle.cs

@@ -27,12 +27,7 @@ public class VersionOracle
         /// <summary>
         /// Initializes a new instance of the <see cref="VersionOracle"/> class.
         /// </summary>
-        /// <param name="projectDirectory"></param>
-        /// <param name="gitRepoDirectory"></param>
-        /// <param name="cloudBuild"></param>
-        /// <param name="overrideBuildNumberOffset"></param>
-        /// <returns></returns>
-        public static VersionOracle Create(string projectDirectory, string gitRepoDirectory = null, ICloudBuild cloudBuild = null, int? overrideBuildNumberOffset = null)
+        public static VersionOracle Create(string projectDirectory, string gitRepoDirectory = null, ICloudBuild cloudBuild = null, int? overrideBuildNumberOffset = null, string projectPathRelativeToGitRepoRoot = null)
         {
             Requires.NotNull(projectDirectory, nameof(projectDirectory));
             if (string.IsNullOrEmpty(gitRepoDirectory))
@@ -42,18 +37,20 @@ public static VersionOracle Create(string projectDirectory, string gitRepoDirect
 
             using (var git = OpenGitRepo(gitRepoDirectory))
             {
-                return new VersionOracle(projectDirectory, git, cloudBuild, overrideBuildNumberOffset);
+                return new VersionOracle(projectDirectory, git, cloudBuild, overrideBuildNumberOffset, projectPathRelativeToGitRepoRoot);
             }
         }
 
         /// <summary>
         /// Initializes a new instance of the <see cref="VersionOracle"/> class.
         /// </summary>
-        public VersionOracle(string projectDirectory, LibGit2Sharp.Repository repo, ICloudBuild cloudBuild, int? overrideBuildNumberOffset = null)
+        public VersionOracle(string projectDirectory, LibGit2Sharp.Repository repo, ICloudBuild cloudBuild, int? overrideBuildNumberOffset = null, string projectPathRelativeToGitRepoRoot = null)
         {
             var repoRoot = repo?.Info?.WorkingDirectory?.TrimEnd(Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar);
             var relativeRepoProjectDirectory = !string.IsNullOrWhiteSpace(repoRoot)
-                ? projectDirectory.Substring(repoRoot.Length).TrimStart(Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar)
+                ? (!string.IsNullOrEmpty(projectPathRelativeToGitRepoRoot)
+                    ? projectPathRelativeToGitRepoRoot
+                    : projectDirectory.Substring(repoRoot.Length).TrimStart(Path.DirectorySeparatorChar, Path.AltDirectorySeparatorChar))
                 : null;
 
             var commit = repo?.Head.Commits.FirstOrDefault();

src/Nerdbank.GitVersioning.NuGet/build/Nerdbank.GitVersioning.targets

@@ -65,6 +65,7 @@
       BuildMetadata="@(BuildMetadata)"
       DefaultPublicRelease="$(PublicRelease)"
       GitRepoRoot="$(GitRepoRoot)"
+      ProjectPathRelativeToGitRepoRoot="$(ProjectPathRelativeToGitRepoRoot)"
       OverrideBuildNumberOffset="$(OverrideBuildNumberOffset)"
       TargetsPath="$(MSBuildThisFileDirectory)">
 

src/Nerdbank.GitVersioning.Tasks/GetBuildVersion.cs

@@ -8,6 +8,7 @@
     using Microsoft.Build.Framework;
     using Microsoft.Build.Utilities;
     using MSBuildExtensionTask;
+    using Validation;
 
     public class GetBuildVersion : ContextAwareTask
     {
@@ -40,6 +41,20 @@ public GetBuildVersion()
         /// </summary>
         public string GitRepoRoot { get; set; }
 
+        /// <summary>
+        /// Gets or sets the relative path from the <see cref="GitRepoRoot"/> to the directory under it that contains the project being built.
+        /// </summary>
+        /// <value>
+        /// If not supplied, the directories from <see cref="GitRepoRoot"/> to <see cref="Environment.CurrentDirectory"/>
+        /// will be searched for version.json.
+        /// If supplied, the value <em>must</em> fall beneath the <see cref="GitRepoRoot"/> (i.e. this value should not contain "..\").
+        /// </value>
+        /// <remarks>
+        /// This property is useful when the project that MSBuild is building is not found under <see cref="GitRepoRoot"/> such that the
+        /// relative path can be calculated automatically.
+        /// </remarks>
+        public string ProjectPathRelativeToGitRepoRoot { get; set; }
+
         /// <summary>
         /// Gets or sets the optional override build number offset.
         /// </summary>
@@ -160,9 +175,19 @@ protected override bool ExecuteInner()
         {
             try
             {
+                if (!string.IsNullOrEmpty(this.ProjectPathRelativeToGitRepoRoot))
+                {
+                    Requires.Argument(Path.IsPathRooted(this.ProjectPathRelativeToGitRepoRoot), nameof(this.ProjectPathRelativeToGitRepoRoot), "Path must be relative.");
+                    Requires.Argument(!(
+                        this.ProjectPathRelativeToGitRepoRoot.Contains(".." + Path.DirectorySeparatorChar) || 
+                        this.ProjectPathRelativeToGitRepoRoot.Contains(".." + Path.AltDirectorySeparatorChar)),
+                        nameof(this.ProjectPathRelativeToGitRepoRoot),
+                        "Path must not use ..\\");
+                }
+
                 var cloudBuild = CloudBuild.Active;
                 var overrideBuildNumberOffset = (this.OverrideBuildNumberOffset == int.MaxValue) ? (int?)null : this.OverrideBuildNumberOffset;
-                var oracle = VersionOracle.Create(Directory.GetCurrentDirectory(), this.GitRepoRoot, cloudBuild, overrideBuildNumberOffset);
+                var oracle = VersionOracle.Create(Directory.GetCurrentDirectory(), this.GitRepoRoot, cloudBuild, overrideBuildNumberOffset, this.ProjectPathRelativeToGitRepoRoot);
                 if (!string.IsNullOrEmpty(this.DefaultPublicRelease))
                 {
                     oracle.PublicRelease = string.Equals(this.DefaultPublicRelease, "true", StringComparison.OrdinalIgnoreCase);