NPM module - izara-testing: Difference between revisions

From Izara Wiki
Jump to navigation Jump to search
No edit summary
Line 46: Line 46:
<syntaxhighlight lang="JavaScript">
<syntaxhighlight lang="JavaScript">
/**
/**
  * Extract all matching unit test configurations
  * Get the configuration for one event
  * @param {string} eventTag - Tag of the event required
  * @param {string} eventTag - Tag of the event required
  *
  *

Revision as of 01:10, 3 September 2020

Overview

Code shared by multiple repositories used for testing, can by npm installed using --save-dev setting, only used in local environments.

The module has the following components:

TestLog

Functions that handle log output from test scripts, including a LOG_LEVEL setting that can be affect which log results are outputted and thisLine which assists outputting debug information such as line number where the log was called from.

IntegrationTestConfig

Build unit tests from Integration Test Config service which must be cloned into the same root directory as the service being tested because config files are linked to using relative paths.

Function - GetResourceConfig

/**
 * Get the configuration for one resource
 * @param {string} serviceName - Service name for the resource
 * @param {string} resourceType - Resource type
 * @param {string} resourceName - Name of the resource
 *
 * @returns {object} One resource configuration
 */
module.exports.GetResourceConfig = (serviceName, resourceType, resourceName) => {

Function - GetUnitTestConfig

/**
 * Extract all matching unit test configurations
 * @param {string} serviceName - Service name for the resource
 * @param {string} resourceType - Resource type
 * @param {string} resourceName - Name of the resource
 * @param {Object[]} integrationTestTags - can be used to only extract unit tests from the specified integrationTestTags
 *
 * @returns {array} array of unit test configuration objects that match the given params
 */
module.exports.GetUnitTestConfig = (serviceName, resourceType, resourceName, integrationTestTags = NULL) => {

Function - GetEventConfig

/**
 * Get the configuration for one event
 * @param {string} eventTag - Tag of the event required
 *
 * @returns {object} One event configuration
 */
module.exports.GetEventConfig = (eventTag) => {