咨询：xcpretty是否支持在HTML测试报告中打印测试用例注释？

Unfortunately, xcpretty's default HTML report template doesn't natively support displaying comments from your test cases. But there are practical workarounds to get your test context visible in the report, which aligns with your goal of letting stakeholders understand the details of what each test does.

Here's how to make it work:

Step 1: Expose test comments in your test logs #

First, you need to make your test comments visible in the raw xcodebuild output—xcpretty can only include data it receives from the build/test process. You have two straightforward ways to do this:

Option A: Use print() statements for explicit comments #

Add direct print calls to your test methods to output your comment text:

func testCheckoutFlow() {
    // Original comment: Verify cart items before proceeding to checkout
    print("Test Context: Verify cart items before proceeding to checkout")
    
    // Test code: Check cart count
    XCTAssertEqual(cart.itemCount, 2, "Cart should have 2 items")
    
    print("Test Context: Validate shipping address fields")
    // Test code: Validate address
    XCTAssertTrue(addressForm.isValid, "Shipping address is invalid")
}

Option B: Use XCTContext for structured test steps #

Apple's XCTContext API lets you organize tests into named activities, which are automatically logged by xcodebuild—this keeps your test logic clean while adding context:

func testLoginFlow() {
    XCTContext.runActivity(named: "Validate username/password inputs") { activity in
        // Test code for input validation
        XCTAssertFalse(usernameField.text?.isEmpty ?? true, "Username can't be empty")
    }
    
    XCTContext.runActivity(named: "Trigger login and verify redirect") { activity in
        // Test code for login action
        loginButton.tap()
        XCTAssertTrue(homeScreen.isVisible, "Login should redirect to home screen")
    }
}

Step 2: Customize the xcpretty HTML template #

Next, modify xcpretty's HTML template to display these logged comments/activities. Here's the step-by-step:

1. Export the default template
   Find where xcpretty is installed with gem which xcpretty, then locate the default HTML templates (usually in templates/html inside the gem directory). Copy this entire directory to your project, for example:

   cp -r /path/to/xcpretty/templates/html ./custom-xcpretty-template
   

2. Modify the template to show logs
   Open custom-xcpretty-template/index.html.erb in a text editor. Look for the section where test cases are rendered (search for test_cases or test_case). Add code to display log entries or activity names for each test. For example, to show XCTContext activities:

   <% if test_case.test_steps.any? %>
     <div class="test-steps">
       <h4>Test Steps:</h4>
       <% test_case.test_steps.each do |step| %>
         <div class="step-item"><%= step.description %></div>
       <% end %>
     </div>
   <% end %>
   

   If you used print() statements, adjust the template logic to capture and render raw log lines associated with each test case.

3. Run xcpretty with your custom template
   Update your command to use the custom template:

   xcodebuild -workspace example-example.xcworkspace -scheme "example-example" -sdk iphonesimulator -destination "platform=iOS Simulator,name=iPhone 7 (10.3.1) [9C14ED59-D6E2-4E85-8662-007080BC27F1]" -derivedDataPath "./output" test | xcpretty --report html --template ./custom-xcpretty-template
   

Alternative: Quick fix with verbose output #

If you don't want to customize the template, add the --verbose flag to xcpretty to include more raw log data in the report. While it's less polished, it will show your printed comments:

xcodebuild [your build flags] test | xcpretty --report html --verbose

This approach will make your test context clear to anyone reviewing the HTML report, fulfilling your core requirement.

内容的提问来源于stack exchange，提问作者Nikitka Gurtovoy