Skip to main content

Keywords for camunda rest api, leading open source workflow engine.

Project description

Robot Framework Camunda

This library provides keywords for accessing camunda workflow engine. Complete REST API reference of camunda can be found here.

Library is in an early stage. Please review issue board for known issues or report one yourself. You are invited to contribute pull requests.

Installation

The library is published on pypi.org and can be installed with pip:

pip install robotframework-camunda

Running robotframework-camunda

The tests folder has example robot tests for keywords already implemented. Those tests assume you already have an instance of camunda running.

Deploy process definition

*** Settings ***
Library    Camunda.Deployment    ${CAMUNDA_HOST}

*** Variables ***
${CAMUNDA_HOST}    http://localhost:8080

*** Test Cases ***
Test deployment of models
    ${response}    deploy model from file    ${CURDIR}/../../bpmn/demo_for_robot.bpmn

Starting a process instance

*** Settings ***
Library    Camunda.ProcessInstance    ${CAMUNDA_HOST}

*** Variables ***
${CAMUNDA_HOST}    http://localhost:8080

*** Test Cases ***
Test starting process
    #GIVEN
    ${process_definition_key}    Set Variable    demo_for_robot

    # WHEN
    ${process_instance}    start process    ${process_definition_key}

Execute Task

"Executing task" bascially means, you execute a robot task that fetches a workload from camunda, processes it and returns its workload back to camunda during completion. Main keywords involved are:

  1. Camunda.ExternalTask.Fetch and lock workloads
  2. Camunda.ExternalTask.Complete Task
*** Settings ***
Library    Camunda.ExternalTask    ${CAMUNDA_HOST}
Library    Collections

*** Variables ***
${CAMUNDA_HOST}    http://localhost:8000
${existing_topic}    process_demo_element

*** Test Cases ***
Test 'fetch and lock' for non existing topic
    # WHEN
    ${work_items}    fetch and lock workloads   topic=${existing_topic}

    # THEN
    Should Not Be Empty    ${work_items}

    ${recent_task}    Get recent process instance
    log    Recent task:\t${recent_task}

    ${my_result}    Create Dictionary    lastname=Stahl
    complete task   ${existing_topic}    ${recent_task}    ${my_result}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

robotframework-camunda-0.3.4.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

robotframework_camunda-0.3.4-py3-none-any.whl (10.7 kB view details)

Uploaded Python 3

File details

Details for the file robotframework-camunda-0.3.4.tar.gz.

File metadata

  • Download URL: robotframework-camunda-0.3.4.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0

File hashes

Hashes for robotframework-camunda-0.3.4.tar.gz
Algorithm Hash digest
SHA256 0226e117d75956e36208bd7a04d4c1812d2769fb78845c449d873a9b865934a4
MD5 866a29cef4f66ec4320d11a0e163beac
BLAKE2b-256 821b00e9361eaf840d708a890134d3026c1a27c0706173a54cca2980c8a5c3aa

See more details on using hashes here.

Provenance

File details

Details for the file robotframework_camunda-0.3.4-py3-none-any.whl.

File metadata

  • Download URL: robotframework_camunda-0.3.4-py3-none-any.whl
  • Upload date:
  • Size: 10.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.24.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0

File hashes

Hashes for robotframework_camunda-0.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d4113126ca54dcf4cea89dec48081ac7658d801bf4b42e1a9809d421e44afa57
MD5 7b7d6cbf24181f32085f274a8c3f3797
BLAKE2b-256 c2197918c69b182334fb2e44b02a445ea32e79ccf5e8e99020826b2ed59248f3

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page