simmer 1.0.0.pre.alpha

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

@@ -0,0 +1,34 @@
+# 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 Specification
+    class Assert
+      class Assertions
+        # Describes when the output does not meet expectations.
+        class BadOutputAssertion
+          attr_reader :expected_value
+
+          def initialize(expected_value)
+            @expected_value = expected_value
+
+            freeze
+          end
+
+          def to_h
+            {
+              'type' => 'output',
+              'expected_value' => expected_value
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# 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 Specification
+    class Assert
+      class Assertions
+        # Describes when a database table does not meet expectations.
+        class BadTableAssertion
+          attr_reader :name, :expected_record_set, :actual_record_set
+
+          def initialize(name, expected_record_set, actual_record_set)
+            @name                = name
+            @expected_record_set = expected_record_set
+            @actual_record_set   = actual_record_set
+
+            freeze
+          end
+
+          def to_h
+            {
+              'type' => 'table',
+              'name' => name,
+              'expected_record_set' => expected_record_set.to_h,
+              'actual_record_set' => actual_record_set.to_h
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# 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 'bad_output_assertion'
+
+module Simmer
+  class Specification
+    class Assert
+      class Assertions
+        # Describes an expected state of the output (log).
+        class Output
+          acts_as_hashable
+
+          attr_reader :value
+
+          def initialize(value:)
+            @value = value.to_s
+
+            freeze
+          end
+
+          def assert(_database, output)
+            return nil if output.to_s.include?(value)
+
+            BadOutputAssertion.new(value)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# 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 'bad_table_assertion'
+
+module Simmer
+  class Specification
+    class Assert
+      class Assertions
+        # Describes an expected state of a database table.
+        class Table
+          acts_as_hashable
+
+          attr_reader :name, :record_set
+
+          def initialize(name:, records: [])
+            @name       = name.to_s
+            @record_set = Util::RecordSet.new(records)
+
+            freeze
+          end
+
+          def assert(database, _output)
+            actual_records      = database.records(name, keys)
+            actual_record_set   = Util::RecordSet.new(actual_records)
+
+            return nil if actual_record_set == record_set
+
+            BadTableAssertion.new(name, record_set, actual_record_set)
+          end
+
+          private
+
+          def keys
+            record_set.keys
+          end
+        end
+      end
+    end
+  end
+end

data/lib/simmer/specification/stage.rb

@@ -0,0 +1,28 @@
+# 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 'stage/input_file'
+
+module Simmer
+  class Specification
+    # Describes the state necessary to exist before Spoon can be executed successfully.
+    class Stage
+      acts_as_hashable
+
+      attr_reader :files, :fixtures
+
+      def initialize(files: [], fixtures: [])
+        @files    = InputFile.array(files)
+        @fixtures = Array(fixtures).map(&:to_s)
+
+        freeze
+      end
+    end
+  end
+end

data/lib/simmer/specification/stage/input_file.rb

@@ -0,0 +1,33 @@
+# 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 Specification
+    class Stage
+      # Describes a file needing to be staged for a specification to execute properly.
+      # It understands where the file exists in the local repository and where to transfer it
+      # to.
+      class InputFile
+        acts_as_hashable
+
+        attr_reader :dest, :src
+
+        def initialize(dest:, src:)
+          raise ArgumentError, 'dest is required'  if dest.to_s.empty?
+          raise ArgumentError, 'src is required'   if src.to_s.empty?
+
+          @dest = dest.to_s
+          @src  = src.to_s
+
+          freeze
+        end
+      end
+    end
+  end
+end

data/lib/simmer/suite.rb

@@ -0,0 +1,73 @@
+# 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 'configuration'
+require_relative 'externals'
+require_relative 'runner'
+require_relative 'session'
+require_relative 'specification'
+
+# Entrypoint to the library
+module Simmer
+  # The main object entrypoint that brings the entire codebase together.
+  class Suite
+    attr_reader :configuration, :session
+
+    def initialize(out:, config_path:, results_dir:, spec_dir:)
+      @configuration = Configuration.new(
+        config_path: config_path,
+        results_dir: results_dir,
+        spec_dir: spec_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
+      )
+
+      freeze
+    end
+
+    def run(path)
+      session.run(specifications(path))
+    end
+
+    private
+
+    def specifications(path)
+      path = path.to_s.empty? ? configuration.tests_dir : path
+
+      Util::YamlReader.new.all(path).map do |file, config|
+        config = (config || {}).merge(path: file)
+        Specification.make(config)
+      end
+    end
+
+    def database
+      Externals::MysqlDatabase.new(configuration.database_config, configuration.fixture_set)
+    end
+
+    def file_system
+      Externals::AwsFileSystem.new(configuration.file_system_config, configuration.files_dir)
+    end
+
+    def spoon_client
+      Externals::SpoonClient.new(configuration.spoon_client_config, configuration.files_dir)
+    end
+  end
+end

data/lib/simmer/util.rb

@@ -0,0 +1,13 @@
+# 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 'util/evaluator'
+require_relative 'util/fixture_set'
+require_relative 'util/record_set'
+require_relative 'util/yaml_reader'

data/lib/simmer/util/evaluator.rb

@@ -0,0 +1,32 @@
+# 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
+    # Text template renderer.  It knows how to take a string and object as an input and
+    # output a compiled string.
+    class Evaluator
+      def initialize
+        @resolver = Objectable.resolver
+
+        freeze
+      end
+
+      def evaluate(string, input = {})
+        Stringento.evaluate(string, input, resolver: Resolver.new)
+      end
+
+      private
+
+      attr_reader :resolver
+    end
+  end
+end

data/lib/simmer/util/fixture.rb

@@ -0,0 +1,32 @@
+# 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 Util
+    # A fixture is a database record that can be inserted in the Stage phase of a specification
+    # execution.
+    class Fixture
+      acts_as_hashable
+
+      attr_reader :fields,
+                  :name,
+                  :table
+
+      def initialize(fields: {}, name:, table:)
+        @fields = fields || {}
+        @name   = name.to_s
+        @table  = table.to_s
+      end
+
+      def to_s
+        "#{name} (#{table}) #{fields}"
+      end
+    end
+  end
+end

data/lib/simmer/util/fixture_set.rb

@@ -0,0 +1,41 @@
+# 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 'fixture'
+
+module Simmer
+  module Util
+    # Hydrate a collection of Fixture instances from configuration.
+    class FixtureSet
+      def initialize(config = {})
+        @fixtures_by_name = config.each_with_object({}) do |(name, fixture_config), memo|
+          memo[name.to_s] = Fixture.make((fixture_config || {}).merge('name' => name))
+        end
+
+        freeze
+      end
+
+      def get!(name)
+        key = name.to_s
+
+        raise ArgumentError, "fixture not found: #{name}" unless fixtures_by_name.key?(key)
+
+        fixtures_by_name[key]
+      end
+
+      def all
+        fixtures_by_name.values
+      end
+
+      private
+
+      attr_reader :fixtures_by_name
+    end
+  end
+end

data/lib/simmer/util/record.rb

@@ -0,0 +1,54 @@
+# 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 Util
+    # A less strict comparable hash data structure.  It does not depend on key type, value type,
+    # and key ordering.
+    class Record
+      extend Forwardable
+
+      attr_reader :data
+
+      def_delegators :data, :to_h
+
+      def initialize(data = {})
+        @data = sorted_string_hash(data)
+      end
+
+      def <=>(other)
+        data <=> other.data
+      end
+
+      def ==(other)
+        other.instance_of?(self.class) && data == other.data
+      end
+      alias eql? ==
+
+      def keys
+        data.map(&:first)
+      end
+
+      private
+
+      def sorted_string_hash(hash)
+        (hash || {}).map do |k, v|
+          key   = k.to_s
+          value = convert(v)
+
+          [key, value]
+        end.sort
+      end
+
+      def convert(value)
+        value.is_a?(BigDecimal) ? value.to_s('F') : value.to_s
+      end
+    end
+  end
+end