perf_check 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0d9ae6fc8c0d7d6581b8c8202f82bd7b2cf6f1e
-  data.tar.gz: cdec3df9f3dc51ad2b329c652dffe1154f0f80a3
+  metadata.gz: 9762190d0d025f9e0b5667bb8c3617de492a60fe
+  data.tar.gz: 3852d966b1245fd2c7fde01b70fef9bc7c043d86
 SHA512:
-  metadata.gz: dcb0b85c4ff22bb9dd0cd7084b513b55942e74d2a18c24fd009cab27d7f0bbd95d241119e48679ce0f9becf96abaf9da6bbb9b74305017ea3eb210a06ffe0eb5
-  data.tar.gz: 3647a68aac43d4bd6f63678c988988de348c69ea276288d5966caef248ebe82f8226690e1d3ad0385df8bfc8cc4d5b8ab3dd56d3eff33d4b276003f7f7ef7297
+  metadata.gz: 43cfa5145f18d1bc38f3cc528c7f8e51e7663c93e4f4e2c62b5dc31ade5104a8c1cf25aa73e7d848234dd129afb709e7b08c9bc71084ab8c693433417d88818e
+  data.tar.gz: ee033dd7afe11300842e5ac28b09672881a56b38c482db2e90f0395e2dc7e9ce447a68117a40d32140c7a21874c98dbc4eedf0dd0c9ace7488a409ea3e7a4329

data/bin/perf_check

@@ -30,7 +30,9 @@ end
 
 perf_check.run
 
-if perf_check.options.brief
+if perf_check.options.compare_paths?
+  perf_check.print_results_of_compared_paths
+elsif perf_check.options.brief
   perf_check.print_brief_results
 else
   perf_check.print_full_results

data/lib/perf_check.rb

@@ -28,7 +28,8 @@ class PerfCheck
                      '--ignore-matching-lines=/mini-profiler-resources/includes.js'],
       brief: false,
       caching: true,
-      json: false
+      json: false,
+      hard_reset: false
     )
 
     @logger = Logger.new(STDERR).tap do |logger|
@@ -68,20 +69,24 @@ class PerfCheck
 
   def run
     begin
-      profile_requests
-
-      if options.reference
-        git.stash_if_needed
-        git.checkout_reference(options.reference)
-        test_cases.each{ |x| x.switch_to_reference_context }
-
+      if options.compare_paths?
+        raise "Must have two paths" if test_cases.count != 2
+        profile_compare_paths_requests
+      else
         profile_requests
+        if options.reference
+          git.stash_if_needed
+          git.checkout(options.reference, bundle_after_checkout: true, hard_reset: options.hard_reset)
+          test_cases.each{ |x| x.switch_to_reference_context }
+
+          profile_requests
+        end
       end
     ensure
-      server.exit rescue nil
+      server.exit
       if options.reference
-        git.checkout_current_branch(false) rescue nil
-        (git.pop rescue nil) if git.stashed?
+        git.checkout(git.current_branch, bundle_after_checkout: true, hard_reset: options.hard_reset)
+        git.pop if git.stashed?
       end
 
       callbacks = {}
@@ -97,29 +102,39 @@ class PerfCheck
 
   private
 
-  def profile_requests
-    run_migrations_up if options.run_migrations?
+  def profile_compare_paths_requests
+    first = test_cases[0]
+    reference_test = test_cases[1]
+    profile_test_case(first)
+    reference_test.switch_to_reference_context
+    profile_test_case(reference_test)
+  end
 
+  def profile_test_case(test)
+    trigger_before_start_callbacks(test)
+    run_migrations_up if options.run_migrations?
     server.restart
-    test_cases.each_with_index do |test, i|
-      trigger_before_start_callbacks(test)
-      server.restart unless i.zero? || options.diff
 
-      test.cookie = options.cookie
+    test.cookie = options.cookie
 
-      if options.diff
-        logger.info("Issuing #{test.resource}")
-      else
-        logger.info ''
-        logger.info("Benchmarking #{test.resource}:")
-      end
-
-      test.run(server, options)
+    if options.diff
+      logger.info("Issuing #{test.resource}")
+    else
+      logger.info ''
+      logger.info("Benchmarking #{test.resource}:")
     end
+
+    test.run(server, options)
   ensure
     run_migrations_down if options.run_migrations?
   end
 
+  def profile_requests
+    test_cases.each do |test|
+      profile_test_case(test)
+    end
+  end
+
   def run_migrations_up
     logger.info "Running db:migrate"
     logger.info `cd #{app_root} && bundle exec rake db:migrate`

data/lib/perf_check/config.rb

@@ -25,11 +25,11 @@ class PerfCheck
       end
 
       opts.on('--quick', '-q',
-              'Fire off 20 requests just on this branch (no comparison with master)') do
+              '20 requests just on this branch (no comparison with master)') do
         options.reference = nil
       end
 
-      opts.on('--no-caching', 'Do not enable fragment caching') do
+      opts.on('--no-caching', 'Do not enable fragment caching (Rails.cache will still work)') do
         options.caching = false
       end
 
@@ -37,6 +37,10 @@ class PerfCheck
         options[:run_migrations?] = true
       end
 
+      opts.on('--compare-paths', 'Compare two paths against each other on the same branch') do
+        options[:compare_paths?] = true
+      end
+
       opts.on('--302-success', 'Consider HTTP 302 code a successful request') do
         options.http_statuses.push(302)
       end
@@ -46,6 +50,14 @@ class PerfCheck
       end
 
       opts.separator "\nMisc"
+      opts.on('-h', 'Display this help') do
+        # Do nothing, just don't error
+      end
+
+      opts.on('--deployment','Use git fetch/reset instead of the safe/friendly checkout') do
+        options.hard_reset = true
+      end
+
       opts.on('--cookie COOKIE', '-c') do |cookie|
         options.cookie = cookie
       end

data/lib/perf_check/git.rb

@@ -18,32 +18,21 @@ class PerfCheck
       @current_branch = exec "git rev-parse --abbrev-ref HEAD"
     end
 
-    def checkout_reference(reference='master')
-      checkout(reference)
-    end
-
-    def checkout_current_branch(bundle=true)
-      checkout(@current_branch, bundle)
-    end
-
-    def checkout(branch, bundle=true)
+    def checkout(branch, bundle_after_checkout: true, hard_reset: false)
       logger.info("Checking out #{branch} and bundling... ")
-      exec "git checkout #{branch} --quiet"
+      if hard_reset
+        exec "git fetch --quiet && git reset --hard origin/#{branch} --quiet"
+      else
+        exec "git checkout #{branch} --quiet"
+      end
 
       unless $?.success?
         logger.fatal("Problem with git checkout! Bailing...")
         raise NoSuchBranch
       end
 
-      exec "git submodule update --quiet"
-
-      if bundle
-        Bundler.with_clean_env{ exec "bundle" }
-        unless $?.success?
-          logger.fatal("Problem bundling! Bailing...")
-          raise BundleError
-        end
-      end
+      update_submodules
+      bundle if bundle_after_checkout
     end
 
     def stash_if_needed
@@ -92,6 +81,18 @@ class PerfCheck
 
     private
 
+    def update_submodules
+      exec "git submodule update --quiet"
+    end
+
+    def bundle
+      Bundler.with_clean_env{ exec "bundle" }
+      unless $?.success?
+        logger.fatal("Problem bundling! Bailing...")
+        raise BundleError
+      end
+    end
+
     def current_migrations_not_on_master
       exec("git diff master --name-only --diff-filter=A db/migrate/").
         split.reverse

data/lib/perf_check/output.rb

@@ -25,6 +25,37 @@ class PerfCheck
     end
   end
 
+  def print_results_of_compared_paths
+    puts("==== Results ====")
+
+    first_test = test_cases[0]
+    second_test = test_cases[1]
+
+    test_latency = first_test.this_latency
+    reference_latency = second_test.reference_latency
+
+    test_latency_output = latency_output(test_latency)
+    reference_latency_output = latency_output(reference_latency)
+
+    puts("reference path:" + first_test.resource.bold)
+    puts("test path:" + second_test.resource.bold)
+
+    latency_difference = test_latency - reference_latency
+
+    change_factor = change_factor(latency_difference, reference_latency, test_latency)
+    change_factor_output = sprintf('%.1fx', change_factor)
+    percent_change = calculate_percent_change(latency_difference, reference_latency)
+
+    formatted_change, color = formatted_change_and_color(
+      change_factor_output,
+      percent_change,
+      latency_difference
+    )
+
+    formatted_change = latency_output(latency_difference) + " (#{formatted_change})"
+    print_results(reference_latency_output, test_latency, formatted_change, color)
+  end
+
   def print_full_results
     puts("==== Results ====")
     test_cases.each do |test|
@@ -35,35 +66,65 @@ class PerfCheck
         next
       end
 
-      master_latency = sprintf('%.1fms', test.reference_latency)
-      this_latency = sprintf('%.1fms', test.this_latency)
-      difference = sprintf('%+.1fms', test.latency_difference)
+      reference_latency_output = latency_output(test.reference_latency)
+      test_latency_output = latency_output(test.this_latency)
 
-      if test.latency_difference < 0
-        change_factor = test.reference_latency / test.this_latency
-      else
-        change_factor = test.this_latency / test.reference_latency
-      end
-      formatted_change = sprintf('%.1fx', change_factor)
-
-      percent_change = 100*(test.latency_difference / test.reference_latency).abs
-      if percent_change < 10
-        formatted_change = "yours is about the same"
-        color = :blue
-      elsif test.latency_difference < 0
-        formatted_change = "yours is #{formatted_change} faster!"
-        color = :green
-      else
-        formatted_change = "yours is #{formatted_change} slower!!!"
-        color = :light_red
-      end
-      formatted_change = difference + " (#{formatted_change})"
+      latency_difference = test.latency_difference
+      reference_latency = test.reference_latency
+      test_latency = test.this_latency
+
+      change_factor = change_factor(
+        latency_difference,
+        reference_latency,
+        test_latency
+      )
+
+      change_factor_output = sprintf('%.1fx', change_factor)
+      percent_change = calculate_percent_change(latency_difference, reference_latency)
 
-      puts("reference: ".rjust(15)  + "#{master_latency}")
-      puts("your branch: ".rjust(15)+ "#{this_latency}")
-      puts(("change: ".rjust(15)    + "#{formatted_change}").bold.send(color))
+      formatted_change, color = formatted_change_and_color(change_factor_output, percent_change, latency_difference)
+      formatted_change = latency_output(latency_difference) + " (#{formatted_change})"
 
+      print_results(reference_latency_output, test_latency_output, formatted_change, color)
       print_diff_results(test.response_diff) if options.verify_no_diff
     end
   end
+
+  private
+
+  def latency_output(latency)
+    sprintf('%.1fms', latency)
+  end
+
+  def change_factor(latency_difference, reference_latency, test_latency)
+    if latency_difference < 0
+      reference_latency / test_latency
+    else
+      test_latency / reference_latency
+    end
+  end
+
+  def print_results(reference_latency, test_latency, formatted_change, color)
+    puts("reference: ".rjust(15)  + "#{reference_latency}")
+    puts("your branch: ".rjust(15)+ "#{test_latency}")
+    puts(("change: ".rjust(15)    + "#{formatted_change}").bold.send(color))
+  end
+
+  def formatted_change_and_color(change_factor_output, percent_change, latency_difference)
+    if percent_change < 10
+      formatted_change = "yours is about the same"
+      color = :blue
+    elsif latency_difference < 0
+      formatted_change = "yours is #{change_factor_output} faster!"
+      color = :green
+    else
+      formatted_change = "yours is #{change_factor_output} slower!!!"
+      color = :light_red
+    end
+    [formatted_change, color]
+  end
+
+  def calculate_percent_change(latency_difference, reference_latency)
+    100*(latency_difference / reference_latency).abs
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: perf_check
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - rubytune
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-14 00:00:00.000000000 Z
+date: 2017-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec