simmer 1.0.0.pre.alpha.3 → 1.0.0.pre.alpha.4

data/lib/simmer/runner.rb

@@ -64,7 +64,7 @@ module Simmer
 
     def clean_file_system
       print_waiting('Stage', 'Cleaning File System')
-      count = file_system.clean
+      count = file_system.clean!
       print("#{count} file(s) deleted")
 
       count
@@ -72,7 +72,7 @@ module Simmer
 
     def seed_file_system(specification)
       print_waiting('Stage', 'Seeding File System')
-      count = file_system.write(specification)
+      count = file_system.write!(specification)
       print("#{count} file(s) uploaded")
 
       count

data/lib/simmer/specification/act.rb

@@ -16,11 +16,6 @@ module Simmer
       extend Forwardable
       acts_as_hashable
 
-      module Type
-        JOB            = :job
-        TRANSFORMATION = :transformation
-      end
-
       attr_reader :repository, :name, :type, :params
 
       def_delegator :params, :compile, :compiled_params
@@ -32,7 +27,7 @@ module Simmer
 
         @repository = repository.to_s
         @name       = name.to_s
-        @type       = Type.const_get(type.to_s.to_s.upcase.to_sym)
+        @type       = type.to_s
         @params     = Params.make(params)
 
         freeze

data/lib/simmer/specification/assert/assertions/table.rb

@@ -27,6 +27,7 @@ module Simmer
           end
 
           def assert(database, _output)
+            keys                = record_set.keys
             actual_records      = database.records(name, keys)
             actual_record_set   = Util::RecordSet.new(actual_records)
 
@@ -34,12 +35,6 @@ module Simmer
 
             BadTableAssertion.new(name, record_set, actual_record_set)
           end
-
-          private
-
-          def keys
-            record_set.keys
-          end
         end
       end
     end

data/lib/simmer/spoon_mock.rb

@@ -0,0 +1,35 @@
+# 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
+  # Provides a simple mock for the underlying Pdi::Spoon class.
+  class SpoonMock
+    attr_reader :pass
+
+    def initialize(pass = true)
+      @pass = pass
+
+      freeze
+    end
+
+    def run(*)
+      raise Pdi::Spoon::KitchenError, 'mocked' unless pass
+
+      Pdi::Executor::Result.new(
+        args: [],
+        status: {
+          code: 0,
+          err: 'Some error output from PDI',
+          out: 'Some output from PDI',
+          pid: 123
+        }
+      )
+    end
+  end
+end

data/lib/simmer/suite.rb

@@ -7,67 +7,73 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require_relative 'configuration'
-require_relative 'externals'
-require_relative 'runner'
-require_relative 'session'
-require_relative 'specification'
+require_relative 'suite/reporter'
+require_relative 'suite/result'
 
-# Entrypoint to the library
 module Simmer
-  # The main object entrypoint that brings the entire codebase together.
+  # Runs a collection of specifications and then writes down the results to disk.
   class Suite
-    attr_reader :configuration, :session
-
-    def initialize(config_path:, out:, results_dir:, simmer_dir:)
-      @configuration = Configuration.new(
-        config_path: config_path,
-        results_dir: results_dir,
-        simmer_dir: simmer_dir
-      )
-
-      runner = Runner.new(
-        database: database,
-        file_system: file_system,
-        out: out,
-        spoon_client: spoon_client
-      )
-
-      @session = Session.new(
-        config: configuration.config,
-        out: out,
-        results_dir: results_dir,
-        runner: runner
-      )
+    def initialize(
+      config:,
+      out:,
+      resolver: Objectable.resolver,
+      results_dir:,
+      runner:
+    )
+      @config      = config || {}
+      @out         = out
+      @resolver    = resolver
+      @results_dir = results_dir
+      @runner      = runner
 
       freeze
     end
 
-    def run(path)
-      session.run(specifications(path))
+    def run(specifications)
+      runner_results = run_all_specs(specifications)
+
+      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
+
+        Reporter.new(result).write!(results_dir)
+
+        out.puts("Results can be viewed at #{results_dir}")
+      end
     end
 
     private
 
-    def specifications(path)
-      path = path.to_s.empty? ? configuration.tests_dir : path
+    attr_reader :config, :out, :results_dir, :resolver, :runner
+
+    def run_all_specs(specifications)
+      out.puts('Simmer suite started')
 
-      Util::YamlReader.new.all(path).map do |file, config|
-        config = (config || {}).merge(path: file)
-        Specification.make(config)
+      count = specifications.length
+
+      out.puts("Running #{count} specification(s)")
+      print_line
+
+      specifications.map.with_index(1) do |specification, index|
+        run_single_spec(specification, index, count)
       end
     end
 
-    def database
-      Externals::MysqlDatabase.new(configuration.database_config, configuration.fixture_set)
-    end
+    def run_single_spec(specification, index, count)
+      id = SecureRandom.uuid
 
-    def file_system
-      Externals::AwsFileSystem.new(configuration.file_system_config, configuration.files_dir)
+      out.puts("Test #{index} of #{count}: #{id} (#{specification.act.type})")
+
+      runner.run(specification, id: id, config: config).tap do
+        print_line
+      end
     end
 
-    def spoon_client
-      Externals::SpoonClient.new(configuration.spoon_client_config, configuration.files_dir)
+    def print_line
+      out.puts('-' * 60)
     end
   end
 end

data/lib/simmer/{session → suite}/reporter.rb

@@ -8,7 +8,7 @@
 #
 
 module Simmer
-  class Session
+  class Suite
     # Understands how to write a SessionResult instance to disk.
     class Reporter
       DATA_FILE    = 'data.yaml'

data/lib/simmer/{session → suite}/result.rb

@@ -8,7 +8,7 @@
 #
 
 module Simmer
-  class Session
+  class Suite
     # The return object for a Session#run call.
     class Result
       attr_reader :runner_results

data/lib/simmer/util.rb

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

data/lib/simmer/util/evaluator.rb

@@ -11,17 +11,16 @@ require_relative 'resolver'
 
 module Simmer
   module Util
-    # Text template renderer.  It knows how to take a string and object as an input and
-    # output a compiled string.
+    # Glues together Objectable and Stringento libraries to form a text template renderer.
     class Evaluator
-      def initialize
-        @resolver = Objectable.resolver
+      def initialize(resolver = Resolver.new)
+        @resolver = resolver
 
         freeze
       end
 
       def evaluate(string, input = {})
-        Stringento.evaluate(string, input, resolver: Resolver.new)
+        Stringento.evaluate(string, input, resolver: resolver)
       end
 
       private

data/lib/simmer/util/record.rb

@@ -19,6 +19,8 @@ module Simmer
       def_delegators :data, :to_h
 
       def initialize(data = {})
+        data = data.respond_to?(:to_h) ? data.to_h : data
+
         @data = sorted_string_hash(data)
       end
 

data/lib/simmer/util/record_set.rb

@@ -14,6 +14,10 @@ module Simmer
     # A less-strict comparable collection of Record instances.
     # It does not depend on Record ordering.
     class RecordSet
+      extend Forwardable
+
+      def_delegators :records, :length
+
       attr_reader :records
 
       def initialize(records = [])
@@ -34,7 +38,7 @@ module Simmer
       end
 
       def keys
-        records.first&.keys || []
+        records.flat_map(&:keys)
       end
 
       private

data/lib/simmer/util/resolver.rb

@@ -14,8 +14,8 @@ module Simmer
     class Resolver
       attr_reader :objectable_resolver
 
-      def initialize
-        @objectable_resolver = Objectable.resolver
+      def initialize(objectable_resolver: Objectable.resolver)
+        @objectable_resolver = objectable_resolver
 
         freeze
       end

data/lib/simmer/util/yaml_reader.rb

@@ -17,26 +17,22 @@ module Simmer
       private_constant :EXTENSIONS
 
       def smash(path)
-        files = all(path).values
-
-        files.each_with_object({}) do |config, memo|
-          memo.merge!(config)
-        end
+        read(path).each_with_object({}) { |file, memo| memo.merge!(file.data || {}) }
       end
 
-      def all(path)
-        expand(path).map { |file| [file, read(file)] }.to_h
+      def read(path)
+        expand(path).map { |file| OpenStruct.new(path: file, data: raw(file)) }
       end
 
-      def read(path)
+      private
+
+      def raw(path)
         path     = File.expand_path(path)
         contents = File.read(path)
 
-        YAML.safe_load(contents) || {}
+        YAML.safe_load(contents)
       end
 
-      private
-
       def wildcard_name
         "*.{#{EXTENSIONS.join(',')}}"
       end
@@ -48,13 +44,14 @@ module Simmer
       def expand(path)
         path = File.expand_path(path.to_s)
 
+        # The sort will ensure it is deterministic (lexicographic by path)
         if File.directory?(path)
           glob = full_path(path)
 
           Dir[glob].to_a
         else
           Array(path)
-        end
+        end.sort
       end
     end
   end

data/lib/simmer/version.rb

@@ -8,5 +8,5 @@
 #
 
 module Simmer
-  VERSION = '1.0.0-alpha.3'
+  VERSION = '1.0.0-alpha.4'
 end

data/spec/config/simmer.yaml.ci

@@ -0,0 +1,7 @@
+mysql_database:
+  init_command: "SET @@SESSION.sql_mode = 'TRADITIONAL,NO_AUTO_VALUE_ON_ZERO'"
+  database: simmer_test
+  username: root
+  host: 127.0.0.1
+  port: 3306
+  flags: MULTI_STATEMENTS

data/spec/db/database.sql

@@ -0,0 +1 @@
+CREATE DATABASE IF NOT EXISTS simmer_test;

data/spec/db/tables.sql

@@ -0,0 +1,20 @@
+DROP TABLE IF EXISTS `simmer_test`.`notes`;
+DROP TABLE IF EXISTS `simmer_test`.`agents`;
+
+CREATE TABLE `simmer_test`.`agents` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `call_sign` varchar(150) NOT NULL,
+  `first` varchar(255),
+  `last` varchar(255),
+  PRIMARY KEY (`id`),
+  UNIQUE INDEX (`call_sign`)
+);
+
+CREATE TABLE `simmer_test`.`notes` (
+  `id` int(11) NOT NULL AUTO_INCREMENT,
+  `agent_id` int(11) NOT NULL,
+  `note` varchar(255),
+  PRIMARY KEY (`id`),
+  INDEX (`agent_id`),
+  FOREIGN KEY (`agent_id`) REFERENCES `simmer_test`.`agents`(`id`)
+);

data/spec/db_helper.rb

@@ -0,0 +1,26 @@
+# 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.
+#
+
+CLEAN_SQL_STATEMENTS = [
+  'DELETE FROM `simmer_test`.`notes`',
+  'DELETE FROM `simmer_test`.`agents`'
+].freeze
+
+def db_helper_config
+  simmer_config['mysql_database']
+end
+
+def db_helper_client
+  @db_helper_client ||= Mysql2::Client.new(db_helper_config)
+end
+
+def db_helper_clean_schema
+  CLEAN_SQL_STATEMENTS.each { |sql| db_helper_client.query(sql) }
+  nil
+end

data/spec/fixtures/agent_fixtures.yaml

@@ -0,0 +1,14 @@
+hulk:
+  table: agents
+  fields:
+    call_sign: hulk
+    first: CLASSIFIED
+    last: CLASSIFIED
+
+iron_man:
+  table: agents
+  fields:
+    call_sign: iron_man
+    first: CLASSIFIED
+    last: CLASSIFIED
+

data/spec/fixtures/configuration.yaml

@@ -0,0 +1,11 @@
+aws_file_system:
+  aws_file_system_key: aws_file_system_value
+
+mysql_database:
+  mysql_database_key: mysql_database_value
+
+spoon_client:
+  spoon_client_key: spoon_client_value
+
+other:
+  other_key: other_value