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

Uploaded Source

Built Distribution

robotframework_camunda-0.6.0-py3-none-any.whl (12.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for robotframework-camunda-0.6.0.tar.gz
Algorithm Hash digest
SHA256 0715953d38f3ce4934e71d46a00475a0cfda2e0e6d210e1c102453fda6ee8dbf
MD5 4b24d1ce646f5f400017e9ad7b2abc29
BLAKE2b-256 e3fcbe2cec4825d9e3981918000e73fdae6623f0e5932eea1f8419cebeec374a

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for robotframework_camunda-0.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6f6760e2ae3d0272b2bb17a5c49f06f171c829ca192e228e7b69583143f46de0
MD5 d94524fdd80e96f088c98ebb296224d6
BLAKE2b-256 d5617704b84fa7dcf58794f6af5cbeeabc2a87f65b76139a0bde313f1436fdc0

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