Change checkout directories and encapsulated artifact rules from string to object.

Author: gfraiteur

src/PostSharp.Engineering.BuildTools/Build/BuildConfigurationInfo.cs

@@ -2,6 +2,7 @@
 
 using PostSharp.Engineering.BuildTools.Build.Publishing;
 using PostSharp.Engineering.BuildTools.Build.Swapping;
+using PostSharp.Engineering.BuildTools.ContinuousIntegration.Model;
 using PostSharp.Engineering.BuildTools.ContinuousIntegration.Triggers;
 using System;
 
@@ -34,7 +35,7 @@ public record BuildConfigurationInfo(
     string? TeamCityDeploymentName = null,
     string? TeamCitySwapName = null,
     bool SwapAfterPublishing = false,
-    string[]? AdditionalArtifactRules = null,
+    ArtifactRule[]? AdditionalArtifactRules = null,
     bool ExportsToTeamCityBuild = true,
     bool ExportsToTeamCityDeploy = true,
     bool ExportsToTeamCityDeployWithoutDependencies = false,

src/PostSharp.Engineering.BuildTools/Build/Helpers/SourceDependenciesHelper.cs

@@ -17,7 +17,7 @@ internal static bool RestoreSourceDependencies( BuildContext context )
             return true;
         }
 
-        var sourceDependenciesDirectory = Path.Combine( context.RepoDirectory, "source-dependencies" );
+        var sourceDependenciesDirectory = Path.Combine( context.RepoDirectory, product.SourceDependenciesDirectory );
 
         if ( !Directory.Exists( sourceDependenciesDirectory ) )
         {

src/PostSharp.Engineering.BuildTools/Build/Model/Product.cs

@@ -5,6 +5,7 @@
 using PostSharp.Engineering.BuildTools.Build.Bumping;
 using PostSharp.Engineering.BuildTools.Build.Publishing;
 using PostSharp.Engineering.BuildTools.ContinuousIntegration.Model;
+using PostSharp.Engineering.BuildTools.ContinuousIntegration.TeamCity;
 using PostSharp.Engineering.BuildTools.ContinuousIntegration.Triggers;
 using PostSharp.Engineering.BuildTools.Dependencies.Model;
 using PostSharp.Engineering.BuildTools.Docker;
@@ -91,7 +92,7 @@ public string GetPrivateArtifactsRelativeDirectory( BuildConfiguration configura
 
         public string DumpDirectory { get; init; } = Path.Combine( "artifacts", "dumps" );
 
-        public string SourceDependenciesDirectory { get; init; } = Path.Combine( "source-dependencies" );
+        public string SourceDependenciesDirectory { get; init; } = "source-dependencies";
 
         public bool GenerateArcadeProperties { get; init; }
 
@@ -159,7 +160,7 @@ public TimeSpan BuildTimeout
                     ExportsToTeamCityDeploy: true,
                     RequiresUpstreamCheck: true ) );
 
-        public ImmutableArray<string> DefaultArtifactRules { get; } = ImmutableArray<string>.Empty;
+        public ArtifactRule[] DefaultArtifactRules { get; } = [];
 
         /// <summary>
         /// List of properties that must be exported into the *.version.props. These properties must be defined in *.props files specified as the dictionary keys.
@@ -283,7 +284,7 @@ public bool TryGetDependencyDefinition( string name, [NotNullWhen( true )] out D
         public ProductExtension[] Extensions { get; init; } = [];
 
         public bool BuildRequiresSourceDependencies { get; init; } = true;
-        
+
         internal string GetPrivateArtifactsAbsoluteDirectory( BuildContext context, BuildConfiguration configuration )
             => Path.Combine(
                 context.RepoDirectory,

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

@@ -0,0 +1,66 @@
+// Copyright (c) SharpCrafters s.r.o. See the LICENSE.md file in the root directory of this repository root for details.
+
+using PostSharp.Engineering.BuildTools.Build.Model;
+using System;
+using System.Collections.Generic;
+
+namespace PostSharp.Engineering.BuildTools.ContinuousIntegration.Model;
+
+public record ArtifactRule( string Source, string Target, bool Exclude = false, bool IsAbsolute = false, bool AllFiles = true ) : IComparable<ArtifactRule>
+{
+    internal string GetPublishRule( string checkoutDirectory )
+    {
+        var prefix = this.Exclude ? "-" : "+";
+        var suffix = this.AllFiles ? "/**/*" : "";
+
+        if ( this.IsAbsolute )
+        {
+            return $"{prefix}:{this.Source}{suffix} => {this.Target}";
+        }
+        else
+        {
+            return $"{prefix}:{checkoutDirectory}/{this.Source}{suffix} => {this.Target}";
+        }
+    }
+
+    internal string GetRestoreRule( string checkoutDirectory )
+    {
+        var sign = this.Exclude ? "-" : "+";
+
+        return $"{sign}:{this.Target}/**/* => {checkoutDirectory}/{this.Source}";
+    }
+
+    public int CompareTo( ArtifactRule? other )
+    {
+        if ( ReferenceEquals( this, other ) )
+        {
+            return 0;
+        }
+
+        if ( other is null )
+        {
+            return 1;
+        }
+
+        if ( this.Exclude != other.Exclude && this.Exclude )
+        {
+            return 1;
+        }
+
+        var sourceComparison = string.Compare( this.Source, other.Source, StringComparison.Ordinal );
+
+        if ( sourceComparison != 0 )
+        {
+            return sourceComparison;
+        }
+
+        var targetComparison = string.Compare( this.Target, other.Target, StringComparison.Ordinal );
+
+        if ( targetComparison != 0 )
+        {
+            return targetComparison;
+        }
+
+        return this.Exclude.CompareTo( other.Exclude );
+    }
+}

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

@@ -29,14 +29,15 @@ internal override TeamCityBuildConfiguration TeamCityBuildConfiguration( Product
             this.Name,
             this.Branch,
             productProperties.VcsId,
+            product.ProductName,
             product.ResolvedBuildAgentRequirements )
         {
             BuildSteps =
             [
                 new PowerShellBuildStep(
                     "Exec",
                     $"Execute {this.Script}",
-                    this.Script,
+                    $"{product.ProductName}/{this.Script}",
                     this.Arguments,
                     product.DockerSpec )
             ],

src/PostSharp.Engineering.BuildTools/ContinuousIntegration/TeamCity/BuildSteps/EngineeringBuildBuildStep.cs

@@ -8,9 +8,15 @@ namespace PostSharp.Engineering.BuildTools.ContinuousIntegration.TeamCity.BuildS
 
 internal class EngineeringBuildBuildStep : EngineeringCommandBuildStep
 {
-    public EngineeringBuildBuildStep( BuildConfiguration configuration, bool testOnBuild, DockerSpec? dockerSpec, TimeSpan? timeout ) : base(
+    public EngineeringBuildBuildStep(
+        BuildConfiguration configuration,
+        string checkoutDirectory,
+        bool testOnBuild,
+        DockerSpec? dockerSpec,
+        TimeSpan? timeout ) : base(
         "Build",
         "Build",
+        checkoutDirectory,
         testOnBuild ? "test" : "build",
         $"--configuration {configuration} --buildNumber %build.number% --buildType %system.teamcity.buildType.id%",
         true,

src/PostSharp.Engineering.BuildTools/ContinuousIntegration/TeamCity/BuildSteps/EngineeringCommandBuildStep.cs

@@ -18,14 +18,15 @@ internal class EngineeringCommandBuildStep : PowerShellBuildStep
     public EngineeringCommandBuildStep(
         string id,
         string name,
+        string checkoutDirectory,
         string command,
         string? arguments = null,
         bool areCustomArgumentsAllowed = false,
         DockerSpec? dockerSpec = null,
         TimeSpan? timeout = null ) : base(
         id,
         name,
-        "Build.ps1",
+        $"{checkoutDirectory}/Build.ps1",
         GetScriptArguments( id, command, arguments, areCustomArgumentsAllowed, timeout ),
         dockerSpec )
     {

src/PostSharp.Engineering.BuildTools/ContinuousIntegration/TeamCity/BuildSteps/EngineeringPublishBuildStep.cs

@@ -8,9 +8,10 @@ namespace PostSharp.Engineering.BuildTools.ContinuousIntegration.TeamCity.BuildS
 
 internal class EngineeringPublishBuildStep : EngineeringCommandBuildStep
 {
-    public EngineeringPublishBuildStep( BuildConfiguration configuration, DockerSpec? dockerSpec, TimeSpan? timeSpan ) : base(
+    public EngineeringPublishBuildStep( BuildConfiguration configuration, string checkoutDirectory, DockerSpec? dockerSpec, TimeSpan? timeSpan ) : base(
         "Publish",
         "Publish",
+        checkoutDirectory,
         "publish",
         $"--configuration {configuration}",
         true,

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

@@ -3,6 +3,7 @@
 using PostSharp.Engineering.BuildTools.Build;
 using PostSharp.Engineering.BuildTools.Build.Files;
 using PostSharp.Engineering.BuildTools.Build.Model;
+using PostSharp.Engineering.BuildTools.ContinuousIntegration.Model;
 using System;
 using System.IO;
 using System.Linq;
@@ -37,7 +38,11 @@ public ConfigurationProperties( Product product, BuildConfiguration configuratio
             .Select( d => new TeamCitySnapshotDependency(
                          d.Definition.CiConfiguration.BuildTypes[d.Configuration],
                          true,
-                         $"+:{d.Definition.GetPrivateArtifactsDirectory( d.Configuration ).Replace( Path.DirectorySeparatorChar, '/' )}/**/*=>dependencies/{d.Definition.Name}" ) )
+                         [
+                             new ArtifactRule(
+                                 $"dependencies/{d.Definition.Name}",
+                                 d.Definition.GetPrivateArtifactsDirectory( d.Configuration ).Replace( Path.DirectorySeparatorChar, '/' ) )
+                         ] ) )
             .ToList();
 
         var sourceSnapshotDependencies = product.SourceDependencies.Where( d => d.GenerateSnapshotDependency )

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

@@ -45,7 +45,7 @@ public ProductProperties( Product product )
                                                                          d.CiConfiguration.ProjectId.ToString(),
                                                                          TeamCityHelper.GetVcsId( d ),
                                                                          true,
-                                                                         $"+:. => {product.SourceDependenciesDirectory}/{d.Name}" ) )
+                                                                         $"+:. => {d.Name}" ) )
             .ToArray();
     }
 }