gauge-ruby 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: daa34f96744dfd879f22b0030d6cb911b37762cf
-  data.tar.gz: ea35374f79704c7438969ceb7a7551f53bd16261
+  metadata.gz: d082650420924a2bbabb264df5849ebe1ce6eb9d
+  data.tar.gz: 887f18dcb515c433222548583f30bd0342b04f52
 SHA512:
-  metadata.gz: c841ed91a33272610d2131242bba2cf426f32ed2c951e8fa94a46cb3668098767075b9d306779401996f194bf2590e987e7125d9fc500a632f3fa06a9f61449d
-  data.tar.gz: 58ebf3f372cb8b4162c32b4762e0ced44bd44bfb6bb768dd6fe0ddce7bbacbbdc88ca845bf3449b1bf8afbbc74bc27ae2be3eae4ade4089c6d8ce08b96ee8233
+  metadata.gz: 1ccdd5acea8a6f3a89c5939ba88e51028b4032d4c0202ca1d688dc5eb4f75be78b2d1544780062207c8be2af09728c08f28f18da8ab680482dd8f1f0ed6accbe
+  data.tar.gz: 766b7a496aa60f3446914a6126ded77efb71697dd3408cd2101b0638a03373eb093d6330278520757fc9c09ae14c7ea1e1a0c26ba3d59fb0538a60da3935a0e7

data/lib/configuration.rb

@@ -55,11 +55,11 @@ module Gauge
       @includes=[]
       @custom_screengrabber=false
       @screengrabber = -> {
-          file = File.open("#{Dir.tmpdir}/screenshot.png", "w+")
-          `gauge_screenshot #{file.path}`
-          file_content = File.binread(file.path)
-          File.delete file
-          return file_content
+        file_name = "#{Dir.tmpdir}/screenshot.png"
+        `gauge_screenshot #{file_name}`
+        file_content = File.binread(file_name)
+        File.delete file_name
+        return file_content
       }
     end
 

data/lib/gauge_messages.rb

@@ -40,17 +40,17 @@ module Gauge
     end
 
     def pending_messages()
-        pending_messages = @messages
+        pending_messages = @messages.select { |m| m != nil}
         @messages = []
         pending_messages
-    end  
+    end
 
     def write(message)
       @messages.push(message)
     end
 
     def get
-      @messages
+      @messages.select { |m| m != nil}
     end
 
     def clear

data/lib/gauge_screenshot.rb

@@ -0,0 +1,53 @@
+# Copyright 2018 ThoughtWorks, Inc.
+
+# This file is part of Gauge-Ruby.
+
+# Gauge-Ruby is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# Gauge-Ruby is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with Gauge-Ruby.  If not, see <http://www.gnu.org/licenses/>.
+
+module Gauge
+  class << self
+    def capture
+      GaugeScreenshot.instance.capture
+    end
+  end
+
+  class GaugeScreenshot
+    def initialize
+      @screenshots = []
+    end
+
+    def self.instance
+      @gauge_screenshots ||= GaugeScreenshot.new
+      end      
+
+    def capture
+      @screenshots.push(Configuration.instance.screengrabber.call)
+    end
+
+    def pending_screenshot
+      pending_screenshot = @screenshots
+      clear
+      pending_screenshot
+    end
+
+    def get
+      @screenshots
+    end
+
+    def clear
+      @screenshots = []
+    end
+
+  end
+end

data/lib/method_cache.rb

@@ -79,13 +79,28 @@ module Gauge
       @@steps_map[step_value][:recoverable]
     end
 
+    def self.relative_filepath(file)
+      project_root =  Pathname.new(ENV['GAUGE_PROJECT_ROOT'])
+      filename = Pathname.new(file).relative_path_from(project_root)
+      return project_root.join(filename.to_s.split(":").first)
+    end
+
     def self.remove_steps(file)
       @@steps_map.each_pair do |step, info|
-        l = info[:locations].reject { |loc| File.fnmatch? loc[:file], file }
+        l = info[:locations].reject { |loc| relative_filepath(loc[:file]).eql? relative_filepath(file) }
         l.empty? ? @@steps_map.delete(step) : @@steps_map[step][:locations] = l
       end
     end
 
+    def self.is_file_cached(file)
+      @@steps_map.each_pair do |step, info|
+        if info[:locations].any? { |loc| relative_filepath(loc[:file]).eql? relative_filepath(file) }
+          return true
+        end
+      end
+      return false
+    end
+
     def self.multiple_implementation?(step_value)
       @@steps_map[step_value][:locations].length > 1
     end

data/lib/processors/cache_file_processor.rb

@@ -34,8 +34,10 @@ module Gauge
         ast = CodeParser.code_to_ast(request.content)
         StaticLoader.reload_steps(f, ast)
       elsif status == Messages::CacheFileRequest::FileStatus::CREATED
-        ast = CodeParser.code_to_ast File.read(f)
-        StaticLoader.reload_steps(f, ast)
+        if !Gauge::MethodCache.is_file_cached f
+          ast = CodeParser.code_to_ast File.read(f)
+          StaticLoader.reload_steps(f, ast)
+        end
       elsif (status == Messages::CacheFileRequest::FileStatus::CLOSED) && File.file?(f)
         ast = CodeParser.code_to_ast File.read(f)
         StaticLoader.reload_steps(f, ast)

data/lib/processors/execution_handler.rb

@@ -33,13 +33,20 @@ module Gauge
 
       def handle_pass(message, execution_time)
         execution_status_response = Messages::ExecutionStatusResponse.new(:executionResult => Messages::ProtoExecutionResult.new(:failed => false, :executionTime => execution_time))
+        execution_status_response.executionResult.screenshots += Gauge::GaugeScreenshot.instance.pending_screenshot
+        execution_status_response.executionResult.message += Gauge::GaugeMessages.instance.pending_messages
         Messages::Message.new(:messageType => :ExecutionStatusResponse, :messageId => message.messageId, :executionStatusResponse => execution_status_response)
       end
 
+      def get_filepath(stacktrace)
+        toptrace = stacktrace.split("\n").first
+        return MethodCache.relative_filepath toptrace
+      end
+    
       def handle_failure(message, exception, execution_time, recoverable)
         project_dir = File.basename(Dir.getwd)
         stacktrace =  exception.backtrace.select {|x| x.match(project_dir) && !x.match(File.join(project_dir, "vendor"))}.join("\n")+"\n"
-        filepath =  stacktrace.split("\n").first.split(":").first
+        filepath = get_filepath(stacktrace)
         line_number =  stacktrace.split("\n").first.split("/").last.split(":")[1]
         code_snippet = "\n" + '> ' + get_code_snippet(filepath, line_number.to_i)
         execution_status_response =
@@ -50,7 +57,12 @@ module Gauge
              :stackTrace => code_snippet + stacktrace,
              :executionTime => execution_time))
         screenshot = screenshot_bytes
-        execution_status_response.executionResult.screenShot = screenshot if !screenshot.nil?
+        if screenshot 
+          execution_status_response.executionResult.screenShot = screenshot
+          execution_status_response.executionResult.failureScreenshot = screenshot
+        end
+        execution_status_response.executionResult.screenshots += Gauge::GaugeScreenshot.instance.pending_screenshot
+        execution_status_response.executionResult.message += Gauge::GaugeMessages.instance.pending_messages
         Messages::Message.new(:messageType => :ExecutionStatusResponse,
           :messageId => message.messageId, :executionStatusResponse => execution_status_response)
       end

data/lib/processors/execution_hook_processors.rb

@@ -17,6 +17,7 @@
 
 require_relative "execution_handler"
 require_relative "../gauge_messages"
+require_relative "../gauge_screenshot"
 require_relative "../executor"
 require_relative "../method_cache"
 require_relative "../util"
@@ -28,30 +29,35 @@ module Gauge
       Gauge::MethodCache.clear
       Executor.load_steps(Util.get_step_implementation_dir)
       response = handle_hooks_execution(MethodCache.get_before_suite_hooks, message,message.executionStartingRequest.currentExecutionInfo,false)
+      response.executionStatusResponse.executionResult.screenshots += Gauge::GaugeScreenshot.instance.pending_screenshot
       response.executionStatusResponse.executionResult.message += Gauge::GaugeMessages.instance.pending_messages
       return response
     end
 
     def process_execution_end_request(message)
       response = handle_hooks_execution(MethodCache.get_after_suite_hooks, message,message.executionEndingRequest.currentExecutionInfo, false)
+      response.executionStatusResponse.executionResult.screenshots += Gauge::GaugeScreenshot.instance.pending_screenshot
       response.executionStatusResponse.executionResult.message += Gauge::GaugeMessages.instance.pending_messages
       return response
     end
 
     def process_spec_execution_start_request(message)
       response = handle_hooks_execution(MethodCache.get_before_spec_hooks, message,message.specExecutionStartingRequest.currentExecutionInfo)
+      response.executionStatusResponse.executionResult.screenshots += Gauge::GaugeScreenshot.instance.pending_screenshot
       response.executionStatusResponse.executionResult.message += Gauge::GaugeMessages.instance.pending_messages
       return response
     end
 
     def process_spec_execution_end_request(message)
       response = handle_hooks_execution(MethodCache.get_after_spec_hooks, message,message.specExecutionEndingRequest.currentExecutionInfo)
+      response.executionStatusResponse.executionResult.screenshots += Gauge::GaugeScreenshot.instance.pending_screenshot
       response.executionStatusResponse.executionResult.message += Gauge::GaugeMessages.instance.pending_messages
       return response
     end
 
     def process_scenario_execution_start_request(message)
       response = handle_hooks_execution(MethodCache.get_before_scenario_hooks, message,message.scenarioExecutionStartingRequest.currentExecutionInfo)
+      response.executionStatusResponse.executionResult.screenshots += Gauge::GaugeScreenshot.instance.pending_screenshot
       response.executionStatusResponse.executionResult.message += Gauge::GaugeMessages.instance.pending_messages
       return response
     end
@@ -59,18 +65,21 @@ module Gauge
 
     def process_scenario_execution_end_request(message)
       response = handle_hooks_execution(MethodCache.get_after_scenario_hooks, message,message.scenarioExecutionEndingRequest.currentExecutionInfo)
+      response.executionStatusResponse.executionResult.screenshots += Gauge::GaugeScreenshot.instance.pending_screenshot
       response.executionStatusResponse.executionResult.message += Gauge::GaugeMessages.instance.pending_messages
       return response
     end
 
     def process_step_execution_start_request(message)
       response = handle_hooks_execution(MethodCache.get_before_step_hooks, message,message.stepExecutionStartingRequest.currentExecutionInfo)
+      response.executionStatusResponse.executionResult.screenshots += Gauge::GaugeScreenshot.instance.pending_screenshot
       response.executionStatusResponse.executionResult.message += Gauge::GaugeMessages.instance.pending_messages
       return response
     end
 
     def process_step_execution_end_request(message)
       response = handle_hooks_execution(MethodCache.get_after_step_hooks, message,message.stepExecutionEndingRequest.currentExecutionInfo)
+      response.executionStatusResponse.executionResult.screenshots += Gauge::GaugeScreenshot.instance.pending_screenshot
       response.executionStatusResponse.executionResult.message += Gauge::GaugeMessages.instance.pending_messages
       return response
     end

data/lib/spec_pb.rb

@@ -16,6 +16,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     repeated :postHookMessages, :string, 9
     repeated :preHookMessage, :string, 10
     repeated :postHookMessage, :string, 11
+    repeated :preHookScreenshots, :bytes, 12
+    repeated :postHookScreenshots, :bytes, 13
   end
   add_message "gauge.messages.ProtoItem" do
     optional :itemType, :enum, 1, "gauge.messages.ProtoItem.ItemType"
@@ -55,6 +57,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     repeated :postHookMessages, :string, 16
     repeated :preHookMessage, :string, 17
     repeated :postHookMessage, :string, 18
+    repeated :preHookScreenshots, :bytes, 19
+    repeated :postHookScreenshots, :bytes, 20
   end
   add_message "gauge.messages.Span" do
     optional :start, :int64, 1
@@ -73,6 +77,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :stepExecutionResult, :message, 4, "gauge.messages.ProtoStepExecutionResult"
     repeated :preHookMessages, :string, 5
     repeated :postHookMessages, :string, 6
+    repeated :preHookScreenshots, :bytes, 7
+    repeated :postHookScreenshots, :bytes, 8
   end
   add_message "gauge.messages.ProtoConcept" do
     optional :conceptStep, :message, 1, "gauge.messages.ProtoStep"
@@ -130,6 +136,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :executionTime, :int64, 6
     repeated :message, :string, 7
     optional :errorType, :enum, 8, "gauge.messages.ProtoExecutionResult.ErrorType"
+    optional :failureScreenshot, :bytes, 9
+    repeated :screenshots, :bytes, 10
   end
   add_enum "gauge.messages.ProtoExecutionResult.ErrorType" do
     value :ASSERTION, 0
@@ -140,6 +148,7 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     optional :errorMessage, :string, 2
     optional :screenShot, :bytes, 3
     optional :tableRowIndex, :int32, 4
+    optional :failureScreenshot, :bytes, 5
   end
   add_message "gauge.messages.ProtoSuiteResult" do
     repeated :specResults, :message, 1, "gauge.messages.ProtoSpecResult"
@@ -158,6 +167,8 @@ Google::Protobuf::DescriptorPool.generated_pool.build do
     repeated :postHookMessages, :string, 14
     repeated :preHookMessage, :string, 15
     repeated :postHookMessage, :string, 16
+    repeated :preHookScreenshots, :bytes, 17
+    repeated :postHookScreenshots, :bytes, 18
   end
   add_message "gauge.messages.ProtoSpecResult" do
     optional :protoSpec, :message, 1, "gauge.messages.ProtoSpec"

data/lib/static_loader.rb

@@ -29,10 +29,10 @@ module Gauge
     end
 
     def self.traverse(ast, &visitor)
-      return if ast.class != Parser::AST::Node
-      if ast && step_node?(ast)
+      return if !ast || ast.class != Parser::AST::Node
+      if step_node?(ast)
         visitor.call(ast)
-      elsif ast&.children
+      elsif ast.children
         ast.children.each {|node|
           traverse(node, &visitor)
         }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gauge-ruby
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Gauge Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-15 00:00:00.000000000 Z
+date: 2019-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-protocol-buffers
@@ -164,6 +164,7 @@ files:
 - lib/gauge.rb
 - lib/gauge_messages.rb
 - lib/gauge_runtime.rb
+- lib/gauge_screenshot.rb
 - lib/log.rb
 - lib/lsp_pb.rb
 - lib/lsp_server.rb