Skip to main content

Robot Framework Libdoc Extension that generates imbus TestBench Library import formats.

Project description

Libdoc2TestBench

Robot Framework Libdoc Extension that generates imbus TestBench Enterprise Library import formats.


Installation:

To install this package you can use pip:

pip install robotframework-libdoc2testbench

Notice: This extension requires Robot Framework 4.0.0 or later and does not work with earlier versions.


Usage:

LibDoc2TestBench command demo

The basic usage just needs the Libdoc2TestBench command and a Robot Framework Library as input and saves a zip-file named project-dump.zip in the current working directory containing the needed information for the import.

Libdoc2TestBench <LIBRARY or RESOURCE>

By using a second positional argument you can additionally specify the output filename:

Libdoc2TestBench <LIBRARY or RESOURCE> <output.zip>

There are several optional arguments, that follow the structure of the robot.libdoc module. When generating imports from a RF library, these values should already be set up correctly. You may overwrite the docformat and other meta data by setting the associated arguments written below.

Arguments Description Allowed Values
-s, --specdocformat Specifies the documentation format used with XML and JSON spec files. RAW means preserving the original documentation format and HTML means converting documentation to HTML. The default is HTML. HTML RAW
-F, --docformat Specifies the source documentation format. Possible values are Robot Framework's documentation format, HTML, plain text, and reStructuredText. The default value can be specified in library source code and the initial default value is ROBOT. ROBOT HTML TEXT REST
-n, --name Sets the name of the documented library or resource for the import.
-v, --version Sets the version of the documented library or resource written for the import written in the description.

Import in imbus TestBench

First create a zip-file from a Robot Framework library via the Libdoc2TestBench command. Afterwards the generated zip-file can be imported via the Import Project... command in the Project Management view of the imbus TestBench:

Import Project Demo

In the Test Elements view you can now see your imported RF library as different interactions and datatypes:

Test Element View


License

Distributed under the Apache-2.0 license. See LICENSE for more information.


Dependencies:

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-libdoc2testbench-1.0rc1.tar.gz (13.1 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file robotframework-libdoc2testbench-1.0rc1.tar.gz.

File metadata

  • Download URL: robotframework-libdoc2testbench-1.0rc1.tar.gz
  • Upload date:
  • Size: 13.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.7

File hashes

Hashes for robotframework-libdoc2testbench-1.0rc1.tar.gz
Algorithm Hash digest
SHA256 d3cdfe760cbd955f314951a8fa8768c05971f238be91d99f1723ec3e9d8f23ca
MD5 837ebcaca4bed2563da0400b14912a08
BLAKE2b-256 12a9e1cd0c83ca825e5ba9172e65cd0125e44d4a0a623b28f1fd18f2b6ae8d10

See more details on using hashes here.

File details

Details for the file robotframework_libdoc2testbench-1.0rc1-py3-none-any.whl.

File metadata

  • Download URL: robotframework_libdoc2testbench-1.0rc1-py3-none-any.whl
  • Upload date:
  • Size: 13.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.8.7

File hashes

Hashes for robotframework_libdoc2testbench-1.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 ee06607fc38ce71c8cf1d9dcb60a28c13ada2108a96aeb07b3894e7a4d991b10
MD5 77d1b4b8c2c3d637071abf25c34e3f4f
BLAKE2b-256 d0a8648c682d6593a5623ad0c4c473905f83d032633ec6354ca78f1827351b8b

See more details on using hashes here.

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