Skip to main content

Robot Framework library for the Lynqa test execution agent

Project description

robotframework-lynqa

CI License Python

robotframework-lynqa is a Robot Framework library for the Lynqa test execution AI Agent.

Robot Framework/Lynqa connector

Write your scenarios in plain Gherkin and have them executed by Lynqa against your web application, instead of by locally defined keywords. It builds on pylynqa, the Python client for the Lynqa REST API.

Disclaimers

[!IMPORTANT] This is an unofficial project. robotframework-lynqa is not affiliated with, endorsed by, or maintained by Smartesting, the company that develops Lynqa. "Lynqa" and "Smartesting" are the property of their respective owners.

[!NOTE] Lynqa is a commercial product. Using this library requires a Lynqa account and an API key, and running tests consumes paid credits. See https://my.lynqa.smartesting.com/integration to create an API key.

Requirements

  • Python 3.9+
  • Robot Framework 7+
  • A Lynqa account and API key (test executions consume credits)

Installation

pip install robotframework-lynqa

At this early stage the package may not be published on PyPI yet. In the meantime you can install it from source:

pip install git+https://github.com/petit-robot/robotframework-lynqa.git

Quick start

Import the library and write your test cases with the Given/When/Then keywords, each taking a single natural-language step:

*** Settings ***
Library    robotframework_lynqa.LynqaLibrary    api_key=%{API_KEY}

*** Variables ***
${LYNQA_URL}    https://example.com/

*** Test Cases ***
Search For An Item
    Given    the home page is open
    When     the user searches for an item
    Then     matching results are displayed

The scenario is captured and submitted to Lynqa, which runs it against the site at ${LYNQA_URL} and reports each step's result back to Robot Framework.

Configuration variables

Variable Required Description
${LYNQA_URL} Yes URL of the web application under test.
${LYNQA_LANGUAGE} No Language of the user running the scenario.
${LYNQA_DATETIME} No Date and time of the run (defaults to the current local date and time).
&{LYNQA_SECRETS} No Mapping of secret name to value (e.g. login=superu password=TrèsS3cr3t).

Collaboration

This project is at an early stage, so external contributions are limited for now. This may be opened up more broadly later as the project matures.

In the meantime, you are very welcome to open an issue to report a bug or ask any question.

License

Licensed under the Apache License 2.0.

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_lynqa-0.1.0a1.tar.gz (47.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

robotframework_lynqa-0.1.0a1-py3-none-any.whl (22.8 kB view details)

Uploaded Python 3

File details

Details for the file robotframework_lynqa-0.1.0a1.tar.gz.

File metadata

  • Download URL: robotframework_lynqa-0.1.0a1.tar.gz
  • Upload date:
  • Size: 47.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for robotframework_lynqa-0.1.0a1.tar.gz
Algorithm Hash digest
SHA256 5e01c4ed08dd7c2f00a30cb3356728325e39ad4efad1aa0f6b22c324044ca7ef
MD5 02db7ef35d5dae05837928cc5a063c15
BLAKE2b-256 9de232dac8628d1737d08a48b001b6b067460d7a6911b48bdef37ab8cfc02b7b

See more details on using hashes here.

Provenance

The following attestation bundles were made for robotframework_lynqa-0.1.0a1.tar.gz:

Publisher: release.yml on petit-robot/robotframework-lynqa

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file robotframework_lynqa-0.1.0a1-py3-none-any.whl.

File metadata

File hashes

Hashes for robotframework_lynqa-0.1.0a1-py3-none-any.whl
Algorithm Hash digest
SHA256 44de0bbd45ef3ef5a97c143cc77ea8e6136758cfdb25d344ae2ba1693cb4e423
MD5 fc98e5e836030567f5edab9497667c97
BLAKE2b-256 306eb6ed1be79c29fd881bd1e154516af2efd8c403f1d859e33aaac1b5644a61

See more details on using hashes here.

Provenance

The following attestation bundles were made for robotframework_lynqa-0.1.0a1-py3-none-any.whl:

Publisher: release.yml on petit-robot/robotframework-lynqa

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page