Update versioning in build scripts

Author: AndreyAkinshin

build/Program.cs

@@ -33,6 +33,7 @@ public class BuildContext : FrostingContext
     public string BuildConfiguration { get; set; }
     public bool SkipTests { get; set; }
     public bool SkipSlowTests { get; set; }
+    public string TargetVersion { get; set; }
 
     public DirectoryPath RootDirectory { get; }
     public DirectoryPath ArtifactsDirectory { get; }
@@ -45,8 +46,6 @@ public class BuildContext : FrostingContext
     public DirectoryPath ChangeLogGenDirectory { get; }
 
     public DirectoryPath RedirectRootDirectory { get; }
-    public DirectoryPath RedirectProjectDirectory { get; }
-    public DirectoryPath RedirectSourceDirectory { get; }
     public DirectoryPath RedirectTargetDirectory { get; }
 
     public FilePath SolutionFile { get; }
@@ -70,6 +69,7 @@ public BuildContext(ICakeContext context)
         BuildConfiguration = context.Argument("Configuration", "Release");
         SkipTests = context.Argument("SkipTests", false);
         SkipSlowTests = context.Argument("SkipSlowTests", false);
+        TargetVersion = context.Argument("Version", "");
 
         RootDirectory = new DirectoryPath(new DirectoryInfo(Directory.GetCurrentDirectory()).Parent.FullName);
         ArtifactsDirectory = RootDirectory.Combine("artifacts");
@@ -82,8 +82,6 @@ public BuildContext(ICakeContext context)
         ChangeLogGenDirectory = RootDirectory.Combine("docs").Combine("_changelog");
 
         RedirectRootDirectory = RootDirectory.Combine("docs").Combine("_redirects");
-        RedirectProjectDirectory = RedirectRootDirectory.Combine("RedirectGenerator");
-        RedirectSourceDirectory = RedirectRootDirectory.Combine("redirects");
         RedirectTargetDirectory = RootDirectory.Combine("docs").Combine("_site"); 
 
         SolutionFile = RootDirectory.CombineWithFilePath("BenchmarkDotNet.sln");
@@ -96,11 +94,16 @@ public BuildContext(ICakeContext context)
         AllPackableSrcProjects = new FilePathCollection(context.GetFiles(RootDirectory.FullPath + "/src/**/*.csproj")
             .Where(p => !p.FullPath.Contains("Disassembler")));
 
-        MsBuildSettings = new DotNetMSBuildSettings
+        MsBuildSettings = new DotNetMSBuildSettings();
+        if (IsCiBuild)
         {
-            MaxCpuCount = 1
-        };
-        MsBuildSettings.WithProperty("UseSharedCompilation", "false");
+            MsBuildSettings.MaxCpuCount = 1;
+            MsBuildSettings.WithProperty("UseSharedCompilation", "false");
+            System.Environment.SetEnvironmentVariable("BDN_CI_BUILD", "true");
+        }
+
+        if (!string.IsNullOrEmpty(TargetVersion))
+            MsBuildSettings.WithProperty("Version", TargetVersion);
 
         // NativeAOT build requires VS C++ tools to be added to $path via vcvars64.bat
         // but once we do that, dotnet restore fails with:
@@ -325,6 +328,7 @@ public class BuildTask : FrostingTask<BuildContext>
 {
     public override void Run(BuildContext context)
     {
+        context.Information("BuildSystemProvider: " + context.BuildSystem().Provider);
         context.DotNetBuild(context.SolutionFile.FullPath, new DotNetBuildSettings
         {
             Configuration = context.BuildConfiguration,
@@ -410,17 +414,20 @@ public override void Run(BuildContext context)
             Configuration = context.BuildConfiguration,
             OutputDirectory = context.ArtifactsDirectory.FullPath,
             ArgumentCustomization = args => args.Append("--include-symbols").Append("-p:SymbolPackageFormat=snupkg"),
-            MSBuildSettings = context.MsBuildSettings
+            MSBuildSettings = context.MsBuildSettings,
+            NoBuild = true,
+            NoRestore = true
         };
+
+        foreach (var project in context.AllPackableSrcProjects)
+            context.DotNetPack(project.FullPath, settingsSrc);
+        
         var settingsTemplate = new DotNetPackSettings
         {
             Configuration = context.BuildConfiguration,
             OutputDirectory = context.ArtifactsDirectory.FullPath,
             MSBuildSettings = context.MsBuildSettings
         };
-
-        foreach (var project in context.AllPackableSrcProjects)
-            context.DotNetPack(project.FullPath, settingsSrc);
         context.DotNetPack(context.TemplatesTestsProjectFile.FullPath, settingsTemplate);
     }
 }

build/common.props

@@ -23,47 +23,41 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <None Include="$(MSBuildThisFileDirectory)package-icon.png" Pack="True" PackagePath="" />
+    <None Include="$(MSBuildThisFileDirectory)package-icon.png" Pack="True" PackagePath=""/>
   </ItemGroup>
 
   <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
     <AssemblyOriginatorKeyFile>$(MSBuildThisFileDirectory)strongNameKey.snk</AssemblyOriginatorKeyFile>
     <SignAssembly>true</SignAssembly>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
   </PropertyGroup>
-  
+
   <PropertyGroup Condition=" '$(IsVisualBasic)' != 'true' AND '$(IsFsharp)' != 'true' ">
     <LangVersion>9.0</LangVersion>
-    
-    <Major>0</Major>
-    <Minor>13</Minor>
-    <Revision>5</Revision>
-
-    <BuildNumber Condition=" '$(APPVEYOR_BUILD_NUMBER)' != '' ">$(APPVEYOR_BUILD_NUMBER)</BuildNumber>
-    <BuildNumber Condition=" '$(BuildNumber)' == '' ">0</BuildNumber>
+  </PropertyGroup>
 
-    <PrereleaseLabel>-develop</PrereleaseLabel>
-    <PrereleaseLabel Condition=" '$(APPVEYOR_BUILD_NUMBER)' != '' "></PrereleaseLabel>
-    <!-- <PrereleaseLabel></PrereleaseLabel> --> <!-- For release versions only -->
+  <PropertyGroup Condition=" '$(VersionPrefix)' == '' ">
+    <VersionPrefix>0.13.5</VersionPrefix>
+    <VersionPrefix Condition=" '$(APPVEYOR_BUILD_NUMBER)' != '' ">$(VersionPrefix).$(APPVEYOR_BUILD_NUMBER)</VersionPrefix>
+  </PropertyGroup>
 
-    <PrereleaseLabelConstants></PrereleaseLabelConstants>
-    <PrereleaseLabelConstants Condition=" '$(PrereleaseLabel)' == '-develop' ">PRERELEASE_DEVELOP</PrereleaseLabelConstants>
-    <PrereleaseLabelConstants Condition=" '$(APPVEYOR_BUILD_NUMBER)' != '' ">PRERELEASE_NIGHTLY</PrereleaseLabelConstants>
-    <DefineConstants>$(DefineConstants);$(PrereleaseLabelConstants)</DefineConstants>
+  <PropertyGroup Condition=" '$(VersionSuffix)' == '' ">
+    <VersionSuffix>develop</VersionSuffix>
+    <VersionSuffix Condition=" '$(APPVEYOR_BUILD_NUMBER)' == '' AND '$(BDN_CI_BUILD)' != '' ">ci</VersionSuffix>
+  </PropertyGroup>
 
-    <AssemblyVersion>$(Major).$(Minor).$(Revision).$(BuildNumber)</AssemblyVersion>
-    <AssemblyFileVersion>$(Major).$(Minor).$(Revision).$(BuildNumber)</AssemblyFileVersion>
-    <InformationalVersion>$(Major).$(Minor).$(Revision).$(BuildNumber)$(PrereleaseLabel)</InformationalVersion>
-    <PackageVersion>$(Major).$(Minor).$(Revision).$(BuildNumber)$(PrereleaseLabel)</PackageVersion>
+  <PropertyGroup>
+    <AssemblyVersion>$(VersionPrefix)</AssemblyVersion>
+    <AssemblyFileVersion>$(VersionPrefix)</AssemblyFileVersion>
+    <InformationalVersion>$(Version)</InformationalVersion>
+    <PackageVersion>$(Version)</PackageVersion>
   </PropertyGroup>
+
   <ItemGroup>
     <PackageReference Include="Microsoft.NETFramework.ReferenceAssemblies" Version="1.0.2">
       <PrivateAssets>all</PrivateAssets>
       <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
     </PackageReference>
-  </ItemGroup>
-
-  <ItemGroup >
     <PackageReference Include="StyleCop.Analyzers" Version="1.1.118">
       <PrivateAssets>all</PrivateAssets>
     </PackageReference>

src/BenchmarkDotNet/Disassemblers/WindowsDisassembler.cs

@@ -86,15 +86,18 @@ private static string GetDisassemblerPath(string architectureName)
             var dir = new FileInfo(assemblyWithDisassemblersInResources.Location).Directory ?? throw new DirectoryNotFoundException();
             string disassemblerPath = Path.Combine(
                 dir.FullName,
-                FolderNameHelper.ToFolderName(BenchmarkDotNetInfo.FullVersion), // possible update
+                FolderNameHelper.ToFolderName(BenchmarkDotNetInfo.Instance.FullVersion), // possible update
                 exeName); // separate process per architecture!!
 
             Path.GetDirectoryName(disassemblerPath).CreateIfNotExists();
 
-#if !PRERELEASE_DEVELOP // for development we always want to copy the file to not omit any dev changes (Properties.BenchmarkDotNetInfo.FullVersion in file name is not enough)
-            if (File.Exists(disassemblerPath))
-                return disassemblerPath;
-#endif
+            // for development we always want to copy the file to not omit any dev changes
+            if (!BenchmarkDotNetInfo.Instance.IsDevelop)
+            {
+                if (File.Exists(disassemblerPath))
+                    return disassemblerPath;
+            }
+
             // the disassembler has not been yet retrieved from the resources
             CopyFromResources(
                 assemblyWithDisassemblersInResources,

src/BenchmarkDotNet/Environments/BenchmarkEnvironmentInfo.cs

@@ -7,6 +7,7 @@
 using BenchmarkDotNet.Jobs;
 using BenchmarkDotNet.Portability;
 using BenchmarkDotNet.Portability.Cpu;
+using BenchmarkDotNet.Properties;
 using BenchmarkDotNet.Validators;
 using JetBrains.Annotations;
 
@@ -51,6 +52,7 @@ protected BenchmarkEnvironmentInfo()
         public virtual IEnumerable<string> ToFormattedString()
         {
             yield return "Benchmark Process Environment Information:";
+            yield return $"{BenchmarkDotNetInfo.Instance.BrandTitle}";
             yield return $"{RuntimeInfoPrefix}{GetRuntimeInfo()}";
             yield return $"{GcInfoPrefix}{GetGcConcurrentFlag()} {GetGcServerFlag()}";
             yield return $"{HardwareIntrinsicsPrefix}{HardwareIntrinsics.GetFullInfo(RuntimeInformation.GetCurrentPlatform())} {HardwareIntrinsics.GetVectorSize()}";

src/BenchmarkDotNet/Environments/HostEnvironmentInfo.cs

@@ -67,7 +67,7 @@ public class HostEnvironmentInfo : BenchmarkEnvironmentInfo
 
         protected HostEnvironmentInfo()
         {
-            BenchmarkDotNetVersion = BenchmarkDotNetInfo.FullVersion;
+            BenchmarkDotNetVersion = BenchmarkDotNetInfo.Instance.BrandVersion;
             OsVersion = new Lazy<string>(RuntimeInformation.GetOsVersion);
             CpuInfo = new Lazy<CpuInfo>(RuntimeInformation.GetCpuInfo);
             ChronometerFrequency = Chronometer.Frequency;

src/BenchmarkDotNet/Exporters/RPlotExporter.cs

@@ -36,7 +36,7 @@ public IEnumerable<string> ExportToFiles(Summary summary, ILogger consoleLogger)
             string logFullPath = Path.Combine(summary.ResultsDirectoryPath, logFileName);
             string script = ResourceHelper.
                 LoadTemplate(scriptFileName).
-                Replace("$BenchmarkDotNetVersion$", BenchmarkDotNetInfo.FullTitle).
+                Replace("$BenchmarkDotNetVersion$", BenchmarkDotNetInfo.Instance.BrandTitle).
                 Replace("$CsvSeparator$", CsvMeasurementsExporter.Default.Separator);
             lock (BuildScriptLock)
                 File.WriteAllText(scriptFullPath, script);

src/BenchmarkDotNet/Properties/BenchmarkDotNetInfo.cs

@@ -1,39 +1,53 @@
 using System;
-using System.Diagnostics.CodeAnalysis;
 using System.Reflection;
+using BenchmarkDotNet.Extensions;
 
 namespace BenchmarkDotNet.Properties
 {
-    [SuppressMessage("ReSharper", "MemberCanBePrivate.Global")]
-    public static class BenchmarkDotNetInfo
+    public class BenchmarkDotNetInfo
     {
-#if PRERELEASE_NIGHTLY
-        public const string PrereleaseLabel = "-nightly";
-#elif PRERELEASE_DEVELOP
-        public const string PrereleaseLabel = "-develop";
-#else
-        public const string PrereleaseLabel = "";
-#endif
-
-        // ReSharper disable once ConditionIsAlwaysTrueOrFalse
-        [SuppressMessage("ReSharper", "RedundantLogicalConditionalExpressionOperand")]
-        private static readonly Lazy<string> FullVersionLazy = new Lazy<string>(() =>
+        private static readonly Lazy<BenchmarkDotNetInfo> LazyInstance = new (() =>
         {
-            string version = typeof(BenchmarkDotNetInfo).GetTypeInfo().Assembly.GetName().Version.ToString();
-#pragma warning disable 162
-            if (version.EndsWith(".0") && PrereleaseLabel == "")
-                version = version.Substring(0, version.Length - 2);
-            if (version.EndsWith(".0") && PrereleaseLabel == "-develop")
-                version = version.Substring(0, version.Length - 1) + DateTime.Now.ToString("yyyyMMdd");
-#pragma warning restore 162
-            return version + PrereleaseLabel;
+            var assembly = typeof(BenchmarkDotNetInfo).GetTypeInfo().Assembly;
+            var assemblyVersion = assembly.GetName().Version;
+            string informationVersion = assembly.GetCustomAttribute<AssemblyInformationalVersionAttribute>().InformationalVersion ?? "";
+            return new BenchmarkDotNetInfo(assemblyVersion, informationVersion);
         });
 
-        private static readonly Lazy<string> FullTitleLazy = new Lazy<string>(() => "BenchmarkDotNet v" + FullVersionLazy.Value);
+        public static BenchmarkDotNetInfo Instance { get; } = LazyInstance.Value;
 
-        public static string FullVersion => FullVersionLazy.Value;
+        public Version AssemblyVersion { get; }
+        public string FullVersion { get; }
 
-        public static string FullTitle => FullTitleLazy.Value;
+        public bool IsDevelop { get; }
+        public bool IsNightly { get; }
+        public bool IsRelease { get; }
+
+        public string BrandTitle { get; }
+        public string BrandVersion { get; }
+
+        public BenchmarkDotNetInfo(Version assemblyVersion, string fullVersion)
+        {
+            AssemblyVersion = assemblyVersion;
+            FullVersion = fullVersion;
+
+            string versionPrefix = AssemblyVersion.Revision > 0
+                ? AssemblyVersion.ToString()
+                : AssemblyVersion.ToString(3);
+            if (!FullVersion.StartsWith(versionPrefix))
+                throw new ArgumentException($"Inconsistent versions: '{assemblyVersion}' and '{fullVersion}'");
+            string versionSuffix = FullVersion.Substring(versionPrefix.Length).TrimStart('-');
+
+            IsDevelop = versionSuffix.StartsWith("develop");
+            IsNightly = AssemblyVersion.Revision > 0;
+            IsRelease = versionSuffix.IsEmpty() && AssemblyVersion.Revision <= 0;
+
+            string brandVersionSuffix = IsDevelop
+                ? " (" + DateTime.Now.ToString("yyyy-MM-dd") + ")"
+                : "";
+            BrandVersion = FullVersion + brandVersionSuffix;
+            BrandTitle = "BenchmarkDotNet v" + BrandVersion;
+        }
 
         internal const string PublicKey =
             "00240000048000009400000006020000002400005253413100040000010001002970bbdfca4d12" +

src/BenchmarkDotNet/Running/BenchmarkRunnerClean.cs

@@ -145,7 +145,8 @@ internal static Summary[] Run(BenchmarkRunInfo[] benchmarkRunInfos)
                     }
 
                     compositeLogger.WriteLineHeader("// * Artifacts cleanup *");
-                    Cleanup(new HashSet<string>(artifactsToCleanup.Distinct()));
+                    Cleanup(compositeLogger, new HashSet<string>(artifactsToCleanup.Distinct()));
+                    compositeLogger.WriteLineInfo("Artifacts cleanup is finished");
                     compositeLogger.Flush();
                 }
             }
@@ -639,10 +640,11 @@ void AddLogger(ILogger logger)
             return new CompositeLogger(loggers.Values.ToImmutableHashSet());
         }
 
-        private static void Cleanup(HashSet<string> artifactsToCleanup)
+        private static void Cleanup(ILogger logger, HashSet<string> artifactsToCleanup)
         {
             foreach (string path in artifactsToCleanup)
             {
+                logger.WriteLineInfo($"Trying to delete '{path}'");
                 try
                 {
                     if (Directory.Exists(path))
@@ -653,9 +655,11 @@ private static void Cleanup(HashSet<string> artifactsToCleanup)
                     {
                         File.Delete(path);
                     }
+                    logger.WriteLineInfo($"Successfully deleted '{path}'");
                 }
-                catch
+                catch (Exception e)
                 {
+                    logger.WriteLineInfo($"Failed to delete '{path}' because of the following exception: {e}");
                     // sth is locking our auto-generated files
                     // there is very little we can do about it
                 }

src/BenchmarkDotNet/Toolchains/InProcess/Emit/Implementation/Emitters/RunnableEmitter.cs

@@ -12,6 +12,7 @@
 using BenchmarkDotNet.Helpers.Reflection.Emit;
 using BenchmarkDotNet.Jobs;
 using BenchmarkDotNet.Loggers;
+using BenchmarkDotNet.Properties;
 using BenchmarkDotNet.Running;
 using BenchmarkDotNet.Toolchains.Results;
 using JetBrains.Annotations;
@@ -78,11 +79,13 @@ public static Assembly EmitPartitionAssembly(
 
         private static bool ShouldSaveToDisk(IConfig config)
         {
-#if PRERELEASE_DEVELOP || PRERELEASE_NIGHTLY // we never want to do that in our official NuGet.org package, it's a hack
-            return config.Options.IsSet(ConfigOptions.KeepBenchmarkFiles) && Portability.RuntimeInformation.IsFullFramework;
-#else
+            if (!BenchmarkDotNetInfo.Instance.IsRelease)
+            {
+                // we never want to do that in our official NuGet.org package, it's a hack
+                return config.Options.IsSet(ConfigOptions.KeepBenchmarkFiles) && Portability.RuntimeInformation.IsFullFramework;
+            }
+
             return false;
-#endif
         }
 
         private static string GetRunnableTypeName(BenchmarkBuildInfo benchmark)

tests/BenchmarkDotNet.Tests/BenchmarkDotNetInfoTests.cs

@@ -0,0 +1,23 @@
+using System;
+using BenchmarkDotNet.Properties;
+using Xunit;
+
+namespace BenchmarkDotNet.Tests
+{
+    public class BenchmarkDotNetInfoTests
+    {
+        [Theory]
+        [InlineData("1.0.0", "1.0.0", false, false, true)]
+        [InlineData("1.0.0", "1.0.0-develop", true, false, false)]
+        [InlineData("1.0.0", "1.0.0-develop123", true, false, false)]
+        [InlineData("1.2.3.4", "1.2.3.4", false, true, false)]
+        public void BenchmarkDotNetInfoTest(string assemblyVersion, string fullVersion, bool expectedIsDevelop, bool expectedIsNightly,
+            bool expectedIsRelease)
+        {
+            var info = new BenchmarkDotNetInfo(Version.Parse(assemblyVersion), fullVersion);
+            Assert.Equal(expectedIsDevelop, info.IsDevelop);
+            Assert.Equal(expectedIsNightly, info.IsNightly);
+            Assert.Equal(expectedIsRelease, info.IsRelease);
+        }
+    }
+}