simmer 1.0.0.pre.alpha.5 → 1.0.0.pre.alpha.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c70362d593331adc1b9499d1292f6a3c43d06a556eddfcc5d52c203d1f5081e0
-  data.tar.gz: edd212d1fc90f57a06bf8594793ac7c574a40e5ac39b3b25ce2dd1abed2a0b9f
+  metadata.gz: d7bb744ed6c7545eff9608e7b4548b5b71afbc219d75cba872f93b6fb0e7db31
+  data.tar.gz: ab9487df40d1d7dd7030c09e9d35398cf45169ec5c1ac322165728ee40bdaa8a
 SHA512:
-  metadata.gz: 40e8856733adf93d0602bad3e06a8d7da6a304a2a0856efcd43a279318441c836311630fcfa9ee5e4b75c8ddf7d261c34c8d6c23cd69b5adccc87591cb59a3ce
-  data.tar.gz: f67b95adfb5bddd49996306b540621b79fd1430c5cd82a1310b80ab6652657e52b4bf297b2e42c6dabe4a2d15f7fd48c26f25337bef12d511819add50ea85ad4
+  metadata.gz: da855ec25b4bccb880dc974abab073cadd22467f36451320c1bf550599f818c72684c5c2b01e61453a8d498e46beb949c21035b1a012009c4ee37f9e36ef59ad
+  data.tar.gz: e906e083ade596051e93e5a67f64faa5c306ac112eaafa0dabb507c2e42d0daec0baa3434645ee39675b0b05ff9657db331ef435ff36417dc4d40294ce3f7023

data/.gitignore

@@ -4,5 +4,6 @@
 /coverage
 Gemfile.lock
 /pkg
-/bin/di
 /spec/config/simmer.yaml
+/spec/simmer_spec/results
+

data/.rubocop.yml

@@ -16,7 +16,7 @@ Metrics/MethodLength:
   Max: 25
 
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.5
 
 Metrics/AbcSize:
   Max: 16

data/.travis.yml

@@ -6,7 +6,6 @@ services:
   - mysql
 rvm:
   # Build on the latest stable of all supported Rubies (https://www.ruby-lang.org/en/downloads/):
-  - 2.4.6
   - 2.5.5
   - 2.6.5
   - 2.7.0

data/lib/simmer/configuration.rb

@@ -12,9 +12,10 @@ module Simmer
   # Simmer implementation.
   class Configuration
     # Configuration Keys
-    AWS_FILE_SYSTEM_KEY = :aws_file_system
-    MYSQL_DATABASE_KEY  = :mysql_database
-    SPOON_CLIENT_KEY    = :spoon_client
+    AWS_FILE_SYSTEM_KEY   = :aws_file_system
+    LOCAL_FILE_SYSTEM_KEY = :local_file_system
+    MYSQL_DATABASE_KEY    = :mysql_database
+    SPOON_CLIENT_KEY      = :spoon_client
 
     # Paths
     FILES    = 'files'
@@ -47,6 +48,18 @@ module Simmer
       get(AWS_FILE_SYSTEM_KEY) || {}
     end
 
+    def local_file_system_config
+      get(LOCAL_FILE_SYSTEM_KEY) || {}
+    end
+
+    def aws_file_system?
+      config.key?(AWS_FILE_SYSTEM_KEY.to_s)
+    end
+
+    def local_file_system?
+      config.key?(LOCAL_FILE_SYSTEM_KEY.to_s)
+    end
+
     def spoon_client_config
       get(SPOON_CLIENT_KEY) || {}
     end

data/lib/simmer/database/fixture_set.rb

@@ -27,10 +27,6 @@ module Simmer
         fixtures_by_name[key]
       end
 
-      def all
-        fixtures_by_name.values
-      end
-
       private
 
       attr_reader :fixtures_by_name

data/lib/simmer/externals/aws_file_system.rb

@@ -7,42 +7,37 @@
 # LICENSE file in the root directory of this source tree.
 #
 
+require_relative 'file_system'
+
 module Simmer
   module Externals
     # Provides the implementation for using AWS S3 as a destination file store.
-    class AwsFileSystem
-      BUCKET_SUFFIX = 'test'
-
-      private_constant :BUCKET_SUFFIX
-
+    class AwsFileSystem < FileSystem
       def initialize(aws_s3_client, bucket, encryption, files_dir)
         raise ArgumentError, 'aws_s3_client is required' unless aws_s3_client
         raise ArgumentError, 'bucket is required'        if bucket.to_s.empty?
 
-        assert_bucket_name(bucket)
+        super(bucket)
 
         @aws_s3_client = aws_s3_client
-        @bucket        = bucket.to_s
         @encryption    = encryption
         @files_dir     = files_dir
 
         freeze
       end
 
-      def write!(specification)
-        files = specification.stage.files
-
-        files.each do |file|
-          src = File.join(files_dir, file.src)
+      def write!(input_files)
+        input_files.each do |input_file|
+          src = File.join(files_dir, input_file.src)
 
-          write_single(file.dest, src)
+          write_single(input_file.dest, src)
         end
 
-        files.length
+        input_files.length
       end
 
       def clean!
-        response    = aws_s3_client.list_objects(bucket: bucket)
+        response    = aws_s3_client.list_objects(bucket: root)
         objects     = response.contents
         keys        = objects.map(&:key)
         delete_keys = keys.map { |key| { key: key } }
@@ -50,7 +45,7 @@ module Simmer
         return 0 if objects.length.zero?
 
         aws_s3_client.delete_objects(
-          bucket: bucket,
+          bucket: root,
           delete: {
             objects: delete_keys
           }
@@ -61,7 +56,7 @@ module Simmer
 
       private
 
-      attr_reader :aws_s3_client, :bucket, :encryption, :files_dir
+      attr_reader :aws_s3_client, :encryption, :files_dir
 
       def write_single(dest, src)
         src = File.expand_path(src)
@@ -69,7 +64,7 @@ module Simmer
         File.open(src, 'rb') do |file|
           aws_s3_client.put_object(
             body: file.read,
-            bucket: bucket,
+            bucket: root,
             key: dest,
             server_side_encryption: encryption
           )
@@ -77,12 +72,6 @@ module Simmer
 
         nil
       end
-
-      def assert_bucket_name(name)
-        return if name.to_s.end_with?(BUCKET_SUFFIX)
-
-        raise ArgumentError, "bucket (#{name}) must end in #{BUCKET_SUFFIX}"
-      end
     end
   end
 end

data/lib/simmer/externals/file_system.rb

@@ -0,0 +1,29 @@
+# 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
+  module Externals
+    # Provides the shared basics of all file systems.
+    class FileSystem
+      SUFFIX = 'test'
+
+      private_constant :SUFFIX
+
+      def initialize(root)
+        @root = root.to_s
+
+        raise ArgumentError, "root: #{root} must end in #{SUFFIX}" unless root.end_with?(SUFFIX)
+      end
+
+      private
+
+      attr_reader :root
+    end
+  end
+end

data/lib/simmer/externals/local_file_system.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.
+#
+
+require_relative 'file_system'
+
+module Simmer
+  module Externals
+    # Provides the implementation for using a local directory
+    class LocalFileSystem < FileSystem
+      def initialize(root, files_dir)
+        root = File.expand_path(root.to_s)
+
+        super(root)
+
+        @files_dir = files_dir.to_s
+
+        freeze
+      end
+
+      def write!(input_files)
+        input_files.each do |input_file|
+          src = File.join(files_dir, input_file.src)
+
+          write_single(input_file.dest, src)
+        end
+
+        input_files.length
+      end
+
+      def clean!
+        glob      = File.join(root, '**', '*')
+        all_files = Dir[glob].reject { |p| File.directory?(p) }
+
+        all_files.each { |path| FileUtils.rm(path) }
+        all_files.length
+      end
+
+      private
+
+      attr_reader :files_dir
+
+      def write_single(dest, src)
+        full_dest = File.join(root, dest)
+        dest_dir  = File.dirname(full_dest)
+        FileUtils.mkdir_p(dest_dir)
+        FileUtils.cp(src, full_dest)
+      end
+    end
+  end
+end

data/lib/simmer/externals/mysql_database.rb

@@ -15,14 +15,14 @@ module Simmer
     class MysqlDatabase
       DATABASE_SUFFIX = 'test'
 
-      def initialize(client, exclude_tables, fixture_set)
-        @client        = client
-        @fixture_set   = fixture_set
-        exclude_tables = Array(exclude_tables).map(&:to_s)
-        @table_names   = retrieve_table_names - exclude_tables
+      def initialize(client, exclude_tables = [])
+        @client = client
 
         assert_database_name(schema)
 
+        exclude_tables = Array(exclude_tables).map(&:to_s)
+        @table_names   = retrieve_table_names - exclude_tables
+
         freeze
       end
 
@@ -32,8 +32,8 @@ module Simmer
         client.query(query).to_a
       end
 
-      def seed!(specification)
-        sql_statements = seed_sql_statements(specification)
+      def seed!(fixtures)
+        sql_statements = seed_sql_statements(fixtures)
 
         shameless_execute(sql_statements)
 
@@ -56,14 +56,8 @@ module Simmer
         Array(columns).any? ? Array(columns).map { |c| client.escape(c) }.join(',') : '*'
       end
 
-      def seed_sql_statements(specification)
-        fixture_names = specification.stage.fixtures
-
-        fixture_names.map do |fixture_name|
-          fixture = fixture_set.get!(fixture_name)
-
-          SqlFixture.new(client, fixture).to_sql
-        end
+      def seed_sql_statements(fixtures)
+        fixtures.map { |fixture| SqlFixture.new(client, fixture).to_sql }
       end
 
       def clean_sql_statements

data/lib/simmer/externals.rb

@@ -8,5 +8,6 @@
 #
 
 require_relative 'externals/aws_file_system'
+require_relative 'externals/local_file_system'
 require_relative 'externals/mysql_database'
 require_relative 'externals/spoon_client'

data/lib/simmer/runner.rb

@@ -13,9 +13,10 @@ require_relative 'runner/result'
 module Simmer
   # Runs a single specification.
   class Runner
-    def initialize(database:, file_system:, out:, spoon_client:)
+    def initialize(database:, file_system:, fixture_set:, out:, spoon_client:)
       @database     = database
       @file_system  = file_system
+      @fixture_set  = fixture_set
       @judge        = Judge.new(database)
       @out          = out
       @spoon_client = spoon_client
@@ -44,7 +45,7 @@ module Simmer
 
     private
 
-    attr_reader :database, :file_system, :judge, :out, :spoon_client
+    attr_reader :database, :file_system, :fixture_set, :judge, :out, :spoon_client
 
     def clean_db
       print_waiting('Stage', 'Cleaning database')
@@ -56,7 +57,10 @@ module Simmer
 
     def seed_db(specification)
       print_waiting('Stage', 'Seeding database')
-      count = database.seed!(specification)
+
+      fixtures = specification.stage.fixtures.map { |f| fixture_set.get!(f) }
+      count    = database.seed!(fixtures)
+
       print("#{count} record(s) inserted")
 
       count
@@ -72,7 +76,7 @@ module Simmer
 
     def seed_file_system(specification)
       print_waiting('Stage', 'Seeding File System')
-      count = file_system.write!(specification)
+      count = file_system.write!(specification.stage.files)
       print("#{count} file(s) uploaded")
 
       count

data/lib/simmer/suite/reporter.rb

@@ -39,14 +39,6 @@ module Simmer
         self
       end
 
-      def to_h
-        {
-          'pass' => pass?,
-          'time_in_seconds' => time_in_seconds,
-          'runner_results' => runner_results.map(&:to_h)
-        }
-      end
-
       private
 
       attr_reader :session_result

data/lib/simmer/version.rb

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

data/lib/simmer.rb

@@ -35,7 +35,6 @@ require_relative 'simmer/database'
 require_relative 'simmer/externals'
 require_relative 'simmer/runner'
 require_relative 'simmer/specification'
-require_relative 'simmer/spoon_mock'
 require_relative 'simmer/suite'
 
 # The main entry-point API for the library.
@@ -51,9 +50,8 @@ module Simmer
       simmer_dir: DEFAULT_SIMMER_DIR
     )
       configuration = make_configuration(config_path: config_path, simmer_dir: simmer_dir)
-      fixtures      = make_fixtures(configuration)
       specs         = make_specifications(path, configuration.tests_dir)
-      runner        = make_runner(configuration, out, fixtures)
+      runner        = make_runner(configuration, out)
       suite         = make_suite(configuration, out, runner)
 
       suite.run(specs)
@@ -84,14 +82,16 @@ module Simmer
       end
     end
 
-    def make_runner(configuration, out, fixtures)
-      database     = make_mysql_database(configuration, fixtures)
-      file_system  = make_aws_file_system(configuration)
+    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
       )
@@ -103,22 +103,28 @@ module Simmer
       Database::FixtureSet.new(config)
     end
 
-    def make_mysql_database(configuration, fixtures)
-      config         = (configuration.mysql_database_config || {}).symbolize_keys
+    def make_mysql_database(configuration)
+      config         = configuration.mysql_database_config.symbolize_keys
       client         = Mysql2::Client.new(config)
       exclude_tables = config[:exclude_tables]
 
-      Externals::MysqlDatabase.new(client, exclude_tables, fixtures)
+      Externals::MysqlDatabase.new(client, exclude_tables)
     end
 
-    def make_aws_file_system(configuration)
-      config = (configuration.aws_file_system_config || {}).symbolize_keys
+    def make_file_system(configuration)
+      if configuration.aws_file_system?
+        make_aws_file_system(configuration)
+      elsif configuration.local_file_system?
+        make_local_file_system(configuration)
+      else
+        raise ArgumentError, 'cannot determine file system'
+      end
+    end
 
-      client = Aws::S3::Client.new(
-        access_key_id: config[:access_key_id],
-        secret_access_key: config[:secret_access_key],
-        region: config[:region]
-      )
+    def make_aws_file_system(configuration)
+      config      = configuration.aws_file_system_config.symbolize_keys
+      client_args = config.slice(:access_key_id, :secret_access_key, :region)
+      client      = Aws::S3::Client.new(client_args)
 
       Externals::AwsFileSystem.new(
         client,
@@ -128,25 +134,18 @@ module Simmer
       )
     end
 
-    def make_spoon_client(configuration)
-      config = (configuration.spoon_client_config || {}).symbolize_keys
-
-      spoon =
-        if config[:mock]
-          SpoonMock.new
-        elsif config[:mock_err]
-          SpoonMock.new(false)
-        else
-          Pdi::Spoon.new(dir: config[:dir])
-        end
+    def make_local_file_system(configuration)
+      config = configuration.local_file_system_config.symbolize_keys
 
-      Externals::SpoonClient.new(configuration.files_dir, spoon)
+      Externals::LocalFileSystem.new(config[:dir], configuration.files_dir)
     end
 
-    def make_fixtures(configuration)
-      raw_fixtures = yaml_reader.smash(configuration.fixtures_dir)
+    def make_spoon_client(configuration)
+      config     = (configuration.spoon_client_config || {}).symbolize_keys
+      spoon_args = config.slice(:args, :dir, :kitchen, :pan)
+      spoon      = Pdi::Spoon.new(spoon_args)
 
-      Database::FixtureSet.new(raw_fixtures)
+      Externals::SpoonClient.new(configuration.files_dir, spoon)
     end
 
     def make_suite(configuration, out, runner)

data/simmer.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.homepage    = 'https://github.com/bluemarblepayroll/simmer'
   s.license     = 'MIT'
 
-  s.required_ruby_version = '>= 2.4.6'
+  s.required_ruby_version = '>= 2.5'
 
   s.add_dependency('acts_as_hashable', '~>1')
   s.add_dependency('aws-sdk-s3', '~>1.6')

data/spec/config/simmer.yaml.ci

@@ -5,3 +5,18 @@ mysql_database:
   host: 127.0.0.1
   port: 3306
   flags: MULTI_STATEMENTS
+
+spoon_client:
+  dir: spec/mocks/spoon
+  args: 0
+
+local_file_system:
+  dir: tmp/store_test
+
+# aws_file_system:
+#   access_key_id:
+#   bucket:
+#   default_expires_in_seconds: 3600
+#   encryption: AES256
+#   region:
+#   secret_access_key:

data/spec/fixtures/specifications/load_noc_list.yaml

@@ -27,4 +27,4 @@ assert:
           first: bruce
           last: banner
     - type: output
-      value: Decoding Agents
+      value: output to stdout

data/spec/mocks/aws_s3_client.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.
+#
+
+class AwsS3Client
+  extend Forwardable
+
+  def_delegators :client,
+                 :list_objects,
+                 :delete_objects,
+                 :put_object
+
+  attr_reader :client, :store
+
+  def initialize(store = {})
+    @store  = store
+    @client = make_client
+
+    freeze
+  end
+
+  private
+
+  # rubocop:disable Metrics/AbcSize
+  def make_client
+    Aws::S3::Client.new(stub_responses: true).tap do |client|
+      client.stub_responses(:get_object, lambda { |context|
+        obj = store[context.params[:key]]
+        obj || 'NoSuchKey'
+      })
+
+      client.stub_responses(:put_object, lambda { |context|
+        store[context.params[:key]] = { body: context.params[:body] }
+        {}
+      })
+
+      client.stub_responses(:list_objects, lambda { |_context|
+        contents = store.keys.map { |k| OpenStruct.new(key: k) }
+
+        OpenStruct.new(contents: contents)
+      })
+
+      client.stub_responses(:delete_objects, lambda { |context|
+        keys = context.params.dig(:delete, :objects).map { |k| k[:key] }
+
+        keys.each { |key| store.delete(key) }
+      })
+    end
+  end
+  # rubocop:enable Metrics/AbcSize
+end

data/spec/mocks/load_noc_list/pan.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require './spec/spec_helper'
+require './spec/db_helper'
+
+puts 'output to stdout'
+
+db_helper_client.query("UPDATE agents SET first = 'bruce', last = 'banner' WHERE call_sign = 'hulk'")
+db_helper_client.query("UPDATE agents SET first = 'tony', last = 'stark' WHERE call_sign = 'iron_man'")

data/spec/mocks/load_noc_list_bad_output/pan.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require './spec/spec_helper'
+require './spec/db_helper'
+
+puts 'bad output!'
+
+db_helper_client.query("UPDATE agents SET first = 'bruce', last = 'banner' WHERE call_sign = 'hulk'")
+db_helper_client.query("UPDATE agents SET first = 'tony', last = 'stark' WHERE call_sign = 'iron_man'")

data/spec/mocks/out.rb

@@ -0,0 +1,14 @@
+# 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.
+#
+
+class Out
+  def puts(msg); end
+
+  def print(msg); end
+end

data/spec/mocks/spoon/kitchen.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+error(){
+  echo "$1" >&2
+}
+
+output(){
+  echo "$1"
+}
+
+output "output to stdout"
+error "output to sterr"
+
+exit $1

data/spec/mocks/spoon/pan.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+error(){
+  echo "$1" >&2
+}
+
+output(){
+  echo "$1"
+}
+
+output "output to stdout"
+error "output to sterr"
+
+exit $1

data/spec/simmer/externals/aws_file_system_spec.rb

@@ -8,46 +8,29 @@
 #
 
 require 'spec_helper'
+require 'mocks/aws_s3_client'
 
 describe Simmer::Externals::AwsFileSystem do
-  let(:bucket_store)         { {} }
   let(:bucket_name)          { 'test' }
   let(:encryption)           { 'AES256' }
   let(:files_dir)            { File.join('spec', 'fixtures') }
   let(:specification_path)   { File.join('specifications', 'load_noc_list.yaml') }
   let(:specification_config) { yaml_fixture(specification_path).merge(path: specification_path) }
   let(:specification)        { Simmer::Specification.make(specification_config) }
+  let(:aws_s3_client_stub)   { AwsS3Client.new }
 
-  let(:aws_s3_client_stub) do
-    Aws::S3::Client.new(stub_responses: true).tap do |client|
-      client.stub_responses(:get_object, lambda { |context|
-        obj = bucket_store[context.params[:key]]
-        obj || 'NoSuchKey'
-      })
-
-      client.stub_responses(:put_object, lambda { |context|
-        bucket_store[context.params[:key]] = { body: context.params[:body] }
-        {}
-      })
-
-      client.stub_responses(:list_objects, lambda { |_context|
-        contents = bucket_store.keys.map { |k| OpenStruct.new(key: k) }
-
-        OpenStruct.new(contents: contents)
-      })
-
-      client.stub_responses(:delete_objects, lambda { |context|
-        keys = context.params.dig(:delete, :objects).map { |k| k[:key] }
+  subject { described_class.new(aws_s3_client_stub, bucket_name, encryption, files_dir) }
 
-        keys.each { |key| bucket_store.delete(key) }
-      })
+  describe 'initialization' do
+    it "requires bucket ends in 'test'" do
+      expect do
+        described_class.new(aws_s3_client_stub, 'hehe', encryption, files_dir)
+      end.to raise_error(ArgumentError)
     end
   end
 
-  subject { described_class.new(aws_s3_client_stub, bucket_name, encryption, files_dir) }
-
   specify '#write transfers all files' do
-    subject.write!(specification)
+    subject.write!(specification.stage.files)
 
     expected = {
       'input/noc_list.csv' => {
@@ -55,7 +38,7 @@ describe Simmer::Externals::AwsFileSystem do
       }
     }
 
-    expect(bucket_store).to eq(expected)
+    expect(aws_s3_client_stub.store).to eq(expected)
   end
 
   specify '#clean! deletes all files' do
@@ -70,6 +53,6 @@ describe Simmer::Externals::AwsFileSystem do
 
     expected = {}
 
-    expect(bucket_store).to eq(expected)
+    expect(aws_s3_client_stub.store).to eq(expected)
   end
 end

data/spec/simmer/externals/mysql_database_spec.rb

@@ -18,14 +18,24 @@ describe Simmer::Externals::MysqlDatabase do
   let(:spec_config)    { yaml_fixture(spec_path).merge(path: spec_path) }
   let(:specification)  { Simmer::Specification.make(spec_config) }
 
-  subject { described_class.new(db_helper_client, exclude_tables, fixture_set) }
+  subject { described_class.new(db_helper_client, exclude_tables) }
 
   before(:each) do
     db_helper_clean_schema
   end
 
+  describe 'initialization' do
+    it "requires database ends in 'test'" do
+      expect do
+        described_class.new(OpenStruct.new(query_options: { database: 'hehe' }))
+      end.to raise_error(ArgumentError)
+    end
+  end
+
   specify '#seed! adds records' do
-    subject.seed!(specification)
+    fixtures = specification.stage.fixtures.map { |f| fixture_set.get!(f) }
+
+    subject.seed!(fixtures)
 
     actual = db_helper_client.query('SELECT * FROM agents ORDER BY call_sign').to_a
 

data/spec/simmer/externals/spoon_client_spec.rb

@@ -11,57 +11,37 @@ require 'spec_helper'
 require 'db_helper'
 
 describe Simmer::Externals::SpoonClient do
-  class Mock
-    attr_reader :result
-
-    def initialize(result)
-      @result = result
-    end
-
-    def run(*)
-      raise Pdi::Spoon::KitchenError, OpenStruct.new(code: 1) if result == 'KitchenError'
-      raise Pdi::Spoon::PanError, OpenStruct.new(code: 1)     if result == 'PanError'
-
-      Pdi::Executor::Result.new(result)
-    end
-  end
-
   let(:files_dir)            { File.join('spec', 'fixtures') }
   let(:specification_path)   { File.join('specifications', 'load_noc_list.yaml') }
   let(:specification_config) { yaml_fixture(specification_path).merge(path: specification_path) }
   let(:specification)        { Simmer::Specification.make(specification_config) }
 
+  let(:spoon) do
+    Pdi::Spoon.new(
+      dir: File.join('spec', 'mocks', 'spoon'),
+      args: arg
+    )
+  end
+
   subject { described_class.new(files_dir, spoon) }
 
   context 'when PDI executes successfully' do
-    let(:spoon) do
-      Mock.new(
-        args: [],
-        status: {
-          code: 0,
-          err: 'Some error output from PDI',
-          out: 'Some output from PDI',
-          pid: 123
-        }
-      )
-    end
+    let(:arg) { 0 }
 
-    specify '#run is called with the right arguments' do
-      expected_path = File.expand_path(File.join(files_dir, 'noc_list.csv'))
+    specify '#run returns code 0 from executor' do
+      result = subject.run(specification, simmer_config)
+
+      expect(result.execution_result.code).to eq(0)
+    end
+  end
 
-      args = {
-        repository: 'top_secret',
-        name: 'load_noc_list',
-        params: {
-          'input_file' => expected_path,
-          'code' => 'The secret code is: '
-        },
-        type: 'transformation'
-      }
+  context 'when PDI executes un-successfully' do
+    let(:arg) { 1 }
 
-      expect(spoon).to receive(:run).with(args)
+    specify '#run returns non-zero code from executor' do
+      result = subject.run(specification, simmer_config)
 
-      subject.run(specification, simmer_config)
+      expect(result.execution_result.code).to eq(1)
     end
   end
 end

data/spec/simmer/specification/assert_spec.rb

@@ -21,7 +21,7 @@ describe Simmer::Specification::Assert do
       expect(subject.assertions.length).to                  eq(2)
       expect(subject.assertions.first.name).to              eq('agents')
       expect(subject.assertions.first.record_set.length).to eq(2)
-      expect(subject.assertions.last.value).to              eq('Decoding Agents')
+      expect(subject.assertions.last.value).to              eq('output to stdout')
     end
   end
 end

data/spec/simmer/util/record_set_spec.rb

@@ -17,6 +17,13 @@ describe Simmer::Util::RecordSet do
     }
   end
 
+  let(:string_hash1) do
+    {
+      'a' => 'a',
+      'b' => 'b'
+    }
+  end
+
   let(:hash2) do
     {
       c: 'c',
@@ -24,6 +31,13 @@ describe Simmer::Util::RecordSet do
     }
   end
 
+  let(:string_hash2) do
+    {
+      'c' => 'c',
+      'd' => 'd'
+    }
+  end
+
   subject { described_class.new([hash1, hash2]) }
 
   describe 'equality' do
@@ -38,4 +52,16 @@ describe Simmer::Util::RecordSet do
   specify '#keys includes all record keys' do
     expect(subject.keys).to eq(%w[a b c d])
   end
+
+  specify '#to_h includes record hashes' do
+    expect(subject.to_h).to eq('records' => [string_hash1, string_hash2])
+  end
+
+  describe 'initialization' do
+    specify 'can accept a hash' do
+      subject = described_class.new(hash1)
+
+      expect(subject.records.length).to eq(1)
+    end
+  end
 end

data/spec/simmer_spec/files/noc_list.csv

@@ -0,0 +1,3 @@
+call_sign,first,last
+iron_man,Tony,Stark
+hulk,Bruce,Banner

data/spec/simmer_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/simmer_spec.rb

@@ -0,0 +1,104 @@
+# 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 'spec_helper'
+require './spec/mocks/out'
+
+describe Simmer do
+  def stage_simmer_config(spoon_dir, args)
+    src_config_path  = File.join('spec', 'config', 'simmer.yaml')
+    dest_config_dir  = File.join('tmp')
+    dest_config_path = File.join(dest_config_dir, 'simmer.yaml')
+
+    FileUtils.rm(dest_config_path) if File.exist?(dest_config_path)
+    FileUtils.mkdir_p(dest_config_dir)
+
+    config = yaml_read(src_config_path)
+
+    new_config = config.merge('spoon_client' => {
+                                'dir' => spoon_dir,
+                                'args' => args
+                              })
+
+    IO.write(dest_config_path, new_config.to_yaml)
+
+    dest_config_path
+  end
+
+  context 'when externally mocking pdi and using local file system' do
+    let(:spec_path)   { File.join('spec', 'fixtures', 'specifications', 'load_noc_list.yaml') }
+    let(:simmer_dir)  { File.join('spec', 'simmer_spec') }
+    let(:out)         { Out.new }
+    let(:config_path) { stage_simmer_config(spoon_path, args) }
+
+    context 'when pdi does not do anything but does not fail' do
+      let(:spoon_path)  { File.join('spec', 'mocks', 'spoon') }
+      let(:args)        { 0 }
+
+      specify 'judge determines it does not pass' do
+        results = described_class.run(
+          spec_path,
+          config_path: config_path,
+          out: out,
+          simmer_dir: simmer_dir
+        )
+
+        expect(results.pass?).to be false
+      end
+    end
+
+    context 'when pdi fails' do
+      let(:spoon_path)  { File.join('spec', 'mocks', 'spoon') }
+      let(:args)        { 1 }
+
+      specify 'judge determines it does not pass' do
+        results = described_class.run(
+          spec_path,
+          config_path: config_path,
+          out: out,
+          simmer_dir: simmer_dir
+        )
+
+        expect(results.pass?).to be false
+      end
+    end
+
+    context 'when pdi acts correctly' do
+      let(:spoon_path)  { File.join('spec', 'mocks', 'load_noc_list') }
+      let(:args)        { '' }
+
+      specify 'judge determines it to pass' do
+        results = described_class.run(
+          spec_path,
+          config_path: config_path,
+          out: out,
+          simmer_dir: simmer_dir
+        )
+
+        expect(results.pass?).to be true
+      end
+    end
+
+    context 'when pdi accts correctly but judge fails on output assert' do
+      let(:spoon_path)  { File.join('spec', 'mocks', 'load_noc_list_bad_output') }
+      let(:args)        { '' }
+
+      specify 'judge determines it to pass' do
+        results = described_class.run(
+          spec_path,
+          config_path: config_path,
+          out: out,
+          simmer_dir: simmer_dir
+        )
+
+        expect(results.pass?).to be false
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simmer
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha.5
+  version: 1.0.0.pre.alpha.6
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -223,6 +223,8 @@ files:
 - lib/simmer/database/fixture_set.rb
 - lib/simmer/externals.rb
 - lib/simmer/externals/aws_file_system.rb
+- lib/simmer/externals/file_system.rb
+- lib/simmer/externals/local_file_system.rb
 - lib/simmer/externals/mysql_database.rb
 - lib/simmer/externals/mysql_database/sql_fixture.rb
 - lib/simmer/externals/spoon_client.rb
@@ -242,7 +244,6 @@ files:
 - lib/simmer/specification/assert/assertions/table.rb
 - lib/simmer/specification/stage.rb
 - lib/simmer/specification/stage/input_file.rb
-- lib/simmer/spoon_mock.rb
 - lib/simmer/suite.rb
 - lib/simmer/suite/reporter.rb
 - lib/simmer/suite/result.rb
@@ -265,6 +266,12 @@ files:
 - spec/fixtures/yaml_reader/bar.yaml
 - spec/fixtures/yaml_reader/baz/baz.yaml
 - spec/fixtures/yaml_reader/foo.yaml
+- spec/mocks/aws_s3_client.rb
+- spec/mocks/load_noc_list/pan.sh
+- spec/mocks/load_noc_list_bad_output/pan.sh
+- spec/mocks/out.rb
+- spec/mocks/spoon/kitchen.sh
+- spec/mocks/spoon/pan.sh
 - spec/simmer/configuration_spec.rb
 - spec/simmer/core_ext/hash_spec.rb
 - spec/simmer/database/fixture_set_spec.rb
@@ -281,6 +288,9 @@ files:
 - spec/simmer/util/record_set_spec.rb
 - spec/simmer/util/record_spec.rb
 - spec/simmer/util/yaml_reader_spec.rb
+- spec/simmer_spec.rb
+- spec/simmer_spec/files/noc_list.csv
+- spec/simmer_spec/fixtures/agent_fixtures.yaml
 - spec/spec_helper.rb
 homepage: https://github.com/bluemarblepayroll/simmer
 licenses:
@@ -294,7 +304,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.6
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"
@@ -317,6 +327,12 @@ test_files:
 - spec/fixtures/yaml_reader/bar.yaml
 - spec/fixtures/yaml_reader/baz/baz.yaml
 - spec/fixtures/yaml_reader/foo.yaml
+- spec/mocks/aws_s3_client.rb
+- spec/mocks/load_noc_list/pan.sh
+- spec/mocks/load_noc_list_bad_output/pan.sh
+- spec/mocks/out.rb
+- spec/mocks/spoon/kitchen.sh
+- spec/mocks/spoon/pan.sh
 - spec/simmer/configuration_spec.rb
 - spec/simmer/core_ext/hash_spec.rb
 - spec/simmer/database/fixture_set_spec.rb
@@ -333,4 +349,7 @@ test_files:
 - spec/simmer/util/record_set_spec.rb
 - spec/simmer/util/record_spec.rb
 - spec/simmer/util/yaml_reader_spec.rb
+- spec/simmer_spec.rb
+- spec/simmer_spec/files/noc_list.csv
+- spec/simmer_spec/fixtures/agent_fixtures.yaml
 - spec/spec_helper.rb

data/lib/simmer/spoon_mock.rb

@@ -1,35 +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
-  # 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