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.

Documentation

Keyword documentation exists for sub-libraries:

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    CamundaLibrary.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    CamundaLibrary.ProcessDefinition    ${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. CamundaLibrary.ExternalTask.Fetch and lock workloads
  2. CamundaLibrary.ExternalTask.Complete Task
*** Settings ***
Library    CamundaLibrary.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.9.0.tar.gz (7.3 kB view details)

Uploaded Source

Built Distribution

robotframework_camunda-0.9.0-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: robotframework-camunda-0.9.0.tar.gz
  • Upload date:
  • Size: 7.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.3.3 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for robotframework-camunda-0.9.0.tar.gz
Algorithm Hash digest
SHA256 93c14b4acb378ea581d1895c8be45cf7bdbaf85e60d599a658401901298061dd
MD5 b3afb27dfa85cac09d6d6f3797d55204
BLAKE2b-256 37bb3cb5f01b83329e41be21f6492dce5157fed418cfc777868fec8c42e14f74

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: robotframework_camunda-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 13.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.3.3 requests-toolbelt/0.9.1 tqdm/4.56.0 CPython/3.9.1

File hashes

Hashes for robotframework_camunda-0.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 01780a17f9e9c648b386667b2a0b4968268152610a4535a2f348081dfc5a300f
MD5 38f02fafcfd1c510bdd3c4f9fb6f81d4
BLAKE2b-256 86813be7332742fd29b7dfecc65521a79a44aed76dd7e0b2b006304701005c51

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