Documentation
¶
Index ¶
- type DefaultFs
- func (DefaultFs) Chtimes(name string, atime, mtime time.Time) error
- func (DefaultFs) Create(name string) (File, error)
- func (DefaultFs) MkdirAll(path string, perm os.FileMode) error
- func (DefaultFs) ReadDir(dirname string) ([]os.FileInfo, error)
- func (DefaultFs) ReadFile(filename string) ([]byte, error)
- func (DefaultFs) Readlink(name string) (string, error)
- func (DefaultFs) Remove(name string) error
- func (DefaultFs) RemoveAll(path string) error
- func (DefaultFs) Rename(oldpath, newpath string) error
- func (DefaultFs) Stat(name string) (os.FileInfo, error)
- func (DefaultFs) Symlink(oldname, newname string) error
- func (DefaultFs) TempDir(dir, prefix string) (string, error)
- func (DefaultFs) TempFile(dir, prefix string) (File, error)
- func (DefaultFs) Walk(root string, walkFn filepath.WalkFunc) error
- func (DefaultFs) WriteFile(filename string, data []byte, perm os.FileMode) error
- type FakeFs
- func (fs *FakeFs) Chtimes(name string, atime, mtime time.Time) error
- func (fs *FakeFs) Create(name string) (File, error)
- func (fs *FakeFs) MkdirAll(path string, perm os.FileMode) error
- func (fs *FakeFs) ReadDir(dirname string) ([]os.FileInfo, error)
- func (fs *FakeFs) ReadFile(filename string) ([]byte, error)
- func (fs *FakeFs) Readlink(name string) (string, error)
- func (fs *FakeFs) Remove(name string) error
- func (fs *FakeFs) RemoveAll(path string) error
- func (fs *FakeFs) Rename(oldpath, newpath string) error
- func (fs *FakeFs) Stat(name string) (os.FileInfo, error)
- func (fs *FakeFs) Symlink(oldname, newname string) error
- func (fs *FakeFs) TempDir(dir, prefix string) (string, error)
- func (fs *FakeFs) TempFile(dir, prefix string) (File, error)
- func (fs *FakeFs) Walk(root string, walkFn filepath.WalkFunc) error
- func (fs *FakeFs) WriteFile(filename string, data []byte, perm os.FileMode) error
- type File
- type Filesystem
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type DefaultFs ¶
type DefaultFs struct{}
DefaultFs implements Filesystem using same-named functions from "os" and "io/ioutil"
type FakeFs ¶
type FakeFs struct {
// contains filtered or unexported fields
}
FakeFs is implemented in terms of afero
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)
Sync() 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
RemoveAll(path string) error
Remove(name string) error
Readlink(name string) (string, error)
Symlink(oldname, newname string) error
// from "io/ioutil"
ReadFile(filename string) ([]byte, error)
WriteFile(filename string, data []byte, perm os.FileMode) error
TempDir(dir, prefix string) (string, error)
TempFile(dir, prefix string) (File, error)
ReadDir(dirname string) ([]os.FileInfo, error)
Walk(root string, walkFn filepath.WalkFunc) error
}
Filesystem is an interface that we can use to mock various filesystem operations
var Fs Filesystem = DefaultFs{}
func NewFakeFs ¶
func NewFakeFs(fakeFsRoot string) (Filesystem, func(), error)
NewFakeFs returns a fake Filesystem that exists at fakeFsRoot as its base path, useful for unit tests. Returns: Filesystem interface, teardown method (cleanup of provided root path) and error. teardown method should be called at the end of each test to ensure environment is left clean.
Source Files
Click to show internal directories.
Click to hide internal directories.