Skip to content

Fix tar with symlink #1218

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.

Sign up for GitHub

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

Merged
KostyaSha merged 2 commits into from
Jul 12, 2019
Merged

Fix tar with symlink #1218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
63f693b
Remove duplicated code to add a file to a tar
hugares Jul 10, 2019
5f7349f
Fix tar creation with symbolic link
hugares Jul 10, 2019
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
52 changes: 24 additions & 28 deletions src/main/java/com/github/dockerjava/core/util/CompressArchiveUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
package com.github.dockerjava.core.util;

import static com.github.dockerjava.core.util.FilePathUtil.relativize;
import static java.nio.file.FileVisitOption.FOLLOW_LINKS;

import java.io.BufferedInputStream;
import java.io.BufferedOutputStream;
Expand All @@ -13,7 +12,6 @@
import java.io.OutputStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.EnumSet;
import java.util.zip.GZIPOutputStream;

import org.apache.commons.compress.archivers.tar.TarArchiveEntry;
Expand All @@ -28,14 +26,26 @@ private CompressArchiveUtil() {
// utility class
}

static void putTarEntry(TarArchiveOutputStream tarOutputStream, TarArchiveEntry tarEntry, Path file)
static void addFileToTar(TarArchiveOutputStream tarArchiveOutputStream, Path file, String entryName)
throws IOException {
tarEntry.setSize(Files.size(file));
tarOutputStream.putArchiveEntry(tarEntry);
try (InputStream input = new BufferedInputStream(Files.newInputStream(file))) {
ByteStreams.copy(input, tarOutputStream);
tarOutputStream.closeArchiveEntry();
if (Files.isSymbolicLink(file)) {
TarArchiveEntry tarArchiveEntry = new TarArchiveEntry(entryName, TarArchiveEntry.LF_SYMLINK);
tarArchiveEntry.setLinkName(Files.readSymbolicLink(file).toString());
tarArchiveOutputStream.putArchiveEntry(tarArchiveEntry);
} else {
TarArchiveEntry tarArchiveEntry = (TarArchiveEntry) tarArchiveOutputStream.createArchiveEntry(file.toFile(),
entryName);
if (file.toFile().canExecute()) {
tarArchiveEntry.setMode(tarArchiveEntry.getMode() | 0755);
}
tarArchiveOutputStream.putArchiveEntry(tarArchiveEntry);
if (file.toFile().isFile()) {
try (InputStream input = new BufferedInputStream(Files.newInputStream(file))) {
ByteStreams.copy(input, tarArchiveOutputStream);
}
}
}
tarArchiveOutputStream.closeArchiveEntry();
}

private static TarArchiveOutputStream buildTarStream(Path outputPath, boolean gZipped) throws IOException {
Expand Down Expand Up @@ -69,19 +79,14 @@ public static void tar(Path inputPath, Path outputPath, boolean gZipped, boolean

try (TarArchiveOutputStream tarArchiveOutputStream = buildTarStream(outputPath, gZipped)) {
if (!Files.isDirectory(inputPath)) {
TarArchiveEntry tarEntry = new TarArchiveEntry(inputPath.getFileName().toString());
if (inputPath.toFile().canExecute()) {
tarEntry.setMode(tarEntry.getMode() | 0755);
}
putTarEntry(tarArchiveOutputStream, tarEntry, inputPath);
addFileToTar(tarArchiveOutputStream, inputPath, inputPath.getFileName().toString());
} else {
Path sourcePath = inputPath;
if (!childrenOnly) {
// In order to have the dossier as the root entry
sourcePath = inputPath.getParent();
}
Files.walkFileTree(inputPath, EnumSet.of(FOLLOW_LINKS), Integer.MAX_VALUE,
new TarDirWalker(sourcePath, tarArchiveOutputStream));
Files.walkFileTree(inputPath, new TarDirWalker(sourcePath, tarArchiveOutputStream));
}
tarArchiveOutputStream.flush();
}
Expand All @@ -95,19 +100,10 @@ public static File archiveTARFiles(File base, Iterable<File> files, String archi
new FileOutputStream(tarFile))))) {
tos.setLongFileMode(TarArchiveOutputStream.LONGFILE_GNU);
for (File file : files) {
TarArchiveEntry tarEntry = new TarArchiveEntry(file);
tarEntry.setName(relativize(base, file));

if (!file.isDirectory() && file.canExecute()) {
tarEntry.setMode(tarEntry.getMode() | 0755);
}

tos.putArchiveEntry(tarEntry);

if (!file.isDirectory()) {
FileUtils.copyFile(file, tos);
}
tos.closeArchiveEntry();
// relativize with method using Path otherwise method with File resolves the symlinks
// and this is not want we want. If the file is a symlink, the relativized path should
// keep the symlink name and not the target it points to.
addFileToTar(tos, file.toPath(), relativize(base.toPath(), file.toPath()));
}
}

Expand Down
9 changes: 1 addition & 8 deletions src/main/java/com/github/dockerjava/core/util/TarDirWalker.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,7 @@ public FileVisitResult preVisitDirectory(Path dir, BasicFileAttributes attrs) th

@Override
public FileVisitResult visitFile(Path file, BasicFileAttributes attrs) throws IOException {
if (attrs.isSymbolicLink()) { // symbolic link to folder
return FileVisitResult.CONTINUE;
}
TarArchiveEntry tarEntry = new TarArchiveEntry(FilePathUtil.relativize(basePath, file));
if (file.toFile().canExecute()) {
tarEntry.setMode(tarEntry.getMode() | 0755);
}
CompressArchiveUtil.putTarEntry(tarArchiveOutputStream, tarEntry, file);
CompressArchiveUtil.addFileToTar(tarArchiveOutputStream, file, FilePathUtil.relativize(basePath, file));
return FileVisitResult.CONTINUE;
}

Expand Down
6 changes: 0 additions & 6 deletions src/test/java/com/github/dockerjava/core/util/CompressArchiveUtilTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

import org.apache.commons.compress.archivers.tar.TarArchiveEntry;
import org.apache.commons.compress.archivers.tar.TarArchiveInputStream;
import org.junit.Ignore;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.TemporaryFolder;
Expand Down Expand Up @@ -69,7 +68,6 @@ public void tarWithExecutableFileAsInput() throws Exception {
}

@Test
@Ignore("Symlink creation is broken so test do not pass")
public void tarWithSymbolicLinkFileAsInput() throws IOException {
Path archiveSourceFile = tempFolder.getRoot().toPath().resolve("symlinkFile");
Path linkTargetFile = tempFolder.newFile("link-target").toPath();
Expand Down Expand Up @@ -140,7 +138,6 @@ public void tarWithfolderAsInputAndNestedExecutableFile() throws Exception {
}

@Test
@Ignore("Symlink creation is broken so test do not pass")
public void tarWithfolderAsInputAndNestedSymbolicLinkFile() throws Exception {
Path archiveSourceDir = tempFolder.newFolder("archive-source").toPath();
Path linkTargetFile = tempFolder.newFile("link-target").toPath();
Expand All @@ -162,7 +159,6 @@ public void tarWithfolderAsInputAndNestedSymbolicLinkFile() throws Exception {
}

@Test
@Ignore("Symlink creation is broken so test do not pass")
public void tarWithfolderAsInputAndNestedSymbolicLinkDir() throws Exception {
Path archiveSourceDir = tempFolder.newFolder("archive-source").toPath();
Path linkTargetDir = tempFolder.newFolder("link-target").toPath();
Expand Down Expand Up @@ -207,7 +203,6 @@ public void archiveTARFilesWithExecutableFile() throws Exception {
}

@Test
@Ignore("Symlink creation is broken so test do not pass")
public void archiveTARFilesWithSymbolicLinkFile() throws Exception {
Path linkTargetFile = tempFolder.newFile("link-target").toPath();
Path symlinkFile = tempFolder.getRoot().toPath().resolve("symlinkFile");
Expand All @@ -219,7 +214,6 @@ public void archiveTARFilesWithSymbolicLinkFile() throws Exception {
}

@Test
@Ignore("Symlink creation is broken so test do not pass")
public void archiveTARFilesWithSymbolicLinkDir() throws Exception {
Path linkTargetDir = tempFolder.newFolder("link-target").toPath();
Path symlinkFile = tempFolder.getRoot().toPath().resolve("symlinkFile");
Expand Down