storage/pkg/chrootarchive/archive_test.go

555 lines
14 KiB
Go

package chrootarchive
import (
"bytes"
"fmt"
"hash/crc32"
"io"
"os"
"path/filepath"
"runtime"
"strings"
"syscall"
"testing"
"time"
"github.com/containers/storage/pkg/archive"
"github.com/containers/storage/pkg/idtools"
"github.com/containers/storage/pkg/reexec"
"github.com/stretchr/testify/require"
)
const (
windows = "windows"
solaris = "solaris"
)
func init() {
reexec.Init()
}
var chrootArchiver = NewArchiver(nil)
func TarUntar(src, dst string) error {
return chrootArchiver.TarUntar(src, dst)
}
func CopyFileWithTar(src, dst string) (err error) {
return chrootArchiver.CopyFileWithTar(src, dst)
}
func UntarPath(src, dst string) error {
return chrootArchiver.UntarPath(src, dst)
}
func CopyWithTar(src, dst string) error {
return chrootArchiver.CopyWithTar(src, dst)
}
func TestChrootTarUntar(t *testing.T) {
tmpdir := t.TempDir()
src := filepath.Join(tmpdir, "src")
if err := os.MkdirAll(src, 0o700); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(src, "toto"), []byte("hello toto"), 0o644); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(src, "lolo"), []byte("hello lolo"), 0o644); err != nil {
t.Fatal(err)
}
stream, err := archive.Tar(src, archive.Uncompressed)
if err != nil {
t.Fatal(err)
}
dest := filepath.Join(tmpdir, "src")
if err := os.MkdirAll(dest, 0o700); err != nil {
t.Fatal(err)
}
if err := Untar(stream, dest, &archive.TarOptions{ExcludePatterns: []string{"lolo"}}); err != nil {
t.Fatal(err)
}
}
// gh#10426: Verify the fix for having a huge excludes list (like on `docker load` with large # of
// local images)
func TestChrootUntarWithHugeExcludesList(t *testing.T) {
tmpdir := t.TempDir()
src := filepath.Join(tmpdir, "src")
if err := os.MkdirAll(src, 0o700); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(src, "toto"), []byte("hello toto"), 0o644); err != nil {
t.Fatal(err)
}
stream, err := archive.Tar(src, archive.Uncompressed)
if err != nil {
t.Fatal(err)
}
dest := filepath.Join(tmpdir, "dest")
if err := os.MkdirAll(dest, 0o700); err != nil {
t.Fatal(err)
}
options := &archive.TarOptions{}
// 65534 entries of 64-byte strings ~= 4MB of environment space which should overflow
// on most systems when passed via environment or command line arguments
excludes := make([]string, 65534)
for i := range 65534 {
excludes[i] = strings.Repeat(fmt.Sprintf("%d", i), 64)
}
options.ExcludePatterns = excludes
if err := Untar(stream, dest, options); err != nil {
t.Fatal(err)
}
}
func TestChrootUntarEmptyArchive(t *testing.T) {
tmpdir := t.TempDir()
if err := Untar(nil, tmpdir, nil); err == nil {
t.Fatal("expected error on empty archive")
}
}
func prepareSourceDirectory(numberOfFiles int, targetPath string, makeSymLinks bool) (int, error) {
fileData := []byte("fooo")
for n := range numberOfFiles {
fileName := fmt.Sprintf("file-%d", n)
if err := os.WriteFile(filepath.Join(targetPath, fileName), fileData, 0o700); err != nil {
return 0, err
}
if makeSymLinks {
if err := os.Symlink(filepath.Join(targetPath, fileName), filepath.Join(targetPath, fileName+"-link")); err != nil {
return 0, err
}
}
}
totalSize := numberOfFiles * len(fileData)
return totalSize, nil
}
func getHash(filename string) (uint32, error) {
stream, err := os.ReadFile(filename)
if err != nil {
return 0, err
}
hash := crc32.NewIEEE()
hash.Write(stream)
return hash.Sum32(), nil
}
func compareDirectories(src string, dest string) error {
changes, err := archive.ChangesDirs(dest, &idtools.IDMappings{}, src, &idtools.IDMappings{})
if err != nil {
return err
}
if len(changes) > 0 {
return fmt.Errorf("unexpected differences after untar: %v", changes)
}
return nil
}
func compareDirectoriesChown(src string, dest string, uid, gid int) error {
uidmap := []idtools.IDMap{{ContainerID: 0, HostID: uid, Size: 1}}
gidmap := []idtools.IDMap{{ContainerID: 0, HostID: gid, Size: 1}}
mappings := idtools.NewIDMappingsFromMaps(uidmap, gidmap)
changes, err := archive.ChangesDirs(dest, mappings, src, &idtools.IDMappings{})
if err != nil {
return err
}
if len(changes) > 0 {
return fmt.Errorf("unexpected differences after untar: %v", changes)
}
return nil
}
func compareFiles(src string, dest string) error {
srcHash, err := getHash(src)
if err != nil {
return err
}
destHash, err := getHash(dest)
if err != nil {
return err
}
if srcHash != destHash {
return fmt.Errorf("%s is different from %s", src, dest)
}
return nil
}
func compareFilesChown(src string, dest string, uid, gid int) error {
if err := compareFiles(src, dest); err != nil {
return err
}
fi, err := os.Lstat(dest)
if err == nil {
statuid := fi.Sys().(*syscall.Stat_t).Uid
statgid := fi.Sys().(*syscall.Stat_t).Gid
if statuid != uint32(uid) || statgid != uint32(gid) {
return fmt.Errorf("%d:%d ownership on %s is different expected %d:%d", statuid, statgid, dest, uid, gid)
}
}
return err
}
func TestChrootTarUntarWithSymlink(t *testing.T) {
// TODO Windows: Figure out why this is failing
if runtime.GOOS == windows {
t.Skip("Failing on Windows")
}
tmpdir := t.TempDir()
src := filepath.Join(tmpdir, "src")
if err := os.MkdirAll(src, 0o700); err != nil {
t.Fatal(err)
}
if _, err := prepareSourceDirectory(10, src, false); err != nil {
t.Fatal(err)
}
dest := filepath.Join(tmpdir, "dest")
if err := TarUntar(src, dest); err != nil {
t.Fatal(err)
}
if err := compareDirectories(src, dest); err != nil {
t.Fatal(err)
}
}
func TestChrootCopyWithTar(t *testing.T) {
// TODO Windows: Figure out why this is failing
if runtime.GOOS == windows || runtime.GOOS == solaris {
t.Skip("Failing on Windows and Solaris")
}
tmpdir := t.TempDir()
src := filepath.Join(tmpdir, "src")
if err := os.MkdirAll(src, 0o700); err != nil {
t.Fatal(err)
}
if _, err := prepareSourceDirectory(10, src, true); err != nil {
t.Fatal(err)
}
// Copy directory
dest := filepath.Join(tmpdir, "dest")
if err := CopyWithTar(src, dest); err != nil {
t.Fatal(err)
}
if err := compareDirectories(src, dest); err != nil {
t.Fatal(err)
}
// Copy file
srcfile := filepath.Join(src, "file-1")
dest = filepath.Join(tmpdir, "destFile")
destfile := filepath.Join(dest, "file-1")
if err := CopyWithTar(srcfile, destfile); err != nil {
t.Fatal(err)
}
if err := compareFiles(srcfile, destfile); err != nil {
t.Fatal(err)
}
// Copy symbolic link
srcLinkfile := filepath.Join(src, "file-1-link")
dest = filepath.Join(tmpdir, "destSymlink")
destLinkfile := filepath.Join(dest, "file-1-link")
if err := CopyWithTar(srcLinkfile, destLinkfile); err != nil {
t.Fatal(err)
}
if err := compareFiles(srcLinkfile, destLinkfile); err != nil {
t.Fatal(err)
}
}
func TestChrootCopyWithTarAndChown(t *testing.T) {
// TODO Windows: Figure out why this is failing
if runtime.GOOS == windows || runtime.GOOS == solaris {
t.Skip("Failing on Windows and Solaris")
}
tmpdir := t.TempDir()
src := filepath.Join(tmpdir, "src")
if err := os.MkdirAll(src, 0o700); err != nil {
t.Fatal(err)
}
if _, err := prepareSourceDirectory(10, src, true); err != nil {
t.Fatal(err)
}
uid := 1000
gid := 1001
owner := idtools.IDPair{UID: uid, GID: gid}
idMap := idtools.IDMap{ContainerID: 0, HostID: 0, Size: 65536}
uidMap := []idtools.IDMap{idMap}
gidMap := []idtools.IDMap{idMap}
copyFunc := CopyWithTarAndChown(&owner, nil, uidMap, gidMap)
// Copy directory
dest := filepath.Join(tmpdir, "dest")
if err := copyFunc(src, dest); err != nil {
t.Fatal(err)
}
if err := compareDirectoriesChown(src, dest, uid, gid); err != nil {
t.Fatal(err)
}
// Copy file
srcfile := filepath.Join(src, "file-1")
dest = filepath.Join(tmpdir, "destFile")
destfile := filepath.Join(dest, "file-1")
if err := copyFunc(srcfile, destfile); err != nil {
t.Fatal(err)
}
if err := compareFilesChown(srcfile, destfile, uid, gid); err != nil {
t.Fatal(err)
}
// Copy symbolic link
srcLinkfile := filepath.Join(src, "file-1-link")
dest = filepath.Join(tmpdir, "destSymlink")
destLinkfile := filepath.Join(dest, "file-1-link")
if err := copyFunc(srcLinkfile, destLinkfile); err != nil {
t.Fatal(err)
}
if err := compareFilesChown(srcLinkfile, destLinkfile, uid, gid); err != nil {
t.Fatal(err)
}
}
func TestChrootCopyFileWithTar(t *testing.T) {
tmpdir := t.TempDir()
src := filepath.Join(tmpdir, "src")
if err := os.MkdirAll(src, 0o700); err != nil {
t.Fatal(err)
}
if _, err := prepareSourceDirectory(10, src, true); err != nil {
t.Fatal(err)
}
// Copy directory
dest := filepath.Join(tmpdir, "dest")
if err := CopyFileWithTar(src, dest); err == nil {
t.Fatal("Expected error on copying directory")
}
// Copy file
srcfile := filepath.Join(src, "file-1")
dest = filepath.Join(tmpdir, "destFile")
destfile := filepath.Join(dest, "file-1")
if err := CopyFileWithTar(srcfile, destfile); err != nil {
t.Fatal(err)
}
if err := compareFiles(srcfile, destfile); err != nil {
t.Fatal(err)
}
// Copy symbolic link
srcLinkfile := filepath.Join(src, "file-1-link")
dest = filepath.Join(tmpdir, "destSymlink")
destLinkfile := filepath.Join(dest, "file-1-link")
if err := CopyFileWithTar(srcLinkfile, destLinkfile); err != nil {
t.Fatal(err)
}
if err := compareFiles(srcLinkfile, destLinkfile); err != nil {
t.Fatal(err)
}
}
func TestChrootCopyFileWithTarAndChown(t *testing.T) {
tmpdir := t.TempDir()
src := filepath.Join(tmpdir, "src")
if err := os.MkdirAll(src, 0o700); err != nil {
t.Fatal(err)
}
if _, err := prepareSourceDirectory(10, src, true); err != nil {
t.Fatal(err)
}
uid := 1000
gid := 1001
owner := idtools.IDPair{UID: uid, GID: gid}
idMap := idtools.IDMap{ContainerID: 0, HostID: 0, Size: 65536}
uidMap := []idtools.IDMap{idMap}
gidMap := []idtools.IDMap{idMap}
copyFunc := CopyFileWithTarAndChown(&owner, nil, uidMap, gidMap)
// Copy directory
dest := filepath.Join(tmpdir, "dest")
if err := copyFunc(src, dest); err == nil {
t.Fatal("Expected error on copying directory")
}
// Copy file
srcfile := filepath.Join(src, "file-1")
dest = filepath.Join(tmpdir, "destFile")
destfile := filepath.Join(dest, "file-1")
if err := copyFunc(srcfile, destfile); err != nil {
t.Fatal(err)
}
if err := compareFilesChown(srcfile, destfile, uid, gid); err != nil {
t.Fatal(err)
}
// Copy symbolic link
srcLinkfile := filepath.Join(src, "file-1-link")
dest = filepath.Join(tmpdir, "destSymlink")
destLinkfile := filepath.Join(dest, "file-1-link")
if err := copyFunc(srcLinkfile, destLinkfile); err != nil {
t.Fatal(err)
}
if err := compareFilesChown(srcLinkfile, destLinkfile, uid, gid); err != nil {
t.Fatal(err)
}
}
func TestChrootUntarPath(t *testing.T) {
// TODO Windows: Figure out why this is failing
if runtime.GOOS == windows {
t.Skip("Failing on Windows")
}
tmpdir := t.TempDir()
src := filepath.Join(tmpdir, "src")
if err := os.MkdirAll(src, 0o700); err != nil {
t.Fatal(err)
}
if _, err := prepareSourceDirectory(10, src, false); err != nil {
t.Fatal(err)
}
dest := filepath.Join(tmpdir, "dest")
// Untar a directory
if err := UntarPath(src, dest); err == nil {
t.Fatal("Expected error on untaring a directory")
}
tarFunc := archive.TarPath(nil, nil)
// Untar a tar file
stream, err := tarFunc(src)
if err != nil {
t.Fatal(err)
}
buf := new(bytes.Buffer)
_, err = buf.ReadFrom(stream)
require.NoError(t, err)
tarfile := filepath.Join(tmpdir, "src.tar")
if err := os.WriteFile(tarfile, buf.Bytes(), 0o644); err != nil {
t.Fatal(err)
}
if err := UntarPath(tarfile, dest); err != nil {
t.Fatal(err)
}
if err := compareDirectories(src, dest); err != nil {
t.Fatal(err)
}
}
func TestChrootUntarPathAndChown(t *testing.T) {
// TODO Windows: Figure out why this is failing
if runtime.GOOS == windows {
t.Skip("Failing on Windows")
}
tmpdir := t.TempDir()
src := filepath.Join(tmpdir, "src")
if err := os.MkdirAll(src, 0o700); err != nil {
t.Fatal(err)
}
if _, err := prepareSourceDirectory(10, src, false); err != nil {
t.Fatal(err)
}
dest := filepath.Join(tmpdir, "dest")
uid := 1000
gid := 1001
owner := idtools.IDPair{UID: uid, GID: gid}
idMap := idtools.IDMap{ContainerID: 0, HostID: 0, Size: 65536}
uidMap := []idtools.IDMap{idMap}
gidMap := []idtools.IDMap{idMap}
untarFunc := UntarPathAndChown(&owner, nil, uidMap, gidMap)
// Untar a directory
if err := untarFunc(src, dest); err == nil {
t.Fatal("Expected error on untaring a directory")
}
// Untar a tar file
tarFunc := archive.TarPath(nil, nil)
// Untar a tar file
stream, err := tarFunc(src)
if err != nil {
t.Fatal(err)
}
buf := new(bytes.Buffer)
_, err = buf.ReadFrom(stream)
require.NoError(t, err)
tarfile := filepath.Join(tmpdir, "src.tar")
if err := os.WriteFile(tarfile, buf.Bytes(), 0o644); err != nil {
t.Fatal(err)
}
if err := untarFunc(tarfile, dest); err != nil {
t.Fatal(err)
}
if err := compareDirectoriesChown(src, dest, uid, gid); err != nil {
t.Fatal(err)
}
}
type slowEmptyTarReader struct {
size int
offset int
chunkSize int
}
// Read is a slow reader of an empty tar (like the output of "tar c --files-from /dev/null")
func (s *slowEmptyTarReader) Read(p []byte) (int, error) {
time.Sleep(100 * time.Millisecond)
count := min(len(p), s.chunkSize)
for i := range count {
p[i] = 0
}
s.offset += count
if s.offset > s.size {
return count, io.EOF
}
return count, nil
}
func TestChrootUntarEmptyArchiveFromSlowReader(t *testing.T) {
tmpdir := t.TempDir()
dest := filepath.Join(tmpdir, "dest")
if err := os.MkdirAll(dest, 0o700); err != nil {
t.Fatal(err)
}
stream := &slowEmptyTarReader{size: 10240, chunkSize: 1024}
if err := Untar(stream, dest, nil); err != nil {
t.Fatal(err)
}
}
func TestChrootApplyEmptyArchiveFromSlowReader(t *testing.T) {
tmpdir := t.TempDir()
dest := filepath.Join(tmpdir, "dest")
if err := os.MkdirAll(dest, 0o700); err != nil {
t.Fatal(err)
}
stream := &slowEmptyTarReader{size: 10240, chunkSize: 1024}
if _, err := ApplyLayer(dest, stream); err != nil {
t.Fatal(err)
}
}
func TestChrootApplyDotDotFile(t *testing.T) {
tmpdir := t.TempDir()
src := filepath.Join(tmpdir, "src")
if err := os.MkdirAll(src, 0o700); err != nil {
t.Fatal(err)
}
if err := os.WriteFile(filepath.Join(src, "..gitme"), []byte(""), 0o644); err != nil {
t.Fatal(err)
}
stream, err := archive.Tar(src, archive.Uncompressed)
if err != nil {
t.Fatal(err)
}
dest := filepath.Join(tmpdir, "dest")
if err := os.MkdirAll(dest, 0o700); err != nil {
t.Fatal(err)
}
if _, err := ApplyLayer(dest, stream); err != nil {
t.Fatal(err)
}
}