capistrano-measure 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb3dbe3012c37df839a3eb8ccc8915297a8de55e
-  data.tar.gz: 5f5f6f74b3146163a665d1afff70a501b8d18c4f
+  metadata.gz: 7985b11ba0b7a76c5839925a75d929a7991222ec
+  data.tar.gz: d9d5b4a4bb46921324ffe71b8b4769788bdd5d68
 SHA512:
-  metadata.gz: e193eee4d4a3890e4f2e717f045d93eeead51ad227c9986726754a766b7e7b68026325b7331d5242ce612779df7a74e7775f7d9c767a26143d21a84cbd56ff1e
-  data.tar.gz: 9662f5a7ab726276484c670faac76bf4eb7faa302337221d2ea3ac7db1b1a19c3ab4b2089b775b8bb1c1099da2d74c3fc13e69bfa6d06565c2f8db6cbee2758d
+  metadata.gz: 9afca2004487f749ba1863e190f7ec1716362e9fd9df5519293765533849a2a9e9287c72fa8c551240fafde5a0d8f6799739556004720f29e144aaa876c6216d
+  data.tar.gz: d9d7958f05359b27fdc8d54d943632572e81a73308d63126047be83b48ff00f169801160c6968efcdc11cf1302a7e7b7346071612d7c9423f0e7aeef11cb9d48

data/README.md

@@ -91,8 +91,9 @@ It will append every capistrano execution with similar report
 You could change threshold time to change the results duration's color.
 
 ```ruby
-set :alert_threshold, 10  # default 60 sec
-set :warning_threshold, 5 # default 30 sec
+set :alert_threshold, 10              # default 60 sec
+set :warning_threshold, 5             # default 30 sec
+set :measure_error_handling, :raise   # default :silent
 ```
 
 ## Contributing

data/lib/capistrano/measure.rb

@@ -3,6 +3,7 @@ require 'capistrano/measure/version'
 require 'capistrano/measure/timer'
 require 'capistrano/measure/log_reporter'
 require 'capistrano/measure/adapter'
+require 'capistrano/measure/error'
 
 case ::Capistrano::Measure::Adapter::capistrano_version
 when 2
@@ -10,7 +11,7 @@ when 2
 when 3
   require 'capistrano/measure/integration/capistrano_3'
 else
-  raise 'This version of Capistrano is not supported.'
+  raise ::Capistrano::Measure::Error, 'This version of Capistrano is not supported.'
 end
 
 module Capistrano

data/lib/capistrano/measure/adapter.rb

@@ -11,18 +11,23 @@ module Capistrano
       def initialize(logger, config)
         @logger = logger
         @config = config
+        @valid = true
       end
 
       def before_task(task_name)
-        timer.start(task_name)
+        with_error_handling { timer.start(task_name) }
       end
 
       def after_task(task_name)
-        timer.stop(task_name)
+        with_error_handling { timer.stop(task_name) }
       end
 
       def print_report
-        log_reporter.render(timer.report_events)
+        if valid?
+          log_reporter.render(timer.report_events)
+        else
+          log_reporter.render_error("Capistrano::Measure plugin encountered an error during performance evaluation and is not able to present a performance report, in order to `raise` and troubleshoot this error add `set :measure_error_handling, :raise` into your capistrano config")
+        end
       end
 
       private
@@ -37,6 +42,21 @@ module Capistrano
         @timer ||= Capistrano::Measure::Timer.new
       end
 
+      def debug?
+        config.fetch(:measure_error_handling, :silent) == :raise
+      end
+
+      def valid?
+        @valid
+      end
+
+      def with_error_handling
+        yield
+      rescue StandardError => e
+        @valid = false
+        raise e if debug?
+      end
+
     end
   end
 end

data/lib/capistrano/measure/error.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  module Measure
+    class Error < StandardError; end
+  end
+end

data/lib/capistrano/measure/log_reporter.rb

@@ -19,18 +19,29 @@ module Capistrano
       def render(events)
         return if events.to_a.empty?
 
-        log_sepertor
-        log ColorizedString["  Performance Report"].green
-        log_sepertor
+        with_layout do
+          events.each do |event|
+            log "#{'..' * event.indent}#{event.name} #{colorize_time(event.elapsed_time)}"
+          end
+        end
+      end
 
-        events.each do |event|
-          log "#{'..' * event.indent}#{event.name} #{colorize_time(event.elapsed_time)}"
+      def render_error(message)
+        with_layout do
+          @logger.error message
         end
-        log_sepertor
       end
 
       private
 
+      def with_layout
+        log_sepertor
+        log ColorizedString["  Performance Report"].green
+        log_sepertor
+        yield
+        log_sepertor
+      end
+
       def log_sepertor
         log "=" * 60
       end

data/lib/capistrano/measure/timer.rb

@@ -42,7 +42,7 @@ module Capistrano
       end
 
       def report_events
-        raise 'Performance measure is not completed' unless @open_events.empty?
+        raise ::Capistrano::Measure::Error, "Performance evaluation is not yet completed, as there are events still open: #{@open_events.map(&:name).join(', ')}" unless @open_events.empty?
         return to_enum(__callee__) unless block_given?
 
         (events + [Event.new]).each_cons(2) do |event, next_event|
@@ -55,7 +55,7 @@ module Capistrano
       def close_event(event_name)
         event = Event.new(event_name, :stop, Time.now, @indent-1)
         open_event = @open_events.last
-        raise "You're trying to stop unstarted event" unless event.eq?(open_event)
+        raise ::Capistrano::Measure::Error, "Cannot estimate time for event `#{event_name}`" unless event.eq?(open_event)
 
         event.elapsed_time = (event.time - open_event.time).to_i
         event

data/lib/capistrano/measure/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Measure
-    VERSION = "0.9.1"
+    VERSION = "0.10.0"
   end
 end

data/spec/capistrano/measure/adapter_spec.rb

@@ -20,7 +20,31 @@ describe Capistrano::Measure::Adapter do
 
     subject.print_report
 
-    expect(logger.to_s).not_to be_empty
+    expect(logger.to_s).to include("Performance Report")
+    expect(logger.to_s).to include("root_task")
+    expect(logger.to_s).to include("..sub_task")
+    expect(logger.to_s).to include("....sub_task1")
+  end
+
+  it "doesn't rise any errors by default" do
+    subject.before_task('root_task')
+    subject.after_task('sub_task')
+
+    subject.print_report
+
+    expect(logger.to_s).to include("Capistrano::Measure plugin encountered an error during performance evaluation")
+  end
+
+  it "raises an error in debug mode (and interrupts the deployment)" do
+    config[:measure_error_handling] = :raise
+
+    expect {
+      subject.before_task('root_task')
+      subject.after_task('sub_task')
+
+      subject.print_report
+    }.to raise_error(::Capistrano::Measure::Error)
+
   end
 
   describe "::capistrano_version" do

data/spec/capistrano/measure/timer_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'capistrano/measure/error'
 require 'capistrano/measure/timer'
 
 describe Capistrano::Measure::Timer do
@@ -75,14 +76,14 @@ describe Capistrano::Measure::Timer do
     end
 
     it "should raise exception with unstarted event" do
-      expect{ subject.stop('test123') }.to raise_error(RuntimeError)
+      expect{ subject.stop('test123') }.to raise_error(::Capistrano::Measure::Error)
     end
   end
 
   describe "#report_events" do
     it "should raise exception if called in the middle of process" do
       subject.start('test')
-      expect{ subject.report_events }.to raise_error(RuntimeError)
+      expect{ subject.report_events }.to raise_error(::Capistrano::Measure::Error)
     end
 
     context "in completed state" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-measure
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Artūrs Mekšs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-21 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
@@ -120,6 +120,7 @@ files:
 - lib/capistrano-measure.rb
 - lib/capistrano/measure.rb
 - lib/capistrano/measure/adapter.rb
+- lib/capistrano/measure/error.rb
 - lib/capistrano/measure/integration/capistrano_2.rb
 - lib/capistrano/measure/integration/capistrano_3.rb
 - lib/capistrano/measure/log_reporter.rb