simmer 2.0.0.pre.alpha → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca773bcfd599ef170f20d49b7d7c4cd6fa3d6559d435fe6bc59ad03b2d438ab3
-  data.tar.gz: 97170a64ec34728574de07e7fb1dde8ba2ca573a0868271942e42af4157fc716
+  metadata.gz: 4c2be2ad790619cfd4a18f34df9c05b9a575a67b80a8d8be4a4e2a0fae4f1271
+  data.tar.gz: 5467d82cf7c7be7c1aab033b45302d6b97d74b56447194ddd3b8ac4760a7ff11
 SHA512:
-  metadata.gz: db9a259095c0be04a8de3d782a54706a42ac6d06a15ea0c53aa371935c17e09b5e6239ebb869b8bf7d75626347e15a7b71ade6bcbe4a780243d641c6dc6779b3
-  data.tar.gz: c637c746037b0b99a042760b79ba5cedabf5de875db7b1a86ac4e28a7b6948eed32aea9b29be72b7720e2bf5ea825ef9e54f5e2515ac98b6dff01c18e5f2edda
+  metadata.gz: 28076b241e673455e18ffc482829425f81754ffde566e58fd9b011cb5d0dd40cb1143b6a35f51f59789096406e5ace09e707e72fa7de640f786b55863a0d7242
+  data.tar.gz: eb7a544f07c273e659aa313877741ddb9628ec1e03f04002f63e26663000f47efa8161582a61146f5a5a059130202bafd469047d00fabfcb1371fa1b323d01f2

data/.rubocop.yml

@@ -13,7 +13,7 @@ Metrics/BlockLength:
     - define
 
 Metrics/MethodLength:
-  Max: 25
+  Max: 30
 
 AllCops:
   TargetRubyVersion: 2.5
@@ -23,3 +23,9 @@ Metrics/AbcSize:
 
 Metrics/ClassLength:
   Max: 125
+
+Style/TrailingCommaInHashLiteral:
+  Enabled: false
+
+Style/TrailingCommaInArrayLiteral:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.6.5
+2.6.6

data/.travis.yml

@@ -6,9 +6,9 @@ services:
   - mysql
 rvm:
   # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
-  - 2.5.5
-  - 2.6.5
-  - 2.7.0
+    - 2.5.8
+    - 2.6.6
+    - 2.7.1
 cache: bundler
 before_script:
   - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter

data/CHANGELOG.md

@@ -1 +1,34 @@
+# Simmer Change Log
 
+## 3.0.0 (June 8th, 2020)
+
+Breaking Changes:
+
+* `Simmer::Runner` now accepts a `Simmer::Suite::OutputRouter` instead of an `IO` instance as its 'out' parameter.
+* The `execution_output` and `execution_result` methods have been removed from `Simmer::Runner::Result`.
+
+Additions:
+
+* pdi_out.txt is written to throughout test execution instead of at the end.
+
+Fixes:
+
+* Fixtures now handle identifiers which are MySQL reserved words.
+
+## 2.1.0 (May 13th, 2020)
+
+Additions:
+
+* Do not make missing fixtures short-circuit the rest of the test suite.
+* Do not make PDI timeouts short-circuit the rest of the test suite.
+* Report PDI's exit code and execution time to the console.
+
+## 2.0.0 (May 11th, 2020)
+
+Breaking Changes:
+
+* Do not emit error file, standard error has been combined with the standard output within the underlying pdi library.
+
+Additions:
+
+* Enhanced Simmer configuration for `spoon_client` to account for `timeout_in_seconds` option.

data/README.md

@@ -281,6 +281,15 @@ Basic steps to take to get this repository compiling:
 3. Clone the repository (git clone git@github.com:bluemarblepayroll/simmer.git)
 4. Navigate to the root folder (cd simmer)
 5. Install dependencies (bundle)
+6. Create the 'simmer_test' MySQL database as defined in `spec/db/tables.sql`.
+7. Add the tables from `spec/db/tables.sql` to this database.
+8. Configure your test simmer.yaml:
+
+````bash
+cp spec/config/simmer.yaml.ci spec/config/simmer.yaml
+```
+
+9. Edit `spec/config/simmer.yaml` so that it can connect to the database created in step seven.
 
 ### Running Tests
 

data/lib/simmer.rb

@@ -51,7 +51,8 @@ module Simmer
     )
       configuration = make_configuration(config_path: config_path, simmer_dir: simmer_dir)
       specs         = make_specifications(path, configuration.tests_dir)
-      runner        = make_runner(configuration, out)
+      out_router    = make_output_router(configuration, out)
+      runner        = make_runner(configuration, out_router)
       suite         = make_suite(configuration, out, runner)
 
       suite.run(specs)
@@ -66,6 +67,21 @@ module Simmer
       Configuration.new(raw_config, simmer_dir)
     end
 
+    def make_runner(configuration, out_router)
+      database     = make_mysql_database(configuration)
+      file_system  = make_file_system(configuration)
+      fixture_set  = make_fixture_set(configuration)
+      spoon_client = make_spoon_client(configuration)
+
+      Runner.new(
+        database: database,
+        file_system: file_system,
+        fixture_set: fixture_set,
+        out: out_router,
+        spoon_client: spoon_client
+      )
+    end
+
     private
 
     def yaml_reader
@@ -82,21 +98,6 @@ module Simmer
       end
     end
 
-    def make_runner(configuration, out)
-      database     = make_mysql_database(configuration)
-      file_system  = make_file_system(configuration)
-      fixture_set  = make_fixture_set(configuration)
-      spoon_client = make_spoon_client(configuration)
-
-      Runner.new(
-        database: database,
-        file_system: file_system,
-        fixture_set: fixture_set,
-        out: out,
-        spoon_client: spoon_client
-      )
-    end
-
     def make_fixture_set(configuration)
       config = Util::YamlReader.new.smash(configuration.fixtures_dir)
 
@@ -142,7 +143,7 @@ module Simmer
 
     def make_spoon_client(configuration)
       config     = (configuration.spoon_client_config || {}).symbolize_keys
-      spoon_args = config.slice(:args, :dir, :kitchen, :pan)
+      spoon_args = config.slice(:args, :dir, :kitchen, :pan, :timeout_in_seconds)
       spoon      = Pdi::Spoon.new(spoon_args)
 
       Externals::SpoonClient.new(configuration.files_dir, spoon)
@@ -156,5 +157,10 @@ module Simmer
         runner: runner
       )
     end
+
+    def make_output_router(configuration, console_out)
+      pdi_out = Suite::PdiOutputWriter.new(configuration.results_dir)
+      Simmer::Suite::OutputRouter.new(console_out, pdi_out)
+    end
   end
 end

data/lib/simmer/database/fixture_set.rb

@@ -13,6 +13,8 @@ module Simmer
   module Database
     # Hydrate a collection of Fixture instances from configuration.
     class FixtureSet
+      class FixtureMissingError < StandardError; end
+
       def initialize(config = {})
         @fixtures_by_name = config_to_fixures_by_name(config)
 
@@ -22,7 +24,7 @@ module Simmer
       def get!(name)
         key = name.to_s
 
-        raise ArgumentError, "fixture not found: #{name}" unless fixtures_by_name.key?(key)
+        raise FixtureMissingError, "fixture missing: #{name}" unless fixtures_by_name.key?(key)
 
         fixtures_by_name[key]
       end

data/lib/simmer/externals/mysql_database.rb

@@ -27,7 +27,7 @@ module Simmer
       end
 
       def records(table, columns = [])
-        query = "SELECT #{sql_select_params(columns)} FROM #{table}"
+        query = "SELECT #{sql_select_params(columns)} FROM #{qualify(table)}"
 
         client.query(query).to_a
       end
@@ -53,7 +53,11 @@ module Simmer
       attr_reader :client, :fixture_set, :table_names
 
       def sql_select_params(columns)
-        Array(columns).any? ? Array(columns).map { |c| client.escape(c) }.join(',') : '*'
+        if Array(columns).any?
+          Array(columns).map { |c| qualify(client.escape(c)).to_s }.join(',')
+        else
+          '*'
+        end
       end
 
       def seed_sql_statements(fixtures)
@@ -62,7 +66,7 @@ module Simmer
 
       def clean_sql_statements
         table_names.map do |table_name|
-          "TRUNCATE #{table_name}"
+          "TRUNCATE #{qualify(table_name)}"
         end
       end
 
@@ -110,6 +114,10 @@ module Simmer
 
         raise ArgumentError, "database (#{name}) must end in #{DATABASE_SUFFIX}"
       end
+
+      def qualify(identifier)
+        "`#{identifier}`"
+      end
     end
   end
 end

data/lib/simmer/externals/spoon_client.rb

@@ -13,6 +13,8 @@ module Simmer
   module Externals
     # Wraps up Pdi::Spoon at a higher-level for Simmer to consume.
     class SpoonClient
+      attr_reader :spoon
+
       def initialize(files_dir, spoon)
         raise ArgumentError, 'spoon is required' unless spoon
 
@@ -22,13 +24,13 @@ module Simmer
         freeze
       end
 
-      def run(specification, config)
+      def run(specification, config, &output_capturer)
         execution_result = nil
         time_in_seconds  = nil
 
         begin
           time_in_seconds = Benchmark.measure do
-            execution_result = execute!(specification, config)
+            execution_result = execute!(specification, config, &output_capturer)
           end.real
         rescue Pdi::Spoon::PanError, Pdi::Spoon::KitchenError => e
           return Result.new(
@@ -46,16 +48,17 @@ module Simmer
 
       private
 
-      attr_reader :files_dir, :spoon
+      attr_reader :files_dir
 
-      def execute!(specification, config)
+      def execute!(specification, config, &output_capturer)
         act = specification.act
 
         spoon.run(
           repository: act.repository,
           name: act.name,
           params: act.compiled_params(files_dir, config),
-          type: act.type
+          type: act.type,
+          &output_capturer
         )
       end
     end

data/lib/simmer/judge/result.rb

@@ -13,7 +13,7 @@ module Simmer
     class Result
       attr_reader :bad_assertions
 
-      def initialize(bad_assertions)
+      def initialize(bad_assertions = [])
         @bad_assertions = bad_assertions
 
         freeze

data/lib/simmer/runner.rb

@@ -13,6 +13,8 @@ require_relative 'runner/result'
 module Simmer
   # Runs a single specification.
   class Runner
+    attr_reader :spoon_client
+
     def initialize(database:, file_system:, fixture_set:, out:, spoon_client:)
       @database     = database
       @file_system  = file_system
@@ -25,109 +27,112 @@ module Simmer
     end
 
     def run(specification, config: {}, id: SecureRandom.uuid)
-      print("Name: #{specification.name}")
-      print("Path: #{specification.path}")
-
-      clean_db
-      seed_db(specification)
-      clean_file_system
-      seed_file_system(specification)
+      out.announce_start(id, specification)
+      clean_and_seed(specification)
 
       spoon_client_result = execute_spoon(specification, config)
       judge_result        = assert(specification, spoon_client_result)
 
-      Result.new(id, judge_result, specification, spoon_client_result).tap do |result|
-        msg = pass_message(result)
-        print_waiting('Done', 'Final verdict')
-        print(msg)
+      Result.new(
+        id: id,
+        judge_result: judge_result,
+        specification: specification,
+        spoon_client_result: spoon_client_result
+      ).tap do |result|
+        out.final_verdict(result)
+      end
+    rescue Database::FixtureSet::FixtureMissingError, Timeout::Error => e
+      Result.new(
+        id: id,
+        specification: specification,
+        errors: e.message
+      ).tap do |result|
+        out.final_verdict(result)
       end
     end
 
+    def complete
+      out.close
+    end
+
     private
 
-    attr_reader :database, :file_system, :fixture_set, :judge, :out, :spoon_client
+    attr_reader :database, :file_system, :fixture_set, :judge, :out
+
+    def clean_and_seed(specification)
+      clean_db
+      seed_db(specification)
+      clean_file_system
+      seed_file_system(specification)
+    end
 
     def clean_db
-      print_waiting('Stage', 'Cleaning database')
+      out.waiting('Stage', 'Cleaning database')
       count = database.clean!
-      print("#{count} table(s) emptied")
+      out.console_puts("#{count} table(s) emptied")
 
       count
     end
 
     def seed_db(specification)
-      print_waiting('Stage', 'Seeding database')
+      out.waiting('Stage', 'Seeding database')
 
       fixtures = specification.stage.fixtures.map { |f| fixture_set.get!(f) }
       count    = database.seed!(fixtures)
 
-      print("#{count} record(s) inserted")
+      out.console_puts("#{count} record(s) inserted")
 
       count
+    rescue Database::FixtureSet::FixtureMissingError => e
+      out.console_puts('Missing Fixture(s)')
+      raise e
     end
 
     def clean_file_system
-      print_waiting('Stage', 'Cleaning File System')
+      out.waiting('Stage', 'Cleaning File System')
       count = file_system.clean!
-      print("#{count} file(s) deleted")
+      out.console_puts("#{count} file(s) deleted")
 
       count
     end
 
     def seed_file_system(specification)
-      print_waiting('Stage', 'Seeding File System')
+      out.waiting('Stage', 'Seeding File System')
       count = file_system.write!(specification.stage.files)
-      print("#{count} file(s) uploaded")
+      out.console_puts("#{count} file(s) uploaded")
 
       count
     end
 
     def execute_spoon(specification, config)
-      print_waiting('Act', 'Executing Spoon')
-      spoon_client_result = spoon_client.run(specification, config)
-      msg = pass_message(spoon_client_result)
-      print(msg)
+      out.waiting('Act', 'Executing Spoon')
+
+      spoon_client_result = spoon_client.run(specification, config) do |output|
+        out.capture_spoon_output(output)
+      end
+
+      out.finish_spec
+      out.spoon_execution_detail_message(spoon_client_result)
 
       spoon_client_result
+    rescue Timeout::Error => e
+      out.console_puts('Timed out')
+      raise e
     end
 
     def assert(specification, spoon_client_result)
-      print_waiting('Assert', 'Checking results')
+      out.waiting('Assert', 'Checking results')
 
       if spoon_client_result.fail?
-        print('Skipped')
+        out.console_puts('Skipped')
         return nil
       end
 
       output       = spoon_client_result.execution_result.out
       judge_result = judge.assert(specification, output)
-      msg          = pass_message(judge_result)
-
-      print(msg)
+      out.result(judge_result)
 
       judge_result
     end
-
-    def print(msg)
-      out.puts(msg)
-    end
-
-    def print_waiting(stage, msg)
-      max  = 25
-      char = '.'
-      msg  = "  > #{pad_right(stage, 6)} - #{pad_right(msg, max, char)}"
-
-      out.print(msg)
-    end
-
-    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

data/lib/simmer/runner/result.rb

@@ -13,23 +13,36 @@ module Simmer
     class Result
       extend Forwardable
 
-      attr_reader :id, :judge_result, :specification, :spoon_client_result
-
-      def_delegators :spoon_client_result, :time_in_seconds
+      attr_reader :errors, :id, :judge_result, :specification, :spoon_client_result
 
       def_delegators :specification, :name
 
-      def initialize(id, judge_result, specification, spoon_client_result)
+      def initialize(
+        id:,
+        specification:,
+        judge_result: nil,
+        spoon_client_result: nil,
+        errors: []
+      )
         @id                  = id.to_s
         @judge_result        = judge_result
         @specification       = specification
         @spoon_client_result = spoon_client_result
+        @errors              = Array(errors)
 
         freeze
       end
 
+      def time_in_seconds
+        spoon_client_result&.time_in_seconds || 0
+      end
+
       def pass?
-        judge_result&.pass? && spoon_client_result&.pass?
+        [
+          judge_result&.pass?,
+          spoon_client_result&.pass?,
+          errors.empty?,
+        ].all?
       end
 
       def fail?
@@ -44,7 +57,8 @@ module Simmer
           'time_in_seconds' => time_in_seconds,
           'pass' => pass?,
           'spoon_client_result' => spoon_client_result.to_h,
-          'judge_result' => judge_result.to_h
+          'judge_result' => judge_result.to_h,
+          'errors' => errors,
         }
       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
@@ -33,15 +35,12 @@ module Simmer
 
     def run(specifications)
       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
+        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}")
       end
@@ -77,5 +76,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'
+  VERSION = '3.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,11 +32,12 @@ 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.0.0.pre.alpha')
+  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')

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: simmer
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre.alpha
+  version: 3.0.0
 platform: ruby
 authors:
 - Matthew Ruggio
+- Ryan Gerry
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-08 00:00:00.000000000 Z
+date: 2020-06-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -70,16 +71,16 @@ dependencies:
   name: pdi
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.pre.alpha
+        version: '2.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.pre.alpha
+        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
@@ -245,10 +260,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 +293,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: 

data/lib/simmer/suite/reporter.rb

@@ -1,83 +0,0 @@
-# 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 Reporter
-      DATA_FILE    = 'data.yaml'
-      PDI_OUT_FILE = 'pdi_out.txt'
-
-      def initialize(session_result)
-        raise ArgumentError, 'session_result is required' unless session_result
-
-        @session_result = session_result
-
-        freeze
-      end
-
-      def write!(dir)
-        dir = setup_directory(dir)
-
-        IO.write(data_path(dir), session_result.to_h.to_yaml)
-
-        pdi_out_file = File.open(pdi_out_path(dir), 'w')
-
-        write_part(session_result.runner_results, pdi_out_file)
-
-        pdi_out_file.close
-
-        self
-      end
-
-      private
-
-      attr_reader :session_result
-
-      def data_path(dir)
-        File.join(dir, DATA_FILE)
-      end
-
-      def pdi_out_path(dir)
-        File.join(dir, PDI_OUT_FILE)
-      end
-
-      def setup_directory(dir)
-        File.expand_path(dir).tap do |expanded_dir|
-          FileUtils.mkdir_p(expanded_dir)
-        end
-      end
-
-      def write_part(runner_results, pdi_out_file)
-        runner_results.each do |runner_result|
-          name         = runner_result.name
-          runner_id    = runner_result.id
-          out_contents = runner_result.spoon_client_result.execution_result.out
-
-          write_block(pdi_out_file, name, runner_id, out_contents)
-        end
-
-        nil
-      end
-
-      def write_block(file, name, runner_id, contents)
-        hyphens = '-' * 80
-
-        file.write("#{hyphens}\n")
-        file.write("Name: #{name}\n")
-        file.write("Runner ID: #{runner_id}\n")
-        file.write("#{hyphens}\n")
-        file.write("#{contents}\n")
-        file.write("\n")
-
-        nil
-      end
-    end
-  end
-end