[241] Create new getWorkflowTemplateSummary function

Author: Toby-Masters-SF

bin/cli.js

@@ -570,9 +570,9 @@ program
   .command("stats")
   .description("Generate an overview with some statistics")
   .requiredOption("-s, --since <date>, Specify the date which is going to be used to filter the data from (format: YYYY-MM-DD) (mandatory)")
-  .option("-w, --workflow [handle]", "Optionally filter test statistics by workflow (workflow handle is optional)")
+  .option("-w, --workflow [handle], Optionally filter test statistics by workflow (optional)")
   .action((options) => {
-    stats.generateOverview(options.since);
+    stats.generateOverview(options.since, options.workflow);
   });
 
 // Set/Get FIRM ID

lib/cli/stats.js

@@ -6,15 +6,20 @@ const fsUtils = require("../utils/fsUtils");
 const yaml = require("yaml");
 const { consola } = require("consola");
 
-async function generateOverview(sinceDate) {
+async function generateOverview(sinceDate, workflow) {
   const TODAY = new Date().toJSON().toString().slice(0, 10);
-  const templateSummary = await getTemplatesSummary();
-  const yamlSummary = await getYamlSummary(sinceDate);
-  // Terminal
-  displayOverview(sinceDate, TODAY, templateSummary, yamlSummary);
-  // File
-  const row = createRow(sinceDate, TODAY, templateSummary, yamlSummary);
-  saveOverviewToFile(row);
+  if (workflow) {
+    const templateSummary = await getWorkflowTemplateSummary(workflow);
+    consola.log("Workflow summary test A")
+  } else {
+    const templateSummary = await getTemplatesSummary();
+    const yamlSummary = await getYamlSummary(sinceDate);
+    // Terminal
+    displayOverview(sinceDate, TODAY, templateSummary, yamlSummary);
+    // File
+    const row = createRow(sinceDate, TODAY, templateSummary, yamlSummary);
+    saveOverviewToFile(row);
+  }
 }
 
 // Return an object with the count of activities by file and by type
@@ -255,6 +260,51 @@ async function getTemplatesSummary() {
   return summary;
 }
 
+async function getWorkflowTemplateSummary(workflowHandle) {
+  const summary = {
+    reconciliations: {
+      total: 0,
+      externallyManaged: 0,
+      externallyManagedPerc: 0,
+      yamlFiles: 0,
+      yamlFilesPerc: 0,
+      unitTests: 0,
+      yamlFilesWithAtLeastTwoTests: 0,
+      yamlFilesWithAtLeastTwoTestsPerc: 0,
+    },
+    exportFiles: {
+      total: 0,
+      externallyManaged: 0,
+      externallyManagedPerc: 0,
+    },
+    accountTemplates: {
+      total: 0,
+      externallyManaged: 0,
+      externallyManagedPerc: 0,
+      yamlFiles: 0,
+      yamlFilesPerc: 0,
+      unitTests: 0,
+      yamlFilesWithAtLeastTwoTests: 0,
+      yamlFilesWithAtLeastTwoTestsPerc: 0,
+    },
+    all: {
+      total: 0,
+      externallyManaged: 0,
+      externallyManagedPerc: 0,
+      yamlFiles: 0,
+      yamlFilesPerc: 0,
+      unitTests: 0,
+      yamlFilesWithAtLeastTwoTests: 0,
+      yamlFilesWithAtLeastTwoTestsPerc: 0,
+    },
+  };
+
+  // Reconciliations
+  // Assume no empty reconciliations within the workflow.
+
+  return summary;
+}
+
 async function getYamlSummary(sinceDate) {
   const yamlActivity = await yamlFilesActivity(sinceDate);
   const summary = { created: 0, updated: 0 };