Towel

Towel is a test results collector. As you run tests, Towel streams them to its storage service and displays them in your web browser. You can search for and filter results, see nicely formatted errors, dig into test logs, view artifacts such as screenshots, and more.

Usage

This repository holds several gems:

  • towel -- The base gem that contains gRPC-generated code and support code that applies to all test frameworks. You won't use this directly.
  • towel-minitest -- Supports collecting Minitest results.
  • towel-rspec -- Supports collecting RSpec results.

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on Bitbucket at https://bitbucket.org/VelvetSoftware/towel-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Towel project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.