Change PowerShell json to new version type, add test build

Author: Robert Holt

CrossCompatibility/CrossCompatibility/Utility/PowerShellVersion.cs renamed to CrossCompatibility/CrossCompatibility/Common/PowerShellVersion.cs

@@ -2,7 +2,7 @@
 using System.Text;
 using Newtonsoft.Json;
 
-namespace Microsoft.PowerShell.CrossCompatibility.Utility
+namespace Microsoft.PowerShell.CrossCompatibility
 {
     public class PowerShellVersion
     {
@@ -11,12 +11,17 @@ public static PowerShellVersion Create(dynamic versionInput)
             switch (versionInput)
             {
                 case Version systemVersion:
-                    return new PowerShellVersion(systemVersion);
+                    return (PowerShellVersion)systemVersion;
 
                 case string versionString:
                     return Parse(versionString);
             }
 
+            if (versionInput.BuildLabel != null)
+            {
+                return new PowerShellVersion(versionInput.Major, versionInput.Minor, versionInput.Patch, $"{versionInput.PreReleaseLabel}+{versionInput.BuildLabel}");
+            }
+
             return new PowerShellVersion(versionInput.Major, versionInput.Minor, versionInput.Patch, versionInput.PreReleaseLabel);
         }
 
@@ -27,7 +32,7 @@ public static PowerShellVersion Parse(string versionStr)
                 throw new ArgumentNullException(nameof(versionStr));
             }
 
-            int[] versionParts = new int[3];
+            int[] versionParts = new int[3] { -1, -1, -1 };
 
             int sectionStartOffset = 0;
             int dotCount = 0;
@@ -69,7 +74,7 @@ public static PowerShellVersion Parse(string versionStr)
 
             versionParts[dotCount] = int.Parse(versionStr.Substring(sectionStartOffset, i - sectionStartOffset));
 
-            return new PowerShellVersion(versionParts[0], versionParts[1], versionParts[2], preReleaseLabel: null);
+            return new PowerShellVersion(versionParts[0], versionParts[1], versionParts[2], label: null);
         }
 
         public static bool TryParse(string versionStr, out PowerShellVersion version)
@@ -86,45 +91,75 @@ public static bool TryParse(string versionStr, out PowerShellVersion version)
             }
         }
 
-        public static explicit operator Version(PowerShellVersion psVersion)
+        public static void ValidateVersionArguments(int major, int minor, int build, int revision, string preReleaseLabel)
         {
-            if (psVersion.PreReleaseLabel != null)
+            if (major < 0)
             {
-                throw new InvalidCastException($"Cannot convert version '{psVersion}' to System.Version, since there is a pre-release label");
+                throw new ArgumentException();
+            }
+
+            if (minor < 0 && (build >= 0 || revision >= 0))
+            {
+                throw new ArgumentException();
             }
 
-            if (psVersion.Revision != null)
+            if (build < 0 && revision >= 0)
             {
-                return new Version(psVersion.Major, psVersion.Minor, psVersion.Patch, psVersion.Revision.Value);
+                throw new ArgumentException();
             }
 
-            return new Version(psVersion.Major, psVersion.Minor, psVersion.Patch);
+            if (revision >= 0 && preReleaseLabel != null)
+            {
+                throw new ArgumentException();
+            }
+        }
+
+        public static explicit operator Version(PowerShellVersion psVersion)
+        {
+            if (psVersion.PreReleaseLabel != null)
+            {
+                throw new InvalidCastException($"Cannot convert version '{psVersion}' to System.Version, since there is a pre-release label");
+            }
+
+            return new Version(psVersion.Major, psVersion.Minor, psVersion.Patch, psVersion.Revision);
         }
 
         public static explicit operator PowerShellVersion(string versionString)
         {
             return PowerShellVersion.Parse(versionString);
         }
 
-        public PowerShellVersion(Version version)
-            : this(version.Major, version.Minor, version.Build, version.Revision)
+        public static explicit operator PowerShellVersion(Version version)
         {
+            return new PowerShellVersion(version.Major, version.Minor, version.Build, version.Revision);
         }
 
         public PowerShellVersion(int major, int minor, int build, int revision)
         {
+            ValidateVersionArguments(major, minor, build, revision, preReleaseLabel: null);
             Major = major;
             Minor = minor;
             Build = build;
             Revision = revision;
         }
 
-        public PowerShellVersion(int major, int minor, int patch, string preReleaseLabel)
+        public PowerShellVersion(int major, int minor, int patch, string label)
         {
+            ValidateVersionArguments(major, minor, patch, -1, label);
             Major = major;
             Minor = minor;
             Build = patch;
-            PreReleaseLabel = preReleaseLabel;
+
+            int plusIdx = label?.IndexOf('+') ?? -1;
+            if (plusIdx < 0)
+            {
+                PreReleaseLabel = label;
+            }
+            else
+            {
+                PreReleaseLabel = label.Substring(0, plusIdx);
+                BuildLabel = label.Substring(plusIdx + 1, label.Length - plusIdx - 1);
+            }
         }
 
         public int Major { get; }
@@ -135,25 +170,37 @@ public PowerShellVersion(int major, int minor, int patch, string preReleaseLabel
 
         public int Patch => Build;
 
-        public int? Revision { get; }
+        public int Revision { get; }
 
         public string PreReleaseLabel { get; }
 
-        public bool IsSemVer => Revision == null;
+        public string BuildLabel { get; }
+
+        public bool IsSemVer => Revision < 0;
 
         public override string ToString()
         {
-            if (!IsSemVer)
+            var sb = new StringBuilder(Major);
+
+            if (Minor < 0)
+            {
+                return sb.ToString();
+            }
+
+            sb.Append('.').Append(Minor);
+
+            if (Build < 0)
             {
-                return $"{Major}.{Minor}.{Build}.{Revision}";
+                return sb.ToString();
             }
 
-            var sb = new StringBuilder()
-                .Append(Major).Append('.')
-                .Append(Minor).Append('.')
-                .Append(Patch);
+            sb.Append('.').Append(Build);
 
-            if (!string.IsNullOrEmpty(PreReleaseLabel))
+            if (Revision >= 0)
+            {
+                sb.Append('.').Append(Revision);
+            }
+            else if (PreReleaseLabel != null)
             {
                 sb.Append('-').Append(PreReleaseLabel);
             }
@@ -167,7 +214,6 @@ public class PowerShellVersionJsonConverter : JsonConverter
         public override bool CanConvert(Type objectType)
         {
             return objectType == typeof(PowerShellVersion)
-                || objectType == typeof(Version)
                 || objectType.FullName == "System.Management.Automation.SemanticVersion";
         }
 

CrossCompatibility/CrossCompatibility/Data/Platform/PowerShellData.cs

@@ -16,7 +16,7 @@ public class PowerShellData : ICloneable
         /// From $PSVersionTable.PSVersion.
         /// </summary>
         [DataMember]
-        public string Version { get; set; }
+        public PowerShellVersion Version { get; set; }
 
         /// <summary>
         /// The edition of PowerShell, from

CrossCompatibility/CrossCompatibility/Query/Platform/PowerShellData.cs

@@ -13,7 +13,7 @@ public PowerShellData(PowerShellDataMut powerShellData)
             _powerShellData = powerShellData;
         }
 
-        public string Version => _powerShellData.Version;
+        public PowerShellVersion Version => _powerShellData.Version;
 
         public string Edition => _powerShellData.Edition;
 

CrossCompatibility/Tests/UtilityApi.Tests.ps1

@@ -33,16 +33,19 @@ Describe "PowerShell version object" {
     Context "Version parsing" {
         BeforeAll {
             $genericVerCases = @(
-                @{ VerStr = '6'; Major = 6; Minor = 0; Patch = 0 }
-                @{ VerStr = '6.1'; Major = 6; Minor = 1; Patch = 0 }
+                @{ VerStr = '6'; Major = 6; Minor = -1; Patch = -1 }
+                @{ VerStr = '6.1'; Major = 6; Minor = 1; Patch = -1 }
                 @{ VerStr = '5.2.7'; Major = 5; Minor = 2; Patch = 7 }
                 @{ VerStr = '512.2124.71'; Major = 512; Minor = 2124; Patch = 71 }
             )
 
             $semVerCases = @(
                 @{ VerStr = '6.1.0-rc.1'; Major = 6; Minor = 1; Patch = 0; Label = 'rc.1' }
-                @{ VerStr = '6-preview.2'; Major = 6; Minor = 0; Patch = 0; Label = 'preview.2' }
-                @{ VerStr = '6.2-preview.2'; Major = 6; Minor = 2; Patch = 0; Label = 'preview.2' }
+                @{ VerStr = '6.2-preview.2'; Major = 6; Minor = 2; Patch = -1; Label = 'preview.2' }
+                @{ VerStr = '6-preview.2'; Major = 6; Minor = -1; Patch = -1; Label = 'preview.2' }
+                @{ VerStr = '6.1.0-rc.1+moo'; Major = 6; Minor = 1; Patch = 0; Label = 'rc.1'; BuildLabel = 'moo' }
+                @{ VerStr = '6.2-preview.2+horse'; Major = 6; Minor = 2; Patch = -1; Label = 'preview.2'; BuildLabel = 'horse' }
+                @{ VerStr = '6-preview.2+veryimportant'; Major = 6; Minor = -1; Patch = -1; Label = 'preview.2'; BuildLabel = 'veryimportant' }
             )
 
             $systemVerCases = @(
@@ -73,15 +76,16 @@ Describe "PowerShell version object" {
             $v.Patch | Should -Be $Patch
         }
 
-        It "Parses version string '<VerStr>' as <Major>.<Minor>.<Patch>-<Label>" -TestCases $semVerCases {
-            param([string]$VerStr, [int]$Major, [int]$Minor, [int]$Patch, [string]$Label)
+        It "Parses version string '<VerStr>' as <Major>.<Minor>.<Patch>-<Label>+<BuildLabel>" -TestCases $semVerCases {
+            param([string]$VerStr, [int]$Major, [int]$Minor, [int]$Patch, [string]$Label, $BuildLabel)
 
             $v = [Microsoft.PowerShell.CrossCompatibility.Utility.PowerShellVersion]::Parse($VerStr)
 
             $v.Major | Should -Be $Major
             $v.Minor | Should -Be $Minor
             $v.Patch | Should -Be $Patch
             $v.PreReleaseLabel | Should -BeExactly $Label
+            $v.BuildLabel | Should -Be $BuildLabel
         }
 
         It "Parses version string '<VerStr>' as <Major>.<Minor>.<Patch>.<Revision>" -TestCases $systemVerCases {
@@ -105,7 +109,7 @@ Describe "PowerShell version object" {
     Context "Version creation from other versions" {
         BeforeAll {
             $versionCreationTests = @(
-                @{ Version = '6.1'; Major = 6; Minor = 1; Patch = 0 }
+                @{ Version = '6.1'; Major = 6; Minor = 1; Patch = -1 }
                 @{ Version = '6.1.4'; Major = 6; Minor = 1; Patch = 4; }
                 @{ Version = '5.1.8-preview.2'; Major = 5; Minor = 1; Patch = 8; Label = 'preview.2' }
                 @{ Version = [version]'4.2'; Major = 4; Minor = 2; Patch = -1; Revision = -1 }
@@ -120,6 +124,9 @@ Describe "PowerShell version object" {
                     @{ Version = [semver]'6.1.2-rc.1'; Major = 6; Minor = 1; Patch = 2; Label = 'rc.1' }
                     @{ Version = [semver]'6.1-rc.1'; Major = 6; Minor = 1; Patch = 0; Label = 'rc.1' }
                     @{ Version = [semver]'6-rc.1'; Major = 6; Minor = 0; Patch = 0; Label = 'rc.1' }
+                    @{ Version = [semver]'6.1.2-rc.1+duck'; Major = 6; Minor = 1; Patch = 2; Label = 'rc.1'; BuildLabel = 'duck' }
+                    @{ Version = [semver]'6.1-rc.1+duck'; Major = 6; Minor = 1; Patch = 0; Label = 'rc.1'; BuildLabel = 'duck' }
+                    @{ Version = [semver]'6-rc.1+duck'; Major = 6; Minor = 0; Patch = 0; Label = 'rc.1'; BuildLabel = 'duck' }
                 )
             }
 
@@ -131,14 +138,15 @@ Describe "PowerShell version object" {
         }
 
         It "Creates a PowerShellVersion from '<Version>'" -TestCases $versionCreationTests {
-            param($Version, [int]$Major, [int]$Minor, [int]$Patch, [int]$Revision, $Label)
+            param($Version, [int]$Major, [int]$Minor, [int]$Patch, [int]$Revision, $Label, $BuildLabel)
 
             $v = [Microsoft.PowerShell.CrossCompatibility.Utility.PowerShellVersion]::Create($Version)
 
             $v.Major | Should -Be $Major
             $v.Minor | Should -Be $Minor
             $v.Patch | Should -Be $Patch
             $v.PreReleaseLabel | Should -Be $Label
+            $v.BuildLabel | Should -Be $BuildLabel
 
             if ($Revision)
             {

CrossCompatibility/build.ps1

@@ -7,7 +7,10 @@ param(
     [Parameter()]
     [ValidateSet('netstandard2.0', 'net452')]
     [string]
-    $Framework
+    $Framework,
+
+    [switch]
+    $Test
 )
 
 $ErrorActionPreference = 'Stop'
@@ -101,15 +104,22 @@ function Publish-CrossCompatibilityModule
     }
 }
 
-if (-not $Framework)
+if ($Framework)
+{
+    Invoke-CrossCompatibilityModuleBuild -Configuration $Configuration -Framework $Framework
+    Publish-CrossCompatibilityModule -TargetFramework $Framework
+}
+else
 {
     foreach ($f in $script:TargetFrameworks)
     {
         Invoke-CrossCompatibilityModuleBuild -Framework $f -Configuration $Configuration
     }
     Publish-CrossCompatibilityModule
-    return
 }
 
-Invoke-CrossCompatibilityModuleBuild @PSBoundParameters
-Publish-CrossCompatibilityModule -TargetFramework $Framework
+if ($Test)
+{
+    $testPath = "$PSScriptRoot/Tests"
+    Start-Job { Invoke-Pester -Path $using:testPath  } | Wait-Job | Receive-Job
+}