stella 0.5.1 → 0.5.3

data/lib/stella/cli.rb

@@ -2,13 +2,14 @@
 require 'optparse'
 require 'ostruct'
 
-# All command-line interface wrappers
 require 'stella/cli/base'
-require 'stella/cli/language'
-require 'stella/cli/localtest'
 
 module Stella
   
+  # Stella::Config
+  #
+  # This Config class manages the content of ENV['HOME]/.stella. The functionality 
+  # is currently disabled so stella is stateless. 
   class Config < Storable
     DEFAULT_HOME = File.join(ENV['HOME'], '.stella').freeze unless defined? DEFAULT_HOME
     DEFAULT_DATA_HOME = File.join(Dir.getwd, 'stella').freeze unless defined? DEFAULT_DATA_HOME
@@ -42,27 +43,36 @@ module Stella
       
   end
     
-    
+  # Stella::CLI
+  #
+  # The is the front-end class for the command-line implementation. The stella script
+  # creates an instance of this class which is the glue between the command-line
+  # and the Stella command classes. 
+  # Note: All Stella::CLI classes are autoloaded and they add themselves to @@commands. 
   class CLI
     
+    # Auto populated with 'command' => Stella::CLI::[class] by each cli class on 'require'.
+    @@commands = {}
+    
     attr_reader :options
     attr_reader :logger
-    attr_accessor :commands
+    
 
+    
     def initialize(arguments=[], stdin=nil)
       @arguments = arguments
       @stdin = stdin
       
-      @commands = {
-        'ab'      => Stella::CLI::LocalTest,
-        'siege'   => Stella::CLI::LocalTest,
-        'httperf'   => Stella::CLI::LocalTest,
-        'lang'    => Stella::CLI::Language
-      }
       @config = Stella::Config.new
       @options = OpenStruct.new
       @options.verbose = 0
+      @options.data_path = @config.working_directory
       @options.agents = []
+      
+    end
+    
+    def commands
+      @@commands
     end
     
     def run
@@ -76,13 +86,13 @@ module Stella
           
       # Pull the requested command object out of the list
       # and tell it what shortname that was used to call it.
-      command = @commands[@command_name].new(@command_name)
+      command = @@commands[@command_name].new(@command_name)
       
       # Give the command object access to the config and runtime options
       #command.global_config = @config 
       command.stella_options = @options
       command.arguments = @command_arguments
-      command.working_directory = @config.working_directory
+      command.working_directory = @options.data_path
       
       command.run
       
@@ -104,7 +114,7 @@ module Stella
 
           @command_name = nil     
           @arguments.each do |arg|
-            if (@commands.has_key? arg)
+            if (@@commands.has_key? arg)
               @command_name = arg 
               index = @arguments.index(@command_name)
               @command_arguments = @arguments[index + 1..@arguments.size] 
@@ -133,7 +143,7 @@ module Stella
 
           opts = OptionParser.new 
           opts.banner = Stella::TEXT.msg(:option_help_usage)
-          opts.on Stella::TEXT.msg(:option_help_preamble, @commands.keys.join(', '))
+          opts.on Stella::TEXT.msg(:option_help_preamble, @@commands.keys.join(', '))
 
           opts.on(Stella::TEXT.msg(:option_help_options_title))
           opts.on('-V', '--version', Stella::TEXT.msg(:option_help_version)) do
@@ -149,9 +159,13 @@ module Stella
           opts.on('-q', '--quiet', Stella::TEXT.msg(:option_help_quiet))   do
             @options.quiet = true 
           end
-          opts.on('--overhead', String, Stella::TEXT.msg(:option_help_overhead)) do
-            @options.showoverhead = true 
-          end
+          
+          # Overhead is interesting for development and auditing but we're not
+          # currently tracking this. It needed to be re-implemented from scratch
+          # so we'll redo this soon. It's also useful for comparing Ruby/JRuby/IronRuby
+          #opts.on('--overhead', String, Stella::TEXT.msg(:option_help_overhead)) do
+          #  @options.showoverhead = true 
+          #end
           
           opts.on('-O', '--stdout', Stella::TEXT.msg(:option_help_stdout)) do
             @options.stdout = true 
@@ -183,10 +197,9 @@ module Stella
             @options.warmup = MathUtil.enforce_limit(((v) ? v : 0), 0.1, 1)
           end
 
-          opts.on('-a', '--agent=S', String, Stella::TEXT.msg(:option_help_agent)) do |v| 
-            raise "Agent is empty" if v.empty?
+          opts.on('-a', '--agent=[S]', String, Stella::TEXT.msg(:option_help_agent)) do |v| 
             @options.agents ||= []
-            agent_ary = Stella::Util::expand_str(v)
+            agent_ary = Stella::Util::expand_str(v || 'random')
             @options.agents.push(agent_ary)
           end
 
@@ -248,7 +261,7 @@ module Stella
           #  Stella::LOGGER.debug("ENV[#{n}]=#{v}")
           #end
 
-          Stella::LOGGER.debug("Commands (#{@command_name}): #{@commands.keys.join(',')}")
+          Stella::LOGGER.debug("Commands (#{@command_name}): #{@@commands.keys.join(',')}")
 
           #Stella::LOGGER.debug("Configs: ")
           #@config.to_hash.each_pair do |n,v|
@@ -265,4 +278,14 @@ module Stella
           Stella::LOGGER.debug("Command Arguments: #{@command_arguments.join(',')}" )
         end
   end
+end
+
+# Autoload CLI classes. These classes add themselves to the class variable @@commands. 
+begin
+  cli_classes = Dir.glob(File.join(STELLA_HOME, 'lib', 'stella', 'cli', "*.rb"))
+  cli_classes.each do |path|
+    require path
+  end
+rescue LoadError => ex
+  Stella::LOGGER.info("Error loading #{path}: #{ex.message}")
 end

data/lib/stella/cli/agents.rb

@@ -0,0 +1,73 @@
+
+
+
+module Stella 
+  class CLI
+    
+    class Agents < Stella::CLI::Base
+      
+      attr_accessor :full
+      attr_accessor :list
+      attr_accessor :search
+      attr_accessor :help
+      
+      def initialize(adapter)
+        super(adapter)
+        @full = false
+        @list = false
+        @help = false
+      end
+      
+      def run
+        process_options
+        
+        if @help
+          process_options(:display)
+          return
+        end
+        
+        # The LocalTest command is the keeper of the user agents
+        localtest = Stella::LocalTest.new
+        
+        agents = []
+        all_agents = localtest.available_agents
+        all_agents.each_pair do |key,value|
+          if (@full) 
+            value.each do |full_value|
+              agent = full_value.join(' ')
+              agents << agent if (!@search || agent.to_s.match(/#{search}/i))
+            end
+          else
+            agents << key.to_s if (!@search || key.to_s.match(/#{search}/i))
+          end
+        end
+ 
+        puts (@list) ? agents.uniq.sort.join("\n") : Stella::TEXT.msg(:agents_count_message, agents.uniq.size)
+
+      end
+      
+      def process_options(display=false)
+
+        opts = OptionParser.new
+        opts.banner = Stella::TEXT.msg(:option_help_usage)
+        opts.on('-h', '--help', Stella::TEXT.msg(:option_help_help)) { @help = true }
+        opts.on('-f', '--full', Stella::TEXT.msg(:agents_option_full)) { @full = true }
+        opts.on('-l', '--list', Stella::TEXT.msg(:agents_option_list)) { @list = true }
+        # TODO: display agents based on shortnames. This is important to maintain continuity with the stella option. 
+        #opts.on('-a', '--agent', Stella::TEXT.msg(:agents_option_list)) { @list = true } 
+        opts.on('-s', '--search=S', String, Stella::TEXT.msg(:agents_option_search)) { |v| @search = v }
+        
+        opts.parse!(@arguments)
+        
+        if display
+          Stella::LOGGER.info opts
+          return
+        end
+        
+      end
+      
+    end
+    
+    @@commands['agents'] = Stella::CLI::Agents
+  end
+end

data/lib/stella/cli/language.rb

@@ -12,5 +12,7 @@ module Stella
       end
       
     end
+    
+    @@commands['lang'] = Stella::CLI::Language
   end
 end

data/lib/stella/cli/localtest.rb

@@ -71,5 +71,10 @@ module Stella
 
       
     end
+  
+    
+    @@commands['ab'] = Stella::CLI::LocalTest
+    @@commands['siege'] = Stella::CLI::LocalTest
+    @@commands['httperf'] = Stella::CLI::LocalTest
   end
 end

data/lib/stella/command/base.rb

@@ -41,7 +41,7 @@ module Stella::Command
     def run_sleeper(duration)
       remainder = duration % 1 
       duration.to_i.times {
-        Stella::LOGGER.info_print('.')
+        Stella::LOGGER.info_print('.') unless @quiet
         sleep 1
       }
       sleep remainder if remainder > 0

data/lib/stella/command/localtest.rb

@@ -27,6 +27,7 @@ module Stella
     attr_reader :paths
     
     attr_accessor :working_directory
+    attr_reader :available_agents
     
     def initialize(testdef=nil, adapter=nil)
       @testdef = testdef if testdef
@@ -73,18 +74,16 @@ module Stella
       
       test_path = _generate_test_path
       
-      
       prepare_test(test_path)       
       
         threshold = (@testdef.rampup) ? @testdef.rampup.ceiling : @adapter.vusers
         
-        
         runnum = "00"
         while(@adapter.vusers <= threshold) do
           
           # Make sure the load factor is set to 1. If there was a warmup, 
           # then this value will be less than 1.
-          testrun = testrun_maker(1)
+          testrun = maker_of_testruns(1)
           
           # We empty test_runpaths so we can keep track of the runpaths for each
           # level of virtual users. This is useful during a rampup test so we can
@@ -117,7 +116,7 @@ module Stella
             if @testdef.sleep && @testdef.sleep.to_f > 0 && @testdef.repetitions > 1 
               run_sleeper(@testdef.sleep)
             end
-            Stella::LOGGER.info('') # We want the newline
+            Stella::LOGGER.info('') unless @quiet # We want the newline
           end
           
           # Rampup tests produce multiple summary files which include the batch
@@ -146,7 +145,7 @@ module Stella
           
           
           # Non-rampup tests only need to run through the loop once. 
-          break if (@adapter.vusers == threshold)
+          break if (!@testdef.rampup && @adapter.vusers == threshold)
         
       end
 
@@ -167,14 +166,66 @@ module Stella
     
     private
       
-      # testrun_maker
+      # prepare_test
+      #
+      # Execute the group of testruns associated to this test. This includes
+      # zero or one warmup and one or more testruns. 
+      #
+      # INPUT:
+      # +test_path+ filesystem path to store all test data
+      #
+      def prepare_test(test_path)
+
+        Stella::LOGGER.info("Writing test data to: #{test_path}\n\n") unless @quiet
+
+        # Make sure the test storage directory is created along with the
+        # latest symlink
+        FileUtil.create_dir(test_path)
+        File.unlink(latest_test_symlink_path) if File.exists?(latest_test_symlink_path)
+        File.symlink(File.expand_path(test_path), latest_test_symlink_path)
+        
+        # Write the test ID to the storage directory
+        FileUtil.write_file(test_path + "/ID.txt", @guid, true)
+
+        # And the test run message
+        FileUtil.write_file(test_path + "/MESSAGE.txt", @testdef.message, true) if @testdef.message
+
+        @adapter.user_agent = @agents unless @agents.empty?
+
+        # The warmup is identical to a testrun except for two things:
+        # - we don't make note of the runpath
+        # - there is a one second sleep after the run. 
+        # Everything else is identical. 
+        if @testdef.warmup
+
+          testrun = maker_of_testruns(@testdef.warmup)
+
+          # Generate the filesystem path to store the run data.
+          # NOTE: We don't keep the warmup path in @test_runpaths because we
+          # include it in the final calculation for the test. 
+          runpath = File.join(test_path, "warmup")
+
+          # Run the warmpup round
+          testrun.call("Warmup", runpath)
+
+          run_sleeper(@testdef.sleep || 1)
+          
+          Stella::LOGGER.info('', '') unless @quiet # We just need the newline
+          
+        end
+        
+        print_title unless @quiet
+
+      end
+        
+      # maker_of_testruns
       #
       # Generator of test runs. Everything that happens during a test
       # run is defined here. We use a Proc so we can toss the functionality
       # around like something that's dirty and loves a good tossing. 
       # It's important that all output be on a single line without a
       # line terminator. Otherwise great descruction could occur.  
-      def testrun_maker(factor)
+      def maker_of_testruns(factor)
         testrun = Proc.new do |name,runpath|
           # Make sure the test run storage directory is created
           FileUtil.create_dir(runpath)
@@ -183,7 +234,7 @@ module Stella
           @adapter.working_directory = runpath
           @adapter.before
           
-          Stella::LOGGER.info_printf("%10s: %6d@%-5d", name, @adapter.requests, @adapter.vusers) unless @quiet
+          Stella::LOGGER.info_printf("%8s: %10d@%-6s ", name, @adapter.requests, @adapter.vuser_rate) unless @quiet
         
           # Here we record the command arguments. This needs to be last because we modify 
           # some of the arguments above.
@@ -202,65 +253,16 @@ module Stella
       
           save_summary(@adapter.summary_path(@format), stats)
       
-      
+
           unless @quiet
-            Stella::LOGGER.info_print(sprintf("%9.4fs %6.2f/s", stats.elapsed_time, stats.transaction_rate)) 
-            Stella::LOGGER.info_print(sprintf("%9.4fs (%3.2f%%)  ", stats.response_time, stats.availability))
-            Stella::LOGGER.info_print(sprintf(" (ruby: %.4f with %.4f overhead)", run_timer.real, run_timer.overhead)) if @showoverhead
+            Stella::LOGGER.info_print(sprintf("%3.0f%% %9.2f/s %8.3fs ", stats.availability, stats.transaction_rate, stats.response_time))
+            Stella::LOGGER.info_print(sprintf("%8.3fMB/s %8.3fMB %8.3fs  ", stats.throughput, stats.data_transferred, stats.elapsed_time))
             # NOTE: We don't print a line terminator here
           end
           
         end
       end
     
-     
-      # prepare_test
-      #
-      # Execute the group of testruns associated to this test. This includes
-      # zero or one warmup and one or more testruns. 
-      #
-      # INPUT:
-      # +test_path+ filesystem path to store all test data
-      #
-      def prepare_test(test_path)
-
-        Stella::LOGGER.info("Writing test data to: #{test_path}\n\n") unless @quiet
-      
-        # Make sure the test storage directory is created along with the
-        # latest symlink
-        FileUtil.create_dir(test_path)
-        File.unlink(latest_test_symlink_path) if File.exists?(latest_test_symlink_path)
-        File.symlink(File.expand_path(test_path), latest_test_symlink_path)
-      
-        # Write the test ID to the storage directory
-        FileUtil.write_file(test_path + "/ID.txt", @guid, true)
-      
-        # And the test run message
-        FileUtil.write_file(test_path + "/MESSAGE.txt", @testdef.message, true) if @testdef.message
-      
-        # The warmup is identical to a testrun except for two things:
-        # - we don't make note of the runpath
-        # - there is a one second sleep after the run. 
-        # Everything else is identical. 
-        if @testdef.warmup
-
-          testrun = testrun_maker(@testdef.warmup)
-        
-          # Generate the filesystem path to store the run data.
-          # NOTE: We don't keep the warmup path in @test_runpaths because we
-          # include it in the final calculation for the test. 
-          runpath = File.join(test_path, "warmup")
-          
-          # Run the warmpup round
-          testrun.call("Warmup", runpath)
-          
-          run_sleeper(@testdef.sleep || 1)
-          
-          Stella::LOGGER.info('', '') # We just need the newline
-        end
-
-        
-      end
     
       # print_summary
       #
@@ -268,13 +270,27 @@ module Stella
       # it's also called at the end of all the runs.  
       #
       # INPUT:
-      # stats:: Any object that extends Stella::Test::SummaryBase object
+      # stats:: Any object that extends Stella::Test::Base object
       def print_summary(stats)
         Stella::LOGGER.info(' ' << "-"*67) unless @quiet
 
-        Stella::LOGGER.info(sprintf("%9s %13s %9.4fs %6.2f/s %8.4fs", "Std Dev:", '', stats.elapsed_time_sdev, stats.transaction_rate_sdev, stats.response_time_sdev))
-        Stella::LOGGER.info_printf("%9s %8d@%-5d%9.4fs %6.2f/s", "Total:", stats.transactions_total, stats.vusers_avg, stats.elapsed_time_total, stats.transaction_rate_avg)
-        Stella::LOGGER.info_printf("%9.4fs (%3.2f%%)  ", stats.response_time_avg, stats.availability)
+        Stella::LOGGER.info_printf("%8s: %10d@%-6d% 3.0f%% %9.2f/s ", "Total", stats.transactions_total, stats.vusers_avg, stats.availability, stats.transaction_rate_avg)
+        Stella::LOGGER.info_printf("%8.3fs %8.3fMB/s %8.3fMB %8.3fs", stats.response_time_avg, stats.throughput_avg, stats.data_transferred_total, stats.elapsed_time_total)
+        Stella::LOGGER.info('') # New line
+        Stella::LOGGER.info_printf("%8s: %22s %9.2f/s %8.3fs %8.3fMB/s %10s %8.3fs", "Std Dev", '', stats.transaction_rate_sdev, stats.response_time_sdev, stats.throughput_sdev, '', stats.elapsed_time_sdev)
+        Stella::LOGGER.info('') # New line
+        Stella::LOGGER.info('') unless @quiet # Extra new line
+      end
+      
+      # print_title
+      #
+      # Prints the column headers for the test run output. Field widths match those 
+      # in print_summary and test_maker
+      def print_title
+        Stella::LOGGER.info(' ' << "-"*67) unless @quiet
+
+        Stella::LOGGER.info_printf("%8s  %10s@%-5s %5s %11s", "", 'REQ', 'VU/s', 'AVAIL', 'REQ/s')
+        Stella::LOGGER.info_printf("%10s %12s %10s %9s", 'RTIME', 'DATA/s', 'DATA', 'TIME')
         Stella::LOGGER.info('') # New line
         Stella::LOGGER.info('') unless @quiet # Extra new line
       end
@@ -285,7 +301,7 @@ module Stella
       # 
       # INPUT:
       # filepath:: the complete path for the file (string)
-      # stats:: Any object that extends Stella::Test::SummaryBase object
+      # stats:: Any object that extends Stella::Test::Base object
       def save_summary(filepath, stats)
         FileUtil.write_file(filepath, stats.dump(@format, :with_titles), true)
       end
@@ -293,12 +309,12 @@ module Stella
       # Load SUMMARY file for each run and create a summary with
       # totals, averages, and standard deviations. 
       def process_test_stats(paths)
-        test_stats = Stella::Test::TestSummary.new(@message)
+        test_stats = Stella::Test::Summary.new(@message)
         all_stats_obj = []
         paths.each do |path|
           file_contents = FileUtil.read_file_to_array("#{path}/SUMMARY.#{@format}")
-          stats = Stella::Test::RunSummary.undump(@format, file_contents)
-          stats_obj = Stella::Test::RunSummary.from_hash(stats)
+          stats = Stella::Test::Run::Summary.undump(@format, file_contents)
+          stats_obj = Stella::Test::Run::Summary.from_hash(stats)
           test_stats.add_run(stats_obj)
         end