Improve cmdlet experience, add rudimentary tests

Author: Robert Holt

PSCompatibilityCollector/Microsoft.PowerShell.CrossCompatibility/Commands/ConvertJsonCommands.cs

@@ -15,14 +15,15 @@ namespace Microsoft.PowerShell.CrossCompatibility.Commands
     /// Turns given .NET objects into JSON strings.
     /// </summary>
     [Cmdlet(VerbsData.ConvertTo, CommandUtilities.MODULE_PREFIX + "Json")]
+    [OutputType(typeof(string))]
     public class ConvertToPSCompatibilityJsonCommand : PSCmdlet
     {
         private JsonProfileSerializer _serializer;
 
         /// <summary>
         /// The object to convert to JSON.
         /// </summary>
-        [Parameter(Mandatory = true, ValueFromPipeline = true)]
+        [Parameter(Position = 0, Mandatory = true, ValueFromPipeline = true)]
         public object[] Item { get; set; }
 
         /// <summary>
@@ -51,15 +52,15 @@ protected override void ProcessRecord()
     /// Class defining the ConvertFrom-PSCompatibilityJson JSON.
     /// Turns given JSON into .NET compatibility profile objects.
     /// </summary>
-    [Cmdlet(VerbsData.ConvertFrom, CommandUtilities.MODULE_PREFIX + "Json")]
+    [Cmdlet(VerbsData.ConvertFrom, CommandUtilities.MODULE_PREFIX + "Json", DefaultParameterSetName = "JsonSource")]
     public class ConvertFromPSCompatibilityJsonCommand : PSCmdlet
     {
         private JsonProfileSerializer _serializer;
 
         /// <summary>
         /// The source of the JSON to convert from. Can be a JSON string, a FileInfo or a TextReader object.
         /// </summary>
-        [Parameter(Mandatory = true, ValueFromPipeline = true, ParameterSetName = "JsonSource")]
+        [Parameter(Position = 0, Mandatory = true, ValueFromPipeline = true, ParameterSetName = "JsonSource")]
         public object[] JsonSource { get; set; }
 
         /// <summary>

PSCompatibilityCollector/Microsoft.PowerShell.CrossCompatibility/Commands/GetPSCompatibilityPlatformDataCommand.cs

@@ -12,6 +12,7 @@ namespace Microsoft.PowerShell.CrossCompatibility.Commands
     /// Assembles an object describing the current platform PowerShell is running on.
     /// </summary>
     [Cmdlet(VerbsCommon.Get, CommandUtilities.MODULE_PREFIX + "PlatformData")]
+    [OutputType(typeof(PlatformData))]
     public class GetPSCompatibilityPlatformDataCommand : Cmdlet
     {
         /// <summary>

PSCompatibilityCollector/Microsoft.PowerShell.CrossCompatibility/Commands/GetPSCompatibilityPlatformNameCommand.cs

@@ -14,6 +14,7 @@ namespace Microsoft.PowerShell.CrossCompatibility.Commands
     /// Gets the canonical profile ID of the current platform PowerShell is executing on.
     /// </summary>
     [Cmdlet(VerbsCommon.Get, CommandUtilities.MODULE_PREFIX + "PlatformName")]
+    [OutputType(typeof(string))]
     public class GetPSCompatibilityPlatformNameCommand : Cmdlet
     {
         /// <summary>

PSCompatibilityCollector/Microsoft.PowerShell.CrossCompatibility/Commands/NewPSCompatibilityProfileCommand.cs

@@ -18,6 +18,7 @@ namespace Microsoft.PowerShell.CrossCompatibility.Commands
     /// Creates a new PowerShell compatibility profile for the current PowerShell session
     /// </summary>
     [Cmdlet(VerbsCommon.New, CommandUtilities.MODULE_PREFIX + "Profile", DefaultParameterSetName = "OutFile")]
+    [OutputType(typeof(CompatibilityProfileData))]
     public class NewPSCompatibilityProfileCommand : PSCmdlet
     {
         /// <summary>
@@ -30,6 +31,7 @@ public class NewPSCompatibilityProfileCommand : PSCmdlet
         /// The path of the profile file to create.
         /// </summary>
         [Parameter(ParameterSetName = "OutFile", Position = 0)]
+        [ValidateNotNullOrEmpty]
         public string OutFile { get; set; }
 
         /// <summary>
@@ -58,6 +60,7 @@ public class NewPSCompatibilityProfileCommand : PSCmdlet
         /// Sets the name of the profile file to be created in the default profile directory.
         /// </summary>
         [Parameter(ParameterSetName = "ProfileName")]
+        [ValidateNotNullOrEmpty]
         public string ProfileName { get; set; }
 
         /// <summary>
@@ -71,13 +74,15 @@ public class NewPSCompatibilityProfileCommand : PSCmdlet
         /// </summary>
         /// <value></value>
         [Parameter]
+        [ValidateNotNullOrEmpty]
         public string[] ExcludeModulePathPrefix { get; set; }
 
         /// <summary>
         /// Assemblies on paths starting with any of these will be excluded.
         /// </summary>
         /// <value></value>
         [Parameter]
+        [ValidateNotNullOrEmpty]
         public string[] ExcludeAssemblyPathPrefix { get; set; }
 
         protected override void EndProcessing()

PSCompatibilityCollector/Tests/Cmdlet.Tests.ps1

@@ -0,0 +1,70 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+
+$script:currentMachineProfile = New-PSCompatibilityProfile -PassThru
+
+Describe "Assert-PSCompatibilityProfileIsValid" {
+    It "Accepts a good profile" {
+        Assert-PSCompatibilityProfileIsValid -CompatibilityProfile $script:currentMachineProfile
+        $? | Should -BeTrue
+    }
+}
+
+Describe "JSON cmdlets" {
+    It "Serializes a compatibility profile to JSON and back again" {
+        $script:currentMachineProfile |
+            ConvertTo-PSCompatibilityJson |
+            ConvertFrom-PSCompatibilityJson |
+            Assert-PSCompatibilityProfileIsValid
+        
+        $? | Should -BeTrue
+    }
+}
+
+Describe "Platform data and naming" {
+    It "Collects platform data properly" {
+        $platformData = Get-PSCompatibilityPlatformData
+
+        $platformData.PowerShell.Version.Major | Should -Be $PSVersionTable.PSVersion.Major
+
+        if ($PSEdition -eq 'Core')
+        {
+            $platformData.Dotnet.Edition | Should -Be 'Core'
+        }
+        else
+        {
+            $platformData.Dotnet.Edition | Should -Be 'Framework'
+        }
+
+        if ($IsLinux)
+        {
+            $platformData.OperatingSystem.Family | Should -Be 'Linux'
+        }
+        elseif ($IsMacOS)
+        {
+            $platformData.OperatingSystem.Family | Should -Be 'MacOS'
+        }
+        else
+        {
+            $platformData.OperatingSystem.Family | Should -Be 'Windows'
+        }
+    }
+
+    It "Names the platform appropriately" {
+        $platformName = Get-PSCompatibilityPlatformName
+
+        $platformNameElements = $platformName -split "_"
+
+        $platformNameElements | Should -HaveCount 6
+    }
+}
+
+Describe "New-PSCompatibilityProfile" {
+    It "Generates a compatibility profile" {
+        $jsonPath = Join-Path $TestDrive "profile.json"
+        New-PSCompatibilityProfile -OutFile $jsonPath
+        $json = ConvertFrom-PSCompatibilityJson -Path $jsonPath
+        Assert-PSCompatibilityProfileIsValid $json
+        $? | Should -BeTrue
+    }
+}