statelint 0.1.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6bee89be701a12fd45bd3d6b0de5b505aad1c602
-  data.tar.gz: 6b6f4208af22128dd92b36c9a81b7def5146e111
+SHA256:
+  metadata.gz: 0f7cf7b9cd3f0f19021f4bb2fb8657b1f282f5dd014914b0ecee706a1f89abdd
+  data.tar.gz: 11cd1013ed9799022e84986f740d53cc04ebb64dd26555f7131922fb8c862f4d
 SHA512:
-  metadata.gz: eb442240dd8d5a919fecc74eed803bda47052b4ddad5ad7b1a9a0d6de092dd9625d809a0124801fe09a28d26df95437d1abbe5b344d10ddaa1a485f5de56f400
-  data.tar.gz: d7bf9684350829a5dae1e5b732bb6268fda45f4921f3626309b3d1cb5ff4342e7b5c27be7dc024a52701065eac9e6cb0ac2bd63c833270738c2df79adfd019ec
+  metadata.gz: cae59e2cd4ac26483138e8f1ae50c74cb09f93f5bb76dab010db0748ae0bde3d86e19679e081ba8d3ae8a2193d9428f755b1882a928d45550ea66201e793978a
+  data.tar.gz: b325d6cafdbc3ce69ebcfca460a2d8c8eaad5bef6f5fcaad36b90cf49ec79f5381e02d9280ccd4b982b3451c4bf9a639472abeb87c30127cc43a5d38f661e1fe

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,29 +12,36 @@ 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, a Wait 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, and a Parallel State MAY have a nullable-referencePath field named "ResultPath".
-A State MAY have a nullable-JSONPath field named "OutputPath".
+A State MAY have a field named "InputPath".
+Each of a Pass State, a Task State, a Parallel State, and a Map State MAY have a nullable-referencePath field named "ResultPath".
+Each of a Task State, a Parallel State, and a Map State MAY have a field named "ResultSelector".
+A State MAY have a 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.
+A Task State MAY have a referencePath field named "TimeoutSecondsPath".
+A Task State MAY have a referencePath field named "HeartbeatSecondsPath".
+A Task State MAY have only one of "TimeoutSeconds" and "TimeoutSecondsPath".
+A Task State MAY have only one of "HeartbeatSeconds" and "HeartbeatSecondsPath".
 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".
@@ -49,9 +56,9 @@ A Choice Rule MUST have a string field named "Next".
 A Choice Rule with an "And" field is a "Boolean".
 A Choice Rule with an "Or" field is a "Boolean".
 A Choice Rule with a "Not" field is a "Boolean".
-A Choice Rule MAY have a referencePath field named "Variable".
+A Choice Rule MAY have a field named "Variable".
 A Choice Rule with a "Variable" field is a "Comparison".
-A Comparison MUST have a field named one of "StringEquals", "StringLessThan", "StringGreaterThan", "StringLessThanEquals", "StringGreaterThanEquals", "NumericEquals", "NumericLessThan", "NumericGreaterThan", "NumericLessThanEquals", "NumericGreaterThanEquals", "BooleanEquals", "TimestampEquals", "TimestampLessThan", "TimestampGreaterThan", "TimestampLessThanEquals", or "TimestampGreaterThanEquals".
+A Comparison MUST have a field named one of "StringEquals", "StringLessThan", "StringGreaterThan", "StringLessThanEquals", "StringGreaterThanEquals", "NumericEquals", "NumericLessThan", "NumericGreaterThan", "NumericLessThanEquals", "NumericGreaterThanEquals", "BooleanEquals", "TimestampEquals", "TimestampLessThan", "TimestampGreaterThan", "TimestampLessThanEquals", "TimestampGreaterThanEquals", "StringEqualsPath", "StringLessThanPath", "StringGreaterThanPath", "StringLessThanEqualsPath", "StringGreaterThanEqualsPath", "NumericEqualsPath", "NumericLessThanPath", "NumericGreaterThanPath", "NumericLessThanEqualsPath", "NumericGreaterThanEqualsPath", "BooleanEqualsPath", "TimestampEqualsPath", "TimestampLessThanPath", "TimestampGreaterThanPath", "TimestampLessThanEqualsPath", "TimestampGreaterThanEqualsPath", "IsNull", "IsPresent", "IsNumeric", "IsString", "IsBoolean", "IsTimestamp", or "StringMatches".
 A Comparison MAY have a string field named "StringEquals".
 A Comparison MAY have a string field named "StringLessThan".
 A Comparison MAY have a string field named "StringGreaterThan".
@@ -68,6 +75,29 @@ A Comparison MAY have a timestamp field named "TimestampLessThan".
 A Comparison MAY have a timestamp field named "TimestampGreaterThan".
 A Comparison MAY have a timestamp field named "TimestampLessThanEquals".
 A Comparison MAY have a timestamp field named "TimestampGreaterThanEquals".
+A Comparison MAY have a boolean field named "IsNull".
+A Comparison MAY have a boolean field named "IsPresent".
+A Comparison MAY have a boolean field named "IsNumeric".
+A Comparison MAY have a boolean field named "IsString".
+A Comparison MAY have a boolean field named "IsBoolean".
+A Comparison MAY have a boolean field named "IsTimestamp".
+A Comparison MAY have a string field named "StringMatches".
+A Comparison MAY have a referencePath field named "StringEqualsPath".
+A Comparison MAY have a referencePath field named "StringLessThanPath".
+A Comparison MAY have a referencePath field named "StringGreaterThanPath".
+A Comparison MAY have a referencePath field named "StringLessThanEqualsPath".
+A Comparison MAY have a referencePath field named "StringGreaterThanEqualsPath".
+A Comparison MAY have a referencePath field named "NumericEqualsPath".
+A Comparison MAY have a referencePath field named "NumericLessThanPath".
+A Comparison MAY have a referencePath field named "NumericGreaterThanPath".
+A Comparison MAY have a referencePath field named "NumericLessThanEqualsPath".
+A Comparison MAY have a referencePath field named "NumericGreaterThanEqualsPath".
+A Comparison MAY have a referencePath field named "BooleanEqualsPath".
+A Comparison MAY have a referencePath field named "TimestampEqualsPath".
+A Comparison MAY have a referencePath field named "TimestampLessThanPath".
+A Comparison MAY have a referencePath field named "TimestampGreaterThanPath".
+A Comparison MAY have a referencePath field named "TimestampLessThanEqualsPath".
+A Comparison MAY have a referencePath field named "TimestampGreaterThanEqualsPath".
 A Comparison MUST NOT have a field named "And".
 A Comparison MUST NOT have a field named "Or".
 A Comparison MUST NOT have a field named "Not".
@@ -78,7 +108,7 @@ A Nested Rule with an "And" field is a "Nested Boolean".
 A Nested Rule with an "Or" field is a "Nested Boolean".
 A Nested Rule with a "Not" field is a "Nested Boolean".
 A Nested Rule MUST NOT have a field named "Next".
-A Nested Rule MAY have a referencePath field named "Variable".
+A Nested Rule MAY have a field named "Variable".
 A Nested Rule with a "Variable" field is a "Nested Comparison".
 A Nested Comparison MAY have a string field named "StringEquals".
 A Nested Comparison MAY have a string field named "StringLessThan".
@@ -96,6 +126,29 @@ A Nested Comparison MAY have a timestamp field named "TimestampLessThan".
 A Nested Comparison MAY have a timestamp field named "TimestampGreaterThan".
 A Nested Comparison MAY have a timestamp field named "TimestampLessThanEquals".
 A Nested Comparison MAY have a timestamp field named "TimestampGreaterThanEquals".
+A Nested Comparison MAY have a boolean field named "IsNull".
+A Nested Comparison MAY have a boolean field named "IsPresent".
+A Nested Comparison MAY have a boolean field named "IsNumeric".
+A Nested Comparison MAY have a boolean field named "IsString".
+A Nested Comparison MAY have a boolean field named "IsBoolean".
+A Nested Comparison MAY have a boolean field named "IsTimestamp".
+A Nested Comparison MAY have a string field named "StringMatches".
+A Nested Comparison MAY have a referencePath field named "StringEqualsPath".
+A Nested Comparison MAY have a referencePath field named "StringLessThanPath".
+A Nested Comparison MAY have a referencePath field named "StringGreaterThanPath".
+A Nested Comparison MAY have a referencePath field named "StringLessThanEqualsPath".
+A Nested Comparison MAY have a referencePath field named "StringGreaterThanEqualsPath".
+A Nested Comparison MAY have a referencePath field named "NumericEqualsPath".
+A Nested Comparison MAY have a referencePath field named "NumericLessThanPath".
+A Nested Comparison MAY have a referencePath field named "NumericGreaterThanPath".
+A Nested Comparison MAY have a referencePath field named "NumericLessThanEqualsPath".
+A Nested Comparison MAY have a referencePath field named "NumericGreaterThanEqualsPath".
+A Nested Comparison MAY have a referencePath field named "BooleanEqualsPath".
+A Nested Comparison MAY have a referencePath field named "TimestampEqualsPath".
+A Nested Comparison MAY have a referencePath field named "TimestampLessThanPath".
+A Nested Comparison MAY have a referencePath field named "TimestampGreaterThanPath".
+A Nested Comparison MAY have a referencePath field named "TimestampLessThanEqualsPath".
+A Nested Comparison MAY have a referencePath field named "TimestampGreaterThanEqualsPath".
 A Nested Comparison MUST NOT have a field named "And".
 A Nested Comparison MUST NOT have a field named "Or".
 A Nested Comparison MUST NOT have a field named "Not".
@@ -106,6 +159,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 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
@@ -30,6 +32,10 @@ module StateMachineLint
       # We keep track of all the state names and complain about
       #  dupes
       @all_state_names = {}
+      @payload_builder_fields = ["Parameters", "ResultSelector"]
+      @context_object_access_fields = [{"field"=> "InputPath", "nullable"=> true}, {"field"=> "OutputPath", "nullable"=> true}, {"field"=>  "ItemsPath", "nullable"=> false}]
+      @choice_state_nested_operators = ["And", "Or", "Not"]
+      @intrinsic_invocation_regex = /^States\.(JsonToString|Format|StringToJson|Array)\(.+\)$/
     end
 
     def check(node, path, problems)
@@ -52,7 +58,22 @@ 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_path = path + '.' + name
+            probe_context_object_access(child, child_path, problems)
+            @payload_builder_fields.each do |field_name|
+              if child.key?(field_name)
+                probe_payload_builder(child[field_name], child_path, problems, field_name)
+              end
+            end  
+            if child.key?("Type") && child["Type"] == "Choice" && child.key?("Choices")
+              probe_choice_state(child["Choices"], child_path + '.Choices' , problems)
+            end
+          end
+
           if @all_state_names[name]
             problems <<
               "State \"#{name}\", defined at #{path}.States, " +
@@ -66,7 +87,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 +134,75 @@ module StateMachineLint
       end
     end
 
+    def probe_context_object_access(node, path, problems)
+      @context_object_access_fields.each do |field|
+        field_name = field["field"]
+        nullable = field["nullable"]
+        if node.key?(field_name)
+          if !nullable && node[field_name].nil?
+            problems << "Field \"#{field_name}\" defined at \"#{path}\" should be non-null"
+            return
+          end
+          if !node[field_name].nil? and !is_valid_parameters_path?(node[field_name])
+            problems << "Field \"#{field_name}\" defined at \"#{path}\" is not a JSONPath"
+          end
+        end
+      end
+    end
+
+    def probe_choice_state(node, path, problems)
+      if node.is_a?(Hash)
+        if node.key?("Variable") && !is_valid_parameters_path?(node["Variable"])
+          problems << "Field \"Variable\" of Choice state at \"#{path}\" is not a JSONPath"
+        end
+        @choice_state_nested_operators.each do |operator|
+          if node.key?(operator)
+            probe_choice_state(node[operator], path + '.' + operator, problems)
+          end
+        end 
+      elsif node.is_a?(Array)
+        node.size.times {|i| probe_choice_state(node[i], "#{path}[#{i}]", problems) }
+      end
+    end
+
+    # Search through Parameters for object nodes and check field semantics
+    def probe_payload_builder(node, path, problems, field_name)
+      if node.is_a?(Hash)
+        node.each do |name, val|
+          if name.end_with? '.$'
+            if !is_intrinsic_invocation?(val) && !is_valid_parameters_path?(val)
+              problems << "Field \"#{name}\" of #{field_name} at \"#{path}\" is not a JSONPath or intrinsic function expression"
+            end
+          else
+            probe_payload_builder(val, "#{path}.#{name}", problems, field_name)
+          end
+        end
+      elsif node.is_a?(Array)
+        node.size.times {|i| probe_payload_builder(node[i], "#{path}[#{i}]", problems, field_name) }
+      end
+    end
+
+    def is_intrinsic_invocation?(val)
+      if val.is_a?(String) && val.match?(@intrinsic_invocation_regex)
+        return true
+      end
+      return false
+    end
+
+    # Check if a string that ends with ".$" is a valid path
+    def is_valid_parameters_path?(val)
+      if !val.is_a?(String)
+        return false
+      end
+      # 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 +221,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.4'
-  s.date        = '2016-09-28'
+  s.version     = '0.5.0'
   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.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Tim Bray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-28 00:00:00.000000000 Z
+date: 2020-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: j2119
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        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:
@@ -42,10 +48,12 @@ 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:
@@ -54,7 +62,7 @@ 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:
   - - ">="
@@ -62,7 +70,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       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