Added component validation for deployment/testing components. Fixed MsDeployPublisher.

gfraiteur · gfraiteur · commit f541139fd55d · 2025-10-08T08:35:20.000+02:00
diff --git a/src/PostSharp.Engineering.BuildTools/Build/IBuildComponent.cs b/src/PostSharp.Engineering.BuildTools/Build/IBuildComponent.cs
@@ -0,0 +1,13 @@
+﻿// 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.Docker;
+using System.Collections.Generic;
+
+namespace PostSharp.Engineering.BuildTools.Build;
+
+public interface IBuildComponent
+{
+    bool VerifyContainerRequirements( BuildContext context, ContainerRequirements requirements );
+
+    IEnumerable<IBuildComponent> Children { get; }
+}
diff --git a/src/PostSharp.Engineering.BuildTools/Build/Model/Product.cs b/src/PostSharp.Engineering.BuildTools/Build/Model/Product.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 JetBrains.Annotations;
+using Microsoft.VisualStudio.Services.Common;
 using PostSharp.Engineering.BuildTools.BillOfMaterials;
 using PostSharp.Engineering.BuildTools.Build.Bumping;
 using PostSharp.Engineering.BuildTools.Build.Files;
@@ -153,6 +154,36 @@ public TimeSpan BuildTimeout
                     ExportsToTeamCityDeploy: true,
                     RequiresUpstreamCheck: true ) );
 
+        public IEnumerable<IBuildComponent> GetBuildComponents()
+        {
+            HashSet<IBuildComponent> components = new();
+
+            foreach ( var configuration in this.Configurations.All )
+            {
+                AddComponents( configuration.PublicPublishers );
+                AddComponents( configuration.PrivatePublishers );
+                AddComponents( configuration.Swappers );
+            }
+
+            return components;
+
+            void AddComponents( IEnumerable<IBuildComponent>? newComponents )
+            {
+                if ( newComponents == null )
+                {
+                    return;
+                }
+
+                foreach ( var component in newComponents )
+                {
+                    if ( components.Add( component ) )
+                    {
+                        AddComponents( component.Children );
+                    }
+                }
+            }
+        }
+
         public ImmutableArray<string> DefaultArtifactRules { get; } = ImmutableArray<string>.Empty;
 
         /// <summary>
diff --git a/src/PostSharp.Engineering.BuildTools/Build/Publishing/InvalidatingS3Publisher.cs b/src/PostSharp.Engineering.BuildTools/Build/Publishing/InvalidatingS3Publisher.cs
@@ -2,6 +2,7 @@
 
 using JetBrains.Annotations;
 using PostSharp.Engineering.BuildTools.Build.Model;
+using PostSharp.Engineering.BuildTools.Docker;
 using PostSharp.Engineering.BuildTools.Utilities;
 using System;
 using System.Collections.Generic;
diff --git a/src/PostSharp.Engineering.BuildTools/Build/Publishing/MsDeployPublisher.cs b/src/PostSharp.Engineering.BuildTools/Build/Publishing/MsDeployPublisher.cs
@@ -1,6 +1,8 @@
 ﻿// Copyright (c) SharpCrafters s.r.o. See the LICENSE.md file in the root directory of this repository root for details.
 
+using JetBrains.Annotations;
 using PostSharp.Engineering.BuildTools.Build.Model;
+using PostSharp.Engineering.BuildTools.Docker;
 using PostSharp.Engineering.BuildTools.Utilities;
 using System;
 using System.Collections.Generic;
@@ -15,6 +17,7 @@ namespace PostSharp.Engineering.BuildTools.Build.Publishing
     /// <summary>
     /// A <see cref="Publisher"/> that uses <c>MSDeploy</c> to deploy a web site.
     /// </summary>
+    [PublicAPI]
     public class MsDeployPublisher : ArtifactPublisher
     {
         private readonly ImmutableArray<MsDeployConfiguration> _configurations;
@@ -57,6 +60,13 @@ private static bool QueryPublishProfile(
             return true;
         }
 
+        public override bool VerifyContainerRequirements( BuildContext context, ContainerRequirements requirements )
+        {
+            return base.VerifyContainerRequirements( context, requirements )
+                   && requirements.RequireComponent<VisualStudioBuildToolsComponent>( context, out var vs )
+                   && vs.RequireVSComponent( context, "Microsoft.VisualStudio.Component.WebDeploy" );
+        }
+
         public override SuccessCode PublishFile(
             BuildContext context,
             PublishSettings settings,
@@ -73,7 +83,7 @@ public override SuccessCode PublishFile(
             }
 
             context.Console.WriteMessage( $"Publishing {file} to {publishProfile.PublishUrl}{packageConfiguration.VirtualDirectory}." );
-
+            
             var exe = @"C:\Program Files\IIS\Microsoft Web Deploy V3\msdeploy.exe";
 
             var iisWebApplicationName = packageConfiguration.VirtualDirectory == null
diff --git a/src/PostSharp.Engineering.BuildTools/Build/Publishing/Publisher.cs b/src/PostSharp.Engineering.BuildTools/Build/Publishing/Publisher.cs
@@ -2,20 +2,27 @@
 
 using JetBrains.Annotations;
 using PostSharp.Engineering.BuildTools.Build.Model;
+using PostSharp.Engineering.BuildTools.Docker;
+using System.Collections.Generic;
+using System.Linq;
 
 namespace PostSharp.Engineering.BuildTools.Build.Publishing
 {
     /// <summary>
     /// An abstract publisher class used in <see cref="PublishCommand"/> to publish artifacts or execute publishing step.
     /// </summary>
     [PublicAPI]
-    public abstract class Publisher
+    public abstract class Publisher : IBuildComponent
     {
         /// <summary>
         /// When set to false, the publisher will not publish pre-release artifacts. Default is true.
         /// </summary>
         public bool PublishPrerelease { get; init; } = true;
 
+        public virtual bool VerifyContainerRequirements( BuildContext context, ContainerRequirements requirements ) => true;
+
+        IEnumerable<IBuildComponent> IBuildComponent.Children => [];
+
         protected abstract bool Publish(
             BuildContext context,
             PublishSettings settings,
diff --git a/src/PostSharp.Engineering.BuildTools/Build/Swapping/AppServiceSwapper.cs b/src/PostSharp.Engineering.BuildTools/Build/Swapping/AppServiceSwapper.cs
@@ -2,6 +2,7 @@
 
 using JetBrains.Annotations;
 using PostSharp.Engineering.BuildTools.Build.Model;
+using PostSharp.Engineering.BuildTools.Docker;
 using PostSharp.Engineering.BuildTools.Utilities;
 
 namespace PostSharp.Engineering.BuildTools.Build.Swapping
@@ -59,5 +60,9 @@ protected override SuccessCode ExecuteCore(
 
             return AzHelper.Run( context, args, settings.Dry ) ? SuccessCode.Success : SuccessCode.Error;
         }
+
+        public override bool VerifyContainerRequirements( BuildContext context, ContainerRequirements requirements )
+            => base.VerifyContainerRequirements( context, requirements )
+               && requirements.RequireComponent<AzureCliComponent>( context );
     }
 }
diff --git a/src/PostSharp.Engineering.BuildTools/Build/Swapping/Swapper.cs b/src/PostSharp.Engineering.BuildTools/Build/Swapping/Swapper.cs
@@ -3,14 +3,16 @@
 using JetBrains.Annotations;
 using PostSharp.Engineering.BuildTools.Build.Model;
 using PostSharp.Engineering.BuildTools.Build.Testing;
+using PostSharp.Engineering.BuildTools.Docker;
+using System.Collections.Generic;
 
 namespace PostSharp.Engineering.BuildTools.Build.Swapping
 {
     /// <summary>
     /// A swapper is some logic that swaps a deployment slot (typically a staging one) onto another deployment slop (typically the production one).
     /// </summary>
     [PublicAPI]
-    public abstract class Swapper
+    public abstract class Swapper : IBuildComponent
     {
         /// <summary>
         /// When set to false, the swapper will not swap when the product is pre-release. Default is true.
@@ -42,5 +44,9 @@ protected abstract SuccessCode ExecuteCore(
             SwapSettings settings,
             BuildConfigurationInfo configuration,
             BuildArguments buildArguments );
+
+        public virtual bool VerifyContainerRequirements( BuildContext context, ContainerRequirements requirements ) => true;
+
+        IEnumerable<IBuildComponent> IBuildComponent.Children => this.Testers;
     }
 }
diff --git a/src/PostSharp.Engineering.BuildTools/Build/Testing/Tester.cs b/src/PostSharp.Engineering.BuildTools/Build/Testing/Tester.cs
@@ -1,14 +1,20 @@
 ﻿// 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 PostSharp.Engineering.BuildTools.Docker;
+using System.Collections.Generic;
 
 namespace PostSharp.Engineering.BuildTools.Build.Testing;
 
-public abstract class Tester
+public abstract class Tester : IBuildComponent
 {
     public abstract SuccessCode Execute(
         BuildContext context,
         string artifactsDirectory,
         BuildArguments buildArguments,
         bool dry );
+
+    public virtual bool VerifyContainerRequirements( BuildContext context, ContainerRequirements requirements ) => true;
+
+    IEnumerable<IBuildComponent> IBuildComponent.Children => [];
 }
diff --git a/src/PostSharp.Engineering.BuildTools/Build/Testing/VsTestTester.cs b/src/PostSharp.Engineering.BuildTools/Build/Testing/VsTestTester.cs
@@ -1,7 +1,9 @@
 ﻿// 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 PostSharp.Engineering.BuildTools.Docker;
 using PostSharp.Engineering.BuildTools.Utilities;
+using System;
 using System.Collections.Generic;
 using System.IO;
 using System.IO.Compression;
@@ -39,7 +41,16 @@ public override SuccessCode Execute(
                 var packagePath = Path.Combine( artifactsDirectory, this.TestPackageName.ToString( buildArguments ) );
                 ZipFile.ExtractToDirectory( packagePath, tempDirectory );
 
-                var exe = @"C:\Program Files\Microsoft Visual Studio\2022\Enterprise\Common7\IDE\Extensions\TestPlatform\vstest.console.exe";
+                var vsDir = Environment.GetEnvironmentVariable( "VSINSTALLDIR" );
+
+                if ( string.IsNullOrEmpty( vsDir ) )
+                {
+                    context.Console.WriteError( "The VSINSTALLDIR environment variable is not defined." );
+
+                    return SuccessCode.Fatal;
+                }
+
+                var exe = Path.Combine( vsDir, @"Common7\IDE\Extensions\TestPlatform\vstest.console.exe" );
 
                 var argsList = new List<string>();
 
@@ -74,5 +85,12 @@ public override SuccessCode Execute(
                 Directory.Delete( tempDirectory, true );
             }
         }
+
+        public override bool VerifyContainerRequirements( BuildContext context, ContainerRequirements requirements )
+        {
+            return base.VerifyContainerRequirements( context, requirements )
+                   && requirements.RequireComponent<VisualStudioBuildToolsComponent>( context, out var vs )
+                   && vs.RequireVSComponent( context, "Microsoft.VisualStudio.Component.TestTools.BuildTools" );
+        }
     }
 }
diff --git a/src/PostSharp.Engineering.BuildTools/Docker/ContainerRequirements.cs b/src/PostSharp.Engineering.BuildTools/Docker/ContainerRequirements.cs
@@ -6,6 +6,7 @@
 using PostSharp.Engineering.BuildTools.Utilities;
 using System;
 using System.Collections.Generic;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Linq;
 
@@ -62,6 +63,19 @@ void Add( ContainerComponent c )
             }
         }
 
+        // Validate publishers and testers.
+        var hasMissingRequirement = false;
+
+        foreach ( var buildComponent in context.Product.GetBuildComponents() )
+        {
+            hasMissingRequirement = !buildComponent.VerifyContainerRequirements( context, this );
+        }
+
+        if ( hasMissingRequirement )
+        {
+            return false;
+        }
+
         // Order components.
         var orderedComponents = allComponents.OrderBy( x => x ).ToList();
 
@@ -87,4 +101,23 @@ void Add( ContainerComponent c )
 
         return true;
     }
+
+    public bool RequireComponent<T>( BuildContext context )
+        where T : ContainerComponent
+        => this.RequireComponent<T>( context, out _ );
+
+    public bool RequireComponent<T>( BuildContext context, [NotNullWhen( true )] out T? component )
+        where T : ContainerComponent
+    {
+        component = this.Components.OfType<T>().SingleOrDefault();
+
+        if ( component == null )
+        {
+            context.Console.WriteError( $"The {typeof(T).Name} component is required." );
+
+            return false;
+        }
+
+        return true;
+    }
 }
diff --git a/src/PostSharp.Engineering.BuildTools/Docker/VisualStudioBuildToolsComponent.cs b/src/PostSharp.Engineering.BuildTools/Docker/VisualStudioBuildToolsComponent.cs
@@ -4,6 +4,7 @@
 using PostSharp.Engineering.BuildTools.Build;
 using PostSharp.Engineering.BuildTools.Utilities;
 using System;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Linq;
 
@@ -13,7 +14,8 @@ namespace PostSharp.Engineering.BuildTools.Docker;
 public sealed class VisualStudioBuildToolsComponent : ContainerComponent
 {
     private readonly VisualStudioBuildToolsComponentVersion _version;
-    private readonly string[] _vsComponents;
+
+    public string[] Components { get; }
 
     public override string Name => "Install VS Build Tools";
 
@@ -25,12 +27,12 @@ public VisualStudioBuildToolsComponent( string[] vsComponents ) : this( VisualSt
     public VisualStudioBuildToolsComponent( VisualStudioBuildToolsComponentVersion version, string[] vsComponents )
     {
         this._version = version;
-        this._vsComponents = vsComponents;
+        this.Components = vsComponents;
     }
 
     public override void WriteDockerfile( TextWriter writer )
     {
-        var components = string.Join( ", ", this._vsComponents.Select( x => $"\"--add\", \"{x}\"" ) );
+        var components = string.Join( ", ", this.Components.Select( x => $"\"--add\", \"{x}\"" ) );
 
         writer.WriteLine(
             $$"""
@@ -49,8 +51,11 @@ public override void WriteDockerfile( TextWriter writer )
                   Remove-Item C:\\vs_buildtools.exe;
               """ );
 
+        // Define VSINSTALLDIR
+        writer.WriteLine( "ENV VSINSTALLDIR=C:\\BuildTools" );
+
         // Define VSSDKINSTALLDIR
-        if ( this._vsComponents.Contains( "Microsoft.VisualStudio.Component.VSSDKBuildTools" ) )
+        if ( this.Components.Contains( "Microsoft.VisualStudio.Component.VSSDKBuildTools" ) )
         {
             writer.WriteLine( "ENV VSSDKINSTALL=C:\\BuildTools\\VSSDK" );
         }
@@ -67,4 +72,16 @@ public override void PopulateContextDirectory( BuildContext context, string dire
     {
         EmbeddedResourceHelper.ExtractResource( context, this._version.ManifestFilename, directory );
     }
+
+    public bool RequireVSComponent( BuildContext context, string component )
+    {
+        if ( !this.Components.Contains( component ) )
+        {
+            context.Console.WriteError( $"The VS component {component} is required." );
+
+            return false;
+        }
+
+        return true;
+    }
 }
diff --git a/src/PostSharp.Engineering.BuildTools/Utilities/ToolInvocationHelper.cs b/src/PostSharp.Engineering.BuildTools/Utilities/ToolInvocationHelper.cs
@@ -5,6 +5,7 @@
 using System;
 using System.ComponentModel;
 using System.Diagnostics;
+using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Linq;
 using System.Text;
@@ -452,5 +453,22 @@ void FilterProcessOutput( string output )
 
             return false;
         }
+
+        public static bool TryFindInPath( string file, [NotNullWhen( true )] out string? path )
+        {
+            foreach ( var directory in Environment.GetEnvironmentVariable( "PATH" )!.Split( ";" ) )
+            {
+                path = Path.Combine( directory, file );
+
+                if ( File.Exists( path ) )
+                {
+                    return true;
+                }
+            }
+
+            path = null;
+
+            return false;
+        }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`
`3`	`3`	`using JetBrains.Annotations;`
`4`	`4`	`using PostSharp.Engineering.BuildTools.Build.Model;`
	`5`	`+using PostSharp.Engineering.BuildTools.Docker;`
`5`	`6`	`using PostSharp.Engineering.BuildTools.Utilities;`
`6`	`7`
`7`	`8`	`namespace PostSharp.Engineering.BuildTools.Build.Swapping`
`@@ -59,5 +60,9 @@ protected override SuccessCode ExecuteCore(`
`59`	`60`
`60`	`61`	`return AzHelper.Run( context, args, settings.Dry ) ? SuccessCode.Success : SuccessCode.Error;`
`61`	`62`	`}`
	`63`	`+`
	`64`	`+ public override bool VerifyContainerRequirements( BuildContext context, ContainerRequirements requirements )`
	`65`	`+ => base.VerifyContainerRequirements( context, requirements )`
	`66`	`+ && requirements.RequireComponent<AzureCliComponent>( context );`
`62`	`67`	`}`
`63`	`68`	`}`