Merge pull request #331 from X-Guardian/Test-PublishMetaData-Guid-Update

Test-PublishMetadata: Add Processing for InvalidGUID Error from Test-ScriptFileInfo

Author: PlagueHO

CHANGELOG.md

@@ -56,6 +56,8 @@
   to the relevant DSC resource GitHub Wiki ([issue #142](https://github.com/PowerShell/DscResource.Tests/issues/142)).
 - Update New-DscResourcePowerShellHelp to output the PowerShell help files to
   the resource specific path and fix the example processing.
+- Added processing to `Test-PublishMetaData` for the InvalidGUID error from Test-ScriptFileInfo
+  ([issue #330](https://github.com/PowerShell/DscResource.Tests/issues/330)).
 
 ## 0.3.0.0
 

DscResource.GalleryDeploy/DscResource.GalleryDeploy.psm1

@@ -289,10 +289,16 @@ function Test-PublishMetadata
                         $skipWarningMessage, ($script:localizedData.MissingRequiredMetadataProperties -f $errorMessage))
             }
 
+            'InvalidGuid,Test-ScriptFileInfo'
+            {
+                Write-Warning -Message ('{0} {1}' -f `
+                        $skipWarningMessage, ($script:localizedData.InvalidGuid -f $errorMessage))
+            }
+
             default
             {
                 # If the error is not recognized then throw.
-                throw $_
+                throw ($script:localizedData.TestScriptFileInfoError -f $Path, $_)
             }
         }
     }

DscResource.GalleryDeploy/en-US/DscResource.GalleryDeploy.strings.psd1

@@ -1,18 +1,20 @@
 ConvertFrom-StringData @'
 # English strings
-CannotPublish = Cannot publish to PowerShell Gallery.
-FoundApiKey = Found API key to use for publishing to the PowerShell Gallery.
-MissingApiKey = Missing API key in $env:gallery_api.
-EvaluatingExamples = Evaluating examples that end with 'Config' if they need publishing.
-NotOnMasterBranch = Not running against the branch 'master'. Will run Publish-Script with parameter WhatIf.
-MissingExampleValidationOptIn = Examples will not publish unless repository has opt-in for example validation. To opt-in, create a '.MetaTestOptIn.json' at the root of the repo in the following format: ["{0}"]
-SkipPublish = Skipping publishing example '{0}'.
-ScriptParseError = The example could not be read, for example if there is a required module missing when the script should be parsed, or general script parsing errors. General errors should have been caught with the common example validation test. Error: {0}
-MissingMetadata = The example has not opt-in by adding script metadata to the example. Error: {0}
+CannotPublish                     = Cannot publish to PowerShell Gallery.
+FoundApiKey                       = Found API key to use for publishing to the PowerShell Gallery.
+MissingApiKey                     = Missing API key in $env:gallery_api.
+EvaluatingExamples                = Evaluating examples that end with 'Config' if they need publishing.
+NotOnMasterBranch                 = Not running against the branch 'master'. Will run Publish-Script with parameter WhatIf.
+MissingExampleValidationOptIn     = Examples will not publish unless repository has opt-in for example validation. To opt-in, create a '.MetaTestOptIn.json' at the root of the repo in the following format: ["{0}"]
+SkipPublish                       = Skipping publishing example '{0}'.
+TestScriptFileInfoError           = Error testing example '{0}'. {1}.
+ScriptParseError                  = The example could not be read, for example if there is a required module missing when the script should be parsed, or general script parsing errors. General errors should have been caught with the common example validation test. Error: {0}
+MissingMetadata                   = The example has not opt-in by adding script metadata to the example. Error: {0}
 MissingRequiredMetadataProperties = The example is missing needed metadata properties. This can also happen if code is checked out with just LF instead of CRLF (make sure core.autocrlf is set to true). Error: {0}
-ConfigurationNameMismatch = The configuration name and the file name are not the same, or the name does not contain only letters, numbers, and underscores. The name must also start with a letter, and it must end with a letter or a number.
-AddingExampleToBePublished = Adding the example '{0}' to the list to be published.
-DuplicateGuid = Skipping examples that was found having the same GUID. Duplicate examples: '{0}'.
-ExampleIsAlreadyPublished = The example '{0}' is already published (same version).
-PublishExample = The example '{0}' with version '{1}' is being published as '{2}'.
+InvalidGuid                       = The example has an invalid GUID. The format must be [XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX] where X is a hex digit (0,1,2,3,4,5,6,7,8,9,A,B,C,D,E,F). Error: {0}
+ConfigurationNameMismatch         = The configuration name and the file name are not the same, or the name does not contain only letters, numbers, and underscores. The name must also start with a letter, and it must end with a letter or a number.
+AddingExampleToBePublished        = Adding the example '{0}' to the list to be published.
+DuplicateGuid                     = Skipping examples that was found having the same GUID. Duplicate examples: '{0}'.
+ExampleIsAlreadyPublished         = The example '{0}' is already published (same version).
+PublishExample                    = The example '{0}' with version '{1}' is being published as '{2}'.
 '@

Tests/Unit/DscResource.GalleryDeploy.Tests.ps1

@@ -601,6 +601,37 @@ InModuleScope -ModuleName 'DscResource.GalleryDeploy' {
             }
         }
 
+        Context 'When a script file has an invalid GUID in its metadata' {
+            BeforeAll {
+                Mock -CommandName Write-Warning
+
+                $errorMessage = 'Cannot convert value ''a18e0a9-2a4b-4406-939e-ac2bb7b6e917'' to type ''System.Guid'''
+
+                Mock -CommandName Test-ScriptFileInfo -MockWith {
+                    $getInvalidArgumentRecordParameters = @{
+                        Message      = $errorMessage
+                        # This is the FullyQualifiedErrorId
+                        ArgumentName = 'InvalidGuid,Test-ScriptFileInfo'
+                    }
+
+                    throw Get-InvalidArgumentRecord @getInvalidArgumentRecordParameters
+                }
+            }
+
+            It 'Should call the correct mocks and return the correct warning message' {
+                { Test-PublishMetadata -Path $TestDrive } | Should -Not -Throw
+
+                Assert-MockCalled -CommandName Test-ScriptFileInfo -Exactly -Times 1 -Scope It
+
+                $warningMessage = $script:localizedData.InvalidGuid -f $errorMessage
+
+                Assert-MockCalled -CommandName Write-Warning -ParameterFilter {
+                    $Message -match ($script:localizedData.SkipPublish -f ($TestDrive -replace '\\','\\')) `
+                    -and $Message -match [Regex]::Escape($warningMessage)
+                } -Exactly -Times 1 -Scope It
+            }
+        }
+
         Context 'When cmdlet Test-ScriptFileInfo throws an unknown error' {
             BeforeAll {
                 $throwMessage = 'Unknown error'
@@ -612,7 +643,8 @@ InModuleScope -ModuleName 'DscResource.GalleryDeploy' {
             }
 
             It 'Should throw the correct error message' {
-                { Test-PublishMetadata -Path $TestDrive } | Should -Throw $throwMessage
+                $errorMessage = $script:localizedData.TestScriptFileInfoError -f $TestDrive, $throwMessage
+                { Test-PublishMetadata -Path $TestDrive } | Should -Throw $errorMessage
 
                 Assert-MockCalled -CommandName Test-ScriptFileInfo -Exactly -Times 1 -Scope It
             }