hansel 0.1.7 → 0.2.0

data/lib/hansel.rb

@@ -1,127 +1,12 @@
 require 'fileutils'
-require 'lib/httperf_result_parser'
-require 'lib/httperf_result'
+require 'yaml'
 
-module Hansel
-  #
-  # Class wrapper over httperf.
-  #
-  class Hansel
-    def initialize(options = {})
-      @options = options
-      @results = []
-      @current_rate = nil
-    end
+$:.unshift File.dirname(__FILE__) + "/../lib/hansel"
 
-    def build_httperf_cmd
-      cookie = @options.cookie
-      httperf_cmd = [
-        "httperf --hog",
-        "--server=#{@options.server}",
-        "--port=#{@options.port}",
-        "--uri=#{@options.uri}",
-        "--num-conns=#{@options.num_conns}",
-        "--rate=#{@current_rate}",
-        cookie && "--add-header='Cookie: #{cookie}\\n'"
-      ].compact.join ' '
-    end
-
-    #
-    # Runs httperf with a given request rate. Parses the output and returns
-    # a hash with the results.
-    #
-    def httperf
-      httperf_cmd = build_httperf_cmd
-      IO.popen("#{httperf_cmd} 2>&1") do |pipe|
-        puts "\n#{httperf_cmd}"
-        @results << (httperf_result = HttperfResult.new({
-            :rate       => @current_rate,
-            :server     => @options.server,
-            :port       => @options.port,
-            :uri        => @options.uri,
-            :num_conns  => @options.num_conns
-          }))
-        HttperfResultParser.new(pipe).parse(httperf_result)
-      end
-    end
-
-    def yaml_formatter
-      load File.here '/../lib/yaml_formatter.rb'
-      YamlFormatter.new(@results)
-    end
-
-    def csv_formatter
-      load File.here '/../lib/csv_formatter.rb'
-      CsvFormatter.new(@results)
-    end
-
-    def octave_formatter
-      load File.here '/../lib/octave_formatter.rb'
-      puts @output_file_name
-      OctaveFormatter.new(@results, {
-          :output_file_name => @output_file_name,
-          :template         => File.join([@options.template_path,
-                                      @options.template || 'octave.m.erb']),
-        }
-      )
-    end
-
-    def format format
-      formatter = "#{format}_formatter".to_sym
-      unless self.respond_to? formatter
-        puts "Using default octave_formatter"
-        octave_formatter
-      else
-        puts "Using #{formatter}"
-        self.send formatter
-      end
-    end
-
-    def formatted_output
-      @output_file_name = [@options.server, @options.num_conns.to_s].join('.')
-      output_file = File.join @options.output_dir, @output_file_name
-      output_format = @options.output_format
-      type = { :yaml => 'yml', :csv => 'csv', :octave => 'm' }[output_format]
-      File.open([output_file, type].join('.'), "w+") do |file|
-        file.puts format(output_format).format
-      end
-    end
-
-    #
-    # Output the results based on the requested output format
-    #
-    def output
-      if @options.output
-        FileUtils.mkdir_p @options.output_dir
-        formatted_output
-      end
-    end
-
-    def status text
-      puts text if @options.verbose
-    end
-
-    def run_all
-      (@options.low_rate.to_i..@options.high_rate.to_i).step(@options.rate_step.to_i) do |rate|
-        status "running httperf at rate: #{rate}"
-        @current_rate = rate
-        httperf
-      end
-    end
-
-    #
-    # Run httperf from low_rate to high_rate, stepping by rate_step
-    #
-    def run
-      status "starting run..."
-      run_all
-      output
-      status "ending run..."
-    end
-
-    trap("INT") {
-      puts "Terminating."
-      Process.exit
-    }
-  end
-end
+require 'arg_parser'
+require 'formatting/formatting'
+require 'httperf/httperf'
+require 'httperf_result'
+require 'httperf_result_parser'
+require 'job_queue/job_queue'
+require 'hansel'

data/spec/arg_parser_spec.rb

@@ -1,57 +1,114 @@
 require File.dirname(__FILE__) + "/spec_helper"
-require 'arg_parser'
 
-describe Hansel::ArgParser, "#parse" do
+describe HanselCore::ArgParser, "#parse" do
   before :each do
-    @argv = [
-      '--server=frunobulax.local',
-      '--port=4000',
-      '--uri=/',
-      '--num_conns=1',
-      '--low_rate=1',
-      '--high_rate=5',
-      '--rate_step=1',
-      '--format=octave',
-      '--output=true'
-      ]
-    @options = Hansel::ArgParser.new(@argv).parse
   end
 
-  describe "should set the" do
-    it "server to 'frunobulax.local'" do
-      @options.server.should == 'frunobulax.local'
-    end
+  describe "when the option" do
+    describe "master is set to 'localhost:4000'" do
+      it "should set master" do
+        @argv = [ '--master=localhost:4000' ]
+        @options = HanselCore::ArgParser.new(@argv).parse
+        @options.master.should == 'localhost:4000'
+      end
 
-    it "port to 4000" do
-      @options.port.should == 4000
+      it "should set master" do
+        @argv = [ '-mlocalhost:4000' ]
+        @options = HanselCore::ArgParser.new(@argv).parse
+        @options.master.should == 'localhost:4000'
+      end
     end
 
-    it "uri to '/" do
-      @options.uri.should == '/'
+    describe "dir is set to '/tmp/hansel_output'" do
+      it "should set output_dir" do
+        @argv = [ '--dir=/tmp/hansel_output' ]
+        @options = HanselCore::ArgParser.new(@argv).parse
+        @options.output_dir.should == '/tmp/hansel_output'
+      end
+
+      it "should set output_dir" do
+        @argv = [ '-d/tmp/hansel_output' ]
+        @options = HanselCore::ArgParser.new(@argv).parse
+        @options.output_dir.should == '/tmp/hansel_output'
+      end
+
+      it "should set template" do
+        @argv = [ '--template=/home/templates' ]
+        @options = HanselCore::ArgParser.new(@argv).parse
+        @options.template.should == '/home/templates'
+      end
+
+      it "should set template" do
+        @argv = [ '-t/home/templates' ]
+        @options = HanselCore::ArgParser.new(@argv).parse
+        @options.template.should == '/home/templates'
+      end
     end
 
-    it "num_conns to 1" do
-      @options.num_conns.should == 1
+    %w(yaml csv octave).each do |format|
+      describe "output --format is set to #{format}" do
+        it "should set format #{format}" do
+          @argv = [ "--format=#{format}" ]
+          @options = HanselCore::ArgParser.new(@argv).parse
+          @options.format.should == format
+        end
+
+        it "should set format to #{format}" do
+          @argv = [ "-f#{format}" ]
+          @options = HanselCore::ArgParser.new(@argv).parse
+          @options.format.should == format
+        end
+      end
     end
 
-    it "low_rate to 1" do
-      @options.low_rate.should == 1
+    describe "verbose is set" do
+      it "should set verbose to true" do
+        @argv = [ '--verbose' ]
+        @options = HanselCore::ArgParser.new(@argv).parse
+        @options.verbose.should == true
+      end
+      it "should set verbose to true" do
+        @argv = [ '-v' ]
+        @options = HanselCore::ArgParser.new(@argv).parse
+        @options.verbose.should == true
+      end
     end
 
-    it  "high_rate to 5" do
-      @options.high_rate.should == 5
+    describe "no-verbose is set" do
+      it "should set verbose to false" do
+        @argv = [ '--verbose', '--no-verbose' ]
+        @options = HanselCore::ArgParser.new(@argv).parse
+        @options.verbose.should == false
+      end
     end
 
-    it "rate_step to 1" do
-      @options.rate_step.should == 1
+    describe "verbose is not set" do
+      it "verbose defaults to false" do
+        @argv = [ ]
+        @options = HanselCore::ArgParser.new(@argv).parse
+        @options.verbose.should == false
+      end
     end
 
-    it "output_format to 'octave'" do
-      @options.output_format.should == :octave
+    describe "help is set" do
+      it "should set exit to true" do
+        @argv = [ '--help' ]
+        @options = HanselCore::ArgParser.new(@argv).parse
+        @options.exit.should == true
+      end
+      it "should set exit to true" do
+        @argv = [ '-h' ]
+        @options = HanselCore::ArgParser.new(@argv).parse
+        @options.exit.should == true
+      end
     end
 
-    it "output to 'true'" do
-      @options.output.should == true
+    describe "version is set" do
+      it "should set exit to true" do
+        @argv = [ '--version' ]
+        @options = HanselCore::ArgParser.new(@argv).parse
+        @options.exit.should == true
+      end
     end
   end
 end

data/spec/hansel_spec.rb

@@ -0,0 +1,134 @@
+require File.dirname(__FILE__) + "/spec_helper"
+
+require 'typhoeus'
+require 'json'
+require 'yaml'
+require 'ostruct'
+
+describe HanselCore, "in general" do
+  before :each do
+    @hansel = HanselCore::Hansel.new
+    @hansel.stub(:config_path).and_return 'spec'
+  end
+
+  it "should have an empty job queue" do
+    @hansel.should respond_to :push_job
+    @hansel.should respond_to :jobs
+    @hansel.jobs.length.should == 0
+  end
+
+  describe "adding to the job queue" do
+    before :each do
+      jobs = YAML.load_file(File.join ['spec', 'jobs.yml']).map{ |job| OpenStruct.new job }
+      jobs.each{ |job| @hansel.push_job job }
+    end
+
+    it "should have some jobs" do
+      @hansel.jobs.length.should > 0
+    end
+  end
+
+  describe "when calling run" do
+    before :each do
+      @hansel.stub( :httperf ).and_return @hansel
+      @hansel.load_job_queue
+    end
+
+    describe "initially" do
+      it "should have some jobs" do
+        @hansel.jobs.length.should > 0
+      end
+    end
+
+    describe "on completion" do
+      before :each do
+        @hansel.run
+      end
+
+      it "should have an empty job queue" do
+        @hansel.jobs.length.should == 0
+      end
+
+      it "should have results to output" do
+        @hansel.should respond_to :results
+      end
+    end
+  end
+
+  describe "after a run" do
+    before :each do
+      result = HanselCore::HttperfResult.new  :server     => "localhost",
+                                              :port       => 80,
+                                              :rate       => 1,
+                                              :uri        => "/",
+                                              :num_conns  => 1
+
+      result.reply_time         = 0.0
+      result.status             = 0
+      result.reply_rate_avg     = 0.0
+      result.request_rate       = 0.0
+      result.reply_rate_min     = 0.0
+      result.connection_rate    = 6754.1
+      result.errors             = 1
+      result.reply_rate_stddev  = 0.0
+      result.net_io             = 0.0
+      result.replies            = 0
+      result.reply_rate_max     = 0.0
+
+      @hansel.stub( :results ).and_return [ result ]
+      @hansel.stub( :options ).and_return HanselCore::ArgParser.
+                                new( [ '--format=yaml', '--dir=/tmp/hansel_output' ] ).parse
+    end
+
+    describe "calling output" do
+      before :each do
+        @default_name = File.join [ @hansel.options.output_dir, 'localhost:80.yml' ]
+        FileUtils.rm @default_name if File.exists? @default_name
+        @hansel.output
+      end
+
+      it "should have stubbed results" do
+        @hansel.results.size.should > 0
+      end
+
+      describe "should put the output into a file in the specified format" do
+        it "should be in a file with the default file name" do
+          @default_name.should == @hansel.output_filename
+          File.exists?( @default_name ).should be_true
+        end
+      end
+    end
+  end
+end
+
+describe HanselCore, "in distributed mode" do
+  before :each do
+    @options = HanselCore::ArgParser.new( [ '--master=localhost:4000' ] ).parse
+  end
+
+  describe "should register with the master" do
+    before :each do
+      response = Typhoeus::Response.new(
+          :code     => 200,
+          :headers  => "",
+          :body     => { :token => '0123456789' }.to_json,
+          :time     => 0.3)
+      Typhoeus::Request.stub(:get, @options.master).and_return response
+    end
+
+    describe "when initialized" do
+      before :each do
+        @hansel = HanselCore::Hansel.new @options
+        @hansel.stub(:config_path).and_return 'spec'
+      end
+
+      it "should be able to register with the master server" do
+        @hansel.should respond_to :register
+      end
+
+      it "should return the access token when registring with the master server" do
+        @hansel.register.should == '0123456789'
+      end
+    end
+  end
+end

data/spec/httperf_result_parser_spec.rb

@@ -28,14 +28,14 @@ Errors: total 0 client-timo 0 socket-timo 0 connrefused 0 connreset 0
 Errors: fd-unavail 0 addrunavail 0 ftab-full 0 other 0
 EOS
 
-describe Hansel::HttperfResultParser, "#score" do
+describe HanselCore::HttperfResultParser, "#score" do
   before(:each) do
-    @parser = Hansel::HttperfResultParser.new SAMPLE_HTTPERF_OUTPUT
+    @parser = HanselCore::HttperfResultParser.new SAMPLE_HTTPERF_OUTPUT
   end
 
   describe "when calling parse" do
     before(:each) do
-      @httperf_result = Hansel::HttperfResult.new(
+      @httperf_result = HanselCore::HttperfResult.new(
         :rate       => 10,
         :server     => 'www.example.com',
         :port       => 80,

data/spec/jobs.yml

@@ -0,0 +1,8 @@
+--- 
+- :server: localhost
+  :uri: /
+  :format: octave
+  :num_conns: 1
+  :low_rate: 1
+  :high_rate: 5
+  :rate_step: 1

data/spec/spec_helper.rb

@@ -1,7 +1,6 @@
 require "rubygems"
 require 'spec'
-
-$:.unshift File.dirname(__FILE__) + "/../lib"
+require 'lib/hansel'
 
 module Helpers
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 7
-  version: 0.1.7
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Paul Mylchreest
@@ -14,10 +14,33 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-08 00:00:00 -04:00
+date: 2010-06-13 00:00:00 -04:00
 default_executable: hansel
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: typhoeus
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
 description: Ruby driver for httperf - automated load and performance testing
 email: paul.mylchreest@mac.com
 executables: 
@@ -26,26 +49,31 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - bin/hansel
 - hansel.gemspec
-- lib/arg_parser.rb
-- lib/config.rb
-- lib/csv_formatter.rb
 - lib/hansel.rb
-- lib/httperf_result.rb
-- lib/httperf_result_parser.rb
-- lib/octave_formatter.rb
-- lib/yaml_formatter.rb
+- lib/hansel/arg_parser.rb
+- lib/hansel/formatting/csv_formatter.rb
+- lib/hansel/formatting/formatting.rb
+- lib/hansel/formatting/octave_formatter.rb
+- lib/hansel/formatting/yaml_formatter.rb
+- lib/hansel/hansel.rb
+- lib/hansel/httperf/httperf.rb
+- lib/hansel/httperf_result.rb
+- lib/hansel/httperf_result_parser.rb
+- lib/hansel/job_queue/job_queue.rb
 - spec/arg_parser_spec.rb
+- spec/hansel_spec.rb
 - spec/httperf_result_parser_spec.rb
+- spec/jobs.yml
 - spec/spec_helper.rb
 - templates/octave.m.erb
 has_rdoc: true
@@ -80,5 +108,6 @@ specification_version: 3
 summary: Ruby driver for httperf - automated load and performance testing
 test_files: 
 - spec/arg_parser_spec.rb
+- spec/hansel_spec.rb
 - spec/httperf_result_parser_spec.rb
 - spec/spec_helper.rb

data/README.rdoc

@@ -1,22 +0,0 @@
-= hansel
-
-Description goes here.
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
-== References
-
-"HTTP Perforance Testing with httperf":http://agiletesting.blogspot.com/2005/04/http-performance-testing-with-httperf.html
-"Perforance vs Load Testing":http://agiletesting.blogspot.com/2005/04/more-on-performance-vs-load-testing.html
-
-== Copyright
-
-Copyright (c) 2010 Paul Mylchreest. See LICENSE for details.