Allure Report extension for Azure DevOps

[ciconq]

Hello,

I am currently testing out Allure Report extension for Azure DevOps. I have built a simple .NET 7 based NUnit framework wih a couple of tests which are passing both locally and on the pipeline and I am able to successfully generate and view a report locally via the CLI.

I am having the following configuration for running the tests and publishing the Allure report in the .yml file:

  - task: DotNetCoreCLI@2
    inputs:
      command: 'test'
      projects: '$(solution)'
      arguments: '--configuration $(buildConfiguration)'
      
  - task: PublishAllureReport@1
    displayName: 'Publish Allure report'
    inputs:
      allureVersion: "2.26.0"
      testResultsDir: "$(System.DefaultWorkingDirectory)/$(projectName)/bin/$(buildConfiguration)/net7.0"

Also this is the allureConfig.json that I am using:

{
  "allure": {
    "directory": "allure-results"
  }
}

I can see in the Publish Allure report task that the allure-results folder is successfully created within the specified directory in testResultsDir as no message in logs is thrown that allure-results folder does not exist(as well as debugging via script to check that allure-results is created in testResultsDir) but what I am seeing after the Publish Allure report task is completed(logs within it) is:

Report successfully generated to "$(System.DefaultWorkingDirectory)/RandomUUID"

Not sure if the issue is because of the RandomUUID(assuming allure-report folder) is created within the project root and allure-results is in different folder. I have tried adding several scripts that create allure-results folder within the project root and copying all the contents of the one that is in a different directory to the newly created allure-results folder as well as checking for UUID directories within project root and renaming them to allure-report from which I can see that there is an index.html file(nothing else like data folder and related directories and files when report is generated locally) but still getting the following when trying to open the report once the pipeline has finished:

Would appreciate any suggestions or ideas, thank you for your time and attention!

[epszaw]

Hey there! testResultsDir means the same as directory in your allureConfig.js. The default value of the option is allure-results, so probably, it would be enough to remove the option or change it to $(projectName)/bin/$(buildConfiguration)/net7.0 because the extension works with the path relative to System.DefaultWorkingDirectory

[ciconq]

testResultsDir: D:\\a\\1\\s\\projectName\\bin\\buildConfiguration\\net7.0

reportDir: D:\\a\\1\\s\\RandomUUID

[epszaw]

Could you tell me also, where are test results located in, when you run tests on your local machine?

[ciconq]

Pretty much the same value as testResultsDir only the drive and folder structure up until projectName are different as it is on my local machine and not on an agent(allure-results folder is in net7.0 folder).

[epszaw]

Then try to change testResultsDir to $(System.DefaultWorkingDirectory)/$(projectName)/bin/$(buildConfiguration)/net7.0/allure-results

[ciconq]

Appending allure-results to the given testResultsDir parameter value works, thanks!
Not sure why I didn't try that... guess I got lost in different variations.

Just wondering is there a better way to dynamically structure the testResultsDir parameter value within the .yml file.

Thanks again, appreciate it!

[epszaw]

No problem! Glad to help you :)

[TheChaseBY]

Hi,
is it possible to set the output directory (-o, --report-dir, --output) in the extension? Or how can I add a result.html file to the Build Artifacts to download it later?
As far as I can see the extension does not support "artifactName", "targetPath", "resultsDir", "publishLocation" parameters...

Or do I have to parse this line:
‘Report successfully generated to ‘$(System.DefaultWorkingDirectory)/RandomUUID’"’
to get the value of RandomUUID and the full path to the file?

[nat-krish]

@ciconq i think i need some help. I know that you were successful in getting the allure results output in Azure DevOps after appending the url. However, I am still struggling with overriding the URL that it generates via .yml file. Is it possible for you to share a template of your .yml file?

[ciconq]

It shouldn't be a problem that the bin folder is in .gitignore. Can you try adding the following dir to see if it is working:

$(System.DefaultWorkingDirectory)/projectRootDir/bin/Debug/net6.0/allure-results

[nat-krish]

@ciconq will try it now and will let you know

[nat-krish]

@ciconq unfortunately, it is not able to find the folder. I got $(System.DefaultWorkingDirectory)/projectRoot/bin/Debug/net6.0/allure-results does not exist.

[ciconq]

Maybe try adding this task after the test run one:

  - task: PowerShell@2
    displayName: 'Get allure-results path'
    condition: succeededOrFailed()
    inputs:
      targetType: 'inline'
      script: |
        $selectedFolder = Get-ChildItem -Path $(System.DefaultWorkingDirectory) -Recurse -Filter "allure-results" -Directory | Select-Object -First 1
        Write-Output "Selected folder: $($selectedFolder.FullName)"
        Write-Output "##vso[task.setvariable variable=allureResultsPath]$($selectedFolder.FullName)"

And then for example pass the variable to the publish task:

  - task: PublishAllureReport@1
    displayName: 'Publish allure report'
    condition: succeededOrFailed()
    inputs:
      allureVersion: '2.29.0'
      testResultsDir: '$(allureResultsPath)'

[nat-krish]

@ciconq cool. I will try that and update you tomorrow. Thanks for your help!