simmer 2.0.0.pre.alpha.1 → 4.0.0

data/lib/simmer/runner/timeout_error.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Simmer
+  class Runner
+    # This error used when a specification times out. It is stored in
+    # <tt>Simmer::Runner::Results#errors</tt> when a specification times out.
+    class TimeoutError < RuntimeError
+      def message
+        cause ? cause.message : DEFAULT_MESSAGE
+      end
+
+      DEFAULT_MESSAGE = 'a timeout occurred'
+      private_constant :DEFAULT_MESSAGE
+    end
+  end
+end

data/lib/simmer/suite.rb

@@ -7,7 +7,9 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require_relative 'suite/reporter'
+require_relative 'suite/output_router'
+require_relative 'suite/pdi_output_writer'
+require_relative 'suite/results_writer'
 require_relative 'suite/result'
 
 module Simmer
@@ -22,7 +24,7 @@ module Simmer
       results_dir:,
       runner:
     )
-      @config      = config || {}
+      @config      = config
       @out         = out
       @resolver    = resolver
       @results_dir = results_dir
@@ -32,18 +34,17 @@ module Simmer
     end
 
     def run(specifications)
-      runner_results = run_all_specs(specifications)
+      config.run_suite_with_callbacks do
+        runner_results = run_all_specs(specifications)
+        runner.complete
 
-      Result.new(runner_results).tap do |result|
-        if result.pass?
-          out.puts('Suite ended successfully')
-        else
-          out.puts('Suite ended but was not successful')
-        end
+        Result.new(runner_results).tap do |result|
+          output_summary(result.pass?)
 
-        Reporter.new(result).write!(results_dir)
+          ResulstWriter.new(result, results_dir).write!
 
-        out.puts("Results can be viewed at #{results_dir}")
+          out.puts("Results can be viewed at #{results_dir}")
+        end
       end
     end
 
@@ -77,5 +78,13 @@ module Simmer
     def print_line
       out.puts('-' * LINE_LENGTH)
     end
+
+    def output_summary(passed)
+      if passed
+        out.puts('Suite ended successfully')
+      else
+        out.puts('Suite ended but was not successful')
+      end
+    end
   end
 end

data/lib/simmer/suite/output_router.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Simmer
+  class Suite
+    # Routes output either to the console or the <tt>PdiOutputWriter</tt>. It
+    # also provides some methods to help format output.
+    class OutputRouter
+      extend Forwardable
+
+      attr_reader :console, :pdi_out
+
+      def_delegator :console, :puts, :console_puts
+      def_delegators :pdi_out, :close, :finish_spec
+      def_delegator :pdi_out, :write, :capture_spoon_output
+
+      def initialize(console, pdi_out)
+        @console = console || raise(ArgumentError, 'console is required')
+        @pdi_out = pdi_out || raise(ArgumentError, 'pdi_out is required')
+
+        freeze
+      end
+
+      def announce_start(id, specification)
+        console_puts("Name: #{specification.name}")
+        console_puts("Path: #{specification.path}")
+        pdi_out.demarcate_spec(id, specification.name)
+      end
+
+      def result(result)
+        console_puts(pass_message(result))
+      end
+
+      def final_verdict(result)
+        msg = pass_message(result)
+        waiting('Done', 'Final verdict')
+        console_puts(msg)
+      end
+
+      def waiting(stage, msg)
+        # This is not for debugging.
+        # rubocop:disable Lint/Debugger
+        console.print(
+          "  > #{pad_right(stage, 6)} - #{pad_right(msg, WAITING_MAX_WIDTH, WAITING_PADDING_CHAR)}"
+        )
+        # rubocop:enable Lint/Debugger
+      end
+
+      def spoon_execution_detail_message(spoon_client_result)
+        code = spoon_client_result.execution_result.status.code
+        detail = "(Exited with code #{code} after #{spoon_client_result.time_in_seconds} seconds)"
+
+        console_puts("#{pass_message(spoon_client_result)} #{detail}")
+      end
+
+      private
+
+      WAITING_MAX_WIDTH = 25
+      WAITING_PADDING_CHAR = '.'
+
+      private_constant :WAITING_MAX_WIDTH, :WAITING_PADDING_CHAR
+
+      def pad_right(msg, len, char = ' ')
+        missing = len - msg.length
+
+        "#{msg}#{char * missing}"
+      end
+
+      def pass_message(obj)
+        obj.pass? ? 'Pass' : 'Fail'
+      end
+    end
+  end
+end

data/lib/simmer/suite/pdi_output_writer.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Simmer
+  class Suite
+    # Captures PDI output from multiple specifications to a single file.
+    class PdiOutputWriter # :nodoc:
+      PDI_OUT_FILE = 'pdi_out.txt'
+
+      attr_reader :results_dir
+
+      def initialize(results_dir)
+        raise ArgumentError, 'results_dir is required' unless results_dir
+
+        results_dir = Util::FileSystem.setup_directory(results_dir)
+        @out = File.new(File.join(results_dir, PDI_OUT_FILE), 'w')
+
+        freeze
+      end
+
+      def demarcate_spec(runner_id, spec_name)
+        out.puts(LINE_OF_HYPHENS)
+        out.puts("Name: #{spec_name}")
+        out.puts("Runner ID: #{runner_id}")
+        out.puts(LINE_OF_HYPHENS)
+      end
+
+      def write(contents)
+        bytes_written = out.write(contents)
+        out.flush
+        bytes_written
+      end
+
+      def finish_spec
+        out.puts
+      end
+
+      def close
+        out.close
+      end
+
+      private
+
+      attr_reader :out
+
+      LINE_OF_HYPHENS = ('-' * 80).freeze
+      private_constant :LINE_OF_HYPHENS
+    end
+  end
+end

data/lib/simmer/suite/result.rb

@@ -22,6 +22,7 @@ module Simmer
       def pass?
         !fail?
       end
+      alias passing? pass?
 
       def fail?
         runner_results.any?(&:fail?)

data/lib/simmer/suite/results_writer.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+module Simmer
+  class Suite
+    # Understands how to write a SessionResult instance to disk.
+    class ResulstWriter
+      DATA_FILE = 'data.yaml'
+
+      # Pass in dir here:
+      def initialize(session_result, results_dir)
+        raise ArgumentError, 'session_result is required' unless session_result
+        raise ArgumentError, 'results_directory is required' unless results_dir
+
+        @session_result = session_result
+        @results_directory = Util::FileSystem.setup_directory(results_dir)
+
+        freeze
+      end
+
+      def write!
+        dir = Util::FileSystem.setup_directory(results_directory)
+
+        IO.write(data_path(dir), session_result.to_h.to_yaml)
+
+        self
+      end
+
+      private
+
+      attr_reader :results_directory, :session_result
+
+      def data_path(dir)
+        File.join(dir, DATA_FILE)
+      end
+    end
+  end
+end

data/lib/simmer/util.rb

@@ -8,5 +8,6 @@
 #
 
 require_relative 'util/evaluator'
+require_relative 'util/file_system'
 require_relative 'util/record_set'
 require_relative 'util/yaml_reader'

data/lib/simmer/util/file_system.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+#
+# Copyright (c) 2020-present, Blue Marble Payroll, LLC
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+#
+
+require_relative 'resolver'
+
+module Simmer
+  module Util
+    # Provides convenience methods for working with the file system.
+    class FileSystem # :nodoc:
+      class << self
+        def setup_directory(dir_path)
+          File.expand_path(dir_path).tap do |expanded_dir|
+            FileUtils.mkdir_p(expanded_dir)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/simmer/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Simmer
-  VERSION = '2.0.0-alpha.1'
+  VERSION = '4.0.0'
 end

data/simmer.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
     Provides a harness for testing Pentaho Data Integration jobs and transformations.
   DESCRIPTION
 
-  s.authors     = ['Matthew Ruggio']
+  s.authors     = ['Matthew Ruggio', 'Ryan Gerry']
   s.email       = ['mruggio@bluemarblepayroll.com']
   s.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   s.bindir      = 'exe'
@@ -32,14 +32,16 @@ Gem::Specification.new do |s|
   s.add_dependency('aws-sdk-s3', '~>1.6')
   s.add_dependency('mysql2', '~>0.5')
   s.add_dependency('objectable', '~>1')
-  s.add_dependency('pdi', '~>2')
+  s.add_dependency('pdi', '~>2.1')
   s.add_dependency('stringento', '~>2')
 
   s.add_development_dependency('guard-rspec', '~>4.7')
   s.add_development_dependency('pry', '~>0')
+  s.add_development_dependency 'pry-byebug'
   s.add_development_dependency('rake', '~> 13')
   s.add_development_dependency('rspec')
   s.add_development_dependency('rubocop', '~>0.79.0')
   s.add_development_dependency('simplecov', '~>0.17.0')
   s.add_development_dependency('simplecov-console', '~>0.6.0')
+  s.add_development_dependency('terminal-notifier-guard')
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: simmer
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.alpha.1
+  version: 4.0.0
 platform: ruby
 authors:
 - Matthew Ruggio
+- Ryan Gerry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-11 00:00:00.000000000 Z
+date: 2020-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -72,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: stringento
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +123,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +207,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.6.0
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: "    Provides a harness for testing Pentaho Data Integration jobs and
   transformations.\n"
 email:
@@ -216,7 +245,9 @@ files:
 - bin/console
 - exe/simmer
 - lib/simmer.rb
+- lib/simmer/bootstrap.rb
 - lib/simmer/configuration.rb
+- lib/simmer/configuration/callback_dsl.rb
 - lib/simmer/core_ext/hash.rb
 - lib/simmer/database.rb
 - lib/simmer/database/fixture.rb
@@ -231,8 +262,10 @@ files:
 - lib/simmer/externals/sql_writers/sql_fixture.rb
 - lib/simmer/judge.rb
 - lib/simmer/judge/result.rb
+- lib/simmer/re_runner.rb
 - lib/simmer/runner.rb
 - lib/simmer/runner/result.rb
+- lib/simmer/runner/timeout_error.rb
 - lib/simmer/specification.rb
 - lib/simmer/specification/act.rb
 - lib/simmer/specification/act/params.rb
@@ -245,10 +278,13 @@ files:
 - lib/simmer/specification/stage.rb
 - lib/simmer/specification/stage/input_file.rb
 - lib/simmer/suite.rb
-- lib/simmer/suite/reporter.rb
+- lib/simmer/suite/output_router.rb
+- lib/simmer/suite/pdi_output_writer.rb
 - lib/simmer/suite/result.rb
+- lib/simmer/suite/results_writer.rb
 - lib/simmer/util.rb
 - lib/simmer/util/evaluator.rb
+- lib/simmer/util/file_system.rb
 - lib/simmer/util/record.rb
 - lib/simmer/util/record_set.rb
 - lib/simmer/util/resolver.rb
@@ -275,9 +311,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.0.3
 signing_key: