Till Wegmüller 5f2a9d062a Merge syscall stuff 4 months ago
helper Path Changes 4 months ago
memfs Path Changes 4 months ago
osfs Merge syscall stuff 4 months ago
test Path Changes 4 months ago
util Path Changes 4 months ago
.gitignore Add TempDir 7 months ago
.travis.yml Path Changes 4 months ago
DCO added DCO 1 year ago
LICENSE LICENSE: changed to Apache 2.0 1 year ago
MAINTAINERS MAINTAINERS: add @mcuadros 1 year ago
Makefile travis: add codecov.io (#13) 2 years ago
README.md Path Changes 4 months ago
appveyor.yml bump v4 version 1 year ago
fs.go Rename capability names to <name>Capability 10 months ago
fs_test.go Path Changes 4 months ago
go.mod Testing SOlaris Changes 4 months ago
go.sum Add TempDir 7 months ago

README.md

go-billy GoDoc Build Status Build status codecov

The missing interface filesystem abstraction for Go. Billy implements an interface based on the os standard library, allowing to develop applications without dependency on the underlying storage. Makes it virtually free to implement mocks and testing over filesystem operations.

Billy was born as part of src-d/go-git project.

Installation

go get -u git.wegmueller.it/toasterson/go-billy/...

Usage

Billy exposes filesystems using the Filesystem interface. Each filesystem implementation gives you a New method, whose arguments depend on the implementation itself, that returns a new Filesystem.

The following example caches in memory all readable files in a directory from any billy's filesystem implementation.

func LoadToMemory(origin billy.Filesystem, path string) (*memory.Memory, error) {
	memory := memory.New()

	files, err := origin.ReadDir("/")
	if err != nil {
		return nil, err
	}

	for _, file := range files {
		if file.IsDir() {
			continue
		}

		src, err := origin.Open(file.Name())
		if err != nil {
			return nil, err
		}

		dst, err := memory.Create(file.Name())
		if err != nil {
			return nil, err
		}

		if _, err = io.Copy(dst, src); err != nil {
			return nil, err
		}

		if err := dst.Close(); err != nil {
			return nil, err
		}

		if err := src.Close(); err != nil {
			return nil, err
		}
	}

	return memory, nil
}

Why billy?

The library billy deals with storage systems and Billy is the name of a well-known, IKEA bookcase. That's it.

License

Apache License Version 2.0, see LICENSE