Add tests

Author: Gijsreyn

dsc/examples/variable.dsc.ps1

@@ -0,0 +1,13 @@
+configuration VariableConfiguration {
+    Import-DscResource -ModuleName PSDesiredStateConfiguration
+    Node localhost
+    {
+        Environment PathEnvironmentVariable {
+            Name   = 'TestPathEnvironmentVariable'
+            Value  = 'TestValue'
+            Ensure = 'Present'
+            Path   = $true
+            Target = @('Process')
+        }
+    }
+}

extensions/powershell/convert-resource.ps1

@@ -19,7 +19,7 @@ process {
 end {
     if ($lines.Count -ne 0) {
         $result = $scriptModule.invoke( { param($lines) Build-DscConfigDocument -Content $lines }, ($lines | Out-String) )
-
+        
         return ($result | ConvertTo-Json -Depth 10 -Compress)
     }
 }

extensions/powershell/convertDscResource.psm1

@@ -1,3 +1,14 @@
+$Script:IsPowerShellCore = $PSVersionTable.PSEdition -eq 'Core'
+
+if ($Script:IsPowerShellCore)
+{
+    if ($IsWindows)
+    {
+        Import-Module -Name 'PSDesiredStateConfiguration' -RequiredVersion 1.1 -UseWindowsPowerShell -WarningAction SilentlyContinue
+    }
+    Import-Module -Name 'PSDesiredStateConfiguration' -MinimumVersion 2.0.7 -Prefix 'Pwsh'
+}
+
 function Write-DscTrace {
     param(
         [Parameter(Mandatory = $false)]
@@ -178,11 +189,11 @@ function ConvertTo-DscObject
 
         if ($null -eq $loadedModuleTest -and -not [System.String]::IsNullOrEmpty($moduleToLoad.ModuleVersion))
         {
-            throw "Module {$($moduleToLoad.ModuleName)} version {$($moduleToLoad.ModuleVersion)} specified in the configuration isn't installed on the machine/agent. Install it by running: Install-Module -Name '$($moduleToLoad.ModuleName)' -RequiredVersion '$($moduleToLoad.ModuleVersion)'"
+            "Module {$($moduleToLoad.ModuleName)} version {$($moduleToLoad.ModuleVersion)} specified in the configuration isn't installed on the machine/agent. Install it by running: Install-Module -Name '$($moduleToLoad.ModuleName)' -RequiredVersion '$($moduleToLoad.ModuleVersion)'" | Write-DscTrace -Operation Error
+            exit 1
         }
         else
         {
-            "Retrieving module: '$($moduleToLoad.ModuleName)'" | Write-DscTrace -Operation Debug
             if ($Script:IsPowerShellCore)
             {
                 $currentResources = Get-PwshDscResource -Module $moduleToLoad.ModuleName
@@ -200,6 +211,12 @@ function ConvertTo-DscObject
         }
     }
 
+    if ($DSCResources.Count -eq 0)
+    {
+        "No DSC resources found in the imported modules." | Write-DscTrace -Operation Error
+        exit 1
+    }
+
     # Drill down
     # Body.ScriptBlock is the part after "Configuration <InstanceName> {"
     # EndBlock is the actual code within that Configuration block
@@ -310,7 +327,6 @@ function ConvertTo-DscObject
             if ($null -eq $valueType)
             {
                 $propertyFound = $false
-                "Defined property {$key} was not found in resource {$resourceType}" | Write-DscTrace -Operation Warn
             }
 
             if ($propertyFound)

extensions/powershell/powershell.dsc.extension.json

@@ -13,10 +13,11 @@
             "-ExecutionPolicy",
             "Bypass",
             "-Command",
+            "Get-Content",
             {
-                "fileArg": "Get-Content"
+                "fileArg": ""
             },
-            "$args | ./convert-resource.ps1 $args"
+            "| ./convert-resource.ps1"
         ]
     }
 }

extensions/powershell/powershell.tests.ps1

@@ -0,0 +1,41 @@
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+
+BeforeDiscovery {
+    if ($IsWindows) {
+        $identity = [System.Security.Principal.WindowsIdentity]::GetCurrent()
+        $principal = [System.Security.Principal.WindowsPrincipal]::new($identity)
+        $isElevated = $principal.IsInRole([System.Security.Principal.WindowsBuiltInRole]::Administrator)
+    }
+}
+
+Describe 'PowerShell extension tests' {
+    It 'Example PowerShell file should work' -Skip:(!$isElevated) {
+        $psFile = Resolve-Path -Path "$PSScriptRoot\..\..\dsc\examples\variable.dsc.ps1"
+        $out = dsc -l trace config get -f $psFile 2>$TestDrive/error.log | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 0 -Because (Get-Content -Path $TestDrive/error.log -Raw | Out-String)
+        $out.results[0].result.actualState.Ensure | Should -Be 'Absent'
+        (Get-Content -Path $TestDrive/error.log -Raw) | Should -Match "Importing file '$psFile' with extension 'Microsoft.DSC.Extension/PowerShell'"
+    }
+
+    It 'Invalid PowerShell configuration document file returns error' {
+        $psFile = "$TestDrive/invalid.ps1"
+        Set-Content -Path $psFile -Value @"
+configuration InvalidConfiguration {
+    Import-DscResource -ModuleName InvalidModule
+    Node localhost
+    {
+        Test Invalid {
+            Name = 'InvalidTest'
+            Ensure = 'Present'
+        }
+    }
+}
+"@
+        $out = dsc -l trace config get -f $psFile 2>$TestDrive/error.log | ConvertFrom-Json
+        $LASTEXITCODE | Should -Be 2 -Because (Get-Content -Path $TestDrive/error.log -Raw | Out-String)
+        $content = (Get-Content -Path $TestDrive/error.log -Raw)
+        $content | Should -BeLike "*Importing file '$psFile' with extension 'Microsoft.DSC.Extension/PowerShell'*"
+        $content | Should -Match "No DSC resources found in the imported modules."
+    }
+}