simmer 2.0.0.pre.alpha.1 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81ea16fc455aa4484da9ddde45699539a50a9d26fc38f8dd73e7a596bd9358f9
-  data.tar.gz: cddf6abdb4a6369c490d60ae9313a62c52d2253bf3f1a04be63ac85f784c1739
+  metadata.gz: fcaddd54b4d50b90701d91f9a62fdfd163a249565d88c850386caf22135a0af3
+  data.tar.gz: 143b6629e67a14e365d6e16a0d795b607f1f4f29aadc270be6458e715a7b68b3
 SHA512:
-  metadata.gz: ae83fea49a7f342e3032d0f8e7ba01d10e29269a94c0c045e36cbada63f6fa5c168ead31d3aa6a0bcb58c75dbfd8e02ba6a5c4362f2ec5bd96252fe2d203bf26
-  data.tar.gz: a678ead18314a24df043ea56f9c90de8093daf1ef56c2006efb5ed2c52eda056fa0d612c2a84a8a94f32d9434dfdd01b35ea4e908509c364e716728d5c2c6d8c
+  metadata.gz: 6645db0960863e2490964b56228969bd3b4a061cc8ad61b069a239dee8920d2861bdbeb125b758861426079529b3c7faed1bb645c67bb3ebbbbeb7a5a9fc11bf
+  data.tar.gz: 257ab72c85cca10bc54a6e23d451b3da17bd056c8d0a2b96a5b493c0f58a2d38f98bd7e6a4fcd14bafe190a8cafecfabf70a713be37777b86befef88e34e7220

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,5 +1,48 @@
-# 2.0.0 (May 11th, 2020)
+# Simmer Change Log
+
+## 4.0.0 (TBD, 2020)
+
+Additions:
+
+* Support for custom test lifecycle hooks to be run before and after a every test or the entire suite.
+* Simmer can now be configured to re-run tests which have failed due to a timeout a custom number of times.
+
+Breaking Changes:
+
+* The `callback_configuration` and `make_runner` methods have been removed from the `Simmer` module.
+* `Simmer::Runner::Result#errors` now contains error/exception instances instead of strings.
+* `Simmer::Suite.new` and `Simmer::Runner.run` now takes a `Simmer::Configuration` instance instead of a hash of configuration values.
+* The config keyword parameter of `Simmer::Runner.run` is now mandatory.
+
+## 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

@@ -53,6 +53,9 @@ The configuration file contains information about external systems, such as:
 Copy this configuration template into your project's root to: `config/simmer.yaml`:
 
 ````yaml
+# Automatically retry a test when it has failed this many times due to a timeout error:
+timeout_failure_retry_count: 0
+
 mysql_database:
   database:
   username:
@@ -270,6 +273,34 @@ You can also omit the path altogether to execute all specs:
 bundle exec simmer
 ````
 
+## Custom Configuration
+
+It is possible to define custom test lifecycle hooks. These are very similar to [Rspec](https://relishapp.com/rspec/rspec-core/v/3-9/docs/hooks/before-and-after-hooks). Here is an example of how to ensure that code called before and after the entire suite:
+
+````ruby
+Simmer.configure do |config|
+  config.before(:suite) { puts 'about to run the entire suite' }
+  config.after(:suite) do |result|
+    result_msg = result.passed? ? 'passed' : 'failed'
+    puts "The suite #{result_msg}."
+  end
+end
+````
+
+Not that after callbacks taken an optional parameter which is the result object.
+
+It is also possible to specify custom code which runs before and after each individual specification.
+
+````ruby
+Simmer.configure do |config|
+  config.before(:each) { puts 'I will run before each test' }
+  config.after(:each) do |result|
+    result_msg = result.passed? ? 'passed' : 'failed'
+    puts "The specification #{result_msg}."
+  end
+end
+````
+
 ## Contributing
 
 ### Development Environment Configuration
@@ -281,6 +312,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

@@ -22,7 +22,7 @@ require 'set'
 require 'stringento'
 require 'yaml'
 
-# Monkey-patching core libaries
+# Monkey-patching core libraries
 require_relative 'simmer/core_ext/hash'
 Hash.include Simmer::CoreExt::Hash
 
@@ -30,10 +30,12 @@ Hash.include Simmer::CoreExt::Hash
 require_relative 'simmer/util'
 
 # Core code
+require_relative 'simmer/bootstrap'
 require_relative 'simmer/configuration'
 require_relative 'simmer/database'
 require_relative 'simmer/externals'
 require_relative 'simmer/runner'
+require_relative 'simmer/re_runner'
 require_relative 'simmer/specification'
 require_relative 'simmer/suite'
 
@@ -49,112 +51,28 @@ module Simmer
       out: $stdout,
       simmer_dir: DEFAULT_SIMMER_DIR
     )
-      configuration = make_configuration(config_path: config_path, simmer_dir: simmer_dir)
-      specs         = make_specifications(path, configuration.tests_dir)
-      runner        = make_runner(configuration, out)
-      suite         = make_suite(configuration, out, runner)
-
-      suite.run(specs)
+      Bootstrap.new(
+        spec_path: path,
+        config_path: config_path,
+        simmer_dir: simmer_dir,
+        callback_configuration: callback_configuration,
+        console_out: out
+      ).run_suite
     end
 
-    def make_configuration(
-      config_path: DEFAULT_CONFIG_PATH,
-      simmer_dir: DEFAULT_SIMMER_DIR
-    )
-      raw_config = yaml_reader.smash(config_path)
-
-      Configuration.new(raw_config, simmer_dir)
+    def configuration(config_path: DEFAULT_CONFIG_PATH, simmer_dir: DEFAULT_SIMMER_DIR)
+      Bootstrap.new(config_path: config_path, simmer_dir: simmer_dir).configuration
     end
+    alias make_configuration 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
-      )
+    def configure
+      yield callback_configuration
     end
 
     private
 
-    def yaml_reader
-      Util::YamlReader.new
-    end
-
-    def make_specifications(path, tests_dir)
-      path = path.to_s.empty? ? tests_dir : path
-
-      Util::YamlReader.new.read(path).map do |file|
-        config = (file.data || {}).merge(path: file.path)
-
-        Specification.make(config)
-      end
-    end
-
-    def make_fixture_set(configuration)
-      config = Util::YamlReader.new.smash(configuration.fixtures_dir)
-
-      Database::FixtureSet.new(config)
-    end
-
-    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)
-    end
-
-    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
-
-    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,
-        config[:bucket],
-        config[:encryption],
-        configuration.files_dir
-      )
-    end
-
-    def make_local_file_system(configuration)
-      config = configuration.local_file_system_config.symbolize_keys
-
-      Externals::LocalFileSystem.new(config[:dir], configuration.files_dir)
-    end
-
-    def make_spoon_client(configuration)
-      config     = (configuration.spoon_client_config || {}).symbolize_keys
-      spoon_args = config.slice(:args, :dir, :kitchen, :pan, :timeout_in_seconds)
-      spoon      = Pdi::Spoon.new(spoon_args)
-
-      Externals::SpoonClient.new(configuration.files_dir, spoon)
-    end
-
-    def make_suite(configuration, out, runner)
-      Suite.new(
-        config: configuration.config,
-        out: out,
-        results_dir: configuration.results_dir,
-        runner: runner
-      )
+    def callback_configuration
+      @callback_configuration ||= Configuration::CallbackDsl.new
     end
   end
 end

data/lib/simmer/bootstrap.rb

@@ -0,0 +1,133 @@
+# 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
+  # :nodoc:
+  # Responsible for creating core objects needed to run tests.
+  class Bootstrap
+    attr_reader :callback_configuration, :configuration, :console_out, :spec_path
+
+    def initialize(
+      config_path:,
+      simmer_dir:,
+      spec_path: nil,
+      console_out: $stdout,
+      callback_configuration: Configuration::CallbackDsl.new
+    )
+      @spec_path = spec_path.to_s
+      raw_config = yaml_reader.smash(config_path)
+      @configuration = Configuration.new(raw_config, simmer_dir, callbacks: callback_configuration)
+      @console_out = console_out
+      @callback_configuration = callback_configuration
+
+      freeze
+    end
+
+    def run_suite
+      suite.run(specs)
+    end
+
+    private
+
+    def specs
+      path = spec_path.empty? ? configuration.tests_dir : spec_path
+
+      Util::YamlReader.new.read(path).map do |file|
+        config = (file.data || {}).merge(path: file.path)
+
+        Specification.make(config)
+      end
+    end
+
+    def suite
+      Suite.new(
+        config: configuration,
+        out: console_out,
+        results_dir: configuration.results_dir,
+        runner: runner
+      )
+    end
+
+    def runner
+      runner = Runner.new(
+        database: mysql_database,
+        file_system: file_system,
+        fixture_set: fixture_set,
+        out: output_router,
+        spoon_client: spoon_client
+      )
+
+      ReRunner.new(
+        runner,
+        output_router,
+        timeout_failure_retry_count: configuration.timeout_failure_retry_count
+      )
+    end
+
+    def yaml_reader
+      Util::YamlReader.new
+    end
+
+    def fixture_set
+      config = Util::YamlReader.new.smash(configuration.fixtures_dir)
+
+      Database::FixtureSet.new(config)
+    end
+
+    def mysql_database
+      config         = configuration.mysql_database_config.symbolize_keys
+      client         = Mysql2::Client.new(config)
+      exclude_tables = config[:exclude_tables]
+
+      Externals::MysqlDatabase.new(client, exclude_tables)
+    end
+
+    def file_system
+      if configuration.aws_file_system?
+        aws_file_system
+      elsif configuration.local_file_system?
+        local_file_system
+      else
+        raise ArgumentError, 'cannot determine file system'
+      end
+    end
+
+    def aws_file_system
+      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,
+        config[:bucket],
+        config[:encryption],
+        configuration.files_dir
+      )
+    end
+
+    def local_file_system
+      config = configuration.local_file_system_config.symbolize_keys
+
+      Externals::LocalFileSystem.new(config[:dir], configuration.files_dir)
+    end
+
+    def spoon_client
+      config     = (configuration.spoon_client_config || {}).symbolize_keys
+      spoon_args = config.slice(:args, :dir, :kitchen, :pan, :timeout_in_seconds)
+      spoon      = Pdi::Spoon.new(spoon_args)
+
+      Externals::SpoonClient.new(configuration.files_dir, spoon)
+    end
+
+    def output_router
+      pdi_out = Suite::PdiOutputWriter.new(configuration.results_dir)
+      Simmer::Suite::OutputRouter.new(console_out, pdi_out)
+    end
+  end
+end

data/lib/simmer/configuration.rb

@@ -7,14 +7,19 @@
 # LICENSE file in the root directory of this source tree.
 #
 
+require_relative 'configuration/callback_dsl'
+
 module Simmer
   # Reads in the Simmer configuration file and options and provides it to the rest of the
   # Simmer implementation.
   class Configuration
+    extend Forwardable
+
     # Configuration Keys
     AWS_FILE_SYSTEM_KEY   = :aws_file_system
     LOCAL_FILE_SYSTEM_KEY = :local_file_system
     MYSQL_DATABASE_KEY    = :mysql_database
+    TIMEOUT_RETRY_KEY     = :timeout_failure_retry_count
     SPOON_CLIENT_KEY      = :spoon_client
 
     # Paths
@@ -32,10 +37,14 @@ module Simmer
 
     attr_reader :config
 
-    def initialize(config, simmer_dir, resolver: Objectable.resolver)
+    # :nodoc:
+    def_delegators :callbacks, :run_single_test_with_callbacks, :run_suite_with_callbacks
+
+    def initialize(config, simmer_dir, resolver: Objectable.resolver, callbacks: nil)
       @config      = config || {}
       @resolver    = resolver
       @simmer_dir  = simmer_dir
+      @callbacks   = callbacks
 
       freeze
     end
@@ -60,6 +69,10 @@ module Simmer
       config.key?(LOCAL_FILE_SYSTEM_KEY.to_s)
     end
 
+    def timeout_failure_retry_count
+      get(TIMEOUT_RETRY_KEY) || 0
+    end
+
     def spoon_client_config
       get(SPOON_CLIENT_KEY) || {}
     end
@@ -82,7 +95,8 @@ module Simmer
 
     private
 
-    attr_reader :resolver,
+    attr_reader :callbacks,
+                :resolver,
                 :simmer_dir,
                 :yaml_reader