Skip to content

Support Dockerfile-Specific Dockerigore Files #2441

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ public Iterable<DockerfileStatement> getStatements() throws IOException {

public List<String> getIgnores() throws IOException {
List<String> ignores = new ArrayList<>();
File dockerIgnoreFile = new File(baseDirectory, ".dockerignore");
File dockerIgnoreFile = getDockerIgnoreFile();
if (dockerIgnoreFile.exists()) {
int lineNumber = 0;
List<String> dockerIgnoreFileContent = FileUtils.readLines(dockerIgnoreFile);
Expand All @@ -107,6 +107,17 @@ public List<String> getIgnores() throws IOException {
return ignores;
}

private File getDockerIgnoreFile() {
// See https://docs.docker.com/build/concepts/context/#filename-and-location
String dockerFileName = dockerFile.getName();
File dockerFileSpecificIgnoreFile = new File(baseDirectory, dockerFileName + ".dockerignore");
if (dockerFileSpecificIgnoreFile.exists()) {
return dockerFileSpecificIgnoreFile;
} else {
return new File(baseDirectory, ".dockerignore");
}
}

public ScannedResult parse() throws IOException {
return new ScannedResult();
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,46 @@ public void ineffectiveIgnorePattern() throws Exception {
assertThat(filesToAdd, containsInAnyOrder("Dockerfile", ".dockerignore", "README.md", "README-secret.md"));
}

@Test
public void specificDockerFileWithoutDockerFileSpecificIgnore() throws IOException {
File baseDir = fileFromBuildTestResource("dockerignore/specificDockerFileWithoutDockerFileSpecificIgnore");
Dockerfile dockerfile = new Dockerfile(new File(baseDir, "specific.Dockerfile"), baseDir);
Dockerfile.ScannedResult result = dockerfile.parse();
Collection<String> filesToAdd = transform(result.filesToAdd, TO_FILE_NAMES);

assertThat(filesToAdd, containsInAnyOrder("specific.Dockerfile", ".dockerignore", "README.md"));
}

@Test
public void defaultDockerFileWithDefaultIgnore() throws IOException {
File baseDir = fileFromBuildTestResource("dockerignore/DefaultDockerFileWithDefaultIgnore");
Dockerfile dockerfile = new Dockerfile(new File(baseDir, "Dockerfile"), baseDir);
Dockerfile.ScannedResult result = dockerfile.parse();
Collection<String> filesToAdd = transform(result.filesToAdd, TO_FILE_NAMES);

assertThat(filesToAdd, containsInAnyOrder("Dockerfile", ".dockerignore", "README.md"));
}

@Test
public void defaultDockerFileWithDockerFileSpecificIgnore() throws IOException {
File baseDir = fileFromBuildTestResource("dockerignore/DefaultDockerFileWithDockerFileSpecificIgnore");
Dockerfile dockerfile = new Dockerfile(new File(baseDir, "Dockerfile"), baseDir);
Dockerfile.ScannedResult result = dockerfile.parse();
Collection<String> filesToAdd = transform(result.filesToAdd, TO_FILE_NAMES);

assertThat(filesToAdd, containsInAnyOrder("Dockerfile", "Dockerfile.dockerignore", "README.md"));
}

@Test
public void dockerFileSpecificIgnoreOverridesDockerIgnore() throws IOException {
File baseDir = fileFromBuildTestResource("dockerignore/DockerFileSpecificIgnoreOverridesDockerIgnore");
Dockerfile dockerfile = new Dockerfile(new File(baseDir, "special.Dockerfile"), baseDir);
Dockerfile.ScannedResult result = dockerfile.parse();
Collection<String> filesToAdd = transform(result.filesToAdd, TO_FILE_NAMES);

assertThat(filesToAdd, containsInAnyOrder("special.Dockerfile", ".dockerignore", "special.Dockerfile.dockerignore", "README.md", "README-not-secret.md"));
}

@Test
public void addFiles() throws IOException {
File baseDir = fileFromBuildTestResource("ADD/files");
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*.md
!README*.md
README-secret.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
FROM busybox:latest

CMD ["echo", "Success"]
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
No markdown files are included in the context except README files other than README-secret.md.
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
FROM busybox:latest

CMD ["echo", "Success"]
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*.md
!README*.md
README-secret.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
No markdown files are included in the context except README files other than README-secret.md.
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
*.md
!README*.md
README-not-secret.md
README-secret.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
No markdown files are included in the context except README files other than README-secret.md.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
No markdown files are included in the context except README files other than README-secret.md.
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
No markdown files are included in the context except README files other than README-secret.md.
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
FROM busybox:latest

CMD ["echo", "Success"]
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
*.md
!README*.md
README-secret.md
README-special-secret.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
*.md
!README*.md
README-secret.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
No markdown files are included in the context except README files other than README-secret.md.
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
FROM busybox:latest

CMD ["echo", "Success"]