Fixes for Metalama.Compiler.

Author: gfraiteur

src/PostSharp.Engineering.BuildTools/BillOfMaterials/DependencyWalker.cs

@@ -55,7 +55,7 @@ private static IReadOnlyList<PackageDependencyInfo> GetPackageDependencies( Buil
 
         if ( !depsFilesPattern.TryGetFiles(
                 context.RepoDirectory,
-                new BuildInfo( null, defaultConfiguration, context.Product, null ),
+                new BuildArguments( null, defaultConfiguration, context.Product, null ),
                 depsFiles ) )
         {
             return [];

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

@@ -125,7 +125,7 @@ public static bool Execute( BuildContext context, BuildSettings settings )
             ImportFile.Delete( context );
 
             // We have to read the version from the file we have generated - using MSBuild, because it contains properties.
-            var buildInfo = VersionFileHelper.ReadGeneratedVersionFile( context, settings.BuildConfiguration );
+            var buildInfo = BuildArguments.Read( context, settings.BuildConfiguration );
 
             var privateArtifactsDirectory = product.GetPrivateArtifactsDirectory( context, buildInfo );
 

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

@@ -53,7 +53,8 @@ public string GetWorkingDirectory( string projectOrSolution )
         /// Gets a value indicating whether the current device is a guest device, as opposed to a device owned and configured by PostSharp.
         /// The main difference is that guest devices use feed packages while company devices use TeamCity artefacts.
         /// </summary>
-        public static bool IsGuestDevice => !bool.TryParse( Environment.GetEnvironmentVariable( EnvironmentVariableNames.IsPostSharpOwned ), out var value ) || !value;
+        public static bool IsGuestDevice
+            => !bool.TryParse( Environment.GetEnvironmentVariable( EnvironmentVariableNames.IsPostSharpOwned ), out var value ) || !value;
 
         /// <summary>
         /// Gets the full path of the current manifest file (i.e. the file called <c>My.Product.version.props</c>)
@@ -64,7 +65,7 @@ public string GetManifestFilePath( BuildConfiguration configuration )
             return Path.Combine(
                 this.RepoDirectory,
                 this.Product.PrivateArtifactsDirectory.ToString(
-                    new BuildInfo( null, configuration.ToString(), this.Product.DependencyDefinition.MSBuildConfiguration[configuration], null ) ),
+                    new BuildArguments( null, configuration.ToString(), this.Product.DependencyDefinition.MSBuildConfiguration[configuration], null ) ),
                 $"{this.Product.ProductName}.version.props" );
         }
 
@@ -154,18 +155,32 @@ public static bool TryCreate(
         }
 
         public BuildContext WithConsoleHelper( ConsoleHelper consoleHelper )
-            => new( consoleHelper, this.RepoDirectory, this.CommandData, this.Branch, this.CommandContext, this.UseProjectDirectoryAsWorkingDirectory, this.Settings );
+            => new(
+                consoleHelper,
+                this.RepoDirectory,
+                this.CommandData,
+                this.Branch,
+                this.CommandContext,
+                this.UseProjectDirectoryAsWorkingDirectory,
+                this.Settings );
 
         public BuildContext WithUseProjectDirectoryAsWorkingDirectory( bool useProjectDirectoryAsWorkingDirectory )
-            => new( this.Console, this.RepoDirectory, this.CommandData, this.Branch, this.CommandContext, useProjectDirectoryAsWorkingDirectory, this.Settings );
+            => new(
+                this.Console,
+                this.RepoDirectory,
+                this.CommandData,
+                this.Branch,
+                this.CommandContext,
+                useProjectDirectoryAsWorkingDirectory,
+                this.Settings );
 
         [PublicAPI]
 #pragma warning disable CA1822
         public bool IsRunningUnderContainer => DockerHelper.IsDockerBuild();
 #pragma warning restore CA1822
 
         public bool IsContinuousIntegrationBuild => TeamCityHelper.IsTeamCityBuild( this.Settings );
-        
+
         [PublicAPI]
         public CommonCommandSettings Settings { get; }
     }

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

@@ -116,7 +116,7 @@ void CleanNugetCache()
                 DeleteDirectory( Path.Combine( context.RepoDirectory, directory ) );
             }
 
-            var stringParameters = new BuildInfo( null, settings.BuildConfiguration, product, null );
+            var stringParameters = new BuildArguments( null, settings.BuildConfiguration, product, null );
 
             DeleteDirectory(
                 Path.Combine(

src/PostSharp.Engineering.BuildTools/Build/Files/ArtifactManifestFile.cs

@@ -207,7 +207,7 @@ internal static string GetPath( BuildContext context, BuildConfiguration configu
         var product = context.Product;
 
         var privateArtifactsRelativeDir =
-            product.PrivateArtifactsDirectory.ToString( new BuildInfo( null, configuration, product, null ) );
+            product.PrivateArtifactsDirectory.ToString( new BuildArguments( null, configuration, product, null ) );
 
         var artifactsDir = Path.Combine( context.RepoDirectory, privateArtifactsRelativeDir );
 
@@ -222,10 +222,18 @@ internal static string GetPath( BuildContext context, BuildConfiguration configu
     /// </summary>
     public static bool TryRead(
         BuildContext context,
-        MainVersionFile mainVersionFile,
+        BuildConfiguration configuration,
         [NotNullWhen( true )] out ArtifactManifestVersionInfo? artifactManifestVersionInfo )
     {
         var product = context.Product;
+
+        if ( !MainVersionFile.TryRead( context, out var mainVersionFile ) )
+        {
+            artifactManifestVersionInfo = null;
+
+            return false;
+        }
+
         var overriddenPatchVersion = mainVersionFile.OverriddenPatchVersion;
 
         string? mainVersion;
@@ -251,15 +259,12 @@ public static bool TryRead(
             {
                 // If no OverridenPatchVersion is defined, we use MainVersion property from private artifact.
 
-                var artifactVersionFile = Path.Combine(
-                    context.RepoDirectory,
-                    context.Product.PrivateArtifactsDirectory.ToString(),
-                    context.Product.ProductName + ".version.props" );
+                var artifactVersionFile = context.GetManifestFilePath( configuration );
 
                 var document = XDocument.Load( artifactVersionFile );
                 var project = document.Root;
                 var properties = project?.Element( "PropertyGroup" );
-                var propertyName = $"{context.Product.ProductNameWithoutDot}MainVersion";
+                var propertyName = $"{product.ProductNameWithoutDot}MainVersion";
                 mainVersion = properties?.Element( propertyName )?.Value;
 
                 if ( mainVersion == null )
@@ -281,4 +286,67 @@ public static bool TryRead(
 
         return true;
     }
+
+    public static BuildArguments CreateParametricStringArguments( BuildContext context, BuildConfiguration buildConfiguration )
+    {
+        var product = context.Product;
+        var versionFilePath = context.GetManifestFilePath( buildConfiguration );
+
+        if ( !File.Exists( versionFilePath ) )
+        {
+            throw new FileNotFoundException( $"The file '{versionFilePath}' should exist before calling this method." );
+        }
+
+        var versionFile = Project.FromFile( versionFilePath, MSBuildLoadOptions.IgnoreImportErrors );
+
+        string packageVersion;
+
+        if ( product.GenerateArcadeProperties )
+        {
+            packageVersion = versionFile.Properties
+                .Single( p => p.Name == product.ProductNameWithoutDot + "VersionPrefix" )
+                .EvaluatedValue;
+
+            var suffix = versionFile
+                .Properties
+                .Single( p => p.Name == product.ProductNameWithoutDot + "VersionSuffix" )
+                .EvaluatedValue;
+
+            if ( !string.IsNullOrWhiteSpace( suffix ) )
+            {
+                packageVersion = packageVersion + "-" + suffix;
+            }
+        }
+        else
+        {
+            packageVersion = versionFile
+                .Properties
+                .Single( p => p.Name == product.ProductNameWithoutDot + "Version" )
+                .EvaluatedValue;
+        }
+
+        if ( string.IsNullOrEmpty( packageVersion ) )
+        {
+            throw new InvalidOperationException( "PackageVersion should not be null." );
+        }
+
+        var configuration = versionFile
+            .Properties
+            .Single( p => p.Name == product.ProductNameWithoutDot + "BuildConfiguration" )
+            .EvaluatedValue;
+
+        var packagePreviewVersion = versionFile
+            .Properties
+            .Single( p => p.Name == product.ProductNameWithoutDot + "PreviewVersion" )
+            .EvaluatedValue;
+
+        if ( string.IsNullOrEmpty( configuration ) )
+        {
+            throw new InvalidOperationException( "BuildConfiguration should not be null." );
+        }
+
+        ProjectCollection.GlobalProjectCollection.UnloadAllProjects();
+
+        return new BuildArguments( packageVersion, Enum.Parse<BuildConfiguration>( configuration ), product, packagePreviewVersion );
+    }
 }

src/PostSharp.Engineering.BuildTools/Build/Files/ArtifactManifestVersionInfo.cs

@@ -4,4 +4,7 @@
 
 namespace PostSharp.Engineering.BuildTools.Build.Files;
 
-internal record ArtifactManifestVersionInfo( Version Version, string PackageVersionSuffix );
+internal record ArtifactManifestVersionInfo( Version Version, string PackageVersionSuffix )
+{
+    public string PackageVersion => this.Version.ToString() + this.PackageVersionSuffix;
+}

src/PostSharp.Engineering.BuildTools/Build/Files/NuGetConfigFile.cs

@@ -67,7 +67,7 @@ internal static bool TryWrite( BuildContext context, DependenciesOverrideFile de
         // Add the current artifact directory.
         var artifactDirectory = Path.Combine(
             context.RepoDirectory,
-            product.PrivateArtifactsDirectory.ToString( new BuildInfo( null, configuration, product, null ) ) );
+            product.PrivateArtifactsDirectory.ToString( new BuildArguments( null, configuration, product, null ) ) );
 
         AddDirectory( product.ProductName, artifactDirectory, product.DependencyDefinition.PackagePatterns );
 
@@ -95,7 +95,7 @@ internal static bool TryWrite( BuildContext context, DependenciesOverrideFile de
                 dependencyDirectory = Path.Combine(
                     dependencyDirectory,
                     dependencyDefinition.PrivateArtifactsDirectory.ToString(
-                        new BuildInfo(
+                        new BuildArguments(
                             null,
                             parametrizedDependency.ConfigurationMapping[configuration],
                             dependencyDefinition,

src/PostSharp.Engineering.BuildTools/Build/Files/TeamCitySettingsFile.cs

@@ -48,7 +48,7 @@ private static bool TryWriteStandalone( BuildContext context, CommonCommandSetti
                 continue;
             }
 
-            var versionInfo = new BuildInfo( null, configuration, product, null );
+            var versionInfo = new BuildArguments( null, configuration, product, null );
 
             // Set artifact rules.
             var publicArtifactsDirectory =
@@ -98,7 +98,7 @@ private static bool TryWriteStandalone( BuildContext context, CommonCommandSetti
                 .Select( d => new TeamCitySnapshotDependency(
                              d.Definition.CiConfiguration.BuildTypes[d.Configuration],
                              true,
-                             $"+:{d.Definition.PrivateArtifactsDirectory.ToString( new BuildInfo( null, d.Configuration, product, null ) ).Replace( Path.DirectorySeparatorChar, '/' )}/**/*=>dependencies/{d.Name}" ) )
+                             $"+:{d.Definition.PrivateArtifactsDirectory.ToString( new BuildArguments( null, d.Configuration, product, null ) ).Replace( Path.DirectorySeparatorChar, '/' )}/**/*=>dependencies/{d.Name}" ) )
                 .ToList();
 
             var sourceSnapshotDependencies = product.SourceDependencies.Where( d => d.GenerateSnapshotDependency )
@@ -469,7 +469,7 @@ bool TryPopulateBuildConfigurations(
                      && !projectsWithNoNuGetArtifacts.Any( p => dependencyDefinition.Name.Contains( p, StringComparison.Ordinal ) ) )
                 {
                     var dependencyMsBuildConfiguration = dependencyDefinition.MSBuildConfiguration[configuration];
-                    var dependencyBuildInfo = new BuildInfo( null, configuration.ToString(), dependencyMsBuildConfiguration, null );
+                    var dependencyBuildInfo = new BuildArguments( null, configuration.ToString(), dependencyMsBuildConfiguration, null );
 
                     var dependencyPrivateArtifactsDirectory = dependencyDefinition.PrivateArtifactsDirectory.ToString( dependencyBuildInfo )
                         .Replace( Path.DirectorySeparatorChar, '/' );
@@ -521,7 +521,7 @@ bool TryPopulateBuildConfigurations(
                         .Select( c => c! ) );
             }
 
-            var buildInfo = new BuildInfo( null, configuration, product, null );
+            var buildInfo = new BuildArguments( null, configuration, product, null );
 
             var privateArtifactsDirectory =
                 product.PrivateArtifactsDirectory.ToString( buildInfo ).Replace( "\\", "/", StringComparison.Ordinal );
@@ -848,7 +848,7 @@ bool TryAddPreOrPostDeploymentBuildConfiguration(
                             var dependencyName = dependencyDefinition.Name;
                             var configuration = BuildConfiguration.Public;
                             var dependencyMsBuildConfiguration = dependencyDefinition.MSBuildConfiguration[configuration];
-                            var dependencyBuildInfo = new BuildInfo( null, configuration.ToString(), dependencyMsBuildConfiguration, null );
+                            var dependencyBuildInfo = new BuildArguments( null, configuration.ToString(), dependencyMsBuildConfiguration, null );
 
                             var dependencyPrivateArtifactsDirectory = dependencyDefinition.PrivateArtifactsDirectory.ToString( dependencyBuildInfo )
                                 .Replace( Path.DirectorySeparatorChar, '/' );

src/PostSharp.Engineering.BuildTools/Build/Files/VersionFileHelper.cs

@@ -16,63 +16,6 @@ namespace PostSharp.Engineering.BuildTools.Build.Files;
 
 internal static class VersionFileHelper
 {
-    public static BuildInfo ReadGeneratedVersionFile( BuildContext context, BuildConfiguration buildConfiguration )
-    {
-        var product = context.Product;
-        var versionFilePath = context.GetManifestFilePath( buildConfiguration );
-        var versionFile = Project.FromFile( versionFilePath, MSBuildLoadOptions.IgnoreImportErrors );
-
-        string packageVersion;
-
-        if ( product.GenerateArcadeProperties )
-        {
-            packageVersion = versionFile.Properties
-                .Single( p => p.Name == product.ProductNameWithoutDot + "VersionPrefix" )
-                .EvaluatedValue;
-
-            var suffix = versionFile
-                .Properties
-                .Single( p => p.Name == product.ProductNameWithoutDot + "VersionSuffix" )
-                .EvaluatedValue;
-
-            if ( !string.IsNullOrWhiteSpace( suffix ) )
-            {
-                packageVersion = packageVersion + "-" + suffix;
-            }
-        }
-        else
-        {
-            packageVersion = versionFile
-                .Properties
-                .Single( p => p.Name == product.ProductNameWithoutDot + "Version" )
-                .EvaluatedValue;
-        }
-
-        if ( string.IsNullOrEmpty( packageVersion ) )
-        {
-            throw new InvalidOperationException( "PackageVersion should not be null." );
-        }
-
-        var configuration = versionFile
-            .Properties
-            .Single( p => p.Name == product.ProductNameWithoutDot + "BuildConfiguration" )
-            .EvaluatedValue;
-
-        var packagePreviewVersion = versionFile
-            .Properties
-            .Single( p => p.Name == product.ProductNameWithoutDot + "PreviewVersion" )
-            .EvaluatedValue;
-
-        if ( string.IsNullOrEmpty( configuration ) )
-        {
-            throw new InvalidOperationException( "BuildConfiguration should not be null." );
-        }
-
-        ProjectCollection.GlobalProjectCollection.UnloadAllProjects();
-
-        return new BuildInfo( packageVersion, Enum.Parse<BuildConfiguration>( configuration ), product, packagePreviewVersion );
-    }
-
     public static BuildConfiguration GetDependencyConfiguration( DependencyDefinition definition, DependencySource source )
     {
         if ( source.SourceKind == DependencySourceKind.Feed )

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

@@ -27,13 +27,13 @@ public static bool TryAddTagToLastCommit( BuildContext context, PublishSettings
 
         if ( !ArtifactManifestFile.TryRead(
                 context,
-                mainVersionFileInfo,
+                settings.BuildConfiguration,
                 out var preparedVersionInfo ) )
         {
             return false;
         }
 
-        var versionTag = string.Concat( "release/", preparedVersionInfo.Version, preparedVersionInfo.PackageVersionSuffix );
+        var versionTag = $"release/{preparedVersionInfo.PackageVersion}";
 
         ToolInvocationHelper.InvokeTool(
             context.Console,