zeebe_bpmn_rspec 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21f042c1e3d81e8f0bc9096924685cdd8c436de1a5a68e1cef9857e3f4e87a58
-  data.tar.gz: fe32bf072bc3677667e1ed6ac49c92e2cd48647ad5adfabd546a7a94ea253eef
+  metadata.gz: 7ee557a1aed97212da2a198eafd8238859e12499f32e8ddf24d97d5240c83c36
+  data.tar.gz: 0105ee8a65e00fbab192cf6f76710e43973bec36324b3defcc4f83882db833ca
 SHA512:
-  metadata.gz: 34a5334740649b53d9199e74009fb6e233ac34667b33c8e012f9c30fa168f470626c5d199a83f83032deae764a3408a33b6df3ce620ee427895d0d9bcc60f7c7
-  data.tar.gz: 1688746402718b8d1d38868f8271782af51be446bc3ba4d62b953ca9c049afa1933d4614ce9203294aa46286efaa74a54fd88b377c8df32f09e9c932acea8179
+  metadata.gz: 978a61f885179d519ede6340a283b93f9c36e1d712c1279629500732afe01a9f9ac7483a484c17d99356bcebb0258fb04f65771492a6d2b6774cd9be64454f1b
+  data.tar.gz: 6f235e5995f75fd04b7996708bb8a23d81cbb1b7bf1ecd8ebea46a5fba78fa1e5c60f8ab1e305e263d0e16e7ac2005dad78dfdf5e684528ff3cdf3343a2f9c2e

data/CHANGELOG.md

@@ -1,4 +1,8 @@
 # zeebe_bpmn_rspec
 
+## v0.2.0
+- Add `retries` option to `ActivatedJob#and_fail`.
+- Add method aliases: `and_complete` (`complete`), `and_fail` (`fail`), `and_throw_error` (`throw_error`).
+
 ## v0.1.0
 - Initial version

data/README.md

@@ -118,7 +118,7 @@ activate_job("my_job").
 
 #### Complete Job
 
-Jobs can be completed by calling `and_complete`. Variables can optionally be returned with the
+Jobs can be completed by calling `and_complete` (also aliased as `complete`). Variables can optionally be returned with the
 completed job.
 
 ```ruby
@@ -134,7 +134,7 @@ project_job("my_job").
 
 #### Fail Job
 
-Jobs can be failed by calling `and_fail`. An optional message can be specified when failing a job.
+Jobs can be failed by calling `and_fail` (also aliased as `fail`). An optional message can be specified when failing a job.
 
 ```ruby
 # Failing a job can be chanined with expectations
@@ -147,9 +147,17 @@ activate_job("my_job").
   and_fail("something didn't go right")
 ```
 
+By default retries are set to zero when a job is failed but the remaining retries can optionally be specified:
+
+```ruby
+job = activate_job("my_job")
+
+job.fail(retries: 1)
+```
+
 #### Throw Error
 
-The `and_throw_error` method can be used to throw an error for a job. The error code is required and an
+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
 optional message may be specified:
 
 ```ruby
@@ -165,7 +173,18 @@ activate_job("my_job").
 
 #### Activating Multiple Jobs
 
-TODO
+Multiple jobs can be activated using the `activate_jobs` method.
+
+```ruby
+activate_jobs("my_job")
+```
+
+The call to `activate_jobs` returns an Enumerator that returns `ActivatedJob` instance.
+The maximum number of jobs to return can be specified:
+
+```ruby
+jobs = activate_jobs("my_job", max_jobs: 2).to_a
+```
 
 ### Workflow Complete
 
@@ -198,6 +217,18 @@ publish_message("message_name", correlation_key: expected_value,
                 variables: { foo: "bar" })
 ```
 
+## Tips & Tricks
+
+### Enumerator for Multiple Jobs
+
+When activating multiple jobs, call `to_a` on the result of `activate_jobs` to get
+an array of activated jobs objects.
+
+### Timer Duration
+
+Specify timer durations using a variable so that tests can easily set the variable
+to specify a short duration.
+
 ## Limitations
 
 The current gem and approach have some limitations:

data/docker-compose.yml

@@ -6,7 +6,7 @@ x-environment: &default-environment
   PRYRC: /usr/src/app/.docker-pryrc
   BUNDLE_IGNORE_CONFIG: 1
   BUNDLE_DISABLE_SHARED_GEMS: "true"
-  ZEEBE_ADDRESS: zeebe-bpmn-gateway:26500
+  ZEEBE_ADDRESS: zeebe:26500
 x-service: &default-service
   image: ruby:2.6.6
   volumes:
@@ -18,7 +18,7 @@ x-service: &default-service
   stdin_open: true
 services:
   zeebe:
-    image: camunda/zeebe:0.23.2
+    image: camunda/zeebe:0.23.4
     environment:
       ZEEBE_LOG_LEVEL: debug
     volumes:
@@ -28,8 +28,8 @@ services:
   monitor:
     image: camunda/zeebe-simple-monitor:0.19.0
     environment:
-      - zeebe.client.broker.contactPoint=zeebe-bpmn-gateway:26500
-      - zeebe.client.worker.hazelcast.connection=zeebe-bpmn-gateway:5701
+      - zeebe.client.broker.contactPoint=zeebe:26500
+      - zeebe.client.worker.hazelcast.connection=zeebe:5701
     ports:
       - "8082:8082"
     depends_on:

data/lib/zeebe_bpmn_rspec/activated_job.rb

@@ -66,16 +66,18 @@ module ZeebeBpmnRspec
                            }.compact
                          ))
     end
+    alias throw_error and_throw_error
 
-    def and_fail(message = nil)
+    def and_fail(message = nil, retries: nil)
       client.fail_job(FailJobRequest.new(
                         {
                           jobKey: job.key,
-                          retries: 0,
+                          retries: retries || 0,
                           errorMessage: message,
                         }.compact
                       ))
     end
+    alias fail and_fail
 
     def and_complete(variables = {})
       client.complete_job(CompleteJobRequest.new(
@@ -83,6 +85,7 @@ module ZeebeBpmnRspec
                             variables: variables.to_json
                           ))
     end
+    alias complete and_complete
 
     private
 

data/lib/zeebe_bpmn_rspec/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zeebe_bpmn_rspec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-21 00:00:00.000000000 Z
+date: 2020-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -174,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.0.3
 signing_key:
 specification_version: 4
 summary: Zeebe BPMN testing using RSpec