fixed single file blob upload (#7222)

* fixed single file blob upload * fixed single file blob upload * fixed L0 * clean target issue + pr comments * pr feedback
microsoft · May 18, 2018 · e193259 · e193259
1 parent cbb1d7e
commit e193259
Show file tree

Hide file tree

Showing 6 changed files with 63 additions and 20 deletions.
diff --git a/Tasks/AzureFileCopyV2/AzureFileCopyRemoteJob.ps1 b/Tasks/AzureFileCopyV2/AzureFileCopyRemoteJob.ps1
@@ -23,6 +23,22 @@ $AzureFileCopyRemoteJob = {
         }
     }
 
+    function Write-LogsAndCleanup
+    {
+        [CmdletBinding()]
+        param(
+            [Nullable[bool]]$isLogsPresent,
+            [AllowEmptyString()][string]$logFilePath,
+            [AllowEmptyString()][string]$azCopyLocation
+        )
+
+        # Print AzCopy.exe verbose logs
+        Get-AzCopyVerboseLogs -isLogsPresent $isLogsPresent -logFilePath $logFilePath -ErrorAction SilentlyContinue
+
+        # Delete AzCopy tool folder
+        Remove-AzCopyFolder -azCopyLocation $azCopyLocation -ErrorAction SilentlyContinue
+    }
+
     function Get-AzCopyVerboseLogs
     {
         [CmdletBinding()]
@@ -51,6 +67,8 @@ $AzureFileCopyRemoteJob = {
 
     try
     {
+        $useDefaultArguments = ($additionalArguments -eq "")
+
         $azCopyToolFileNames = $azCopyToolFileNamesString.Split(";")
         $azCopyToolFileContents = $azCopyToolFileContentsString.Split(";")
 
@@ -72,15 +90,21 @@ $AzureFileCopyRemoteJob = {
 
         if($CleanTargetBeforeCopy)
         {
-            Get-ChildItem -Path $targetPath -Recurse -Force | Remove-Item -Force -Recurse
-            Write-DetailLogs "Destination location cleaned"
+            if (Test-Path $targetPath -PathType Container)
+            {
+                Get-ChildItem -Path $targetPath -Recurse -Force | Remove-Item -Force -Recurse
+                Write-DetailLogs "Destination location cleaned"
+            }
+            else
+            {
+                Write-DetailLogs "Folder at path $targtPath not found for cleanup."
+            }
         }
 
         $azCopyExeLocation = Join-Path -Path $azCopyDestinationPath -ChildPath "AzCopy.exe"
 
         $logFileName = "AzCopyVerbose_" + [guid]::NewGuid() + ".log"
         $logFilePath = Join-Path -Path $azCopyDestinationPath -ChildPath $logFileName
-        $useDefaultArguments = ($additionalArguments -eq "")
 
         if($useDefaultArguments)
         {
@@ -94,9 +118,9 @@ $AzureFileCopyRemoteJob = {
             $additionalArguments = "/Z:`"$azCopyDestinationPath`" /V:`"$logFilePath`" /S /Y"
         }
 
-        Write-DetailLogs "Executing command: & `"$azCopyExeLocation`" /Source:$containerURL /Dest:`"$targetPath`" /SourceSAS:`"*****`" $additionalArguments"
+        Write-DetailLogs "##[command] & `"$azCopyExeLocation`" /Source:`"$containerURL`" /Dest:`"$targetPath`" /SourceSAS:`"*****`" $additionalArguments"
 
-        $azCopyCommand = "& `"$azCopyExeLocation`" /Source:$containerURL /Dest:`"$targetPath`" /SourceSAS:`"$containerSasToken`" $additionalArguments"
+        $azCopyCommand = "& `"$azCopyExeLocation`" /Source:`"$containerURL`" /Dest:`"$targetPath`" /SourceSAS:`"$containerSasToken`" $additionalArguments"
         Invoke-Expression $azCopyCommand
     }
     catch
@@ -106,10 +130,6 @@ $AzureFileCopyRemoteJob = {
     }
     finally
     {
-        # Print AzCopy.exe verbose logs
-        Get-AzCopyVerboseLogs -isLogsPresent $useDefaultArguments -logFilePath $logFilePath -ErrorAction SilentlyContinue
-
-        # Delete AzCopy tool folder
-        Remove-AzCopyFolder -azCopyLocation $azCopyDestinationPath -ErrorAction SilentlyContinue
+        Write-LogsAndCleanup -isLogsPresent $useDefaultArguments -logFilePath "$logFilePath" -azCopyLocation "$azCopyDestinationPath" -ErrorAction SilentlyContinue
     }
 }
diff --git a/Tasks/AzureFileCopyV2/Strings/resources.resjson/en-US/resources.resjson b/Tasks/AzureFileCopyV2/Strings/resources.resjson/en-US/resources.resjson
@@ -37,7 +37,7 @@
   "loc.input.label.TargetPath": "Destination Folder",
   "loc.input.help.TargetPath": "Local path on the target machines for copying the files from the source. Environment variable can be used like $env:windir\\BudgetIT\\Web.",
   "loc.input.label.AdditionalArgumentsForBlobCopy": "Optional Arguments (for uploading files to blob)",
-  "loc.input.help.AdditionalArgumentsForBlobCopy": "Optional AzCopy.exe arguments that will be applied when uploading to blob like, /NC:10. If no optional arguments are specified here, the following optional arguments will be added by default.<br> /Y, /SetContentType, /Z, /V,<br> /S (only if container name is not $root),<br> /BlobType:page (only if specified storage account is a premium account)",
+  "loc.input.help.AdditionalArgumentsForBlobCopy": "Optional AzCopy.exe arguments that will be applied when uploading to blob like, /NC:10. If no optional arguments are specified here, the following optional arguments will be added by default.<br> /Y, /SetContentType, /Z, /V,<br> /S (only if container name is not $root),<br> /BlobType:page (only if specified storage account is a premium account).<br> If source path is a file, /Pattern will always be added irrespective of whether or not you have specified optional arguments.",
   "loc.input.label.AdditionalArgumentsForVMCopy": "Optional Arguments (for downloading files to VM)",
   "loc.input.help.AdditionalArgumentsForVMCopy": "Optional AzCopy.exe arguments that will be applied when downloading to VM like, /NC:10. If no optional arguments are specified here, the following optional arguments will be added by default.<br> /Y, /S, /Z, /V",
   "loc.input.label.enableCopyPrerequisites": "Enable Copy Prerequisites",
@@ -93,5 +93,6 @@
   "loc.messages.AFC_BlobStorageNotFound": "Storage account: {0} not found. Please specify existing storage account",
   "loc.messages.AFC_RootContainerAndDirectory": "'/S' option is not valid for $root containers.",
   "loc.messages.AFC_RedirectResponseInvalidStatusCode": "The HTTP response code: '{0}' is not a valid redirect status code",
-  "loc.messages.AFC_RedirectResponseLocationHeaderIsNull": "Redirect response location header is null."
+  "loc.messages.AFC_RedirectResponseLocationHeaderIsNull": "Redirect response location header is null.",
+  "loc.messages.AFC_AzCopyBlobUploadNonZeroExitCode": "AzCopy.exe exited with non-zero exit code while uploading files to blob storage."
 }
diff --git a/Tasks/AzureFileCopyV2/Tests/L0UploadFilesToAzureContainer.ps1 b/Tasks/AzureFileCopyV2/Tests/L0UploadFilesToAzureContainer.ps1
@@ -9,6 +9,7 @@ $invalidInputStorageAccount = "invalidInputStorageAccount"
 $exceptionMessage = "Exception thrown"
 
 Register-Mock Write-Telemetry { }
+Register-Mock Test-Path { return $false }
 
 # Test 1 "Should throw if Invoke-Expression fails"
 Register-Mock Invoke-Expression { throw $exceptionMessage }
@@ -31,6 +32,7 @@ Assert-WasCalled Remove-AzureContainer -Times 1
 # Test 3 "Success in Upload blob destination"
 Unregister-Mock Invoke-Expression
 Register-Mock Invoke-Expression { return $succeededCopyResponse }
+$LASTEXITCODE = 0
 
 Upload-FilesToAzureContainer -sourcePath $validInputSourcePath -storageAccountName $validInputStorageAccount -containerName $validInputContainerName `
                              -blobPrefix $validInputBlobPrefix -storageKey $validStorageKey -azCopyLocation $validAzCopyLocation -destinationType $validInputAzureBlobDestinationType

diff --git a/Tasks/AzureFileCopyV2/Utility.ps1 b/Tasks/AzureFileCopyV2/Utility.ps1
@@ -247,16 +247,34 @@ function Upload-FilesToAzureContainer
     {
         Write-Output (Get-VstsLocString -Key "AFC_UploadFilesStorageAccount" -ArgumentList $sourcePath, $storageAccountName, $containerName, $blobPrefix)
 
+        $resolvedSourcePath = $sourcePath
+
+        # Check if source path is a file. If yes, then add /Pattern additional argument.
+        if(Test-Path -Path $sourcePath -PathType Leaf)
+        {
+            $fileInfo = Get-Item $sourcePath
+            $resolvedSourcePath = $fileInfo.Directory.FullName
+            $additionalArguments += " /Pattern:`"$($fileInfo.Name)`""
+        }
+
         $blobPrefix = $blobPrefix.Trim()
         $containerURL = [string]::Format("{0}/{1}/{2}", $blobStorageEndpoint.Trim("/"), $containerName, $blobPrefix).Trim("/")
         $azCopyExeLocation = Join-Path -Path $azCopyLocation -ChildPath "AzCopy.exe"
 
-        Write-Verbose "Executing command: & `"$azCopyExeLocation`" /Source:$sourcePath /Dest:$containerURL /DestKey:`"*****`" $additionalArguments"
+        Write-Output "##[command] & `"$azCopyExeLocation`" /Source:`"$resolvedSourcePath`" /Dest:`"$containerURL`" /DestKey:`"*****`" $additionalArguments"
 
-        $uploadToBlobCommand = "& `"$azCopyExeLocation`" /Source:$sourcePath /Dest:$containerURL /DestKey:`"$storageKey`" $additionalArguments"
+        $uploadToBlobCommand = "& `"$azCopyExeLocation`" /Source:`"$resolvedSourcePath`" /Dest:`"$containerURL`" /DestKey:`"$storageKey`" $additionalArguments"
 
         Invoke-Expression $uploadToBlobCommand
-        Write-Output (Get-VstsLocString -Key "AFC_UploadFileSuccessful" -ArgumentList $sourcePath, $storageAccountName, $containerName, $blobPrefix)
+
+        if($LASTEXITCODE -eq 0)
+        {
+            Write-Output (Get-VstsLocString -Key "AFC_UploadFileSuccessful" -ArgumentList $sourcePath, $storageAccountName, $containerName, $blobPrefix)
+        }
+        else
+        {
+            throw (Get-VstsLocString -Key "AFC_AzCopyBlobUploadNonZeroExitCode")
+        }
     }
     catch
     {
@@ -283,8 +301,8 @@ function Handle-AzCopyLogs
 {
     [CmdletBinding()]
     param(
-        [bool]$isLogsPresent,
-        [string]$logsFilePath
+        [Nullable[bool]]$isLogsPresent,
+        [AllowEmptyString()][string]$logsFilePath
     )
 
     if($isLogsPresent)

diff --git a/Tasks/AzureFileCopyV2/task.json b/Tasks/AzureFileCopyV2/task.json
@@ -207,7 +207,7 @@
             "label": "Optional Arguments (for uploading files to blob)",
             "required": false,
             "defaultValue": "",
-            "helpMarkDown": "Optional AzCopy.exe arguments that will be applied when uploading to blob like, /NC:10. If no optional arguments are specified here, the following optional arguments will be added by default.<br> /Y, /SetContentType, /Z, /V,<br> /S (only if container name is not $root),<br> /BlobType:page (only if specified storage account is a premium account)"
+            "helpMarkDown": "Optional AzCopy.exe arguments that will be applied when uploading to blob like, /NC:10. If no optional arguments are specified here, the following optional arguments will be added by default.<br> /Y, /SetContentType, /Z, /V,<br> /S (only if container name is not $root),<br> /BlobType:page (only if specified storage account is a premium account).<br> If source path is a file, /Pattern will always be added irrespective of whether or not you have specified optional arguments."
         },
         {
             "name": "AdditionalArgumentsForVMCopy",
@@ -344,6 +344,7 @@
         "AFC_BlobStorageNotFound": "Storage account: {0} not found. Please specify existing storage account",
         "AFC_RootContainerAndDirectory": "'/S' option is not valid for $root containers.",
         "AFC_RedirectResponseInvalidStatusCode": "The HTTP response code: '{0}' is not a valid redirect status code",
-        "AFC_RedirectResponseLocationHeaderIsNull": "Redirect response location header is null."
+        "AFC_RedirectResponseLocationHeaderIsNull": "Redirect response location header is null.",
+        "AFC_AzCopyBlobUploadNonZeroExitCode": "AzCopy.exe exited with non-zero exit code while uploading files to blob storage."
     }
 }
diff --git a/Tasks/AzureFileCopyV2/task.loc.json b/Tasks/AzureFileCopyV2/task.loc.json
@@ -358,6 +358,7 @@
     "AFC_BlobStorageNotFound": "ms-resource:loc.messages.AFC_BlobStorageNotFound",
     "AFC_RootContainerAndDirectory": "ms-resource:loc.messages.AFC_RootContainerAndDirectory",
     "AFC_RedirectResponseInvalidStatusCode": "ms-resource:loc.messages.AFC_RedirectResponseInvalidStatusCode",
-    "AFC_RedirectResponseLocationHeaderIsNull": "ms-resource:loc.messages.AFC_RedirectResponseLocationHeaderIsNull"
+    "AFC_RedirectResponseLocationHeaderIsNull": "ms-resource:loc.messages.AFC_RedirectResponseLocationHeaderIsNull",
+    "AFC_AzCopyBlobUploadNonZeroExitCode": "ms-resource:loc.messages.AFC_AzCopyBlobUploadNonZeroExitCode"
   }
 }