Extract files: to process "no files were found" warning

Question

How do you handle cases when the Extract files task does not find files to extract ?

Is it possible to set the Extract files task to fail if there were no files extracted ? Here is a sample task

steps:
- task: ExtractFiles@1
  displayName: 'Extract files '
  inputs:
    archiveFilePatterns: '$(System.ArtifactsDirectory)\*.zip'
    destinationFolder: '$(System.ArtifactsDirectory)\bin'

it does not fail if no file was found however

2020-10-01T14:25:23.1175947Z Searching for: *.zip under directory: E:\ba\n1_work\r16\a
2020-10-01T14:25:23.1287445Z Found: 0 files to extract:

and then a ftp upload task does nothing

2020-10-01T14:25:36.4142531Z ##[warning]Could not find any files to upload

The release pipeline is simple like

• extract files
• stop azure app service
• upload files by ftp
• start azure app service

I've added the powershell script to check for files were extracted

if (-not (Test-path $(System.ArtifactsDirectory)\bin\*) )
{
Throw New-Object System.ArgumentException("no files were extracted")
}

but would like to know is it possible to make ExtractFiles@1 or FtpUpload@2 tasks to fail if there was nothing extracted or uploaded ?

Regards

Answer 1

There is no easy way to do this as the task doesn't support such case. (So please consider adding feature request on github). Howeer you can use REST API call to get logs analyze them and throw exception when there is no files. It could look like this:

variables:
  devopsAccount : 'thecodemanual'
  projectName : 'DevOps Manual'
  logId: "6"


steps:
- task: ExtractFiles@1
  displayName: 'Extract files '
  inputs:
    archiveFilePatterns: '$(System.ArtifactsDirectory)\*.zip'
    destinationFolder: '$(System.ArtifactsDirectory)\bin'

- task: PowerShell@2
  name: testDetails
  condition: always()
  inputs:
    targetType: 'inline'
    script: |
        # Encode the Personal Access Token (PAT)
        $AzureDevOpsAuthenicationHeader = @{Authorization = 'Basic ' + [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes(":$(System.AccessToken)")) }

        # Get a list of releases
        $uri = "https://dev.azure.com/$(devopsAccount)/$(projectName)/_apis/build/builds/$(Build.BuildId)/logs/$(logId)?api-version=5.1"

        Write-Host $uri

        # Invoke the REST call
        $result = Invoke-RestMethod -Uri $uri -Method Get -Headers $AzureDevOpsAuthenicationHeader

        Write-Host $result

        $lines = $result.Split([Environment]::NewLine)

        $passed = 0;
        $failed = 0;

        foreach($line in $lines) {
            if ($line -match "Found: 0 files to extract") { 
              throw 'There is no files to extract'

            }
        }

Log id in my case is 6 because Azure DevOps adds 5 steps before running first task from the list.

Answer 2

The task ExtractFiles@1 or FtpUpload@2 code is open source on GitHub, we can download it and update the .ts file then Publish it to Visual Studio Marketplace.

For example, make the task FtpUpload@2 to fail if there was nothing uploaded.

2020-10-01T14:25:36.4142531Z ##[warning]Could not find any files to upload

This warning message is defined NoFilesFound in the task.json file and then called in the file ftpuploadtask.ts via this code tl.warning(tl.loc("NoFilesFound"));.

We can change the code to tl.setResult(tl.TaskResult.Failed, tl.loc("NoFilesFound")); Then we can see the error message in the task instead of warning message, and the task result will show failed.

We can do the same things for the task ExtractFiles@1

Answer 3

There are other tasks that are available in the marketplace you can use to unzip the package. You can try using Unzip Task or Zip and unzip directory build task in stead of using Extract files task.

I tested with Unzip Task and Zip and unzip directory build task. They both work greatly and failed as expected when no file is found to unzip. See below

And for FTP upload, you can check out FTP Uploader task.