statelint 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3084f3b4eea83b19e2d4bf60acf70ecf6e8bd151c1f86007203bfd8139c7c6d
-  data.tar.gz: e3f789d73ddde2eaa63f215598e907df32058bea101a608d68f6a66801e8703c
+  metadata.gz: 0f7cf7b9cd3f0f19021f4bb2fb8657b1f282f5dd014914b0ecee706a1f89abdd
+  data.tar.gz: 11cd1013ed9799022e84986f740d53cc04ebb64dd26555f7131922fb8c862f4d
 SHA512:
-  metadata.gz: b59e83552e82a3e5333d79d99bfd8d19f4e416ab14ed7b1677f78ad48624d98d9384f048836b57f78ecb4480230816f9019218c1e2e46ef104d9e331140da024
-  data.tar.gz: 81173298fa0eb6dc22d02dbcf957dca86343f1b6713b5b2e3cef9809eb5a377de4e727189a4ef1ca1d32eddf3e416bf9f51de8d95ea3c073254265f718442ac1
+  metadata.gz: cae59e2cd4ac26483138e8f1ae50c74cb09f93f5bb76dab010db0748ae0bde3d86e19679e081ba8d3ae8a2193d9428f755b1882a928d45550ea66201e793978a
+  data.tar.gz: b325d6cafdbc3ce69ebcfca460a2d8c8eaad5bef6f5fcaad36b90cf49ec79f5381e02d9280ccd4b982b3451c4bf9a639472abeb87c30127cc43a5d38f661e1fe

data/data/StateMachine.j2119

@@ -20,9 +20,10 @@ 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".
+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".
-A State MAY have a nullable-JSONPath field named "OutputPath".
+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".
@@ -32,6 +33,10 @@ Each of a Task State, a Parallel State, and a Map State MAY have an object-array
 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.
@@ -51,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".
@@ -70,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".
@@ -80,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".
@@ -98,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".
@@ -109,7 +160,7 @@ A Wait State MUST have only one of "Seconds", "SecondsPath", "Timestamp", and "T
 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 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 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".

data/lib/statelint/state_node.rb

@@ -32,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)
@@ -57,8 +61,17 @@ module StateMachineLint
         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)
+          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]
@@ -121,25 +134,66 @@ 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_parameters(node, path, problems)
+    def probe_payload_builder(node, path, problems, field_name)
       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"
+            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_parameters(val, "#{path}.#{name}", problems)
+            probe_payload_builder(val, "#{path}.#{name}", problems, field_name)
           end
         end
       elsif node.is_a?(Array)
-        node.size.times {|i| probe_parameters(node[i], "#{path}[#{i}]", problems) }
+        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(/^\$/, "")

data/statelint.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name        = 'statelint'
-  s.version     = '0.4.1'
+  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"]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statelint
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Tim Bray
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2020-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: j2119