github.com/kaydxh/golang@v0.0.131/go/filesystem/filesystem.go (about)

     1  /*
     2   *Copyright (c) 2022, kaydxh
     3   *
     4   *Permission is hereby granted, free of charge, to any person obtaining a copy
     5   *of this software and associated documentation files (the "Software"), to deal
     6   *in the Software without restriction, including without limitation the rights
     7   *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     8   *copies of the Software, and to permit persons to whom the Software is
     9   *furnished to do so, subject to the following conditions:
    10   *
    11   *The above copyright notice and this permission notice shall be included in all
    12   *copies or substantial portions of the Software.
    13   *
    14   *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    15   *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    16   *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    17   *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    18   *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    19   *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
    20   *SOFTWARE.
    21   */
    22  package filesystem
    23  
    24  import (
    25  	"os"
    26  	"path/filepath"
    27  	"time"
    28  )
    29  
    30  // Filesystem is an interface that we can use to mock various filesystem operations
    31  type Filesystem interface {
    32  	// from "os"
    33  	Stat(name string) (os.FileInfo, error)
    34  	Create(name string) (File, error)
    35  	Rename(oldpath, newpath string) error
    36  	MkdirAll(path string, perm os.FileMode) error
    37  	Chtimes(name string, atime time.Time, mtime time.Time) error
    38  	RemoveAll(path string) error
    39  	Remove(name string) error
    40  
    41  	// from "io/ioutil"
    42  	ReadFile(filename string) ([]byte, error)
    43  	TempDir(dir, prefix string) (string, error)
    44  	TempFile(dir, prefix string) (File, error)
    45  	ReadDir(dirname string) ([]os.FileInfo, error)
    46  	Walk(root string, walkFn filepath.WalkFunc) error
    47  }
    48  
    49  // File is an interface that we can use to mock various filesystem operations typically
    50  // accessed through the File object from the "os" package
    51  type File interface {
    52  	// for now, the only os.File methods used are those below, add more as necessary
    53  	Name() string
    54  	Write(b []byte) (n int, err error)
    55  	Sync() error
    56  	Close() error
    57  }