Generate test coverage reports for Xcode projects & hook it into CI.
Project | Coverage |
---|---|
Parsimmon | |
VENCore | |
CGFloatType | |
DAZABTest | |
TBStateMachine |
Add this line to your application's Gemfile:
gem 'slather'
And then execute:
$ bundle
Set up your project for test coverage:
$ slather setup path/to/project.xcodeproj
This will enable the Generate Test Coverage
and Instrument Program Flow
flags for your project.
To verify you're ready to generate test coverage, run your test suite on your project, and then run:
$ slather coverage -s path/to/project.xcodeproj
Login to Codecov (no need to activate a repository, this happens automatically). Right now, slather
supports Codecov via all supported CI providers listed here.
Make a .slather.yml
file:
# .slather.yml
coverage_service: cobertura_xml
xcodeproj: path/to/project.xcodeproj
source_directory: path/to/sources/to/include
output_directory: path/to/xml_report
ignore:
- ExamplePodCode/*
- ProjectTestsGroup/*
And then in your .travis.yml
, circle.yml
(or after test commands in other CI providers), call slather
after a successful build:
# .travis.yml
before_install: rvm use $RVM_RUBY_VERSION
install: bundle install --without=documentation --path ../travis_bundle_dir
after_success:
- slather
- bash <(curl -s https://codecov.io/bash) -f path/to/xml_report/cobertura.xml
# circle.yml
test:
post:
- bundle exec slather
- bash <(curl -s https://codecov.io/bash)
Private repo? Add
-t :uuid-repo-token
to the codecov uploader. Read more about uploading report to Codecov here
Login to Coveralls and enable your repository. Right now, slather
supports Coveralls via Travis CI and CircleCI.
Make a .slather.yml
file:
# .slather.yml
coverage_service: coveralls
xcodeproj: path/to/project.xcodeproj
ignore:
- ExamplePodCode/*
- ProjectTestsGroup/*
And then in your .travis.yml
or circle.yml
, call slather
after a successful build:
# .travis.yml
before_install: rvm use $RVM_RUBY_VERSION
install: bundle install --without=documentation --path ../travis_bundle_dir
after_success: slather
# circle.yml
test:
post:
- bundle exec slather
To use Coveralls with Travis CI Pro (for private repos), add following lines along with other settings to .slather.yml
:
# .slather.yml
ci_service: travis_pro
coverage_access_token: <YOUR ACCESS TOKEN>
The coverage token can be found at Coveralls repo page. Or it can be passed in via the COVERAGE_ACCESS_TOKEN
environment var.
To create a Cobertura XML report set cobertura_xml
as coverage service inside your .slather.yml
. Optionally you can define an output directory for the XML report:
# .slather.yml
coverage_service: cobertura_xml
xcodeproj: path/to/project.xcodeproj
source_directory: path/to/sources/to/include
output_directory: path/to/xml_report
ignore:
- ExamplePodCode/*
- ProjectTestsGroup/*
Or use the command line options --cobertura-xml
or -x
and --output-directory
:
$ slather coverage -x --output-directory path/to/xml_report
To create a report as static html pages, use the command line options --html
:
$ slather coverage --html path/to/project.xcodeproj
This will make a directory named html
in your root directory (unless --output-directory
is specified) and will generate all the reports as static html pages inside the directory. It will print out the report's path by default, but you can also specify --show
flag to open it in your browser automatically.
If you're trying to compute the coverage of code that has been included via
CocoaPods, you will need to tell CocoaPods to use the Slather plugin by
adding the following to your Podfile
.
plugin 'slather'
You will also need to tell Slather where to find the source files for your Pod.
# .slather.yml
source_directory: Pods/AFNetworking
Slather will look for the test coverage files in DerivedData
by default. If you send build output to a custom location, like this, then you should also set the build_directory
property in .slather.yml
We’d love to see your ideas for improving this library! The best way to contribute is by submitting a pull request. We’ll do our best to respond to your patch as soon as possible. You can also submit a new GitHub issue if you find bugs or have questions.
Please make sure to follow our general coding style and add test coverage for new features!