Skip to content

tkww/XCTestHTMLReport

 
 

Repository files navigation

⚠️ Looking for collaborators to maintain XCTestHTMLReport: Drop me a line ⚠️

title

What is it?

Xcode-like HTML report for Unit and UI Tests

screenshot

Features

  • Supports parallel testing
  • Supports attachments:
    • .png
    • .jpeg
    • .txt
    • .log
    • .mp4
  • Navigate through the report with the keyboard's arrow keys
  • Filter out successful or failed tests
  • Displays information about the target device
  • Displays activity logs
  • Junit report

Fastlane Support

https://github.com/TitouanVanBelle/fastlane-plugin-xchtmlreport

Installation

Homebrew

Install via Homebrew.

# Install latest stable version
$ brew install https://raw.githubusercontent.com/TitouanVanBelle/XCTestHTMLReport/develop/xchtmlreport.rb

# Install latest master branch
$ brew install --HEAD https://raw.githubusercontent.com/TitouanVanBelle/XCTestHTMLReport/develop/xchtmlreport.rb

Alternate

Simply execute the following command to download the latest version of XCTestHTMLReport

$ bash <(curl -s https://raw.githubusercontent.com/TitouanVanBelle/XCTestHTMLReport/master/install.sh)

You can also specify a branch or tag

$ bash <(curl -s https://raw.githubusercontent.com/TitouanVanBelle/XCTestHTMLReport/master/install.sh) '1.0.0'

Usage

Run your UI tests using xcodebuild without forgetting to specify the resultBundlePath

$ xcodebuild test -workspace XCTestHTMLReport.xcworkspace -scheme XCTestHTMLReportSampleApp -destination 'platform=iOS Simulator,name=iPhone 7,OS=11.0' -resultBundlePath TestResults

Then use the previously downloaded xchtmlreport tool to create the HTML report

$ xchtmlreport -r TestResults

Report successfully created at ./index.html

Testing changes:

To test any changes made to the SDK locally:

  • Open the SDK folder with Xcode.
  • Click in the project target and select Edit Scheme.
  • In the Run category open the Arguments section.
  • In the Arguments passed on Launch list add a new argument with a valid path to an .xcresult file.
  • Make sure that the new argument is checked.
  • Close the window and run.

Multiple Result Bundle Path

You can also pass multiple times the -r option.

$ xchtmlreport -r TestResults1 -r TestResults2

Report successfully created at ./index.html

This will create only one HTML Report in the path you passed with the -r option

Contribution

Please create an issue whenever you find an issue or think a feature could be a good addition to XCTestHTMLReport. Always make sure to follow the Contributing Guidelines. Feel free to take a shot at these issues.

License

XCTestHTMLReport is available under the MIT license.

About

Xcode-like HTML report for Unit and UI Tests

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Swift 55.9%
  • HTML 43.2%
  • Other 0.9%