Integrate Mr Suricate with XQual - Launcher

MrSuricate Launcher (mrsuricate.jar)

XQual integrates natively with MrSuricate — centralize your MrSuricate test executions, results, and reports from a single dashboard.
Why QA teams use XQual with MrSuricate
  • Centralize MrSuricate 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 mrsuricate.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
Mr Suricate
Mr Suricate URL This must indicate the URL of MrSuricate server

Default value is: https://api.mrsuricate.com/api-v2
Email This must indicate your account's email address.

Default value is: my_email@acme.com
Password This must indicate your account's password.

Default value is: my_password
Customer Id This must indicate your account's customer ID.

Default value is: 123
Browser This must indicate on which browser to run the tests.

Valid values are: Chrome, Firefox, Safari, Edge
Default value is: Chrome

These values can be changed while creating the campaign session from XQual.
Note about file path parameters:
Any parameter referring to a file or folder path (for instance Test root path) can be provided either using \ separator (if the tests are going to be executed on a Windows agent) or / separator (if the tests are going to be executed on a linux or MacOSX agent).

On windows, if you provide a path containing an OS-localizable folder such as C:\Program Files, always prefer the English version (i.e. NOT C:\Programmes if you're using a french-localized Windows) or the corresponding native environment variable (i.e. %PROGRAMFILES%).


Process

The tests are executed by the launcher using this syntax:

When the session starts (initialize())

Authenticate to MrSuricate

api-v2/auth/login

Fetch all the scenarios available

api-v2/customers/XXX/scenarios/get

Map the scenarios available with the tests that are going to be executed in this session


Run a schedule containing all the scenarios corresponding to the tests included in this session

api-v2/customers/XXX/runs/schedule

Map the run ids with the scheduled scenarios


For each test executed (run())

retrieve its corresponding run id


Check the status of the execution every 2 second (max 1 hour) until the run id is "Completed"

api-v2/customers/XXX/runs/<run-id>/get



The test will be marked as passed or failed depending on the json report returned by MrSuricate.

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