mockfs

Documentation

Overview

Package mockfs provides mock Fs for testing.

Index

• Variables
• func NewFs(ctx context.Context, name string, root string, config configmap.Mapper) (fs.Fs, error)
• func Register()
• type Fs
  • func (f *Fs) AddObject(o fs.Object)
  • func (f *Fs) Features() *fs.Features
  • func (f *Fs) Hashes() hash.Set
  • func (f *Fs) List(ctx context.Context, dir string) (entries fs.DirEntries, err error)
  • func (f *Fs) Mkdir(ctx context.Context, dir string) error
  • func (f *Fs) Name() string
  • func (f *Fs) NewObject(ctx context.Context, remote string) (fs.Object, error)
  • func (f *Fs) Precision() time.Duration
  • func (f *Fs) Put(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)
  • func (f *Fs) Rmdir(ctx context.Context, dir string) error
  • func (f *Fs) Root() string
  • func (f *Fs) SetHashes(hashes hash.Set)
  • func (f *Fs) String() string

Variables

var ErrNotImplemented = errors.New("not implemented")

ErrNotImplemented is returned by unimplemented methods

Functions

func NewFs

func NewFs(ctx context.Context, name string, root string, config configmap.Mapper) (fs.Fs, error)

NewFs returns a new mock Fs

func Register

func Register()

Register with Fs

Types

type Fs

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

Fs is a minimal mock Fs

func (*Fs) AddObject

func (f *Fs) AddObject(o fs.Object)

AddObject adds an Object for List to return Only works for the root for the moment

func (*Fs) Features

func (f *Fs) Features() *fs.Features

Features returns the optional features of this Fs

func (*Fs) Hashes

func (f *Fs) Hashes() hash.Set

Hashes returns the supported hash types of the filesystem

func (*Fs) List

func (f *Fs) List(ctx context.Context, dir string) (entries fs.DirEntries, err error)

List the objects and directories in dir into entries. The entries can be returned in any order but should be for a complete directory.

dir should be "" to list the root, and should not have trailing slashes.

This should return ErrDirNotFound if the directory isn't found.

func (*Fs) Mkdir

func (f *Fs) Mkdir(ctx context.Context, dir string) error

Mkdir makes the directory (container, bucket)

Shouldn't return an error if it already exists

func (*Fs) Name

func (f *Fs) Name() string

Name of the remote (as passed into NewFs)

func (*Fs) NewObject

func (f *Fs) NewObject(ctx context.Context, remote string) (fs.Object, error)

NewObject finds the Object at remote. If it can't be found it returns the error ErrorObjectNotFound.

func (*Fs) Precision

func (f *Fs) Precision() time.Duration

Precision of the ModTimes in this Fs

func (*Fs) Put

func (f *Fs) Put(ctx context.Context, in io.Reader, src fs.ObjectInfo, options ...fs.OpenOption) (fs.Object, error)

Put in to the remote path with the modTime given of the given size

May create the object even if it returns an error - if so will return the object and the error, otherwise will return nil and the error

func (*Fs) Rmdir

func (f *Fs) Rmdir(ctx context.Context, dir string) error

Rmdir removes the directory (container, bucket) if empty

Return an error if it doesn't exist or isn't empty

func (*Fs) Root

func (f *Fs) Root() string

Root of the remote (as passed into NewFs)

func (*Fs) SetHashes

func (f *Fs) SetHashes(hashes hash.Set)

SetHashes sets the hashes that this supports

func (*Fs) String

func (f *Fs) String() string

String returns a description of the FS