Support for sparse checkout of source dependencies.

Author: gfraiteur

src/PostSharp.Engineering.BuildTools/ContinuousIntegration/Model/AdditionalCiBuildConfiguration.cs

@@ -13,8 +13,10 @@ public abstract class AdditionalCiBuildConfiguration
 
     public string Branch { get; }
 
-    public bool RequiresSourceDependencies { get; init; }
-    
+    public SourceDependenciesRequirements SourceDependenciesRequirements { get; init; }
+
+    public bool OnlyCheckoutEngineering { get; init; }
+
     protected AdditionalCiBuildConfiguration( string id, string name, string branch )
     {
         this.Id = id;
@@ -23,4 +25,11 @@ protected AdditionalCiBuildConfiguration( string id, string name, string branch
     }
 
     internal abstract TeamCityBuildConfiguration TeamCityBuildConfiguration( ProductProperties productProperties );
+}
+
+public enum SourceDependenciesRequirements
+{
+    None,
+    Full,
+    EngOnly
 }

src/PostSharp.Engineering.BuildTools/ContinuousIntegration/Model/PowershellAdditionalCiBuildConfiguration.cs

@@ -4,6 +4,7 @@
 using PostSharp.Engineering.BuildTools.ContinuousIntegration.TeamCity;
 using PostSharp.Engineering.BuildTools.ContinuousIntegration.TeamCity.BuildSteps;
 using PostSharp.Engineering.BuildTools.ContinuousIntegration.TeamCity.Generation;
+using System;
 
 namespace PostSharp.Engineering.BuildTools.ContinuousIntegration.Model;
 
@@ -41,7 +42,13 @@ internal override TeamCityBuildConfiguration TeamCityBuildConfiguration( Product
                     product.DockerSpec )
             ],
             IsSshAgentRequired = productProperties.IsRepoRemoteSsh,
-            SourceDependencies = this.RequiresSourceDependencies ? productProperties.SourceDependencies : []
+            SourceDependencies = this.SourceDependenciesRequirements switch
+            {
+                SourceDependenciesRequirements.None => [],
+                SourceDependenciesRequirements.EngOnly => productProperties.EngOnlySourceDependencies,
+                SourceDependenciesRequirements.Full => productProperties.SourceDependencies,
+                _ => throw new ArgumentOutOfRangeException()
+            }
         };
 
         return downstreamMergeConfiguration;

src/PostSharp.Engineering.BuildTools/ContinuousIntegration/TeamCity/Generation/ProductProperties.cs

@@ -3,6 +3,7 @@
 using PostSharp.Engineering.BuildTools.Build.Model;
 using PostSharp.Engineering.BuildTools.Tools.TeamCity;
 using System;
+using System.Collections.Generic;
 using System.Linq;
 
 namespace PostSharp.Engineering.BuildTools.ContinuousIntegration.TeamCity.Generation;
@@ -31,6 +32,8 @@ internal class ProductProperties
 
     public TeamCitySourceDependency[] SourceDependencies { get; }
 
+    public TeamCitySourceDependency[] EngOnlySourceDependencies { get; set; }
+
     public ProductProperties( Product product )
     {
         this.Product = product;
@@ -47,5 +50,16 @@ public ProductProperties( Product product )
                                                                          true,
                                                                          $"+:. => {product.SourceDependenciesDirectory}/{d.Name}" ) )
             .ToArray();
+
+        this.EngOnlySourceDependencies = product.SourceDependencies.Select( d => new TeamCitySourceDependency(
+                                                                                d.CiConfiguration.ProjectId.ToString(),
+                                                                                TeamCityHelper.GetVcsId( d ),
+                                                                                true,
+                                                                                $"""
+                                                                                 +:{product.DependencyDefinition.EngineeringDirectory} => {product.SourceDependenciesDirectory}/{d.Name}/{product.DependencyDefinition.EngineeringDirectory}
+                                                                                 +:DockerBuild.ps1 => {product.SourceDependenciesDirectory}/{d.Name}/DockerBuild.ps1
+                                                                                 +:Build.ps1 => {product.SourceDependenciesDirectory}/{d.Name}/Build.ps1
+                                                                                 """ ) )
+            .ToArray();
     }
 }

src/PostSharp.Engineering.BuildTools/ContinuousIntegration/TeamCity/TeamCityBuildConfiguration.cs

@@ -153,7 +153,11 @@ void AddBuildStep( BuildStep newStep )
                 {
                     var objectName = sourceDependency.IsAbsoluteId ? @$"AbsoluteId(""{sourceDependency.VcsId}"")" : sourceDependency.VcsId;
 
-                    writer.WriteLine( $@"        root({objectName}, ""{sourceDependency.ArtifactRules}"")" );
+                    writer.WriteLine(
+                        $""""
+                                 root({objectName},
+                                   """{sourceDependency.CheckoutRules}""")
+                         """" );
                 }
             }
 
@@ -194,7 +198,7 @@ void AddBuildStep( BuildStep newStep )
 
             var requiresSwabra = allBuildSteps.Count > 0;
             var requiresSshAgent = this.IsSshAgentRequired;
-            var requiresAnyFeatures = requiresSwabra || requiresSshAgent || this.RequiresCommitStatusPublisher ;
+            var requiresAnyFeatures = requiresSwabra || requiresSshAgent || this.RequiresCommitStatusPublisher;
 
             // Features.
             if ( requiresAnyFeatures )
@@ -227,22 +231,23 @@ void AddBuildStep( BuildStep newStep )
                                   }
                               }
                           """ );
-                    
+
                     // Integrate with PRs.
-                    writer.WriteLine($$"""
-                                       pullRequests {
-                                              vcsRootExtId = "{{this.VcsId}}"
-                                               provider = github {
-                                                   authType = token {
-                                                       token = "%env.{{EnvironmentVariableNames.GitHubToken}}%"
-                                                   }
-                                                  filterTargetBranch = "+:refs/heads/{{this.DefaultBranch}}"
-                                                  filterAuthorRole = PullRequests.GitHubRoleFilter.EVERYBODY
-                                              }
-                                          }
-                                       
-                                       
-                                       """);
+                    writer.WriteLine(
+                        $$"""
+                          pullRequests {
+                                 vcsRootExtId = "{{this.VcsId}}"
+                                  provider = github {
+                                      authType = token {
+                                          token = "%env.{{EnvironmentVariableNames.GitHubToken}}%"
+                                      }
+                                     filterTargetBranch = "+:refs/heads/{{this.DefaultBranch}}"
+                                     filterAuthorRole = PullRequests.GitHubRoleFilter.EVERYBODY
+                                 }
+                             }
+
+
+                          """ );
                 }
 
                 if ( requiresSshAgent )

src/PostSharp.Engineering.BuildTools/ContinuousIntegration/TeamCity/TeamCitySourceDependency.cs

@@ -2,4 +2,4 @@
 
 namespace PostSharp.Engineering.BuildTools.ContinuousIntegration.TeamCity;
 
-internal record TeamCitySourceDependency( string ObjectId, string VcsId, bool IsAbsoluteId, string ArtifactRules );
+internal record TeamCitySourceDependency( string ObjectId, string VcsId, bool IsAbsoluteId, string CheckoutRules );