https://github.com/instructure/statsd_test_harness

https://github.com/instructure/statsd_test_harness

Last synced: 8 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/instructure/statsd_test_harness
• Owner: instructure
• License: mit
• Created: 2015-08-28T19:10:55.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2015-08-28T20:15:21.000Z (about 9 years ago)
• Last Synced: 2024-10-08T12:40:56.479Z (about 1 month ago)
• Language: Ruby
• Size: 305 KB
• Stars: 0
• Watchers: 17
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# StatsdTestHarness

A test harness that captures output of various testing frameworks to post to a statsd server.

## Installation

Add this line to your application's Gemfile:

```ruby

gem 'statsd_test_harness'

```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install statsd_test_harness

## Configuration

Set the following environment variables for statsd integration:

    export STATSD_HOST=192.168.42.10

    export STATSD_PORT=8125

    export STATSD_NAMESPACE=statsd_test_harness

    export STATSD_APP_NAME=my_app_name

## Usage

You must specify a config file at runtime:

    wrap run_suite --config path/to/config/file.rb

For an example of what the config file should look like, refer to config/sample_config.rb

To register a new test framework, add it to the `config.tools` array in your config file, e.g.

    {

      name: 'my_framework',

      command: 'test',

      label: 'my_framework',

      options: '',

      ignore_return_value: false

    }

Set the `ignore_return_value` flag to true if you don't want to report an unsuccessful test run (based on exit status).

## Development

To start a graphite/statsd docker container for testing purposes:

    docker run -d --name graphite --restart=always -p 80:80 -p 2003:2003 -p 8125:8125/udp hopsoft/graphite-statsd -e VIRTUAL_HOST=graphite.docker

## Contributing

1. Fork it ( https://github.com/[my-github-username]/statsd_test_harness/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request