beaker-benchmark 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 922c931b423b9789170751154af7dc4a6a6329ec
-  data.tar.gz: 2acd0c5534b6c7a435b8680f502b768cd8ff3e94
+  metadata.gz: d3d7e588bdbad5a3f018e49fa02f007aa9a6b80c
+  data.tar.gz: b2f79746d5e092f9e4fbdca47fe02010167a7e17
 SHA512:
-  metadata.gz: 887223881be37ff961623e150fbf954232d3229a5d73dab2f9aefefc93467418c8e014408e068774dbadd8958515f23d54a144e5d53727bd8b8c929be2e06105
-  data.tar.gz: 253c9dbb32aa9425cca0be231e4fcb40539a11b020ac43064e971b85e9eca8de3282f8f7f7d7136f09d2163722665dec4a370d071ca0dbe7a38dc06b038e77b6
+  metadata.gz: ad55ce1d5233f656f454b359491a12a21c04ece6dff547d6b0e687eb04fbdba234a29ee72038d0da1ac8f09eda556bee80840c38729475c3f1ac8b00e08426e1
+  data.tar.gz: ec1b08f2300581e6e8f20692b5f85084991561b6c9d611512cc9adc8143d6b41f32b28ae65a89e3e57941b28dd0f1062eaffc4c37a4f689eab1c2e70d34ccf24

data/acceptance/tests/measure_perf_on.rb

@@ -0,0 +1,17 @@
+require 'beaker-benchmark'
+require 'fileutils'
+
+# Acceptance level testing goes into files in the tests directory like this one,
+# Each file corresponding to a new test made up of individual testing steps
+test_name "measure_perf_on test" do
+  if Dir.exist?('tmp/atop')
+    FileUtils.rm_r('tmp/atop')
+  end
+  result = measure_perf_on master, 'sleep test' do
+    on master, 'sleep 10'
+  end
+
+  assert(File.exist?('tmp/atop/ubuntu-server-1404-x64/atop_log_measure_perf_on_test_sleep_test.log'))
+  result.log_csv
+  assert(File.exist?('tmp/atop/ubuntu-server-1404-x64/atop_log_measure_perf_on_test_sleep_test.csv'))
+end

data/lib/beaker-benchmark/helpers.rb

@@ -1,11 +1,36 @@
 require 'csv'
+require 'fileutils'
 
 module Beaker
   module DSL
     module BeakerBenchmark
       module Helpers
+        include Beaker::HostPrebuiltSteps
+        # Column indexes for atop CSV style output
+        MEASURE_TYPE_INDEX = 0
 
-        # Example usage:
+        SYSTEM_CPU_INDEX = 8
+        USR_CPU_INDEX = 9
+        IOWAIT_CPU_INDEX = 12
+        IDLE_CPU_INDEX = 11
+
+        MEM_INDEX = 10
+
+        DISK_READ_INDEX = 9
+        DISK_WRITE_INDEX = 11
+
+        PROC_PID_INDEX = 6
+
+        PROC_CPU_INDEX = 16
+
+        PROC_MEM_INDEX = 11
+
+        PROC_DISK_READ_INDEX = 11
+        PROC_DISK_WRITE_INDEX = 13
+
+        TMP_DIR = 'tmp/atop'
+
+                # Example usage:
         # test_name('measure_perf_on_puppetserver_start') {
         #   on(master, 'puppet resource service pe-puppetserver ensure=stopped')
         #   result = measure_perf_on(master, 'start_pe-puppetserver', true) {
@@ -21,63 +46,69 @@ module Beaker
           # Append action name to test case name if test name is available
           action_name = metadata[:case][:name] + "_#{action_name}" if defined? metadata && metadata[:case] && metadata[:case][:name]
 
-          atop_log = 'atop_log.log'
-
-          start_monitoring(infrastructure_host, atop_log, include_processes)
+          start_monitoring(infrastructure_host, action_name, include_processes)
 
           yield
 
-          stop_monitoring(infrastructure_host, action_name, atop_log, include_processes.nil? ? nil : process_regex)
+          stop_monitoring(infrastructure_host, include_processes.nil? ? nil : process_regex)
         end
 
         def setup_atop(infrastructure_host)
-          @benchmark_tmpdir = Dir.mktmpdir
           # Only install atop once per host
           unless infrastructure_host.check_for_package('atop')
-            add_el_extras(infrastructure_host)
+            add_el_extras(infrastructure_host, @options)
             infrastructure_host.install_package('atop')
           end
         end
 
-        def start_monitoring(infrastructure_host, atop_log, include_processes=false, sample_interval=1)
+        def start_monitoring(infrastructure_host, action_name, include_processes=false, sample_interval=1)
+          raise('Monitoring already in progress, call stop_monitoring before calling start_monitoring a second time') unless @beaker_benchmark_start.nil?
+          @atop_log = "atop_log_#{action_name.downcase.gsub(/[^a-z0-9]/i, '_')}.log"
+          @action_name = action_name
           setup_atop(infrastructure_host)
           additional_args = ''
           additional_args = ',PRC,PRM,PRD' if include_processes
-          atop_cmd        = "sh -c 'nohup atop -P CPU,SWP,DSK#{additional_args} -i #{sample_interval} > #{atop_log} 2>&1 &'"
+          atop_cmd        = "sh -c 'nohup atop -P CPU,SWP,DSK#{additional_args} -i #{sample_interval} >  #{@atop_log} 2>&1 &'"
 
           on(infrastructure_host, atop_cmd)
           @beaker_benchmark_start = Time.now
         end
 
-        def stop_monitoring(infrastructure_host, action_name, atop_log_name, process_regex='.*')
-          if defined?@beaker_benchmark_start && !@beaker_benchmark_start.nil?
-            duration = Time.now - @beaker_benchmark_start
-          else
-            duration = nil
-          end
+        def stop_monitoring(infrastructure_host, process_regex='.*')
+          begin
+            if defined?@beaker_benchmark_start && !@beaker_benchmark_start.nil?
+              duration = Time.now - @beaker_benchmark_start
+            else
+              raise('No monitoring in progress, call start_monitoring before calling stop_monitoring')
+            end
 
-          # The atop process sticks around unless killed
-          on infrastructure_host, 'pkill -15 -f atop'
-          set_processes_to_monitor(infrastructure_host, process_regex)
-          parse_atop_log(infrastructure_host, action_name, duration, atop_log_name)
+            # The atop process sticks around unless killed
+            # It can also take some time to kill depending on how long it has been running and sampling rate.
+            retry_on infrastructure_host, 'pkill -15 -f atop', {:max_retries => 3, :retry_interval => 5}
+            set_processes_to_monitor(infrastructure_host, process_regex)
+            parse_atop_log(infrastructure_host, duration)
+          ensure
+            @beaker_benchmark_start = nil
+          end
         end
 
-        def parse_atop_log(infrastructure_host, action_name, duration, atop_log_name)
-          unless infrastructure_host.file_exist?(atop_log_name)
-            raise("atop log does not exist at #{atop_log_name}")
+        def parse_atop_log(infrastructure_host, duration)
+          unless infrastructure_host.file_exist?(@atop_log)
+            raise("atop log does not exist at #{@atop_log}")
           end
 
-          scp_from(infrastructure_host, atop_log_name, '/tmp')
+          log_dir = "#{TMP_DIR}/#{infrastructure_host.hostname}"
+          FileUtils::mkdir_p log_dir unless Dir.exist? log_dir
+          scp_from(infrastructure_host, @atop_log, log_dir)
           cpu_usage  = []
           mem_usage  = []
           disk_read  = []
           disk_write = []
 
-          process_cpu = []
           skip        = true
-          CSV.parse(File.read("/tmp/#{File.basename(atop_log_name)}"), { :col_sep => ' ' }) do |row|
+          CSV.parse(File.read(File.expand_path(File.basename(@atop_log), log_dir)), { :col_sep => ' ' }) do |row|
             #skip the first entry, until the first separator 'SEP'.
-            measure_type = row[0]
+            measure_type = row[MEASURE_TYPE_INDEX]
             if skip
               skip = (measure_type != 'SEP')
               next
@@ -85,28 +116,28 @@ module Beaker
             case measure_type
               when 'CPU'
                 # system + usr + iowait
-                cpu_active = row[8].to_i + row[9].to_i + row[12].to_i
+                cpu_active = row[SYSTEM_CPU_INDEX].to_i + row[USR_CPU_INDEX].to_i + row[IOWAIT_CPU_INDEX].to_i
                 # active + idle
-                cpu_total = cpu_active + row[11].to_i
+                cpu_total = cpu_active + row[IDLE_CPU_INDEX].to_i
                 cpu_percent = cpu_active * 100 / cpu_total
                 cpu_usage.push(cpu_percent)
               when 'SWP'
-                mem_usage.push(row[10].to_i)
+                mem_usage.push(row[MEM_INDEX].to_i)
               when 'DSK'
-                disk_read.push(row[9].to_i)
-                disk_write.push(row[11].to_i)
+                disk_read.push(row[DISK_READ_INDEX].to_i)
+                disk_write.push(row[DISK_WRITE_INDEX].to_i)
               when 'PRC'
-                add_process_measure(:cpu_usage, row[6], row[16].to_i)
+                add_process_measure(:cpu_usage, row[PROC_PID_INDEX], row[PROC_CPU_INDEX].to_i)
               when 'PRM'
-                add_process_measure(:mem_usage, row[6], row[11].to_i)
+                add_process_measure(:mem_usage, row[PROC_PID_INDEX], row[PROC_MEM_INDEX].to_i)
               when 'PRD'
                 # TODO: investigate why atop always shows disk_read as 0
-                # add_process_measure(:disk_read, row[6], row[11].to_i)
-                add_process_measure(:disk_write, row[6], row[13].to_i)
+                # add_process_measure(:disk_read, row[PROC_PID_INDEX], row[PROC_DISK_READ_INDEX].to_i)
+                add_process_measure(:disk_write, row[PROC_PID_INDEX], row[PROC_DISK_WRITE_INDEX].to_i)
             end
           end
 
-          PerformanceResult.new({ :cpu => cpu_usage, :mem => mem_usage, :disk_read => disk_read, :disk_write => disk_write, :action => action_name, :duration => duration, :processes => @processes_to_monitor, :logger => @logger})
+          PerformanceResult.new({ :cpu => cpu_usage, :mem => mem_usage, :disk_read => disk_read, :disk_write => disk_write, :action => @action_name, :duration => duration, :processes => @processes_to_monitor, :logger => @logger, :hostname => infrastructure_host})
         end
 
         def set_processes_to_monitor(infrastructure_host, process_regex)
@@ -120,7 +151,6 @@ module Beaker
               @processes_to_monitor[line.split(' ').first] = { :cmd => line.split(' ')[1..-1].join(' '), :cpu_usage => [], :mem_usage => [], :disk_read => [], :disk_write => [] }
             end
           end
-          @logger.info result.stdout
         end
 
         def add_process_measure measure_type, pid, value
@@ -136,7 +166,7 @@ module Beaker
         #   Process pid: 14067, command: '/opt/puppetlabs/server/apps/postgresql/bin/postgres -D /opt/puppetlabs/server/data/postgresql/9.6/data -c log_directory=/var/log/puppetlabs/postgresql'
         #       Avg CPU: '1', Avg MEM: 48888, Avg DSK Write: 20
         class PerformanceResult
-          attr_accessor :avg_cpu, :avg_mem, :avg_disk_read, :avg_disk_write, :action_name, :duration, :processes
+          attr_accessor :avg_cpu, :avg_mem, :avg_disk_read, :avg_disk_write, :action_name, :duration, :processes, :hostname
           def initialize(args)
             @avg_cpu = args[:cpu].empty? ? 0 : args[:cpu].inject{ |sum, el| sum + el } / args[:cpu].size
             @avg_mem = args[:mem].empty? ? 0 : args[:mem].inject{ |sum, el| sum + el } / args[:mem].size
@@ -146,6 +176,8 @@ module Beaker
             @duration = args[:duration]
             @processes = args[:processes]
             @logger = args[:logger]
+            @hostname = args[:hostname] || ''
+
 
             @processes.keys.each do |key|
               @processes[key][:avg_cpu] = @processes[key][:cpu_usage].inject{ |sum, el| sum + el } / @processes[key][:cpu_usage].size unless @processes[key][:cpu_usage].empty?
@@ -165,6 +197,20 @@ module Beaker
               @logger.info "   Avg CPU: '#{@processes[key][:avg_cpu]}%', Avg MEM: #{@processes[key][:avg_mem]}, Avg DSK read: #{@processes[key][:avg_disk_read]}, Avg DSK Write: #{@processes[key][:avg_disk_write]}"
             end
           end
+
+          def log_csv file_path=nil
+            file_path = file_path || "#{TMP_DIR}/#{@hostname}/atop_log_#{action_name.downcase.gsub(/[^a-z0-9]/i, '_')}.csv"
+            FileUtils.mkdir_p "#{TMP_DIR}/#{@hostname}/" unless Dir.exist?("#{TMP_DIR}/#{@hostname}/")
+            file = File.open file_path, 'w'
+            file.write "Action,Duration,Avg CPU,Avg MEM,Avg DSK read,Avg DSK Write\n"
+            file.write "#{@action_name},#{@duration},#{@avg_cpu},#{@avg_mem},#{@avg_disk_read},#{@avg_disk_write}\n\n"
+            file.write "Process pid,command,Avg CPU,Avg MEM,Avg DSK read,Avg DSK Write\n"
+            @processes.keys.each do |key|
+              file.write "#{key},'#{@processes[key][:cmd]}','#{@processes[key][:avg_cpu]},#{@processes[key][:avg_mem]},#{@processes[key][:avg_disk_read]},#{@processes[key][:avg_disk_write]}\n"
+            end
+            file.close
+            file.path
+          end
         end
 
       end

data/lib/beaker-benchmark/version.rb

@@ -3,7 +3,7 @@ module Beaker
     module BeakerBenchmark
 
       module Version
-        STRING = '0.0.1'
+        STRING = '0.0.2'
       end
 
     end

data/spec/beaker-benchmark/helpers_spec.rb

@@ -117,37 +117,6 @@ describe ClassMixedWithDSLHelpers do
 
   end
 
-  describe 'PerformanceResult::initialize' do
-
-    it 'properly averages arrays of values' do
-
-    end
-
-    it 'sets overall averages to 0 if no values are set' do
-
-    end
-
-    it 'raises an exception if :mem, :cpu, :disk_read or :disk_write args do not exist' do
-
-    end
-
-    it 'creates a result without no process data if @processes_to_monitor is empty or nil' do
-
-    end
-
-    it 'raises an exception if :mem, :cpu, :disk_read or :disk_write args do not exist' do
-
-    end
-
-  end
-
-  describe 'PerformanceResult::log' do
-
-    it 'prints out the results' do
-
-    end
-
-  end
 end
 
 

data/spec/beaker-benchmark/performance_result_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+class ClassMixedWithDSLHelpers
+  include BeakerTestHelpers
+  include Beaker::DSL::BeakerBenchmark::Helpers
+
+  def logger
+    RSpec::Mocks::Double.new('logger').as_null_object
+  end
+
+end
+
+describe ClassMixedWithDSLHelpers do
+  subject { Beaker::DSL::BeakerBenchmark::Helpers::PerformanceResult.new (
+            {:cpu => [60, 40], :mem => [6000, 4000], :disk_write => [600, 400], :action => 'test_action', :duration => 10,
+             :processes => {1000 => {:cmd => 'proc1', :cpu_usage => [10, 20], :mem_usage => [1000, 2000], :disk_write => [100, 200]},
+                            2000 => {:cmd => 'proc2', :cpu_usage => [20, 40], :mem_usage => [2000, 4000], :disk_write => [200, 400]}},
+             :logger => logger, :hostname => 'my_host'}) }
+
+  describe 'initialize' do
+
+    it 'properly averages arrays of values' do
+
+    end
+
+    it 'sets overall averages to 0 if no values are set' do
+
+    end
+
+    it 'raises an exception if :mem, :cpu, :disk_read or :disk_write args do not exist' do
+
+    end
+
+    it 'creates a result without no process data if @processes_to_monitor is empty or nil' do
+
+    end
+
+    it 'raises an exception if :mem, :cpu, :disk_read or :disk_write args do not exist' do
+
+    end
+
+  end
+
+  describe 'log_summary' do
+
+    it 'prints out the results' do
+
+    end
+
+  end
+
+  describe 'log_csv' do
+
+    it 'prints out the results in CSV format' do
+      file_path = subject.log_csv
+      file = File.open file_path
+      csv_file_content = file.readlines
+      expected_content = <<-EOS
+Process pid,command,Avg CPU,Avg MEM,Avg DSK read,Avg DSK Write
+1000,'proc1','15,1500,,150
+2000,'proc2','30,3000,,300
+      EOS
+      expect(csv_file_content == expected_content)
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beaker-benchmark
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Puppetlabs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-06 00:00:00.000000000 Z
+date: 2018-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -167,13 +167,14 @@ files:
 - README.md
 - Rakefile
 - acceptance/config/nodes/vagrant-ubuntu-1404.yml
-- acceptance/tests/first.rb
+- acceptance/tests/measure_perf_on.rb
 - beaker-benchmark.gemspec
 - bin/beaker-benchmark
 - lib/beaker-benchmark.rb
 - lib/beaker-benchmark/helpers.rb
 - lib/beaker-benchmark/version.rb
 - spec/beaker-benchmark/helpers_spec.rb
+- spec/beaker-benchmark/performance_result_spec.rb
 - spec/beaker_test_helpers.rb
 - spec/helpers.rb
 - spec/spec_helper.rb
@@ -203,6 +204,7 @@ specification_version: 4
 summary: Beaker benchmark Helpers!
 test_files:
 - spec/beaker-benchmark/helpers_spec.rb
+- spec/beaker-benchmark/performance_result_spec.rb
 - spec/beaker_test_helpers.rb
 - spec/helpers.rb
 - spec/spec_helper.rb

data/acceptance/tests/first.rb

@@ -1,8 +0,0 @@
-
-# Acceptance level testing goes into files in the tests directory like this one,
-# Each file corresponding to a new test made up of individual testing steps
-test_name "Template Acceptance Test Example"
-
-step "Fail fast!"
-
-fail_test("There are no acceptance tests yet!")