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
-x, --xml Writes a single xml-file instead of the zipfile.
-t, --temp Path to write temporary files to.
-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.
-r, --repository Sets the repository id of the TestBench import. The default is iTB_RF.
-p, --pk Defines from which number the pks are enumerated. The default is 230.
--info Writes the Libdoc2TestBench, Robot Framework and Python version to console.

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

Change log

  • 1.0rc2
    • ADDED optional arguments for:
      • xml-file output (instead of zip-file)
      • custom temporary directory
      • changing the repository id in the xml-header
      • custom primary key enumeration start
      • info command for printing Libdoc2TestBench/Robot Framework/Python version to console
      • support for resource-files (attachment support coming soon)
    • FIX:
      • only create _Datatype subdivison in libraries when data types are present
      • Resource subdivison is now in the correct parent subdivision
      • Updated README.md / package help-messages to reflect changes
  • 1.0rc1
    • first release candidate

License

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


Dependencies


Contributing

Code style: black For consistent code formatting, please use Black - The Uncompromising Code Formatter with the following arguments in the root directory:

black -l 100 -S .

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

Built Distribution

File details

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

File metadata

  • Download URL: robotframework-libdoc2testbench-1.0rc2.tar.gz
  • Upload date:
  • Size: 16.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.0

File hashes

Hashes for robotframework-libdoc2testbench-1.0rc2.tar.gz
Algorithm Hash digest
SHA256 5fe1fd5d0c4e434a517ede833ee7d3d7ed9ee611bc5b17d31df7a9a4763d0318
MD5 934a89530f481ead39acef54506d0937
BLAKE2b-256 76d43446a7acd08aa3f85b435cdf84012ba176f975194b289db3ae9a2f4faca1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: robotframework_libdoc2testbench-1.0rc2-py3-none-any.whl
  • Upload date:
  • Size: 16.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/3.7.3 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.0

File hashes

Hashes for robotframework_libdoc2testbench-1.0rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 b31f94cce7395ad9e88b41799eb412aa5403d8388425102f70a2bc52264eb196
MD5 7681cd362015af8f6f2c9096d70a4a48
BLAKE2b-256 56cd7cc316dfc922e00223d062e835f767bf2ddb2d22d5bfaa8ecb7dcfb8ce33

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