diff options
author | Gabriel Jackson <gabriel@coffeepowered.co> | 2017-01-29 12:13:57 -0800 |
---|---|---|
committer | Kim "BKC" Carlbäcker <kim.carlbacker@gmail.com> | 2017-02-02 15:24:18 +0100 |
commit | bf6f61cc690978bcad416ace8e8da2418602cbf3 (patch) | |
tree | 98be4a5abcd53063b41676772b8dd37a47621c44 /modules | |
parent | 73d05a51e3dce4a5b31b8660a6141a14ae615404 (diff) | |
download | gitea-bf6f61cc690978bcad416ace8e8da2418602cbf3.tar.gz gitea-bf6f61cc690978bcad416ace8e8da2418602cbf3.zip |
Cleanup log messaging
This change corrects a few logging issues:
* Standardized formatting errors with '%v'.
* Standardized failure warning word usage.
* Corrected an instance of using the standard log library when
the gitea log library should be used instead.
Diffstat (limited to 'modules')
-rw-r--r-- | modules/base/tool.go | 2 | ||||
-rw-r--r-- | modules/log/file.go | 8 | ||||
-rw-r--r-- | modules/log/log.go | 4 | ||||
-rw-r--r-- | modules/mailer/mailer.go | 2 | ||||
-rw-r--r-- | modules/setting/setting.go | 60 | ||||
-rw-r--r-- | modules/ssh/ssh.go | 11 |
6 files changed, 43 insertions, 44 deletions
diff --git a/modules/base/tool.go b/modules/base/tool.go index f4249f6d6d..d7d86ea4a7 100644 --- a/modules/base/tool.go +++ b/modules/base/tool.go @@ -110,7 +110,7 @@ func GetRandomBytesAsBase64(n int) string { _, err := io.ReadFull(rand.Reader, bytes) if err != nil { - log.Fatal(4, "Error reading random bytes: %s", err) + log.Fatal(4, "Error reading random bytes: %v", err) } return base64.RawURLEncoding.EncodeToString(bytes) diff --git a/modules/log/file.go b/modules/log/file.go index dc243de8d9..fe6c54ec38 100644 --- a/modules/log/file.go +++ b/modules/log/file.go @@ -151,7 +151,7 @@ func (w *FileLogWriter) initFd() error { fd := w.mw.fd finfo, err := fd.Stat() if err != nil { - return fmt.Errorf("get stat: %s", err) + return fmt.Errorf("get stat: %v", err) } w.maxsizeCursize = int(finfo.Size()) w.dailyOpenDate = time.Now().Day() @@ -194,12 +194,12 @@ func (w *FileLogWriter) DoRotate() error { // close fd before rename // Rename the file to its newfound home if err = os.Rename(w.Filename, fname); err != nil { - return fmt.Errorf("Rotate: %s", err) + return fmt.Errorf("Rotate: %v", err) } // re-start logger if err = w.StartLogger(); err != nil { - return fmt.Errorf("Rotate StartLogger: %s", err) + return fmt.Errorf("Rotate StartLogger: %v", err) } go w.deleteOldLog() @@ -221,7 +221,7 @@ func (w *FileLogWriter) deleteOldLog() { if strings.HasPrefix(filepath.Base(path), filepath.Base(w.Filename)) { if err := os.Remove(path); err != nil { - returnErr = fmt.Errorf("Fail to remove %s: %v", path, err) + returnErr = fmt.Errorf("Failed to remove %s: %v", path, err) } } } diff --git a/modules/log/log.go b/modules/log/log.go index 8faf9416de..bea6e5b80a 100644 --- a/modules/log/log.go +++ b/modules/log/log.go @@ -35,7 +35,7 @@ func NewLogger(bufLen int64, mode, config string) { loggers = append(loggers, logger) } if err := logger.SetLogger(mode, config); err != nil { - Fatal(2, "Fail to set logger (%s): %v", mode, err) + Fatal(2, "Failed to set logger (%s): %v", mode, err) } } @@ -56,7 +56,7 @@ func NewGitLogger(logPath string) { path := path.Dir(logPath) if err := os.MkdirAll(path, os.ModePerm); err != nil { - Fatal(4, "Fail to create dir %s: %v", path, err) + Fatal(4, "Failed to create dir %s: %v", path, err) } GitLogger = newLogger(0) diff --git a/modules/mailer/mailer.go b/modules/mailer/mailer.go index fd1a5db14f..ab8f010880 100644 --- a/modules/mailer/mailer.go +++ b/modules/mailer/mailer.go @@ -241,7 +241,7 @@ func processMailQueue() { case msg := <-mailQueue: log.Trace("New e-mail sending request %s: %s", msg.GetHeader("To"), msg.Info) if err := gomail.Send(Sender, msg.Message); err != nil { - log.Error(3, "Fail to send emails %s: %s - %v", msg.GetHeader("To"), msg.Info, err) + log.Error(3, "Failed to send emails %s: %s - %v", msg.GetHeader("To"), msg.Info, err) } else { log.Trace("E-mails sent %s: %s", msg.GetHeader("To"), msg.Info) } diff --git a/modules/setting/setting.go b/modules/setting/setting.go index 0586bce94b..ae7b8beb3a 100644 --- a/modules/setting/setting.go +++ b/modules/setting/setting.go @@ -431,7 +431,7 @@ func init() { var err error if AppPath, err = execPath(); err != nil { - log.Fatal(4, "fail to get app path: %v\n", err) + log.Fatal(4, "Failed to get app path: %v", err) } // Note: we don't use path.Dir here because it does not handle case @@ -483,16 +483,16 @@ func IsRunUserMatchCurrentUser(runUser string) (string, bool) { func createPIDFile(pidPath string) { currentPid := os.Getpid() if err := os.MkdirAll(filepath.Dir(pidPath), os.ModePerm); err != nil { - log.Fatal(4, "Can't create PID folder on %s", err) + log.Fatal(4, "Failed to create PID folder: %v", err) } file, err := os.Create(pidPath) if err != nil { - log.Fatal(4, "Can't create PID file: %v", err) + log.Fatal(4, "Failed to create PID file: %v", err) } defer file.Close() if _, err := file.WriteString(strconv.FormatInt(int64(currentPid), 10)); err != nil { - log.Fatal(4, "Can'write PID information on %s", err) + log.Fatal(4, "Failed to write PID information: %v", err) } } @@ -501,13 +501,13 @@ func createPIDFile(pidPath string) { func NewContext() { workDir, err := WorkDir() if err != nil { - log.Fatal(4, "Fail to get work directory: %v", err) + log.Fatal(4, "Failed to get work directory: %v", err) } Cfg = ini.Empty() if err != nil { - log.Fatal(4, "Fail to parse 'app.ini': %v", err) + log.Fatal(4, "Failed to parse 'app.ini': %v", err) } CustomPath = os.Getenv("GITEA_CUSTOM") @@ -533,7 +533,7 @@ please consider changing to GITEA_CUSTOM`) if com.IsFile(CustomConf) { if err = Cfg.Append(CustomConf); err != nil { - log.Fatal(4, "Fail to load custom conf '%s': %v", CustomConf, err) + log.Fatal(4, "Failed to load custom conf '%s': %v", CustomConf, err) } } else { log.Warn("Custom config '%s' not found, ignore this if you're running first time", CustomConf) @@ -542,7 +542,7 @@ please consider changing to GITEA_CUSTOM`) homeDir, err := com.HomeDir() if err != nil { - log.Fatal(4, "Fail to get home directory: %v", err) + log.Fatal(4, "Failed to get home directory: %v", err) } homeDir = strings.Replace(homeDir, "\\", "/", -1) @@ -578,7 +578,7 @@ please consider changing to GITEA_CUSTOM`) UnixSocketPermissionRaw := sec.Key("UNIX_SOCKET_PERMISSION").MustString("666") UnixSocketPermissionParsed, err := strconv.ParseUint(UnixSocketPermissionRaw, 8, 32) if err != nil || UnixSocketPermissionParsed > 0777 { - log.Fatal(4, "Fail to parse unixSocketPermission: %s", UnixSocketPermissionRaw) + log.Fatal(4, "Failed to parse unixSocketPermission: %s", UnixSocketPermissionRaw) } UnixSocketPermission = uint32(UnixSocketPermissionParsed) } @@ -602,7 +602,7 @@ please consider changing to GITEA_CUSTOM`) SSH.RootPath = path.Join(homeDir, ".ssh") SSH.KeyTestPath = os.TempDir() if err = Cfg.Section("server").MapTo(&SSH); err != nil { - log.Fatal(4, "Fail to map SSH settings: %v", err) + log.Fatal(4, "Failed to map SSH settings: %v", err) } SSH.KeygenPath = sec.Key("SSH_KEYGEN_PATH").MustString("ssh-keygen") @@ -616,9 +616,9 @@ please consider changing to GITEA_CUSTOM`) if !SSH.Disabled && !SSH.StartBuiltinServer { if err := os.MkdirAll(SSH.RootPath, 0700); err != nil { - log.Fatal(4, "Fail to create '%s': %v", SSH.RootPath, err) + log.Fatal(4, "Failed to create '%s': %v", SSH.RootPath, err) } else if err = os.MkdirAll(SSH.KeyTestPath, 0644); err != nil { - log.Fatal(4, "Fail to create '%s': %v", SSH.KeyTestPath, err) + log.Fatal(4, "Failed to create '%s': %v", SSH.KeyTestPath, err) } } @@ -632,13 +632,13 @@ please consider changing to GITEA_CUSTOM`) } if err = Cfg.Section("server").MapTo(&LFS); err != nil { - log.Fatal(4, "Fail to map LFS settings: %v", err) + log.Fatal(4, "Failed to map LFS settings: %v", err) } if LFS.StartServer { if err := os.MkdirAll(LFS.ContentPath, 0700); err != nil { - log.Fatal(4, "Fail to create '%s': %v", LFS.ContentPath, err) + log.Fatal(4, "Failed to create '%s': %v", LFS.ContentPath, err) } LFS.JWTSecretBytes = make([]byte, 32) @@ -650,7 +650,7 @@ please consider changing to GITEA_CUSTOM`) _, err := io.ReadFull(rand.Reader, LFS.JWTSecretBytes) if err != nil { - log.Fatal(4, "Error reading random bytes: %s", err) + log.Fatal(4, "Error reading random bytes: %v", err) } LFS.JWTSecretBase64 = base64.RawURLEncoding.EncodeToString(LFS.JWTSecretBytes) @@ -660,14 +660,14 @@ please consider changing to GITEA_CUSTOM`) if com.IsFile(CustomConf) { // Keeps custom settings if there is already something. if err := cfg.Append(CustomConf); err != nil { - log.Error(4, "Fail to load custom conf '%s': %v", CustomConf, err) + log.Error(4, "Failed to load custom conf '%s': %v", CustomConf, err) } } cfg.Section("server").Key("LFS_JWT_SECRET").SetValue(LFS.JWTSecretBase64) if err := os.MkdirAll(filepath.Dir(CustomConf), os.ModePerm); err != nil { - log.Fatal(4, "Fail to create '%s': %v", CustomConf, err) + log.Fatal(4, "Failed to create '%s': %v", CustomConf, err) } if err := cfg.SaveTo(CustomConf); err != nil { log.Fatal(4, "Error saving generated JWT Secret to custom config: %v", err) @@ -680,22 +680,22 @@ please consider changing to GITEA_CUSTOM`) binVersion, err := git.BinVersion() if err != nil { - log.Fatal(4, "Error retrieving git version: %s", err) + log.Fatal(4, "Error retrieving git version: %v", err) } splitVersion := strings.SplitN(binVersion, ".", 3) majorVersion, err := strconv.ParseUint(splitVersion[0], 10, 64) if err != nil { - log.Fatal(4, "Error parsing git major version: %s", err) + log.Fatal(4, "Error parsing git major version: %v", err) } minorVersion, err := strconv.ParseUint(splitVersion[1], 10, 64) if err != nil { - log.Fatal(4, "Error parsing git minor version: %s", err) + log.Fatal(4, "Error parsing git minor version: %v", err) } revisionVersion, err := strconv.ParseUint(splitVersion[2], 10, 64) if err != nil { - log.Fatal(4, "Error parsing git revision version: %s", err) + log.Fatal(4, "Error parsing git revision version: %v", err) } if !((majorVersion > 2) || (majorVersion == 2 && minorVersion > 1) || @@ -771,11 +771,11 @@ please consider changing to GITEA_CUSTOM`) } ScriptType = sec.Key("SCRIPT_TYPE").MustString("bash") if err = Cfg.Section("repository").MapTo(&Repository); err != nil { - log.Fatal(4, "Fail to map Repository settings: %v", err) + log.Fatal(4, "Failed to map Repository settings: %v", err) } else if err = Cfg.Section("repository.editor").MapTo(&Repository.Editor); err != nil { - log.Fatal(4, "Fail to map Repository.Editor settings: %v", err) + log.Fatal(4, "Failed to map Repository.Editor settings: %v", err) } else if err = Cfg.Section("repository.upload").MapTo(&Repository.Upload); err != nil { - log.Fatal(4, "Fail to map Repository.Upload settings: %v", err) + log.Fatal(4, "Failed to map Repository.Upload settings: %v", err) } if !filepath.IsAbs(Repository.Upload.TempPath) { @@ -823,17 +823,17 @@ please consider changing to GITEA_CUSTOM`) } if err = Cfg.Section("ui").MapTo(&UI); err != nil { - log.Fatal(4, "Fail to map UI settings: %v", err) + log.Fatal(4, "Failed to map UI settings: %v", err) } else if err = Cfg.Section("markdown").MapTo(&Markdown); err != nil { - log.Fatal(4, "Fail to map Markdown settings: %v", err) + log.Fatal(4, "Failed to map Markdown settings: %v", err) } else if err = Cfg.Section("cron").MapTo(&Cron); err != nil { - log.Fatal(4, "Fail to map Cron settings: %v", err) + log.Fatal(4, "Failed to map Cron settings: %v", err) } else if err = Cfg.Section("git").MapTo(&Git); err != nil { - log.Fatal(4, "Fail to map Git settings: %v", err) + log.Fatal(4, "Failed to map Git settings: %v", err) } else if err = Cfg.Section("mirror").MapTo(&Mirror); err != nil { - log.Fatal(4, "Fail to map Mirror settings: %v", err) + log.Fatal(4, "Failed to map Mirror settings: %v", err) } else if err = Cfg.Section("api").MapTo(&API); err != nil { - log.Fatal(4, "Fail to map API settings: %v", err) + log.Fatal(4, "Failed to map API settings: %v", err) } if Mirror.DefaultInterval <= 0 { diff --git a/modules/ssh/ssh.go b/modules/ssh/ssh.go index 18bac8dbf2..36a383fa86 100644 --- a/modules/ssh/ssh.go +++ b/modules/ssh/ssh.go @@ -5,7 +5,6 @@ package ssh import ( - "fmt" "io" "io/ioutil" "net" @@ -117,7 +116,7 @@ func handleServerConn(keyID string, chans <-chan ssh.NewChannel) { func listen(config *ssh.ServerConfig, host string, port int) { listener, err := net.Listen("tcp", host+":"+com.ToStr(port)) if err != nil { - log.Fatal(4, "Fail to start SSH server: %v", err) + log.Fatal(4, "Failed to start SSH server: %v", err) } for { // Once a ServerConfig has been configured, connections can be accepted. @@ -169,23 +168,23 @@ func Listen(host string, port int) { filePath := filepath.Dir(keyPath) if err := os.MkdirAll(filePath, os.ModePerm); err != nil { - log.Error(4, "Fail to create dir %s: %v", filePath, err) + log.Error(4, "Failed to create dir %s: %v", filePath, err) } _, stderr, err := com.ExecCmd("ssh-keygen", "-f", keyPath, "-t", "rsa", "-N", "") if err != nil { - panic(fmt.Sprintf("Fail to generate private key: %v - %s", err, stderr)) + log.Fatal(4, "Failed to generate private key: %v - %s", err, stderr) } log.Trace("SSH: New private key is generateed: %s", keyPath) } privateBytes, err := ioutil.ReadFile(keyPath) if err != nil { - panic("SSH: Fail to load private key") + log.Fatal(4, "SSH: Failed to load private key") } private, err := ssh.ParsePrivateKey(privateBytes) if err != nil { - panic("SSH: Fail to parse private key") + log.Fatal(4, "SSH: Failed to parse private key") } config.AddHostKey(private) |