gauge-ruby 0.0.4.1

data/lib/method_cache.rb

@@ -0,0 +1,81 @@
+# Copyright 2015 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/>.
+
+require_relative 'configuration'
+module Gauge
+  # @api private
+  class MethodCache
+    HOOKS.each { |hook|
+      define_singleton_method "add_#{hook}_hook" do |&block|
+        self.class_variable_get("@@#{hook}_hooks").push block
+      end
+      define_singleton_method "get_#{hook}_hooks" do
+        self.class_variable_get("@@#{hook}_hooks")
+      end
+    }
+
+    def self.add_step(parameterized_step_text, &block)
+      @@steps_map[parameterized_step_text] = block
+    end
+
+    def self.get_step(parameterized_step_text)
+      @@steps_map[parameterized_step_text]
+    end
+
+    def self.add_step_text(parameterized_step_text, step_text)
+      @@steps_text_map[parameterized_step_text] = step_text
+    end
+
+    def self.get_step_text(parameterized_step_text)
+      @@steps_text_map[parameterized_step_text]
+    end
+
+    def self.add_step_alias(*step_texts)
+      @@steps_with_aliases.push *step_texts if step_texts.length > 1
+    end
+
+    def self.has_alias?(step_text)
+      @@steps_with_aliases.include? step_text
+    end
+
+    def self.valid_step?(step)
+      @@steps_map.has_key? step
+    end
+
+    def self.all_steps
+      @@steps_map.keys
+    end
+
+    private
+    HOOKS = ["before_step", "after_step", "before_spec", "after_spec", "before_scenario", "after_scenario", "before_suite", "after_suite"]
+    @@steps_map = Hash.new
+    @@steps_text_map = Hash.new
+    @@steps_with_aliases = []
+    @@before_suite_hooks = []
+    @@after_suite_hooks = []
+    @@before_spec_hooks = []
+    @@after_spec_hooks = []
+    @@before_scenario_hooks = []
+    @@after_scenario_hooks = []
+    @@before_step_hooks = []
+    @@after_step_hooks = []
+  end
+
+  # hack : get the 'main' object and include the configured includes there.
+  # can be removed once we have scoped execution.
+  MethodCache.add_before_suite_hook { Configuration.include_configured_modules }
+end

data/lib/processors/datastore_init_processor.rb

@@ -0,0 +1,36 @@
+# Copyright 2015 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/>.
+
+require_relative '../datastore'
+
+module Gauge
+  # @api private
+  module Processors
+    def process_datastore_init(message)
+      case message.messageType
+        when Messages::Message::MessageType::SuiteDataStoreInit
+          DataStoreFactory.suite_datastore.clear
+        when Messages::Message::MessageType::SpecDataStoreInit
+          DataStoreFactory.spec_datastore.clear
+        when Messages::Message::MessageType::ScenarioDataStoreInit
+          DataStoreFactory.scenario_datastore.clear
+      end
+      execution_status_response = Messages::ExecutionStatusResponse.new(:executionResult => Messages::ProtoExecutionResult.new(:failed => false, :executionTime => 0))
+      Messages::Message.new(:messageType => Messages::Message::MessageType::ExecutionStatusResponse, :messageId => message.messageId, :executionStatusResponse => execution_status_response)
+    end
+  end
+end

data/lib/processors/execute_step_request_processor.rb

@@ -0,0 +1,37 @@
+# Copyright 2015 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/>.
+
+require_relative "execution_handler"
+
+module Gauge
+  module Processors
+    include ExecutionHandler
+
+    def process_execute_step_request(message)
+      step_text = message.executeStepRequest.parsedStepText
+      parameters = message.executeStepRequest.parameters
+      args = create_param_values parameters
+      start_time= Time.now
+      begin
+        Executor.execute_step step_text, args
+      rescue Exception => e
+        return handle_failure message, e, time_elapsed_since(start_time)
+      end
+      handle_pass message, time_elapsed_since(start_time)
+    end
+  end
+end

data/lib/processors/execution_handler.rb

@@ -0,0 +1,83 @@
+# Copyright 2015 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/>.
+
+require 'os'
+
+module Gauge
+  module Processors
+    # @api private
+    module ExecutionHandler
+      def handle_hooks_execution(hooks, message, currentExecutionInfo)
+        start_time= Time.now
+        execution_error = Executor.execute_hooks(hooks, currentExecutionInfo)
+        if execution_error == nil
+          return handle_pass message, time_elapsed_since(start_time)
+        else
+          return handle_failure message, execution_error, time_elapsed_since(start_time)
+        end
+      end
+
+      def handle_pass(message, execution_time)
+        execution_status_response = Messages::ExecutionStatusResponse.new(:executionResult => Messages::ProtoExecutionResult.new(:failed => false, :executionTime => execution_time))
+        Messages::Message.new(:messageType => Messages::Message::MessageType::ExecutionStatusResponse, :messageId => message.messageId, :executionStatusResponse => execution_status_response)
+      end
+
+      def handle_failure(message, exception, execution_time)
+        execution_status_response = 
+          Messages::ExecutionStatusResponse.new(
+            :executionResult => Messages::ProtoExecutionResult.new(:failed => true,
+             :recoverableError => false,
+             :errorMessage => exception.message,
+             :stackTrace => exception.backtrace.join("\n")+"\n",
+             :executionTime => execution_time,
+             :screenShot => screenshot_bytes))
+        Messages::Message.new(:messageType => Messages::Message::MessageType::ExecutionStatusResponse,
+          :messageId => message.messageId, :executionStatusResponse => execution_status_response)
+      end
+
+      def screenshot_bytes
+        return nil if (ENV['screenshot_enabled'] || "").downcase == "false"
+        # todo: make it platform independent
+        if (OS.mac?)
+          file = File.open("#{Dir.tmpdir}/screenshot.png", "w+")
+          `screencapture #{file.path}`
+          file_content = File.binread(file.path)
+          File.delete file
+          return file_content
+        end
+        return nil
+      end
+
+      def time_elapsed_since(start_time)
+        ((Time.now-start_time) * 1000).round
+      end
+
+      def create_param_values parameters
+        params = []
+        parameters.each do |param|
+          if ((param.parameterType == Messages::Parameter::ParameterType::Table) ||(param.parameterType == Messages::Parameter::ParameterType::Special_Table))
+            gtable = Gauge::Table.new(param.table)
+            params.push gtable
+          else
+            params.push param.value
+          end
+        end
+        return params
+      end  
+    end
+  end
+end

data/lib/processors/execution_hook_processors.rb

@@ -0,0 +1,56 @@
+# Copyright 2015 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/>.
+
+require_relative "execution_handler"
+
+module Gauge
+  module Processors
+    include ExecutionHandler
+
+    def process_execution_start_request(message)
+      handle_hooks_execution(MethodCache.get_before_suite_hooks, message, message.executionStartingRequest.currentExecutionInfo)
+    end
+
+    def process_execution_end_request(message)
+      handle_hooks_execution(MethodCache.get_after_suite_hooks, message, message.executionEndingRequest.currentExecutionInfo)
+    end
+
+    def process_spec_execution_start_request(message)
+      handle_hooks_execution(MethodCache.get_before_spec_hooks, message, message.specExecutionStartingRequest.currentExecutionInfo)
+    end
+
+    def process_spec_execution_end_request(message)
+      handle_hooks_execution(MethodCache.get_after_spec_hooks, message, message.specExecutionEndingRequest.currentExecutionInfo)
+    end
+
+    def process_scenario_execution_start_request(message)
+      handle_hooks_execution(MethodCache.get_before_scenario_hooks, message, message.scenarioExecutionStartingRequest.currentExecutionInfo)
+    end
+
+    def process_scenario_execution_end_request(message)
+      handle_hooks_execution(MethodCache.get_after_scenario_hooks, message, message.scenarioExecutionEndingRequest.currentExecutionInfo)
+    end
+
+    def process_step_execution_start_request(message)
+      handle_hooks_execution(MethodCache.get_before_step_hooks, message, message.stepExecutionStartingRequest.currentExecutionInfo)
+    end
+
+    def process_step_execution_end_request(message)
+      handle_hooks_execution(MethodCache.get_after_step_hooks, message, message.stepExecutionEndingRequest.currentExecutionInfo)
+    end
+  end
+end

data/lib/processors/kill_request_processor.rb

@@ -0,0 +1,25 @@
+# Copyright 2015 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
+  # @api private
+  module Processors
+    def process_kill_processor_request(message)
+      return message
+    end
+  end
+end

data/lib/processors/refactor_step_request_processor.rb

@@ -0,0 +1,36 @@
+# Copyright 2015 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/>.
+
+require_relative '../code_parser'
+
+module Gauge
+  module Processors
+    def refactor_step(message)
+      oldStepValue = message.refactorRequest.oldStepValue.stepValue
+      newStep = message.refactorRequest.newStepValue
+      stepBlock = MethodCache.get_step oldStepValue
+      refactor_response = Messages::RefactorResponse.new(success: true)
+      begin
+        CodeParser.refactor stepBlock, message.refactorRequest.paramPositions, newStep.parameters, newStep.parameterizedStepValue
+      rescue Exception => e
+        refactor_response.success=false
+        refactor_response.error=e.message
+      end
+      Messages::Message.new(:messageType => Messages::Message::MessageType::RefactorResponse, :messageId => message.messageId, refactorResponse: refactor_response)
+    end
+  end
+end

data/lib/processors/step_name_request_processor.rb

@@ -0,0 +1,29 @@
+# Copyright 2015 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
+  module Processors
+    def process_step_name_request(message)
+      parsed_step_text = message.stepNameRequest.stepValue
+      is_valid = MethodCache.valid_step?(parsed_step_text)
+      step_text = is_valid ? MethodCache.get_step_text(parsed_step_text) : ""
+      has_alias = MethodCache.has_alias?(step_text)
+      get_step_name_response = Messages::StepNameResponse.new(isStepPresent: is_valid, stepName: [step_text], hasAlias: has_alias)
+      Messages::Message.new(:messageType => Messages::Message::MessageType::StepNameResponse, :messageId => message.messageId, :stepNameResponse => get_step_name_response)
+    end
+  end
+end

data/lib/processors/step_names_request_processor.rb

@@ -0,0 +1,26 @@
+# Copyright 2015 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
+  module Processors
+    def process_step_names_request(message)
+      step_names_response = Messages::StepNamesResponse.new(:steps => MethodCache.all_steps)
+      Messages::Message.new(:messageType => Messages::Message::MessageType::StepNamesResponse,
+        :messageId => message.messageId, :stepNamesResponse => step_names_response)
+    end
+  end
+end

data/lib/processors/step_validation_request_processor.rb

@@ -0,0 +1,30 @@
+# Copyright 2015 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
+  module Processors
+    def process_step_validation_request(message)
+      step_validate_request = message.stepValidateRequest
+      is_valid = MethodCache.valid_step?(step_validate_request.stepText)
+      step_validate_response = Messages::StepValidateResponse.new(:isValid => is_valid,
+        :errorMessage => is_valid ? "" : "Step implementation not found")
+      Messages::Message.new(:messageType => Messages::Message::MessageType::StepValidateResponse,
+        :messageId => message.messageId, 
+        :stepValidateResponse => step_validate_response)
+    end
+  end
+end