hippoload 0.0.1 → 0.0.2

data/README.md

@@ -2,8 +2,10 @@
 
 Basic Ruby wrapper/parser for Httperf
 
-Currently it supports 'get' method of httperf.
 
+> Httperf is a tool for measuring web server performance. It provides a flexible facility for generating various HTTP workloads and for measuring server performance.
+
+Currently it supports 'get' method of httperf.
 
 ## Installation
 
@@ -26,6 +28,19 @@ require "hippoload"
 
 # for single connections and rate
 
+# Conf arguments: (Note: Currently it supports only these arguments. New arguments are coming soon...)
+
+# conf = {
+#   :connections => '300',
+#   :rate => '30',
+#   :server => 'mysite.com' # by default it's 'localhost',
+#   :port => '8080' # by default it's '3000',
+#   :connections_and_rates => [{:connections => 1000, :rate => 10}, {:connections => 2000, :rate => 200}]
+#   :uri => '/posts'
+# }
+
+# Note: Please assign either (:connections and :rate) or (:connections_and_rates) at a time
+
 conf = {:connections => 100, :rate => 10, :uri => "/api/v1/entities?app_token=ef6baaed0d294f8f54eef80aeb8a4ee1" }
 
 hippo = Hippoload::Hippo.new(conf)
@@ -40,13 +55,14 @@ hippo_parser.parse(raw_output)
 
 # for connections and rates list
 
-conf = {:connections_and_rates => [{:connections => 100, :rate => 10}, {:connections => 200, :rate => 20}], :uri => "/api/v1/entities?app_token=ef6baaed0d294f8f54eef
+conf = {:connections_and_rates => [{:connections => 100, :rate => 10}, {:connections => 200, :rate => 20}], :uri => "/api/v1/entities?app_token=ef6baaed0d294f8f54eef80aeb8a4ee1"}
 
 hippo = Hippoload::Hippo.new(conf)
 
 hippo.becomes_crazy
 
 # connections list wise => {"100-10-/api/v1/entities?app_token=ef6baaed0d294f8f54eef80aeb8a4ee1"=>"httperf --client=0/1 --server=localhost --port=3000 --uri=/api/v1/entities?app_token=ef6baaed0d294f8f54eef80aeb8a4ee1 --rate=10 --send-buffer=4096 --recv-buffer=16384 --num-conns=100 --num-calls=1\nMaximum connect burst length: 1\n\nTotal: connections 100 requests 100 replies 100 test-duration 9.951 s\n\nConnection rate: 10.0 conn/s (99.5 ms/conn, <=5 concurrent connections)\nConnection time [ms]: min 34.3 avg 69.5 max 400.1 median 50.5 stddev 57.6\nConnection time [ms]: connect 0.1\nConnection length [replies/conn]: 1.000\n\nRequest rate: 10.0 req/s (99.5 ms/req)\nRequest size [B]: 120.0\n\nReply rate [replies/s]: min 10.0 avg 10.0 max 10.0 stddev 0.0 (1 samples)\nReply time [ms]: response 68.9 transfer 0.5\nReply size [B]: header 642.0 content 4901.0 footer 0.0 (total 5543.0)\nReply status: 1xx=0 2xx=100 3xx=0 4xx=0 5xx=0\n\nCPU time [s]: user 2.14 system 7.81 (user 21.5% system 78.5% total 99.9%)\nNet I/O: 55.6 KB/s (0.5*10^6 bps)\n\nErrors: total 0 client-timo 0 socket-timo 0 connrefused 0 connreset 0\nErrors: fd-unavail 0 addrunavail 0 ftab-full 0 other 0\n", "150-15-/api/v1/entities?app_token=ef6baaed0d294f8f54eef80aeb8a4ee1"=>"httperf --client=0/1 --server=localhost --port=3000 --uri=/api/v1/entities?app_token=ef6baaed0d294f8f54eef80aeb8a4ee1 --rate=15 --send-buffer=4096 --recv-buffer=16384 --num-conns=150 --num-calls=1\nMaximum connect burst length: 1\n\nTotal: connections 150 requests 150 replies 150 test-duration 9.988 s\n\nConnection rate: 15.0 conn/s (66.6 ms/conn, <=7 concurrent connections)\nConnection time [ms]: min 34.3 avg 92.1 max 415.4 median 71.5 stddev 68.8\nConnection time [ms]: connect 0.1\nConnection length [replies/conn]: 1.000\n\nRequest rate: 15.0 req/s (66.6 ms/req)\nRequest size [B]: 120.0\n\nReply rate [replies/s]: min 15.0 avg 15.0 max 15.0 stddev 0.0 (1 samples)\nReply time [ms]: response 91.9 transfer 0.0\nReply size [B]: header 642.0 content 4901.0 footer 0.0 (total 5543.0)\nReply status: 1xx=0 2xx=150 3xx=0 4xx=0 5xx=0\n\nCPU time [s]: user 1.76 system 8.21 (user 17.6% system 82.2% total 99.9%)\nNet I/O: 83.1 KB/s (0.7*10^6 bps)\n\nErrors: total 0 client-timo 0 socket-timo 0 connrefused 0 connreset 0\nErrors: fd-unavail 0 addrunavail 0 ftab-full 0 other 0\n"}
+
 ```
 ## Contributing
 
@@ -55,3 +71,10 @@ hippo.becomes_crazy
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Other similar Ruby gems/libraries
+
+1. [httperfrb](https://github.com/rubyops/httperfrb)
+2. [stresser](https://github.com/moviepilot/stresser)
+3. [httperf-output-parser](https://github.com/wjessop/httperf-output-parser)
+

data/lib/hippoload/hippo.rb

@@ -12,19 +12,27 @@ module Hippoload
     attr_reader :connections, :rate, :server, :port, :uri, :connections_and_rates
 
     def initialize(conf)
+
+      raise ArgumentError, 'Argument is not hash' unless conf.is_a? Hash
+
       @connections = conf[:connections]
       @rate = conf[:rate]
       @server = conf[:server] || 'localhost'
       @port = conf[:port] || '3000'
       @uri = conf[:uri]
-      @connections_and_rates = conf[:connections_and_rates] || default_connections_and_rates
+      @connections_and_rates = if !conf[:connections_and_rates].nil?
+                                 conf[:connections_and_rates]
+                               elsif @connections.nil? && @rate.nil?
+                                 default_connections_and_rates
+                               end
 
-      raise_error_if_wrong_conf
+      raise Hippo.wrong_conf_message if wrong_configuration
     end
 
     def attack
-      set_connections if !@connections.nil?
-      set_rate if !@rate.nil?
+      raise "Httperf is not installed on your machine" unless httperf_installed?
+      set_connections if @connections.nil?
+      set_rate if @rate.nil?
       %x(httperf --num-conns=#{@connections} --rate=#{@rate} --server=#{@server} --port=#{@port} --uri="#{@uri}")
     end
 
@@ -40,6 +48,13 @@ module Hippoload
       raw_outputs
     end
 
+    class << self
+      def wrong_conf_message
+        "You are missing :connections or :rate arrtibute or may be,
+        either assign (:connections, :rate) or assign :connections_and_rates attribute"
+      end
+    end
+
     private
 
     def default_connections_and_rates
@@ -50,21 +65,29 @@ module Hippoload
         { :connections => 500,  :rate =>  50 },
         { :connections => 700,  :rate =>  70 },
         { :connections => 1000, :rate => 100 }
-      ] if (!@connections.nil? or !@rate.nil?) && !@connections_and_rates.nil?
+      ]
     end
 
     def set_connections
-      @connections = @connections ||  default_connections_and_rates.first[:connections]
+      @connections ||=  default_connections_and_rates[0][:connections]
+      puts "--" * 50
+      puts "NOTE: You haven't passed the no of connections, so setting default value (#{@connections}) for the connections."
+      puts "--" * 50
     end
 
     def set_rate
-      @rate = @rate ||  default_connections_and_rates.first[:rate]
+      @rate ||=  default_connections_and_rates[0][:rate]
+      puts "--" * 50
+      puts "NOTE: You haven't passed the value for rate, so setting default value (#{@rate}) for the rate."
+      puts "--" * 50
     end
 
-    def raise_error_if_wrong_conf
-      if (!@connections.nil? || !@rate.nil?) && !@connections_and_rates.nil?
-        raise "You can not assign (:connections, :rate) at same with :connections_and_rates attributes. Either assign (:connections, :rate) or assign :connections_and_rates attribute"
-      end
+    def wrong_configuration
+      (!@connections.nil? || !@rate.nil?) && !@connections_and_rates.nil?
+    end
+
+    def httperf_installed?
+      system("which httperf > /dev/null 2>&1")
     end
   end
 end

data/lib/hippoload/hippo_parser.rb

@@ -1,6 +1,8 @@
 module Hippoload
   class HippoParser
 
+    # Inspired by https://github.com/wjessop/httperf-output-parser/blob/master/lib/httperf-output-parser.rb
+
     DATATYPES = %w(
                 total_conenctions
                 duration

data/lib/hippoload/version.rb

@@ -1,3 +1,3 @@
 module Hippoload
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/hippo_spec.rb

@@ -11,10 +11,15 @@ describe Hippoload::Hippo do
       :uri => "/posts",
       :connections_and_rates => [{ :connections => 100, :rate => 10 }]
     }
+
   end
 
+  let(:wrong_arg) {['worng_arg']}
+
   describe "Hippo#attributes_methods" do
 
+    # These tests are tested using real database with the httperf tool
+
     it "should have attributes reader" do
       hippo = Hippoload::Hippo.new(basic_conf)
       hippo.connections.should eql(100)
@@ -29,6 +34,10 @@ describe Hippoload::Hippo do
       expect { Hippoload::Hippo.new(wrong_conf) }.to raise_error
     end
 
+    it "should raise error if wrong argument passed" do
+      expect { Hippoload::Hippo.new(wrong_arg) }.to raise_error
+    end
+
     it "should not raise error if correct conf passed" do
       expect { Hippoload::Hippo.new(basic_conf) }.to_not raise_error
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hippoload
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-28 00:00:00.000000000 Z
+date: 2013-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec