[Stats] Add percentage columns

Calculate the amount of templates that are externally managed and have unit tests
Add them to new columns in the output csv file
Include percentange in the overview displayed on the terminal

Author: AgustinSilverfin

lib/cli/stats.js

@@ -159,48 +159,67 @@ async function setMainPath(templateType, templateName) {
   return filePath;
 }
 
+function percentageRoundTwo(num, den) {
+  return den > 0 ? Number(((num / den) * 100).toFixed(2)) : 0;
+}
+
 async function getTemplatesSummary() {
   const summary = {
     reconciliations: {
       total: 0,
       externallyManaged: 0,
+      externallyManagedPerc: 0,
       yamlFiles: 0,
+      yamlFilesPerc: 0,
       unitTests: 0,
     },
     sharedParts: {
       total: 0,
       externallyManaged: 0,
+      externallyManagedPerc: 0,
     },
     exportFiles: {
       total: 0,
       externallyManaged: 0,
+      externallyManagedPerc: 0,
     },
     accountTemplates: {
       total: 0,
       externallyManaged: 0,
+      externallyManagedPerc: 0,
       yamlFiles: 0,
+      yamlFilesPerc: 0,
       unitTests: 0,
     },
     all: {
       total: 0,
       externallyManaged: 0,
+      externallyManagedPerc: 0,
       yamlFiles: 0,
+      yamlFilesPerc: 0,
       unitTests: 0,
     },
   };
 
   // Reconciliations
-  const reconciliationsNonEmpty = await listNonEmptyTemplates(
-    "reconciliationText"
-  );
+  const reconciliationsNonEmpty =
+    await listNonEmptyTemplates("reconciliationText");
   const reconciliationsExtMan = await listExternallyManagedTemplates(
     "reconciliationText",
     reconciliationsNonEmpty
   );
   const reconciliationsTests = await countYamlFiles("reconciliationText");
   summary.reconciliations.total = reconciliationsNonEmpty.length;
   summary.reconciliations.externallyManaged = reconciliationsExtMan.length;
+  summary.reconciliations.externallyManagedPerc = percentageRoundTwo(
+    summary.reconciliations.externallyManaged,
+    summary.reconciliations.total
+  );
   summary.reconciliations.yamlFiles = reconciliationsTests.files;
+  summary.reconciliations.yamlFilesPerc = percentageRoundTwo(
+    summary.reconciliations.yamlFiles,
+    summary.reconciliations.total
+  );
   summary.reconciliations.unitTests = reconciliationsTests.tests;
 
   // Shared Parts
@@ -211,6 +230,10 @@ async function getTemplatesSummary() {
   );
   summary.sharedParts.total = sharedPartsNonEmpty.length;
   summary.sharedParts.externallyManaged = sharedPartsExtMan.length;
+  summary.sharedParts.externallyManagedPerc = percentageRoundTwo(
+    summary.sharedParts.externallyManaged,
+    summary.sharedParts.total
+  );
 
   // Export Files
   const exportFilesNonEmpty = await listNonEmptyTemplates("exportFile");
@@ -220,19 +243,30 @@ async function getTemplatesSummary() {
   );
   summary.exportFiles.total = exportFilesNonEmpty.length;
   summary.exportFiles.externallyManaged = exportFilesExtMan.length;
+  summary.exportFiles.externallyManagedPerc = percentageRoundTwo(
+    summary.exportFiles.externallyManaged,
+    summary.exportFiles.total
+  );
 
   // Account Templates
-  const accountTemplatesNonEmpty = await listNonEmptyTemplates(
-    "accountTemplate"
-  );
+  const accountTemplatesNonEmpty =
+    await listNonEmptyTemplates("accountTemplate");
   const accountTemplatesExtMan = await listExternallyManagedTemplates(
     "accountTemplate",
     accountTemplatesNonEmpty
   );
   const accountTemplatesTests = await countYamlFiles("accountTemplate");
   summary.accountTemplates.total = accountTemplatesNonEmpty.length;
   summary.accountTemplates.externallyManaged = accountTemplatesExtMan.length;
+  summary.accountTemplates.externallyManagedPerc = percentageRoundTwo(
+    summary.accountTemplates.externallyManaged, 
+    summary.accountTemplates.total
+  );
   summary.accountTemplates.yamlFiles = accountTemplatesTests.files;
+  summary.accountTemplates.yamlFilesPerc = percentageRoundTwo(
+    summary.accountTemplates.yamlFiles,
+    summary.accountTemplates.total
+  );
   summary.accountTemplates.unitTests = accountTemplatesTests.tests;
 
   // All
@@ -246,8 +280,16 @@ async function getTemplatesSummary() {
     summary.sharedParts.externallyManaged +
     summary.exportFiles.externallyManaged +
     summary.accountTemplates.externallyManaged;
+  summary.all.externallyManagedPerc = percentageRoundTwo(
+    summary.all.externallyManaged,
+    summary.all.total
+  )
   summary.all.yamlFiles =
     summary.reconciliations.yamlFiles + summary.accountTemplates.yamlFiles;
+  summary.all.yamlFilesPerc = percentageRoundTwo(
+    summary.all.yamlFiles,
+    summary.all.total
+  );
   summary.all.unitTests =
     summary.reconciliations.unitTests + summary.accountTemplates.unitTests;
 
@@ -277,35 +319,35 @@ function displayOverview(sinceDate, today, templateSummary, yamlSummary) {
   consola.log(`${chalk.bold("Reconciliations:")}`);
   consola.log(`Templates: ${templateSummary.reconciliations.total}`);
   consola.log(
-    `Externally Managed: ${templateSummary.reconciliations.externallyManaged}`
+    `Externally Managed: ${templateSummary.reconciliations.externallyManaged} (${templateSummary.reconciliations.externallyManagedPerc}%)`
   );
-  consola.log(`YAML files: ${templateSummary.reconciliations.yamlFiles}`);
+  consola.log(`YAML files: ${templateSummary.reconciliations.yamlFiles} (${templateSummary.reconciliations.yamlFilesPerc}%)`);
   consola.log(`Unit Tests: ${templateSummary.reconciliations.unitTests}`);
   consola.log("");
   consola.log(`${chalk.bold("Account Templates:")}`);
   consola.log(`Templates: ${templateSummary.accountTemplates.total}`);
   consola.log(
-    `Externally Managed: ${templateSummary.accountTemplates.externallyManaged}`
+    `Externally Managed: ${templateSummary.accountTemplates.externallyManaged} (${templateSummary.accountTemplates.externallyManagedPerc}%)`
   );
-  consola.log(`YAML files: ${templateSummary.accountTemplates.yamlFiles}`);
+  consola.log(`YAML files: ${templateSummary.accountTemplates.yamlFiles} (${templateSummary.accountTemplates.yamlFilesPerc}%)`);
   consola.log(`Unit Tests: ${templateSummary.accountTemplates.unitTests}`);
   consola.log("");
   consola.log(`${chalk.bold("Shared Parts:")}`);
   consola.log(`Templates: ${templateSummary.sharedParts.total}`);
   consola.log(
-    `Externally Managed: ${templateSummary.sharedParts.externallyManaged}`
+    `Externally Managed: ${templateSummary.sharedParts.externallyManaged} (${templateSummary.sharedParts.externallyManagedPerc}%)`
   );
   consola.log("");
   consola.log(`${chalk.bold("Export Files:")}`);
   consola.log(`Templates: ${templateSummary.exportFiles.total}`);
   consola.log(
-    `Externally Managed: ${templateSummary.exportFiles.externallyManaged}`
+    `Externally Managed: ${templateSummary.exportFiles.externallyManaged} (${templateSummary.exportFiles.externallyManagedPerc}%)`
   );
   consola.log("");
   consola.log(`${chalk.bold("All:")}`);
   consola.log(`Templates: ${templateSummary.all.total}`);
-  consola.log(`Externally Managed: ${templateSummary.all.externallyManaged}`);
-  consola.log(`YAML files: ${templateSummary.all.yamlFiles}`);
+  consola.log(`Externally Managed: ${templateSummary.all.externallyManaged} (${templateSummary.all.externallyManagedPerc}%)`);
+  consola.log(`YAML files: ${templateSummary.all.yamlFiles} (${templateSummary.all.yamlFilesPerc}%)`);
   consola.log(`Unit Tests: ${templateSummary.all.unitTests}`);
   consola.log("");
   consola.log("------------------------------------");
@@ -334,6 +376,15 @@ function createRow(sinceDate, today, templateSummary, yamlSummary) {
     templateSummary.sharedParts.externallyManaged,
     templateSummary.exportFiles.total,
     templateSummary.exportFiles.externallyManaged,
+    templateSummary.all.externallyManagedPerc,
+    templateSummary.reconciliations.externallyManagedPerc,
+    templateSummary.accountTemplates.externallyManagedPerc,
+    templateSummary.sharedParts.externallyManagedPerc,
+    templateSummary.exportFiles.externallyManagedPerc,
+    templateSummary.all.yamlFilesPerc,
+    templateSummary.reconciliations.yamlFilesPerc,
+    templateSummary.accountTemplates.yamlFilesPerc,
+
   ];
   const row = `\r\n${rowContent.join(";")}`;
   return row;
@@ -362,6 +413,14 @@ function saveOverviewToFile(row) {
     "Shared Parts - externally managed",
     "Export Files - templates",
     "Export Files - externally managed",
+    "All - externally managed (%)",
+    "Reconciliations - externally managed (%)",
+    "Account Templates - externally managed (%)",
+    "Shared Parts - externally managed (%)",
+    "Export Files - externally managed (%)",
+    "All - yaml files (%)",
+    "Reconciliations - yaml files (%)",
+    "Account Templates - yaml files (%)",
   ];
   const ROW_HEADER = `${COLUMNS.join(";")}`;
   const CSV_PATH = `./stats/overview.csv`;