@dbouckaert/zephyr-scale-reporter/dist/zephyrHelpers.d.ts

ZH, or zephyr helpers is a Node JS framework that implements test suites with Zephyr scale for Jira. It uses a soft-assert function to absorb failing assertions and translate them to a true/false value.

import { ZephyrConfig } from './interfaces/zephyr-config.interface';
import { TestResultDetails } from './interfaces/test-result-details.interface';
import { SoftAssert } from './interfaces/soft-assert.interface';
/**
 * This function sets a range of variables the Zephyr module uses
 * @param {ZephyrConfig} zephyrConfig
 */
export declare function init(zephyrConfig: ZephyrConfig): Promise<void>;
/**
 * This function will get all testcases for a certain project and add them to variables.testCasesArray
 * @returns {void}
 */
export declare const getAllTestcases: () => Promise<void>;
/**
 * Updating the test result 'entry' with the passed/failed status, based on the 'test run id'
 * @param {object} params  testrunId, status (passed or failed)
 */
export declare const updateTestResult: (testResultDetails: TestResultDetails) => Promise<void>;
/**
 * This function creates a new test run and resturns the testrun ID
 * @param {string} testcaseFolderName name of the folder the testcase is in
 * @param {string} testcaseName name of the testcase
 * @returns {number} testrun ID
 */
export declare const createNewTestrun: (testcaseFolderName: string, testcaseName: string) => Promise<number>;
/**
 * Assert and capture errors.
 * While a normal failing assert would stop the code from running, the soft-assert can continue
 * And throws errors only if .assertAll() is called.
 */
export declare const softAssert: SoftAssert;