statelint 0.1.3 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 4099489f3b2acf5a9f4c1099e2a7b98db15897ec
-  data.tar.gz: 195be4d2090aa0d5b2f5f12c397057f4668bb386
+SHA256:
+  metadata.gz: c3084f3b4eea83b19e2d4bf60acf70ecf6e8bd151c1f86007203bfd8139c7c6d
+  data.tar.gz: e3f789d73ddde2eaa63f215598e907df32058bea101a608d68f6a66801e8703c
 SHA512:
-  metadata.gz: 90aebfd032fb4f03703324989a4dfe14e79ecd6314aa97e9206204ec7977bd546a3e314e0ee2fec61148dfda4293f92dea39e9e2d95c5f58e5fbf8dcefe62568
-  data.tar.gz: 58706c46430bd39cd68bb31eeb389dd11683138cb0421cb1bd140661171c680252751de6ab95f1c4f156d600c34a87dd205ad9499b4fe6df66c9fba70e56ca2c
+  metadata.gz: b59e83552e82a3e5333d79d99bfd8d19f4e416ab14ed7b1677f78ad48624d98d9384f048836b57f78ecb4480230816f9019218c1e2e46ef104d9e331140da024
+  data.tar.gz: 81173298fa0eb6dc22d02dbcf957dca86343f1b6713b5b2e3cef9809eb5a377de4e727189a4ef1ca1d32eddf3e416bf9f51de8d95ea3c073254265f718442ac1

data/Gemfile

@@ -1,3 +1,5 @@
 source "https://rubygems.org"
 
-gem 'j2119', '>=0.1.0'
+gem 'j2119', '>=0.4.0'
+gem 'rake', '>=12.3.2'
+gem 'rspec', '>=3.8.0'

data/data/StateMachine.j2119

@@ -4,7 +4,7 @@ A State Machine MUST have a string field named "StartAt".
 A State Machine MAY have a string field named "Comment".
 A State Machine MAY have a string field named "Version".
 A State Machine MAY have a positive-integer field named "TimeoutSeconds" whose value MUST be less than 99999999.
-A State MUST have a string field named "Type" whose value MUST be one of "Pass", "Succeed", "Fail", "Task", "Choice", "Wait", or "Parallel".
+A State MUST have a string field named "Type" whose value MUST be one of "Pass", "Succeed", "Fail", "Task", "Choice", "Wait", "Parallel", or "Map".
 A State whose "Type" field's value is "Pass" is a "Pass State".
 A State whose "Type" field's value is "Succeed" is a "Succeed State".
 A State whose "Type" field's value is "Fail" is a "Fail State".
@@ -12,21 +12,23 @@ A State whose "Type" field's value is "Task" is a "Task State".
 A State whose "Type" field's value is "Choice" is a "Choice State".
 A State whose "Type" field's value is "Wait" is a "Wait State".
 A State whose "Type" field's value is "Parallel" is a "Parallel State".
+A State whose "Type" field's value is "Map" is a "Map State".
 A State MAY have a string field named "Comment".
-Each of a Pass State, a Task State, and a Parallel State MAY have a boolean field named "End".
+Each of a Pass State, a Task State, a Wait State, a Parallel State, and a Map State MAY have a boolean field named "End".
+Each of a Pass State, a Task State, a Parallel State, and a Map State MAY have a field named "Parameters".
 A State whose "End" field's value is true is a "Terminal State".
 Each of a Succeed State and a Fail State is a "Terminal State".
 A State which is not a Terminal State or a Choice State MUST have a string field named "Next".
 A Terminal State MUST NOT have a field named "Next".
 A State MAY have a nullable-JSONPath field named "InputPath".
-Each of a Pass State, a Task State, a Wait State, and a Parallel State MAY have a nullable-referencePath field named "ResultPath".
+Each of a Pass State, a Task State, a Parallel State, and a Map State MAY have a nullable-referencePath field named "ResultPath".
 A State MAY have a nullable-JSONPath field named "OutputPath".
 A Pass State MAY have a field named "Result".
 A Fail State MUST NOT have a field named "InputPath".
 A Fail State MUST NOT have a field named "OutputPath".
 A Fail State MAY have a string field named "Cause".
 A Fail State MAY have a string field named "Error".
-Each of a Task State and a Parallel State MAY have an object-array field named "Retry"; each element is a "Retrier".
+Each of a Task State, a Parallel State, and a Map State MAY have an object-array field named "Retry"; each element is a "Retrier".
 A Task State MUST have a URI field named "Resource".
 A Task State MAY have a positive-integer field named "TimeoutSeconds" whose value MUST be less than 99999999.
 A Task State MAY have a positive-integer field named "HeartbeatSeconds" whose value MUST be less than 99999999.
@@ -34,7 +36,7 @@ A Retrier MUST have a nonempty-string-array field named "ErrorEquals".
 A Retrier MAY have an positive-integer field named "IntervalSeconds".
 A Retrier MAY have a nonnegative-integer field named "MaxAttempts" whose value MUST be less than 99999999.
 A Retrier MAY have a float field named "BackoffRate" whose value MUST be greater than or equal to 1.0.
-Each of a Task State and a Parallel State MAY have an object-array field named "Catch"; each element is a "Catcher".
+Each of a Task State, a Parallel State, and a Map State MAY have an object-array field named "Catch"; each element is a "Catcher".
 A Catcher MUST have an nonempty-string-array field named "ErrorEquals".
 A Catcher MUST have a string field named "Next".
 A Catcher MAY have a nullable-referencePath field named "ResultPath".
@@ -106,6 +108,9 @@ A Wait State MAY have a referencePath field named "TimestampPath".
 A Wait State MUST have only one of "Seconds", "SecondsPath", "Timestamp", and "TimestampPath".
 A Wait State MUST have a field named one of "Seconds", "SecondsPath", "Timestamp", or "TimestampPath".
 A Parallel State MUST have an object-array field named "Branches"; each element is a "Branch".
-A Branch MUST have an object field named "States"; each element is a "State".
+A Map State MUST have an object field named "Iterator"; its value is a "Branch".
+A Map State MAY have a referencePath field named "ItemsPath".
+A Map State MAY have a numeric field named "MaxConcurrency".
+A Branch MUST have an object field named "States"; each field is a "State".
 A Branch MUST have a string field named "StartAt".
 A Branch MAY have a string field named "Comment".

data/lib/statelint.rb

@@ -12,7 +12,6 @@
 # permissions and limitations under the License.
 #!/usr/bin/env ruby
 
-$:.unshift("#{File.expand_path(File.dirname(__FILE__))}/../lib")
 require 'j2119'
 require 'statelint/state_node'
 

data/lib/statelint/state_node.rb

@@ -12,6 +12,8 @@
 # permissions and limitations under the License.
 #!/usr/bin/env ruby
 
+require 'j2119'
+
 module StateMachineLint
 
   # Semantic validation that can't be expressed in a J2119 schema
@@ -19,7 +21,7 @@ module StateMachineLint
   class StateNode
 
     def initialize
-      # We push States nodes on here when we traverse them.  
+      # We push States nodes on here when we traverse them.
       #  Then, whenever we find a "Next" or "Default" or "StartAt" node,
       #  we validate that the target is there, and record that that
       #  target has an incoming pointer
@@ -52,7 +54,13 @@ module StateMachineLint
           @current_states_incoming << []
         end
 
-        node['States'].keys.each do |name|
+        states = node['States']
+        states.keys.each do |name|
+          child = states[name]
+          if child.is_a?(Hash) && child.key?('Parameters')
+            probe_parameters(child, path + '.' + name, problems)
+          end
+
           if @all_state_names[name]
             problems <<
               "State \"#{name}\", defined at #{path}.States, " +
@@ -66,7 +74,7 @@ module StateMachineLint
       check_for_terminal(node, path, problems)
 
       check_next(node, path, problems)
-        
+
       check_States_ALL(node['Retry'], path + '.Retry', problems)
       check_States_ALL(node['Catch'], path + '.Catch', problems)
 
@@ -113,6 +121,34 @@ module StateMachineLint
       end
     end
 
+    # Search through Parameters for object nodes and check field semantics
+    def probe_parameters(node, path, problems)
+      if node.is_a?(Hash)
+        node.each do |name, val|
+          if name.end_with? '.$'
+            if (!val.is_a?(String)) || (!is_valid_parameters_path?(val))
+              problems << "Field \"#{name}\" of Parameters at \"#{path}\" is not a JSONPath"
+            end
+          else
+            probe_parameters(val, "#{path}.#{name}", problems)
+          end
+        end
+      elsif node.is_a?(Array)
+        node.size.times {|i| probe_parameters(node[i], "#{path}[#{i}]", problems) }
+      end
+    end
+
+    # Check if a string that ends with ".$" is a valid path
+    def is_valid_parameters_path?(val)
+      # If the value begins with “$$”, the first dollar character is stripped off and the remainder MUST be a Path.
+      if val.start_with?("$$")
+        path_to_check = val.gsub(/^\$/, "")
+        J2119::JSONPathChecker.is_path?(path_to_check)
+      else
+        J2119::JSONPathChecker.is_path?(val)
+      end
+    end
+
     def check_for_terminal(node, path, problems)
       if node['States'] && node['States'].is_a?(Hash)
         terminal_found = false
@@ -131,12 +167,12 @@ module StateMachineLint
         end
       end
     end
-    
+
     def check_States_ALL(node, path, problems)
       if !node.is_a?(Array)
         return
       end
-      
+
       i = 0
       node.each do |element|
         if element.is_a?(Hash)

data/statelint.gemspec

@@ -1,7 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'statelint'
-  s.version     = '0.1.3'
-  s.date        = '2016-09-28'
+  s.version     = '0.4.1'
   s.summary     = "State Machine JSON validator"
   s.description = "Validates a JSON object representing a State Machine"
   s.authors     = ["Tim Bray"]
@@ -11,7 +10,15 @@ Gem::Specification.new do |s|
     f.match(%r{^(spec|test)/})
   end
 
-  s.homepage    = 'http://rubygems.org/gems/statelint'
-  s.license     = 'Apache 2.0'
-  s.add_runtime_dependency "j2119"
+  s.homepage    = 'https://github.com/awslabs/statelint'
+  s.license     = 'Apache-2.0'
+
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.add_runtime_dependency 'j2119', '~> 0.4', '>= 0.4.0'
+
+  s.metadata = {
+    'source_code_uri' => 'https://github.com/awslabs/statelint',
+    "bug_tracker_uri"   => 'https://github.com/awslabs/statelint/issues'
+  }
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: statelint
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.4.1
 platform: ruby
 authors:
 - Tim Bray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-28 00:00:00.000000000 Z
+date: 2020-06-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: j2119
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.0
 description: Validates a JSON object representing a State Machine
 email: timbray@amazon.com
 executables:
@@ -31,7 +37,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE
 - NOTICE.txt
@@ -42,27 +48,29 @@ files:
 - lib/statelint.rb
 - lib/statelint/state_node.rb
 - statelint.gemspec
-homepage: http://rubygems.org/gems/statelint
+homepage: https://github.com/awslabs/statelint
 licenses:
-- Apache 2.0
-metadata: {}
+- Apache-2.0
+metadata:
+  source_code_uri: https://github.com/awslabs/statelint
+  bug_tracker_uri: https://github.com/awslabs/statelint/issues
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: State Machine JSON validator