solutious-stella 0.5.5 → 0.6.0

data/lib/stella/adapter/base.rb

@@ -1,106 +0,0 @@
-
-
-module Stella::Adapter
-  class CommandNotReady < RuntimeError
-    def initialize(name="")
-      super(Stella::TEXT.msg(:error_adapter_command_not_ready, name))
-    end
-  end
-  
-  class Base
-    
-    
-    attr_accessor :working_directory
-    attr_reader :load_factor, :arguments
-    
-    def initialize(options={}, arguments=[])
-      if options.is_a? Array
-        self.process_arguments(options) 
-      else
-        self.options = options
-        self.arguments = arguments 
-      end
-    end
-    
-    def load_factor=(load_factor)
-      @load_factor = load_factor
-    end
-    def stdout_path
-      File.join(@working_directory, 'STDOUT.txt')
-    end
-    
-    def stderr_path
-      File.join(@working_directory, 'STDERR.txt')
-    end
-    
-    def summary_path(ext='yaml')
-      File.join(@working_directory, "SUMMARY.#{ext}")
-    end
-    
-    # process_arguments
-    #
-    # This method must be overridden by the implementing class. This is intended
-    # for processing the command-specific command-line arguments
-    def process_arguments
-      raise Stella::TEXT.msg(:error_class_must_override, 'process_options')
-    end
-    
-    # options=
-    #
-    # Takes a hash, OpenStruct and applies the values to the instance variables. 
-    # The keys should conincide with with the command line argument names. 
-    # by process_options first and 
-    # i.e. The key for --help should be :help 
-    def options=(options={})
-      options = options.marshal_dump if options.is_a? OpenStruct
-      
-      unless options.nil? || options.empty?
-        options.each_pair do |name,value|
-          next if @private_variables.member?(name)
-          Stella::LOGGER.info(:error_class_unknown_argument, name) && next unless self.respond_to?("#{name.to_s}=")
-          instance_variable_set("@#{name.to_s}", value)
-        end
-      end
-    end
-    
-    def arguments=(arguments=[])
-      @arguments = arguments unless arguments.nil? 
-    end
-    
-    def available?
-      (version.to_f > 0)
-    end
-    
-    def name
-      @name
-    end
-    
-    def rate
-      @rate || 0
-    end
-    def vuser_rate
-      "#{vusers}/#{rate}"
-    end
-    
-    def command
-      raise Stella::TEXT.msg(:error_class_must_override, 'command')
-    end
-    
-    def summary
-      raise Stella::TEXT.msg(:error_class_must_override, 'summary')
-    end
-    
-    def add_header
-      raise Stella::TEXT.msg(:error_class_must_override, 'add_header')
-    end
-    
-    def user_agent=
-      raise Stella::TEXT.msg(:error_class_must_override, 'user_agent=')
-    end
-    
-    private
-    
-    
-  end
-end
-  

data/lib/stella/adapter/httperf.rb

@@ -1,305 +0,0 @@
-
-
-module Stella
-  module Adapter
-
-    #Usage: httperf [-hdvV] [--add-header S] [--burst-length N] [--client N/N]
-    #	[--close-with-reset] [--debug N] [--failure-status N]
-    #	[--help] [--hog] [--http-version S] [--max-connections N]
-    #	[--max-piped-calls N] [--method S] [--no-host-hdr]
-    #	[--num-calls N] [--num-conns N] [--period [d|u|e]T1[,T2]]
-    #	[--port N] [--print-reply [header|body]] [--print-request [header|body]]
-    #	[--rate X] [--recv-buffer N] [--retry-on-failure] [--send-buffer N]
-    #	[--server S] [--server-name S] [--session-cookies]
-    #	[--ssl] [--ssl-ciphers L] [--ssl-no-reuse]
-    #	[--think-timeout X] [--timeout X] [--uri S] [--verbose] [--version]
-    #	[--wlog y|n,file] [--wsess N,N,X] [--wsesslog N,X,file]
-    #	[--wset N,X]
-    # 
-    class Httperf < Stella::Adapter::Base
-      
-      
-      
-      attr_accessor :hog, :server, :uri, :num_conns, :num_calls, :rate, :timeout, :think_timeout, :port
-      attr_accessor :burst_length, :client, :close_with_reset, :debug, :failure_status
-      attr_accessor :help, :http_version, :max_connections, :max_piped_calls, :method, :no_host_hdr
-      attr_accessor :period, :print_reply, :print_request, :recv_buffer, :retry_on_failure, :send_buffer
-      attr_accessor :server_name, :session_cookies, :ssl, :ssl_ciphers, :ssl_no_reuse, :verbose 
-      
-      attr_writer :version, :add_header, :wlog, :wsess, :wsesslog, :wset
-      
-      def initialize(options={}, arguments=[])
-        
-        @name = 'httperf'
-        @private_variables = ['private_variables', 'name', 'arguments', 'load_factor', 'working_directory']
-        @load_factor = 1
-        
-        super(options, arguments)
-      end
-      
-      
-      
-      def error
-        (File.exists? stderr_path) ? FileUtil.read_file(stderr_path) : "Unknown error"
-      end
-      
-      # Before calling run
-      def before
-
-        
-      end
-      def command
-        raise CommandNotReady.new(self.class.to_s) unless ready?
-
-        command = "#{@name} "
-
-        instance_variables.each do |name|
-          canon = name.tr('@', '')        # instance_variables returns '@name'
-          next if @private_variables.member?(canon)
-          
-          # It's important that we take the value from the getter method
-          # because it applies the load factor. 
-          value = self.send(canon)
-          if (value.is_a? Array)
-            value.each { |el| command << "--#{canon.tr('_', '-')} #{EscapeUtil.shell_single_word(el.to_s)} " }
-          else
-            command << "--#{canon.tr('_', '-')} #{EscapeUtil.shell_single_word(value.to_s)} "
-          end
-
-        end
-
-        command << (@arguments.map { |uri| "'#{uri}'" }).join(' ') unless @arguments.empty?
-        command
-      end
-      
-      # After calling run
-      def after
-
-
-      end
-
-      def process_arguments(arguments)
-        
-        opts = OptionParser.new 
-        opts.on('--hog') do @hog = true end
-        opts.on('--server=S', String) do |v| @server = v end
-        opts.on('--server-name=S', String) do |v| @server_name = v end
-        opts.on('--port=N', Integer) do |v| @port = v end
-        opts.on('--uri=S', String) do |v| @uri = v end
-        opts.on('--num-conns=N', Integer) do |v| @num_conns = v end
-        opts.on('--num-calls=N', Integer) do |v| @num_calls = v end
-        opts.on('--rate=N', Integer) do |v| @rate = v end
-        opts.on('--timeout=N', Integer) do |v| @timeout = v end
-        opts.on('--think-timeout=N', Integer) do |v| @think_timeout = v end
-        
-        opts.on('-h', '--help') do |v| @help = true end
-        opts.on('-v', '--verbose') do |v| @verbose = true end
-        opts.on('-V', '--version') do |v| @version = true end
-        opts.on('--close-with-reset') do |v| @close_with_reset = true end
-        opts.on('--session-cookies') do |v| @session_cookies = true end
-        opts.on('--ssl') do |v| @ssl = true end
-        opts.on('--ssl-ciphers') do |v| @ssl_ciphers = true end
-        opts.on('--ssl-no-reuse') do |v| @ssl_no_reuse = true end
-        opts.on('--no-host-hdr') do |v| @no_host_hdr = true end
-        opts.on('--retry-on-failure') do |v| @retry_on_failure = true end
-              
-        opts.on('--add-header=S', String) do |v| @add_header ||= []; @add_header << v; end
-        opts.on('--burst-length=N', Integer) do |v| @burst_length = v end
-        opts.on('--client=S', String) do |v| @client = v end
-        opts.on('-d N', '--debug=N', Integer) do |v| @debug ||= 0; @debug = v end
-        opts.on('--failure-status=N', Integer) do |v| @failure_status = v end
-        
-        opts.on('--http-version=S', String) do |v| @http_version = v end
-        
-        opts.on('--max-connections=N', Integer) do |v| @max_connections = v end
-        opts.on('--max-piped-calls=N', Integer) do |v| @max_piped_calls = v end
-        opts.on('--method=S', String) do |v| @method = v end
-        
-        opts.on('--period=S', String) do |v| @period = v end # TODO: Requires parsing
-        opts.on('--print-reply=[S]', String) do |v| @print_reply = v end
-        opts.on('--print-request=[S]', String) do |v| @print_request = v end
-          
-        opts.on('--recv-buffer=N', Integer) do |v| @recv_buffer = v end
-        opts.on('--send-buffer=N', Integer) do |v| @send_buffer = v end
-        
-        
-        opts.on('--wlog=S', String) do |v| @wlog = Stella::Util::expand_str(v) end
-        opts.on('--wsess=S', String) do |v| @wsess = Stella::Util::expand_str(v, Integer) end
-        opts.on('--wsesslog=S', String) do |v| @wsesslog = Stella::Util::expand_str(v) end
-        opts.on('--wset=S', String) do |v| @wset = Stella::Util::expand_str(v) end
-        
-        if @wsess
-          
-        end
-        
-        # parse! removes the options it finds.
-        # It also fails when it finds unknown switches (i.e. -X)
-        # Which should leave only the remaining arguments (URIs in this case)
-        opts.parse!(arguments)
-        
-        self.arguments = arguments
-        
-      rescue OptionParser::InvalidOption => ex
-        # We want to replace this text so we grab just the name of the argument
-        badarg = ex.message.gsub('invalid option: ', '')
-        raise InvalidArgument.new(badarg)
-      end
-
-      
-      def version
-        vsn = 0
-        Stella::Util.capture_output("#{@name} --version") do |stdout, stderr|
-           stdout.join.scan(/httperf\-([\d\.]+)\s/) { |v| vsn = v[0] }
-        end
-        vsn
-      end
-      
-      # loadtest
-      #
-      # True or false: is the call to siege a load test? If it's a call to help or version or
-      # to display the config this with return false. It's no reason for someone to make this 
-      # call through Stella but it's here for goodness sake. 
-      def loadtest?
-        @uri && !@uri.empty?
-      end
-      def ready?
-        @name && !instance_variables.empty?
-      end
-      
-      def add_header(name=false, value=false)
-        # This is a hack since we have an instance variable called add_header.
-        # I figure this is the best of two evils because I'd rather keep the 
-        # instance variable naming consistent. 
-        return @add_header if !name && !value 
-        @add_header ||= []
-        @add_header << "#{name}: #{value}"
-      end
-      
-      def user_agent=(list=[])
-        return unless list && !list.empty?
-        list = list.to_ary
-        list.each do |agent|
-          add_header("User-Agent", agent)
-        end
-      end
-      def vusers
-         @wsess[1]
-      end
-      def vuser_rate
-        "#{vusers}/#{rate}"
-      end
-      
-      def vusers=(v)
-        0
-      end
-      def requests
-        @num_conns || (@wsess[0] * @wsess[1])
-      end
-      def requests=(v)
-        0
-      end
-      def vuser_requests
-        0
-      end
-      def wsess
-        @wsess.join(',')
-      end
-      
-      def wset
-        @wset.join(',')
-      end
-      
-      
-      def wsesslog
-        @wsesslog.join(',')
-      end
-      def wlog
-        @wlog.join(',')
-      end
-      
-      #def concurrent
-      #  (@concurrent * @load_factor).to_i
-      #end
-      #def concurrent_f
-      #  (@concurrent * @load_factor).to_f
-      #end
-      #def reps
-      #  @reps
-      #end
-      
-      
-
-      # Siege writes the summary to STDERR
-      def summary_file
-        File.new(stdout_path) if File.exists?(stdout_path)
-      end
-      
-      def rc_file
-        File.join(@working_directory, "siegerc") 
-      end
-      
-      def log_file
-        File.join(@working_directory, "siege.log")
-      end
-      
-      def uris_file
-        File.join(@working_directory, File.basename(@file))
-      end
-      
-      # httperf --hog --timeout=30 --client=0/1 --server=127.0.0.1 --port=5600 --uri=/ --send-buffer=4096 --recv-buffer=16384 --num-conns=5 --num-calls=1
-      # httperf: warning: open file limit > FD_SETSIZE; limiting max. # of open files to FD_SETSIZE
-      # Maximum connect burst length: 1
-      # 
-      # Total: connections 5 requests 5 replies 5 test-duration 0.513 s
-      # 
-      # Connection rate: 9.7 conn/s (102.7 ms/conn, <=1 concurrent connections)
-      # Connection time [ms]: min 102.1 avg 102.7 max 104.1 median 102.5 stddev 0.8
-      # Connection time [ms]: connect 0.2
-      # Connection length [replies/conn]: 1.000
-      # 
-      # Request rate: 9.7 req/s (102.7 ms/req)
-      # Request size [B]: 62.0
-      # 
-      # Reply rate [replies/s]: min 0.0 avg 0.0 max 0.0 stddev 0.0 (0 samples)
-      # Reply time [ms]: response 102.3 transfer 0.1
-      # Reply size [B]: header 136.0 content 96.0 footer 0.0 (total 232.0)
-      # Reply status: 1xx=0 2xx=5 3xx=0 4xx=0 5xx=0
-      # 
-      # CPU time [s]: user 0.12 system 0.39 (user 22.5% system 75.3% total 97.8%)
-      # Net I/O: 2.8 KB/s (0.0*10^6 bps)
-      # 
-      # Errors: total 0 client-timo 0 socket-timo 0 connrefused 0 connreset 0
-      # Errors: fd-unavail 0 addrunavail 0 ftab-full 0 other 0
-      
-      def summary
-        return unless summary_file
-        
-        raw = summary_file.readlines.join
-        stats = Stella::Test::Run::Summary.new
-        
-        raw.scan(/Request rate: (\d+?\.\d+?) req.s .(\d+?\.\d+?) ms.req./) do |rate,time|
-          stats.transaction_rate = rate.to_f
-          stats.response_time = (time.to_f) / 1000
-        end
-         
-        raw.scan(/connections (\d+?) requests (\d+?) replies (\d+?) test-duration (\d+\.\d+?) s/) do |conn,req,rep,time|  
-          stats.elapsed_time = time.to_f
-          stats.successful = rep.to_i
-          stats.failed = conn.to_i - rep.to_i # maybe this should be from the Error line
-          stats.transactions = conn.to_i
-        end
-        
-        raw.scan(/header (\d+\.\d+?)\s+.+?\s+.total (\d+\.\d+?)./) do |h,t|
-          stats.data_transferred = ((t.to_f || 0 ) / 1_048_576).to_f
-          stats.headers_transferred = ((h.to_f || 0 ) / 1_048_576).to_f
-        end
-        stats.vusers = self.vusers
-        
-        stats
-      end
-
-
-
-    end
-  end
-end

data/lib/stella/adapter/pcap_watcher.rb

@@ -1,221 +0,0 @@
-
-require 'webrick'  
-require 'stringio'
-require 'net/dns/packet'
-
-
-module Stella
-  module Adapter
-    # Make sure Stella's lib directory is before the system defined ones. 
-    # We are using a modified version of pcaplet.rb. 
-    require 'pcap'
-    require 'observer'
-    
-    # Stella::Adapter::PcapWatcher
-    #
-    # Record HTTP or DNS events with Pcap (TCP sniffer). This requires ruby-pcap and the C pcap 
-    # library as well as root acceess (TCP packet sniffing requires root privileges). If you're
-    # running Ruby 1.9, JRuby, or Windows this will not be available on your system. 
-    # To sniff traffic, you must be on either the machine sending the requests or the machine
-    # receiving the requests. 
-    class PcapWatcher
-      include Observable
-      
-      # Building Ruby::Pcap with Ruby 1.9.1
-      # RSTRING()->len ia now RSTRING_LEN(), ... 
-      #   see: http://gnufied.org/2007/12/21/mysql-c-bindings-for-ruby-19/#comment-3133
-      #   see: http://www.rubyinside.com/ruby-1-9-1-preview-released-why-its-a-big-deal-1280.html#comment-37223
-      # TRAP_BEG and TRAP_END are also fucked. But the fix is not clear. 
-      # Basically Ruby::PCap is not ready for 1.9
-      # See: http://d.hatena.ne.jp/takuma104/20080210/1202638583
-      
-        # Network interface device ID. eri0, en0, lo0, etc... /sbin/ifconfig -a will tell you. 
-      attr_accessor :device
-        # Buffer size, in bytes, to read from each packet (default: 1500)
-      attr_accessor :snaplen
-        # Port of the machine sending requests (default: 80)
-      attr_accessor :sport
-        # Port of the machine receiving requests (default: 80)
-      attr_accessor :dport
-        # dns or http
-      attr_accessor :service
-        # udp or tcp
-      attr_accessor :protocol
-        # Maximum number of packets to sniff
-      attr_accessor :maxpacks
-      
-      attr_reader :pcaplet
-      
-      def initialize(options={})
-        # The proper service name for dns is "domain"
-        @service = options[:service] || 'http'
-        @service = 'domain' if options[:service] == 'dns'
-        
-        if @service == 'domain'
-          @protocol = 'udp'
-        else
-          @protocol = options[:protocol] || 'tcp'
-        end
-        
-        @dport = options[:port] || Socket::getservbyname(@service)
-        @sport = options[:port] || @dport
-        
-        @device = options[:device] || guess_device
-        @snaplen = options[:snaplen] || 10000         # 10KB
-        @maxpacks = options[:maxpacks] || 100_000
-        
-        Stella::LOGGER.info("Watching interface #{@device} for #{@service} activity on #{@protocol} port #{@dport}")
-      end
-      
-      def guess_device
-        # NOTE: This should be passed in as a value, not called from the global
-        case Stella::SYSINFO.implementation
-        when :osx
-          "en1" # Pcap.lookupdev returns en0
-        else
-          Pcap.lookupdev
-        end
-      end
-      
-      def run
-        
-        if (respond_to? "monitor_#{@service}")
-          self.send("monitor_#{@service}")
-        else
-          raise "Unknown service type (#{@service})"
-        end
-        
-      end
-      
-      
-      
-      # monitor_domain
-      #
-      # Use Ruby-Pcap to sniff packets off the network interface. 
-      #
-      # DNS monitor based on: http://www.linuxjournal.com/article/9614
-      # Install http://rubyforge.org/projects/net-dns
-      #
-      # NOTE: Is there a better way to match up a request packet with a
-      # response packet?
-      # We keep connect a request with the response using the domain name. 
-      # It's possible that two (or more) requests to be made for the same domain 
-      # at the same time and the responses could be mixed up. This will affect
-      # the exact response time but probably not by much.
-      def monitor_domain
-
-        @pcaplet = Pcaplet.new(:device => @device, :count => @maxpacks)
-        
-        req_filter  = Pcap::Filter.new("#{@protocol} and dst port #{@dport}", @pcaplet.capture)
-        resp_filter = Pcap::Filter.new("#{@protocol} and src port #{@dport}", @pcaplet.capture)
-        @pcaplet.add_filter(req_filter | resp_filter)
-        @pcaplet.each_packet do |packet|
-          data = packet.udp_data
-          case packet
-          when req_filter
-            dobj = Stella::Data::DomainRequest.new(data)
-            dobj.time = packet.time
-            dobj.client_ip = packet.ip_src
-            dobj.server_ip = packet.ip_dst
-            
-            changed
-            notify_observers(:domain_request, dobj)
-            
-          when resp_filter
-            dobj = Stella::Data::DomainResponse.new(data)
-            dobj.time = packet.time
-            dobj.client_ip = packet.ip_dst
-            dobj.server_ip = packet.ip_src
-            
-            changed
-            notify_observers(:domain_response, dobj)
-          end
-          
-        end
-
-      rescue Interrupt
-        after
-        exit
-      end
-      
-
-      def monitor_http
-        
-        @pcaplet = Pcaplet.new(:device => @device, :count => @maxpacks)
-            
-        begin
-          req_filter  = Pcap::Filter.new("#{@protocol} and dst port #{@dport}", @pcaplet.capture)
-          resp_filter = Pcap::Filter.new("#{@protocol} and src port #{@sport}", @pcaplet.capture)
-          @pcaplet.add_filter(req_filter | resp_filter)
-          @pcaplet.each_packet do |packet|
-            data = packet.tcp_data
-            next if data.nil?
-            
-            
-            # NOTE: With HTTP 1.1 keep alive connections, multiple requests can be passed
-            # through single connection. This makes it difficult to match responses with
-            # requests. 
-            # NOTE: We don't parse the body of POST and PUT requests because the data can
-            # be (and likely is), split across numerous packets. We also only grab 1500
-            # bytes from each packet. 
-            # NOTE: The hostname is taken from the Host header. Requests made without 
-            # this header (including HTTP 1.0) will contain the local hostname instead. 
-            # TODO: resolve the hostname from the IP address.   
-            # There are some helpful methods for doing some of this stuff:
-            # http://www.goto.info.waseda.ac.jp/~fukusima/ruby/pcap/doc/TCPPacket.html
-            case packet
-            when req_filter
-              next unless data and data =~ /^(GET|POST|HEAD|DELETE|PUT)\s+(.+?)\s+(HTTP.+?)$/
-              dobj = Stella::Data::HTTPRequest.new(data.gsub(/\r?\n/, $/)) # Use the system's line terminators
-              dobj.time = packet.time
-              dobj.client_ip = packet.ip_src
-              dobj.server_ip = packet.ip_dst
-              
-              changed
-              notify_observers(:http_request, dobj)  
-              
-            when resp_filter
-              # NOTE: Some responses do not contain a body in the first packet.
-              # TODO: investigate further. Try: http://www.ruby-doc.org/core/classes/Enumerable.html
-              next unless data and data =~ /^(HTTP.+)$/
-              dobj = Stella::Data::HTTPResponse.new(data.gsub(/\r?\n/, $/))
-              dobj.time = packet.time
-              dobj.client_ip = packet.ip_dst
-              dobj.server_ip = packet.ip_src
-              
-              changed
-              notify_observers(:http_response, dobj)
-                
-            end
-          
-          end
-        rescue Interrupt
-          after
-          exit
-        rescue => ex
-          Stella::LOGGER.error(ex)
-        end
-        
-        
-      end
-      
-      def after
-      STDOUT.flush
-        stat = @pcaplet.capture.stats
-        if stat
-          Stella::LOGGER.info("#{$/}#{stat.recv} packets received by filter");
-          Stella::LOGGER.info("#{stat.drop} packets dropped by kernel", ''); # with an extra line
-        end
-        STDOUT.flush
-        @pcaplet.capture.close
-        delete_observers
-      rescue
-        
-        # Ignore errors
-      end
-      
-      
-    end
-  end
-end
-