zeebe_bpmn_rspec 0.5.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28a2727e47b273a44521d2f74ecf03c97ee84c22ccd9c2d16cd70eb97e2a2b3f
-  data.tar.gz: '065783a4f62345e2fa7b7a121d090153bdbf67e3b683c2156c40e74238e862b6'
+  metadata.gz: dbc8b0a3a6bf05f4ef29f2a5285b452afa1e733f2e166a521ba28e48dc2f94d1
+  data.tar.gz: 5ef538eea22fce15ba4356ea06204891b69ec51170706cc804d005f1639107f6
 SHA512:
-  metadata.gz: 50711d2a17a5141d4734e5bcc40d10c73b7a43e369561ad74cbdb60de3d6631f804f175f777aed911a369d5aeaf4be619772d330d7c54ab26b8b24bc1d033f24
-  data.tar.gz: f81b79f8603d00b9c8714a85dd6d927e3e13c4b14d8f204e5dd0eeb172a4c04952e90f8d7419d20a788647125c9e362bb3ed81cd116cd6320414c2ebc2436503
+  metadata.gz: 89756e04128e43c7386cc13f785dc3146568b76a7ed5b841c9ec71851f243f043c5d91e1709dd6a44ec41dc05f6e8c2c2414e20fb4227eb3a896b1ee12efad5f
+  data.tar.gz: 3e2f49b5e1ad94878f83ac4b6efb69028a77728e3f53b8f46b2fa134cc6ea63b19f7f3c9e88717ab9942cc0daf97d103ebdfdb12492e937c5f59361b1ec069dd

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # zeebe_bpmn_rspec
 
-## v0.5.0
+## v1.0.0
+- Support Zeebe 1.0.0. Method names now use `process` instead of `workflow`
+  to match the renaming in Zeebe. Previous methods are deprecated and will be
+  removed in a future release.
+
+## v0.5.0 (unreleased)
 - Require Ruby 2.6 or later.
 - Require `worker` to be specified when activating a job. This argument is
   defaulted but can no longer be specified as blank.

data/README.md

@@ -41,24 +41,24 @@ The gem adds the following helper methods to RSpec.
 
 The gem also defines [Custom Matchers](#custom-matchers).
 
-### Deploy Workflow
+### Deploy Process
 
-The `deploy_workflow` method requires a path to a BPMN file and deploys it to Zeebe. There is no support for
+The `deploy_process` (previously `deploy_workflow`) method requires a path to a BPMN file and deploys it to Zeebe. There is no support for
 removing a BPMN file once deployed, so this can be done once before the examples that use it.
 
 ```ruby
-before(:all) { deploy_workflow(filepath) }
+before(:all) { deploy_process(filepath) }
 ```
 
-A custom name can also be specified for the workflow:
+A custom name can also be specified for the process:
 
 ```ruby
-before(:all) { deploy_workflow(filepath, "custom_name") }
+before(:all) { deploy_process(filepath, "custom_name") }
 ```
 
-### With Workflow Instance
+### With Process Instance
 
-The `with_workflow_instance` method is used to create an instance for the specified workflow
+The `with_process_instance` (previously `with_workflow_instance`) method is used to create an instance for the specified process
 and then yields a block that can interact with the instance.
 
 This method ensures that an active instance is cancelled at the end of the block.
@@ -67,14 +67,14 @@ For testing BPMN files it is expected that most of the test definition will be w
 call to this method.
 
 ```ruby
-with_workflow_instance("file_basename") do
+with_process_instance("file_basename") do
   ...
 end
 ```
 
 ### Processing Jobs
 
-A single job can be processed for a workflow by calling `activate_job` (previously `process_job`).
+A single job can be processed for a process by calling `activate_job` (previously `process_job`).
 `activate_job` is called with a job type:
 
 ```ruby
@@ -129,8 +129,8 @@ activate_job("my_job").
   expect_input(user_id: 123).
   and_complete
 
-# Jobs can be completed with data that is merged with variables in the workflow
-project_job("my_job").
+# Jobs can be completed with data that is merged with variables in the process
+activate_job("my_job").
   and_complete(status: "ACTIVATED")
 ```
 
@@ -198,17 +198,17 @@ The maximum number of jobs to return can be specified:
 jobs = activate_jobs("my_job", max_jobs: 2).to_a
 ```
 
-### Workflow Complete
+### Process Complete
 
-The `workflow_complete!` method can be used to assert that the current workflow is complete at the end of a
-test. This is implemented by cancelling the workflow and checking for an error that it is already
+The `process_complete!` (previously `workflow_complete!`) method can be used to assert that the current process is complete at the end of a
+test. This is implemented by cancelling the process and checking for an error that it is already
 complete.
 
 ```ruby
-with_workflow_instance("file_basename") do
+with_process_instance("file_basename") do
   ...
 
-  workflow_complete!
+  process_complete!
 end
 ```
 
@@ -242,8 +242,8 @@ 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" })
+# process_instance_key is a method that returns the key for the current process instance
+set_variables(process_instance_key, { foo: "bar" })
 ```
 
 An activated job can be used to determine the key for the task that it is associated with:
@@ -370,7 +370,7 @@ to specify a short duration.
 
 The current gem and approach have some limitations:
 
-1. You can interact with only one workflow at a time.
+1. You can interact with only one process at a time.
 
 ## Development
 

data/docker-compose.simple-monitor.yml

@@ -0,0 +1,17 @@
+version: "3.4"
+
+services:
+  zeebe:
+    volumes:
+      - ./compose/zeebe-hazelcast-exporter.jar:/usr/local/zeebe/exporters/zeebe-hazelcast-exporter.jar
+      - ./compose/application.yml:/usr/local/zeebe/config/application.yaml
+
+  monitor:
+    image: camunda/zeebe-simple-monitor:0.19.1
+    environment:
+      - zeebe.client.broker.contactPoint=zeebe:26500
+      - zeebe.client.worker.hazelcast.connection=zeebe:5701
+    ports:
+      - "8082:8082"
+    depends_on:
+      - zeebe

data/docker-compose.yml

@@ -8,7 +8,7 @@ x-environment: &default-environment
   BUNDLE_DISABLE_SHARED_GEMS: "true"
   ZEEBE_ADDRESS: zeebe:26500
 x-service: &default-service
-  image: ruby:2.7.2
+  image: ruby:2.7.3
   volumes:
     - .:/usr/src/gem
     - ./compose/entrypoint.sh:/tmp/entrypoint.sh
@@ -18,22 +18,9 @@ x-service: &default-service
   stdin_open: true
 services:
   zeebe:
-    image: camunda/zeebe:${ZEEBE_VERSION:-0.26.1}
+    image: camunda/zeebe:${ZEEBE_VERSION:-1.0.0}
     environment:
       ZEEBE_LOG_LEVEL: debug
-    volumes:
-      - ./compose/zeebe-hazelcast-exporter.jar:/usr/local/zeebe/exporters/zeebe-hazelcast-exporter.jar
-      - ./compose/application.yml:/usr/local/zeebe/config/application.yaml
-
-  monitor:
-    image: camunda/zeebe-simple-monitor:0.19.1
-    environment:
-      - zeebe.client.broker.contactPoint=zeebe:26500
-      - zeebe.client.worker.hazelcast.connection=zeebe:5701
-    ports:
-      - "8082:8082"
-    depends_on:
-      - zeebe
 
   console:
     <<: *default-service

data/lib/zeebe_bpmn_rspec.rb

@@ -3,6 +3,7 @@
 require "active_support"
 require "rspec"
 require "zeebe/client"
+require "zeebe_bpmn_rspec/deprecate_workflow_alias"
 require "zeebe_bpmn_rspec/helpers"
 require "zeebe_bpmn_rspec/version"
 require "zeebe_bpmn_rspec/matchers/have_activated"

data/lib/zeebe_bpmn_rspec/activated_job.rb

@@ -6,13 +6,14 @@ require "json"
 module ZeebeBpmnRspec
   class ActivatedJob
     include ::Zeebe::Client::GatewayProtocol # for direct reference of request classes
+    extend DeprecateWorkflowAlias
 
     attr_reader :job, :type
 
-    def initialize(job, type:, workflow_instance_key:, client:, context:, validate:) # rubocop:disable Metrics/ParameterLists
+    def initialize(job, type:, process_instance_key:, client:, context:, validate:) # rubocop:disable Metrics/ParameterLists
       @job = job
       @type = type
-      @workflow_instance_key = workflow_instance_key
+      @process_instance_key = process_instance_key
       @client = client
       @context = context
 
@@ -20,7 +21,7 @@ module ZeebeBpmnRspec
         context.instance_eval do
           expect(job).not_to be_nil, "expected to receive job of type '#{type}' but received none"
           aggregate_failures do
-            expect(job.workflowInstanceKey).to eq(workflow_instance_key)
+            expect(job.processInstanceKey).to eq(process_instance_key)
             expect(job.type).to eq(type)
           end
         end
@@ -35,9 +36,10 @@ module ZeebeBpmnRspec
       job.key
     end
 
-    def workflow_instance_key
-      job.workflowInstanceKey
+    def process_instance_key
+      job.processInstanceKey
     end
+    deprecate_workflow_alias :workflow_instance_key, :process_instance_key
 
     def retries
       job.retries

data/lib/zeebe_bpmn_rspec/deprecate_workflow_alias.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "active_support/deprecation"
+
+module ZeebeBpmnRspec
+  module DeprecateWorkflowAlias
+    WorkflowDeprecation = ActiveSupport::Deprecation.new("v2.0", "ZeebeBpmnRspec")
+
+    def deprecate_workflow_alias(deprecated_name, new_name)
+      alias_method deprecated_name, new_name
+      deprecate deprecated_name => new_name, deprecator: WorkflowDeprecation
+    end
+  end
+end

data/lib/zeebe_bpmn_rspec/helpers.rb

@@ -6,38 +6,39 @@ require "zeebe_bpmn_rspec/activated_job"
 module ZeebeBpmnRspec
   module Helpers # rubocop:disable Metrics/ModuleLength
     include ::Zeebe::Client::GatewayProtocol # for direct reference of request classes
-
-    def deploy_workflow(path, name = nil)
-      _zeebe_client.deploy_workflow(DeployWorkflowRequest.new(
-                                      workflows: [WorkflowRequestObject.new(
-                                        name: (name && "#{name}.bpmn") || File.basename(path),
-                                        type: WorkflowRequestObject::ResourceType::FILE,
-                                        definition: File.read(path)
-                                      )]
-                                    ))
+    extend DeprecateWorkflowAlias
+
+    def deploy_process(path, name = nil)
+      _zeebe_client.deploy_process(DeployProcessRequest.new(
+                                     processes: [ProcessRequestObject.new(
+                                       name: (name && "#{name}.bpmn") || File.basename(path),
+                                       definition: File.read(path)
+                                     )]
+                                   ))
     rescue StandardError => e
-      raise "Failed to deploy workflow: #{e}"
+      raise "Failed to deploy precess: #{e}"
     end
+    deprecate_workflow_alias :deploy_workflow, :deploy_process
 
-    def with_workflow_instance(name, variables = {})
+    def with_process_instance(name, variables = {})
       system_error = nil
-      workflow = _zeebe_client.create_workflow_instance(CreateWorkflowInstanceRequest.new(
-                                                          bpmnProcessId: name,
-                                                          version: -1, # always latest
-                                                          variables: variables.to_json
-                                                        ))
-      @__workflow_instance_key = workflow.workflowInstanceKey
-      yield(workflow.workflowInstanceKey) if block_given?
+      process = _zeebe_client.create_process_instance(CreateProcessInstanceRequest.new(
+                                                        bpmnProcessId: name,
+                                                        version: -1, # always latest
+                                                        variables: variables.to_json
+                                                      ))
+      @__process_instance_key = process.processInstanceKey
+      yield(process.processInstanceKey) if block_given?
     rescue Exception => e # rubocop:disable Lint/RescueException
       # exceptions are rescued to ensure that instances are cancelled
       # any error is re-raised below
       system_error = e
     ensure
-      if workflow&.workflowInstanceKey
+      if process&.processInstanceKey
         begin
-          _zeebe_client.cancel_workflow_instance(CancelWorkflowInstanceRequest.new(
-                                                   workflowInstanceKey: workflow.workflowInstanceKey
-                                                 ))
+          _zeebe_client.cancel_process_instance(CancelProcessInstanceRequest.new(
+                                                  processInstanceKey: process.processInstanceKey
+                                                ))
         rescue GRPC::NotFound => _e
           # expected
         rescue StandardError => _e
@@ -46,24 +47,27 @@ module ZeebeBpmnRspec
       end
       raise system_error if system_error
     end
+    deprecate_workflow_alias :with_workflow_instance, :with_process_instance
 
-    def workflow_complete!
+    def process_complete!(wait_seconds: 0.25)
       error = nil
-      sleep 0.25 # TODO: configurable?
+      sleep(wait_seconds)
       begin
-        _zeebe_client.cancel_workflow_instance(CancelWorkflowInstanceRequest.new(
-                                                 workflowInstanceKey: workflow_instance_key
-                                               ))
+        _zeebe_client.cancel_process_instance(CancelProcessInstanceRequest.new(
+                                                processInstanceKey: process_instance_key
+                                              ))
       rescue GRPC::NotFound => e
         error = e
       end
 
-      raise "Expected workflow instance #{workflow_instance_key} to be complete" if error.nil?
+      raise "Expected process instance #{process_instance_key} to be complete" if error.nil?
     end
+    deprecate_workflow_alias :workflow_complete!, :process_complete!
 
-    def workflow_instance_key
-      @__workflow_instance_key
+    def process_instance_key
+      @__process_instance_key
     end
+    deprecate_workflow_alias :workflow_instance_key, :process_instance_key
 
     def activate_job(type, fetch_variables: nil, validate: true, worker: "#{type}-#{SecureRandom.hex}")
       raise ArgumentError.new("'worker' cannot be blank") if worker.blank?
@@ -83,13 +87,13 @@ module ZeebeBpmnRspec
 
       ActivatedJob.new(job,
                        type: type,
-                       workflow_instance_key: workflow_instance_key,
+                       process_instance_key: process_instance_key,
                        client: _zeebe_client,
                        context: self,
                        validate: validate)
     end
     alias process_job activate_job
-    # TODO: deprecate process_job
+    deprecate process_job: :activate_job
 
     def job_with_type(type, fetch_variables: nil)
       activate_job(type, fetch_variables: fetch_variables, validate: false)
@@ -114,7 +118,7 @@ module ZeebeBpmnRspec
           response.jobs.each do |job|
             yielder << ActivatedJob.new(job,
                                         type: type,
-                                        workflow_instance_key: workflow_instance_key,
+                                        process_instance_key: process_instance_key,
                                         client: _zeebe_client,
                                         context: self,
                                         validate: true)
@@ -143,7 +147,7 @@ module ZeebeBpmnRspec
     end
 
     def reset_zeebe!
-      @__workflow_instance_key = nil
+      @__process_instance_key = nil
     end
 
     private

data/lib/zeebe_bpmn_rspec/version.rb

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

data/zeebe_bpmn_rspec.gemspec

@@ -52,5 +52,5 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency "activesupport"
   spec.add_runtime_dependency "rspec", "~> 3.4"
-  spec.add_runtime_dependency "zeebe-client"
+  spec.add_runtime_dependency "zeebe-client", "~> 0.14.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zeebe_bpmn_rspec
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 1.0.0
 platform: ruby
 authors:
 - ezCater, Inc
@@ -126,16 +126,16 @@ dependencies:
   name: zeebe-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.14.0
 description: Zeebe BPMN testing using RSpec
 email:
 - engineering@ezcater.com
@@ -148,9 +148,11 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- docker-compose.simple-monitor.yml
 - docker-compose.yml
 - lib/zeebe_bpmn_rspec.rb
 - lib/zeebe_bpmn_rspec/activated_job.rb
+- lib/zeebe_bpmn_rspec/deprecate_workflow_alias.rb
 - lib/zeebe_bpmn_rspec/helpers.rb
 - lib/zeebe_bpmn_rspec/matchers/have_activated.rb
 - lib/zeebe_bpmn_rspec/matchers/have_headers.rb