feat(src): add --stdout flag

Signed-off-by: Abhinav Bansal <[email protected]>

src/__tests__/integration/scenarios/sci-e.ts

@@ -4,9 +4,9 @@ import {
   npmInstallPackage,
   npmUninstallPackage,
 } from '../helpers/module-installer';
-import {execPromise, getJSONFromText} from '../helpers/common';
+import {execPromise} from '../helpers/common';
 import {sciEInputData} from '../test-data/sci-e';
-
+import * as YAML from 'js-yaml';
 describe('integration/sci-e', () => {
   const modelName = 'sci-e';
   const absoluteManifestPath = `${__dirname}/../manifest/sci-e.yaml`;
@@ -24,7 +24,7 @@ describe('integration/sci-e', () => {
       method: 'SciE',
       path: '@grnsft/if-plugins',
     };
-    file.initialize.outputs = ['log'];
+    file.initialize.outputs = [];
 
     file.tree.children.child.pipeline = [modelName];
     file.tree.children.child.config = {};
@@ -33,23 +33,29 @@ describe('integration/sci-e', () => {
 
     await saveYamlFileAs(file, absoluteManifestPath); // save yaml uses absolute path
     const response = (
-      await execPromise(`npm run ie -- --manifest ${relativeManifestPath}`)
+      await execPromise(
+        `npm run ie -- --manifest ${relativeManifestPath} --stdout`
+      )
     ).stdout; // exec promise uses relative path
 
-    const finalOutputParsed = getJSONFromText(response);
+    const yamlPart = response.substring(
+      response.indexOf('name:'),
+      response.length
+    );
+    const finalOutputParsed: any = YAML.load(yamlPart);
 
     // assertions
-    const path = finalOutputParsed.tree.children['child'].outputs![0];
-    const manifestPath = file.tree.children['child'].inputs[0];
+    const path = finalOutputParsed.tree.children.child.outputs[0];
+    const manifestPath = file.tree.children.child.inputs[0];
 
     // assert timestamp
-    expect(
-      finalOutputParsed.tree.children['child'].inputs[0].timestamp
-    ).toEqual(file.tree.children['child'].inputs[0].timestamp);
+    expect(finalOutputParsed.tree.children.child.inputs[0].timestamp).toEqual(
+      file.tree.children.child.inputs[0].timestamp
+    );
 
     // assert duration
-    expect(finalOutputParsed.tree.children['child'].inputs[0].duration).toEqual(
-      file.tree.children['child'].inputs[0].duration
+    expect(finalOutputParsed.tree.children.child.inputs[0].duration).toEqual(
+      file.tree.children.child.inputs[0].duration
     );
 
     // assert total energy

src/__tests__/unit/builtins/export-log.test.ts

@@ -1,5 +1,5 @@
 import {ExportLog} from '../../../builtins/export-log';
-
+import * as YAML from 'js-yaml';
 import {tree, context} from '../../../__mocks__/builtins/export-csv';
 
 describe('builtins/export-log:', () => {
@@ -10,7 +10,7 @@ describe('builtins/export-log:', () => {
 
       expect(mockConsoleLog).toHaveBeenCalled();
       expect(mockConsoleLog).toHaveBeenCalledWith(
-        JSON.stringify({...context, tree}, null, 2)
+        YAML.dump({...context, tree}, {noRefs: true})
       );
 
       mockConsoleLog.mockRestore();
@@ -22,7 +22,7 @@ describe('builtins/export-log:', () => {
 
       expect(mockConsoleLog).toHaveBeenCalled();
       expect(mockConsoleLog).toHaveBeenCalledWith(
-        JSON.stringify({...context, tree: {}}, null, 2)
+        YAML.dump({...context, tree: {}}, {noRefs: true})
       );
 
       mockConsoleLog.mockRestore();

src/builtins/export-log.ts

@@ -1,5 +1,5 @@
 import {Context} from '../types/manifest';
-
+import * as YAML from 'js-yaml';
 export const ExportLog = () => {
   /**
    * Logs output manifest in console.
@@ -9,8 +9,7 @@ export const ExportLog = () => {
       ...context,
       tree,
     };
-
-    console.log(JSON.stringify(outputFile, null, 2));
+    console.log(YAML.dump(outputFile, {noRefs: true}));
   };
 
   return {execute};

src/config/config.ts

@@ -35,6 +35,11 @@ export const CONFIG = {
         description:
           'How much information to output about the calculation to aid investigation and debugging.',
       },
+      stdout: {
+        type: Boolean,
+        optional: true,
+        description: 'Prints output to the console.',
+      },
       help: {
         type: Boolean,
         optional: true,
@@ -47,12 +52,14 @@ export const CONFIG = {
   -output [path to the output file]
   -format [yaml|csv] 
   -verbose
+  --stdout
   -help 
   manifest: path to an input manifest
   output: path to the output file where the results as saved, if none is provided it prints to stdout.
   format: the output file format. default to yaml but if csv is specified then it formats the outputs as a csv file for loading into another program.
   verbose: how much information to output about the calculation to aid investigation and debugging.
   help: prints out the above help instruction.
+  stdout: Prints output to the console.
   `,
   },
   GITHUB_PATH: 'https://github.com',

src/index.ts

@@ -24,15 +24,15 @@ const impactEngine = async () => {
   const options = parseArgs();
 
   if (options) {
-    const {inputPath, outputPath, paramPath} = options;
+    const {inputPath, outputPath, paramPath, stdout} = options;
 
     const {tree, context, parameters} = await load(inputPath, paramPath);
     parameterize.combine(context.params, parameters);
     const pluginStorage = await initalize(context.initialize.plugins);
     const computedTree = await compute(tree, {context, pluginStorage});
     const aggregatedTree = aggregate(computedTree, context.aggregation);
     context['if-version'] = packageJson.version;
-    exhaust(aggregatedTree, context, outputPath);
+    exhaust(aggregatedTree, context, outputPath, stdout);
 
     return;
   }

src/lib/exhaust.ts

@@ -33,8 +33,6 @@ const initializeExhaustPlugin = (name: string): ExhaustPluginInterface => {
       return ExportCSV();
     case 'csv-raw':
       return ExportCSVRaw();
-    case 'log':
-      return ExportLog();
     default:
       throw new ModuleInitializationError(INVALID_EXHAUST_PLUGIN(name));
   }
@@ -44,12 +42,17 @@ const initializeExhaustPlugin = (name: string): ExhaustPluginInterface => {
  * Output manager - Exhaust.
  * Grabs output plugins from context, executes every.
  */
-export const exhaust = (tree: any, context: Context, outputPath?: string) => {
+export const exhaust = (
+  tree: any,
+  context: Context,
+  outputPath?: string,
+  stdout?: boolean
+) => {
   const outputPlugins = context.initialize.outputs;
-
-  if (!outputPlugins) {
+  if (stdout) {
     ExportLog().execute(tree, context);
-
+  }
+  if (!outputPlugins) {
     return;
   }
 

src/types/process-args.ts

@@ -3,4 +3,5 @@ export interface ManifestProcessArgs {
   output?: string;
   'override-params'?: string;
   help?: boolean;
+  stdout?: boolean;
 }

src/util/args.ts

@@ -56,6 +56,7 @@ export const parseArgs = () => {
     output,
     'override-params': overrideParams,
     help,
+    stdout,
   } = validateAndParseProcessArgs();
 
   if (help) {
@@ -67,6 +68,7 @@ export const parseArgs = () => {
     if (checkIfFileIsYaml(manifest)) {
       return {
         inputPath: prependFullFilePath(manifest),
+        stdout: stdout,
         ...(output && {outputPath: prependFullFilePath(output)}),
         ...(overrideParams && {paramPath: overrideParams}),
       };