hexios/bin/controllers/chiefWorkflow.js

A haystacks based API testing automation plugin used for building API testing automation frameworks, wrapper for the axios library.

/**
 * @file chiefWorkflow.js
 * @module chiefWorkflow
 * @description Contains all of the top-level functions to manage the workflows for the plugin.
 * @requires module:plugin.constants
 * @requires module:chiefData
 * @requires module:loggers
 * @requires {@link https://www.npmjs.com/package/@haystacks/constants|@haystacks/constants}
 * @requires {@link https://www.npmjs.com/package/path|path}
 * @author Seth Hollingsead
 * @date 2023/04/21
 * @copyright Copyright © 2023-… by Seth Hollingsead. All rights reserved
 */

// Internal imports
import * as plg from '../constants/plugin.constants.js';
import chiefData from './chiefData.js';
import loggers from '../executrix/loggers.js';
// External imports
import hayConst from '@haystacks/constants';
import path from 'path';

const {bas, msg, wrd} = hayConst;
const baseFileName = path.basename(import.meta.url, path.extname(import.meta.url));
// plugins.hexios.controllers.chiefWorkflow.
const namespacePrefix = wrd.cplugins + bas.cDot + plg.cpluginName + bas.cDot + wrd.ccontrollers + bas.cDot + baseFileName + bas.cDot;

/**
 * @function setupWorkflows
 * @description Sets up all the plugin workflows data.
 * @param {string} pluginWorkflowsPath The path of the workflows files for the plugin layer.
 * @return {object} A JSON object that contains all of the workflows data loaded and parsed from the specified path.
 * @author Seth Hollingsead
 * @date 2023/04/24
 */
async function setupWorkflows(pluginWorkflowsPath) {
  // let functionName = setupWorkflows.name;
  // await loggers.consoleLog(namespacePrefix + functionName, msg.cBEGIN_Function);
  // pluginWorkflowsPath is:
  // await loggers.consoleLog(namespacePrefix + functionName, msg.cpluginWorkflowsPathIs + pluginWorkflowsPath);
  let returnData = {};
  returnData = await chiefData.loadWorkflowsData(pluginWorkflowsPath);
  // await loggers.consoleLog(namespacePrefix + functionName, msg.creturnDataIs + JSON.stringify(returnData));
  // await loggers.consoleLog(namespacePrefix + functionName, msg.cEND_Function);
  return returnData;
}

export default {
  setupWorkflows
};