simmer 1.0.0.pre.alpha.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d2c8a97f020d8075b14da8b15908e5bc256e8bb946fc36dba254cad4cfec95d
-  data.tar.gz: e3868ab99540e0dfcf11c6e76fd785d94535ed96bd7b14bd1e831db5fe896bf6
+  metadata.gz: 7988189a0fd02e4ec9231a3ddb8e8e7e27682cdc2ae3625bc1d0bd6ddc6d1379
+  data.tar.gz: f5fcd321056010f74a87ad4d76337920616c6564c9d74eb7c6bbd4acdd6a0e67
 SHA512:
-  metadata.gz: 76596e1d548b7fe09d4e8ef7baf102bdb41cee3cf60d745efc7cb938e5492a6d39212cdc32de376d62f68aa86d08861f1e8d093ad947d83c0ff37629c9286bed
-  data.tar.gz: '00980ec71fb9a07f693848736564dadfa9100949b14e65a5e514427c3bf8cb7c7bcb05ce9234a25f981b181294a4b7a303e2bf92056b6459e9fb0823883b54e1'
+  metadata.gz: 3122824cd6ed5c9480f148cb86e8cc9403aa6b54013424ca50cfd69bd881577b83c1b79acd4b710664ab033f1ee83211b517c2df43f23d29299ac9d5f01ce885
+  data.tar.gz: 369bccc61afbb3d4246d9b9baa49915372e3276a9bbe5ae530108046d9912ef5dffa5f1f416f7cf0d0f00781e7bb175b0aeedc6ec541a276e418bad51e2cf95f

data/README.md

@@ -76,15 +76,23 @@ spoon_client:
 #   secret_access_key:
 ````
 
+Note: You can configure any options for `mysql_database` listed in the [mysql2 gem configuration options](https://github.com/brianmario/mysql2#connection-options).
+
 Fill out the missing configuration values required for each section.  If you would like to use your local file system then un-comment the `local_file_system` key.  If you would like to use AWS S3 then un-comment out the `aws_file_system` key.
 
+Note: There is a naming-convention-based protection to help ensure non-test database and file systems do not get accidentally wiped that you must follow:
+
+1. Database names must end in `_test'
+2. local file system dir must end in `-test`
+3. AWS file system bucket must end in `-test`
+
 ### Simmer Directory
 
 You will also need to create the following folder structure in your project's root folder:
 
 * **simmer/files**: Place any files necessary to stage in this directory.
-* **simmer/fixtures**: Place yaml files, that describe database records, necessary to stage the database.
-* **simmer/specs**: Place specification yaml files here.
+* **simmer/fixtures**: Place YAML files, that describe database records, necessary to stage the database.
+* **simmer/specs**: Place specification YAML files here.
 
 It does not matter how each of these directories are internally structured, they can contain folder structure in any arbitrary way.  These directories should be version controlled as they contain the necessary information to execute your tests.  But you may want to ignore the `simmer/results` directory as that will store the results after execution.
 
@@ -158,9 +166,14 @@ Each file entry specifies two things:
 
 ###### Fixtures
 
-Each fixture entry contains the name of a fixture specified in one of the yaml files within fixture directory.
+Fixtures will populate the database specified in the `mysql_database` section of `simmer.yaml`.  In order to do this you need to:
 
-Fixtures live in yaml files within the `simmer/fixtures` directory.  They can be placed in any arbitrary file, the only restriction is their top-level keys that uniquely identify a fixture.  Here is an example of a fixture file:
+1. Add the fixture to a YAML file in the `simmer/fixtures` directory.
+2. Add the name of the fixture you wish to use in the `stage/fixtures` section as illustrated above
+
+**Adding Fixtures**
+
+Fixtures live in YAML files within the `simmer/fixtures` directory.  They can be placed in any arbitrary file, the only restriction is their top-level keys that uniquely identify a fixture.  Here is an example of a fixture file:
 
 ````yaml
 hulk:
@@ -178,7 +191,7 @@ iron_man:
     last: CLASSIFIED
 ````
 
-This example specifies two fixtures: `hulk` and `iron_man`.  Each will end up creating a record in the `agents` table with their respective attributes (columns.)
+This example specifies two fixtures: `hulk` and `iron_man`.  Each will end up creating a record in the `agents` table with their respective attributes (columns).
 
 ##### Act Section
 
@@ -224,7 +237,9 @@ This contains two table and one output assertion.  It explicitly states that:
 
 * The table `agents` should exactly contain two records with the column values as described (iron_man and hulk)
 * The table `agents` should include a record where the last name is `stark`
-* The output should contain the string described in the value somewhere in the log
+* The standard output should contain the string described in the value somewhere in the log
+
+**Note**: Output does not currently test the standard error, just the standard output.
 
 ###### Table Assertion Rules
 

data/lib/simmer/externals/file_system.rb

@@ -11,7 +11,7 @@ module Simmer
   module Externals
     # Provides the shared basics of all file systems.
     class FileSystem
-      SUFFIX = 'test'
+      SUFFIX = '-test'
 
       private_constant :SUFFIX
 

data/lib/simmer/externals/mysql_database.rb

@@ -7,13 +7,13 @@
 # LICENSE file in the root directory of this source tree.
 #
 
-require_relative 'mysql_database/sql_fixture'
+require_relative 'sql_writers/sql_fixture'
 
 module Simmer
   module Externals
     # Provides a wrapper around mysql2 for Simmer.
     class MysqlDatabase
-      DATABASE_SUFFIX = 'test'
+      DATABASE_SUFFIX = '_test'
 
       def initialize(client, exclude_tables = [])
         @client = client
@@ -57,7 +57,7 @@ module Simmer
       end
 
       def seed_sql_statements(fixtures)
-        fixtures.map { |fixture| SqlFixture.new(client, fixture).to_sql }
+        fixtures.map { |fixture| SqlWriters::SqlFixture.new(client, fixture).to_sql }
       end
 
       def clean_sql_statements

data/lib/simmer/externals/{mysql_database → sql_writers}/sql_fixture.rb

@@ -9,7 +9,7 @@
 
 module Simmer
   module Externals
-    class MysqlDatabase
+    module SqlWriters
       # This class knows how to turn a fixture into sql.
       class SqlFixture
         extend Forwardable
@@ -28,10 +28,10 @@ module Simmer
         end
 
         def to_sql
-          sql_columns = fields.keys.join(',')
+          sql_columns = fields.keys.map { |k| "`#{k}`" }.join(',')
           sql_values  = fields.values.map { |v| "'#{client.escape(v.to_s)}'" }.join(',')
 
-          "INSERT INTO #{table} (#{sql_columns}) VALUES (#{sql_values})"
+          "INSERT INTO `#{table}` (#{sql_columns}) VALUES (#{sql_values})"
         end
 
         private

data/lib/simmer/judge.rb

@@ -26,11 +26,7 @@ module Simmer
     def assert(specification, output)
       assertions = specification.assert.assertions
 
-      bad_assertions = assertions.each_with_object([]) do |assertion, memo|
-        bad_assert = assertion.assert(database, output)
-
-        memo << bad_assert if bad_assert
-      end
+      bad_assertions = assertions.map { |assertion| assertion.assert(database, output) }.compact
 
       Result.new(bad_assertions)
     end

data/lib/simmer/runner.rb

@@ -37,7 +37,7 @@ module Simmer
       judge_result        = assert(specification, spoon_client_result)
 
       Result.new(id, judge_result, specification, spoon_client_result).tap do |result|
-        msg = result.pass? ? 'PASS' : 'FAIL'
+        msg = pass_message(result)
         print_waiting('Done', 'Final verdict')
         print(msg)
       end
@@ -85,7 +85,7 @@ module Simmer
     def execute_spoon(specification, config)
       print_waiting('Act', 'Executing Spoon')
       spoon_client_result = spoon_client.run(specification, config)
-      msg = spoon_client_result.pass? ? 'Pass' : 'Fail'
+      msg = pass_message(spoon_client_result)
       print(msg)
 
       spoon_client_result
@@ -101,7 +101,7 @@ module Simmer
 
       output       = spoon_client_result.execution_result.out
       judge_result = judge.assert(specification, output)
-      msg          = judge_result.pass? ? 'Pass' : 'Fail'
+      msg          = pass_message(judge_result)
 
       print(msg)
 
@@ -125,5 +125,9 @@ module Simmer
 
       "#{msg}#{char * missing}"
     end
+
+    def pass_message(obj)
+      obj.pass? ? 'Pass' : 'Fail'
+    end
   end
 end

data/lib/simmer/suite.rb

@@ -13,6 +13,8 @@ require_relative 'suite/result'
 module Simmer
   # Runs a collection of specifications and then writes down the results to disk.
   class Suite
+    LINE_LENGTH = 80
+
     def initialize(
       config:,
       out:,
@@ -73,7 +75,7 @@ module Simmer
     end
 
     def print_line
-      out.puts('-' * 60)
+      out.puts('-' * LINE_LENGTH)
     end
   end
 end

data/lib/simmer/util/yaml_reader.rb

@@ -30,7 +30,7 @@ module Simmer
         path     = File.expand_path(path)
         contents = File.read(path)
 
-        YAML.safe_load(contents)
+        YAML.safe_load(contents, [], [], true)
       end
 
       def wildcard_name

data/lib/simmer/version.rb

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

data/lib/simmer.rb

@@ -39,7 +39,7 @@ require_relative 'simmer/suite'
 
 # The main entry-point API for the library.
 module Simmer
-  DEFAULT_CONFIG_PATH = File.join('config', 'simmer.yaml')
+  DEFAULT_CONFIG_PATH = File.join('config', 'simmer.yaml').freeze
   DEFAULT_SIMMER_DIR  = 'simmer'
 
   class << self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simmer
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre.alpha.8
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthew Ruggio
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-10 00:00:00.000000000 Z
+date: 2020-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: acts_as_hashable
@@ -226,9 +226,9 @@ files:
 - 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
 - lib/simmer/externals/spoon_client/result.rb
+- lib/simmer/externals/sql_writers/sql_fixture.rb
 - lib/simmer/judge.rb
 - lib/simmer/judge/result.rb
 - lib/simmer/runner.rb
@@ -275,9 +275,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: