Merge pull request #545 from snyk/feat/add-parse-dockerfile-functiona…

…lity feat: add "parse dockerfile" functionality
snyk · Oct 22, 2023 · 0b7a1e7 · 0b7a1e7
2 parents cb0a0c2 + 30c3030
commit 0b7a1e7
Show file tree

Hide file tree

Showing 2 changed files with 29 additions and 2 deletions.
diff --git a/lib/dockerfile/index.ts b/lib/dockerfile/index.ts
@@ -1,4 +1,4 @@
-import { DockerfileParser } from "dockerfile-ast";
+import { Dockerfile, DockerfileParser } from "dockerfile-ast";
 import * as fs from "fs";
 import { normalize as normalizePath } from "path";
 import {
@@ -18,6 +18,7 @@ export {
   getDockerfileBaseImageName,
   updateDockerfileBaseImageName,
   DockerFileAnalysis,
+  parseDockerfile,
 };
 
 async function readDockerfileAndAnalyse(
@@ -53,3 +54,7 @@ async function readFile(path: string) {
     });
   }) as Promise<string>;
 }
+
+function parseDockerfile(content: string): Dockerfile {
+  return DockerfileParser.parse(content);
+}
diff --git a/test/lib/dockerfile.spec.ts b/test/lib/dockerfile.spec.ts
@@ -1,5 +1,7 @@
-import exp from "constants";
+import { DockerfileParser } from "dockerfile-ast";
+import { Dockerfile } from "dockerfile-ast/lib/dockerfile";
 import * as path from "path";
+import { parseDockerfile } from "../../lib/dockerfile";
 
 import * as dockerFile from "../../lib/dockerfile";
 import {
@@ -268,3 +270,23 @@ describe("readDockerfileAndAnalyse() correctly parses...", () => {
     });
   });
 });
+
+describe("parseDockerfile()", () => {
+  afterEach(() => {
+    jest.resetAllMocks();
+  });
+
+  test("returns undefined when Dockerfile is not supplied", async () => {
+    const dockerfileContent: string = "some dockerfile content";
+
+    const expectedParsedDockerfile: jest.Mocked<Dockerfile> =
+      jest.mocked(Dockerfile);
+    jest
+      .spyOn(DockerfileParser, "parse")
+      .mockImplementation(() => expectedParsedDockerfile);
+
+    const result = parseDockerfile(dockerfileContent);
+
+    expect(result).toEqual(expectedParsedDockerfile);
+  });
+});