github.com/mvdan/u-root-coreutils@v0.0.0-20230122170626-c2eef2898555/pkg/cp/cmd_test.go

// Copyright 2016 the u-root Authors. All rights reserved
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

// created by Manoel Vilela <manoel_vilela@engineer.com>

package cp

import (
	"bufio"
	"bytes"
	"errors"
	"fmt"
	"io"
	"io/fs"
	"math/rand"
	"os"
	"path/filepath"
	"reflect"
	"strings"
	"testing"

	"github.com/mvdan/u-root-coreutils/pkg/uio"
	"golang.org/x/sys/unix"
)

const (
	maxSizeFile = 1000
	maxDirDepth = 5
	maxFiles    = 5
)

// randomFile create a random file with random content
func randomFile(fpath, prefix string) (*os.File, error) {
	f, err := os.CreateTemp(fpath, prefix)
	if err != nil {
		return nil, err
	}
	// generate random content for files
	bytes := []byte{}
	for i := 0; i < rand.Intn(maxSizeFile); i++ {
		bytes = append(bytes, byte(i))
	}
	f.Write(bytes)

	return f, nil
}

// createFilesTree create a random files tree
func createFilesTree(root string, maxDepth, depth int) error {
	// create more one dir if don't achieve the maxDepth
	if depth < maxDepth {
		newDir, err := os.MkdirTemp(root, fmt.Sprintf("cpdir_%d_", depth))
		if err != nil {
			return err
		}

		if err = createFilesTree(newDir, maxDepth, depth+1); err != nil {
			return err
		}
	}
	// generate random files
	for i := 0; i < maxFiles; i++ {
		f, err := randomFile(root, fmt.Sprintf("cpfile_%d_", i))
		if err != nil {
			return err
		}
		f.Close()
	}

	return nil
}

func TestRunSimple(t *testing.T) {
	tmpDir := t.TempDir()
	file1, err := randomFile(tmpDir, "src-")
	if err != nil {
		t.Errorf("failed to create tmp dir: %q", err)
	}

	for _, tt := range []struct {
		name    string
		flag    flags
		args    []string
		input   string
		wantErr error
	}{
		{
			name: "NoFlags-Success-",
			args: []string{file1.Name(), filepath.Join(tmpDir, "destination")},
		},
		{
			name: "AskYes-Success-",
			args: []string{file1.Name(), filepath.Join(tmpDir, "destination")},
			flag: flags{
				ask: true,
			},
			input: "yes\n",
		},
		{
			name: "AskYes-Fail1-",
			args: []string{file1.Name(), filepath.Join(tmpDir, "destination")},
			flag: flags{
				ask: true,
			},
			input:   "yes",
			wantErr: io.EOF,
		},
		{
			name: "AskYes-Fail2-",
			args: []string{file1.Name(), filepath.Join(tmpDir, "destination")},
			flag: flags{
				ask: true,
			},
			input:   "no\n",
			wantErr: ErrSkip,
		},
		{
			name: "Verbose",
			args: []string{file1.Name(), filepath.Join(tmpDir, "destination")},
			flag: flags{
				verbose: true,
			},
			wantErr: ErrSkip,
		},
		{
			name:    "SameFile-NoFlags",
			args:    []string{file1.Name(), file1.Name()},
			wantErr: ErrSkip,
		},
		{
			name:    "NoFlags-Fail-SrcNotExist",
			args:    []string{"src", filepath.Join(tmpDir, "destination")},
			wantErr: fs.ErrNotExist,
		},
		{
			name:    "NoFlags-Fail-DstcNotExist",
			args:    []string{file1.Name(), "dst"},
			wantErr: fs.ErrNotExist,
		},
		{
			name:    "NoFlags-ToManyArgs-",
			args:    []string{file1.Name(), "dst", "src"},
			wantErr: unix.ENOTDIR,
		},
	} {
		t.Run(tt.name, func(t *testing.T) {
			var out bytes.Buffer
			var inBuf bytes.Buffer
			fmt.Fprintf(&inBuf, "%s", tt.input)
			in := bufio.NewReader(&inBuf)
			if err := run(RunParams{Stdin: in, Stderr: &out}, tt.args, tt.flag); err != nil {
				if !errors.Is(err, tt.wantErr) {
					t.Errorf(`run(tt.args, tt.flag, &out, in) = %q, not %q`, err.Error(), tt.wantErr)
				}
				return
			}

			if err := IsEqualTree(Default, tt.args[0], tt.args[1]); err != nil {
				t.Errorf(`EqualTree(Default, tt.args[0], tt.args[1]) = %q, not nil`, err)
			}
		})

		t.Run(tt.name+"PreCallBack", func(t *testing.T) {
			var out bytes.Buffer
			var inBuf bytes.Buffer
			fmt.Fprintf(&inBuf, "%s", tt.input)
			in := bufio.NewReader(&inBuf)
			f := setupPreCallback(tt.flag.recursive, tt.flag.ask, tt.flag.force, &out, *in)
			srcfi, err := os.Stat(tt.args[0])
			// If the src file does not exist, there is no point in continue, but it is not an error so the say.
			// Also we catch that error in the previous test
			if errors.Is(err, fs.ErrNotExist) {
				return
			}
			if err := f(tt.args[0], tt.args[1], srcfi); !errors.Is(err, ErrSkip) {
				t.Logf(`preCallback(tt.args[0], tt.args[1], srcfi) = %q, not ErrSkip`, err)
			}
		})

		t.Run(tt.name+"PostCallBack", func(t *testing.T) {
			var out bytes.Buffer
			f := setupPostCallback(tt.flag.verbose, &out)
			f(tt.args[0], tt.args[1])
			if tt.flag.verbose {
				if out.String() != fmt.Sprintf("%q -> %q\n", tt.args[0], tt.args[1]) {
					t.Errorf("postCallback(tt.args[0], tt.args[1]) = %q, not %q", out.String(), fmt.Sprintf("%q -> %q\n", tt.args[0], tt.args[1]))
				}
			}
		})
	}
}

// TestCpSrcDirectory tests copying source to destination without recursive
// cmd-line equivalent: cp ~/dir ~/dir2
func TestCpSrcDirectory(t *testing.T) {
	var f flags

	tempDir := t.TempDir()
	tempDirTwo := t.TempDir()

	// capture log output to verify
	var logBytes bytes.Buffer
	var in bufio.Reader

	if err := run(RunParams{Stdin: &in, Stderr: &logBytes}, []string{tempDir, tempDirTwo}, f); err != nil {
		t.Fatalf(`run([]string{tempDir, tempDirTwo}, f, &logBytes, &in) = %q, not nil`, err)
	}

	outString := fmt.Sprintf("cp: -r not specified, omitting directory %s", tempDir)
	capturedString := logBytes.String()
	if !strings.Contains(capturedString, outString) {
		t.Fatal("strings.Contains(capturedString, outString) = false, not true")
	}
}

// TestCpRecursive tests the recursive mode copy
// Copy dir hierarchies src-dir to dst-dir
// whose src-dir and dst-dir already exists
// cmd-line equivalent: $ cp -R src-dir/ dst-dir/
func TestCpRecursive(t *testing.T) {
	var f flags
	f.recursive = true

	tempDir := t.TempDir()

	srcDir := filepath.Join(tempDir, "src")
	if err := os.Mkdir(srcDir, 0o755); err != nil {
		t.Fatalf(`os.Mkdir(srcDir, 0o755) = %q, not nil`, err)
	}
	dstDir := filepath.Join(tempDir, "dst-exists")
	if err := os.Mkdir(dstDir, 0o755); err != nil {
		t.Fatalf(`os.Mkdir(dstDir, 0o755) = %q, not nil`, err)
	}

	if err := createFilesTree(srcDir, maxDirDepth, 0); err != nil {
		t.Fatalf(`createFilesTree(srcDir, maxDirDepth, 0) = %q, not nil`, err)
	}

	t.Run("existing-dst-dir", func(t *testing.T) {
		var out bytes.Buffer
		var in bufio.Reader
		if err := run([]string{srcDir, dstDir}, f, &out, &in); err != nil {
			t.Fatalf(`run([]string{srcDir, dstDir}, f, &out, &in) = %q, not nil`, err)
		}
		// Because dstDir already existed, a new dir was created inside it.
		realDestination := filepath.Join(dstDir, filepath.Base(srcDir))
		if err := IsEqualTree(Default, srcDir, realDestination); err != nil {
			t.Fatalf(`IsEqualTree(Default, srcDir, realDestination) = %q, not nil`, err)
		}
	})

	t.Run("non-existing-dst-dir", func(t *testing.T) {
		var out bytes.Buffer
		var in bufio.Reader
		notExistDstDir := filepath.Join(tempDir, "dst-does-not-exist")
		if err := run([]string{srcDir, notExistDstDir}, f, &out, &in); err != nil {
			t.Fatalf(`run([]string{srcDir, notExistDstDir}, f, &out, &in) = %q, not nil`, err)
		}

		if err := IsEqualTree(Default, srcDir, notExistDstDir); err != nil {
			t.Fatalf(`IsEqualTree(Default, srcDir, notExistDstDir) = %q, not nil`, err)
		}
	})
}

// Other test to verify the CopyRecursive
// whose dir$n and dst-dir already exists
// cmd-line equivalent: $ cp -R dir1/ dir2/ dir3/ dst-dir/
//
// dst-dir will content dir{1, 3}
// $ dst-dir/
// ..	dir1/
// ..	dir2/
// ..   dir3/
func TestCpRecursiveMultiple(t *testing.T) {
	var f flags
	f.recursive = true
	tempDir := t.TempDir()

	dstTest := filepath.Join(tempDir, "destination")
	if err := os.Mkdir(dstTest, 0o755); err != nil {
		t.Fatalf(`os.Mkdir(dstTest, 0o755) = %q, not nil`, err)
	}

	// create multiple random directories sources
	srcDirs := []string{}
	for i := 0; i < maxDirDepth; i++ {
		srcTest := t.TempDir()

		if err := createFilesTree(srcTest, maxDirDepth, 0); err != nil {
			t.Fatalf(`createFilesTree(srcTest, maxDirDepth, 0) = %q, not nil`, err)
		}

		srcDirs = append(srcDirs, srcTest)

	}
	var out bytes.Buffer
	var in bufio.Reader
	args := srcDirs
	args = append(args, dstTest)
	if err := run(args, f, &out, &in); err != nil {
		t.Fatalf(`run(args, f, &out, &in) = %q, not nil`, err)
	}
	// Make sure we can do it twice.
	f.force = true
	if err := run(args, f, &out, &in); err != nil {
		t.Fatalf(`run(args, f, &out, &in) = %q, not nil`, err)
	}
	for _, src := range srcDirs {
		_, srcFile := filepath.Split(src)

		dst := filepath.Join(dstTest, srcFile)
		if err := IsEqualTree(Default, src, dst); err != nil {
			t.Fatalf(`IsEqualTree(Default, src, dst) = %q, not nil`, err)
		}
	}
}

// using -P don't follow symlinks, create other symlink
// cmd-line equivalent: $ cp -P symlink symlink-copy
func TestCpSymlink(t *testing.T) {
	tempDir := t.TempDir()

	f, err := randomFile(tempDir, "src-")
	if err != nil {
		t.Fatalf(`randomFile(tempDir, "src-") = %q, not nil`, err)
	}
	defer f.Close()

	srcFpath := f.Name()
	srcFname := filepath.Base(srcFpath)

	newName := filepath.Join(tempDir, srcFname+"_link")
	if err := os.Symlink(srcFname, newName); err != nil {
		t.Fatalf(`os.Symlink(srcFname, newName) = %q, not nil`, err)
	}

	t.Run("no-follow-symlink", func(t *testing.T) {
		var out bytes.Buffer
		var in bufio.Reader
		var f flags
		f.noFollowSymlinks = true

		dst := filepath.Join(tempDir, "dst-no-follow")
		if err := run([]string{newName, dst}, f, &out, &in); err != nil {
			t.Fatalf(`run([]string{newName, dst}, f, &out, &in) = %q, not nil`, err)
		}
		if err := IsEqualTree(NoFollowSymlinks, newName, dst); err != nil {
			t.Fatalf(`IsEqualTree(NoFollowSymlinks, newName, dst) =%q, not nil`, err)
		}
	})

	t.Run("follow-symlink", func(t *testing.T) {
		var out bytes.Buffer
		var in bufio.Reader
		var f flags
		f.noFollowSymlinks = false

		dst := filepath.Join(tempDir, "dst-follow")
		if err := run([]string{newName, dst}, f, &out, &in); err != nil {
			t.Fatalf(`run([]string{newName, dst}, f, &out, &in) =%q, not nil`, err)
		}
		if err := IsEqualTree(Default, newName, dst); err != nil {
			t.Fatalf(`IsEqualTree(Default, newName, dst) = %q, not nil`, err)
		}
	})
}

// isEqualFile compare two files by checksum
func isEqualFile(fpath1, fpath2 string) error {
	file1, err := os.Open(fpath1)
	if err != nil {
		return err
	}
	defer file1.Close()
	file2, err := os.Open(fpath2)
	if err != nil {
		return err
	}
	defer file2.Close()

	if !uio.ReaderAtEqual(file1, file2) {
		return fmt.Errorf("%q and %q do not have equal content", fpath1, fpath2)
	}
	return nil
}

func readDirNames(path string) ([]string, error) {
	entries, err := os.ReadDir(path)
	if err != nil {
		return nil, err
	}
	var basenames []string
	for _, entry := range entries {
		basenames = append(basenames, entry.Name())
	}
	return basenames, nil
}

func stat(o Options, path string) (os.FileInfo, error) {
	if o.NoFollowSymlinks {
		return os.Lstat(path)
	}
	return os.Stat(path)
}

// IsEqualTree compare the content in the file trees in src and dst paths
func IsEqualTree(o Options, src, dst string) error {
	srcInfo, err := stat(o, src)
	if err != nil {
		return err
	}
	dstInfo, err := stat(o, dst)
	if err != nil {
		return err
	}
	if sm, dm := srcInfo.Mode()&os.ModeType, dstInfo.Mode()&os.ModeType; sm != dm {
		return fmt.Errorf("mismatched mode: %q has mode %s while %q has mode %s", src, sm, dst, dm)
	}

	switch {
	case srcInfo.Mode().IsDir():
		srcEntries, err := readDirNames(src)
		if err != nil {
			return err
		}
		dstEntries, err := readDirNames(dst)
		if err != nil {
			return err
		}
		// os.ReadDir guarantees these are sorted.
		if !reflect.DeepEqual(srcEntries, dstEntries) {
			return fmt.Errorf("directory contents did not match:\n%q had %v\n%q had %v", src, srcEntries, dst, dstEntries)
		}
		for _, basename := range srcEntries {
			if err := IsEqualTree(o, filepath.Join(src, basename), filepath.Join(dst, basename)); err != nil {
				return err
			}
		}
		return nil

	case srcInfo.Mode().IsRegular():
		return isEqualFile(src, dst)

	case srcInfo.Mode()&os.ModeSymlink == os.ModeSymlink:
		srcTarget, err := os.Readlink(src)
		if err != nil {
			return err
		}
		dstTarget, err := os.Readlink(dst)
		if err != nil {
			return err
		}
		if srcTarget != dstTarget {
			return fmt.Errorf("target mismatch: symlink %q had target %q, while %q had target %q", src, srcTarget, dst, dstTarget)
		}
		return nil

	default:
		return fmt.Errorf("unsupported mode: %s", srcInfo.Mode())
	}
}