Create logger package and rename errorIf to LogIf (#5678)

Removing message from error logging
Replace errors.Trace with LogIf
This commit is contained in:
kannappanr
2018-04-05 15:04:40 -07:00
committed by GitHub
parent 91fd8ffeb7
commit f8a3fd0c2a
119 changed files with 2608 additions and 1860 deletions

View File

@@ -17,11 +17,13 @@
package cmd
import (
"context"
"io"
"os"
pathutil "path"
"runtime"
"github.com/minio/minio/cmd/logger"
"github.com/minio/minio/pkg/errors"
"github.com/minio/minio/pkg/lock"
)
@@ -29,17 +31,23 @@ import (
// Removes only the file at given path does not remove
// any parent directories, handles long paths for
// windows automatically.
func fsRemoveFile(filePath string) (err error) {
func fsRemoveFile(ctx context.Context, filePath string) (err error) {
if filePath == "" {
return errors.Trace(errInvalidArgument)
logger.LogIf(ctx, errInvalidArgument)
return errInvalidArgument
}
if err = checkPathLength(filePath); err != nil {
return errors.Trace(err)
logger.LogIf(ctx, err)
return err
}
if err = os.Remove((filePath)); err != nil {
return osErrToFSFileErr(err)
fsErr := osErrToFSFileErr(err)
if fsErr != errFileNotFound {
logger.LogIf(ctx, err)
}
return fsErr
}
return nil
@@ -47,22 +55,27 @@ func fsRemoveFile(filePath string) (err error) {
// Removes all files and folders at a given path, handles
// long paths for windows automatically.
func fsRemoveAll(dirPath string) (err error) {
func fsRemoveAll(ctx context.Context, dirPath string) (err error) {
if dirPath == "" {
return errors.Trace(errInvalidArgument)
logger.LogIf(ctx, errInvalidArgument)
return errInvalidArgument
}
if err = checkPathLength(dirPath); err != nil {
return errors.Trace(err)
logger.LogIf(ctx, err)
return err
}
if err = os.RemoveAll(dirPath); err != nil {
if os.IsPermission(err) {
return errors.Trace(errVolumeAccessDenied)
logger.LogIf(ctx, errVolumeAccessDenied)
return errVolumeAccessDenied
} else if isSysErrNotEmpty(err) {
return errors.Trace(errVolumeNotEmpty)
logger.LogIf(ctx, errVolumeNotEmpty)
return errVolumeNotEmpty
}
return errors.Trace(err)
logger.LogIf(ctx, err)
return err
}
return nil
@@ -70,22 +83,27 @@ func fsRemoveAll(dirPath string) (err error) {
// Removes a directory only if its empty, handles long
// paths for windows automatically.
func fsRemoveDir(dirPath string) (err error) {
func fsRemoveDir(ctx context.Context, dirPath string) (err error) {
if dirPath == "" {
return errors.Trace(errInvalidArgument)
logger.LogIf(ctx, errInvalidArgument)
return errInvalidArgument
}
if err = checkPathLength(dirPath); err != nil {
return errors.Trace(err)
logger.LogIf(ctx, err)
return err
}
if err = os.Remove((dirPath)); err != nil {
if os.IsNotExist(err) {
return errors.Trace(errVolumeNotFound)
logger.LogIf(ctx, errVolumeNotFound)
return errVolumeNotFound
} else if isSysErrNotEmpty(err) {
return errors.Trace(errVolumeNotEmpty)
logger.LogIf(ctx, errVolumeNotEmpty)
return errVolumeNotEmpty
}
return errors.Trace(err)
logger.LogIf(ctx, err)
return err
}
return nil
@@ -95,29 +113,36 @@ func fsRemoveDir(dirPath string) (err error) {
// otherwise returns an error. If directory already
// exists returns an error. Windows long paths
// are handled automatically.
func fsMkdir(dirPath string) (err error) {
func fsMkdir(ctx context.Context, dirPath string) (err error) {
if dirPath == "" {
return errors.Trace(errInvalidArgument)
logger.LogIf(ctx, errInvalidArgument)
return errInvalidArgument
}
if err = checkPathLength(dirPath); err != nil {
return errors.Trace(err)
logger.LogIf(ctx, err)
return err
}
if err = os.Mkdir((dirPath), 0777); err != nil {
if os.IsExist(err) {
return errors.Trace(errVolumeExists)
logger.LogIf(ctx, errVolumeExists)
return errVolumeExists
} else if os.IsPermission(err) {
return errors.Trace(errDiskAccessDenied)
logger.LogIf(ctx, errDiskAccessDenied)
return errDiskAccessDenied
} else if isSysErrNotDir(err) {
// File path cannot be verified since
// one of the parents is a file.
return errors.Trace(errDiskAccessDenied)
logger.LogIf(ctx, errDiskAccessDenied)
return errDiskAccessDenied
} else if isSysErrPathNotFound(err) {
// Add specific case for windows.
return errors.Trace(errDiskAccessDenied)
logger.LogIf(ctx, errDiskAccessDenied)
return errDiskAccessDenied
}
return errors.Trace(err)
logger.LogIf(ctx, err)
return err
}
return nil
@@ -128,36 +153,40 @@ func fsMkdir(dirPath string) (err error) {
// not perform any higher layer interpretation of files v/s
// directories. For higher level interpretation look at
// fsStatFileDir, fsStatFile, fsStatDir.
func fsStat(statLoc string) (os.FileInfo, error) {
func fsStat(ctx context.Context, statLoc string) (os.FileInfo, error) {
if statLoc == "" {
return nil, errors.Trace(errInvalidArgument)
logger.LogIf(ctx, errInvalidArgument)
return nil, errInvalidArgument
}
if err := checkPathLength(statLoc); err != nil {
return nil, errors.Trace(err)
logger.LogIf(ctx, err)
return nil, err
}
fi, err := os.Stat((statLoc))
if err != nil {
return nil, errors.Trace(err)
logger.LogIf(ctx, err)
return nil, err
}
return fi, nil
}
// Lookup if volume exists, returns volume attributes upon success.
func fsStatVolume(volume string) (os.FileInfo, error) {
fi, err := fsStat(volume)
func fsStatVolume(ctx context.Context, volume string) (os.FileInfo, error) {
fi, err := fsStat(ctx, volume)
if err != nil {
err = errors.Cause(err)
if os.IsNotExist(err) {
return nil, errors.Trace(errVolumeNotFound)
return nil, errVolumeNotFound
} else if os.IsPermission(err) {
return nil, errors.Trace(errVolumeAccessDenied)
return nil, errVolumeAccessDenied
}
return nil, errors.Trace(err)
return nil, err
}
if !fi.IsDir() {
return nil, errors.Trace(errVolumeAccessDenied)
logger.LogIf(ctx, errVolumeAccessDenied)
return nil, errVolumeAccessDenied
}
return fi, nil
@@ -173,52 +202,55 @@ func osErrToFSFileErr(err error) error {
}
err = errors.Cause(err)
if os.IsNotExist(err) {
return errors.Trace(errFileNotFound)
return errFileNotFound
}
if os.IsPermission(err) {
return errors.Trace(errFileAccessDenied)
return errFileAccessDenied
}
if isSysErrNotDir(err) {
return errors.Trace(errFileAccessDenied)
return errFileAccessDenied
}
if isSysErrPathNotFound(err) {
return errors.Trace(errFileNotFound)
return errFileNotFound
}
return err
}
// Lookup if directory exists, returns directory attributes upon success.
func fsStatDir(statDir string) (os.FileInfo, error) {
fi, err := fsStat(statDir)
func fsStatDir(ctx context.Context, statDir string) (os.FileInfo, error) {
fi, err := fsStat(ctx, statDir)
if err != nil {
return nil, osErrToFSFileErr(err)
}
if !fi.IsDir() {
return nil, errors.Trace(errFileAccessDenied)
return nil, errFileAccessDenied
}
return fi, nil
}
// Lookup if file exists, returns file attributes upon success.
func fsStatFile(statFile string) (os.FileInfo, error) {
fi, err := fsStat(statFile)
func fsStatFile(ctx context.Context, statFile string) (os.FileInfo, error) {
fi, err := fsStat(ctx, statFile)
if err != nil {
return nil, osErrToFSFileErr(err)
}
if fi.IsDir() {
return nil, errors.Trace(errFileAccessDenied)
logger.LogIf(ctx, errFileAccessDenied)
return nil, errFileAccessDenied
}
return fi, nil
}
// Opens the file at given path, optionally from an offset. Upon success returns
// a readable stream and the size of the readable stream.
func fsOpenFile(readPath string, offset int64) (io.ReadCloser, int64, error) {
func fsOpenFile(ctx context.Context, readPath string, offset int64) (io.ReadCloser, int64, error) {
if readPath == "" || offset < 0 {
return nil, 0, errors.Trace(errInvalidArgument)
logger.LogIf(ctx, errInvalidArgument)
return nil, 0, errInvalidArgument
}
if err := checkPathLength(readPath); err != nil {
return nil, 0, errors.Trace(err)
logger.LogIf(ctx, err)
return nil, 0, err
}
fr, err := os.Open((readPath))
@@ -229,19 +261,22 @@ func fsOpenFile(readPath string, offset int64) (io.ReadCloser, int64, error) {
// Stat to get the size of the file at path.
st, err := os.Stat((readPath))
if err != nil {
return nil, 0, errors.Trace(err)
logger.LogIf(ctx, err)
return nil, 0, err
}
// Verify if its not a regular file, since subsequent Seek is undefined.
if !st.Mode().IsRegular() {
return nil, 0, errors.Trace(errIsNotRegular)
logger.LogIf(ctx, errIsNotRegular)
return nil, 0, errIsNotRegular
}
// Seek to the requested offset.
if offset > 0 {
_, err = fr.Seek(offset, os.SEEK_SET)
if err != nil {
return nil, 0, errors.Trace(err)
logger.LogIf(ctx, err)
return nil, 0, err
}
}
@@ -250,21 +285,25 @@ func fsOpenFile(readPath string, offset int64) (io.ReadCloser, int64, error) {
}
// Creates a file and copies data from incoming reader. Staging buffer is used by io.CopyBuffer.
func fsCreateFile(filePath string, reader io.Reader, buf []byte, fallocSize int64) (int64, error) {
func fsCreateFile(ctx context.Context, filePath string, reader io.Reader, buf []byte, fallocSize int64) (int64, error) {
if filePath == "" || reader == nil {
return 0, errors.Trace(errInvalidArgument)
logger.LogIf(ctx, errInvalidArgument)
return 0, errInvalidArgument
}
if err := checkPathLength(filePath); err != nil {
return 0, errors.Trace(err)
logger.LogIf(ctx, err)
return 0, err
}
if err := mkdirAll(pathutil.Dir(filePath), 0777); err != nil {
return 0, errors.Trace(err)
logger.LogIf(ctx, err)
return 0, err
}
if err := checkDiskFree(pathutil.Dir(filePath), fallocSize); err != nil {
return 0, errors.Trace(err)
logger.LogIf(ctx, err)
return 0, err
}
writer, err := lock.Open(filePath, os.O_CREATE|os.O_WRONLY, 0666)
@@ -276,7 +315,8 @@ func fsCreateFile(filePath string, reader io.Reader, buf []byte, fallocSize int6
// Fallocate only if the size is final object is known.
if fallocSize > 0 {
if err = fsFAllocate(int(writer.Fd()), 0, fallocSize); err != nil {
return 0, errors.Trace(err)
logger.LogIf(ctx, err)
return 0, err
}
}
@@ -284,12 +324,14 @@ func fsCreateFile(filePath string, reader io.Reader, buf []byte, fallocSize int6
if buf != nil {
bytesWritten, err = io.CopyBuffer(writer, reader, buf)
if err != nil {
return 0, errors.Trace(err)
logger.LogIf(ctx, err)
return 0, err
}
} else {
bytesWritten, err = io.Copy(writer, reader)
if err != nil {
return 0, errors.Trace(err)
logger.LogIf(ctx, err)
return 0, err
}
}
@@ -320,12 +362,14 @@ func fsFAllocate(fd int, offset int64, len int64) (err error) {
// Renames source path to destination path, creates all the
// missing parents if they don't exist.
func fsRenameFile(sourcePath, destPath string) error {
func fsRenameFile(ctx context.Context, sourcePath, destPath string) error {
if err := checkPathLength(sourcePath); err != nil {
return errors.Trace(err)
logger.LogIf(ctx, err)
return err
}
if err := checkPathLength(destPath); err != nil {
return errors.Trace(err)
logger.LogIf(ctx, err)
return err
}
// Verify if source path exists.
@@ -334,27 +378,34 @@ func fsRenameFile(sourcePath, destPath string) error {
}
if err := renameAll(sourcePath, destPath); err != nil {
return errors.Trace(err)
logger.LogIf(ctx, err)
return err
}
return nil
}
// fsDeleteFile is a wrapper for deleteFile(), after checking the path length.
func fsDeleteFile(basePath, deletePath string) error {
func fsDeleteFile(ctx context.Context, basePath, deletePath string) error {
if err := checkPathLength(basePath); err != nil {
return errors.Trace(err)
logger.LogIf(ctx, err)
return err
}
if err := checkPathLength(deletePath); err != nil {
return errors.Trace(err)
logger.LogIf(ctx, err)
return err
}
return deleteFile(basePath, deletePath)
if err := deleteFile(basePath, deletePath); err != nil {
logger.LogIf(ctx, err)
return err
}
return nil
}
// fsRemoveMeta safely removes a locked file and takes care of Windows special case
func fsRemoveMeta(basePath, deletePath, tmpDir string) error {
func fsRemoveMeta(ctx context.Context, basePath, deletePath, tmpDir string) error {
// Special case for windows please read through.
if runtime.GOOS == globalWindowsOSName {
// Ordinarily windows does not permit deletion or renaming of files still
@@ -388,13 +439,13 @@ func fsRemoveMeta(basePath, deletePath, tmpDir string) error {
tmpPath := pathJoin(tmpDir, mustGetUUID())
fsRenameFile(deletePath, tmpPath)
fsRenameFile(ctx, deletePath, tmpPath)
// Proceed to deleting the directory if empty
fsDeleteFile(basePath, pathutil.Dir(deletePath))
fsDeleteFile(ctx, basePath, pathutil.Dir(deletePath))
// Finally delete the renamed file.
return fsDeleteFile(tmpDir, tmpPath)
return fsDeleteFile(ctx, tmpDir, tmpPath)
}
return fsDeleteFile(basePath, deletePath)
return fsDeleteFile(ctx, basePath, deletePath)
}