Merge pull request #48 from mgr32/dev

Added MatchSource parameter to xRemoteFile. Fixes #45

Author: KarolKaczmarek

DSCResources/MSFT_xRemoteFile/MSFT_xRemoteFile.psm1

@@ -100,7 +100,11 @@ function Set-TargetResource
         $Headers,
 
         [System.Management.Automation.PSCredential]
-        $Credential
+        $Credential,
+
+        [parameter(Mandatory = $false)]
+        [System.Boolean]
+        $MatchSource = $true
     )
 
     # Validate Uri
@@ -154,8 +158,9 @@ function Set-TargetResource
         $DestinationPath = Join-Path $DestinationPath $uriFileName        
     }
 
-    # Remove DestinationPath from parameters as it is not parameter of Invoke-WebRequest
+    # Remove DestinationPath and MatchSource from parameters as they are not parameters of Invoke-WebRequest
     $PSBoundParameters.Remove("DestinationPath") | Out-Null;
+    $PSBoundParameters.Remove("MatchSource") | Out-Null;
 
     # Convert headers to hashtable
     $PSBoundParameters.Remove("Headers") | Out-Null;
@@ -216,7 +221,11 @@ function Test-TargetResource
         $Headers,
 
         [System.Management.Automation.PSCredential]
-        $Credential
+        $Credential,
+
+        [parameter(Mandatory = $false)]
+        [System.Boolean]
+        $MatchSource = $true
     )
 
     # Check whether DestinationPath points to existing file or directory
@@ -228,37 +237,47 @@ function Test-TargetResource
         "File" {
             Write-Debug "DestinationPath: '$DestinationPath' is existing file on the machine"
 
-            $file = Get-Item $DestinationPath
-            # Getting cache. It's cleared every time user runs Start-DscConfiguration
-            $cache = Get-Cache -DestinationPath $DestinationPath -Uri $Uri
+            if ($MatchSource) {           
+                $file = Get-Item $DestinationPath
+                # Getting cache. It's cleared every time user runs Start-DscConfiguration
+                $cache = Get-Cache -DestinationPath $DestinationPath -Uri $Uri
 
-            if ($cache -ne $null -and ($cache.LastWriteTime -eq $file.LastWriteTimeUtc))
-            {
-                Write-Debug "Cache reflects current state. No need for downloading file."
-                $fileExists = $true
+                if ($cache -ne $null -and ($cache.LastWriteTime -eq $file.LastWriteTimeUtc))
+                {
+                    Write-Debug "Cache reflects current state. No need for downloading file."
+                    $fileExists = $true
+                }
+                else
+                {
+                    Write-Debug "Cache is empty or it doesn't reflect current state. File will be downloaded."
+                }
+            } else {
+                Write-Debug "MatchSource is false. No need for downloading file."
+                $fileExists = $true 
             }
-            else
-            {
-                Write-Debug "Cache is empty or it doesn't reflect current state. File will be downloaded."
-            }              
         }
 
         "Directory" {
             Write-Debug "DestinationPath: '$DestinationPath' is existing directory on the machine"
             $expectedDestinationPath = Join-Path $DestinationPath $uriFileName
 
             if (Test-Path $expectedDestinationPath) {
-                $file = Get-Item $expectedDestinationPath
-                $cache = Get-Cache -DestinationPath $expectedDestinationPath -Uri $Uri
-                if ($cache -ne $null -and ($cache.LastWriteTime -eq $file.LastWriteTimeUtc))
-                {
-                    Write-Debug "Cache reflects current state. No need for downloading file."
+                if ($MatchSource) { 
+                    $file = Get-Item $expectedDestinationPath
+                    $cache = Get-Cache -DestinationPath $expectedDestinationPath -Uri $Uri
+                    if ($cache -ne $null -and ($cache.LastWriteTime -eq $file.LastWriteTimeUtc))
+                    {
+                        Write-Debug "Cache reflects current state. No need for downloading file."
+                        $fileExists = $true
+                    }
+                    else
+                    {
+                        Write-Debug "Cache is empty or it doesn't reflect current state. File will be downloaded."
+                    }
+                } else {
+                    Write-Debug "MatchSource is false. No need for downloading file."
                     $fileExists = $true
                 }
-                else
-                {
-                    Write-Debug "Cache is empty or it doesn't reflect current state. File will be downloaded."
-                }
             }    
         }
 

DSCResources/MSFT_xRemoteFile/MSFT_xRemoteFile.schema.mof

@@ -7,6 +7,7 @@ class MSFT_xRemoteFile : OMI_BaseResource
     [Write, Description("User agent for the web request.")] String UserAgent;
     [Write, EmbeddedInstance("MSFT_KeyValuePair"), Description("Headers of the web request.")] String Headers[];
     [Write, EmbeddedInstance("MSFT_Credential"), Description("Specifies a user account that has permission to send the request.")] String Credential;
+    [Write, Description("A boolean value to indicate whether the remote file should be re-downloaded if file in the DestinationPath was modified locally.")] Boolean MatchSource;
       [Read, ValueMap{"Present", "Absent"}, Values{"Present", "Absent"}, Description("Says whether DestinationPath exists on the machine")] String Ensure;
 };
 

README.md

@@ -68,6 +68,7 @@ For a complete list of properties, please use Get-DscResource
 * **UserAgent**: User agent for the web request.
 * **Headers**: Headers of the web request.
 * **Credential**: Specifies credential of a user which has permissions to send the request.
+* **MatchSource**: Determines whether the remote file should be re-downloaded if file in the DestinationPath was modified locally.
 * **Ensure**: Says whether DestinationPath exists on the machine. It's a read only property.
 
 ### xPackage
@@ -136,6 +137,7 @@ Domain members may be specified using domain\name or Universal Principal Name (U
 ### Unreleased
 
 * Added CreateCheckRegValue parameter to xPackage resource
+* Added MatchSource parameter to xRemoteFile resource
 
 ### 3.5.0.0