Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/blang/vfs
Virtual filesystem library written in golang
https://github.com/blang/vfs
golang mocking vfs virtual-file-system
Last synced: 4 days ago
JSON representation
Virtual filesystem library written in golang
- Host: GitHub
- URL: https://github.com/blang/vfs
- Owner: blang
- License: mit
- Created: 2015-08-16T22:06:35.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-03-16T18:18:18.000Z (8 months ago)
- Last Synced: 2024-11-05T21:45:25.694Z (6 days ago)
- Topics: golang, mocking, vfs, virtual-file-system
- Language: Go
- Size: 55.7 KB
- Stars: 465
- Watchers: 14
- Forks: 51
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
vfs for golang [](https://travis-ci.org/blang/vfs) [](https://godoc.org/github.com/blang/vfs) [](https://coveralls.io/r/blang/vfs?branch=master) [](https://gitter.im/blang/vfs?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
======
vfs is library to support virtual filesystems. It provides basic abstractions of filesystems and implementations, like `OS` accessing the file system of the underlying OS and `memfs` a full filesystem in-memory.
Usage
-----
```bash
$ go get github.com/blang/vfs
```
Note: Always vendor your dependencies or fix on a specific version tag.
```go
import github.com/blang/vfs
```
```go
// Create a vfs accessing the filesystem of the underlying OS
var osfs vfs.Filesystem = vfs.OS()
osfs.Mkdir("/tmp", 0777)
// Make the filesystem read-only:
osfs = vfs.ReadOnly(osfs) // Simply wrap filesystems to change its behaviour
// os.O_CREATE will fail and return vfs.ErrReadOnly
// os.O_RDWR is supported but Write(..) on the file is disabled
f, _ := osfs.OpenFile("/tmp/example.txt", os.O_RDWR, 0)
// Return vfs.ErrReadOnly
_, err := f.Write([]byte("Write on readonly fs?"))
if err != nil {
fmt.Errorf("Filesystem is read only!\n")
}
// Create a fully writable filesystem in memory
mfs := memfs.Create()
mfs.Mkdir("/root", 0777)
// Create a vfs supporting mounts
// The root fs is accessing the filesystem of the underlying OS
fs := mountfs.Create(osfs)
// Mount a memfs inside /memfs
// /memfs may not exist
fs.Mount(mfs, "/memfs")
// This will create /testdir inside the memfs
fs.Mkdir("/memfs/testdir", 0777)
// This would create /tmp/testdir inside your OS fs
// But the rootfs `osfs` is read-only
fs.Mkdir("/tmp/testdir", 0777)
```
Check detailed examples below. Also check the [GoDocs](http://godoc.org/github.com/blang/vfs).
Why should I use this lib?
-----
- Only Stdlib
- (Nearly) Fully tested (Coverage >90%)
- Easy to create your own filesystem
- Mock a full filesystem for testing (or use included `memfs`)
- Compose/Wrap Filesystems `ReadOnly(OS())` and write simple Wrappers
- Many features, see [GoDocs](http://godoc.org/github.com/blang/vfs) and examples below
Features and Examples
-----
- [OS Filesystem support](http://godoc.org/github.com/blang/vfs#example-OsFS)
- [ReadOnly Wrapper](http://godoc.org/github.com/blang/vfs#example-RoFS)
- [DummyFS for quick mocking](http://godoc.org/github.com/blang/vfs#example-DummyFS)
- [MemFS - full in-memory filesystem](http://godoc.org/github.com/blang/vfs/memfs#example-MemFS)
- [MountFS - support mounts across filesystems](http://godoc.org/github.com/blang/vfs/mountfs#example-MountFS)
Current state: ALPHA
-----
While the functionality is quite stable and heavily tested, interfaces are subject to change.
You need more/less abstraction? Let me know by creating a Issue, thank you.
Motivation
-----
I simply couldn't find any lib supporting this wide range of variation and adaptability.
Contribution
-----
Feel free to make a pull request. For bigger changes create a issue first to discuss about it.
License
-----
See [LICENSE](LICENSE) file.