More refactoring of TeamCity settings configuration, with possibility to add custom scripts.

Author: gfraiteur

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

@@ -2,7 +2,7 @@
 
 using PostSharp.Engineering.BuildTools.Build.Publishing;
 using PostSharp.Engineering.BuildTools.Build.Swapping;
-using PostSharp.Engineering.BuildTools.Build.Triggers;
+using PostSharp.Engineering.BuildTools.ContinuousIntegration.Triggers;
 using System;
 
 namespace PostSharp.Engineering.BuildTools.Build;

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

@@ -4,8 +4,8 @@
 using PostSharp.Engineering.BuildTools.BillOfMaterials;
 using PostSharp.Engineering.BuildTools.Build.Bumping;
 using PostSharp.Engineering.BuildTools.Build.Publishing;
-using PostSharp.Engineering.BuildTools.Build.Triggers;
 using PostSharp.Engineering.BuildTools.ContinuousIntegration.Model;
+using PostSharp.Engineering.BuildTools.ContinuousIntegration.Triggers;
 using PostSharp.Engineering.BuildTools.Dependencies.Model;
 using PostSharp.Engineering.BuildTools.Docker;
 using PostSharp.Engineering.BuildTools.Utilities;
@@ -251,7 +251,7 @@ public DockerSpec? DockerSpec
         /// </summary>
         public Version? MSBuildVersion { get; init; }
 
-        public string[] ExternalTeamCityBuildTypes { get; init; } = [];
+        public AdditionalCiBuildConfiguration[] AdditionalCiBuildConfigurations { get; init; } = [];
 
         public bool TryGetDependency( string name, [NotNullWhen( true )] out ParametrizedDependency? dependency )
         {

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

@@ -1,6 +1,7 @@
 // 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.ContinuousIntegration.Model;
+using PostSharp.Engineering.BuildTools.ContinuousIntegration.TeamCity;
 using Spectre.Console.Cli;
 using System.Collections.Generic;
 

src/PostSharp.Engineering.BuildTools/ContinuousIntegration/GenerateScriptsCommand.cs

@@ -3,6 +3,7 @@
 using JetBrains.Annotations;
 using PostSharp.Engineering.BuildTools.Build;
 using PostSharp.Engineering.BuildTools.Build.Files;
+using PostSharp.Engineering.BuildTools.ContinuousIntegration.TeamCity.Generation;
 using PostSharp.Engineering.BuildTools.Docker;
 using PostSharp.Engineering.BuildTools.Utilities;
 

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

@@ -0,0 +1,26 @@
+// 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.ContinuousIntegration.TeamCity;
+using PostSharp.Engineering.BuildTools.ContinuousIntegration.TeamCity.Generation;
+
+namespace PostSharp.Engineering.BuildTools.ContinuousIntegration.Model;
+
+public abstract class AdditionalCiBuildConfiguration
+{
+    public string Name { get; }
+
+    public string Id { get; }
+
+    public string Branch { get; }
+
+    public bool AddSourceDependencies { get; init; }
+
+    protected AdditionalCiBuildConfiguration( string id, string name, string branch )
+    {
+        this.Id = id;
+        this.Name = name;
+        this.Branch = branch;
+    }
+
+    internal abstract TeamCityBuildConfiguration TeamCityBuildConfiguration( ProductProperties productProperties );
+}

src/PostSharp.Engineering.BuildTools/ContinuousIntegration/Model/BuildSteps/TeamCityBuildStep.cs

@@ -0,0 +1,48 @@
+using JetBrains.Annotations;
+using PostSharp.Engineering.BuildTools.ContinuousIntegration.TeamCity;
+using PostSharp.Engineering.BuildTools.ContinuousIntegration.TeamCity.BuildSteps;
+using PostSharp.Engineering.BuildTools.ContinuousIntegration.TeamCity.Generation;
+
+namespace PostSharp.Engineering.BuildTools.ContinuousIntegration.Model;
+
+[PublicAPI]
+public class PowershellAdditionalCiBuildConfiguration : AdditionalCiBuildConfiguration
+{
+    public PowershellAdditionalCiBuildConfiguration( string id, string name, string branch, string script, string arguments ) : base( id, name, branch )
+    {
+        this.Script = script;
+        this.Arguments = arguments;
+    }
+
+    public string Script { get; }
+
+    public string Arguments { get; }
+
+    internal override TeamCityBuildConfiguration TeamCityBuildConfiguration( ProductProperties productProperties )
+    {
+        var product = productProperties.Product;
+
+        var downstreamMergeConfiguration = new TeamCityBuildConfiguration(
+            this.Id,
+            this.Name,
+            this.Branch,
+            productProperties.DefaultBranchParameter,
+            productProperties.VcsRootId,
+            product.ResolvedBuildAgentRequirements )
+        {
+            BuildSteps =
+            [
+                new PowerShellBuildStep(
+                    "Exec",
+                    $"Execute {this.Script}",
+                    this.Script,
+                    this.Arguments,
+                    product.DockerSpec )
+            ],
+            IsSshAgentRequired = productProperties.IsRepoRemoteSsh,
+            SourceDependencies = this.AddSourceDependencies ? productProperties.SourceDependencies : []
+        };
+
+        return downstreamMergeConfiguration;
+    }
+}

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

@@ -1,14 +1,14 @@
 // Copyright (c) SharpCrafters s.r.o. See the LICENSE.md file in the root directory of this repository root for details.
 
-namespace PostSharp.Engineering.BuildTools.ContinuousIntegration.Model.Arguments;
+namespace PostSharp.Engineering.BuildTools.ContinuousIntegration.TeamCity.Arguments;
 
-public class TeamCityBuildConfigurationParameter
+public class BuildConfigurationParameter
 {
     public string Name { get; }
 
     public string Value { get; }
 
-    public TeamCityBuildConfigurationParameter( string name, string value )
+    public BuildConfigurationParameter( string name, string value )
     {
         this.Name = name;
         this.Value = value;

…s/TeamCityBuildConfigurationParameter.cs …Arguments/BuildConfigurationParameter.cssrc/PostSharp.Engineering.BuildTools/ContinuousIntegration/Model/Arguments/TeamCityBuildConfigurationParameter.cs renamed to src/PostSharp.Engineering.BuildTools/ContinuousIntegration/TeamCity/Arguments/BuildConfigurationParameter.cs src/PostSharp.Engineering.BuildTools/ContinuousIntegration/Model/Arguments/TeamCityBuildConfigurationParameter.cs renamed to src/PostSharp.Engineering.BuildTools/ContinuousIntegration/TeamCity/Arguments/BuildConfigurationParameter.cs

@@ -1,8 +1,8 @@
 // Copyright (c) SharpCrafters s.r.o. See the LICENSE.md file in the root directory of this repository root for details.
 
-namespace PostSharp.Engineering.BuildTools.ContinuousIntegration.Model.Arguments;
+namespace PostSharp.Engineering.BuildTools.ContinuousIntegration.TeamCity.Arguments;
 
-public class TeamCityTextBuildConfigurationParameter : TeamCityBuildConfigurationParameter
+public class TextBuildConfigurationParameter : BuildConfigurationParameter
 {
     public string Label { get; }
 
@@ -12,7 +12,7 @@ public class TeamCityTextBuildConfigurationParameter : TeamCityBuildConfiguratio
 
     public (string Regex, string ValidationMessage)? Validation { get; init; }
 
-    public TeamCityTextBuildConfigurationParameter( string name, string label, string description, string defaultValue = "", bool allowEmpty = false )
+    public TextBuildConfigurationParameter( string name, string label, string description, string defaultValue = "", bool allowEmpty = false )
         : base( name, defaultValue )
     {
         this.Label = label;

…amCityTextBuildConfigurationParameter.cs …ments/TextBuildConfigurationParameter.cssrc/PostSharp.Engineering.BuildTools/ContinuousIntegration/Model/Arguments/TeamCityTextBuildConfigurationParameter.cs renamed to src/PostSharp.Engineering.BuildTools/ContinuousIntegration/TeamCity/Arguments/TextBuildConfigurationParameter.cs src/PostSharp.Engineering.BuildTools/ContinuousIntegration/Model/Arguments/TeamCityTextBuildConfigurationParameter.cs renamed to src/PostSharp.Engineering.BuildTools/ContinuousIntegration/TeamCity/Arguments/TextBuildConfigurationParameter.cs

@@ -0,0 +1,47 @@
+// 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.ContinuousIntegration.TeamCity.Arguments;
+using PostSharp.Engineering.BuildTools.Docker;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+
+namespace PostSharp.Engineering.BuildTools.ContinuousIntegration.TeamCity.BuildSteps;
+
+internal abstract class BuildStep
+{
+    private readonly DockerSpec? _dockerSpec;
+
+    private readonly List<BuildConfigurationParameter> _parameters = new();
+
+    protected BuildStep( DockerSpec? dockerSpec )
+    {
+        this._dockerSpec = dockerSpec;
+    }
+
+    public IReadOnlyList<BuildConfigurationParameter> BuildConfigurationParameters => this._parameters;
+
+    protected void AddParameter( BuildConfigurationParameter parameter ) => this._parameters.Add( parameter );
+
+    public abstract string GenerateTeamCityCode();
+
+    public virtual void InsertPrerequisites( IReadOnlyList<BuildStep> previousSteps, Action<BuildStep> addStep )
+    {
+        if ( this._dockerSpec != null )
+        {
+            var prepareImageStep = previousSteps
+                .OfType<EngineeringPrepareImageBuildStep>()
+                .SingleOrDefault( i => i.DockerSpec.ImageName == this._dockerSpec.ImageName );
+
+            if ( prepareImageStep == null )
+            {
+                addStep( new EngineeringPrepareImageBuildStep( "PrepareImage", this._dockerSpec ) );
+            }
+        }
+    }
+
+    /// <summary>
+    /// Gets a time that should be added to the complete build configuration timeout.
+    /// </summary>
+    public virtual TimeSpan AdditionalTimeout { get; init; } = TimeSpan.Zero;
+}