3.4.5 • Public • Published

    Testwizard - Core

    Javascript language support for testing different kinds of devices using testwizard

    npm (scoped) lerna


    Use this package in combination with one (or more) of the specific device packages

    Sidecar file

    The testwizard manager enables a single script to be run on different devices with (optionally) different sets of parameters. To enable this from any IDE a sidecar file (in json format) is used . By default the name of the sidecar file is the same as this script, but with a .json extension. A command-line-argument (--sidecar or -s) can be used to instruct the usage of a different file.

    This json file has the following attributes:

    • tester: The name of the tester (optional)
    • parameters: An array of parameters (optional)
      • name: The name of the parameter
      • value: The value for the parameter
    • resources: An array of resources
      • category: The category of the testobject
      • name: The name of the testobject
      • id: The id of the testobject
    • outputFolder: The folder where the log files should be written (optional)


    Every parameter will be made available as a field of the parameters property of the session object.

    console.log("param1 = " + session.paramteres.param1);


    All resources will be acquired (and thus locked) at the start of a test run and will be released when the script ends. To execute a command on a testobject it must be referenced (constructed), when doing this, the name of the resource will be used, while the id corresponds to the actual device.

    const mobile = await Mobile.create(session, "Mobile");
    let result = await mobile.initDriver();

    Output folder

    When running a test all actions are logged (testrun.log) and so is the result (result.log). By default the location of these files is a timestamp based folder within the runs folder. If a different location is preferred, this can be configured in the outputfolder attribute.


    When the script is executed (run or debug), a new session is created, and all resources will be locked If any of the resources is allready in use, a session cannot be setup and an error will be thrown. The session is destroyed when the script ends. At this point the resources will be released and available for other script runs.

    More information about the session can be read from the info attribute:

    • info
      • scriptFilePath: The full path of the script file
      • scriptFileName: The file name of the script file
      • storagePath: The directory where the output will be written
      • tester: The name of the tester
    • info.environment
      • scriptsBasePath: The root directory where all scripts are stored
      • storageBasePath: The root directory where the output is written
      • ocrEngine: The name of the ocr engine being used
      • testWizardVersion: The version of testwizard being used
    • info.session (optional: only when run from within the manager)
      • id: The unique identifier of the session in the manager
      • name: The name of the session
      • scriptIndex: The index of the script within the session


    The outcome of a script run can be either Pass, Fail or Error. During a script run multiple results can be reported, this can be done in 2 different ways:

    1. addPass / addFail: reports a pass or fail but does not post it to the server
    2. setResult: reports a pass / fail /error and posts it to the server
    let result = await mobile.initDriver();
    if (result.success)
    let result = await mobile.initDriver();
    if (result.success)
         await session.setResult(Testwizard.ResultCodes.PASS, result.message);
         await session.setResult(Testwizard.ResultCodes.FAIL, result.message);

    Sample script

    javascript (sample.js)

    'use strict';
    const Testwizard = require("@testwizard/test");
    const Mobile = require("@testwizard/mobile");
    const SetTopBox = require("@testwizard/set-top-box");
    async function test() {
        const session = await Testwizard.createSession();
        console.log("-- Parameter usage ---");
        console.log("  param1 = " + session.param1);
        console.log("  param2 = " + session.param2);
        console.log("-- Session info ---");
        console.log("  info.scriptFilePath = " + session.info.scriptFilePath);
        console.log("  info.scriptFileName = " + session.info.scriptFileName);
        console.log("  info.storagePath = " + session.info.storagePath);
        console.log("  info.tester = " + session.info.tester);
        console.log("  info.environment.scriptsBasePath = " + session.info.environment.scriptsBasePath);
        console.log("  info.environment.storageBasePath = " + session.info.environment.storageBasePath);
        console.log("  info.environment.ocrEngine = " + session.info.environment.ocrEngine);
        console.log("  info.environment.testWizardVersion = " + session.info.environment.testWizardVersion);
        if (session.info.session !== null)
            console.log("Script was started by the manager:");
            console.log("  info.session.id = " + session.info.session.id);
            console.log("  info.session.name = " + session.info.session.name);
            console.log("  info.session.scriptIndex = " + session.info.session.scriptIndex);
        console.log("-- Create Mobile test object ---");
        const mobile = await Mobile.create(session, "Mobile");
        console.log("-- Mobile test object info ---");
        console.log("  id = " + mobile.info.id);
        console.log("  name = " + mobile.info.name);
        console.log("  category = " + mobile.info.category);
        console.log("  device.serialNo = " + mobile.info.device.serialNo);
        console.log("  device.hardwareVersion = " + mobile.info.device.hardwareVersion);
        console.log("  device.softwareVersion = " + mobile.info.device.softwareVersion);
        console.log("  device.description = " + mobile.info.device.description);
        console.log("  device.vendor.name = " + mobile.info.device.vendor.name);
        console.log("  device.vendor.modelName = " + mobile.info.device.vendor.modelName);
        console.log("  device.vendor.serialNo = " + mobile.info.device.vendor.serialNo);
        console.log("- mobile: initDriver");
        let result = await mobile.initDriver();
        if (!result.success)
        console.log("-- Create Set-top box test object ---");
        const setTopBox = await SetTopBox.create(session, "STB");
        console.log("- stb: sendRCKey");
        result = await setTopBox.sendRCKey("menu");
        if (!result.success)
        if (!(session.hasFails || session.hasErrors))
            session.addPass("Test was successful");

    sidecar file (sample.json)

        "tester": "Some tester",
        "parameters": [
            { "name": "param1", "value": "value1"},
            { "name": "param2", "value": "value2"}
        "resources": [
            { "category": "MOBILE", "name": "Mobile", "id": "Mobile 1"},
            { "category": "STB", "name": "STB", "id": "SetTopBox 1"}
        "outputFolder": "c:\\temp"


    The version is compatible with testwizard version 3.4


    Testwizard licensing


    npm i @testwizard/test

    DownloadsWeekly Downloads





    See readme.md

    Unpacked Size

    11 kB

    Total Files


    Last publish


    • edtb