Fix #181 Add hovers to ADD and COPY's --chown flag

Signed-off-by: Remy Suen <[email protected]>
rcjsuen · Jan 9, 2018 · 9939938 · 9939938
1 parent 8aead06
commit 9939938
Show file tree

Hide file tree

Showing 4 changed files with 166 additions and 36 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,8 @@ All notable changes to this project will be documented in this file.
 ### Added
 - textDocument/completion
   - documentation for ADD and COPY's --chown flag ([#181](https://github.com/rcjsuen/dockerfile-language-server-nodejs/issues/181))
+- textDocument/hover
+  - ADD and COPY's --chown flag ([#181](https://github.com/rcjsuen/dockerfile-language-server-nodejs/issues/181))
 
 ### Changed
 - created a dependency on the dockerfile-ast NPM module ([#196](https://github.com/rcjsuen/dockerfile-language-server-nodejs/issues/196))

diff --git a/src/dockerHover.ts b/src/dockerHover.ts
@@ -103,10 +103,28 @@ export class DockerHover {
 
 	private getFlagsHover(position: Position, instruction: Instruction): Hover {
 		switch (instruction.getKeyword()) {
+			case "ADD":
+				let addFlags = (instruction as ModifiableInstruction).getFlags();
+				for (let flag of addFlags) {
+					if (Util.isInsideRange(position, flag.getNameRange())) {
+						switch (flag.getName()) {
+							case "chown":
+								return this.markdown.getMarkdown("ADD_FlagChown");
+						}
+					}
+				}
+				break;
 			case "COPY":
 				let copyFlags = (instruction as ModifiableInstruction).getFlags();
-				if (copyFlags.length > 0 && Util.isInsideRange(position, copyFlags[0].getNameRange()) && copyFlags[0].getName() === "from") {
-					return this.markdown.getMarkdown("COPY_FlagFrom");
+				for (let flag of copyFlags) {
+					if (Util.isInsideRange(position, flag.getNameRange())) {
+						switch (flag.getName()) {
+							case "chown":
+								return this.markdown.getMarkdown("COPY_FlagChown");
+							case "from":
+								return this.markdown.getMarkdown("COPY_FlagFrom");
+						}
+					}
 				}
 				break;
 			case "HEALTHCHECK":

diff --git a/src/dockerMarkdown.ts b/src/dockerMarkdown.ts
@@ -32,6 +32,8 @@ export class MarkdownDocumentation {
 
 		"hoverOnlineDocumentationFooter": "\n\n[Online documentation](${0})",
 
+		"hoverAddFlagChown": "The username, groupname, or UID/GID combination to own the added content.",
+		"hoverCopyFlagChown": "The username, groupname, or UID/GID combination to own the copied content.",
 		"hoverCopyFlagFrom": "The previous build stage to use as the source location instead of the build's context.\n\nSince Docker 17.05.0-ce.",
 		"hoverHealthcheckFlagInterval": "The seconds to wait for the health check to run after the container has started, and then again the number of seconds to wait before running again after the previous check has completed.",
 		"hoverHealthcheckFlagRetries": "The number of consecutive failures of this health check before the container is considered to be `unhealthy`.",
@@ -57,6 +59,10 @@ export class MarkdownDocumentation {
 					this.formatMessage(this.dockerMessages["hoverOnlineDocumentationFooter"], "https://docs.docker.com/engine/reference/builder/#add")
 			},
 
+			ADD_FlagChown: {
+				contents:  this.dockerMessages["hoverAddFlagChown"]
+			},
+
 			ARG: {
 				contents: this.dockerMessages["hoverArg"] +
 					"```\n" +
@@ -83,6 +89,10 @@ export class MarkdownDocumentation {
 					this.formatMessage(this.dockerMessages["hoverOnlineDocumentationFooter"], "https://docs.docker.com/engine/reference/builder/#copy")
 			},
 
+			COPY_FlagChown: {
+				contents:  this.dockerMessages["hoverCopyFlagChown"]
+			},
+
 			COPY_FlagFrom: {
 				contents:  this.dockerMessages["hoverCopyFlagFrom"]
 			},

diff --git a/test/dockerHover.test.ts b/test/dockerHover.test.ts
@@ -184,6 +184,58 @@ describe("Dockerfile hover", function() {
 			assert.equal(hover, null);
 		});
 
+		function createAddTest(trigger: boolean) {
+			let onbuild = trigger ? "ONBUILD " : "";
+			let triggerOffset = onbuild.length;
+
+			describe("ADD", function() {
+				it("--chown", function() {
+					let document = createDocument(onbuild + "ADD --chown");
+					let hover = onHover(document, 0, triggerOffset + 9);
+					assert.notEqual(hover, null);
+					assert.equal(hover, markdownDocumentation.getMarkdown("ADD_FlagChown"));
+				});
+
+				it("--chown=\\$user", function() {
+					let document = createDocument(onbuild + "ADD --chown=\\$user");
+					let hover = onHover(document, 0, triggerOffset + 9);
+					assert.notEqual(hover, null);
+					assert.equal(hover, markdownDocumentation.getMarkdown("ADD_FlagChown"));
+				});
+
+				it("--chown=\\root", function() {
+					let document = createDocument(onbuild + "ADD --chown=\\root");
+					let hover = onHover(document, 0, triggerOffset + 9);
+					assert.notEqual(hover, null);
+					assert.equal(hover, markdownDocumentation.getMarkdown("ADD_FlagChown"));
+				});
+
+				it("--CHOWN", function() {
+					let document = createDocument(onbuild + "ADD --FROM");
+					let hover = onHover(document, 0, triggerOffset + 9);
+					assert.equal(hover, null);
+				});
+
+				it("whitespace", function() {
+					let document = createDocument(onbuild + "ADD  --from");
+					let hover = onHover(document, 0, triggerOffset + 5);
+					assert.equal(hover, null);
+				});
+
+				it("flag after", function() {
+					let document = createDocument(onbuild + "ADD app --chown=root app");
+					let hover = onHover(document, 0, triggerOffset + 13);
+					assert.equal(hover, null);
+
+					document = createDocument(onbuild + "ADD app app --chown=root");
+					hover = onHover(document, 0, triggerOffset + 17);
+					assert.equal(hover, null);
+				});
+			});
+		}
+
+		createAddTest(false);
+
 		function createVariablesTest(testSuiteName: string, instruction: string, delimiter: string) {
 			const space = delimiter === " ";
 
@@ -1000,47 +1052,94 @@ describe("Dockerfile hover", function() {
 			let triggerOffset = onbuild.length;
 
 			describe("COPY", function() {
-				it("--from", function() {
-					let document = createDocument(onbuild + "COPY --from");
-					let hover = onHover(document, 0, triggerOffset + 9);
-					assert.notEqual(hover, null);
-					assert.equal(hover, markdownDocumentation.getMarkdown("COPY_FlagFrom"));
-				});
+				describe("--from flag", function() {
+					it("--from", function() {
+						let document = createDocument(onbuild + "COPY --from");
+						let hover = onHover(document, 0, triggerOffset + 9);
+						assert.notEqual(hover, null);
+						assert.equal(hover, markdownDocumentation.getMarkdown("COPY_FlagFrom"));
+					});
 
-				it("--from=\\$x", function() {
-					let document = createDocument(onbuild + "COPY --from=\\$x");
-					let hover = onHover(document, 0, triggerOffset + 9);
-					assert.notEqual(hover, null);
-					assert.equal(hover, markdownDocumentation.getMarkdown("COPY_FlagFrom"));
-				});
+					it("--from=\\$x", function() {
+						let document = createDocument(onbuild + "COPY --from=\\$x");
+						let hover = onHover(document, 0, triggerOffset + 9);
+						assert.notEqual(hover, null);
+						assert.equal(hover, markdownDocumentation.getMarkdown("COPY_FlagFrom"));
+					});
 
-				it("--from=\\a", function() {
-					let document = createDocument(onbuild + "COPY --from=\\a");
-					let hover = onHover(document, 0, triggerOffset + 9);
-					assert.notEqual(hover, null);
-					assert.equal(hover, markdownDocumentation.getMarkdown("COPY_FlagFrom"));
-				});
+					it("--from=\\a", function() {
+						let document = createDocument(onbuild + "COPY --from=\\a");
+						let hover = onHover(document, 0, triggerOffset + 9);
+						assert.notEqual(hover, null);
+						assert.equal(hover, markdownDocumentation.getMarkdown("COPY_FlagFrom"));
+					});
 
-				it("--FROM", function() {
-					let document = createDocument(onbuild + "COPY --FROM");
-					let hover = onHover(document, 0, triggerOffset + 9);
-					assert.equal(hover, null);
-				});
+					it("--FROM", function() {
+						let document = createDocument(onbuild + "COPY --FROM");
+						let hover = onHover(document, 0, triggerOffset + 9);
+						assert.equal(hover, null);
+					});
 
-				it("whitespace", function() {
-					let document = createDocument(onbuild + "COPY  --from");
-					let hover = onHover(document, 0, triggerOffset + 5);
-					assert.equal(hover, null);
+					it("flag after", function() {
+						let document = createDocument(onbuild + "COPY app --from=alpine app");
+						let hover = onHover(document, 0, triggerOffset + 13);
+						assert.equal(hover, null);
+
+						document = createDocument(onbuild + "COPY app app --from=alpine");
+						hover = onHover(document, 0, triggerOffset + 18);
+						assert.equal(hover, null);
+					});
+
+					it("whitespace", function() {
+						let document = createDocument(onbuild + "COPY  --from");
+						let hover = onHover(document, 0, triggerOffset + 5);
+						assert.equal(hover, null);
+					});
 				});
 
-				it("flag after", function() {
-					let document = createDocument(onbuild + "COPY app --from=alpine app");
-					let hover = onHover(document, 0, triggerOffset + 13);
-					assert.equal(hover, null);
+				describe("--chown flag", function() {
+					it("--chown", function() {
+						let document = createDocument(onbuild + "COPY --chown");
+						let hover = onHover(document, 0, triggerOffset + 9);
+						assert.notEqual(hover, null);
+						assert.equal(hover, markdownDocumentation.getMarkdown("COPY_FlagChown"));
+					});
 
-					document = createDocument(onbuild + "COPY app app --from=alpine");
-					hover = onHover(document, 0, triggerOffset + 18);
-					assert.equal(hover, null);
+					it("--chown=\\$user", function() {
+						let document = createDocument(onbuild + "COPY --chown=\\$x");
+						let hover = onHover(document, 0, triggerOffset + 9);
+						assert.notEqual(hover, null);
+						assert.equal(hover, markdownDocumentation.getMarkdown("COPY_FlagChown"));
+					});
+
+					it("--chown=\\root", function() {
+						let document = createDocument(onbuild + "COPY --chown=\\a");
+						let hover = onHover(document, 0, triggerOffset + 9);
+						assert.notEqual(hover, null);
+						assert.equal(hover, markdownDocumentation.getMarkdown("COPY_FlagChown"));
+					});
+
+					it("--CHOWN", function() {
+						let document = createDocument(onbuild + "COPY --CHOWN");
+						let hover = onHover(document, 0, triggerOffset + 9);
+						assert.equal(hover, null);
+					});
+
+					it("flag after", function() {
+						let document = createDocument(onbuild + "COPY app --chown=alpine app");
+						let hover = onHover(document, 0, triggerOffset + 13);
+						assert.equal(hover, null);
+
+						document = createDocument(onbuild + "COPY app app --chown=alpine");
+						hover = onHover(document, 0, triggerOffset + 18);
+						assert.equal(hover, null);
+					});
+
+					it("whitespace", function() {
+						let document = createDocument(onbuild + "COPY  --chown");
+						let hover = onHover(document, 0, triggerOffset + 5);
+						assert.equal(hover, null);
+					});
 				});
 			});
 		}
@@ -1722,6 +1821,7 @@ describe("Dockerfile hover", function() {
 		createHealthcheckTest(false);
 
 		describe("ONBUILD", function() {
+			createAddTest(true);
 			createCopyTest(true);
 			createHealthcheckTest(true);
 		});