root
/
buildah
mirror of https://github.com/containers/buildah.git
1
0
Fork 0
Code Issues Actions 3 Packages Projects Releases Wiki Activity
buildah/copier/copier_test.go

1907 lines
63 KiB
Go
Raw Normal View History

Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
package copier
import (
"archive/tar"
"bufio"
"bytes"
Use errors.Is() instead of os.Is{Not,}Exist If errors for which os.IsExist() or os.IsNotExist() would have returned true have been wrapped using fmt.Errorf()'s "%w" verb, os.IsExist() and os.IsNotExist(), not having been retrofitted to use errors.Is(), will return false. Use errors.Is() to check if an error is an os.ErrExist or os.ErrNotExist error instead of calling os.IsExist() or os.IsNotExist(). Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2022-07-27 03:27:30 +08:00
"errors"
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
"flag"
"fmt"
"io"
Switch most calls to filepath.Walk to filepath.WalkDir Should speed up most walks escpecially if they don't need to stat every directory entry. [ NO NEW TESTS NEEDED] Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2022-03-26 19:48:51 +08:00
"io/fs"
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
"os"
"path"
"path/filepath"
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
"reflect"
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
"sort"
Replace fmt.Sprintf("%d", x) with strconv.Itoa(x) Replace calls to fmt.Sprintf("%d", x) with strconv.Itoa(x), which is slightly faster. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-09-28 05:25:06 +08:00
"strconv"
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
"strings"
"sync"
"syscall"
"testing"
"time"
"github.com/containers/storage/pkg/idtools"
"github.com/containers/storage/pkg/reexec"
"github.com/sirupsen/logrus"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)
func TestMain(m *testing.M) {
if reexec.Init() {
return
}
flag.Parse()
if testing.Verbose() {
logrus.SetLevel(logrus.DebugLevel)
}
os.Exit(m.Run())
}
// makeFileContents creates contents for a file of a specified size
func makeContents(length int64) io.ReadCloser {
pipeReader, pipeWriter := io.Pipe()
buffered := bufio.NewWriter(pipeWriter)
go func() {
count := int64(0)
for count < length {
if _, err := buffered.Write([]byte{"0123456789abcdef"[count%16]}); err != nil {
buffered.Flush()
pipeWriter.CloseWithError(err) // nolint:errcheck
return
}
count++
}
buffered.Flush()
pipeWriter.Close()
}()
return pipeReader
}
// makeArchiveSlice creates an archive from the set of headers and returns a byte slice.
func makeArchiveSlice(headers []tar.Header) []byte {
rc := makeArchive(headers, nil)
defer rc.Close()
buf := new(bytes.Buffer)
if _, err := io.Copy(buf, rc); err != nil {
panic("error creating in-memory archive")
}
return buf.Bytes()
}
// makeArchive creates an archive from the set of headers.
func makeArchive(headers []tar.Header, contents map[string][]byte) io.ReadCloser {
if contents == nil {
contents = make(map[string][]byte)
}
pipeReader, pipeWriter := io.Pipe()
go func() {
var err error
buffered := bufio.NewWriter(pipeWriter)
tw := tar.NewWriter(buffered)
for _, header := range headers {
var fileContent []byte
switch header.Typeflag {
case tar.TypeLink, tar.TypeSymlink:
header.Size = 0
case tar.TypeReg:
fileContent = contents[header.Name]
if len(fileContent) != 0 {
header.Size = int64(len(fileContent))
}
}
if err = tw.WriteHeader(&header); err != nil {
break
}
if header.Typeflag == tar.TypeReg && header.Size > 0 {
var fileContents io.Reader
if len(fileContent) > 0 {
fileContents = bytes.NewReader(fileContent)
} else {
rc := makeContents(header.Size)
defer rc.Close()
fileContents = rc
}
if _, err = io.Copy(tw, fileContents); err != nil {
break
}
}
}
tw.Close()
buffered.Flush()
if err != nil {
pipeWriter.CloseWithError(err) // nolint:errcheck
} else {
pipeWriter.Close()
}
}()
return pipeReader
}
// makeContextFromArchive creates a temporary directory, and a subdirectory
// inside of it, from an archive and returns its location. It can be removed
// once it's no longer needed.
test: use `T.TempDir` to create temporary test directory This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The directory created by `t.TempDir` is automatically removed when the test and all its subtests complete. Prior to this commit, temporary directory created using `ioutil.TempDir` needs to be removed manually by calling `os.RemoveAll`, which is omitted in some tests. The error handling boilerplate e.g. defer func() { if err := os.RemoveAll(dir); err != nil { t.Fatal(err) } } is also tedious, but `t.TempDir` handles this for us nicely. Reference: https://pkg.go.dev/testing#T.TempDir Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
2022-08-20 15:02:40 +08:00
func makeContextFromArchive(t *testing.T, archive io.ReadCloser, subdir string) (string, error) {
tmp := t.TempDir()
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
uidMap := []idtools.IDMap{{HostID: os.Getuid(), ContainerID: 0, Size: 1}}
gidMap := []idtools.IDMap{{HostID: os.Getgid(), ContainerID: 0, Size: 1}}
test: use `T.TempDir` to create temporary test directory This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The directory created by `t.TempDir` is automatically removed when the test and all its subtests complete. Prior to this commit, temporary directory created using `ioutil.TempDir` needs to be removed manually by calling `os.RemoveAll`, which is omitted in some tests. The error handling boilerplate e.g. defer func() { if err := os.RemoveAll(dir); err != nil { t.Fatal(err) } } is also tedious, but `t.TempDir` handles this for us nicely. Reference: https://pkg.go.dev/testing#T.TempDir Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
2022-08-20 15:02:40 +08:00
err := Put(tmp, path.Join(tmp, subdir), PutOptions{UIDMap: uidMap, GIDMap: gidMap}, archive)
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
archive.Close()
if err != nil {
return "", err
}
return tmp, err
}
// enumerateFiles walks a directory, returning the items it contains as a slice
// of names relative to that directory.
func enumerateFiles(directory string) ([]enumeratedFile, error) {
var results []enumeratedFile
err := filepath.Walk(directory, func(path string, info os.FileInfo, err error) error {
if info == nil || err != nil {
return err
}
rel, err := filepath.Rel(directory, path)
if err != nil {
return err
}
if rel != "" && rel != "." {
results = append(results, enumeratedFile{
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
name: rel,
mode: info.Mode() & os.ModePerm,
isSymlink: info.Mode()&os.ModeSymlink == os.ModeSymlink,
date: info.ModTime().UTC().String(),
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
})
}
return nil
})
if err != nil {
return nil, err
}
return results, nil
}
type expectedError struct {
inSubdir bool
name string
err error
}
type enumeratedFile struct {
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
name string
mode os.FileMode
isSymlink bool
date string
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
}
var (
testDate = time.Unix(1485449953, 0)
copier test: use correct UID/GID in test archives Handing Put() an archive which uses host IDs while also including ID maps for mapping from container IDs to host IDs is a mistake, and the tests have been failing when run by non-root users since storage v1.38 started flagging it as such. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2022-03-31 03:30:09 +08:00
uid = os.Getuid()
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
testArchiveSlice = makeArchiveSlice([]tar.Header{
CI: enable the gofumpt linter Turn on the gofumpt linter. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2024-08-16 00:50:07 +08:00
{Name: "item-0", Typeflag: tar.TypeReg, Size: 123, Mode: 0o600, ModTime: testDate},
{Name: "item-1", Typeflag: tar.TypeReg, Size: 456, Mode: 0o600, ModTime: testDate},
{Name: "item-2", Typeflag: tar.TypeReg, Size: 789, Mode: 0o600, ModTime: testDate},
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
})
testArchives = []struct {
name string
rootOnly bool
headers []tar.Header
contents map[string][]byte
excludes []string
expectedGetErrors []expectedError
subdirContents map[string][]string
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
renames []struct {
name string
renames map[string]string
expected []string
}
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
}{
{
name: "regular",
rootOnly: false,
headers: []tar.Header{
CI: enable the gofumpt linter Turn on the gofumpt linter. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2024-08-16 00:50:07 +08:00
{Name: "file-0", Typeflag: tar.TypeReg, Size: 123456789, Mode: 0o600, ModTime: testDate},
{Name: "file-a", Typeflag: tar.TypeReg, Size: 23, Mode: 0o600, ModTime: testDate},
{Name: "file-b", Typeflag: tar.TypeReg, Size: 23, Mode: 0o600, ModTime: testDate},
{Name: "file-c", Typeflag: tar.TypeLink, Linkname: "file-a", Mode: 0o600, ModTime: testDate},
{Name: "file-u", Typeflag: tar.TypeReg, Size: 23, Mode: cISUID | 0o755, ModTime: testDate},
{Name: "file-g", Typeflag: tar.TypeReg, Size: 23, Mode: cISGID | 0o755, ModTime: testDate},
{Name: "file-t", Typeflag: tar.TypeReg, Size: 23, Mode: cISVTX | 0o755, ModTime: testDate},
{Name: "link-0", Typeflag: tar.TypeSymlink, Linkname: "../file-0", Size: 123456789, Mode: 0o777, ModTime: testDate},
{Name: "link-a", Typeflag: tar.TypeSymlink, Linkname: "file-a", Size: 23, Mode: 0o777, ModTime: testDate},
{Name: "link-b", Typeflag: tar.TypeSymlink, Linkname: "../file-a", Size: 23, Mode: 0o777, ModTime: testDate},
{Name: "hlink-0", Typeflag: tar.TypeLink, Linkname: "file-0", Size: 123456789, Mode: 0o600, ModTime: testDate},
{Name: "hlink-a", Typeflag: tar.TypeLink, Linkname: "/file-a", Size: 23, Mode: 0o600, ModTime: testDate},
{Name: "hlink-b", Typeflag: tar.TypeLink, Linkname: "../file-b", Size: 23, Mode: 0o600, ModTime: testDate},
{Name: "subdir-a", Typeflag: tar.TypeDir, Mode: 0o700, ModTime: testDate},
{Name: "subdir-a/file-n", Typeflag: tar.TypeReg, Size: 108, Mode: 0o660, ModTime: testDate},
{Name: "subdir-a/file-o", Typeflag: tar.TypeReg, Size: 34, Mode: 0o660, ModTime: testDate},
{Name: "subdir-a/file-a", Typeflag: tar.TypeSymlink, Linkname: "../file-a", Size: 23, Mode: 0o777, ModTime: testDate},
{Name: "subdir-a/file-b", Typeflag: tar.TypeSymlink, Linkname: "../../file-b", Size: 23, Mode: 0o777, ModTime: testDate},
{Name: "subdir-a/file-c", Typeflag: tar.TypeSymlink, Linkname: "/file-c", Size: 23, Mode: 0o777, ModTime: testDate},
{Name: "subdir-b", Typeflag: tar.TypeDir, Mode: 0o700, ModTime: testDate},
{Name: "subdir-b/file-n", Typeflag: tar.TypeReg, Size: 216, Mode: 0o660, ModTime: testDate},
{Name: "subdir-b/file-o", Typeflag: tar.TypeReg, Size: 45, Mode: 0o660, ModTime: testDate},
{Name: "subdir-c", Typeflag: tar.TypeDir, Mode: 0o700, ModTime: testDate},
{Name: "subdir-c/file-n", Typeflag: tar.TypeReg, Size: 432, Mode: 0o666, ModTime: testDate},
{Name: "subdir-c/file-o", Typeflag: tar.TypeReg, Size: 56, Mode: 0o666, ModTime: testDate},
{Name: "subdir-d", Typeflag: tar.TypeDir, Mode: 0o700, ModTime: testDate},
{Name: "subdir-d/hlink-0", Typeflag: tar.TypeLink, Linkname: "../file-0", Size: 123456789, Mode: 0o600, ModTime: testDate},
{Name: "subdir-d/hlink-a", Typeflag: tar.TypeLink, Linkname: "/file-a", Size: 23, Mode: 0o600, ModTime: testDate},
{Name: "subdir-d/hlink-b", Typeflag: tar.TypeLink, Linkname: "../../file-b", Size: 23, Mode: 0o600, ModTime: testDate},
{Name: "archive-a", Typeflag: tar.TypeReg, Size: 0, Mode: 0o600, ModTime: testDate},
{Name: "subdir-e", Typeflag: tar.TypeDir, Mode: 0o500, ModTime: testDate},
{Name: "subdir-e/file-p", Typeflag: tar.TypeReg, Size: 890, Mode: 0o600, ModTime: testDate},
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
},
contents: map[string][]byte{
"archive-a": testArchiveSlice,
},
expectedGetErrors: []expectedError{
{inSubdir: false, name: "link-0", err: syscall.ENOENT},
{inSubdir: false, name: "link-b", err: syscall.ENOENT},
{inSubdir: false, name: "subdir-a/file-b", err: syscall.ENOENT},
{inSubdir: true, name: "link-0", err: syscall.ENOENT},
{inSubdir: true, name: "link-b", err: syscall.ENOENT},
{inSubdir: true, name: "subdir-a/file-b", err: syscall.ENOENT},
{inSubdir: true, name: "subdir-a/file-c", err: syscall.ENOENT},
},
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
renames: []struct {
name string
renames map[string]string
expected []string
}{
{
name: "no-match-dir",
renames: map[string]string{"subdir-z": "subdir-y"},
expected: []string{
"file-0",
"file-a",
"file-b",
"file-c",
"file-u",
"file-g",
"file-t",
"link-0",
"link-a",
"link-b",
"hlink-0",
"hlink-a",
"hlink-b",
"subdir-a",
"subdir-a/file-n",
"subdir-a/file-o",
"subdir-a/file-a",
"subdir-a/file-b",
"subdir-a/file-c",
"subdir-b",
"subdir-b/file-n",
"subdir-b/file-o",
"subdir-c",
"subdir-c/file-n",
"subdir-c/file-o",
"subdir-d",
"subdir-d/hlink-0",
"subdir-d/hlink-a",
"subdir-d/hlink-b",
copier.Put(): write to read-only directories Try to improve our ability to write to directories that aren't writable. If we encounter an EPERM error while attempting to create an item, attempt to temporarily make writable the directory that we're writing the item to, and restore its permissions on our way out. The error usually isn't seen when run as UID 0, whether in a user namespace or not, which is usually how we're called, but running the unit tests as an unprivileged user will verify it. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2022-04-27 05:33:10 +08:00
"subdir-e",
"subdir-e/file-p",
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
"archive-a",
},
},
{
name: "no-match-file",
renames: map[string]string{"file-n": "file-z"},
expected: []string{
"file-0",
"file-a",
"file-b",
"file-c",
"file-u",
"file-g",
"file-t",
"link-0",
"link-a",
"link-b",
"hlink-0",
"hlink-a",
"hlink-b",
"subdir-a",
"subdir-a/file-n",
"subdir-a/file-o",
"subdir-a/file-a",
"subdir-a/file-b",
"subdir-a/file-c",
"subdir-b",
"subdir-b/file-n",
"subdir-b/file-o",
"subdir-c",
"subdir-c/file-n",
"subdir-c/file-o",
"subdir-d",
"subdir-d/hlink-0",
"subdir-d/hlink-a",
"subdir-d/hlink-b",
copier.Put(): write to read-only directories Try to improve our ability to write to directories that aren't writable. If we encounter an EPERM error while attempting to create an item, attempt to temporarily make writable the directory that we're writing the item to, and restore its permissions on our way out. The error usually isn't seen when run as UID 0, whether in a user namespace or not, which is usually how we're called, but running the unit tests as an unprivileged user will verify it. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2022-04-27 05:33:10 +08:00
"subdir-e",
"subdir-e/file-p",
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
"archive-a",
},
},
{
name: "directory",
renames: map[string]string{"subdir-a": "subdir-z"},
expected: []string{
"file-0",
"file-a",
"file-b",
"file-c",
"file-u",
"file-g",
"file-t",
"link-0",
"link-a",
"link-b",
"hlink-0",
"hlink-a",
"hlink-b",
"subdir-z",
"subdir-z/file-n",
"subdir-z/file-o",
"subdir-z/file-a",
"subdir-z/file-b",
"subdir-z/file-c",
"subdir-b",
"subdir-b/file-n",
"subdir-b/file-o",
"subdir-c",
"subdir-c/file-n",
"subdir-c/file-o",
"subdir-d",
"subdir-d/hlink-0",
"subdir-d/hlink-a",
"subdir-d/hlink-b",
copier.Put(): write to read-only directories Try to improve our ability to write to directories that aren't writable. If we encounter an EPERM error while attempting to create an item, attempt to temporarily make writable the directory that we're writing the item to, and restore its permissions on our way out. The error usually isn't seen when run as UID 0, whether in a user namespace or not, which is usually how we're called, but running the unit tests as an unprivileged user will verify it. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2022-04-27 05:33:10 +08:00
"subdir-e",
"subdir-e/file-p",
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
"archive-a",
},
},
{
name: "file-in-directory",
renames: map[string]string{"subdir-a/file-n": "subdir-a/file-z"},
expected: []string{
"file-0",
"file-a",
"file-b",
"file-c",
"file-u",
"file-g",
"file-t",
"link-0",
"link-a",
"link-b",
"hlink-0",
"hlink-a",
"hlink-b",
"subdir-a",
"subdir-a/file-z",
"subdir-a/file-o",
"subdir-a/file-a",
"subdir-a/file-b",
"subdir-a/file-c",
"subdir-b",
"subdir-b/file-n",
"subdir-b/file-o",
"subdir-c",
"subdir-c/file-n",
"subdir-c/file-o",
"subdir-d",
"subdir-d/hlink-0",
"subdir-d/hlink-a",
"subdir-d/hlink-b",
copier.Put(): write to read-only directories Try to improve our ability to write to directories that aren't writable. If we encounter an EPERM error while attempting to create an item, attempt to temporarily make writable the directory that we're writing the item to, and restore its permissions on our way out. The error usually isn't seen when run as UID 0, whether in a user namespace or not, which is usually how we're called, but running the unit tests as an unprivileged user will verify it. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2022-04-27 05:33:10 +08:00
"subdir-e",
"subdir-e/file-p",
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
"archive-a",
},
},
},
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
},
{
name: "devices",
rootOnly: true,
headers: []tar.Header{
CI: enable the gofumpt linter Turn on the gofumpt linter. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2024-08-16 00:50:07 +08:00
{Name: "char-dev", Typeflag: tar.TypeChar, Devmajor: 0, Devminor: 0, Mode: 0o600, ModTime: testDate},
{Name: "blk-dev", Typeflag: tar.TypeBlock, Devmajor: 0, Devminor: 0, Mode: 0o600, ModTime: testDate},
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
},
},
}
)
func TestPutNoChroot(t *testing.T) {
couldChroot := canChroot
canChroot = false
testPut(t)
canChroot = couldChroot
}
func testPut(t *testing.T) {
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
uidMap := []idtools.IDMap{{HostID: os.Getuid(), ContainerID: 0, Size: 1}}
gidMap := []idtools.IDMap{{HostID: os.Getgid(), ContainerID: 0, Size: 1}}
for i := range testArchives {
for _, topdir := range []string{"", ".", "top"} {
t.Run(fmt.Sprintf("archive=%s,topdir=%s", testArchives[i].name, topdir), func(t *testing.T) {
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
if uid != 0 && testArchives[i].rootOnly {
t.Skipf("test archive %q can only be tested with root privileges, skipping", testArchives[i].name)
}
test: use `T.TempDir` to create temporary test directory This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The directory created by `t.TempDir` is automatically removed when the test and all its subtests complete. Prior to this commit, temporary directory created using `ioutil.TempDir` needs to be removed manually by calling `os.RemoveAll`, which is omitted in some tests. The error handling boilerplate e.g. defer func() { if err := os.RemoveAll(dir); err != nil { t.Fatal(err) } } is also tedious, but `t.TempDir` handles this for us nicely. Reference: https://pkg.go.dev/testing#T.TempDir Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
2022-08-20 15:02:40 +08:00
dir, err := makeContextFromArchive(t, makeArchive(testArchives[i].headers, testArchives[i].contents), topdir)
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
require.NoErrorf(t, err, "error creating context from archive %q, topdir=%q", testArchives[i].name, topdir)
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
// enumerate what we expect to have created
expected := make([]enumeratedFile, 0, len(testArchives[i].headers)+1)
if topdir != "" && topdir != "." {
info, err := os.Stat(filepath.Join(dir, topdir))
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
require.NoErrorf(t, err, "error statting directory %q", filepath.Join(dir, topdir))
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
expected = append(expected, enumeratedFile{
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
name: filepath.FromSlash(topdir),
mode: info.Mode() & os.ModePerm,
isSymlink: info.Mode()&os.ModeSymlink == os.ModeSymlink,
date: info.ModTime().UTC().String(),
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
})
}
for _, hdr := range testArchives[i].headers {
expected = append(expected, enumeratedFile{
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
name: filepath.Join(filepath.FromSlash(topdir), filepath.FromSlash(hdr.Name)),
mode: os.FileMode(hdr.Mode) & os.ModePerm,
isSymlink: hdr.Typeflag == tar.TypeSymlink,
date: hdr.ModTime.UTC().String(),
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
})
}
sort.Slice(expected, func(i, j int) bool { return strings.Compare(expected[i].name, expected[j].name) < 0 })
// enumerate what we actually created
fileList, err := enumerateFiles(dir)
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
require.NoErrorf(t, err, "error walking context directory for archive %q, topdir=%q", testArchives[i].name, topdir)
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
sort.Slice(fileList, func(i, j int) bool { return strings.Compare(fileList[i].name, fileList[j].name) < 0 })
// make sure they're the same
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
moddedEnumeratedFiles := func(enumerated []enumeratedFile) []enumeratedFile {
m := make([]enumeratedFile, 0, len(enumerated))
for i := range enumerated {
e := enumeratedFile{
name: enumerated[i].name,
mode: os.FileMode(int64(enumerated[i].mode) & testModeMask),
isSymlink: enumerated[i].isSymlink,
date: enumerated[i].date,
}
if testIgnoreSymlinkDates && e.isSymlink {
e.date = ""
}
m = append(m, e)
}
return m
}
if !reflect.DeepEqual(expected, fileList) && reflect.DeepEqual(moddedEnumeratedFiles(expected), moddedEnumeratedFiles(fileList)) {
logrus.Warn("chmod() lost some bits and possibly timestamps on symlinks, otherwise we match the source archive")
} else {
require.Equal(t, expected, fileList, "list of files in context directory for archive %q under topdir %q should match the archived used to populate it", testArchives[i].name, topdir)
}
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
})
}
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
for _, renames := range testArchives[i].renames {
t.Run(fmt.Sprintf("archive=%s,rename=%s", testArchives[i].name, renames.name), func(t *testing.T) {
if uid != 0 && testArchives[i].rootOnly {
t.Skipf("test archive %q can only be tested with root privileges, skipping", testArchives[i].name)
}
test: use `T.TempDir` to create temporary test directory This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The directory created by `t.TempDir` is automatically removed when the test and all its subtests complete. Prior to this commit, temporary directory created using `ioutil.TempDir` needs to be removed manually by calling `os.RemoveAll`, which is omitted in some tests. The error handling boilerplate e.g. defer func() { if err := os.RemoveAll(dir); err != nil { t.Fatal(err) } } is also tedious, but `t.TempDir` handles this for us nicely. Reference: https://pkg.go.dev/testing#T.TempDir Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
2022-08-20 15:02:40 +08:00
tmp := t.TempDir()
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
archive := makeArchive(testArchives[i].headers, testArchives[i].contents)
test: use `T.TempDir` to create temporary test directory This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The directory created by `t.TempDir` is automatically removed when the test and all its subtests complete. Prior to this commit, temporary directory created using `ioutil.TempDir` needs to be removed manually by calling `os.RemoveAll`, which is omitted in some tests. The error handling boilerplate e.g. defer func() { if err := os.RemoveAll(dir); err != nil { t.Fatal(err) } } is also tedious, but `t.TempDir` handles this for us nicely. Reference: https://pkg.go.dev/testing#T.TempDir Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
2022-08-20 15:02:40 +08:00
err := Put(tmp, tmp, PutOptions{UIDMap: uidMap, GIDMap: gidMap, Rename: renames.renames}, archive)
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
require.NoErrorf(t, err, "error extracting archive %q to directory %q", testArchives[i].name, tmp)
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
var found []string
linters: unused arguments shouldn't have names Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2024-08-07 03:07:02 +08:00
err = filepath.WalkDir(tmp, func(path string, _ fs.DirEntry, err error) error {
Switch most calls to filepath.Walk to filepath.WalkDir Should speed up most walks escpecially if they don't need to stat every directory entry. [ NO NEW TESTS NEEDED] Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2022-03-26 19:48:51 +08:00
if err != nil {
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
return err
}
rel, err := filepath.Rel(tmp, path)
if err != nil {
return err
}
if rel == "." {
return nil
}
found = append(found, rel)
return nil
})
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
require.NoErrorf(t, err, "error walking context directory for archive %q under %q", testArchives[i].name, tmp)
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
sort.Strings(found)
expected := renames.expected
sort.Strings(expected)
assert.Equal(t, expected, found, "renaming did not work as expected")
})
}
}
copier: add `NoOverwriteNonDirDir` option Similar to the `NoOverwriteDirNonDir` one, add an option that disables non-directories from being overwritten by directories. Required-for: containers/podman/issues/14420 Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
2022-06-07 18:54:07 +08:00
// Overwrite directory
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
for _, overwrite := range []bool{false, true} {
for _, typeFlag := range []byte{tar.TypeReg, tar.TypeLink, tar.TypeSymlink, tar.TypeChar, tar.TypeBlock, tar.TypeFifo} {
copier: add `NoOverwriteNonDirDir` option Similar to the `NoOverwriteDirNonDir` one, add an option that disables non-directories from being overwritten by directories. Required-for: containers/podman/issues/14420 Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
2022-06-07 18:54:07 +08:00
t.Run(fmt.Sprintf("overwrite (dir)=%v,type=%c", overwrite, typeFlag), func(t *testing.T) {
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
archive := makeArchiveSlice([]tar.Header{
CI: enable the gofumpt linter Turn on the gofumpt linter. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2024-08-16 00:50:07 +08:00
{Name: "target", Typeflag: tar.TypeSymlink, Mode: 0o755, Linkname: "target", ModTime: testDate},
{Name: "target", Typeflag: tar.TypeDir, Mode: 0o755, ModTime: testDate},
{Name: "target", Typeflag: tar.TypeSymlink, Mode: 0o755, Linkname: "target", ModTime: testDate},
{Name: "target", Typeflag: tar.TypeReg, Size: 123, Mode: 0o755, ModTime: testDate},
{Name: "test", Typeflag: tar.TypeDir, Size: 0, Mode: 0o755, ModTime: testDate},
{Name: "test/content", Typeflag: tar.TypeReg, Size: 0, Mode: 0o755, ModTime: testDate},
{Name: "test", Typeflag: typeFlag, Size: 0, Mode: 0o755, Linkname: "target", ModTime: testDate},
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
})
test: use `T.TempDir` to create temporary test directory This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The directory created by `t.TempDir` is automatically removed when the test and all its subtests complete. Prior to this commit, temporary directory created using `ioutil.TempDir` needs to be removed manually by calling `os.RemoveAll`, which is omitted in some tests. The error handling boilerplate e.g. defer func() { if err := os.RemoveAll(dir); err != nil { t.Fatal(err) } } is also tedious, but `t.TempDir` handles this for us nicely. Reference: https://pkg.go.dev/testing#T.TempDir Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
2022-08-20 15:02:40 +08:00
tmp := t.TempDir()
err := Put(tmp, tmp, PutOptions{UIDMap: uidMap, GIDMap: gidMap, NoOverwriteDirNonDir: !overwrite}, bytes.NewReader(archive))
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
if overwrite {
Drop util/util.Cause() Use errors.Is() and errors.As() instead of our own call-errors.Unwrap()-over-and-over-again helper. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2022-08-18 02:44:08 +08:00
if !errors.Is(err, syscall.EPERM) {
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
assert.Nilf(t, err, "expected to overwrite directory with type %c: %v", typeFlag, err)
}
} else {
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
assert.Errorf(t, err, "expected an error trying to overwrite directory with type %c", typeFlag)
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
}
})
}
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
}
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
copier: add `NoOverwriteNonDirDir` option Similar to the `NoOverwriteDirNonDir` one, add an option that disables non-directories from being overwritten by directories. Required-for: containers/podman/issues/14420 Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
2022-06-07 18:54:07 +08:00
// Overwrite non-directory
for _, overwrite := range []bool{false, true} {
for _, typeFlag := range []byte{tar.TypeReg, tar.TypeLink, tar.TypeSymlink, tar.TypeChar, tar.TypeBlock, tar.TypeFifo} {
t.Run(fmt.Sprintf("overwrite (non-dir)=%v,type=%c", overwrite, typeFlag), func(t *testing.T) {
archive := makeArchiveSlice([]tar.Header{
CI: enable the gofumpt linter Turn on the gofumpt linter. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2024-08-16 00:50:07 +08:00
{Name: "target", Typeflag: tar.TypeSymlink, Mode: 0o755, Linkname: "target", ModTime: testDate},
{Name: "target", Typeflag: tar.TypeReg, Mode: 0o755, ModTime: testDate},
{Name: "target", Typeflag: tar.TypeSymlink, Mode: 0o755, Linkname: "target", ModTime: testDate},
{Name: "target", Typeflag: tar.TypeReg, Size: 123, Mode: 0o755, ModTime: testDate},
{Name: "test", Typeflag: typeFlag, Size: 0, Mode: 0o755, Linkname: "target", ModTime: testDate},
{Name: "test", Typeflag: tar.TypeDir, Size: 0, Mode: 0o755, ModTime: testDate},
{Name: "test/content", Typeflag: tar.TypeReg, Size: 0, Mode: 0o755, ModTime: testDate},
copier: add `NoOverwriteNonDirDir` option Similar to the `NoOverwriteDirNonDir` one, add an option that disables non-directories from being overwritten by directories. Required-for: containers/podman/issues/14420 Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
2022-06-07 18:54:07 +08:00
})
test: use `T.TempDir` to create temporary test directory This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The directory created by `t.TempDir` is automatically removed when the test and all its subtests complete. Prior to this commit, temporary directory created using `ioutil.TempDir` needs to be removed manually by calling `os.RemoveAll`, which is omitted in some tests. The error handling boilerplate e.g. defer func() { if err := os.RemoveAll(dir); err != nil { t.Fatal(err) } } is also tedious, but `t.TempDir` handles this for us nicely. Reference: https://pkg.go.dev/testing#T.TempDir Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
2022-08-20 15:02:40 +08:00
tmp := t.TempDir()
err := Put(tmp, tmp, PutOptions{UIDMap: uidMap, GIDMap: gidMap, NoOverwriteNonDirDir: !overwrite}, bytes.NewReader(archive))
copier: add `NoOverwriteNonDirDir` option Similar to the `NoOverwriteDirNonDir` one, add an option that disables non-directories from being overwritten by directories. Required-for: containers/podman/issues/14420 Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
2022-06-07 18:54:07 +08:00
if overwrite {
Drop util/util.Cause() Use errors.Is() and errors.As() instead of our own call-errors.Unwrap()-over-and-over-again helper. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2022-08-18 02:44:08 +08:00
if !errors.Is(err, syscall.EPERM) {
copier: add `NoOverwriteNonDirDir` option Similar to the `NoOverwriteDirNonDir` one, add an option that disables non-directories from being overwritten by directories. Required-for: containers/podman/issues/14420 Signed-off-by: Valentin Rothberg <vrothberg@redhat.com>
2022-06-07 18:54:07 +08:00
assert.Nilf(t, err, "expected to overwrite file with type %c: %v", typeFlag, err)
}
} else {
assert.Errorf(t, err, "expected an error trying to overwrite file of type %c", typeFlag)
}
})
}
}
copier.PutOptions: add an "IgnoreDevices" flag Prior to 1.16, when ADDing contents to a working container, if we were being run by an unprivileged user using a user namespace, content that was a device node would be ignored. Add a flag in copier.PutOptions that tells copier.Put() to ignore entries that are either a device, or a hard link to a device. Make buildah.Add() set the IgnoreDevices flag in PutOptions when libcontainer says we're running in a user namespace. Together, these two changes should restore the earlier behavior. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-01-05 05:44:30 +08:00
for _, ignoreDevices := range []bool{false, true} {
for _, typeFlag := range []byte{tar.TypeChar, tar.TypeBlock} {
t.Run(fmt.Sprintf("ignoreDevices=%v,type=%c", ignoreDevices, typeFlag), func(t *testing.T) {
if uid != 0 && !ignoreDevices {
t.Skip("can only test !IgnoreDevices with root privileges, skipping")
}
archive := makeArchiveSlice([]tar.Header{
CI: enable the gofumpt linter Turn on the gofumpt linter. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2024-08-16 00:50:07 +08:00
{Name: "test", Typeflag: typeFlag, Size: 0, Mode: 0o600, ModTime: testDate, Devmajor: 0, Devminor: 0},
{Name: "link", Typeflag: tar.TypeLink, Size: 0, Mode: 0o600, ModTime: testDate, Linkname: "test"},
{Name: "unrelated", Typeflag: tar.TypeReg, Size: 0, Mode: 0o600, ModTime: testDate},
copier.PutOptions: add an "IgnoreDevices" flag Prior to 1.16, when ADDing contents to a working container, if we were being run by an unprivileged user using a user namespace, content that was a device node would be ignored. Add a flag in copier.PutOptions that tells copier.Put() to ignore entries that are either a device, or a hard link to a device. Make buildah.Add() set the IgnoreDevices flag in PutOptions when libcontainer says we're running in a user namespace. Together, these two changes should restore the earlier behavior. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-01-05 05:44:30 +08:00
})
test: use `T.TempDir` to create temporary test directory This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The directory created by `t.TempDir` is automatically removed when the test and all its subtests complete. Prior to this commit, temporary directory created using `ioutil.TempDir` needs to be removed manually by calling `os.RemoveAll`, which is omitted in some tests. The error handling boilerplate e.g. defer func() { if err := os.RemoveAll(dir); err != nil { t.Fatal(err) } } is also tedious, but `t.TempDir` handles this for us nicely. Reference: https://pkg.go.dev/testing#T.TempDir Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
2022-08-20 15:02:40 +08:00
tmp := t.TempDir()
err := Put(tmp, tmp, PutOptions{UIDMap: uidMap, GIDMap: gidMap, IgnoreDevices: ignoreDevices}, bytes.NewReader(archive))
copier.PutOptions: add an "IgnoreDevices" flag Prior to 1.16, when ADDing contents to a working container, if we were being run by an unprivileged user using a user namespace, content that was a device node would be ignored. Add a flag in copier.PutOptions that tells copier.Put() to ignore entries that are either a device, or a hard link to a device. Make buildah.Add() set the IgnoreDevices flag in PutOptions when libcontainer says we're running in a user namespace. Together, these two changes should restore the earlier behavior. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-01-05 05:44:30 +08:00
require.Nilf(t, err, "expected to extract content with typeflag %c without an error: %v", typeFlag, err)
fileList, err := enumerateFiles(tmp)
require.Nilf(t, err, "unexpected error scanning the contents of extraction directory for typeflag %c: %v", typeFlag, err)
expectedItems := 3
if ignoreDevices {
expectedItems = 1
}
require.Equalf(t, expectedItems, len(fileList), "didn't extract as many things as expected for typeflag %c", typeFlag)
})
}
}
copier.PutOptions: add StripSetuidBit/StripSetgidBit/StripStickyBit Add StripSetuidBit/StripSetgidBit/StripStickyBit flags to copier.PutOptions, that are interpreted similarly to their counterparts in copier.GetOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2022-04-28 04:56:14 +08:00
for _, stripSetuidBit := range []bool{false, true} {
for _, stripSetgidBit := range []bool{false, true} {
for _, stripStickyBit := range []bool{false, true} {
t.Run(fmt.Sprintf("stripSetuidBit=%v,stripSetgidBit=%v,stripStickyBit=%v", stripSetuidBit, stripSetgidBit, stripStickyBit), func(t *testing.T) {
mode := int64(0o700) | cISUID | cISGID | cISVTX
archive := makeArchiveSlice([]tar.Header{
{Name: "test", Typeflag: tar.TypeReg, Size: 0, Mode: mode, ModTime: testDate},
})
test: use `T.TempDir` to create temporary test directory This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The directory created by `t.TempDir` is automatically removed when the test and all its subtests complete. Prior to this commit, temporary directory created using `ioutil.TempDir` needs to be removed manually by calling `os.RemoveAll`, which is omitted in some tests. The error handling boilerplate e.g. defer func() { if err := os.RemoveAll(dir); err != nil { t.Fatal(err) } } is also tedious, but `t.TempDir` handles this for us nicely. Reference: https://pkg.go.dev/testing#T.TempDir Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
2022-08-20 15:02:40 +08:00
tmp := t.TempDir()
copier.PutOptions: add StripSetuidBit/StripSetgidBit/StripStickyBit Add StripSetuidBit/StripSetgidBit/StripStickyBit flags to copier.PutOptions, that are interpreted similarly to their counterparts in copier.GetOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2022-04-28 04:56:14 +08:00
putOptions := PutOptions{
UIDMap: uidMap,
GIDMap: gidMap,
StripSetuidBit: stripSetuidBit,
StripSetgidBit: stripSetgidBit,
StripStickyBit: stripStickyBit,
}
test: use `T.TempDir` to create temporary test directory This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The directory created by `t.TempDir` is automatically removed when the test and all its subtests complete. Prior to this commit, temporary directory created using `ioutil.TempDir` needs to be removed manually by calling `os.RemoveAll`, which is omitted in some tests. The error handling boilerplate e.g. defer func() { if err := os.RemoveAll(dir); err != nil { t.Fatal(err) } } is also tedious, but `t.TempDir` handles this for us nicely. Reference: https://pkg.go.dev/testing#T.TempDir Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
2022-08-20 15:02:40 +08:00
err := Put(tmp, tmp, putOptions, bytes.NewReader(archive))
copier.PutOptions: add StripSetuidBit/StripSetgidBit/StripStickyBit Add StripSetuidBit/StripSetgidBit/StripStickyBit flags to copier.PutOptions, that are interpreted similarly to their counterparts in copier.GetOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2022-04-28 04:56:14 +08:00
require.Nilf(t, err, "unexpected error writing sample file", err)
st, err := os.Stat(filepath.Join(tmp, "test"))
require.Nilf(t, err, "unexpected error checking permissions of file", err)
assert.Equalf(t, stripSetuidBit, st.Mode()&os.ModeSetuid == 0, "setuid bit was not set/stripped correctly")
assert.Equalf(t, stripSetgidBit, st.Mode()&os.ModeSetgid == 0, "setgid bit was not set/stripped correctly")
assert.Equalf(t, stripStickyBit, st.Mode()&os.ModeSticky == 0, "sticky bit was not set/stripped correctly")
})
}
}
}
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
}
func isExpectedError(err error, inSubdir bool, name string, expectedErrors []expectedError) bool {
// if we couldn't read that content, check if it's one of the expected failures
for _, expectedError := range expectedErrors {
if expectedError.inSubdir != inSubdir {
continue
}
if expectedError.name != name {
continue
}
Drop util/util.Cause() Use errors.Is() and errors.As() instead of our own call-errors.Unwrap()-over-and-over-again helper. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2022-08-18 02:44:08 +08:00
if !strings.Contains(err.Error(), expectedError.err.Error()) {
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
// not expecting this specific error
continue
}
// it's an expected failure
return true
}
return false
}
func TestStatNoChroot(t *testing.T) {
couldChroot := canChroot
canChroot = false
testStat(t)
canChroot = couldChroot
}
func testStat(t *testing.T) {
for _, absolute := range []bool{false, true} {
for _, topdir := range []string{"", ".", "top"} {
for _, testArchive := range testArchives {
if uid != 0 && testArchive.rootOnly {
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
t.Logf("test archive %q can only be tested with root privileges, skipping", testArchive.name)
continue
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
}
test: use `T.TempDir` to create temporary test directory This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The directory created by `t.TempDir` is automatically removed when the test and all its subtests complete. Prior to this commit, temporary directory created using `ioutil.TempDir` needs to be removed manually by calling `os.RemoveAll`, which is omitted in some tests. The error handling boilerplate e.g. defer func() { if err := os.RemoveAll(dir); err != nil { t.Fatal(err) } } is also tedious, but `t.TempDir` handles this for us nicely. Reference: https://pkg.go.dev/testing#T.TempDir Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
2022-08-20 15:02:40 +08:00
dir, err := makeContextFromArchive(t, makeArchive(testArchive.headers, testArchive.contents), topdir)
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
require.NoErrorf(t, err, "error creating context from archive %q", testArchive.name)
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
root := dir
for _, testItem := range testArchive.headers {
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
name := filepath.FromSlash(testItem.Name)
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
if absolute {
name = filepath.Join(root, topdir, name)
}
t.Run(fmt.Sprintf("absolute=%t,topdir=%s,archive=%s,item=%s", absolute, topdir, testArchive.name, name), func(t *testing.T) {
// read stats about this item
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
var excludes []string
for _, exclude := range testArchive.excludes {
excludes = append(excludes, filepath.FromSlash(exclude))
}
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
options := StatOptions{
CheckForArchives: false,
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
Excludes: excludes,
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
}
stats, err := Stat(root, topdir, options, []string{name})
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
require.NoErrorf(t, err, "error statting %q: %v", name, err)
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
for _, st := range stats {
// should not have gotten an error
require.Emptyf(t, st.Error, "expected no error from stat %q", st.Glob)
// no matching characters -> should have matched one item
require.NotEmptyf(t, st.Globbed, "expected at least one match on glob %q", st.Glob)
matches := 0
for _, glob := range st.Globbed {
matches++
require.Equal(t, st.Glob, glob, "expected entry for %q", st.Glob)
require.NotNil(t, st.Results[glob], "%q globbed %q, but there are no results for it", st.Glob, glob)
toStat := glob
if !absolute {
toStat = filepath.Join(root, topdir, name)
}
_, err = os.Lstat(toStat)
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
require.NoErrorf(t, err, "got error on lstat() of returned value %q(%q(%q)): %v", toStat, glob, name, err)
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
result := st.Results[glob]
switch testItem.Typeflag {
Remove use of deprecated tar.TypeRegA Fixes golangci-lint message: `tar.TypeRegA has been deprecated since Go 1.11 and an alternative has been available since Go 1.1: Use TypeReg instead.` Signed-off-by: Chris Evich <cevich@redhat.com>
2023-05-05 00:09:49 +08:00
case tar.TypeReg:
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
if actualContent, ok := testArchive.contents[testItem.Name]; ok {
testItem.Size = int64(len(actualContent))
}
require.Equal(t, testItem.Size, result.Size, "unexpected size difference for %q", name)
require.True(t, result.IsRegular, "expected %q.IsRegular to be true", glob)
require.False(t, result.IsDir, "expected %q.IsDir to be false", glob)
require.False(t, result.IsSymlink, "expected %q.IsSymlink to be false", glob)
case tar.TypeDir:
require.False(t, result.IsRegular, "expected %q.IsRegular to be false", glob)
require.True(t, result.IsDir, "expected %q.IsDir to be true", glob)
require.False(t, result.IsSymlink, "expected %q.IsSymlink to be false", glob)
case tar.TypeSymlink:
require.True(t, result.IsSymlink, "%q is supposed to be a symbolic link, but is not", name)
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
require.Equal(t, filepath.FromSlash(testItem.Linkname), result.ImmediateTarget, "%q is supposed to point to %q, but points to %q", glob, testItem.Linkname, result.ImmediateTarget)
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
case tar.TypeBlock, tar.TypeChar:
require.False(t, result.IsRegular, "%q is a regular file, but is not supposed to be", name)
require.False(t, result.IsDir, "%q is a directory, but is not supposed to be", name)
require.False(t, result.IsSymlink, "%q is not supposed to be a symbolic link, but appears to be one", name)
}
}
require.Equal(t, 1, matches, "non-glob %q matched %d items, not exactly one", name, matches)
}
})
}
}
}
}
}
func TestGetSingleNoChroot(t *testing.T) {
couldChroot := canChroot
canChroot = false
testGetSingle(t)
canChroot = couldChroot
}
func testGetSingle(t *testing.T) {
for _, absolute := range []bool{false, true} {
for _, topdir := range []string{"", ".", "top"} {
for _, testArchive := range testArchives {
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
var excludes []string
for _, exclude := range testArchive.excludes {
excludes = append(excludes, filepath.FromSlash(exclude))
}
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
getOptions := GetOptions{
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
Excludes: excludes,
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
ExpandArchives: false,
}
if uid != 0 && testArchive.rootOnly {
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
t.Logf("test archive %q can only be tested with root privileges, skipping", testArchive.name)
continue
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
}
test: use `T.TempDir` to create temporary test directory This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The directory created by `t.TempDir` is automatically removed when the test and all its subtests complete. Prior to this commit, temporary directory created using `ioutil.TempDir` needs to be removed manually by calling `os.RemoveAll`, which is omitted in some tests. The error handling boilerplate e.g. defer func() { if err := os.RemoveAll(dir); err != nil { t.Fatal(err) } } is also tedious, but `t.TempDir` handles this for us nicely. Reference: https://pkg.go.dev/testing#T.TempDir Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
2022-08-20 15:02:40 +08:00
dir, err := makeContextFromArchive(t, makeArchive(testArchive.headers, testArchive.contents), topdir)
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
require.NoErrorf(t, err, "error creating context from archive %q", testArchive.name)
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
root := dir
for _, testItem := range testArchive.headers {
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
name := filepath.FromSlash(testItem.Name)
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
if absolute {
name = filepath.Join(root, topdir, name)
}
t.Run(fmt.Sprintf("absolute=%t,topdir=%s,archive=%s,item=%s", absolute, topdir, testArchive.name, name), func(t *testing.T) {
// check if we can get this one item
Replace io/ioutil calls with os calls In golang 1.19, `io/ioutil` is fully deprecated preventing Buildah from compiling. Replace all calls with equivalent calls from the `os` package. Signed-off-by: Chris Evich <cevich@redhat.com>
2022-11-15 00:22:45 +08:00
err := Get(root, topdir, getOptions, []string{name}, io.Discard)
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
// if we couldn't read that content, check if it's one of the expected failures
if err != nil && isExpectedError(err, topdir != "" && topdir != ".", testItem.Name, testArchive.expectedGetErrors) {
return
}
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
require.NoErrorf(t, err, "error getting %q under %q", name, filepath.Join(root, topdir))
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
// we'll check subdirectories later
if testItem.Typeflag == tar.TypeDir {
return
}
// check what we get when we get this one item
pipeReader, pipeWriter := io.Pipe()
var getErr error
var wg sync.WaitGroup
wg.Add(1)
go func() {
getErr = Get(root, topdir, getOptions, []string{name}, pipeWriter)
pipeWriter.Close()
wg.Done()
}()
tr := tar.NewReader(pipeReader)
hdr, err := tr.Next()
for err == nil {
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
assert.Equal(t, filepath.Base(name), filepath.FromSlash(hdr.Name), "expected item named %q, got %q", filepath.Base(name), filepath.FromSlash(hdr.Name))
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
hdr, err = tr.Next()
}
assert.Equal(t, io.EOF.Error(), err.Error(), "expected EOF at end of archive, got %q", err.Error())
copier: split StripSetidBits into StripSetuidBit/StripSetgidBit/StripStickyBit For the sake of conformance tests, callers need to be able to strip setuid and setgid bits from contents being copied from the build context while leaving the sticky bit intact. Split the StripSetidBits option for copier.Get() into three separate flags (StripSetuidBit / StripSetgidBit / StripStickyBit). Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-29 04:36:39 +08:00
if !t.Failed() && testItem.Typeflag == tar.TypeReg && testItem.Mode&(cISUID|cISGID|cISVTX) != 0 {
for _, stripSetuidBit := range []bool{false, true} {
for _, stripSetgidBit := range []bool{false, true} {
for _, stripStickyBit := range []bool{false, true} {
t.Run(fmt.Sprintf("absolute=%t,topdir=%s,archive=%s,item=%s,strip_setuid=%t,strip_setgid=%t,strip_sticky=%t", absolute, topdir, testArchive.name, name, stripSetuidBit, stripSetgidBit, stripStickyBit), func(t *testing.T) {
var getErr error
var wg sync.WaitGroup
getOptions := getOptions
getOptions.StripSetuidBit = stripSetuidBit
getOptions.StripSetgidBit = stripSetgidBit
getOptions.StripStickyBit = stripStickyBit
pipeReader, pipeWriter := io.Pipe()
wg.Add(1)
go func() {
getErr = Get(root, topdir, getOptions, []string{name}, pipeWriter)
pipeWriter.Close()
wg.Done()
}()
tr := tar.NewReader(pipeReader)
hdr, err := tr.Next()
for err == nil {
expectedMode := testItem.Mode
modifier := ""
if stripSetuidBit {
expectedMode &^= cISUID
modifier += "(with setuid bit stripped) "
}
if stripSetgidBit {
expectedMode &^= cISGID
modifier += "(with setgid bit stripped) "
}
if stripStickyBit {
expectedMode &^= cISVTX
modifier += "(with sticky bit stripped) "
}
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
if expectedMode != hdr.Mode && expectedMode&testModeMask == hdr.Mode&testModeMask {
logrus.Warnf("chmod() lost some bits: expected 0%o, got 0%o", expectedMode, hdr.Mode)
} else {
assert.Equal(t, expectedMode, hdr.Mode, "expected item named %q %sto have mode 0%o, got 0%o", hdr.Name, modifier, expectedMode, hdr.Mode)
}
copier: split StripSetidBits into StripSetuidBit/StripSetgidBit/StripStickyBit For the sake of conformance tests, callers need to be able to strip setuid and setgid bits from contents being copied from the build context while leaving the sticky bit intact. Split the StripSetidBits option for copier.Get() into three separate flags (StripSetuidBit / StripSetgidBit / StripStickyBit). Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-29 04:36:39 +08:00
hdr, err = tr.Next()
}
assert.Equal(t, io.EOF.Error(), err.Error(), "expected EOF at end of archive, got %q", err.Error())
wg.Wait()
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
assert.NoErrorf(t, getErr, "unexpected error from Get(%q): %v", name, getErr)
copier: split StripSetidBits into StripSetuidBit/StripSetgidBit/StripStickyBit For the sake of conformance tests, callers need to be able to strip setuid and setgid bits from contents being copied from the build context while leaving the sticky bit intact. Split the StripSetidBits option for copier.Get() into three separate flags (StripSetuidBit / StripSetgidBit / StripStickyBit). Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-29 04:36:39 +08:00
pipeReader.Close()
})
}
}
}
}
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
wg.Wait()
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
assert.NoErrorf(t, getErr, "unexpected error from Get(%q): %v", name, getErr)
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
pipeReader.Close()
})
}
}
}
}
}
func TestGetMultipleNoChroot(t *testing.T) {
couldChroot := canChroot
canChroot = false
testGetMultiple(t)
canChroot = couldChroot
}
func testGetMultiple(t *testing.T) {
type getTestArchiveCase struct {
name string
pattern string
exclude []string
items []string
expandArchives bool
copier: split StripSetidBits into StripSetuidBit/StripSetgidBit/StripStickyBit For the sake of conformance tests, callers need to be able to strip setuid and setgid bits from contents being copied from the build context while leaving the sticky bit intact. Split the StripSetidBits option for copier.Get() into three separate flags (StripSetuidBit / StripSetgidBit / StripStickyBit). Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-29 04:36:39 +08:00
stripSetuidBit bool
stripSetgidBit bool
stripStickyBit bool
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
stripXattrs bool
keepDirectoryNames bool
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
renames map[string]string
copier.GetOptions: add NoDerefSymLinks Add a NoDerefSymlinks flag to force items that are matched to the Globs we're given to be treated as symlinks, rather than dereferencing them as we would need to do for sources for ADD or COPY. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-18 02:44:40 +08:00
noDerefSymlinks bool
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
}
CI: enable the gofumpt linter Turn on the gofumpt linter. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2024-08-16 00:50:07 +08:00
getTestArchives := []struct {
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
name string
headers []tar.Header
contents map[string][]byte
cases []getTestArchiveCase
expectedGetErrors []expectedError
}{
{
name: "regular",
headers: []tar.Header{
CI: enable the gofumpt linter Turn on the gofumpt linter. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2024-08-16 00:50:07 +08:00
{Name: "file-0", Typeflag: tar.TypeReg, Size: 123456789, Mode: 0o600},
{Name: "file-a", Typeflag: tar.TypeReg, Size: 23, Mode: 0o600},
{Name: "file-b", Typeflag: tar.TypeReg, Size: 23, Mode: 0o600},
{Name: "link-a", Typeflag: tar.TypeSymlink, Linkname: "file-a", Size: 23, Mode: 0o600},
{Name: "link-c", Typeflag: tar.TypeSymlink, Linkname: "subdir-c", Mode: 0o700, ModTime: testDate},
{Name: "archive-a", Typeflag: tar.TypeReg, Size: 0, Mode: 0o600},
{Name: "non-archive-a", Typeflag: tar.TypeReg, Size: 1199, Mode: 0o600},
{Name: "hlink-0", Typeflag: tar.TypeLink, Linkname: "file-0", Size: 123456789, Mode: 0o600},
{Name: "something-a", Typeflag: tar.TypeReg, Size: 34, Mode: 0o600},
{Name: "subdir-a", Typeflag: tar.TypeDir, Mode: 0o700},
{Name: "subdir-a/file-n", Typeflag: tar.TypeReg, Size: 108, Mode: 0o660},
{Name: "subdir-a/file-o", Typeflag: tar.TypeReg, Size: 45, Mode: 0o660},
{Name: "subdir-a/file-a", Typeflag: tar.TypeSymlink, Linkname: "../file-a", Size: 23, Mode: 0o600},
{Name: "subdir-a/file-b", Typeflag: tar.TypeSymlink, Linkname: "../../file-b", Size: 23, Mode: 0o600},
{Name: "subdir-a/file-c", Typeflag: tar.TypeReg, Size: 56, Mode: 0o600},
{Name: "subdir-b", Typeflag: tar.TypeDir, Mode: 0o700},
{Name: "subdir-b/file-n", Typeflag: tar.TypeReg, Size: 216, Mode: 0o660},
{Name: "subdir-b/file-o", Typeflag: tar.TypeReg, Size: 67, Mode: 0o660},
{Name: "subdir-c", Typeflag: tar.TypeDir, Mode: 0o700},
{Name: "subdir-c/file-p", Typeflag: tar.TypeReg, Size: 432, Mode: 0o666},
{Name: "subdir-c/file-q", Typeflag: tar.TypeReg, Size: 78, Mode: 0o666},
{Name: "subdir-d", Typeflag: tar.TypeDir, Mode: 0o700},
{Name: "subdir-d/hlink-0", Typeflag: tar.TypeLink, Linkname: "../file-0", Size: 123456789, Mode: 0o600},
{Name: "subdir-e", Typeflag: tar.TypeDir, Mode: 0o700},
{Name: "subdir-e/subdir-f", Typeflag: tar.TypeDir, Mode: 0o700},
{Name: "subdir-e/subdir-f/hlink-b", Typeflag: tar.TypeLink, Linkname: "../../file-b", Size: 23, Mode: 0o600},
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
},
contents: map[string][]byte{
"archive-a": testArchiveSlice,
},
expectedGetErrors: []expectedError{
{inSubdir: true, name: ".", err: syscall.ENOENT},
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
{inSubdir: true, name: "/subdir-b/*", err: syscall.ENOENT},
{inSubdir: true, name: "../../subdir-b/*", err: syscall.ENOENT},
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
},
cases: []getTestArchiveCase{
{
name: "everything",
pattern: ".",
items: []string{
"file-0",
"file-a",
"file-b",
"link-a",
copier.GetOptions: add NoDerefSymLinks Add a NoDerefSymlinks flag to force items that are matched to the Globs we're given to be treated as symlinks, rather than dereferencing them as we would need to do for sources for ADD or COPY. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-18 02:44:40 +08:00
"link-c",
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
"hlink-0",
"something-a",
"archive-a",
"non-archive-a",
"subdir-a",
"subdir-a/file-n",
"subdir-a/file-o",
"subdir-a/file-a",
"subdir-a/file-b",
"subdir-a/file-c",
"subdir-b",
"subdir-b/file-n",
"subdir-b/file-o",
"subdir-c",
"subdir-c/file-p",
"subdir-c/file-q",
"subdir-d",
"subdir-d/hlink-0",
"subdir-e",
"subdir-e/subdir-f",
"subdir-e/subdir-f/hlink-b",
},
},
{
name: "wildcard",
pattern: "*",
items: []string{
"file-0",
"file-a",
"file-b",
"link-a",
"hlink-0",
"something-a",
"archive-a",
"non-archive-a",
"file-n", // from subdir-a
"file-o", // from subdir-a
"file-a", // from subdir-a
"file-b", // from subdir-a
"file-c", // from subdir-a
"file-n", // from subdir-b
"file-o", // from subdir-b
"file-p", // from subdir-c
copier.GetOptions: add NoDerefSymLinks Add a NoDerefSymlinks flag to force items that are matched to the Globs we're given to be treated as symlinks, rather than dereferencing them as we would need to do for sources for ADD or COPY. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-18 02:44:40 +08:00
"file-p", // from link-c -> subdir-c
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
"file-q", // from subdir-c
copier.GetOptions: add NoDerefSymLinks Add a NoDerefSymlinks flag to force items that are matched to the Globs we're given to be treated as symlinks, rather than dereferencing them as we would need to do for sources for ADD or COPY. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-18 02:44:40 +08:00
"file-q", // from link-c -> subdir-c
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
"hlink-0", // from subdir-d
"subdir-f", // from subdir-e
"subdir-f/hlink-b", // from subdir-e
},
},
{
name: "dot-with-wildcard-includes-and-excludes",
pattern: ".",
exclude: []string{"**/*-a", "!**/*-c"},
items: []string{
"file-0",
"file-b",
copier.GetOptions: add NoDerefSymLinks Add a NoDerefSymlinks flag to force items that are matched to the Globs we're given to be treated as symlinks, rather than dereferencing them as we would need to do for sources for ADD or COPY. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-18 02:44:40 +08:00
"link-c",
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
"hlink-0",
copier.Get(): try to avoid descending into directories When processing a directory tree, only descend into a directory that is marked for exclusion if its path is literally a prefix of an exception pattern. Subtly, but in a way that's compatible with docker, this means that if we exclude directory "subdir", but we've been told to also include "**/file" (with an exclusion pattern of "!**/file"), we won't descend into "subdir" and find a file named "subdir/file", because "**/file" doesn't start with "subdir/". More generally, exclusion patterns that start with "!" which include any wildcards before their final component technically won't be treated correctly. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-08-24 22:41:16 +08:00
// "subdir-a/file-c", // strings.HasPrefix("**/*-c", "subdir-a/") is false
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
"subdir-b",
"subdir-b/file-n",
"subdir-b/file-o",
"subdir-c",
"subdir-c/file-p",
"subdir-c/file-q",
"subdir-d",
"subdir-d/hlink-0",
"subdir-e",
"subdir-e/subdir-f",
"subdir-e/subdir-f/hlink-b",
},
},
{
name: "everything-with-wildcard-includes-and-excludes",
pattern: "*",
exclude: []string{"**/*-a", "!**/*-c"},
items: []string{
"file-0",
"file-b",
ADD and COPY: descend into excluded directories, sometimes When a directly-named (or globbed) source directory for ADD or COPY is marked for exclusion by .dockerignore, check if its name is a prefix for any exceptions in the .dockerignore file, and if it is, check the directory for things we need to include anyway. This will miss exceptions where the pattern uses a wildcard for anything but the final component. When adding items, count items that are actually passed over the tar pipe, rather than items scanned, so that we can correctly diagnose not having found anything that we needed to copy under a directory that would otherwise have been excluded. In copierHandlerGet(), just don't discount any globbed directories that are excluded. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-10-06 05:43:49 +08:00
"file-c",
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
"file-n",
"file-o",
copier.GetOptions: add NoDerefSymLinks Add a NoDerefSymlinks flag to force items that are matched to the Globs we're given to be treated as symlinks, rather than dereferencing them as we would need to do for sources for ADD or COPY. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-18 02:44:40 +08:00
"file-p", // from subdir-c
"file-p", // from link-c -> subdir-c
"file-q", // from subdir-c
"file-q", // from link-c -> subdir-c
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
"hlink-0",
"hlink-0",
"subdir-f",
"subdir-f/hlink-b",
},
},
{
name: "dot-with-dot-exclude",
pattern: ".",
exclude: []string{".", "!**/*-c"},
items: []string{
"file-0",
"file-a",
"file-b",
"link-a",
copier.GetOptions: add NoDerefSymLinks Add a NoDerefSymlinks flag to force items that are matched to the Globs we're given to be treated as symlinks, rather than dereferencing them as we would need to do for sources for ADD or COPY. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-18 02:44:40 +08:00
"link-c",
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
"hlink-0",
"something-a",
"archive-a",
"non-archive-a",
"subdir-a",
"subdir-a/file-a",
"subdir-a/file-b",
"subdir-a/file-c",
"subdir-a/file-n",
"subdir-a/file-o",
"subdir-b",
"subdir-b/file-n",
"subdir-b/file-o",
"subdir-c",
"subdir-c/file-p",
"subdir-c/file-q",
"subdir-d",
"subdir-d/hlink-0",
"subdir-e",
"subdir-e/subdir-f",
"subdir-e/subdir-f/hlink-b",
},
},
{
name: "everything-with-dot-exclude",
pattern: "*",
exclude: []string{".", "!**/*-c"},
items: []string{
"file-0",
"file-a",
"file-a",
"file-b",
"file-b",
"file-c",
"file-n",
"file-n",
"file-o",
"file-o",
"file-p",
copier.GetOptions: add NoDerefSymLinks Add a NoDerefSymlinks flag to force items that are matched to the Globs we're given to be treated as symlinks, rather than dereferencing them as we would need to do for sources for ADD or COPY. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-18 02:44:40 +08:00
"file-p",
"file-q",
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
"file-q",
"hlink-0",
"hlink-0",
"link-a",
"something-a",
"archive-a",
"non-archive-a",
"subdir-f",
"subdir-f/hlink-b",
},
},
{
name: "all-with-all-exclude",
pattern: "*",
exclude: []string{"*", "!**/*-c"},
items: []string{
ADD and COPY: descend into excluded directories, sometimes When a directly-named (or globbed) source directory for ADD or COPY is marked for exclusion by .dockerignore, check if its name is a prefix for any exceptions in the .dockerignore file, and if it is, check the directory for things we need to include anyway. This will miss exceptions where the pattern uses a wildcard for anything but the final component. When adding items, count items that are actually passed over the tar pipe, rather than items scanned, so that we can correctly diagnose not having found anything that we needed to copy under a directory that would otherwise have been excluded. In copierHandlerGet(), just don't discount any globbed directories that are excluded. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-10-06 05:43:49 +08:00
"file-c",
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
"file-p",
copier.GetOptions: add NoDerefSymLinks Add a NoDerefSymlinks flag to force items that are matched to the Globs we're given to be treated as symlinks, rather than dereferencing them as we would need to do for sources for ADD or COPY. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-18 02:44:40 +08:00
"file-p",
"file-q",
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
"file-q",
},
},
{
name: "everything-with-all-exclude",
pattern: ".",
exclude: []string{"*", "!**/*-c"},
items: []string{
copier.Get(): try to avoid descending into directories When processing a directory tree, only descend into a directory that is marked for exclusion if its path is literally a prefix of an exception pattern. Subtly, but in a way that's compatible with docker, this means that if we exclude directory "subdir", but we've been told to also include "**/file" (with an exclusion pattern of "!**/file"), we won't descend into "subdir" and find a file named "subdir/file", because "**/file" doesn't start with "subdir/". More generally, exclusion patterns that start with "!" which include any wildcards before their final component technically won't be treated correctly. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-08-24 22:41:16 +08:00
// "subdir-a/file-c", // strings.HasPrefix("**/*-c", "subdir-a/") is false
copier.GetOptions: add NoDerefSymLinks Add a NoDerefSymlinks flag to force items that are matched to the Globs we're given to be treated as symlinks, rather than dereferencing them as we would need to do for sources for ADD or COPY. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-18 02:44:40 +08:00
"link-c",
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
"subdir-c",
"subdir-c/file-p",
"subdir-c/file-q",
},
},
{
name: "file-wildcard",
pattern: "file-*",
items: []string{
"file-0",
"file-a",
"file-b",
},
},
{
name: "file-and-dir-wildcard",
pattern: "*-a",
items: []string{
"file-a",
"link-a",
"something-a",
"archive-a",
"non-archive-a",
"file-n", // from subdir-a
"file-o", // from subdir-a
"file-a", // from subdir-a
"file-b", // from subdir-a
"file-c", // from subdir-a
},
},
{
name: "file-and-dir-wildcard-with-exclude",
pattern: "*-a",
exclude: []string{"subdir-a", "top/subdir-a"},
items: []string{
"file-a",
"link-a",
"something-a",
"archive-a",
"non-archive-a",
},
},
{
name: "file-and-dir-wildcard-with-wildcard-exclude",
pattern: "*-a",
exclude: []string{"subdir*", "top/subdir*"},
items: []string{
"file-a",
"link-a",
"something-a",
"archive-a",
"non-archive-a",
},
},
{
name: "file-and-dir-wildcard-with-deep-exclude",
pattern: "*-a",
exclude: []string{"**/subdir-a"},
items: []string{
"file-a",
"link-a",
"something-a",
"archive-a",
"non-archive-a",
},
},
{
name: "file-and-dir-wildcard-with-wildcard-deep-exclude",
pattern: "*-a",
exclude: []string{"**/subdir*"},
items: []string{
"file-a",
"link-a",
"something-a",
"archive-a",
"non-archive-a",
},
},
{
name: "file-and-dir-wildcard-with-deep-include",
pattern: "*-a",
exclude: []string{"**/subdir-a", "!**/file-c"},
items: []string{
"file-a",
"link-a",
"something-a",
"archive-a",
"non-archive-a",
ADD and COPY: descend into excluded directories, sometimes When a directly-named (or globbed) source directory for ADD or COPY is marked for exclusion by .dockerignore, check if its name is a prefix for any exceptions in the .dockerignore file, and if it is, check the directory for things we need to include anyway. This will miss exceptions where the pattern uses a wildcard for anything but the final component. When adding items, count items that are actually passed over the tar pipe, rather than items scanned, so that we can correctly diagnose not having found anything that we needed to copy under a directory that would otherwise have been excluded. In copierHandlerGet(), just don't discount any globbed directories that are excluded. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-10-06 05:43:49 +08:00
"file-c",
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
},
},
{
name: "file-and-dir-wildcard-with-wildcard-deep-include",
pattern: "*-a",
exclude: []string{"**/subdir*", "!**/file-c"},
items: []string{
"file-a",
"link-a",
"something-a",
"archive-a",
"non-archive-a",
ADD and COPY: descend into excluded directories, sometimes When a directly-named (or globbed) source directory for ADD or COPY is marked for exclusion by .dockerignore, check if its name is a prefix for any exceptions in the .dockerignore file, and if it is, check the directory for things we need to include anyway. This will miss exceptions where the pattern uses a wildcard for anything but the final component. When adding items, count items that are actually passed over the tar pipe, rather than items scanned, so that we can correctly diagnose not having found anything that we needed to copy under a directory that would otherwise have been excluded. In copierHandlerGet(), just don't discount any globbed directories that are excluded. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-10-06 05:43:49 +08:00
"file-c",
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
},
},
{
name: "subdirectory",
pattern: "subdir-e",
items: []string{
"subdir-f",
"subdir-f/hlink-b",
},
},
{
name: "subdirectory-wildcard",
pattern: "*/subdir-*",
items: []string{
"hlink-b", // from subdir-e/subdir-f
},
},
{
name: "not-expanded-archive",
pattern: "*archive-a",
items: []string{
"archive-a",
"non-archive-a",
},
},
{
name: "expanded-archive",
pattern: "*archive-a",
expandArchives: true,
items: []string{
"non-archive-a",
"item-0",
"item-1",
"item-2",
},
},
{
name: "subdir-without-name",
pattern: "subdir-e",
items: []string{
"subdir-f",
"subdir-f/hlink-b",
},
},
{
name: "subdir-with-name",
pattern: "subdir-e",
keepDirectoryNames: true,
items: []string{
"subdir-e",
"subdir-e/subdir-f",
"subdir-e/subdir-f/hlink-b",
},
},
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
{
name: "root-wildcard",
pattern: "/subdir-b/*",
keepDirectoryNames: false,
items: []string{
"file-n",
"file-o",
},
},
{
name: "dotdot-wildcard",
pattern: "../../subdir-b/*",
keepDirectoryNames: false,
items: []string{
"file-n",
"file-o",
},
},
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
{
name: "wildcard-with-rename",
pattern: "*-a",
keepDirectoryNames: false,
renames: map[string]string{"file-a": "renamed"},
items: []string{
"renamed", // from file-a
"link-a",
"archive-a",
"non-archive-a",
"something-a",
"file-n", // from subdir-a
"file-o", // from subdir-a
"renamed", // from subdir-a/file-a -> file-a -> renamed
"file-b", // from subdir-a
"file-c", // from subdir-a
},
},
{
name: "wildcard-with-rename-keep",
pattern: "*-a",
keepDirectoryNames: true,
renames: map[string]string{"subdir-a": "subdir-b"},
items: []string{
"file-a",
"link-a",
"archive-a",
"non-archive-a",
"something-a",
"subdir-b",
"subdir-b/file-n",
"subdir-b/file-o",
"subdir-b/file-a",
"subdir-b/file-b",
"subdir-b/file-c",
},
},
copier.GetOptions: add NoDerefSymLinks Add a NoDerefSymlinks flag to force items that are matched to the Globs we're given to be treated as symlinks, rather than dereferencing them as we would need to do for sources for ADD or COPY. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-18 02:44:40 +08:00
{
name: "no-deref-symlinks-baseline",
pattern: "*-a",
noDerefSymlinks: true,
items: []string{
"file-a",
"link-a",
"archive-a",
"non-archive-a",
"something-a",
"file-n", // from subdir-a
"file-o", // from subdir-a
"file-a", // from subdir-a
"file-b", // from subdir-a
"file-c", // from subdir-a
},
},
{
name: "no-deref-symlinks-directory",
pattern: "link-c",
noDerefSymlinks: true,
items: []string{
"link-c",
},
},
{
name: "deref-symlinks-directory",
pattern: "link-c",
noDerefSymlinks: false,
items: []string{
"file-p", // from link-c -> subdir-c
"file-q", // from link-c -> subdir-c
},
},
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
},
},
}
for _, topdir := range []string{"", ".", "top"} {
for _, testArchive := range getTestArchives {
test: use `T.TempDir` to create temporary test directory This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The directory created by `t.TempDir` is automatically removed when the test and all its subtests complete. Prior to this commit, temporary directory created using `ioutil.TempDir` needs to be removed manually by calling `os.RemoveAll`, which is omitted in some tests. The error handling boilerplate e.g. defer func() { if err := os.RemoveAll(dir); err != nil { t.Fatal(err) } } is also tedious, but `t.TempDir` handles this for us nicely. Reference: https://pkg.go.dev/testing#T.TempDir Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
2022-08-20 15:02:40 +08:00
dir, err := makeContextFromArchive(t, makeArchive(testArchive.headers, testArchive.contents), topdir)
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
require.NoErrorf(t, err, "error creating context from archive %q", testArchive.name)
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
root := dir
cases := make(map[string]struct{})
for _, testCase := range testArchive.cases {
if _, ok := cases[testCase.name]; ok {
t.Fatalf("duplicate case %q", testCase.name)
}
cases[testCase.name] = struct{}{}
}
for _, testCase := range testArchive.cases {
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
var excludes []string
for _, exclude := range testCase.exclude {
excludes = append(excludes, filepath.FromSlash(exclude))
}
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
getOptions := GetOptions{
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
Excludes: excludes,
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
ExpandArchives: testCase.expandArchives,
copier: split StripSetidBits into StripSetuidBit/StripSetgidBit/StripStickyBit For the sake of conformance tests, callers need to be able to strip setuid and setgid bits from contents being copied from the build context while leaving the sticky bit intact. Split the StripSetidBits option for copier.Get() into three separate flags (StripSetuidBit / StripSetgidBit / StripStickyBit). Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-29 04:36:39 +08:00
StripSetuidBit: testCase.stripSetuidBit,
StripSetgidBit: testCase.stripSetgidBit,
StripStickyBit: testCase.stripStickyBit,
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
StripXattrs: testCase.stripXattrs,
KeepDirectoryNames: testCase.keepDirectoryNames,
copier: add PutOptions.NoOverwriteDirNonDir, Get/PutOptions.Rename Add a flag for controlling overwriting-directories-with-non-directories behavior in PutOptions, and fields for controlling name mappings to both GetOptions and PutOptions. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-12-15 06:21:16 +08:00
Rename: testCase.renames,
copier.GetOptions: add NoDerefSymLinks Add a NoDerefSymlinks flag to force items that are matched to the Globs we're given to be treated as symlinks, rather than dereferencing them as we would need to do for sources for ADD or COPY. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-18 02:44:40 +08:00
NoDerefSymlinks: testCase.noDerefSymlinks,
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
}
t.Run(fmt.Sprintf("topdir=%s,archive=%s,case=%s,pattern=%s", topdir, testArchive.name, testCase.name, testCase.pattern), func(t *testing.T) {
// ensure that we can get stuff using this spec
Replace io/ioutil calls with os calls In golang 1.19, `io/ioutil` is fully deprecated preventing Buildah from compiling. Replace all calls with equivalent calls from the `os` package. Signed-off-by: Chris Evich <cevich@redhat.com>
2022-11-15 00:22:45 +08:00
err := Get(root, topdir, getOptions, []string{testCase.pattern}, io.Discard)
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
if err != nil && isExpectedError(err, topdir != "" && topdir != ".", testCase.pattern, testArchive.expectedGetErrors) {
return
}
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
require.NoErrorf(t, err, "error getting %q under %q", testCase.pattern, filepath.Join(root, topdir))
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
// see what we get when we get this pattern
pipeReader, pipeWriter := io.Pipe()
var getErr error
var wg sync.WaitGroup
wg.Add(1)
go func() {
getErr = Get(root, topdir, getOptions, []string{testCase.pattern}, pipeWriter)
pipeWriter.Close()
wg.Done()
}()
tr := tar.NewReader(pipeReader)
hdr, err := tr.Next()
actualContents := []string{}
for err == nil {
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
actualContents = append(actualContents, filepath.FromSlash(hdr.Name))
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
hdr, err = tr.Next()
}
pipeReader.Close()
sort.Strings(actualContents)
// compare it to what we were supposed to get
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
expectedContents := make([]string, 0, len(testCase.items))
for _, item := range testCase.items {
expectedContents = append(expectedContents, filepath.FromSlash(item))
}
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
sort.Strings(expectedContents)
assert.Equal(t, io.EOF.Error(), err.Error(), "expected EOF at end of archive, got %q", err.Error())
wg.Wait()
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
assert.NoErrorf(t, getErr, "unexpected error from Get(%q)", testCase.pattern)
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
assert.Equal(t, expectedContents, actualContents, "Get(%q,excludes=%v) didn't produce the right set of items", testCase.pattern, excludes)
Add the "copier" package Add new primitives for reading and writing data, represented as tar streams, from and to possibly-chrooted directories via subprocesses. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-15 04:34:07 +08:00
})
}
}
}
}
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
copier: add an Eval function Add copier.Eval(), for expanding paths using symbolic links in a chrooted scope, without failing if a path component doesn't exist. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-03-03 05:06:27 +08:00
func TestEvalNoChroot(t *testing.T) {
couldChroot := canChroot
canChroot = false
testEval(t)
canChroot = couldChroot
}
func testEval(t *testing.T) {
test: use `T.TempDir` to create temporary test directory This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The directory created by `t.TempDir` is automatically removed when the test and all its subtests complete. Prior to this commit, temporary directory created using `ioutil.TempDir` needs to be removed manually by calling `os.RemoveAll`, which is omitted in some tests. The error handling boilerplate e.g. defer func() { if err := os.RemoveAll(dir); err != nil { t.Fatal(err) } } is also tedious, but `t.TempDir` handles this for us nicely. Reference: https://pkg.go.dev/testing#T.TempDir Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
2022-08-20 15:02:40 +08:00
tmp := t.TempDir()
copier: add an Eval function Add copier.Eval(), for expanding paths using symbolic links in a chrooted scope, without failing if a path component doesn't exist. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-03-03 05:06:27 +08:00
options := EvalOptions{}
linkname := filepath.Join(tmp, "link")
vectors := []struct {
id, linkTarget, inputPath, evaluatedPath string
}{
{"0a", "target", "link/foo", "target/foo"},
{"1a", "/target", "link/foo", "target/foo"},
{"2a", "../target", "link/foo", "target/foo"},
{"3a", "/../target", "link/foo", "target/foo"},
{"4a", "../../target", "link/foo", "target/foo"},
{"5a", "target/subdirectory", "link/foo", "target/subdirectory/foo"},
{"6a", "/target/subdirectory", "link/foo", "target/subdirectory/foo"},
{"7a", "../target/subdirectory", "link/foo", "target/subdirectory/foo"},
{"8a", "/../target/subdirectory", "link/foo", "target/subdirectory/foo"},
{"9a", "../../target/subdirectory", "link/foo", "target/subdirectory/foo"},
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
// inputPath is lexically cleaned to "foo" early, so callers
// won't get values consistent with the kernel, but we use the
// result for ADD and COPY, where docker build seems to have
// the same limitation
{"0b", "target", "link/../foo", "foo"},
{"1b", "/target", "link/../foo", "foo"},
{"2b", "../target", "link/../foo", "foo"},
{"3b", "/../target", "link/../foo", "foo"},
{"4b", "../../target", "link/../foo", "foo"},
{"5b", "target/subdirectory", "link/../foo", "foo"},
{"6b", "/target/subdirectory", "link/../foo", "foo"},
{"7b", "../target/subdirectory", "link/../foo", "foo"},
{"8b", "/../target/subdirectory", "link/../foo", "foo"},
{"9b", "../../target/subdirectory", "link/../foo", "foo"},
copier: add an Eval function Add copier.Eval(), for expanding paths using symbolic links in a chrooted scope, without failing if a path component doesn't exist. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-03-03 05:06:27 +08:00
}
for _, vector := range vectors {
t.Run(fmt.Sprintf("id=%s", vector.id), func(t *testing.T) {
test: use `T.TempDir` to create temporary test directory This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The directory created by `t.TempDir` is automatically removed when the test and all its subtests complete. Prior to this commit, temporary directory created using `ioutil.TempDir` needs to be removed manually by calling `os.RemoveAll`, which is omitted in some tests. The error handling boilerplate e.g. defer func() { if err := os.RemoveAll(dir); err != nil { t.Fatal(err) } } is also tedious, but `t.TempDir` handles this for us nicely. Reference: https://pkg.go.dev/testing#T.TempDir Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
2022-08-20 15:02:40 +08:00
err := os.Symlink(vector.linkTarget, linkname)
Use errors.Is() instead of os.Is{Not,}Exist If errors for which os.IsExist() or os.IsNotExist() would have returned true have been wrapped using fmt.Errorf()'s "%w" verb, os.IsExist() and os.IsNotExist(), not having been retrofitted to use errors.Is(), will return false. Use errors.Is() to check if an error is an os.ErrExist or os.ErrNotExist error instead of calling os.IsExist() or os.IsNotExist(). Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2022-07-27 03:27:30 +08:00
if err != nil && errors.Is(err, os.ErrExist) {
copier: add an Eval function Add copier.Eval(), for expanding paths using symbolic links in a chrooted scope, without failing if a path component doesn't exist. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-03-03 05:06:27 +08:00
os.Remove(linkname)
err = os.Symlink(vector.linkTarget, linkname)
}
require.NoErrorf(t, err, "error creating link from %q to %q", linkname, vector.linkTarget)
evaluated, err := Eval(tmp, filepath.Join(tmp, vector.inputPath), options)
require.NoErrorf(t, err, "error evaluating %q: %v", vector.inputPath, err)
require.Equalf(t, filepath.Join(tmp, vector.evaluatedPath), evaluated, "evaluation of %q with %q pointing to %q failed", vector.inputPath, linkname, vector.linkTarget)
})
}
}
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
func TestMkdirNoChroot(t *testing.T) {
couldChroot := canChroot
canChroot = false
testMkdir(t)
canChroot = couldChroot
}
func testMkdir(t *testing.T) {
type testCase struct {
name string
create string
expect []string
}
testArchives := []struct {
name string
headers []tar.Header
testCases []testCase
}{
{
name: "regular",
headers: []tar.Header{
CI: enable the gofumpt linter Turn on the gofumpt linter. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2024-08-16 00:50:07 +08:00
{Name: "subdir-a", Typeflag: tar.TypeDir, Mode: 0o755, ModTime: testDate},
{Name: "subdir-a/subdir-b", Typeflag: tar.TypeDir, Mode: 0o755, ModTime: testDate},
{Name: "subdir-a/subdir-b/subdir-c", Typeflag: tar.TypeDir, Mode: 0o755, ModTime: testDate},
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
{Name: "subdir-a/subdir-b/dangle1", Typeflag: tar.TypeSymlink, Linkname: "dangle1-target", ModTime: testDate},
{Name: "subdir-a/subdir-b/dangle2", Typeflag: tar.TypeSymlink, Linkname: "../dangle2-target", ModTime: testDate},
{Name: "subdir-a/subdir-b/dangle3", Typeflag: tar.TypeSymlink, Linkname: "../../dangle3-target", ModTime: testDate},
{Name: "subdir-a/subdir-b/dangle4", Typeflag: tar.TypeSymlink, Linkname: "../../../dangle4-target", ModTime: testDate},
{Name: "subdir-a/subdir-b/dangle5", Typeflag: tar.TypeSymlink, Linkname: "../../../../dangle5-target", ModTime: testDate},
{Name: "subdir-a/subdir-b/dangle6", Typeflag: tar.TypeSymlink, Linkname: "/dangle6-target", ModTime: testDate},
{Name: "subdir-a/subdir-b/dangle7", Typeflag: tar.TypeSymlink, Linkname: "/../dangle7-target", ModTime: testDate},
},
testCases: []testCase{
{
name: "basic",
create: "subdir-d",
expect: []string{"subdir-d"},
},
{
name: "subdir",
create: "subdir-d/subdir-e/subdir-f",
expect: []string{"subdir-d", "subdir-d/subdir-e", "subdir-d/subdir-e/subdir-f"},
},
{
name: "dangling-link-itself",
create: "subdir-a/subdir-b/dangle1",
expect: []string{"subdir-a/subdir-b/dangle1-target"},
},
{
name: "dangling-link-as-intermediate-parent",
create: "subdir-a/subdir-b/dangle2/final",
expect: []string{"subdir-a/dangle2-target", "subdir-a/dangle2-target/final"},
},
{
name: "dangling-link-as-intermediate-grandparent",
create: "subdir-a/subdir-b/dangle3/final",
expect: []string{"dangle3-target", "dangle3-target/final"},
},
{
name: "dangling-link-as-intermediate-attempted-relative-breakout",
create: "subdir-a/subdir-b/dangle4/final",
expect: []string{"dangle4-target", "dangle4-target/final"},
},
{
name: "dangling-link-as-intermediate-attempted-relative-breakout-again",
create: "subdir-a/subdir-b/dangle5/final",
expect: []string{"dangle5-target", "dangle5-target/final"},
},
{
name: "dangling-link-itself-absolute",
create: "subdir-a/subdir-b/dangle6",
expect: []string{"dangle6-target"},
},
{
name: "dangling-link-as-intermediate-absolute",
create: "subdir-a/subdir-b/dangle6/final",
expect: []string{"dangle6-target", "dangle6-target/final"},
},
{
name: "dangling-link-as-intermediate-absolute-relative-breakout",
create: "subdir-a/subdir-b/dangle7/final",
expect: []string{"dangle7-target", "dangle7-target/final"},
},
{
name: "parent-parent-final",
create: "../../final",
expect: []string{"final"},
},
{
name: "root-parent-final",
create: "/../final",
expect: []string{"final"},
},
{
name: "root-parent-intermediate-parent-final",
create: "/../intermediate/../final",
expect: []string{"final"},
},
},
},
}
for i := range testArchives {
t.Run(testArchives[i].name, func(t *testing.T) {
for _, testCase := range testArchives[i].testCases {
t.Run(testCase.name, func(t *testing.T) {
test: use `T.TempDir` to create temporary test directory This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The directory created by `t.TempDir` is automatically removed when the test and all its subtests complete. Prior to this commit, temporary directory created using `ioutil.TempDir` needs to be removed manually by calling `os.RemoveAll`, which is omitted in some tests. The error handling boilerplate e.g. defer func() { if err := os.RemoveAll(dir); err != nil { t.Fatal(err) } } is also tedious, but `t.TempDir` handles this for us nicely. Reference: https://pkg.go.dev/testing#T.TempDir Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
2022-08-20 15:02:40 +08:00
dir, err := makeContextFromArchive(t, makeArchive(testArchives[i].headers, nil), "")
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
require.NoErrorf(t, err, "error creating context from archive %q, topdir=%q", testArchives[i].name, "")
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
root := dir
options := MkdirOptions{ChownNew: &idtools.IDPair{UID: os.Getuid(), GID: os.Getgid()}}
var beforeNames, afterNames []string
linters: unused arguments shouldn't have names Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2024-08-07 03:07:02 +08:00
err = filepath.WalkDir(dir, func(path string, _ fs.DirEntry, err error) error {
Switch most calls to filepath.Walk to filepath.WalkDir Should speed up most walks escpecially if they don't need to stat every directory entry. [ NO NEW TESTS NEEDED] Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2022-03-26 19:48:51 +08:00
if err != nil {
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
return err
}
rel, err := filepath.Rel(dir, path)
if err != nil {
return err
}
beforeNames = append(beforeNames, rel)
return nil
})
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
require.NoErrorf(t, err, "error walking directory to catalog pre-Mkdir contents: %v", err)
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
err = Mkdir(root, testCase.create, options)
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
require.NoErrorf(t, err, "error creating directory %q under %q with Mkdir: %v", testCase.create, root, err)
linters: unused arguments shouldn't have names Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2024-08-07 03:07:02 +08:00
err = filepath.WalkDir(dir, func(path string, _ fs.DirEntry, err error) error {
Switch most calls to filepath.Walk to filepath.WalkDir Should speed up most walks escpecially if they don't need to stat every directory entry. [ NO NEW TESTS NEEDED] Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2022-03-26 19:48:51 +08:00
if err != nil {
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
return err
}
rel, err := filepath.Rel(dir, path)
if err != nil {
return err
}
afterNames = append(afterNames, rel)
return nil
})
ADD/COPY: create the destination directory first, chroot to it Always create the destination directory first when ADDing or COPYing content into a container, then extract contents into it using the destination directory as the chroot instead of the container's root directory. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-17 02:40:23 +08:00
require.NoErrorf(t, err, "error walking directory to catalog post-Mkdir contents: %v", err)
copier: add Mkdir() Add a function for doing Mkdir-possibly-in-a-chroot, for ensuring that a directory exists without having to possibly create it directly from outside of a chroot. Make use of filepath.ToSlash() and filepath.FromSlash() where it's appropriate. Add more unit tests. Address some review comments: * Check for ERANGE instead of E2BIG errors from llistxattr() and lgetxattr() as indicators that the buffer we passed to them is too small. * Factor an `isRelevantXattr` helper out of Lgetxattrs() and Lsetxattrs(). * Drop our getcwd() function in favor of using os.Getwd(). * Adjust the comment describing the GetOptions.KeepDirectoryNames field. * Clean hdr.Name before attempting to compute where an item being extracted should go. * When writing items to the filesystem, create with 0?00 permissions, set ownership, then set the correct permissions. * Merge StatResponse.Error, GetResponse.Error, and PutResponse.Error into Response.Error. * When reading items from the filesystem, if a glob matches multiple items, and one of the items is excluded, continue checking the other items. * Make sure we always Wait() on a child process if we spawned one. * Clean up the cleanup logic for pipes that we use to communicate with a child process. * Clean up the kill-the-child-process logic we call when we encounter an error communicating with the child process. * Drop the separate Options structure, use helper methods to simplify pulling out the right ID maps and exclusions list for the request. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2020-07-31 02:00:25 +08:00
expected := append([]string{}, beforeNames...)
for _, expect := range testCase.expect {
expected = append(expected, filepath.FromSlash(expect))
}
sort.Strings(expected)
sort.Strings(afterNames)
assert.Equal(t, expected, afterNames, "expected different paths")
})
}
})
}
}
func TestCleanerSubdirectory(t *testing.T) {
testCases := [][2]string{
{".", "."},
{"..", "."},
{"/", "."},
{"directory/subdirectory/..", "directory"},
{"directory/../..", "."},
{"../../directory", "directory"},
{"../directory/subdirectory", "directory/subdirectory"},
{"/directory/../..", "."},
{"/directory/../../directory", "directory"},
}
for _, testCase := range testCases {
t.Run(testCase[0], func(t *testing.T) {
cleaner := cleanerReldirectory(filepath.FromSlash(testCase[0]))
assert.Equal(t, testCase[1], filepath.ToSlash(cleaner), "expected to get %q, got %q", testCase[1], cleaner)
})
}
}
copier: fix a renaming bug When attempting to handle renames, we'd fail to correctly handle renames of prefixes of a given item's path because of a string handling error, and add a unit test for the rename logic (finally). Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-18 04:05:32 +08:00
func TestHandleRename(t *testing.T) {
renames := map[string]string{
"a": "b",
"c": "d",
"a/1": "a/2",
}
testCases := [][2]string{
{"a", "b"},
{"a/1", "a/2"},
{"a/1/2", "a/2/2"},
{"a/1/2/3", "a/2/2/3"},
{"a/2/3/4", "b/2/3/4"},
{"a/2/3", "b/2/3"},
{"a/2", "b/2"},
{"c/2", "d/2"},
}
for i, testCase := range testCases {
Replace fmt.Sprintf("%d", x) with strconv.Itoa(x) Replace calls to fmt.Sprintf("%d", x) with strconv.Itoa(x), which is slightly faster. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-09-28 05:25:06 +08:00
t.Run(strconv.Itoa(i), func(t *testing.T) {
copier: fix a renaming bug When attempting to handle renames, we'd fail to correctly handle renames of prefixes of a given item's path because of a string handling error, and add a unit test for the rename logic (finally). Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-02-18 04:05:32 +08:00
renamed := handleRename(renames, testCase[0])
assert.Equal(t, testCase[1], renamed, "expected to get %q, got %q", testCase[1], renamed)
})
}
}
copier: add Remove() Add copier.Remove(). Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-04-20 06:01:13 +08:00
func TestRemoveNoChroot(t *testing.T) {
couldChroot := canChroot
canChroot = false
testRemove(t)
canChroot = couldChroot
}
func testRemove(t *testing.T) {
type testCase struct {
name string
remove string
all bool
fail bool
removed []string
}
testArchives := []struct {
name string
headers []tar.Header
testCases []testCase
}{
{
name: "regular",
headers: []tar.Header{
CI: enable the gofumpt linter Turn on the gofumpt linter. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2024-08-16 00:50:07 +08:00
{Name: "subdir-a", Typeflag: tar.TypeDir, Mode: 0o755, ModTime: testDate},
{Name: "subdir-a/file-a", Typeflag: tar.TypeReg, Mode: 0o755, ModTime: testDate},
{Name: "subdir-a/file-b", Typeflag: tar.TypeReg, Mode: 0o755, ModTime: testDate},
{Name: "subdir-a/subdir-b", Typeflag: tar.TypeDir, Mode: 0o755, ModTime: testDate},
{Name: "subdir-a/subdir-b/subdir-c", Typeflag: tar.TypeDir, Mode: 0o755, ModTime: testDate},
copier: add Remove() Add copier.Remove(). Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-04-20 06:01:13 +08:00
{Name: "subdir-a/subdir-b/subdir-c/parent", Typeflag: tar.TypeSymlink, Linkname: "..", ModTime: testDate},
{Name: "subdir-a/subdir-b/subdir-c/link-b", Typeflag: tar.TypeSymlink, Linkname: "../../file-b", ModTime: testDate},
{Name: "subdir-a/subdir-b/subdir-c/root", Typeflag: tar.TypeSymlink, Linkname: "/", ModTime: testDate},
CI: enable the gofumpt linter Turn on the gofumpt linter. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2024-08-16 00:50:07 +08:00
{Name: "subdir-a/subdir-d", Typeflag: tar.TypeDir, Mode: 0o755, ModTime: testDate},
{Name: "subdir-a/subdir-e", Typeflag: tar.TypeDir, Mode: 0o755, ModTime: testDate},
{Name: "subdir-a/subdir-e/subdir-f", Typeflag: tar.TypeDir, Mode: 0o755, ModTime: testDate},
copier: add Remove() Add copier.Remove(). Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-04-20 06:01:13 +08:00
},
testCases: []testCase{
{
name: "file",
remove: "subdir-a/file-a",
removed: []string{"subdir-a/file-a"},
},
{
name: "file-all",
remove: "subdir-a/file-a",
all: true,
removed: []string{"subdir-a/file-a"},
},
{
name: "subdir",
remove: "subdir-a/subdir-b",
all: false,
fail: true,
},
{
name: "subdir-all",
remove: "subdir-a/subdir-b/subdir-c",
all: true,
removed: []string{
"subdir-a/subdir-b/subdir-c",
"subdir-a/subdir-b/subdir-c/parent",
"subdir-a/subdir-b/subdir-c/link-b",
"subdir-a/subdir-b/subdir-c/root",
},
},
{
name: "file-link",
remove: "subdir-a/subdir-b/subdir-c/link-b",
removed: []string{"subdir-a/subdir-b/subdir-c/link-b"},
},
{
name: "file-link-all",
remove: "subdir-a/subdir-b/subdir-c/link-b",
all: true,
removed: []string{"subdir-a/subdir-b/subdir-c/link-b"},
},
{
name: "file-link-indirect",
remove: "subdir-a/subdir-b/subdir-c/parent/subdir-c/link-b",
removed: []string{"subdir-a/subdir-b/subdir-c/link-b"},
},
{
name: "file-link-indirect-all",
remove: "subdir-a/subdir-b/subdir-c/parent/subdir-c/link-b",
all: true,
removed: []string{"subdir-a/subdir-b/subdir-c/link-b"},
},
{
name: "dir-link",
remove: "subdir-a/subdir-b/subdir-c/root",
removed: []string{"subdir-a/subdir-b/subdir-c/root"},
},
{
name: "dir-link-all",
remove: "subdir-a/subdir-b/subdir-c/root",
all: true,
removed: []string{"subdir-a/subdir-b/subdir-c/root"},
},
{
name: "dir-through-link",
remove: "subdir-a/subdir-b/subdir-c/root/subdir-a/subdir-d",
removed: []string{"subdir-a/subdir-d"},
},
{
name: "dir-through-link-all",
remove: "subdir-a/subdir-b/subdir-c/root/subdir-a/subdir-d",
all: true,
removed: []string{"subdir-a/subdir-d"},
},
{
name: "tree-through-link",
remove: "subdir-a/subdir-b/subdir-c/root/subdir-a/subdir-e",
all: false,
fail: true,
},
{
name: "tree-through-link-all",
remove: "subdir-a/subdir-b/subdir-c/root/subdir-a/subdir-e",
all: true,
removed: []string{"subdir-a/subdir-e", "subdir-a/subdir-e/subdir-f"},
},
},
},
}
for i := range testArchives {
t.Run(testArchives[i].name, func(t *testing.T) {
for _, testCase := range testArchives[i].testCases {
t.Run(testCase.name, func(t *testing.T) {
test: use `T.TempDir` to create temporary test directory This commit replaces `ioutil.TempDir` with `t.TempDir` in tests. The directory created by `t.TempDir` is automatically removed when the test and all its subtests complete. Prior to this commit, temporary directory created using `ioutil.TempDir` needs to be removed manually by calling `os.RemoveAll`, which is omitted in some tests. The error handling boilerplate e.g. defer func() { if err := os.RemoveAll(dir); err != nil { t.Fatal(err) } } is also tedious, but `t.TempDir` handles this for us nicely. Reference: https://pkg.go.dev/testing#T.TempDir Signed-off-by: Eng Zer Jun <engzerjun@gmail.com>
2022-08-20 15:02:40 +08:00
dir, err := makeContextFromArchive(t, makeArchive(testArchives[i].headers, nil), "")
copier: add Remove() Add copier.Remove(). Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-04-20 06:01:13 +08:00
require.NoErrorf(t, err, "error creating context from archive %q, topdir=%q", testArchives[i].name, "")
root := dir
options := RemoveOptions{All: testCase.all}
beforeNames := make(map[string]struct{})
linters: unused arguments shouldn't have names Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2024-08-07 03:07:02 +08:00
err = filepath.WalkDir(dir, func(path string, _ fs.DirEntry, err error) error {
Switch most calls to filepath.Walk to filepath.WalkDir Should speed up most walks escpecially if they don't need to stat every directory entry. [ NO NEW TESTS NEEDED] Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2022-03-26 19:48:51 +08:00
if err != nil {
copier: add Remove() Add copier.Remove(). Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-04-20 06:01:13 +08:00
return err
}
rel, err := filepath.Rel(dir, path)
if err != nil {
return err
}
beforeNames[rel] = struct{}{}
return nil
})
require.NoErrorf(t, err, "error walking directory to catalog pre-Remove contents: %v", err)
err = Remove(root, testCase.remove, options)
if testCase.fail {
require.Errorf(t, err, "did not expect to succeed removing item %q under %q with Remove", testCase.remove, root)
return
}
require.NoErrorf(t, err, "error removing item %q under %q with Remove: %v", testCase.remove, root, err)
afterNames := make(map[string]struct{})
linters: unused arguments shouldn't have names Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2024-08-07 03:07:02 +08:00
err = filepath.WalkDir(dir, func(path string, _ fs.DirEntry, err error) error {
Switch most calls to filepath.Walk to filepath.WalkDir Should speed up most walks escpecially if they don't need to stat every directory entry. [ NO NEW TESTS NEEDED] Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
2022-03-26 19:48:51 +08:00
if err != nil {
copier: add Remove() Add copier.Remove(). Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2021-04-20 06:01:13 +08:00
return err
}
rel, err := filepath.Rel(dir, path)
if err != nil {
return err
}
afterNames[rel] = struct{}{}
return nil
})
require.NoErrorf(t, err, "error walking directory to catalog post-Remove contents: %v", err)
var removed []string
for beforeName := range beforeNames {
if _, stillPresent := afterNames[beforeName]; !stillPresent {
removed = append(removed, beforeName)
}
}
var expected []string
for _, expect := range testCase.removed {
expected = append(expected, filepath.FromSlash(expect))
}
sort.Strings(expected)
sort.Strings(removed)
assert.Equal(t, expected, removed, "expected different paths to be missing")
})
}
})
}
}
copier: handle globbing with "**" path components Handle glob patterns with "**" path components by expanding "**" to the set of subdirectories and calling filepath.Glob() on the results. Signed-off-by: Nalin Dahyabhai <nalin@redhat.com>
2024-08-15 05:54:31 +08:00
func TestExtendedGlob(t *testing.T) {
tmpdir := t.TempDir()
buf := []byte("buffer")
var expected1, expected2 []string
require.NoError(t, os.Mkdir(filepath.Join(tmpdir, "a"), 0o700))
require.NoError(t, os.Mkdir(filepath.Join(tmpdir, "a", "b"), 0o700))
require.NoError(t, os.WriteFile(filepath.Join(tmpdir, "a", "b", "a.dat"), buf, 0o600))
expected1 = append(expected1, filepath.Join(tmpdir, "a", "b", "a.dat"))
require.NoError(t, os.Mkdir(filepath.Join(tmpdir, "b"), 0o700))
require.NoError(t, os.Mkdir(filepath.Join(tmpdir, "b", "c"), 0o700))
require.NoError(t, os.Mkdir(filepath.Join(tmpdir, "c"), 0o700))
require.NoError(t, os.Mkdir(filepath.Join(tmpdir, "c", "d"), 0o700))
require.NoError(t, os.WriteFile(filepath.Join(tmpdir, "c", "d", "c.dat"), buf, 0o600))
expected1 = append(expected1, filepath.Join(tmpdir, "c", "d", "c.dat"))
expected2 = append(expected2, filepath.Join(tmpdir, "c", "d", "c.dat"))
require.NoError(t, os.Mkdir(filepath.Join(tmpdir, "d"), 0o700))
require.NoError(t, os.WriteFile(filepath.Join(tmpdir, "d", "d.dat"), buf, 0o600))
expected1 = append(expected1, filepath.Join(tmpdir, "d", "d.dat"))
expected2 = append(expected2, filepath.Join(tmpdir, "d", "d.dat"))
matched, err := extendedGlob(filepath.Join(tmpdir, "**", "*.dat"))
require.NoError(t, err, "globbing")
require.ElementsMatchf(t, expected1, matched, "**/*.dat")
matched, err = extendedGlob(filepath.Join(tmpdir, "**", "d", "*.dat"))
require.NoError(t, err, "globbing")
require.ElementsMatch(t, expected2, matched, "**/d/*.dat")
matched, err = extendedGlob(filepath.Join(tmpdir, "**", "**", "d", "*.dat"))
require.NoError(t, err, "globbing")
require.ElementsMatch(t, expected2, matched, "**/**/d/*.dat")
matched, err = extendedGlob(filepath.Join(tmpdir, "**", "d", "**", "*.dat"))
require.NoError(t, err, "globbing")
require.ElementsMatch(t, expected2, matched, "**/d/**/*.dat")
}