osfs: symlink support. (#30)

* Get the test suite passing on Mac OS.

* Implement `Symlink()` and `Readlink()` on `osfs.OS`.

* Ensure full support for relative and absolute symlinks.

* Add `Symlinker` interface.

* Always create parent directories when creating a symlink.

* Implement `Symlink()` and `Readlink()` on `subdir.subdirFs`.

* Add test for calling `Readlink()` on a regular file.

* Relax specificity of error assertions.

* Fix readlink assertion for windows.

* Add tests for subdirfs when underlying filesystem does not support symlinks.

* Document interface methods, and improve paramter names.
9 files changed
tree: f3830a254e5311fa42403e8fab6547b267ed3518
  1. memfs/
  2. osfs/
  3. subdirfs/
  4. test/
  5. tmpoverlayfs/
  6. .gitignore
  7. .travis.yml
  8. appveyor.yml
  9. fs.go
  10. LICENSE
  11. Makefile
  12. README.md
  13. utils.go
README.md

go-billy GoDoc Build Status Build status codecov codebeat badge

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. Make virtually free implement an mocks and testing over filesystem operations.

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

Installation

go get -u gopkg.in/src-d/go-billy.v2/...

Why billy?

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

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
}

License

MIT, see LICENSE