Integrate Lynqa with XQual - Launcher

Lynqa Launcher (lynqa.jar)

XQual integrates natively with Lynqa — centralize your Lynqa test executions, results, and reports from a single dashboard.
Why QA teams use XQual with Lynqa
  • Centralize Lynqa results alongside 100+ other frameworks in a single dashboard
  • Link test cases to requirements and defects for full traceability
  • Launch, monitor and report across all your frameworks simultaneously
→ Start your free XQual trial

Configuration

The lynqa.xml file is just a template and must NOT be edited. It's used by the system to build dynamically the form that the user will be able to fill in from the GUI when creating a custom execution configuration.

Parameter Description
REST Connection
Base URL This must indicate the URL of Lynqa service

Default value is: https://my_lynqa_server
API Key This must indicate the API Key to authenticate to the server.

Default value is: aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee
Target
Base URL This must indicate the URL of the target app

Default value is: https://my_target_app

These values can be changed while creating the campaign session from XQual.

Process

The tests are executed by the launcher using this process:

Generate the input JSON for Lynqa

A JSON document containing the testcase procedure is built in Lynqa format

Call Lynqa service to execute the testcase

The method testRuns (POST query) is called with the JSON document in the body of the query
A runId is returned.

Wait Lynqa service to report the end of execution

The method getStatus (GET query) is called with the runId as parameter every second until a status success, failed or terminated is returned
The output is parsed and converted to structured messages that are visible in XQual.
In case of a success, all screenshots referenced by Lynqa are downloaded and embedded in the messages as well.
A timeout of 1 hour is also applied. If the timeout expires, the launcher ignores the execution and returns an error to XQual.



Permissions

WARNING: if you're running your tests on Windows, it may be required to run the tests as administrator.
Having an account with Administrators permissions may even not be enough in some cases (especially if you're using Windows 10) and you may need to disable completely the UAC (User Access Control) on your computer.
To do so:
  • Press the Windows + R key combination
  • Type in regedit
  • Go to HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Policies\System
  • In the right-side pane, look for EnableLUA and set the value 0
  • Close the registry editor
  • Restart your computer

Debug

If your tests are not executed correctly or are reporting only failures, this is very likely because your configuration is incorrect or because you used a wrong naming convention for your tests and test cases.

The best way to quickly find out what's wrong is to look at the traces generated by XQual (or XAgent).
The traces always include the detailed description of what the launcher performs (command line execution, script execution, API calling etc.) to run a test case. So, if you experiment some problems, the first thing to do is to activate the traces and look at what's happening when you run your tests.

Then, try to execute manually in a cmd box the exact same commands.
This will normally fail the same way.
At this point, you needs to figure out what has to be changed in these commands in order to have them run properly.

When you have something working, compare these commands to what's described in the Process chapter above. This will tell you exactly what you need to change.

Most of the time, this is related to:
  • some incorrect values in some parameters of your configuration,
  • the name of your tests,
  • the name of your test cases,
  • the canonical path of your tests

Next steps with XQual