fs

Documentation

Overview

Package fs provides tools for creating and working with temporary files and directories.

Index

• type Dir
  • func NewDir(t assert.TestingT, prefix string, ops ...PathOp) *Dir
  • func (d *Dir) Join(parts ...string) string
  • func (d *Dir) Path() string
  • func (d *Dir) Remove()
• type File
  • func NewFile(t assert.TestingT, prefix string, ops ...PathOp) *File
  • func (f *File) Path() string
  • func (f *File) Remove()
• type Path
• type PathOp
  • func AsUser(uid, gid int) PathOp
  • func FromDir(source string) PathOp
  • func WithBytes(raw []byte) PathOp
  • func WithContent(content string) PathOp
  • func WithDir(name string, ops ...PathOp) PathOp
  • func WithFile(filename, content string, ops ...PathOp) PathOp
  • func WithFiles(files map[string]string) PathOp
  • func WithHardlink(path, target string) PathOp
  • func WithMode(mode os.FileMode) PathOp
  • func WithSymlink(path, target string) PathOp
  • func WithTimestamps(atime, mtime time.Time) PathOp

Examples

• NewDir
• NewFile
• WithDir

Types

type Dir

type Dir struct {
	// contains filtered or unexported fields
}

Dir is a temporary directory

func NewDir

func NewDir(t assert.TestingT, prefix string, ops ...PathOp) *Dir

NewDir returns a new temporary directory using prefix as part of the directory name. The PathOps are applied before returning the Dir.

Example

Create a temporary directory which contains a single file

package main

import (
	"io/ioutil"
	"testing"

	"github.com/gotestyourself/gotestyourself/assert"
	"github.com/gotestyourself/gotestyourself/assert/cmp"
	"github.com/gotestyourself/gotestyourself/fs"
)

var t = &testing.T{}

func main() {
	dir := fs.NewDir(t, "test-name", fs.WithFile("file1", "content\n"))
	defer dir.Remove()

	files, err := ioutil.ReadDir(dir.Path())
	assert.NilError(t, err)
	assert.Assert(t, cmp.Len(files, 0))
}

func (*Dir) Join

func (d *Dir) Join(parts ...string) string

Join returns a new path with this directory as the base of the path

func (*Dir) Path

func (d *Dir) Path() string

Path returns the full path to the directory

func (*Dir) Remove

func (d *Dir) Remove()

Remove the directory

type File

type File struct {
	// contains filtered or unexported fields
}

File is a temporary file on the filesystem

func NewFile

func NewFile(t assert.TestingT, prefix string, ops ...PathOp) *File

NewFile creates a new file in a temporary directory using prefix as part of the filename. The PathOps are applied to the before returning the File.

Example

Create a new file with some content

package main

import (
	"io/ioutil"
	"testing"

	"github.com/gotestyourself/gotestyourself/assert"
	"github.com/gotestyourself/gotestyourself/fs"
)

var t = &testing.T{}

func main() {
	file := fs.NewFile(t, "test-name", fs.WithContent("content\n"), fs.AsUser(0, 0))
	defer file.Remove()

	content, err := ioutil.ReadFile(file.Path())
	assert.NilError(t, err)
	assert.Equal(t, "content\n", content)
}

func (*File) Path

func (f *File) Path() string

Path returns the full path to the file

func (*File) Remove

func (f *File) Remove()

Remove the file

type Path

type Path interface {
	Path() string
	Remove()
}

Path objects return their filesystem path. Both File and Dir implement Path.

type PathOp

type PathOp func(path Path) error

PathOp is a function which accepts a Path to perform some operation

func AsUser

func AsUser(uid, gid int) PathOp

AsUser changes ownership of the file system object at Path

func FromDir

func FromDir(source string) PathOp

FromDir copies the directory tree from the source path into the new Dir

func WithBytes

func WithBytes(raw []byte) PathOp

WithBytes write bytes to a file at Path

func WithContent

func WithContent(content string) PathOp

WithContent writes content to a file at Path

func WithDir

func WithDir(name string, ops ...PathOp) PathOp

WithDir creates a subdirectory in the directory at path. Additional PathOp can be used to modify the subdirectory

Example

Create a directory and subdirectory with files

package main

import (
	"os"
	"testing"

	"github.com/gotestyourself/gotestyourself/fs"
)

var t = &testing.T{}

func main() {
	dir := fs.NewDir(t, "test-name",
		fs.WithDir("subdir",
			fs.WithMode(os.FileMode(0700)),
			fs.WithFile("file1", "content\n")),
	)
	defer dir.Remove()
}

func WithFile

func WithFile(filename, content string, ops ...PathOp) PathOp

WithFile creates a file in the directory at path with content

func WithFiles

func WithFiles(files map[string]string) PathOp

WithFiles creates all the files in the directory at path with their content

func WithHardlink

func WithHardlink(path, target string) PathOp

WithHardlink creates a link in the directory which links to target. Target must be a path relative to the directory.

Note: the argument order is the inverse of os.Link to be consistent with the other functions in this package.

func WithMode

func WithMode(mode os.FileMode) PathOp

WithMode sets the file mode on the directory or file at path

func WithSymlink

func WithSymlink(path, target string) PathOp

WithSymlink creates a symlink in the directory which links to target. Target must be a path relative to the directory.

Note: the argument order is the inverse of os.Symlink to be consistent with the other functions in this package.

func WithTimestamps

func WithTimestamps(atime, mtime time.Time) PathOp

WithTimestamps sets the access and modification times of the file system object at path.