Publish-PSResource Script publishing support

test/PSGetTestUtils.psm1

@@ -315,33 +315,36 @@ function Get-ScriptResourcePublishedToLocalRepoTestDrive
 {
     Param(
         [string]
-        $scriptName
+        $scriptName,
+
+        [string]
+        $scriptRepoName,
+
+        [string]
+        $scriptVersion
     )
     Get-TestDriveSetUp
 
     $scriptFilePath = Join-Path -Path $script:testIndividualResourceFolder -ChildPath "$scriptName.ps1"
     $null = New-Item -Path $scriptFilePath -ItemType File -Force
 
-    $version = "1.0.0"
     $params = @{
-                #Path = $scriptFilePath
-                Version = $version
-                #GUID =
+                Version = $scriptVersion
+                GUID = [guid]::NewGuid()
                 Author = 'Jane'
                 CompanyName = 'Microsoft Corporation'
                 Copyright = '(c) 2020 Microsoft Corporation. All rights reserved.'
                 Description = "Description for the $scriptName script"
                 LicenseUri = "https://$scriptName.com/license"
                 IconUri = "https://$scriptName.com/icon"
                 ProjectUri = "https://$scriptName.com"
-                Tags = @('Tag1','Tag2', "Tag-$scriptName-$version")
+                Tags = @('Tag1','Tag2', "Tag-$scriptName-$scriptVersion")
                 ReleaseNotes = "$scriptName release notes"
                 }
 
     $scriptMetadata = Create-PSScriptMetadata @params
     Set-Content -Path $scriptFilePath -Value $scriptMetadata
-
-    Publish-PSResource -path $scriptFilePath -Repository psgettestlocal
+    Publish-PSResource -Path $scriptFilePath -Repository $scriptRepoName -Verbose
 }
 
 function Get-CommandResourcePublishedToLocalRepoTestDrive
@@ -507,8 +510,6 @@ function Create-PSScriptMetadata
 
 .COPYRIGHT$(if ($Copyright) {" $Copyright"})
 
-.DESCRIPTION$(if ($Description) {" $Description"})
-
 .TAGS$(if ($Tags) {" $Tags"})
 
 .LICENSEURI$(if ($LicenseUri) {" $LicenseUri"})
@@ -528,6 +529,13 @@ $($ReleaseNotes -join "`r`n")
 
 .PRIVATEDATA$(if ($PrivateData) {" $PrivateData"})
 
+#>
+
+<#
+
+.DESCRIPTION
+$(if ($Description) {" $Description"})
+
 #>
 "@
         return $PSScriptInfoString

test/PublishPSResource.Tests.ps1

@@ -41,20 +41,32 @@ Describe "Test Publish-PSResource" {
         $script:destinationPath = [IO.Path]::GetFullPath((Join-Path -Path $TestDrive -ChildPath "tmpDestinationPath"))
         New-Item $script:destinationPath -ItemType directory -Force
 
-        # Path to folder, within our test folder, where we store invalid module files used for testing
+        #Create folder where we shall place all script files to be published for these tests
+        $script:tmpScriptsFolderPath = Join-Path -Path $TestDrive -ChildPath "tmpScriptsPath"
+        if(!(Test-Path $script:tmpScriptsFolderPath))
+        {
+            New-Item -Path $script:tmpScriptsFolderPath -ItemType Directory -Force
+        }
+
+        # Path to folder, within our test folder, where we store invalid module and script files used for testing
         $script:testFilesFolderPath = Join-Path $psscriptroot -ChildPath "testFiles"
+
+        # Path to specifically to that invalid test modules folder
         $script:testModulesFolderPath = Join-Path $testFilesFolderPath -ChildPath "testModules"
+
+        # Path to specifically to that invalid test scripts folder
+        $script:testScriptsFolderPath = Join-Path $testFilesFolderPath -ChildPath "testScripts"
     }
     AfterAll {
-    #    Get-RevertPSResourceRepositoryFile
+       Get-RevertPSResourceRepositoryFile
     }
     AfterEach {
-      # Delete all contents of the repository without deleting the repository directory itself
-     # $pkgsToDelete = Join-Path -Path "$script:repositoryPath" -ChildPath "*"
-     # Remove-Item $pkgsToDelete -Recurse
+        # Delete all contents of the repository without deleting the repository directory itself
+        $pkgsToDelete = Join-Path -Path "$script:repositoryPath" -ChildPath "*"
+        Remove-Item $pkgsToDelete -Recurse
 
-     # $pkgsToDelete = Join-Path -Path "$script:repositoryPath2" -ChildPath "*"
-     # Remove-Item $pkgsToDelete -Recurse
+        $pkgsToDelete = Join-Path -Path "$script:repositoryPath2" -ChildPath "*"
+        Remove-Item $pkgsToDelete -Recurse
     }
 
     It "Publish a module with -Path to the highest priority repo" {
@@ -290,6 +302,98 @@ Describe "Test Publish-PSResource" {
         (Get-ChildItem $script:repositoryPath2).FullName | Should -Be $expectedPath
     }
 
+    It "publish a script locally"{
+        $scriptName = "PSGetTestScript"
+        $scriptVersion = "1.0.0"
+
+        $params = @{
+            Version = $scriptVersion
+            GUID = [guid]::NewGuid()
+            Author = 'Jane'
+            CompanyName = 'Microsoft Corporation'
+            Copyright = '(c) 2020 Microsoft Corporation. All rights reserved.'
+            Description = "Description for the $scriptName script"
+            LicenseUri = "https://$scriptName.com/license"
+            IconUri = "https://$scriptName.com/icon"
+            ProjectUri = "https://$scriptName.com"
+            Tags = @('Tag1','Tag2', "Tag-$scriptName-$scriptVersion")
+            ReleaseNotes = "$scriptName release notes"
+            }
+
+        $scriptPath = (Join-Path -Path $script:tmpScriptsFolderPath -ChildPath "$scriptName.ps1")
+        New-ScriptFileInfo @params -Path $scriptPath
+
+        Publish-PSResource -Path $scriptPath
+
+        $expectedPath = Join-Path -Path $script:repositoryPath  -ChildPath "$scriptName.$scriptVersion.nupkg"
+        (Get-ChildItem $script:repositoryPath).FullName | Should -Be $expectedPath
+    }
+
+    It "should write error and not publish script when Author property is missing" {
+        $scriptName = "InvalidScriptMissingAuthor.ps1"
+        $scriptVersion = "1.0.0"
+
+        $scriptFilePath = Join-Path $script:testScriptsFolderPath -ChildPath $scriptName
+        Publish-PSResource -Path $scriptFilePath -ErrorVariable err -ErrorAction SilentlyContinue
+        $err.Count | Should -Not -Be 0
+        $err[0].FullyQualifiedErrorId | Should -BeExactly "MissingAuthorInScriptMetadata,Microsoft.PowerShell.PowerShellGet.Cmdlets.PublishPSResource"
+
+        $publishedPath = Join-Path -Path $script:repositoryPath  -ChildPath "$scriptName.$scriptVersion.nupkg"
+        Test-Path -Path $publishedPath | Should -Be $false
+    }
+
+    It "should write error and not publish script when Version property is missing" {
+        $scriptName = "InvalidScriptMissingVersion.ps1"
+
+        $scriptFilePath = Join-Path $script:testScriptsFolderPath -ChildPath $scriptName
+        Publish-PSResource -Path $scriptFilePath -ErrorVariable err -ErrorAction SilentlyContinue
+        $err.Count | Should -Not -Be 0
+        $err[0].FullyQualifiedErrorId | Should -BeExactly "MissingVersionInScriptMetadata,Microsoft.PowerShell.PowerShellGet.Cmdlets.PublishPSResource"
+
+        $publishedPkgs = Get-ChildItem -Path $script:repositoryPath -Filter *.nupkg
+        $publishedPkgs.Count | Should -Be 0
+    }
+
+    It "should write error and not publish script when Guid property is missing" {
+        $scriptName = "InvalidScriptMissingGuid.ps1"
+        $scriptVersion = "1.0.0"
+
+        $scriptFilePath = Join-Path $script:testScriptsFolderPath -ChildPath $scriptName
+        Publish-PSResource -Path $scriptFilePath -ErrorVariable err -ErrorAction SilentlyContinue
+        $err.Count | Should -Not -Be 0
+        $err[0].FullyQualifiedErrorId | Should -BeExactly "MissingGuidInScriptMetadata,Microsoft.PowerShell.PowerShellGet.Cmdlets.PublishPSResource"
+
+        $publishedPath = Join-Path -Path $script:repositoryPath  -ChildPath "$scriptName.$scriptVersion.nupkg"
+        Test-Path -Path $publishedPath | Should -Be $false
+    }
+
+    It "should write error and not publish script when Description property is missing" {
+        $scriptName = "InvalidScriptMissingDescription.ps1"
+        $scriptVersion = "1.0.0"
+
+        $scriptFilePath = Join-Path $script:testScriptsFolderPath -ChildPath $scriptName
+        Publish-PSResource -Path $scriptFilePath -ErrorVariable err -ErrorAction SilentlyContinue
+        $err.Count | Should -Not -Be 0
+        $err[0].FullyQualifiedErrorId | Should -BeExactly "MissingOrInvalidDescriptionInScriptMetadata,Microsoft.PowerShell.PowerShellGet.Cmdlets.PublishPSResource"
+
+        $publishedPath = Join-Path -Path $script:repositoryPath  -ChildPath "$scriptName.$scriptVersion.nupkg"
+        Test-Path -Path $publishedPath | Should -Be $false
+    }
+
+    It "should write error and not publish script when Description block altogether is missing" {
+        # we expect .ps1 files to have a separate comment block for .DESCRIPTION property, not to be included in the PSScriptInfo commment block
+        $scriptName = "InvalidScriptMissingDescriptionCommentBlock.ps1"
+        $scriptVersion = "1.0.0"
+
+        $scriptFilePath = Join-Path $script:testScriptsFolderPath -ChildPath $scriptName
+        Publish-PSResource -Path $scriptFilePath -ErrorVariable err -ErrorAction SilentlyContinue
+        $err.Count | Should -Not -Be 0
+        $err[0].FullyQualifiedErrorId | Should -BeExactly "PSScriptMissingHelpContentCommentBlock,Microsoft.PowerShell.PowerShellGet.Cmdlets.PublishPSResource"
+
+        $publishedPath = Join-Path -Path $script:repositoryPath  -ChildPath "$scriptName.$scriptVersion.nupkg"
+        Test-Path -Path $publishedPath | Should -Be $false
+    }
+
     It "Publish a module with that has an invalid version format, should throw" {
         $moduleName = "incorrectmoduleversion"
         $incorrectmoduleversion = Join-Path -Path $script:testModulesFolderPath -ChildPath $moduleName

test/testFiles/testScripts/InvalidScriptMissingAuthor.ps1

@@ -0,0 +1,43 @@
+
+<#PSScriptInfo
+
+.VERSION 1.0
+
+.GUID 3951be04-bd06-4337-8dc3-a620bf539fbd
+
+.AUTHOR
+
+.COMPANYNAME
+
+.COPYRIGHT
+
+.TAGS
+
+.LICENSEURI
+
+.PROJECTURI
+
+.ICONURI
+
+.EXTERNALMODULEDEPENDENCIES 
+
+.REQUIREDSCRIPTS
+
+.EXTERNALSCRIPTDEPENDENCIES
+
+.RELEASENOTES
+
+
+.PRIVATEDATA
+
+#>
+
+<# 
+
+.DESCRIPTION 
+ this is a test for a script that will be published remotely 
+
+#> 
+Param()
+
+

test/testFiles/testScripts/InvalidScriptMissingDescription.ps1

@@ -0,0 +1,42 @@
+
+<#PSScriptInfo
+
+.VERSION 1.0
+
+.GUID 3951be04-bd06-4337-8dc3-a620bf539fbd
+
+.AUTHOR annavied
+
+.COMPANYNAME
+
+.COPYRIGHT
+
+.TAGS
+
+.LICENSEURI
+
+.PROJECTURI
+
+.ICONURI
+
+.EXTERNALMODULEDEPENDENCIES 
+
+.REQUIREDSCRIPTS
+
+.EXTERNALSCRIPTDEPENDENCIES
+
+.RELEASENOTES
+
+
+.PRIVATEDATA
+
+#>
+
+<# 
+
+.DESCRIPTION
+
+#>
+Param()
+
+

test/testFiles/testScripts/InvalidScriptMissingDescriptionCommentBlock.ps1

@@ -0,0 +1,37 @@
+
+<#PSScriptInfo
+
+.VERSION 1.0
+
+.GUID 3951be04-bd06-4337-8dc3-a620bf539fbd
+
+.AUTHOR annavied
+
+.COMPANYNAME
+
+.COPYRIGHT
+
+.TAGS
+
+.LICENSEURI
+
+.PROJECTURI
+
+.ICONURI
+
+.EXTERNALMODULEDEPENDENCIES 
+
+.REQUIREDSCRIPTS
+
+.EXTERNALSCRIPTDEPENDENCIES
+
+.RELEASENOTES
+
+
+.PRIVATEDATA
+
+#>
+
+Param()
+
+

test/testFiles/testScripts/InvalidScriptMissingGuid.ps1

@@ -0,0 +1,43 @@
+
+<#PSScriptInfo
+
+.VERSION 1.0
+
+.GUID
+
+.AUTHOR annavied
+
+.COMPANYNAME
+
+.COPYRIGHT
+
+.TAGS
+
+.LICENSEURI
+
+.PROJECTURI
+
+.ICONURI
+
+.EXTERNALMODULEDEPENDENCIES 
+
+.REQUIREDSCRIPTS
+
+.EXTERNALSCRIPTDEPENDENCIES
+
+.RELEASENOTES
+
+
+.PRIVATEDATA
+
+#>
+
+<# 
+
+.DESCRIPTION 
+ this is a test for a script that will be published remotely 
+
+#> 
+Param()
+
+