release 5.1.1 - which adds an assembly for net452

PowerShellStandard.psm1

@@ -1,12 +1,18 @@
 function Start-Build {
+    param ( [switch]$CoreOnly )
     $versions = 3,5
     $srcBase = Join-Path $PsScriptRoot src
     foreach ( $version in $versions ) {
         try {
             $srcDir = Join-Path $srcBase $version
             Push-Location $srcDir
             dotnet restore
-            dotnet build --configuration Release
+            if ( $CoreOnly ) {
+                dotnet build --configuration Release --framework netstandard2.0
+            }
+            else {
+                dotnet build --configuration Release
+            }
         }
         finally {
             Pop-Location
@@ -49,13 +55,40 @@ function Start-Clean {
 }
 
 function Invoke-Test {
+    param ( [switch]$CoreOnly )
+    # first, run the package tests and validate that the signing.xml file is correct
+    try {
+        $testBase = Join-Path $PsScriptRoot test
+        Push-Location $testBase
+        Invoke-Pester -Path ./Build.Tests.ps1
+    }
+    finally {
+        Pop-Location
+    }
     $versions = 3,5
     foreach ( $version in $versions ) {
         try {
             $testBase = Join-Path $PsScriptRoot "test/${version}"
             Push-Location $testBase
-            dotnet build --configuration Release
-            Invoke-Pester
+            foreach ( $framework in "core","full" ) {
+                if ( $CoreOnly -and $framework -eq "full" ) {
+                    continue
+                }
+                try {
+                    Push-Location $framework
+                    if ( $CoreOnly ) {
+                        dotnet build --configuration Release --framework netstandard2.0
+                        Invoke-Pester
+                    }
+                    else {
+                        dotnet build --configuration Release
+                        Invoke-Pester
+                    }
+                }
+                finally {
+                    pop-location
+                }
+            }
         }
         finally {
             Pop-Location

README.md

@@ -65,3 +65,92 @@ To remove all build artifacts (except for the .nuget files in the root of the re
 ```powershell
 ./build.ps1 -Clean
 ```
+
+## How to use the PowerShell Standard Library
+
+### Via Visual Studio
+
+Using the PowerShell Standard Library within Visual Studio is as simple as installing the package into your solution and building the project
+
+Create a project, and in the Package Manager Console (Tools -> Nuget Package Manager -> Package Manager Console) type:
+
+```powershell
+install-package -id PowerShellStandard.Library
+```
+
+This will add `System.Management.Automation` to your project references.
+After this, you must set `Copy Local` to False in the Reference Properties pane.
+
+![Copy Local = False](Images/CopyLocal.png)
+
+This will keep the PowerShell Standard Library from being copied into your release/publish directories.
+This is because the PowerShell Standard Library is a _reference_ assembly and doesn't actually contain any implementations and should never be distributed with your module.
+You may now create and build your module in the usual way.
+
+Once your module is built, you can see the portability of your module very easily, if you have both Windows PowerShell and PowerShell core on your system.
+The following demonstrates the portability of using PowerShell Standard.
+
+The following shows the same assembly being used by both Windows PowerShell, PowerShell Core, and via Docker; PowerShell Core on Linux.
+
+```powershell
+PS> powershell
+Windows PowerShell
+Copyright (C) Microsoft Corporation. All rights reserved.
+
+Loading personal and system profiles took 714ms.
+PS> gci
+
+    Directory: C:\users\jimtru\documents\visual studio 2017\Projects\ClassLibrary2\ClassLibrary2\bin\Debug
+
+Mode                LastWriteTime         Length Name
+----                -------------         ------ ----
+-a----         3/7/2019  10:54 AM           4608 ClassLibrary2.dll
+-a----         3/7/2019  10:54 AM          15872 ClassLibrary2.pdb
+
+PS> import-module .\ClassLibrary2.dll
+PS> "joe","jane" | Invoke-Demo
+Hello 'joe'
+Hello 'jane'
+PS> exit
+
+PS> pwsh-preview
+PowerShell 6.1.0-rc.1
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+https://aka.ms/pscore6-docs
+Type 'help' to get help.
+
+PS> import-module .\ClassLibrary2.dll
+PS> "joe","jane" | Invoke-Demo
+Hello 'joe'
+Hello 'jane'
+PS> exit
+
+PS> $m = "C:\Users\jimtru\DOCUME~1\VIBB41~1\Projects\CLASSL~2\CLASSL~1\bin\Debug"
+PS> docker run --rm -it -v "${m}:/module" mcr.microsoft.com/powershell:preview
+PowerShell 6.2.0-rc.1
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+https://aka.ms/pscore6-docs
+Type 'help' to get help.
+
+PS /> hostname
+add7d6ed4818
+
+PS /> select-string pretty /etc/os-release
+etc/os-release:5:PRETTY_NAME="Ubuntu 18.04.2 LTS"
+
+PS /> gci /module
+    Directory: /module
+Mode                LastWriteTime         Length Name
+----                -------------         ------ ----
+------            3/7/19  6:54 PM           4608 ClassLibrary2.dll
+------            3/7/19  6:54 PM          15872 ClassLibrary2.pdbPS /> import-module /module/ClassLibrary2.dll
+
+PS /> Import-Module /module/ClassLibrary2.dll
+PS /> "joe","jane" | Invoke-Demo
+Hello 'joe'
+Hello 'jane'
+```
+
+And that's how you can build a single module used by Windows PowerShell, PowerShell Core on Windows and Linux!

build.ps1

@@ -1,8 +1,9 @@
 #!/usr/bin/env pwsh
 param ( 
-    [Parameter()][switch]$Clean,
-    [Parameter()][switch]$Test,
-    [Parameter()][switch]$Pack
+    [Parameter(HelpMessage="Remove earlier built versions")][switch]$Clean,
+    [Parameter(HelpMessage="Run the tests")][switch]$Test,
+    [Parameter(HelpMessage="Create a .nupkg")][switch]$Pack,
+    [Parameter(HelpMessage="Build only for netstandard2.0")][switch]$CoreOnly
 )
 
 import-module $PSScriptRoot/PowerShellStandard.psm1 -force
@@ -12,14 +13,25 @@ if ( $Clean ) {
     return
 }
 
+# It would be great if there were targeting frameworks for net452
+# on non-Windows platforms, but for now, if you're linux or macOS
+# we'll build only core
+if ( $IsLinux -or $IsMacOS ) {
+    $CoreOnly = $true
+}
+
 if ( $Pack ) {
+    if ( $CoreOnly ) {
+        Write-Warning "Must build both netstandard2.0 and net452 to build package"
+        throw "Build on a Windows system with netstandard and net452 target platforms"
+    }
     Export-NuGetPackage
 }
 else {
-    Start-Build
+    Start-Build -CoreOnly:$CoreOnly
 }
 
 if ( $Test ) {
-    Invoke-Test
+    Invoke-Test -CoreOnly:$CoreOnly
 }
 

src/3/System.Management.Automation-lib.csproj

@@ -1,6 +1,6 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFramework>netstandard2.0</TargetFramework>
+    <TargetFrameworks>netstandard2.0;net451</TargetFrameworks>
     <SignAssembly>True</SignAssembly>
     <AssemblyOriginatorKeyFile>..\signing\visualstudiopublic.snk</AssemblyOriginatorKeyFile>
     <AssemblyName>System.Management.Automation</AssemblyName>
@@ -10,7 +10,7 @@
     <DefineConstants>RUNTIME_SERIALIZATION</DefineConstants>
     <NuspecFile>./PowershellStandard.Library.nuspec</NuspecFile>
   </PropertyGroup>
-  <ItemGroup>
+  <ItemGroup Condition="'$(TargetFramework)'=='netstandard2.0'" >
     <PackageReference Include="System.IO.FileSystem.AccessControl" Version="4.5.0" />
     <PackageReference Include="System.Security.AccessControl" Version="4.5.0" />
     <PackageReference Include="System.Security.Permissions" Version="4.5.0" />

src/5/PowerShellStandard.Library.nuspec

@@ -2,7 +2,8 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2011/08/nuspec.xsd">
   <metadata>
     <id>PowerShellStandard.Library</id>
-    <version>5.1.0-RC1</version>
+    <version>5.1.1</version>
+    <title>PowerShellStandard.Library</title>
     <authors>Microsoft</authors>
     <owners>Microsoft,PowerShellTeam</owners>
     <projectUrl>https://github.com/PowerShell/PowerShellStandard</projectUrl>
@@ -11,13 +12,16 @@
     <requireLicenseAcceptance>false</requireLicenseAcceptance>
     <description>Contains the reference assemblies for PowerShell Standard 5</description>
     <copyright>© Microsoft Corporation. All rights reserved.</copyright>
-    <tags>PowerShell, reference, netstandard2, netstandard2.0</tags>
+    <tags>PowerShell, reference, net452, netstandard2, netstandard2.0</tags>
     <references>
-      <reference file="System.Management.Automation.dll" />
+      <reference file="System.Management.Automation.dll" >
+        <private>False</private>
+      </reference>
     </references>
   </metadata>
   <files>
     <file src="obj/Release/netstandard2.0/System.Management.Automation.dll" target="lib/netstandard2.0" />
+    <file src="obj/Release/net452/System.Management.Automation.dll" target="lib/net452" />
   </files>
 </package>
 

src/5/System.Management.Automation-lib.csproj

@@ -1,16 +1,16 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
-    <TargetFramework>netstandard2.0</TargetFramework>
+    <TargetFrameworks>netstandard2.0;net452</TargetFrameworks>
     <SignAssembly>True</SignAssembly>
     <AssemblyOriginatorKeyFile>..\signing\visualstudiopublic.snk</AssemblyOriginatorKeyFile>
     <AssemblyName>System.Management.Automation</AssemblyName>
     <AssemblyVersion>3.0.0</AssemblyVersion>
-    <FileVersion>5.1.0</FileVersion>
+    <FileVersion>5.1.1</FileVersion>
     <DelaySign>True</DelaySign>
     <DefineConstants>RUNTIME_SERIALIZATION</DefineConstants>
     <NuspecFile>./PowershellStandard.Library.nuspec</NuspecFile>
   </PropertyGroup>
-  <ItemGroup>
+  <ItemGroup Condition="'$(TargetFramework)'=='netstandard2.0'" >
     <PackageReference Include="System.IO.FileSystem.AccessControl" Version="4.5.0" />
     <PackageReference Include="System.Security.AccessControl" Version="4.5.0" />
     <PackageReference Include="System.Security.Permissions" Version="4.5.0" />

src/dotnetTemplate/Microsoft.PowerShell.Standard.Module.Template/Microsoft.PowerShell.Standard.Module.Template.nuspec

@@ -2,7 +2,7 @@
 <package xmlns="http://schemas.microsoft.com/packaging/2012/06/nuspec.xsd">
   <metadata>
     <id>Microsoft.PowerShell.Standard.Module.Template</id>
-    <version>0.1.3</version>
+    <version>0.1.4</version>
     <title>PowerShell Standard module</title>
     <authors>Microsoft</authors>
     <owners>Microsoft,PowerShellTeam</owners>

src/dotnetTemplate/Microsoft.PowerShell.Standard.Module.Template/Microsoft.PowerShell.Standard.Module.Template/Microsoft.PowerShell.Standard.Module.Template.csproj

@@ -6,7 +6,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="PowerShellStandard.Library" Version="5.1.0-RC1">
+    <PackageReference Include="PowerShellStandard.Library" Version="5.1.1">
       <PrivateAssets>All</PrivateAssets>
     </PackageReference>
 

src/dotnetTemplate/README.md

@@ -95,9 +95,9 @@ PowerShell Standard Module (C#)
 Author: Microsoft Corporation
 Options:
   -v|--powershell-standard-version
-                                        5.1.0-preview-03    - PowerShell Standard 5.1
+                                        5.1.1               - PowerShell Standard 5.1.1
                                         3.0.0-preview-02    - PowerShell Standard 3.0
-                                    Default: 5.1.0-preview-03
+                                    Default: 5.1.1
 
   --no-restore                      If specified, skips the automatic restore of the project on create.
                                     bool - Optional
@@ -132,4 +132,4 @@ This template will create:
 
 * `*.csproj` - a project file that uses the same name as the folder it was created in
 * `TestSampleCmdletCommand.cs` - an example PowerShell cmdlet class
-* `obj` - a folder generated by the restore
+* `obj` - a folder generated by the restore

test/3/PSStandard.csproj → test/3/core/PSStandard.csproj

@@ -6,7 +6,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <ProjectReference Include="../../src/3/System.Management.Automation-lib.csproj" />
+    <ProjectReference Include="../../../src/3/System.Management.Automation-lib.csproj" />
   </ItemGroup>
 
 </Project>

test/3/full/Class1.cs

@@ -0,0 +1,17 @@
+using System;
+using System.Management.Automation;
+
+namespace PSStandard
+{
+    [Cmdlet("get","thing")]
+    public class Class1 : PSCmdlet
+    {
+        [Parameter()]
+        [Credential()]
+        public PSCredential Credential { get; set; }
+
+        protected override void EndProcessing() {
+            WriteObject("Success!");
+        }
+    }
+}

test/3/full/PSS3.Tests.ps1

@@ -0,0 +1,16 @@
+Describe "PowerShell Standard 3" {
+    BeforeAll {
+        $cmdletAssembly = "bin/Release/net452/Demo.Cmdlet.dll" 
+        $assemblyPath = Join-Path "$PSScriptRoot" $cmdletAssembly
+        $PSBin = (Get-Process -id $PID).MainModule.FileName
+    }
+    It "Can build a reference assembly" {
+        dotnet restore
+        dotnet build --configuration Release
+        $assemblyPath | Should Exist
+    }
+    It "Can execute the compiled cmdlet" {
+        $result = & $PSBin -c "import-module $assemblyPath; Get-Thing"
+        $result | Should Be "success!"
+    }
+}

test/3/full/PSStandard.csproj

@@ -0,0 +1,12 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFramework>net452</TargetFramework>
+    <AssemblyName>Demo.Cmdlet</AssemblyName>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="../../../src/3/System.Management.Automation-lib.csproj" />
+  </ItemGroup>
+
+</Project>

test/5/PSStandard.csproj → test/5/core/PSStandard.csproj

@@ -6,7 +6,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <ProjectReference Include="../../src/5/System.Management.Automation-lib.csproj" />
+    <ProjectReference Include="../../../src/5/System.Management.Automation-lib.csproj" />
   </ItemGroup>
 
 </Project>

test/5/full/Class1.cs

@@ -0,0 +1,27 @@
+using System;
+using System.Management.Automation;
+using System.Management.Automation.Runspaces;
+
+namespace PSStandard
+{
+    [Cmdlet("get","thing")]
+    public class Class1 : PSCmdlet
+    {
+        [Parameter()]
+        [Credential()]
+        public PSCredential Credential { get; set; }
+
+        [Parameter()]
+        [ValidateSet("a","b","c")]
+        public string p1 { get; set; }
+
+        protected override void BeginProcessing() {
+            WriteVerbose(Runspace.DefaultRunspace.Name);
+            PSObject p = new PSObject(DateTime.Now);
+            WriteVerbose(p.Properties["DateTime"].ToString());
+        }
+        protected override void EndProcessing() {
+            WriteObject("Success!");
+        }
+    }
+}