filesystem

Documentation

Index

• type DefaultFs
  • func (DefaultFs) Chtimes(name string, atime time.Time, mtime time.Time) error
  • func (DefaultFs) Create(name string) (File, error)
  • func (DefaultFs) MkdirAll(path string, perm os.FileMode) error
  • func (DefaultFs) ReadFile(filename string) ([]byte, error)
  • func (DefaultFs) Rename(oldpath, newpath string) error
  • func (DefaultFs) Stat(name string) (os.FileInfo, error)
  • func (DefaultFs) TempFile(dir, prefix string) (File, error)
• type File
• type Filesystem
  • func NewFakeFs() Filesystem

Types

type DefaultFs

type DefaultFs struct{}

DefaultFs implements Filesystem using same-named functions from "os" and "io/ioutil"

func (DefaultFs) Chtimes

func (DefaultFs) Chtimes(name string, atime time.Time, mtime time.Time) error

Chtimes via os.Chtimes

func (DefaultFs) Create

func (DefaultFs) Create(name string) (File, error)

Create via os.Create

func (DefaultFs) MkdirAll

func (DefaultFs) MkdirAll(path string, perm os.FileMode) error

MkdirAll via os.MkdirAll

func (DefaultFs) ReadFile

func (DefaultFs) ReadFile(filename string) ([]byte, error)

ReadFile via os.ReadFile

func (DefaultFs) Rename

func (DefaultFs) Rename(oldpath, newpath string) error

Rename via os.Rename

func (DefaultFs) Stat

func (DefaultFs) Stat(name string) (os.FileInfo, error)

Stat via os.Stat

func (DefaultFs) TempFile

func (DefaultFs) TempFile(dir, prefix string) (File, error)

TempFile via os.TempFile

type File

type File interface {
	// for now, the only os.File methods used are those below, add more as necessary
	Name() string
	Write(b []byte) (n int, err error)
	Close() error
}

File is an interface that we can use to mock various filesystem operations typically accessed through the File object from the "os" package

type Filesystem

type Filesystem interface {
	// from "os"
	Stat(name string) (os.FileInfo, error)
	Create(name string) (File, error)
	Rename(oldpath, newpath string) error
	MkdirAll(path string, perm os.FileMode) error
	Chtimes(name string, atime time.Time, mtime time.Time) error

	// from "io/ioutil"
	ReadFile(filename string) ([]byte, error)
	TempFile(dir, prefix string) (File, error)
}

Filesystem is an interface that we can use to mock various filesystem operations

func NewFakeFs

func NewFakeFs() Filesystem

NewFakeFs returns a fake Filesystem that exists in-memory, useful for unit tests