statsd_test_harness 0.1.3 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb076d5a472dc9b47e680b5d800f69d0bf9d2068
-  data.tar.gz: 01d1a1b26c113be200a12198c86e2ea4342438bc
+  metadata.gz: 60ab01edf847abd342b0b97ea2b6756268193e86
+  data.tar.gz: 0e28cca62fab3ddfd4d65f38399029fffa703c7a
 SHA512:
-  metadata.gz: e35b0f593d8bd4b4561b5358ac326f42000109da1a64b13f39d34e1c42058f476eca62321f94f9405def9914c2f8a7381a073d5819fd4a1ad926d992276d7c8c
-  data.tar.gz: 59cc9da579d16e4515a0872850e20e4bb74f28d0990f48629584ffea1de5128377428288c4d43449d4fb8180bfe19de8c7c84dd16751b0994bedfc6e417394f3
+  metadata.gz: d1ee5426339c2e6275a8614503688bc5e643882bfb279f9f1d563fabe04075c233d93a8d7b2a54e6ae3c8c58714fb5ddb987a0f377470a474de0c14d086a63b3
+  data.tar.gz: 99d988e3db95a437f61a0e1df1919e32c68b3bf17e88a957fa7ea29c5056a1334e6e9a6d7df77a28d3fceacd019530753b4d0a8477d52909a1d432e2c1812691

data/.gitignore

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

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    statsd_test_harness (0.2.1)
+      dotenv (~> 2.0)
+      require_all (~> 1.3)
+      statsd-ruby (~> 0.3.0)
+      thor (~> 0.19)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    dotenv (2.0.2)
+    rake (10.4.2)
+    require_all (1.3.2)
+    rspec (3.3.0)
+      rspec-core (~> 3.3.0)
+      rspec-expectations (~> 3.3.0)
+      rspec-mocks (~> 3.3.0)
+    rspec-core (3.3.2)
+      rspec-support (~> 3.3.0)
+    rspec-expectations (3.3.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-mocks (3.3.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.3.0)
+    rspec-support (3.3.0)
+    statsd-ruby (0.3.0)
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.9)
+  rake (~> 10.0)
+  rspec (~> 3.3)
+  statsd_test_harness!

data/README.md

@@ -22,35 +22,24 @@ Or install it yourself as:
 
 Set the following environment variables for statsd integration:
 
-    STATSD_HOST=192.168.42.10
-    STATSD_PORT=2003
-    STATSD_APP_NAME=my_app_name
+    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
 
+To start a graphite/statsd docker file:
+
+    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
+
 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
 
-## Development
-
-To add support for a new test suite, create a file in statsd_test_harness/postprocessors/ that will extract the duration output
-from the testing framework. Follow statsd_test_harness/postprocessors/rspec.rb for an example.
-
-To register the postprocessor, 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: 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).
+In your config file, set the `ignore_return_value` flag to false if you don't want to report an unsuccessful test run (based on exit status).
 
 ## Contributing
 

data/config/config_custom.rb

@@ -0,0 +1,20 @@
+require 'dotenv'
+Dotenv.load
+
+StatsdTestHarness.configure do |config|
+  config.host = ENV['STATSD_HOST']
+  config.port = ENV['STATSD_PORT']
+  config.app_name = ENV['STATSD_APP_NAME']
+  config.namespace = ENV['STATSD_NAMESPACE']
+
+  config.tools = [
+    {
+      name: 'rspec',
+      command: 'rspec',
+      label: 'rspec',
+      options: 'spec/models/conversation_spec.rb',
+      ignore_return_value: false
+    }
+  ]
+
+end

data/config/sample_config.rb

@@ -1,19 +1,18 @@
 require 'dotenv'
 Dotenv.load
 
-StatsdTestHarness.configure do |config|
-  config.statsd_host     = ENV['STATSD_HOST']
-  config.statsd_port     = ENV['STATSD_PORT']
-  config.statsd_app_name = ENV['STATSD_APP_NAME']
+StatsdTess.configure do |config|
+  config.host      = ENV['STATSD_HOST']
+  config.port      = ENV['STATSD_PORT']
+  config.app_name  = ENV['STATSD_APP_NAME']
+  config.namespace = ENV['STATSD_NAMESPACE']
 
   config.tools = [
     {
       name: 'rspec',
       command: 'rspec',
-      label: 'rspec',
       options: '',
-      ignore_return_value: true,
-      postprocessor: StatsdTestHarness::Postprocessors::RSpec
+      ignore_return_value: true
     }
   ]
 

data/lib/statsd_test_harness/cli.rb

@@ -2,16 +2,13 @@ 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/client.rb

@@ -0,0 +1,19 @@
+module StatsdTestHarness
+  class Client
+
+    def post(duration, label)
+      puts "Sending test data from #{label} suite for app #{StatsdTestHarness.config.app_name}..."
+      client.timing(
+        "#{StatsdTestHarness.config.namespace}.#{StatsdTestHarness.config.app_name}.#{label}.duration",
+        duration
+      )
+    end
+
+    private
+
+    def client
+      Statsd.new(StatsdTestHarness.config.host, StatsdTestHarness.config.port)
+    end
+
+  end
+end

data/lib/statsd_test_harness/processor.rb

@@ -1,64 +1,56 @@
 module StatsdTestHarness
-
   class Processor
 
-    require 'graphite-api'
+    require 'statsd'
 
     attr_reader :path_to_config
 
     def initialize(path_to_config)
       @path_to_config = path_to_config
+      load_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)
+        puts "Executing #{tool.label} test suite for #{StatsdTestHarness.config.app_name}..."
+        if duration = with_timing{tool.run}
+          StatsdTestHarness::Client.new.post(duration, tool.name)
+          puts "Test suite for #{tool.label} completed in #{duration} ms."
         end
-        puts "Test suite run complete."
       end
     end
 
     private
 
-    def load_external_config
+    def load_config
       begin
-        load self.path_to_config
         validate_path_to_config
+        load self.path_to_config
         validate_env_variables
       rescue Exception => e
-        puts "-- Unable to read config file: #{e}"
+        puts "-- Invalid configuration, exiting: #{e}"
+        exit
       end
     end
 
-    def post_to_statsd(data, label)
-      puts "Sending test data from #{label} suite for app #{StatsdTestHarness.config.statsd_app_name}..."
-      GraphiteAPI.new(graphite: endpoint).metrics(
-        {"stats.timers.#{StatsdTestHarness.config.statsd_app_name}.#{label}.duration" => data.duration},
-        Time.now
-      )
-    end
-
-    def endpoint
-      "http://#{StatsdTestHarness.config.statsd_host}:#{StatsdTestHarness.config.statsd_port}"
+    def validate_env_variables
+      unless StatsdTestHarness.config.host && StatsdTestHarness.config.port
+        raise "No statsd environment variables defined."
+      end
     end
 
     def validate_path_to_config
       if self.path_to_config.empty?
-        puts "No config file specified, exiting"
-        exit
+        raise "No config file specified."
       end
     end
 
-    def validate_env_variables
-      unless StatsdTestHarness.config.statsd_host && StatsdTestHarness.config.statsd_port
-        puts "No statsd environment variables defined, exiting"
-        exit
-      end
+    def with_timing
+      start_time = Time.now.to_f
+      yield
+      (Time.now.to_f - start_time) * 1000
     end
-  end
 
+  end
 end

data/lib/statsd_test_harness/tool.rb

@@ -1,28 +1,24 @@
 module StatsdTestHarness
-
   class Tool
 
-    attr_reader :name, :label, :command, :options, :ignore_return_value, :postprocessor
+    attr_reader :name, :command, :options, :label, :ignore_return_value
 
     def initialize(attrs={})
-      @name = attrs[:name]
-      @command = attrs[:command]
-      @options = attrs[:options]
-      @label = attrs[:label]
-      @postprocessor = attrs[:postprocessor]
+      @name     = attrs[:name]
+      @command  = attrs[:command]
+      @options  = attrs[:options]
+      @label    = attrs[:label]
       @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
+      true
     end
 
   end
-
 end

data/lib/statsd_test_harness/version.rb

@@ -1,3 +1,3 @@
 module StatsdTestHarness
-  VERSION = "0.1.3"
+  VERSION = "0.2.1"
 end

data/lib/statsd_test_harness.rb

@@ -21,7 +21,7 @@ module StatsdTestHarness
   end
 
   class Configuration
-    attr_accessor :tools, :statsd_host, :statsd_port, :statsd_app_name
+    attr_accessor :tools, :host, :port, :app_name, :namespace
   end
 
 end

data/statsd_test_harness.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "thor", "~> 0.19"
   spec.add_dependency "require_all", "~> 1.3"
-  spec.add_dependency "graphite-api", "~> 0.1"
+  spec.add_dependency "statsd-ruby", "~> 0.3.0"
   spec.add_dependency "dotenv", "~> 2.0"
 
   spec.add_development_dependency "bundler", "~> 1.9"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statsd_test_harness
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.1
 platform: ruby
 authors:
 - CoralineAda
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-06 00:00:00.000000000 Z
+date: 2015-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: graphite-api
+  name: statsd-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -121,18 +121,19 @@ files:
 - ".gitignore"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - bin/wrap
+- config/config_custom.rb
 - config/sample_config.rb
 - lib/statsd_test_harness.rb
 - lib/statsd_test_harness/cli.rb
-- lib/statsd_test_harness/postprocessors/rspec.rb
+- lib/statsd_test_harness/client.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

data/lib/statsd_test_harness/postprocessors/rspec.rb

@@ -1,21 +0,0 @@
-module StatsdTestHarness
-  module Postprocessors
-    class RSpec
-
-      attr_reader :output
-
-      def initialize(output)
-        @output = output
-      end
-
-      def duration
-        duration_string = /^real(.+)/.match(self.output).to_a.last
-        hours   = /([0-9\.]+)h/.match(duration_string).to_a.last.to_f || 0
-        minutes = /([0-9\.]+)m/.match(duration_string).to_a.last.to_f || 0
-        seconds = /([0-9\.]+)s/.match(duration_string).to_a.last.to_f || 0
-        (hours * 60 * 60) + (minutes * 60) + seconds
-      end
-
-    end
-  end
-end

data/lib/statsd_test_harness/test_data.rb

@@ -1,22 +0,0 @@
-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