zeebe_bpmn_rspec 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c61752ebec049d8c944c74517f9f36aa57eb89054ca2c16c3dd3e22eeaf83cc
-  data.tar.gz: 29ef97e9a0901e5b70225425d51df1a4ea27cf15eb75acfdee70c86147c61867
+  metadata.gz: 9326bc3b39da887700ba4f953b851cb31bdfcf5c69f66072e32dd8186a230e3e
+  data.tar.gz: abf9685a1f5d66fc1704afe29e2664e75ced661f959245689a9bbf9f35925ea4
 SHA512:
-  metadata.gz: 38918b2d17281f6cbb36d2263ec6c706ae77ce2b749eb30d9f095613f9f14af61921a9175b76f141019f1f57321b2f33ea794df344aa32062c3d562d73d04051
-  data.tar.gz: 97180846225b71825b2506d4da6c76e8aa991bdc290adb0e456784fcbe9ab41589a421e55a37d4195f4d235e9cd0ab0ce9a2050e883421840d3d6634c4cfaa4a
+  metadata.gz: a63baf2863a6ad3eda3a253c6ca5ae113bf25d082763686aacfcde3b57ece0d73970780a752712b73bd80fab51bc96f41a3ff04cb679c962d29d0cee3b0b4c83
+  data.tar.gz: a0f1a2178661ae07958c6c1c3d0b9374a9c790ae3f58ffae418a145eb20b326656c754861c1e57302fc9d662bcd6a60192304cf8feb1f73b64d79611dae37dc3

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # zeebe_bpmn_rspec
 
+## v0.4.0
+- Add `ttl_ms` option for `publish_message`.
+- Add `update_retries` method to `ActivatedJob` class.
+- Add `set_variables` helper.
+- Add support for `:fetch_variables` option when activating jobs.
+
 ## v0.3.1
 - Use consistent activate request timeout.
 - Provide a better error when a job is not activated.

data/README.md

@@ -157,6 +157,16 @@ job = activate_job("my_job")
 job.fail(retries: 1)
 ```
 
+#### Update Retries
+
+The retries for a job can also be modified using the `update_retries` method:
+
+```ruby
+job = activate_job("my_job")
+
+job.update_retries(3)
+```
+
 #### Throw Error
 
 The `and_throw_error` (also aliased as `throw_error`) method can be used to throw an error for a job. The error code is required and an
@@ -219,6 +229,37 @@ publish_message("message_name", correlation_key: expected_value,
                 variables: { foo: "bar" })
 ```
 
+The time-to-live (in milliseconds) cna also be specified for a message.
+It defaults to 5000 milliseconds if unspecified.
+
+```ruby
+publish_message("message_name", correlation_key: expected_value, ttl_ms: 1000)
+```
+
+### Set Variables
+
+The `set_variables` method can be used to set variables for a specified
+scope in Zeebe:
+
+```ruby
+# workflow_instance_key is a method that returns the key for the current workflow instance
+set_variables(workflow_instance_key, { foo: "bar" })
+```
+
+An activated job can be used to determine the key for the task that it is associated with:
+
+```ruby
+job = job_with_type("my_type")
+set_variables(job.task_key, { foo: "baz"})
+```
+
+Variables default to being local to the scope on which they are set. This
+can be overridden by specifying the `:local` option:
+
+```ruby
+set_variables(job.task_key, { foo: "baz"}, local: false)
+```
+
 ### Custom Matchers
 
 In addition to the helpers documented above, this gem defines custom RSpec matchers to provide a more typical

data/lib/zeebe_bpmn_rspec/activated_job.rb

@@ -36,6 +36,14 @@ module ZeebeBpmnRspec
       job.key
     end
 
+    def retries
+      job.retries
+    end
+
+    def task_key
+      job.elementInstanceKey
+    end
+
     def to_s
       raw.to_s
     end
@@ -98,6 +106,13 @@ module ZeebeBpmnRspec
     end
     alias complete and_complete
 
+    def update_retries(retries = 1)
+      client.update_job_retries(UpdateJobRetriesRequest.new(
+                                  jobKey: job.key,
+                                  retries: retries
+                                ))
+    end
+
     private
 
     attr_reader :client, :context

data/lib/zeebe_bpmn_rspec/helpers.rb

@@ -64,14 +64,15 @@ module ZeebeBpmnRspec
       @__workflow_instance_key
     end
 
-    def activate_job(type, validate: true)
-      stream = _zeebe_client.activate_jobs(ActivateJobsRequest.new(
-                                             type: type,
-                                             worker: "#{type}-#{SecureRandom.hex}",
-                                             maxJobsToActivate: 1,
-                                             timeout: 1000,
-                                             requestTimeout: ZeebeBpmnRspec.activate_request_timeout
-                                           ))
+    def activate_job(type, fetch_variables: nil, validate: true)
+      stream = _zeebe_client.activate_jobs(ActivateJobsRequest.new({
+        type: type,
+        worker: "#{type}-#{SecureRandom.hex}",
+        maxJobsToActivate: 1,
+        timeout: 1000,
+        fetchVariable: fetch_variables&.then { |v| Array(v) },
+        requestTimeout: ZeebeBpmnRspec.activate_request_timeout,
+      }.compact))
 
       job = nil
       stream.find { |response| job = response.jobs.first }
@@ -87,20 +88,21 @@ module ZeebeBpmnRspec
     alias process_job activate_job
     # TODO: deprecate process_job
 
-    def job_with_type(type)
-      activate_job(type, validate: false)
+    def job_with_type(type, fetch_variables: nil)
+      activate_job(type, fetch_variables: fetch_variables, validate: false)
     end
 
-    def expect_job_of_type(type)
-      expect(job_with_type(type))
+    def expect_job_of_type(type, fetch_variables: nil)
+      expect(job_with_type(type, fetch_variables: fetch_variables))
     end
 
-    def activate_jobs(type, max_jobs: nil)
+    def activate_jobs(type, max_jobs: nil, fetch_variables: nil)
       stream = _zeebe_client.activate_jobs(ActivateJobsRequest.new({
         type: type,
         worker: "#{type}-#{SecureRandom.hex}",
         maxJobsToActivate: max_jobs,
         timeout: 1000,
+        fetchVariable: fetch_variables&.then { |v| Array(v) },
         requestTimeout: ZeebeBpmnRspec.activate_request_timeout,
       }.compact))
 
@@ -118,17 +120,25 @@ module ZeebeBpmnRspec
       end
     end
 
-    def publish_message(name, correlation_key:, variables: nil)
+    def publish_message(name, correlation_key:, variables: nil, ttl_ms: 5000)
       _zeebe_client.publish_message(PublishMessageRequest.new(
                                       {
                                         name: name,
                                         correlationKey: correlation_key,
-                                        timeToLive: 5000,
+                                        timeToLive: ttl_ms,
                                         variables: variables&.to_json,
                                       }.compact
                                     ))
     end
 
+    def set_variables(key, variables, local: true)
+      _zeebe_client.set_variables(SetVariablesRequest.new(
+                                    elementInstanceKey: key,
+                                    variables: variables.to_json,
+                                    local: local
+                                  ))
+    end
+
     def reset_zeebe!
       @__workflow_instance_key = nil
     end

data/lib/zeebe_bpmn_rspec/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ZeebeBpmnRspec
-  VERSION = "0.3.1"
+  VERSION = "0.4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zeebe_bpmn_rspec
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-25 00:00:00.000000000 Z
+date: 2020-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler