Skip to content

Commit bf6f61c

Browse files
gabrieljacksonbkcsoft
gabrieljackson
authored and
bkcsoft
committed
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.
1 parent 73d05a5 commit bf6f61c

26 files changed

+111
-112
lines changed

‎cmd/cert.go

+7-7
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ func pemBlockForKey(priv interface{}) *pem.Block {
8282
case *ecdsa.PrivateKey:
8383
b, err := x509.MarshalECPrivateKey(k)
8484
if err != nil {
85-
log.Fatalf("Unable to marshal ECDSA private key: %v\n", err)
85+
log.Fatalf("Unable to marshal ECDSA private key: %v", err)
8686
}
8787
return &pem.Block{Type: "EC PRIVATE KEY", Bytes: b}
8888
default:
@@ -112,7 +112,7 @@ func runCert(ctx *cli.Context) error {
112112
log.Fatalf("Unrecognized elliptic curve: %q", ctx.String("ecdsa-curve"))
113113
}
114114
if err != nil {
115-
log.Fatalf("Failed to generate private key: %s", err)
115+
log.Fatalf("Failed to generate private key: %v", err)
116116
}
117117

118118
var notBefore time.Time
@@ -121,7 +121,7 @@ func runCert(ctx *cli.Context) error {
121121
} else {
122122
notBefore, err = time.Parse("Jan 2 15:04:05 2006", ctx.String("start-date"))
123123
if err != nil {
124-
log.Fatalf("Failed to parse creation date: %s", err)
124+
log.Fatalf("Failed to parse creation date: %v", err)
125125
}
126126
}
127127

@@ -130,7 +130,7 @@ func runCert(ctx *cli.Context) error {
130130
serialNumberLimit := new(big.Int).Lsh(big.NewInt(1), 128)
131131
serialNumber, err := rand.Int(rand.Reader, serialNumberLimit)
132132
if err != nil {
133-
log.Fatalf("Failed to generate serial number: %s", err)
133+
log.Fatalf("Failed to generate serial number: %v", err)
134134
}
135135

136136
template := x509.Certificate{
@@ -163,20 +163,20 @@ func runCert(ctx *cli.Context) error {
163163

164164
derBytes, err := x509.CreateCertificate(rand.Reader, &template, &template, publicKey(priv), priv)
165165
if err != nil {
166-
log.Fatalf("Failed to create certificate: %s", err)
166+
log.Fatalf("Failed to create certificate: %v", err)
167167
}
168168

169169
certOut, err := os.Create("cert.pem")
170170
if err != nil {
171-
log.Fatalf("Failed to open cert.pem for writing: %s", err)
171+
log.Fatalf("Failed to open cert.pem for writing: %v", err)
172172
}
173173
pem.Encode(certOut, &pem.Block{Type: "CERTIFICATE", Bytes: derBytes})
174174
certOut.Close()
175175
log.Println("Written cert.pem")
176176

177177
keyOut, err := os.OpenFile("key.pem", os.O_WRONLY|os.O_CREATE|os.O_TRUNC, 0600)
178178
if err != nil {
179-
log.Fatalf("Failed to open key.pem for writing: %v\n", err)
179+
log.Fatalf("Failed to open key.pem for writing: %v", err)
180180
}
181181
pem.Encode(keyOut, pemBlockForKey(priv))
182182
keyOut.Close()

‎cmd/dump.go

+11-11
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ func runDump(ctx *cli.Context) error {
6868
}
6969
TmpWorkDir, err := ioutil.TempDir(tmpDir, "gitea-dump-")
7070
if err != nil {
71-
log.Fatalf("Fail to create tmp work directory: %v", err)
71+
log.Fatalf("Failed to create tmp work directory: %v", err)
7272
}
7373
log.Printf("Creating tmp work dir: %s", TmpWorkDir)
7474

@@ -78,7 +78,7 @@ func runDump(ctx *cli.Context) error {
7878
log.Printf("Dumping local repositories...%s", setting.RepoRootPath)
7979
zip.Verbose = ctx.Bool("verbose")
8080
if err := zip.PackTo(setting.RepoRootPath, reposDump, true); err != nil {
81-
log.Fatalf("Fail to dump local repositories: %v", err)
81+
log.Fatalf("Failed to dump local repositories: %v", err)
8282
}
8383

8484
targetDBType := ctx.String("database")
@@ -89,26 +89,26 @@ func runDump(ctx *cli.Context) error {
8989
}
9090

9191
if err := models.DumpDatabase(dbDump, targetDBType); err != nil {
92-
log.Fatalf("Fail to dump database: %v", err)
92+
log.Fatalf("Failed to dump database: %v", err)
9393
}
9494

9595
fileName := fmt.Sprintf("gitea-dump-%d.zip", time.Now().Unix())
9696
log.Printf("Packing dump files...")
9797
z, err := zip.Create(fileName)
9898
if err != nil {
99-
log.Fatalf("Fail to create %s: %v", fileName, err)
99+
log.Fatalf("Failed to create %s: %v", fileName, err)
100100
}
101101

102102
if err := z.AddFile("gitea-repo.zip", reposDump); err != nil {
103-
log.Fatalf("Fail to include gitea-repo.zip: %v", err)
103+
log.Fatalf("Failed to include gitea-repo.zip: %v", err)
104104
}
105105
if err := z.AddFile("gitea-db.sql", dbDump); err != nil {
106-
log.Fatalf("Fail to include gitea-db.sql: %v", err)
106+
log.Fatalf("Failed to include gitea-db.sql: %v", err)
107107
}
108108
customDir, err := os.Stat(setting.CustomPath)
109109
if err == nil && customDir.IsDir() {
110110
if err := z.AddDir("custom", setting.CustomPath); err != nil {
111-
log.Fatalf("Fail to include custom: %v", err)
111+
log.Fatalf("Failed to include custom: %v", err)
112112
}
113113
} else {
114114
log.Printf("Custom dir %s doesn't exist, skipped", setting.CustomPath)
@@ -124,16 +124,16 @@ func runDump(ctx *cli.Context) error {
124124
}
125125

126126
if err := zipAddDirectoryExclude(z, "data", setting.AppDataPath, sessionAbsPath); err != nil {
127-
log.Fatalf("Fail to include data directory: %v", err)
127+
log.Fatalf("Failed to include data directory: %v", err)
128128
}
129129

130130
if err := z.AddDir("log", setting.LogRootPath); err != nil {
131-
log.Fatalf("Fail to include log: %v", err)
131+
log.Fatalf("Failed to include log: %v", err)
132132
}
133133
// FIXME: SSH key file.
134134
if err = z.Close(); err != nil {
135135
_ = os.Remove(fileName)
136-
log.Fatalf("Fail to save %s: %v", fileName, err)
136+
log.Fatalf("Failed to save %s: %v", fileName, err)
137137
}
138138

139139
if err := os.Chmod(fileName, 0600); err != nil {
@@ -143,7 +143,7 @@ func runDump(ctx *cli.Context) error {
143143
log.Printf("Removing tmp work dir: %s", TmpWorkDir)
144144

145145
if err := os.RemoveAll(TmpWorkDir); err != nil {
146-
log.Fatalf("Fail to remove %s: %v", TmpWorkDir, err)
146+
log.Fatalf("Failed to remove %s: %v", TmpWorkDir, err)
147147
}
148148
log.Printf("Finish dumping in file %s", fileName)
149149

‎cmd/serve.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ func setup(logPath string) {
5656
if setting.UseSQLite3 || setting.UseTiDB {
5757
workDir, _ := setting.WorkDir()
5858
if err := os.Chdir(workDir); err != nil {
59-
log.GitLogger.Fatal(4, "Fail to change directory %s: %v", workDir, err)
59+
log.GitLogger.Fatal(4, "Failed to change directory %s: %v", workDir, err)
6060
}
6161
}
6262

@@ -134,10 +134,10 @@ func handleUpdateTask(uuid string, user, repoUser *models.User, reponame string,
134134
if err == nil {
135135
resp.Body.Close()
136136
if resp.StatusCode/100 != 2 {
137-
log.GitLogger.Error(2, "Fail to trigger task: not 2xx response code")
137+
log.GitLogger.Error(2, "Failed to trigger task: not 2xx response code")
138138
}
139139
} else {
140-
log.GitLogger.Error(2, "Fail to trigger task: %v", err)
140+
log.GitLogger.Error(2, "Failed to trigger task: %v", err)
141141
}
142142
}
143143

@@ -273,7 +273,7 @@ func runServ(c *cli.Context) error {
273273

274274
mode, err := models.AccessLevel(user, repo)
275275
if err != nil {
276-
fail("Internal error", "Fail to check access: %v", err)
276+
fail("Internal error", "Failed to check access: %v", err)
277277
} else if mode < requestedMode {
278278
clientMessage := accessDenied
279279
if mode >= models.AccessModeRead {

‎cmd/web.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ func newMacaron() *macaron.Macaron {
114114
localeNames, err := options.Dir("locale")
115115

116116
if err != nil {
117-
log.Fatal(4, "Fail to list locale files: %v", err)
117+
log.Fatal(4, "Failed to list locale files: %v", err)
118118
}
119119

120120
localFiles := make(map[string][]byte)
@@ -655,7 +655,7 @@ func runWeb(ctx *cli.Context) error {
655655
err = fcgi.Serve(nil, m)
656656
case setting.UnixSocket:
657657
if err := os.Remove(listenAddr); err != nil {
658-
log.Fatal(4, "Fail to remove unix socket directory %s: %v", listenAddr, err)
658+
log.Fatal(4, "Failed to remove unix socket directory %s: %v", listenAddr, err)
659659
}
660660
var listener *net.UnixListener
661661
listener, err = net.ListenUnix("unix", &net.UnixAddr{Name: listenAddr, Net: "unix"})
@@ -674,7 +674,7 @@ func runWeb(ctx *cli.Context) error {
674674
}
675675

676676
if err != nil {
677-
log.Fatal(4, "Fail to start server: %v", err)
677+
log.Fatal(4, "Failed to start server: %v", err)
678678
}
679679

680680
return nil

‎cmd/web_graceful.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@ package cmd
88

99
import (
1010
"crypto/tls"
11-
"log"
1211
"net/http"
1312

13+
"code.gitea.io/gitea/modules/log"
1414
"github.com/facebookgo/grace/gracehttp"
1515
)
1616

‎main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ func main() {
3838
app.Flags = append(app.Flags, []cli.Flag{}...)
3939
err := app.Run(os.Args)
4040
if err != nil {
41-
log.Fatal(4, "Fail to run app with %s: %v", os.Args, err)
41+
log.Fatal(4, "Failed to run app with %s: %v", os.Args, err)
4242
}
4343

4444
}

‎models/migrations/migrations.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,7 @@ func attachmentRefactor(x *xorm.Engine) error {
328328

329329
dumpPath := path.Join(setting.LogRootPath, "attachment_path.dump")
330330
ioutil.WriteFile(dumpPath, buf.Bytes(), 0666)
331-
fmt.Println("Fail to rename some attachments, old and new paths are saved into:", dumpPath)
331+
log.Info("Failed to rename some attachments, old and new paths are saved into: %s", dumpPath)
332332
}()
333333
for _, attach := range attachments {
334334
if err = os.MkdirAll(path.Dir(attach.NewPath), os.ModePerm); err != nil {

‎models/models.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -205,15 +205,15 @@ func getEngine() (*xorm.Engine, error) {
205205
return nil, errors.New("this binary version does not build support for SQLite3")
206206
}
207207
if err := os.MkdirAll(path.Dir(DbCfg.Path), os.ModePerm); err != nil {
208-
return nil, fmt.Errorf("Fail to create directories: %v", err)
208+
return nil, fmt.Errorf("Failed to create directories: %v", err)
209209
}
210210
connStr = "file:" + DbCfg.Path + "?cache=shared&mode=rwc"
211211
case "tidb":
212212
if !EnableTiDB {
213213
return nil, errors.New("this binary version does not build support for TiDB")
214214
}
215215
if err := os.MkdirAll(path.Dir(DbCfg.Path), os.ModePerm); err != nil {
216-
return nil, fmt.Errorf("Fail to create directories: %v", err)
216+
return nil, fmt.Errorf("Failed to create directories: %v", err)
217217
}
218218
connStr = "goleveldb://" + DbCfg.Path
219219
default:
@@ -237,7 +237,7 @@ func NewTestEngine(x *xorm.Engine) (err error) {
237237
func SetEngine() (err error) {
238238
x, err = getEngine()
239239
if err != nil {
240-
return fmt.Errorf("Fail to connect to database: %v", err)
240+
return fmt.Errorf("Failed to connect to database: %v", err)
241241
}
242242

243243
x.SetMapper(core.GonicMapper{})
@@ -247,12 +247,12 @@ func SetEngine() (err error) {
247247
logPath := path.Join(setting.LogRootPath, "xorm.log")
248248

249249
if err := os.MkdirAll(path.Dir(logPath), os.ModePerm); err != nil {
250-
return fmt.Errorf("Fail to create dir %s: %v", logPath, err)
250+
return fmt.Errorf("Failed to create dir %s: %v", logPath, err)
251251
}
252252

253253
f, err := os.Create(logPath)
254254
if err != nil {
255-
return fmt.Errorf("Fail to create xorm.log: %v", err)
255+
return fmt.Errorf("Failed to create xorm.log: %v", err)
256256
}
257257
x.SetLogger(xorm.NewSimpleLogger(f))
258258
x.ShowSQL(true)

‎models/org.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -272,13 +272,13 @@ func deleteOrg(e *xorm.Session, u *User) error {
272272
path := UserPath(u.Name)
273273

274274
if err := os.RemoveAll(path); err != nil {
275-
return fmt.Errorf("Fail to RemoveAll %s: %v", path, err)
275+
return fmt.Errorf("Failed to RemoveAll %s: %v", path, err)
276276
}
277277

278278
avatarPath := u.CustomAvatarPath()
279279
if com.IsExist(avatarPath) {
280280
if err := os.Remove(avatarPath); err != nil {
281-
return fmt.Errorf("Fail to remove %s: %v", avatarPath, err)
281+
return fmt.Errorf("Failed to remove %s: %v", avatarPath, err)
282282
}
283283
}
284284

‎models/pull.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -275,7 +275,7 @@ func (pr *PullRequest) Merge(doer *User, baseGitRepo *git.Repository) (err error
275275
tmpBasePath := path.Join(setting.AppDataPath, "tmp/repos", com.ToStr(time.Now().Nanosecond())+".git")
276276

277277
if err := os.MkdirAll(path.Dir(tmpBasePath), os.ModePerm); err != nil {
278-
return fmt.Errorf("Fail to create dir %s: %v", tmpBasePath, err)
278+
return fmt.Errorf("Failed to create dir %s: %v", tmpBasePath, err)
279279
}
280280

281281
defer os.RemoveAll(path.Dir(tmpBasePath))

0 commit comments

Comments
 (0)