xcresults: metadata support

[maxibello]

Hello!

I have a question about custom metadata support in xcresults export to Allure 2 format.

Context:

• I am running iOS UI tests with XCTest and generating attachments in each test using XCTAttachment.
• I use names like allure.label.MyLabel or allure.environment.os for these attachments, hoping they will be mapped to Allure labels or environment fields in the resulting *-result.json files.

What I see:

• After running xcresults export ..., all my attachments appear in the "attachments" section of the test in Allure, but they do not appear as labels or environment fields in the Allure report or in the labels/parameters sections of the result JSON.

Question:

• Is there a way to make xcresults map certain attachments (by name or type) to Allure labels or environment fields automatically?
• If not, are there any plans to support this feature in the future?
• Is there a recommended workaround for adding per-test custom fields and environment variables to Allure results for iOS/XCTest?

Example of what I tried:

let automationAttachment = XCTAttachment(string: "true")
automationAttachment.name = "allure.label.iOSAutomation"
add(automationAttachment)

let osAttachment = XCTAttachment(string: "iOS 18.5.0")
osAttachment.name = "allure.environment.os"
add(osAttachment)

Thank you in advance for any advice or clarification!

[delatrie]

Hi, @maxibello!

You should use activities, not attachments, to add metadata to test results. The name of the activity must follow the corresponding naming convention.

xcresults supports the following naming conventions:

• allure.id:<id>: associates the result with a test case.
• allure.name:<new name>: renames the test.
• allure.description:<text>: sets the description of the test.
• allure.label.<name>:<value>: adds a new label to the result.
• allure.link.<text>[<type>]:<url>: adds a new link to the result.

Activities that follow them will not be converted to steps but will instead apply the metadata.

Example:

XCTContext.runActivity(named: "allure.id:1001") { _ in }
XCTContext.runActivity(named: "allure.name:My test case") { _ in }
XCTContext.runActivity(named: "allure.description:A description of the test case") { _ in }
XCTContext.runActivity(named: "allure.label.layer:UI") { _ in }
XCTContext.runActivity(named: "allure.link.Discussion 3045[issue]:https://github.com/orgs/allure-framework/discussions/3045") { _ in }
XCTContext.runActivity(named: "allure.link.Homepage:https://allurereport.com") { _ in }

You can then set up a mapping between labels and custom fields as described in the TestOps documentation.

As for TestOps environments, you should split Allure result files into separate directories (each corresponding to a specific environment) and upload them individually, providing the configured environment variables.

The exact way of splitting depends on your case. If the environments are based solely on Xcode run destinations, you may (it it's applicable to your workflow) keep the results of each destination in a separate xcresult bundle without merging them. In that case, export each bundle to its own location.

Otherwise, consider post-processing the exported Allure results with a custom script. Tools like jq may help you with that. Move each test result into the correct directory based on the criteria you need (e.g., based on a label value) and proceed with uploading them with the correct environment variables.