test: new test organization based on the interfaces

Author: mcuadros

memfs/memory.go

@@ -23,25 +23,22 @@ type Memory struct {
 	tempCount int
 }
 
-//New returns a new Memory filesystem
+//New returns a new Memory filesystem.
 func New() *Memory {
 	return &Memory{
 		base: string(separator),
 		s:    newStorage(),
 	}
 }
 
-// Create returns a new file in memory from a given filename.
 func (fs *Memory) Create(filename string) (billy.File, error) {
 	return fs.OpenFile(filename, os.O_RDWR|os.O_CREATE|os.O_TRUNC, 0666)
 }
 
-// Open returns a readonly file from a given name.
 func (fs *Memory) Open(filename string) (billy.File, error) {
 	return fs.OpenFile(filename, os.O_RDONLY, 0)
 }
 
-// OpenFile returns the file from a given name with given flag and permits.
 func (fs *Memory) OpenFile(filename string, flag int, perm os.FileMode) (billy.File, error) {
 	fullpath := fs.fullpath(filename)
 	f, has := fs.s.Get(fullpath)
@@ -97,7 +94,6 @@ func isAbs(path string) bool {
 	return filepath.IsAbs(path) || strings.HasPrefix(path, string(separator))
 }
 
-// Stat returns a billy.FileInfo with the information of the requested file.
 func (fs *Memory) Stat(filename string) (billy.FileInfo, error) {
 	fullpath := fs.fullpath(filename)
 	f, has := fs.s.Get(fullpath)
@@ -132,7 +128,6 @@ func (fs *Memory) Lstat(filename string) (billy.FileInfo, error) {
 	return f.Stat(), nil
 }
 
-// ReadDir returns a list of billy.FileInfo in the given directory.
 func (fs *Memory) ReadDir(path string) ([]billy.FileInfo, error) {
 	fullpath := fs.fullpath(path)
 	if f, has := fs.s.Get(fullpath); has {
@@ -149,7 +144,6 @@ func (fs *Memory) ReadDir(path string) ([]billy.FileInfo, error) {
 	return entries, nil
 }
 
-// MkdirAll creates a directory.
 func (fs *Memory) MkdirAll(path string, perm os.FileMode) error {
 	fullpath := fs.Join(fs.base, path)
 
@@ -159,7 +153,6 @@ func (fs *Memory) MkdirAll(path string, perm os.FileMode) error {
 
 var maxTempFiles = 1024 * 4
 
-// TempFile creates a new temporary file.
 func (fs *Memory) TempFile(dir, prefix string) (billy.File, error) {
 	var fullpath string
 	for {
@@ -182,34 +175,22 @@ func (fs *Memory) getTempFilename(dir, prefix string) string {
 	return fs.Join(fs.base, dir, filename)
 }
 
-// Rename moves a the `from` file to the `to` file.
 func (fs *Memory) Rename(from, to string) error {
 	from = fs.Join(fs.base, from)
 	to = fs.Join(fs.base, to)
 
 	return fs.s.Rename(from, to)
 }
 
-// Remove deletes a given file from storage.
 func (fs *Memory) Remove(filename string) error {
 	fullpath := fs.Join(fs.base, filename)
 	return fs.s.Remove(fullpath)
 }
 
-// Join joins any number of path elements into a single path, adding a Separator if necessary.
 func (fs *Memory) Join(elem ...string) string {
 	return filepath.Join(elem...)
 }
 
-// Dir creates a new memory filesystem whose root is the given path inside the current
-// filesystem.
-func (fs *Memory) Dir(path string) billy.Filesystem {
-	return &Memory{
-		base: fs.Join(fs.base, path),
-		s:    fs.s,
-	}
-}
-
 func (fs *Memory) Symlink(target, link string) error {
 	fullpath := clean(fs.Join(fs.base, link))
 
@@ -244,7 +225,13 @@ func (fs *Memory) Readlink(link string) (string, error) {
 	return string(f.content.bytes), nil
 }
 
-// Base returns the base path for the filesystem.
+func (fs *Memory) Dir(path string) billy.Filesystem {
+	return &Memory{
+		base: fs.Join(fs.base, path),
+		s:    fs.s,
+	}
+}
+
 func (fs *Memory) Base() string {
 	return fs.base
 }

memfs/memory_test.go

@@ -17,7 +17,7 @@ type MemorySuite struct {
 var _ = Suite(&MemorySuite{})
 
 func (s *MemorySuite) SetUpTest(c *C) {
-	s.FilesystemSuite.FS = New()
+	s.FilesystemSuite = test.NewFilesystemSuite(New())
 }
 
 func (s *MemorySuite) TestTempFileMaxTempFiles(c *C) {

osfs/os.go

@@ -16,26 +16,22 @@ const (
 	defaultCreateMode    = 0666
 )
 
-// OS is a filesystem based on the os filesystem
+// OS is a filesystem based on the os filesystem.
 type OS struct {
 	base string
 }
 
-// New returns a new OS filesystem
+// New returns a new OS filesystem.
 func New(baseDir string) *OS {
 	return &OS{
 		base: baseDir,
 	}
 }
 
-// Create creates a file and opens it with standard permissions
-// and modes O_RDWR, O_CREATE and O_TRUNC.
 func (fs *OS) Create(filename string) (billy.File, error) {
 	return fs.OpenFile(filename, os.O_RDWR|os.O_CREATE|os.O_TRUNC, defaultCreateMode)
 }
 
-// OpenFile is equivalent to standard os.OpenFile.
-// If flag os.O_CREATE is set, all parent directories will be created.
 func (fs *OS) OpenFile(filename string, flag int, perm os.FileMode) (billy.File, error) {
 	fullpath := fs.absolutize(filename)
 
@@ -69,8 +65,6 @@ func (fs *OS) createDir(fullpath string) error {
 	return nil
 }
 
-// ReadDir returns the filesystem info for all the archives under the specified
-// path.
 func (fs *OS) ReadDir(path string) ([]billy.FileInfo, error) {
 	fullpath := fs.absolutize(path)
 
@@ -87,7 +81,6 @@ func (fs *OS) ReadDir(path string) ([]billy.FileInfo, error) {
 	return s, nil
 }
 
-// Rename moves a file in disk from _from_ to _to_.
 func (fs *OS) Rename(from, to string) error {
 	from = fs.absolutize(from)
 	to = fs.absolutize(to)
@@ -99,24 +92,20 @@ func (fs *OS) Rename(from, to string) error {
 	return os.Rename(from, to)
 }
 
-// MkdirAll creates a directory.
 func (fs *OS) MkdirAll(path string, perm os.FileMode) error {
 	fullpath := fs.absolutize(path)
 	return os.MkdirAll(fullpath, defaultDirectoryMode)
 }
 
-// Open opens a file in read-only mode.
 func (fs *OS) Open(filename string) (billy.File, error) {
 	return fs.OpenFile(filename, os.O_RDONLY, 0)
 }
 
-// Remove deletes a file in disk.
 func (fs *OS) Remove(filename string) error {
 	fullpath := fs.absolutize(filename)
 	return os.Remove(fullpath)
 }
 
-// TempFile creates a new temporal file.
 func (fs *OS) TempFile(dir, prefix string) (billy.File, error) {
 	fullpath := fs.absolutize(dir)
 	if err := fs.createDir(fullpath + string(os.PathSeparator)); err != nil {
@@ -141,24 +130,18 @@ func (fs *OS) TempFile(dir, prefix string) (billy.File, error) {
 	return newOSFile(filename, f), nil
 }
 
-// Join joins the specified elements using the filesystem separator.
 func (fs *OS) Join(elem ...string) string {
 	return filepath.Join(elem...)
 }
 
-// Dir returns a new Filesystem from the same type of fs using as baseDir the
-// given path
 func (fs *OS) Dir(path string) billy.Filesystem {
 	return New(fs.absolutize(path))
 }
 
-// Base returns the base path of the filesytem
 func (fs *OS) Base() string {
 	return fs.base
 }
 
-// RemoveAll removes a file or directory recursively. Removes everything it can,
-// but returns the first error.
 func (fs *OS) RemoveAll(path string) error {
 	fullpath := fs.Join(fs.base, path)
 	return os.RemoveAll(fullpath)
@@ -169,7 +152,6 @@ func (fs *OS) Lstat(filename string) (billy.FileInfo, error) {
 	return os.Lstat(fullpath)
 }
 
-// Symlink imlements billy.Symlinker.Symlink.
 func (fs *OS) Symlink(target, link string) error {
 	target = filepath.FromSlash(target)
 
@@ -186,7 +168,6 @@ func (fs *OS) Symlink(target, link string) error {
 	return os.Symlink(target, link)
 }
 
-// Readlink implements billy.Symlinker.Readlink.
 func (fs *OS) Readlink(link string) (string, error) {
 	fullpath := fs.Join(fs.base, link)
 	target, err := os.Readlink(fullpath)
@@ -206,6 +187,13 @@ func (fs *OS) Readlink(link string) (string, error) {
 	return string(os.PathSeparator) + target, nil
 }
 
+func (fs *OS) absolutize(relpath string) string {
+	fullpath := filepath.FromSlash(filepath.ToSlash(relpath))
+
+	fullpath = fs.Join(fs.base, fullpath)
+	return filepath.Clean(fullpath)
+}
+
 // osFile represents a file in the os filesystem
 type osFile struct {
 	billy.BaseFile
@@ -240,10 +228,3 @@ func (f *osFile) Close() error {
 func (f *osFile) ReadAt(p []byte, off int64) (int, error) {
 	return f.file.ReadAt(p, off)
 }
-
-func (fs *OS) absolutize(relpath string) string {
-	fullpath := filepath.FromSlash(filepath.ToSlash(relpath))
-
-	fullpath = fs.Join(fs.base, fullpath)
-	return filepath.Clean(fullpath)
-}

osfs/os_test.go

@@ -21,7 +21,7 @@ var _ = Suite(&OSSuite{})
 
 func (s *OSSuite) SetUpTest(c *C) {
 	s.path, _ = ioutil.TempDir(os.TempDir(), "go-billy-osfs-test")
-	s.FilesystemSuite.FS = New(s.path)
+	s.FilesystemSuite = test.NewFilesystemSuite(New(s.path))
 }
 
 func (s *OSSuite) TearDownTest(c *C) {