HTML Export Support

README.md

@@ -45,6 +45,7 @@ For detailed information about development, testing , and contributing to the SA
       * [HDF to Checklist](#hdf-to-checklist)
       * [HDF to CSV](#hdf-to-csv)
       * [HDF to Condensed JSON](#hdf-to-condensed-json)
+      * [HDF to HTML](#hdf-to-html)
 
 ### Convert Other Formats to HDF
 
@@ -538,6 +539,38 @@ convert hdf2condensed         Condensed format used by some community members
     $ saf convert hdf2condensed -i rhel7-results.json -o rhel7-condensed.json
 ```
 [top](#convert-hdf-to-other-formats)
+#### HDF to HTML
+```
+convert hdf2html             Translate an HDF file into a Heimdall Report HTML file
+
+  USAGE
+    $ saf convert hdf2html -i <hdf-scan-results-json>... -o <output-html> [-t <output-type>] [-h]
+
+  FLAGS
+    -h, --help
+        Show CLI help.
+
+    -i, --input=<value>...
+        (required) Input HDF JSON file
+
+    -o, --output=<value>
+        (required) Output HTML file
+
+    -t, --type=<option>
+        [default: Administrator] The report type to generate
+        Report types differ with the information they include
+        Executive: Profile Info + Statuses + Compliance Level
+        Manager: Executive + Test Results and Details
+        Administrator: Manager + Test Code
+        <options: executive|manager|administrator>
+
+  DESCRIPTION
+    Translate an HDF file into a Heimdall Report HTML file
+
+  EXAMPLES
+    $ saf convert hdf2html -i hdf_input.json -o report.html -t manager 
+```
+[top](#convert-hdf-to-other-formats)
 
 ---
 ### Convert To HDF

src/commands/convert/hdf2html.ts

@@ -0,0 +1,48 @@
+import { Command, Flags } from '@oclif/core';
+import fs from 'fs';
+import path from 'path';
+import { FromHDFToHTMLMapper as Mapper } from '@mitre/hdf-converters';
+import _ from 'lodash';
+
+// All selectable export types for an HTML export
+enum FileExportTypes {
+  Executive = 'Executive',
+  Manager = 'Manager',
+  Administrator = 'Administrator',
+}
+
+export default class HDF2HTML extends Command {
+  static usage = 'convert hdf2html -i <hdf-scan-results-json>... -o <output-html> [-t <output-type>] [-h]';
+
+  static description = 'Translate an HDF file into a Heimdall Report HTML file';
+
+  static examples = ['saf convert hdf2html -i hdf_input.json -o report.html -t manager'];
+
+  static flags = {
+    help: Flags.help({ char: 'h' }),
+    input: Flags.string({ char: 'i', required: true, multiple: true, description: 'Input HDF JSON file' }),
+    output: Flags.string({ char: 'o', required: true, description: 'Output HTML file' }),
+    type: Flags.string({ char: 't', default: FileExportTypes.Administrator,
+      description: 'The report type to generate\nReport types differ with the information they include\nExecutive: Profile Info + Statuses + Compliance Level\nManager: Executive + Test Results and Details\nAdministrator: Manager + Test Code',
+      options: ['executive', 'manager', 'administrator'] }),
+  };
+
+  async run() {
+    const { flags } = await this.parse(HDF2HTML);
+
+    const files = [];
+
+    let i = 0;
+    for (const file of flags.input) {
+      // Create unique fileID for html reference
+      const fileID = `${i++}`;
+
+      const data = fs.readFileSync(file, 'utf8');
+      const fileName = path.basename(file);
+      files.push({ data, fileName, fileID });
+    }
+
+    const converter = await new Mapper(files, _.startCase(flags.type) as FileExportTypes).toHTML();
+    fs.writeFileSync(flags.output, converter);
+  }
+}

src/commands/convert/splunk2hdf.ts

@@ -1,5 +1,5 @@
 import { Flags } from '@oclif/core';
-import { SplunkMapper } from '@mitre/hdf-converters/lib/src/splunk-mapper';
+import { SplunkMapper } from '@mitre/hdf-converters';
 import { table } from 'table';
 import _ from 'lodash';
 import fs from 'fs';

test/commands/convert/hdf2html.test.ts

@@ -0,0 +1,65 @@
+import { runCommand } from '@oclif/test';
+import fs from 'fs';
+import path from 'path';
+import tmp from 'tmp';
+import { describe, expect, it } from 'vitest';
+import { omitHtmlChangingfields as omitHtmlChangingFields } from '../utils';
+
+// describe('Test hdf2html triple_overlay_profile_example with default (administrator) report type', () => {
+//   const tmpobj = tmp.dirSync({ unsafeCleanup: true });
+//
+//   it('hdf-converter output test', async () => {
+//     await runCommand<{ name: string }>([
+//       'convert hdf2html',
+//       '-i', path.resolve('./test/sample_data/HDF/input/triple_overlay_profile_example.json'),
+//       '-o', `${tmpobj.name}/triple_overlay_profile_example.html`,
+//     ]);
+//     const converted = omitHtmlChangingFields(fs.readFileSync(`${tmpobj.name}/triple_overlay_profile_example.html`, 'utf8'));
+//     const sample = omitHtmlChangingFields(fs.readFileSync(path.resolve('./test/sample_data/html/triple_overlay_profile_example.html'), 'utf8'));
+//     expect(converted).to.eql(sample);
+//   });
+// });
+
+// describe('Test hdf2html with manager report type and two input files', () => {
+//   const tmpobj = tmp.dirSync({ unsafeCleanup: true });
+//
+//   it('hdf-converter output test', async () => {
+//     await runCommand<{ name: string }>([
+//       'convert hdf2html',
+//       '-i', path.resolve('./test/sample_data/HDF/input/red_hat_good.json'), path.resolve('./test/sample_data/HDF/input/vSphere8_report.json'),
+//       '-o', `${tmpobj.name}/combined_output.html`, '-t', 'manager',
+//     ]);
+//     const converted = omitHtmlChangingFields(fs.readFileSync(`${tmpobj.name}/combined_output.html`, 'utf8'));
+//     const sample = omitHtmlChangingFields(fs.readFileSync(path.resolve('./test/sample_data/html/combined_output.html'), 'utf8'));
+//     expect(converted).to.eql(sample);
+//   });
+// });
+
+// describe('Test hdf2html with executive report type', () => {
+//   const tmpobj = tmp.dirSync({ unsafeCleanup: true });
+//
+//   it('hdf-converter output test', async () => {
+//     await runCommand<{ name: string }>([
+//       'convert hdf2html',
+//       '-i', path.resolve('./test/sample_data/HDF/input/red_hat_good.json'),
+//       '-o', `${tmpobj.name}/red_hat_good.html`, '-t', 'executive']);
+//     const converted = omitHtmlChangingFields(fs.readFileSync(`${tmpobj.name}/red_hat_good.html`, 'utf8'));
+//     const sample = omitHtmlChangingFields(fs.readFileSync(path.resolve('./test/sample_data/html/red_hat_good.html'), 'utf8'));
+//     expect(converted).to.eql(sample);
+//   });
+// });
+
+describe('Test hdf2html sonarqube with default (administrator) report type', () => {
+  const tmpobj = tmp.dirSync({ unsafeCleanup: true });
+
+  it('hdf-converter output test', async () => {
+    await runCommand<{ name: string }>([
+      'convert hdf2html',
+      '-i', path.resolve('./test/sample_data/sonarqube/sonarqube-hdf.json'),
+      '-o', `${tmpobj.name}/sonarqube-hdf.html`,
+    ]);
+    const converted = omitHtmlChangingFields(fs.readFileSync(`${tmpobj.name}/sonarqube-hdf.html`, 'utf8'));
+    const sample = omitHtmlChangingFields(fs.readFileSync(path.resolve('./test/sample_data/html/sonarqube-hdf.html'), 'utf8'));
+    expect(converted).to.eql(sample);
+  });
+});

test/commands/utils.ts

@@ -33,3 +33,8 @@ export function omitChecklistChangingFields(input: string) {
   return input.replaceAll(/[0-9a-fA-F]{8}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{4}\b-[0-9a-fA-F]{12}/gm, '')
     .replace(/<!--Heimdall Version :: \S+-->/, '');
 }
+
+export function omitHtmlChangingfields(input: string) {
+  return input.replace(/(tailwindcss .+ \|)/, 'TAILWIND VERSION')
+    .replace(/TW Elements \d+\.\d+\.\d+/, 'TW ELEMENTS VERSION');
+}