statsd_test_harness 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c3392016a57b7f0f12fea1613979dc2fccda5ff
+  data.tar.gz: 645e94680fadf32fb0c041ad949c51f2058610d1
+SHA512:
+  metadata.gz: 47288d2658834bdfe3d556015867e20ae1fab16ec9e8de79b2a141cd0726129341aa5abfc9f9efb4a6a26a9efdc6a4e984dd87df4a1d2072dff19273de19aad5
+  data.tar.gz: fb71cce422a069f7ff6a6e490b33ba965bd292b8a1d046f9657fc54996533379f618f54eb51bd8725583133ab3161ca69fc7464903eeb1e9d6892a867c54b715

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,22 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in statsd_test_harness.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Instructure Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# StatsdTestHarness
+
+A test harness that captures output of various testing frameworks to post to statsd.
+
+## 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:
+
+    STATSD_HOST=192.168.42.10
+    STATSD_PORT=2003
+    APP_NAME=my_app_name
+
+## Usage
+
+Run at command line:
+
+    wrap run_suite
+
+If you don't have a configuration in config/statsd_test_harness.rb, you can specify a config file at runtime:
+
+    wrap run_suite --config path/to/config/file.rb
+
+## Development
+
+To add support for a new test suite, create a file in statsd_test_harness/postprocessors that will match the duration output
+by the testing framework. Follow rspec.rb for an example.
+
+To register the postprocessor, add it to the `config.tools` array the config file, e.g.
+
+    {
+      name: 'my_framework',
+      command: 'test',
+      label: 'my_framework',
+      options: '',
+      ignore_return_value: true,
+      postprocessor: StatsdTestHarness::Postprocessors::MyPostProcessor
+    }
+
+Set the `ignore_return_value` flag to false if you don't want to report an unsuccessful test run (based on exit status).
+
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "statsd_test_harness"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/wrap

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require 'statsd_test_harness/cli'
+require 'dotenv'
+Dotenv.load
+require_relative '../config/config'
+
+StatsdTestHarness::CLI.start

data/config/config.rb

@@ -0,0 +1,20 @@
+require 'dotenv'
+Dotenv.load
+
+StatsdTestHarness.configure do |config|
+  config.statsd_host = ENV['STATSD_HOST']
+  config.statsd_port = ENV['STATSD_PORT']
+  config.app_name =    ENV['APP_NAME']
+
+  config.tools = [
+    {
+      name: 'rspec',
+      command: 'rspec',
+      label: 'rspec',
+      options: '',
+      ignore_return_value: true,
+      postprocessor: StatsdTestHarness::Postprocessors::RSpec
+    }
+  ]
+
+end

data/lib/statsd_test_harness.rb

@@ -0,0 +1,28 @@
+require "require_all"
+
+require_all "lib/statsd_test_harness"
+
+module StatsdTestHarness
+
+  def self.new(path_to_config)
+    StatsdTestHarness::Processor.new(path_to_config)
+  end
+
+  class << self
+    attr_accessor :config
+  end
+
+  def self.configure(&block)
+    @config = Configuration.new
+    yield(config)
+  end
+
+  def self.config
+    @config || Configuration.new
+  end
+
+  class Configuration
+    attr_accessor :tools, :statsd_host, :statsd_port, :app_name
+  end
+
+end

data/lib/statsd_test_harness/cli.rb

@@ -0,0 +1,17 @@
+require "thor"
+require "statsd_test_harness"
+
+module StatsdTestHarness
+
+  class CLI < Thor
+
+    desc "wrap run_suite [--config PATH_TO_CONFIG]", ""
+    method_option :config, type: :string, default: '', aliases: "-c"
+
+    def run_suite
+      StatsdTestHarness.new(options['config']).run
+    end
+
+  end
+
+end

data/lib/statsd_test_harness/postprocessors/rspec.rb

@@ -0,0 +1,17 @@
+module StatsdTestHarness
+  module Postprocessors
+    class RSpec
+
+      attr_reader :output
+
+      def initialize(output)
+        @output = output
+      end
+
+      def duration
+        /Finished in ([0-9\.]+) seconds/.match(self.output)[1]
+      end
+
+    end
+  end
+end

data/lib/statsd_test_harness/processor.rb

@@ -0,0 +1,50 @@
+module StatsdTestHarness
+
+  class Processor
+
+    require 'graphite-api'
+
+    attr_reader :path_to_config
+
+    def initialize(path_to_config=nil)
+      @path_to_config = path_to_config
+    end
+
+    def run
+      load_external_config
+      StatsdTestHarness.config.tools.each do |tool_harness|
+        tool = Tool.new(tool_harness)
+        puts "Executing #{tool.label} test suite..."
+        if data = tool.run
+          post_to_statsd(data, tool.label)
+        end
+        puts "Test suite run complete."
+      end
+    end
+
+    private
+
+    def load_external_config
+      return if self.path_to_config.empty?
+      begin
+        load self.path_to_config
+      rescue Exception => e
+        puts "-- Unable to read custom config file: #{e}"
+      end
+    end
+
+    def post_to_statsd(data, label)
+      puts "Sending test data from #{label} suite for app #{StatsdTestHarness.config.app_name}..."
+      GraphiteAPI.new(graphite: endpoint).metrics(
+        {"stats.timers.#{StatsdTestHarness.config.app_name}.#{label}.duration" => data.duration},
+        Time.now
+      )
+    end
+
+    def endpoint
+      "http://#{StatsdTestHarness.config.statsd_host}:#{StatsdTestHarness.config.statsd_port}"
+    end
+
+  end
+
+end

data/lib/statsd_test_harness/test_data.rb

@@ -0,0 +1,22 @@
+module StatsdTestHarness
+
+  class TestData
+
+    attr_reader :raw_output
+
+    def self.from(output)
+      new(output)
+    end
+
+    def initialize(raw_output)
+      @raw_output = raw_output
+    end
+
+    # FIXME parse output for duration
+    def duration
+      12
+    end
+
+  end
+
+end

data/lib/statsd_test_harness/tool.rb

@@ -0,0 +1,28 @@
+module StatsdTestHarness
+
+  class Tool
+
+    attr_reader :name, :label, :command, :options, :ignore_return_value, :postprocessor
+
+    def initialize(attrs={})
+      @name = attrs[:name]
+      @command = attrs[:command]
+      @options = attrs[:options]
+      @label = attrs[:label]
+      @postprocessor = attrs[:postprocessor]
+      @ignore_return_value = attrs[:ignore_return_value]
+    end
+
+    def run
+      output = `#{self.command} #{self.options}`
+      puts output
+      data = self.postprocessor.new(output)
+      if $?.to_i > 0 && ! ignore_return_value
+        raise "Test run returned non-zero status, results not submitted."
+      end
+      data
+    end
+
+  end
+
+end

data/lib/statsd_test_harness/version.rb

@@ -0,0 +1,3 @@
+module StatsdTestHarness
+  VERSION = "0.1.0"
+end

data/statsd_test_harness.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'statsd_test_harness/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "statsd_test_harness"
+  spec.version       = StatsdTestHarness::VERSION
+  spec.authors       = ["CoralineAda"]
+  spec.email         = ["coraline@idolhands.com"]
+
+  spec.summary       = %q{Test harness for reporting to statsd.}
+  spec.description   = %q{Captures output of various testing frameworks to post to statsd.}
+  spec.homepage      = "https://github.com/CoralineAda/statsd_test_harness"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "thor", "~> 0.19"
+  spec.add_dependency "require_all", "~> 1.3"
+  spec.add_dependency "graphite-api", "~> 0.1"
+  spec.add_dependency "dotenv", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.3"
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: statsd_test_harness
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- CoralineAda
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: graphite-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+description: Captures output of various testing frameworks to post to statsd.
+email:
+- coraline@idolhands.com
+executables:
+- console
+- setup
+- wrap
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/wrap
+- config/config.rb
+- lib/statsd_test_harness.rb
+- lib/statsd_test_harness/cli.rb
+- lib/statsd_test_harness/postprocessors/rspec.rb
+- lib/statsd_test_harness/processor.rb
+- lib/statsd_test_harness/test_data.rb
+- lib/statsd_test_harness/tool.rb
+- lib/statsd_test_harness/version.rb
+- statsd_test_harness.gemspec
+homepage: https://github.com/CoralineAda/statsd_test_harness
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Test harness for reporting to statsd.
+test_files: []
+has_rdoc: