HTML Reports based on filter data

apps/frontend/src/components/global/ExportHTMLModal.vue

@@ -119,22 +119,60 @@ export default class ExportHTMLModal extends Vue {
     }
 
     const files = [];
+    const filteredOn = this.filter.status;
+
     for (const fileId of this.filter.fromFile) {
       const file = InspecDataModule.allEvaluationFiles.find(
         (f) => f.uniqueId === fileId
       );
+
       if (file) {
         const data = file.evaluation;
+
+        /**
+         * NOTE: The filterControls array is used to specify which
+         * controls are selected.
+         * If we use the approach of filtering the content from the data object
+         * (e.g.
+         *   data.data.profiles[0].controls =
+         *     data.data.profiles[0].controls.filter((control) => {
+         *       if (filteredControls.includes(control.id)) {
+         *         return filteredControls.includes(control.id);
+         *       }
+         *     });
+         * )
+         * the contextualize object does not get updated and the results
+         * in data_store get out of sync, there is when utilizing the
+         * ".contains" it returns ann results where the file.evaluations
+         * returns the filtered controls.
+         */
+        let filteredControls: string[] = [];
+        if (filteredOn!.length > 0) {
+          data.contains.map((profile) => {
+            profile.contains.map((result) => {
+              if (filteredOn?.includes(result.root.hdf.status)) {
+                filteredControls.push(result.data.id);
+              }
+            });
+          });
+        } else {
+          data.contains.map((profile) => {
+            profile.contains.map((result) => {
+              filteredControls.push(result.data.id);
+            });
+          });
+        }
+
         const fileName = file.filename;
         const fileID = file.uniqueId;
-        files.push({data, fileName, fileID});
+        files.push({data, fileName, fileID, filteredControls});
       }
     }
-
     // Generate and export HTML file
     const body = await new FromHDFToHTMLMapper(files, this.exportType).toHTML(
       '/static/export/'
     );
+
     saveAs(
       new Blob([s2ab(body)], {type: 'application/octet-stream'}),
       `${this.exportType}_Report_${new Date().toString()}.html`.replace(

libs/hdf-converters/package.json

@@ -75,4 +75,4 @@
       "^.+\\.ts$": "ts-jest"
     }
   }
-}
+}

libs/hdf-converters/src/converters-from-hdf/html/reverse-html-mapper.ts

@@ -29,12 +29,14 @@ type InputData = {
   data: ContextualizedEvaluation | string;
   fileName: string;
   fileID: string;
+  filteredControls: string[];
 };
 
 type ProcessedData = {
   data: ContextualizedEvaluation;
   fileName: string;
   fileID: string;
+  filteredControls: string[];
 };
 
 // All selectable export types for an HTML export
@@ -174,7 +176,12 @@ export class FromHDFToHTMLMapper {
       }
 
       this.addFiledata(
-        {data: file.data, fileName: file.fileName, fileID: file.fileID},
+        {
+          data: file.data,
+          fileName: file.fileName,
+          fileID: file.fileID,
+          filteredControls: file.filteredControls
+        },
         exportType
       );
     }
@@ -201,7 +208,11 @@ export class FromHDFToHTMLMapper {
     const allResultLevels: ContextualizedControl[] = [];
     file.data.contains.map((profile) => {
       profile.contains.map((result) => {
-        allResultLevels.push(result);
+        file.filteredControls.forEach((element) => {
+          if (element === result.data.id) {
+            allResultLevels.push(result);
+          }
+        });
       });
     });
 
@@ -310,7 +321,7 @@ export class FromHDFToHTMLMapper {
     };
 
     // Calculate & set compliance level and color from result statuses
-    // Set default complaince level and color
+    // Set default compliance level and color
     this.outputData.compliance.level = '0.00%';
     this.outputData.compliance.color = 'low';
 
@@ -324,7 +335,9 @@ export class FromHDFToHTMLMapper {
           100
       );
       // Set compliance level
-      this.outputData.compliance.level = complianceLevel;
+      this.outputData.compliance.level = complianceLevel.includes('NaN')
+        ? '0.00%'
+        : complianceLevel;
       // Determine color of compliance level
       // High compliance is green, medium is yellow, low is red
       this.outputData.compliance.color = translateCompliance(complianceLevel);
@@ -495,7 +508,7 @@ export class FromHDFToHTMLMapper {
     return text;
   }
 
-  // Prompt HTML generation from data pulled from file during constructor intialization
+  // Prompt HTML generation from data pulled from file during constructor initialization
   // Requires path to prompt location of needed files relative to function call location
   async toHTML(path: string): Promise<string> {
     // Pull export template + styles and create outputData object containing data to fill template with

libs/inspecjs/src/compat_wrappers.ts

@@ -109,12 +109,14 @@ export interface HDFControl {
    */
   parsedNistRevision: NistRevision | null;
 
-  /** Get the start time of this control's run, as determiend by the time of the first test.
+  /**
+   * Get the start time of this control's run, as determined by the time of the first test.
    * If no tests were run, (it is a profile-json or has no tests) returns undefined
    */
   start_time?: string;
 
-  /** Get the results of this control's control segments  as a list.
+  /**
+   * Get the results of this control's control segments  as a list.
    * If no tests were run, (this is a profile-json) returns undefined.
    * Can be empty in the rare case that no control segments exist/were run.
    */

libs/inspecjs/src/context.ts

@@ -1,5 +1,5 @@
 /**
- * Provides general utilities for articulating associations beteen evaluations, profiles, and controls.
+ * Provides general utilities for articulating associations between evaluations, profiles, and controls.
  * Especially useful for handling overlay/wrapper profiles.
  */
 
@@ -206,7 +206,7 @@ export function contextualizeEvaluation(
 
   // Link each contextualized control
   for (const cc of allControls) {
-    // Behaviour changes based on if we have well-formed or malformed profile dependency
+    // Behavior changes based on if we have well-formed or malformed profile dependency
     if (cc.sourcedFrom.extendsFrom.length || cc.sourcedFrom.extendedBy.length) {
       // Our profile is a baseline! No need to continue - children will make connections for us
       // If we aren't extended from something we just drop. Our children will make connections for us