@mitre/inspec-objects 0.0.30 → 0.0.32

package/lib/parsers/xccdf.js

@@ -40,7 +40,8 @@ exports.extractAllComplexChecks = extractAllComplexChecks;
 function ensureDecodedXMLStringValue(input) {
     return lodash_1.default.get(input, '[0].#text') ? lodash_1.default.get(input, '[0].#text') : input;
 }
-function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
+// Moving the newline removal to diff library rather than processXCCDF level
+function processXCCDF(xml, removeNewlines, useRuleId, ovalDefinitions) {
     const parsedXML = (0, xccdf_1.convertEncodedXmlIntoJson)(xml);
     const rules = extractAllRules(parsedXML.Benchmark[0].Group);
     const profile = new profile_1.default({
@@ -90,13 +91,15 @@ function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
                 control.id = rule.version;
                 break;
             case 'cis':
+                // eslint-disable-next-line  no-case-declarations
                 const controlIdRegex = /\d(\d?)(\d?)(\d?)(.\d(\d?)(\d?)(\d?))?(.\d(\d?)(\d?)(\d?))?(.\d(\d?)(\d?)(\d?))?(.\d(\d?)(\d?)(\d?))?/g;
+                // eslint-disable-next-line  no-case-declarations
                 const controlIdMatch = controlIdRegex.exec(rule['@_id']);
                 if (controlIdMatch) {
                     control.id = controlIdMatch[0];
                 }
                 else {
-                    throw new Error(`Could not parse control ID from rule ID: ${rule['@_id']}. Expecting format: 'xccdf_org.cisecurity.benchmarks_rule_1.1.11_Rule_title_summary`);
+                    throw new Error(`Could not parse control ID from rule ID: ${rule['@_id']}. Expecting something in this example format: 'xccdf_org.cisecurity.benchmarks_rule_1.1.11_Rule_title_summary`);
                 }
                 break;
             default:
@@ -146,7 +149,7 @@ function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
         }
         // Very CIS specific
         else if (rule['complex-check']) {
-            let checkTexts = [];
+            const checkTexts = [];
             for (const complexChecks of rule['complex-check']) {
                 const allComplexChecks = extractAllComplexChecks(complexChecks);
                 if (control.id === '1.1.1.5') {
@@ -225,7 +228,7 @@ function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
         control.tags.gid = rule.group['@_id'],
             control.tags.rid = rule['@_id'];
         control.tags.stig_id = rule['version'];
-        if (typeof rule.group.title === "string") {
+        if (typeof rule.group.title === 'string') {
             control.tags.gtitle = (0, xccdf_1.removeXMLSpecialCharacters)(rule.group.title);
         }
         else {
@@ -319,6 +322,7 @@ function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
                     if (typeof referenceText === 'string' && referenceText.indexOf('§') !== -1) {
                         const referenceParts = referenceText.split('§');
                         if (referenceParts.length == 2) {
+                            // eslint-disable-next-line  prefer-const
                             let [identifierType, identifier] = referenceText.split('§');
                             identifierType = identifierType.toLowerCase();
                             if (!(identifierType in control.tags)) {
@@ -332,7 +336,7 @@ function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
                             }
                         }
                         else {
-                            console.warn("Reference parts of invalid length:");
+                            console.warn('Reference parts of invalid length:');
                             console.log(referenceParts);
                         }
                     }

package/lib/utilities/diff.d.ts

@@ -1,9 +1,9 @@
-import Profile from "../objects/profile";
-import { ProfileDiff } from "../types/diff";
-import winston from "winston";
+import Profile from '../objects/profile';
+import { ProfileDiff } from '../types/diff';
+import winston from 'winston';
 export declare function removeNewlines(control?: Record<string, unknown>): Record<string, unknown>;
-export declare function simplifyDiff(diffData: Record<string, unknown>): Record<string, unknown>;
+export declare function ignoreFormattingDiff(diffData: Record<string, unknown>): Record<string, unknown>;
 export declare function diffProfile(fromProfile: Profile, toProfile: Profile, logger: winston.Logger): {
-    simplified: ProfileDiff;
-    originalDiff: Record<string, unknown>;
+    ignoreFormattingDiff: ProfileDiff;
+    rawDiff: Record<string, unknown>;
 };

package/lib/utilities/diff.js

@@ -1,49 +1,51 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.diffProfile = exports.simplifyDiff = exports.removeNewlines = void 0;
+exports.diffProfile = exports.ignoreFormattingDiff = exports.removeNewlines = void 0;
 const tslib_1 = require("tslib");
 const json_diff_1 = require("json-diff");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const update_1 = require("./update");
+const global_1 = require("./global");
 function removeNewlines(control) {
     if (!control) {
         return {};
     }
     return lodash_1.default.mapValues(control, (value) => {
-        if (typeof value === "string") {
-            return value.replace(/\n/g, "{{{{newlineHERE}}}}").trim();
+        if (typeof value === 'string') {
+            return value.replace(/\n/g, '{{{{newlineHERE}}}}').trim();
         }
-        else if (typeof value === "object" && value !== null) {
+        else if (typeof value === 'object' && value !== null) {
             return removeNewlines(value);
         }
         return value;
     });
 }
 exports.removeNewlines = removeNewlines;
-function simplifyDiff(diffData) {
+// Goal is to use a linter for the formatting and compare characters without whitespaces here
+function ignoreFormattingDiff(diffData) {
     return lodash_1.default.transform(diffData, (result, diffValue, key) => {
-        if (lodash_1.default.has(diffValue, "__new")) {
+        if (lodash_1.default.has(diffValue, '__new')) {
             // Remove any trailing space
-            if (typeof lodash_1.default.get(diffValue, "__new") === "string" &&
-                typeof lodash_1.default.get(diffValue, "__old") === "string") {
-                if (lodash_1.default.get(diffValue, "__new").trim() !==
-                    lodash_1.default.get(diffValue, "__old").trim()) {
-                    lodash_1.default.set(result, key, lodash_1.default.get(diffValue, "__new"));
+            if (typeof lodash_1.default.get(diffValue, '__new') === 'string' &&
+                typeof lodash_1.default.get(diffValue, '__old') === 'string') {
+                if ((0, global_1.removeWhitespace)(lodash_1.default.get(diffValue, '__new')) !==
+                    (0, global_1.removeWhitespace)(lodash_1.default.get(diffValue, '__old'))) {
+                    lodash_1.default.set(result, key, lodash_1.default.get(diffValue, '__new'));
                 }
             }
             else {
-                result[key] = lodash_1.default.get(diffValue, "__new");
+                result[key] = lodash_1.default.get(diffValue, '__new');
             }
         }
         else if (Array.isArray(diffValue)) {
             result[key] = diffValue
-                .map((value) => value[0] === "+" && value[1])
+                .map((value) => value[0] === '+' && value[1])
                 .filter((value) => value);
         }
-        else if (typeof diffValue === "object") {
-            result[key] = simplifyDiff(diffValue);
+        else if (typeof diffValue === 'object') {
+            result[key] = ignoreFormattingDiff(diffValue);
         }
-        else if (key.endsWith("__deleted")) {
+        else if (key.endsWith('__deleted')) {
             return undefined;
         }
         else {
@@ -51,19 +53,22 @@ function simplifyDiff(diffData) {
         }
     });
 }
-exports.simplifyDiff = simplifyDiff;
+exports.ignoreFormattingDiff = ignoreFormattingDiff;
 function diffProfile(fromProfile, toProfile, logger) {
+    var _a;
     const profileDiff = {
         addedControlIDs: [],
         removedControlIDs: [],
-        renamedControlIds: {},
+        renamedControlIDs: {},
+        changedControlIDs: [],
         addedControls: {},
         changedControls: {},
     };
     const originalDiff = {
         addedControlIDs: [],
         removedControlIDs: [],
-        renamedControlIds: {},
+        renamedControlIDs: {},
+        changedControlIDs: [],
         addedControls: {},
         changedControls: {},
     };
@@ -72,23 +77,30 @@ function diffProfile(fromProfile, toProfile, logger) {
         .sort();
     const toControlIDs = toProfile.controls.map((control) => control.id).sort();
     // Find new controls
-    const controlIDDiff = (0, json_diff_1.diff)(fromControlIDs, toControlIDs);
+    const controlIDDiff = (_a = (0, json_diff_1.diff)(fromControlIDs, toControlIDs)) === null || _a === void 0 ? void 0 : _a.filter((item) => !(item.length === 1 && item[0] === ' '));
     // Contains the new IDs
     const changedControlIds = [];
+    // a diffValue has an entry for both what was subtracted ("-")
+    // and what was added ("+") -- need to handle both
     controlIDDiff === null || controlIDDiff === void 0 ? void 0 : controlIDDiff.forEach((diffValue) => {
-        if (diffValue[0] === "-") {
+        if (diffValue[0] === '-') {
             const existingControl = fromProfile.controls.find((control) => control.id === diffValue[1]);
             // Check if the control has been given a new ID
             if (existingControl) {
                 const newControl = (0, update_1.findUpdatedControlByAllIdentifiers)(existingControl, toProfile.controls);
                 if (newControl && newControl.id !== existingControl.id) {
-                    profileDiff.renamedControlIds[existingControl.id] = newControl.id;
-                    originalDiff.renamedControlIds[existingControl.id] = newControl.id;
+                    profileDiff.renamedControlIDs[existingControl.id] = newControl.id;
+                    originalDiff.renamedControlIDs[existingControl.id] = newControl.id;
                     changedControlIds.push(newControl.id.toLowerCase());
-                    const controlDiff = lodash_1.default.omit((0, json_diff_1.diff)(existingControl, newControl), "code__deleted");
-                    profileDiff.changedControls[newControl.id] = simplifyDiff(controlDiff);
+                    const controlDiff = lodash_1.default.omit((0, json_diff_1.diff)(existingControl, newControl), 'code__deleted');
+                    // logger.info("CONTROL DIFF:" + JSON.stringify(controlDiff, null, 2))
+                    const renamedControlIgnoredFormatting = ignoreFormattingDiff(controlDiff);
+                    logger.info(JSON.stringify(renamedControlIgnoredFormatting));
+                    profileDiff.changedControls[newControl.id] = renamedControlIgnoredFormatting;
+                    profileDiff.changedControlIDs.push(newControl.id);
                     originalDiff.changedControls[newControl.id] = controlDiff;
-                    logger.verbose(`Control ${existingControl.id} has been upgraded to ${newControl.id}`);
+                    originalDiff.changedControlIDs.push(newControl.id);
+                    logger.verbose(`Control ${existingControl.id} has been updated to ${newControl.id}`);
                 }
                 else {
                     profileDiff.removedControlIDs.push(diffValue[1]);
@@ -99,11 +111,17 @@ function diffProfile(fromProfile, toProfile, logger) {
                 logger.error(`Unable to find existing control ${diffValue[1]}`);
             }
         }
-        else if (diffValue[0] === "+" && !changedControlIds.includes(diffValue[1].toLowerCase())) {
+        else if (diffValue[0] === '+' && !changedControlIds.includes(diffValue[1].toLowerCase()) && diffValue[1]) {
+            logger.info(JSON.stringify(diffValue));
+            logger.info(JSON.stringify(changedControlIds));
             profileDiff.addedControlIDs.push(diffValue[1]);
             originalDiff.addedControlIDs.push(diffValue[1]);
         }
     });
+    // take the list of renamed controls out of the list of added controls
+    // (a control is not "new" if it was renamed)
+    profileDiff.addedControlIDs = profileDiff.addedControlIDs.filter((item) => !Object.values(profileDiff.renamedControlIDs).includes(item));
+    originalDiff.addedControlIDs = originalDiff.addedControlIDs.filter((item) => !Object.values(originalDiff.renamedControlIDs).includes(item));
     // Add new controls to addedControls
     profileDiff.addedControlIDs.forEach((addedControl) => {
         const newControl = toProfile.controls.find((control) => addedControl === control.id);
@@ -116,13 +134,17 @@ function diffProfile(fromProfile, toProfile, logger) {
     for (const fromControl of fromProfile.controls) {
         const toControl = toProfile.controls.find((control) => control.id === fromControl.id);
         if (toControl) {
-            const controlDiff = lodash_1.default.omit((0, json_diff_1.diff)(fromControl, toControl), "code__deleted");
+            const controlDiff = lodash_1.default.omit((0, json_diff_1.diff)(fromControl, toControl), 'code__deleted');
             if (controlDiff) {
-                profileDiff.changedControls[toControl.id] = simplifyDiff(controlDiff);
+                // eslint-disable-next-line  @typescript-eslint/no-non-null-assertion
+                profileDiff.changedControls[toControl.id] = ignoreFormattingDiff(controlDiff);
+                profileDiff.changedControlIDs.push(toControl.id);
+                // eslint-disable-next-line  @typescript-eslint/no-non-null-assertion
                 originalDiff.changedControls[toControl.id] = controlDiff;
+                originalDiff.changedControlIDs.push(toControl.id);
             }
         }
     }
-    return { simplified: profileDiff, originalDiff: originalDiff };
+    return { ignoreFormattingDiff: profileDiff, rawDiff: originalDiff };
 }
 exports.diffProfile = diffProfile;

package/lib/utilities/diffMarkdown.d.ts

@@ -1,5 +1,5 @@
-import { ProfileDiff } from "../types/diff";
+import { ProfileDiff } from '../types/diff';
 export declare function createDiffMarkdown(diff: {
-    simplified: ProfileDiff;
-    originalDiff: any;
+    ignoreFormattingDiff: ProfileDiff;
+    rawDiff: any;
 }): string;

package/lib/utilities/diffMarkdown.js

@@ -5,13 +5,9 @@ const tslib_1 = require("tslib");
 const mustache_1 = tslib_1.__importDefault(require("mustache"));
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const automatticUpdateTemplate_json_1 = tslib_1.__importDefault(require("../resources/automatticUpdateTemplate.json"));
-function getUpdatedCheckForId(id, profile) {
-    const foundControl = profile.controls.find((control) => control.id === id);
-    return lodash_1.default.get(foundControl === null || foundControl === void 0 ? void 0 : foundControl.descs, "check") || "Missing check";
-}
 function createDiffMarkdown(diff) {
     const renderableDiffData = {
-        addedControls: Object.values(diff.simplified.addedControls),
+        addedControls: Object.values(diff.ignoreFormattingDiff.addedControls),
         hasRenamedControls: false,
         renamedControls: [],
         updatedChecks: [],
@@ -20,20 +16,20 @@ function createDiffMarkdown(diff) {
         updatedTitles: [],
         updatedDescriptions: [],
     };
-    Object.entries(diff.simplified.renamedControlIds).forEach(([oldId, newId]) => {
+    Object.entries(diff.ignoreFormattingDiff.renamedControlIDs).forEach(([oldId, newId]) => {
         renderableDiffData.hasRenamedControls = true;
         renderableDiffData.renamedControls.push({
             oldId: oldId,
             newId: newId,
         });
     });
-    Object.entries(diff.originalDiff.changedControls).forEach(([id, controlDiff]) => {
+    Object.entries(diff.rawDiff.changedControls).forEach(([id, controlDiff]) => {
         var _a, _b;
         if ((_a = controlDiff.descs) === null || _a === void 0 ? void 0 : _a.check) {
-            const oldCheck = lodash_1.default.get(controlDiff.descs.check, "__old");
-            const newCheck = lodash_1.default.get(controlDiff.descs.check, "__new");
-            if (oldCheck.replace(/\n/g, "").replace(/\W/g, "") !==
-                newCheck.replace(/\n/g, "").replace(/\W/g, "")) {
+            const oldCheck = lodash_1.default.get(controlDiff.descs.check, '__old');
+            const newCheck = lodash_1.default.get(controlDiff.descs.check, '__new');
+            if (oldCheck.replace(/\n/g, '').replace(/\W/g, '') !==
+                newCheck.replace(/\n/g, '').replace(/\W/g, '')) {
                 renderableDiffData.updatedChecks.push({
                     id: id,
                     old: oldCheck,
@@ -42,10 +38,10 @@ function createDiffMarkdown(diff) {
             }
         }
         if ((_b = controlDiff.descs) === null || _b === void 0 ? void 0 : _b.fix) {
-            const oldFix = lodash_1.default.get(controlDiff.descs.fix, "__old");
-            const newFix = lodash_1.default.get(controlDiff.descs.fix, "__new");
-            if (oldFix.replace(/\n/g, "").replace(/\W/g, "") !==
-                newFix.replace(/\n/g, "").replace(/\W/g, "")) {
+            const oldFix = lodash_1.default.get(controlDiff.descs.fix, '__old');
+            const newFix = lodash_1.default.get(controlDiff.descs.fix, '__new');
+            if (oldFix.replace(/\n/g, '').replace(/\W/g, '') !==
+                newFix.replace(/\n/g, '').replace(/\W/g, '')) {
                 renderableDiffData.updatedFixes.push({
                     id: id,
                     old: oldFix,
@@ -54,8 +50,8 @@ function createDiffMarkdown(diff) {
             }
         }
         if (controlDiff.impact) {
-            const oldImpact = lodash_1.default.get(controlDiff.impact, "__old");
-            const newImpact = lodash_1.default.get(controlDiff.impact, "__new");
+            const oldImpact = lodash_1.default.get(controlDiff.impact, '__old');
+            const newImpact = lodash_1.default.get(controlDiff.impact, '__new');
             if (oldImpact !== newImpact) {
                 renderableDiffData.updatedImpacts.push({
                     id: id,
@@ -65,8 +61,8 @@ function createDiffMarkdown(diff) {
             }
         }
         if (controlDiff.title) {
-            const oldTitle = lodash_1.default.get(controlDiff.title, "__old");
-            const newTitle = lodash_1.default.get(controlDiff.title, "__new");
+            const oldTitle = lodash_1.default.get(controlDiff.title, '__old');
+            const newTitle = lodash_1.default.get(controlDiff.title, '__new');
             if (oldTitle !== newTitle) {
                 renderableDiffData.updatedTitles.push({
                     id: id,
@@ -76,8 +72,8 @@ function createDiffMarkdown(diff) {
             }
         }
         if (controlDiff.desc) {
-            const oldDesc = lodash_1.default.get(controlDiff.desc, "__old");
-            const newDesc = lodash_1.default.get(controlDiff.desc, "__new");
+            const oldDesc = lodash_1.default.get(controlDiff.desc, '__old');
+            const newDesc = lodash_1.default.get(controlDiff.desc, '__new');
             if (oldDesc !== newDesc) {
                 renderableDiffData.updatedDescriptions.push({
                     id: id,

package/lib/utilities/global.d.ts

@@ -1,9 +1,7 @@
 export declare function wrap(s: string, lineLength?: number): string;
 export declare function unformatText(s: string): string;
-declare const escapeQuotes: (s: string) => string;
-declare const escapeDoubleQuotes: (s: string) => string;
-declare const wrapAndEscapeQuotes: (s: string, lineLength?: number) => string;
-export { escapeQuotes, escapeDoubleQuotes, wrapAndEscapeQuotes };
+export declare function removeWhitespace(input: string): string;
+export declare function escapeQuotes(s: string): string;
 export declare function removeNewlinePlaceholders(s: string): string;
 export declare function getFirstPath(object: Record<string, unknown>, paths: string[]): string;
 export declare function hasPath(file: Record<string, unknown>, path: string | string[]): boolean;

package/lib/utilities/global.js

@@ -1,23 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasPath = exports.getFirstPath = exports.removeNewlinePlaceholders = exports.wrapAndEscapeQuotes = exports.escapeDoubleQuotes = exports.escapeQuotes = exports.unformatText = exports.wrap = void 0;
+exports.hasPath = exports.getFirstPath = exports.removeNewlinePlaceholders = exports.escapeQuotes = exports.removeWhitespace = exports.unformatText = exports.wrap = void 0;
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 // Breaks lines down to lineLength number of characters
 function wrap(s, lineLength = 80) {
-    let newString = "";
-    let currentLine = "";
+    let newString = '';
     let currentLength = 0;
     let shouldBreakLine = false;
-    for (var i = 0; i < s.length; i++) {
+    for (let i = 0; i < s.length; i++) {
         if (shouldBreakLine) {
-            newString += `\n`;
+            newString += '\n';
             currentLength = 0;
             shouldBreakLine = false;
         }
-        let currentChar = s.charAt(i);
-        let nextChar = s.charAt(i + 1);
-        if (nextChar === " ") {
+        const currentChar = s.charAt(i);
+        const nextChar = s.charAt(i + 1);
+        if (nextChar === ' ') {
             if (currentLength >= lineLength) {
                 shouldBreakLine = true;
                 newString += currentChar;
@@ -36,16 +35,33 @@ function wrap(s, lineLength = 80) {
     return newString;
 }
 exports.wrap = wrap;
+// Remove new lines and tabs
 function unformatText(s) {
     return s.replace(/\n/g, ' ').replace(/\\n/g, ' ').replace(/( +|\t)/g, ' ');
 }
 exports.unformatText = unformatText;
-const escapeQuotes = (s) => s.replace(/\\/g, "\\\\").replace(/'/g, "\\'"); // Escape backslashes and quotes
+function removeWhitespace(input) {
+    return input.replace(/\s/gi, '');
+}
+exports.removeWhitespace = removeWhitespace;
+const escapeSingleQuotes = (s) => {
+    return s.replace(/\\/g, '\\\\').replace(/'/g, "\\'"); // Escape backslashes and quotes
+};
+const escapeDoubleQuotes = (s) => {
+    return s.replace(/\\/g, '\\\\').replace(/"/g, '\\"'); // Escape backslashes and double quotes
+};
+function escapeQuotes(s) {
+    if (s.includes("'") && s.includes('"')) {
+        return `%q(${removeNewlinePlaceholders(s)})`;
+    }
+    else if (s.includes("'")) {
+        return `"${escapeDoubleQuotes(removeNewlinePlaceholders(s))}"`;
+    }
+    else {
+        return `'${escapeSingleQuotes(removeNewlinePlaceholders(s))}'`;
+    }
+}
 exports.escapeQuotes = escapeQuotes;
-const escapeDoubleQuotes = (s) => s.replace(/\\/g, "\\\\").replace(/"/g, '\\"'); // Escape backslashes and double quotes
-exports.escapeDoubleQuotes = escapeDoubleQuotes;
-const wrapAndEscapeQuotes = (s, lineLength) => escapeDoubleQuotes(wrap(s, lineLength)); // Escape backslashes and quotes, and wrap long lines
-exports.wrapAndEscapeQuotes = wrapAndEscapeQuotes;
 function removeNewlinePlaceholders(s) {
     return s.replace(/\{\{\{\{newlineHERE\}\}\}\}/g, '\n');
 }

package/lib/utilities/logging.d.ts

@@ -1,2 +1,2 @@
-import winston from "winston";
+import winston from 'winston';
 export declare function createWinstonLogger(level?: string): winston.Logger;

package/lib/utilities/update.d.ts

@@ -1,4 +1,4 @@
-import winston from "winston";
+import winston from 'winston';
 import Control from '../objects/control';
 import Profile from '../objects/profile';
 import { ProfileDiff } from '../types/diff';
@@ -6,11 +6,12 @@ import { OvalDefinitionValue } from '../types/oval';
 export declare type UpdatedProfileReturn = {
     profile: Profile;
     diff: {
-        simplified: ProfileDiff;
-        originalDiff: Record<string, unknown>;
+        ignoreFormattingDiff: ProfileDiff;
+        rawDiff: Record<string, unknown>;
     };
     markdown: string;
 };
+export declare function getExistingDescribeFromControl(control: Control): string;
 export declare function findUpdatedControlByAllIdentifiers(existingControl: Control, updatedControls: Control[]): Control | undefined;
 export declare function updateControl(from: Control, update: Partial<Control>, logger: winston.Logger): Control;
 export declare function updateProfile(from: Profile, using: Profile, logger: winston.Logger): Omit<UpdatedProfileReturn, 'markdown'>;

package/lib/utilities/update.js

@@ -2,14 +2,13 @@
 // Utilities to update a profile or control with new metadata
 // The ultimate goal is to preserve all the metadata that is already there and only add what is new
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateProfileUsingXCCDF = exports.updateProfile = exports.updateControl = exports.findUpdatedControlByAllIdentifiers = void 0;
+exports.updateProfileUsingXCCDF = exports.updateProfile = exports.updateControl = exports.findUpdatedControlByAllIdentifiers = exports.getExistingDescribeFromControl = void 0;
 const tslib_1 = require("tslib");
 const lodash_1 = tslib_1.__importDefault(require("lodash"));
 const profile_1 = tslib_1.__importDefault(require("../objects/profile"));
 const xccdf_1 = require("../parsers/xccdf");
 const diff_1 = require("./diff");
 const diffMarkdown_1 = require("./diffMarkdown");
-const knownInSpecKeywords = ['title', 'desc', 'impact', 'ref', 'tag', "\""];
 function projectValuesOntoExistingObj(dst, src, currentPath = '') {
     for (const updatedValue in src) {
         const existingValue = lodash_1.default.get(dst, updatedValue);
@@ -32,65 +31,69 @@ function projectValuesOntoExistingObj(dst, src, currentPath = '') {
     }
     return dst;
 }
-// This is the most likely thing to break if you are getting code formatting issues.
-// Extract the existing describe blocks (what is actually run by inspec for validation)
+/*
+  Return first index found from given array that is not an empty entry (cell)
+*/
+function getIndexOfFirstLine(auditArray, index, action) {
+    let indexVal = index;
+    while (auditArray[indexVal] === '') {
+        switch (action) {
+            case '-':
+                indexVal--;
+                break;
+            case '+':
+                indexVal++;
+                break;
+        }
+    }
+    return indexVal;
+}
+/*
+  This is the most likely thing to break if you are getting code formatting issues.
+  Extract the existing describe blocks (what is actually run by inspec for validation)
+*/
 function getExistingDescribeFromControl(control) {
+    // Algorithm:
+    //   Locate the start and end of the control string
+    //   Update the end of the control that contains information (if empty lines are at the end of the control)
+    //   loop: until the start index is changed (loop is done from the bottom up)
+    //     Clean testing array entry line (removes any non-print characters)
+    //     if: line starts with meta-information 'tag' or 'ref'
+    //       set start index to found location
+    //       break out of the loop
+    //     end
+    //   end
+    //   Remove any empty lines after the start index (in any)
+    //   Extract the describe block from the audit control given the start and end indices
+    // Assumptions: 
+    //  1 - The meta-information 'tag' or 'ref' precedes the describe block
+    // Pros: Solves the potential issue with option 1, as the lookup for the meta-information
+    //       'tag' or 'ref' is expected to the at the beginning of the line.
     if (control.code) {
         let existingDescribeBlock = '';
-        let currentQuoteEscape = '';
-        let inQuoteBlock = false;
-        let inMetadataValueOverride = false;
-        let indentedMetadataOverride = false;
-        let inDescribeBlock = false;
-        let mostSpacesSeen = 0;
-        control.code.split('\n').forEach((line) => {
-            const wordSplit = line.trim().split(' ');
-            const spaces = line.substring(0, line.indexOf(wordSplit[0])).length;
-            if (spaces - mostSpacesSeen > 10) {
-                indentedMetadataOverride = true;
-            }
-            else {
-                mostSpacesSeen = spaces;
-                indentedMetadataOverride = false;
-            }
-            if ((!inQuoteBlock && !inMetadataValueOverride && !indentedMetadataOverride) || inDescribeBlock) {
-                // Get the number of spaces at the beggining of the current line
-                if (spaces >= 2) {
-                    const firstWord = wordSplit[0];
-                    if (knownInSpecKeywords.indexOf(firstWord.toLowerCase()) === -1 || (knownInSpecKeywords.indexOf(firstWord.toLowerCase()) !== -1 && spaces > 2) || inDescribeBlock) {
-                        inDescribeBlock = true;
-                        existingDescribeBlock += line + '\n';
-                    }
-                }
+        let indexStart = control.code.toLowerCase().indexOf('control');
+        let indexEnd = control.code.toLowerCase().trimEnd().lastIndexOf('end');
+        const auditControl = control.code.substring(indexStart, indexEnd).split('\n');
+        indexStart = 0;
+        indexEnd = auditControl.length - 1;
+        indexEnd = getIndexOfFirstLine(auditControl, indexEnd, '-');
+        let index = indexEnd;
+        while (indexStart === 0) {
+            const line = auditControl[index].toLowerCase().trim();
+            if (line.indexOf('ref') === 0 || line.indexOf('tag') === 0) {
+                indexStart = index + 1;
             }
-            wordSplit.forEach((word, index) => {
-                const charSplit = word.split('');
-                charSplit.forEach((char, index) => {
-                    if (char === '"' && charSplit[index - 1] !== '\\') {
-                        if (!currentQuoteEscape || !inQuoteBlock) {
-                            currentQuoteEscape = '"';
-                        }
-                        if (currentQuoteEscape === '"') {
-                            inQuoteBlock = !inQuoteBlock;
-                        }
-                    }
-                    else if (char === "'" && charSplit[index - 1] !== '\\') {
-                        if (!currentQuoteEscape || !inQuoteBlock) {
-                            currentQuoteEscape = "'";
-                        }
-                        if (currentQuoteEscape === "'") {
-                            inQuoteBlock = !inQuoteBlock;
-                        }
-                    }
-                });
-            });
-        });
+            index--;
+        }
+        indexStart = getIndexOfFirstLine(auditControl, indexStart, '+');
+        existingDescribeBlock = auditControl.slice(indexStart, indexEnd + 1).join('\n').toString();
         return existingDescribeBlock;
     }
     else {
         return '';
     }
 }
+exports.getExistingDescribeFromControl = getExistingDescribeFromControl;
 function findUpdatedControlByAllIdentifiers(existingControl, updatedControls) {
     // Try to match based on IDs
     let updatedControl = updatedControls.find((updatedControl) => {
@@ -127,8 +130,8 @@ function updateProfile(from, using, logger) {
     // Find the diff
     const diff = (0, diff_1.diffProfile)(from, using, logger);
     // Add the new controls
-    diff.simplified.addedControlIDs.forEach(id => {
-        const addedControl = diff.simplified.addedControls[id];
+    diff.ignoreFormattingDiff.addedControlIDs.forEach(id => {
+        const addedControl = diff.ignoreFormattingDiff.addedControls[id];
         if (addedControl) {
             logger.debug(`New Control: ${addedControl.id} - ${addedControl.title}`);
             to.controls.push(addedControl);
@@ -141,7 +144,7 @@ function updateProfile(from, using, logger) {
     for (const existingControl of from.controls) {
         const updatedControl = findUpdatedControlByAllIdentifiers(existingControl, using.controls);
         if (updatedControl) {
-            const controlDiff = diff.simplified.changedControls[updatedControl.id];
+            const controlDiff = diff.ignoreFormattingDiff.changedControls[updatedControl.id];
             if (controlDiff) {
                 to.controls.push(updateControl(existingControl, controlDiff, logger));
             }

package/lib/utilities/xccdf.js

@@ -25,7 +25,6 @@ function removeXMLSpecialCharacters(str) {
     return he_1.default.decode(str);
 }
 exports.removeXMLSpecialCharacters = removeXMLSpecialCharacters;
-;
 function severityStringToImpact(string, id) {
     var _a, _b, _c, _d, _e;
     if ((_a = string.match(/none|na|n\/a|not[\s()*_|]?applicable/i)) === null || _a === void 0 ? void 0 : _a.length) {