macpaw / xcsummary

macOS command line tool to parse xcbodebuild test results and generate html output with activity screenshots.

xcsummary is a macOS command line tool that parses xcbodebuild test results and generates html output with activity screenshots. We use it as a part of our CI Server and find it very useful and helpful. We'd like to share it.

• Installation
• Usage
• Example
• Output
• Inspiration
• Links
• Contribution

Installation

Open terminal and do the following:

• Clone the project.

git clone https://github.com/MacPaw/xcsummary.git

• Navigate to source folder

cd xcsummary

• Copy binary to the folder you prefer. For example /usr/local/bin/

cp build/xcsummary /usr/local/bin/xcsummary

Usage

As easy as pie:

xcsummary -in <path to Summary.plist> -out <path to result.html>

Optional -show_success argument can be used to expand green test cases as well.

Example

Tip: we use -resultBundlePath parameter in xcodebuild to know the exact location for every single build.

#Run your test as usual
xcodebuild test -workspace YourProject.xcworkspace -scheme YourProjectScheme -resultBundlePath '<path_to_results>' 
#Here we suggest to browse <path_to_results> folder to check the folders structure.
#... and generate the report
xcsummary -in <path_to_results>/1_Test/action_TestSummaries.plist -out ~/Desktop/result.html

Screenshots

Output

Live HTML Example

Inspiration

xcsummary is completely inspired by xcpretty, we really love it and use it. But since xcpretty has some issues with screenshots collection, we decided to create our own one :)

Links

Great article to understand Test Logs in Xcode

Contribution

Feel free to open issues and pull requests.

xcsummary's Issues

There is no image in xcsummary report by using Xcode 10.2

after updating to xcode 10.2 reports doesnt show device screenshoots.

Attachment Files Location Issue

Hello,
I put the build inside me Mac /usr/local/bin directory. Then i am running the build from command Terminal with below this command to generate reports.
xcsummary -in -out
Here I have a folder in my desktop, where I am putting my input .plist file which I have got from different system generated .xcresult file
And I have also a output folder in my desktop which I am giving as my .
Now when I am running the above command
xcsummary -in -out -show_success
then I am getting all the data in my HTML report except the attachment snapshots.
And a blank resource folder is getting generated in my
So, for attaching the snapshots in my report I copied all the attachment images with jpg format from my .xcresult/attchment to this new resource folder that is being generated during running of above command. But still no snapshots are coming in the report.html

Test case count

Hey great work with the html screen shots, I'm porting over as a existing XCPretty user although I've noticed the lack of the top bar that contains the test results overall for the test run. Having overall test run results per class would be great also.

Set resources path?

I see that I can set the path for the -in and -out files. This appears to create a resources directory in the current directory.

Is there a way to set the path where this resources directory is created?

Add expand and collapse for detailed steps

I've create new pull-request for this future

How can I find the `action_TestSummaries.plist`?

With Xcode Version 12.3:

$ ls test.xcresult
Data       Info.plist

It seems that Apple has changed the format of testResultBundles after Xcode 11.0. And this tool cannot support any more: https://stackoverflow.com/questions/57471506/missing-testsummeries-plist-file-in-deriveddata

Add expand and collapse for detailed steps

Hi guy,

Thanks for sharing your implementation for this html result which is almost what I wanted.
But if all detailed steps can be collapsed just like what we see test result in xcode will be perfect.
User can choose to expand and see which screenshot.

B.R.
Luis

There is no image in xcsummary report by using Xcode 9.

Hi ,
I upgraded Xcode to Xcode 9, and run xcsummary via below command

xcsummary -in path to Summary.plist -out path to result.html

Then there isn't any screenshot in report.
Is it cause by the different of image's format?

Thanks.
Vivian