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    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.5.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

robotframework_camunda-0.3.5-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: robotframework-camunda-0.3.5.tar.gz
  • Upload date:
  • Size: 5.2 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.5.tar.gz
Algorithm Hash digest
SHA256 fcdb34ae0469e503a8bf036b6906c362097ed8a26fb493555a31cd301d09b453
MD5 966809b61e9cb3d2b420e4e45f24fc3c
BLAKE2b-256 62bc733f6fc3ca82c66bb35828561e87e6ec94bfe70611590008bae70a0cd00b

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: robotframework_camunda-0.3.5-py3-none-any.whl
  • Upload date:
  • Size: 10.9 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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 fd421c06055dde53a1a7f9c05303ad32b5dca1f556829817a3e8a66c05592f80
MD5 3928a1f904f2dcf8f7427cff27f85af9
BLAKE2b-256 c5d79cd27ff7c54c20a11f4fb10aa9ff720529021dbf4f6a21b82a4ea53ba5dd

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