Fix #117 Prevent getHeredocs() from considering <<< as a heredoc

Signed-off-by: Remy Suen <remy.suen@gmail.com>
rcjsuen · Nov 10, 2024 · bc51eea · bc51eea
1 parent f0bdecf
commit bc51eea
Show file tree

Hide file tree

Showing 4 changed files with 26 additions and 16 deletions.
diff --git a/src/instruction.ts b/src/instruction.ts
@@ -652,7 +652,7 @@ export class Instruction extends Line {
         // instruction only on one line, if heredocs exist they would be incomplete
         for (const arg of args) {
             const value = arg.getValue();
-            if (value.startsWith("<<")) {
+            if (value.startsWith("<<") && Util.parseHeredocName(value) !== null) {
                 const startRange = arg.getRange();
                 const nameRange = this.getNameRange(startRange);
                 const name = this.getName(nameRange);

diff --git a/src/parser.ts b/src/parser.ts
@@ -315,20 +315,6 @@ export class Parser {
         return this.buffer.length;
     }
 
-    private parseHeredocName(value: string): string | null {
-        value = value.substring(2);
-        if (value.charAt(0) === '-') {
-            value = value.substring(1);
-        }
-        if (value.charAt(0) === '"' || value.charAt(0) === '\'') {
-            value = value.substring(1, value.length - 1);
-        }
-        if (value.charAt(0) === "<") {
-            return null;
-        }
-        return value;
-    }
-
     private processHeredocs(instruction: Instruction, offset: number): number {
         let keyword = instruction.getKeyword();
         if (keyword === Keyword.ONBUILD) {
@@ -345,7 +331,7 @@ export class Parser {
         for (const arg of instruction.getArguments()) {
             const value = arg.getValue();
             if (value.startsWith("<<") && value.length > 2) {
-                const name = this.parseHeredocName(value);
+                const name = Util.parseHeredocName(value);
                 if (name !== null) {
                     heredocs.push(name);
                 }

diff --git a/src/util.ts b/src/util.ts
@@ -71,4 +71,18 @@ export class Util {
         }
         return range.start.line < position.line && position.line < range.end.line;
     }
+
+    public static parseHeredocName(value: string): string | null {
+        value = value.substring(2);
+        if (value.charAt(0) === '-') {
+            value = value.substring(1);
+        }
+        if (value.charAt(0) === '"' || value.charAt(0) === '\'') {
+            value = value.substring(1, value.length - 1);
+        }
+        if (value.charAt(0) === "<") {
+            return null;
+        }
+        return value;
+    }
 }
diff --git a/test/heredoc.test.ts b/test/heredoc.test.ts
@@ -417,6 +417,16 @@ describe("Heredoc", () => {
                     assert.strictEqual(heredocs[0].getDelimiterRange(), null);
                 });
 
+                /**
+                 * RUN <<<EOT
+                 * <EOT
+                 */
+                it(`${keyword} <<<EOT\\n<EOT`, () => {
+                    const instruction = DockerfileParser.parse(`${keyword}  <<<EOT\n<EOT`).getInstructions()[0];
+                    const heredocs = heredocsExtractor(instruction);
+                    assert.strictEqual(heredocs.length, 0);
+                });
+
                 /**
                  * RUN <<\
                  * #EOT