@mitre/inspec-objects 0.0.31 → 0.0.34

package/lib/parsers/xccdf.js

@@ -41,7 +41,7 @@ function ensureDecodedXMLStringValue(input) {
     return lodash_1.default.get(input, '[0].#text') ? lodash_1.default.get(input, '[0].#text') : input;
 }
 // Moving the newline removal to diff library rather than processXCCDF level
-function processXCCDF(xml, removeNewlines = false, useRuleId, ovalDefinitions) {
+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({
@@ -91,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:
@@ -147,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') {
@@ -226,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 {
@@ -320,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)) {
@@ -333,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,6 +1,6 @@
-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 ignoreFormattingDiff(diffData: Record<string, unknown>): Record<string, unknown>;
 export declare function diffProfile(fromProfile: Profile, toProfile: Profile, logger: winston.Logger): {

package/lib/utilities/diff.js

@@ -11,10 +11,10 @@ function removeNewlines(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;
@@ -24,28 +24,28 @@ exports.removeNewlines = removeNewlines;
 // 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 ((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"));
+            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") {
+        else if (typeof diffValue === 'object') {
             result[key] = ignoreFormattingDiff(diffValue);
         }
-        else if (key.endsWith("__deleted")) {
+        else if (key.endsWith('__deleted')) {
             return undefined;
         }
         else {
@@ -77,13 +77,13 @@ function diffProfile(fromProfile, toProfile, logger) {
         .sort();
     const toControlIDs = toProfile.controls.map((control) => control.id).sort();
     // Find new controls
-    const controlIDDiff = (_a = (0, json_diff_1.diff)(fromControlIDs, toControlIDs)) === null || _a === void 0 ? void 0 : _a.filter((item) => !(item.length === 1 && item[0] === " "));
+    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) {
@@ -92,7 +92,7 @@ function diffProfile(fromProfile, toProfile, logger) {
                     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");
+                    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));
@@ -111,7 +111,7 @@ function diffProfile(fromProfile, toProfile, logger) {
                 logger.error(`Unable to find existing control ${diffValue[1]}`);
             }
         }
-        else if (diffValue[0] === "+" && !changedControlIds.includes(diffValue[1].toLowerCase()) && diffValue[1]) {
+        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]);
@@ -134,10 +134,12 @@ 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) {
+                // 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);
             }

package/lib/utilities/diffMarkdown.d.ts

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

package/lib/utilities/diffMarkdown.js

@@ -5,10 +5,6 @@ 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.ignoreFormattingDiff.addedControls),
@@ -30,10 +26,10 @@ function createDiffMarkdown(diff) {
     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,10 +1,7 @@
 export declare function wrap(s: string, lineLength?: number): string;
 export declare function unformatText(s: string): string;
 export declare function removeWhitespace(input: 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 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.removeWhitespace = 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,6 +35,7 @@ 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, ' ');
 }
@@ -44,12 +44,24 @@ function removeWhitespace(input) {
     return input.replace(/\s/gi, '');
 }
 exports.removeWhitespace = removeWhitespace;
-const escapeQuotes = (s) => s.replace(/\\/g, "\\\\").replace(/'/g, "\\'"); // Escape backslashes and quotes
+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';
@@ -11,6 +11,7 @@ export declare type UpdatedProfileReturn = {
     };
     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,101 +31,179 @@ 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)
-function getExistingDescribeFromControl(control) {
-    if (control.code) {
-        let existingDescribeBlock = '';
-        let currentQuoteEscape = '';
-        let percentBlockRegexp = /%[qQriIwWxs]?(?<lDelimiter>[\(\[\{\<])/;
-        let inPercentBlock = false;
-        let inQuoteBlock = false;
-        let inMetadataValueOverride = false;
-        let indentedMetadataOverride = false;
-        let inDescribeBlock = false;
-        let mostSpacesSeen = 0;
-        let lDelimiter = '(';
-        let rDelimiter = ')';
-        control.code.split('\n').forEach((line) => {
-            const wordArray = line.trim().split(' ');
-            const spaces = line.substring(0, line.indexOf(wordArray[0])).length;
-            if (spaces - mostSpacesSeen > 10) {
-                indentedMetadataOverride = true;
+function getRangesForLines(text) {
+    /*
+      Returns an array containing two numerical indices (i.e., start and stop
+      line numbers) for each string or multi-line comment, given raw text as
+      an input parameter. The raw text is a string containing the entirety of an
+      InSpec control.
+  
+      Algorithm utilizes a pair of stacks (i.e., `stack`, `rangeStack`) to keep
+      track of string delimiters and their associated line numbers, respectively.
+  
+      Combinations Handled:
+      - Single quotes (')
+      - Double quotes (")
+      - Back ticks (`)
+      - Mixed quotes ("`'")
+      - Percent strings (%; keys: q, Q, r, i, I, w, W, x; delimiters: (), {},
+        [], <>, most non-alphanumeric characters); (e.g., "%q()")
+      - Percent literals (%; delimiters: (), {}, [], <>, most non-
+        alphanumeric characters); (e.g., "%()")
+      - Multi-line comments (e.g., =begin\nSome comment\n=end)
+      - Variable delimiters (i.e., paranthesis: (); array: []; hash: {})
+    */
+    const stringDelimiters = { '(': ')', '{': '}', '[': ']', '<': '>' };
+    const variableDelimiters = { '(': ')', '{': '}', '[': ']' };
+    const quotes = '\'"`';
+    const strings = 'qQriIwWxs';
+    let skipCharLength;
+    (function (skipCharLength) {
+        skipCharLength[skipCharLength["string"] = '('.length] = "string";
+        skipCharLength[skipCharLength["percentString"] = 'q('.length] = "percentString";
+        skipCharLength[skipCharLength["commentBegin"] = '=begin'.length] = "commentBegin";
+    })(skipCharLength || (skipCharLength = {}));
+    const stack = [];
+    const rangeStack = [];
+    const ranges = [];
+    const lines = text.split('\n');
+    for (let i = 0; i < lines.length; i++) {
+        let j = 0;
+        while (j < lines[i].length) {
+            const line = lines[i];
+            let char = line[j];
+            const isEmptyStack = (stack.length == 0);
+            const isNotEmptyStack = (stack.length > 0);
+            const isQuoteChar = quotes.includes(char);
+            const isNotEscapeChar = ((j == 0) || (j > 0 && line[j - 1] != '\\'));
+            const isPercentChar = (char == '%');
+            const isVariableDelimiterChar = Object.keys(variableDelimiters).includes(char);
+            const isStringDelimiterChar = ((j < line.length - 1) && (/^[^A-Za-z0-9]$/.test(line[j + 1])));
+            const isCommentBeginChar = ((j == 0) && (line.length >= 6) && (line.slice(0, 6) == '=begin'));
+            const isPercentStringKeyChar = ((j < line.length - 1) && (strings.includes(line[j + 1])));
+            const isPercentStringDelimiterChar = ((j < line.length - 2) && (/^[^A-Za-z0-9]$/.test(line[j + 2])));
+            const isPercentString = (isPercentStringKeyChar && isPercentStringDelimiterChar);
+            let baseCondition = (isEmptyStack && isNotEscapeChar);
+            const quotePushCondition = (baseCondition && isQuoteChar);
+            const variablePushCondition = (baseCondition && isVariableDelimiterChar);
+            const stringPushCondition = (baseCondition && isPercentChar && isStringDelimiterChar);
+            const percentStringPushCondition = (baseCondition && isPercentChar && isPercentString);
+            const commentBeginCondition = (baseCondition && isCommentBeginChar);
+            if (stringPushCondition) {
+                j += skipCharLength.string; // j += 1
             }
-            else {
-                mostSpacesSeen = spaces;
-                indentedMetadataOverride = false;
+            else if (percentStringPushCondition) {
+                j += skipCharLength.percentString; // j += 2
             }
-            if ((!inPercentBlock && !inQuoteBlock && !inMetadataValueOverride && !indentedMetadataOverride) || inDescribeBlock) {
-                if (inDescribeBlock && wordArray.length === 1 && wordArray.includes('')) {
-                    existingDescribeBlock += '\n';
-                }
-                // Get the number of spaces at the beginning of the current line
-                else if (spaces >= 2) {
-                    const firstWord = wordArray[0];
-                    if (knownInSpecKeywords.indexOf(firstWord.toLowerCase()) === -1 || (knownInSpecKeywords.indexOf(firstWord.toLowerCase()) !== -1 && spaces > 2) || inDescribeBlock) {
-                        inDescribeBlock = true;
-                        existingDescribeBlock += line + '\n';
-                    }
+            else if (commentBeginCondition) {
+                j += skipCharLength.commentBegin; // j += 6
+            }
+            char = line[j];
+            baseCondition = (isNotEmptyStack && isNotEscapeChar);
+            const delimiterCondition = (baseCondition && Object.keys(stringDelimiters).includes(stack[stack.length - 1]));
+            const delimiterPushCondition = (delimiterCondition && (stack[stack.length - 1] == char));
+            const delimiterPopCondition = (delimiterCondition && (stringDelimiters[stack[stack.length - 1]] == char));
+            const basePopCondition = (baseCondition && (stack[stack.length - 1] == char) && !Object.keys(stringDelimiters).includes(char));
+            const isCommentEndChar = ((j == 0) && (line.length >= 4) && (line.slice(0, 4) == '=end'));
+            const commentEndCondition = (baseCondition && isCommentEndChar && (stack[stack.length - 1] == '=begin'));
+            const popCondition = (basePopCondition || delimiterPopCondition || commentEndCondition);
+            const pushCondition = (quotePushCondition || variablePushCondition || stringPushCondition ||
+                percentStringPushCondition || delimiterPushCondition || commentBeginCondition);
+            if (popCondition) {
+                stack.pop();
+                rangeStack[rangeStack.length - 1].push(i);
+                const range_ = rangeStack.pop();
+                if (rangeStack.length == 0) {
+                    ranges.push(range_);
                 }
             }
-            wordArray.forEach((word, index) => {
-                //console.log(`LDELIMITER:   \"${lDelimiter}\"   RDELIMITER:   \"${rDelimiter}\"`)
-                let percentBlockMatch = percentBlockRegexp.exec(word);
-                if (percentBlockMatch && inPercentBlock === false) {
-                    inPercentBlock = true;
-                    lDelimiter = percentBlockMatch.groups.lDelimiter || '(';
-                    switch (lDelimiter) {
-                        case '{': {
-                            rDelimiter = '}';
-                            break;
-                        }
-                        case '[': {
-                            rDelimiter = ']';
-                            break;
-                        }
-                        case '<': {
-                            rDelimiter = '>';
-                            break;
-                        }
-                        default: {
-                            break;
-                        }
-                    }
+            else if (pushCondition) {
+                if (commentBeginCondition) {
+                    stack.push('=begin');
                 }
-                const charArray = word.split('');
-                charArray.forEach((char, index) => {
-                    if (inPercentBlock) {
-                        if (char === rDelimiter && charArray[index - 1] !== '\\' && !inQuoteBlock) {
-                            inPercentBlock = false;
-                        }
-                    }
-                    if (char === '"' && charArray[index - 1] !== '\\') {
-                        if (!currentQuoteEscape || !inQuoteBlock) {
-                            currentQuoteEscape = '"';
-                        }
-                        if (currentQuoteEscape === '"') {
-                            inQuoteBlock = !inQuoteBlock;
-                        }
-                    }
-                    else if (char === "'" && charArray[index - 1] !== '\\') {
-                        if (!currentQuoteEscape || !inQuoteBlock) {
-                            currentQuoteEscape = "'";
-                        }
-                        if (currentQuoteEscape === "'") {
-                            inQuoteBlock = !inQuoteBlock;
-                        }
-                    }
-                });
-            });
-        });
-        // Take off the extra newline at the end
-        return existingDescribeBlock.slice(0, -1);
+                else {
+                    stack.push(char);
+                }
+                rangeStack.push([i]);
+            }
+            j++;
+        }
+    }
+    return ranges;
+}
+function joinMultiLineStringsFromRanges(text, ranges) {
+    /*
+      Returns an array of strings and joined strings at specified ranges, given
+      raw text as an input parameter.
+    */
+    const originalLines = text.split('\n');
+    const joinedLines = [];
+    let i = 0;
+    while (i < originalLines.length) {
+        let foundInRanges = false;
+        for (const [startIndex, stopIndex] of ranges) {
+            if (i >= startIndex && i <= stopIndex) {
+                joinedLines.push(originalLines.slice(startIndex, stopIndex + 1).join('\n'));
+                foundInRanges = true;
+                i = stopIndex;
+                break;
+            }
+        }
+        if (!foundInRanges) {
+            joinedLines.push(originalLines[i]);
+        }
+        i++;
+    }
+    return joinedLines;
+}
+function getMultiLineRanges(ranges) {
+    /*
+      Drops ranges with the same start and stop line numbers (i.e., strings
+      that populate a single line)
+    */
+    const multiLineRanges = [];
+    for (const [start, stop] of ranges) {
+        if (start !== stop) {
+            multiLineRanges.push([start, stop]);
+        }
+    }
+    return multiLineRanges;
+}
+/*
+  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) {
+    if (control.code) {
+        // Join multi-line strings in InSpec control.
+        const ranges = getRangesForLines(control.code);
+        const multiLineRanges = getMultiLineRanges(ranges);
+        const lines = joinMultiLineStringsFromRanges(control.code, multiLineRanges); // Array of lines representing the full InSpec control, with multi-line strings collapsed
+        // Define RegExp for lines to skip when searching for describe block.
+        const skip = ['control\\W', '  title\\W', '  desc\\W', '  impact\\W', '  tag\\W', '  ref\\W'];
+        const skipRegExp = RegExp(skip.map(x => `(^${x})`).join('|'));
+        // Extract describe block from InSpec control with collapsed multiline strings.
+        const describeBlock = [];
+        let ignoreNewLine = true;
+        for (const line of lines) {
+            const checkRegExp = ((line.trim() !== '') && !skipRegExp.test(line));
+            const checkNewLine = ((line.trim() === '') && !ignoreNewLine);
+            // Include '\n' if it is part of describe block, otherwise skip line.
+            if (checkRegExp || checkNewLine) {
+                describeBlock.push(line);
+                ignoreNewLine = false;
+            }
+            else {
+                ignoreNewLine = true;
+            }
+        }
+        return describeBlock.slice(0, describeBlock.length - 2).join('\n'); // Drop trailing ['end', '\n'] from Control block.
     }
     else {
         return '';
     }
 }
+exports.getExistingDescribeFromControl = getExistingDescribeFromControl;
 function findUpdatedControlByAllIdentifiers(existingControl, updatedControls) {
     // Try to match based on IDs
     let updatedControl = updatedControls.find((updatedControl) => {