Skip to content

Commit abf836e

Browse files
mpsonntagmpsonntag
committed
Consistently use log.ShowWrite
1 parent c878213 commit abf836e

File tree

10 files changed

+108
-111
lines changed

10 files changed

+108
-111
lines changed

‎cmd/ginvalid/main.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,13 @@ func startupCheck(srvcfg config.ServerCfg) {
6262
os.Exit(-1)
6363
}
6464

65-
log.ShowWrite("[Warmup] using temp directory: '%s'", srvcfg.Dir.Temp)
66-
log.ShowWrite("[Warmup] using results directory '%s'", srvcfg.Dir.Result)
65+
log.ShowWrite("[Warmup] using temp directory: %q", srvcfg.Dir.Temp)
66+
log.ShowWrite("[Warmup] using results directory %q", srvcfg.Dir.Result)
6767

6868
// Check bids-validator is installed
6969
outstr, err := helpers.AppVersionCheck(srvcfg.Exec.BIDS)
7070
if err != nil {
71-
log.ShowWrite("[Error] checking bids-validator '%s'", err.Error())
71+
log.ShowWrite("[Error] checking bids-validator %q", err.Error())
7272
os.Exit(-1)
7373
}
7474
log.ShowWrite("[Warmup] using bids-validator v%s", strings.TrimSpace(outstr))
@@ -110,7 +110,7 @@ func commcheck(srvcfg config.ServerCfg) {
110110
cli := ginclient.New("gin")
111111
err = cli.Login(srvcfg.Settings.GINUser, srvcfg.Settings.GINPassword, srvcfg.Settings.ClientID)
112112
if err != nil {
113-
log.ShowWrite("Failed to login to GIN server: %s", err.Error())
113+
log.ShowWrite("[Error] Failed to login to GIN server: %s", err.Error())
114114
os.Exit(-1)
115115
}
116116
log.ShowWrite("[Warmup] GIN server configuration OK")
@@ -171,7 +171,7 @@ func main() {
171171
port = srvcfg.Settings.Port
172172
}
173173
port = fmt.Sprintf(":%s", port)
174-
log.ShowWrite("[Warmup] using port: '%s'", port)
174+
log.ShowWrite("[Warmup] using port: %q", port)
175175

176176
log.ShowWrite("[Warmup] registering routes")
177177
router := mux.NewRouter()

‎internal/helpers/utils.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ func ValidDirectory(path string) bool {
1212
var fi os.FileInfo
1313
var err error
1414
if fi, err = os.Stat(path); err != nil {
15-
log.ShowWrite("[Error] checking directory '%s': '%s'\n", path, err.Error())
15+
log.ShowWrite("[Error] checking directory %q: %q", path, err.Error())
1616
return false
1717
} else if !fi.IsDir() {
18-
log.ShowWrite("[Error] invalid directory '%s'\n", fi.Name())
18+
log.ShowWrite("[Error] invalid directory %q", fi.Name())
1919
return false
2020
}
2121
return true

‎internal/web/fail.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,21 @@ import (
1313
// fail logs an error and renders an error page with the given message,
1414
// returning the given status code to the user.
1515
func fail(w http.ResponseWriter, r *http.Request, status int, message string) {
16-
log.Write("[error] %s", message)
16+
log.ShowWrite("[Info] displaying error message %s", message)
1717
w.WriteHeader(status)
1818

1919
tmpl := template.New("layout")
2020
tmpl, err := tmpl.Parse(templates.Layout)
2121
if err != nil {
22-
log.Write("[Error] failed to parse html layout page. Displaying error message without layout.")
22+
log.ShowWrite("[Error] failed to parse html layout page. Displaying error message without layout: %s", err.Error())
2323
tmpl = template.New("content")
2424
}
2525
tmpl, err = tmpl.Parse(templates.Fail)
2626
if err != nil {
27-
log.Write("[Error] failed to render fail page. Displaying plain error message.")
27+
log.ShowWrite("[Error] failed to render fail page. Displaying plain error message: %s", err.Error())
2828
_, err = w.Write([]byte(message))
2929
if err != nil {
30-
log.Write("[Error] failed to write plain error message: %s", err.Error())
30+
log.ShowWrite("[Error] failed to write plain error message: %s", err.Error())
3131
}
3232
return
3333
}
@@ -54,6 +54,6 @@ func fail(w http.ResponseWriter, r *http.Request, status int, message string) {
5454
}
5555
err = tmpl.Execute(w, &errinfo)
5656
if err != nil {
57-
log.Write("[Error] failed to parse error info to page: %s", err.Error())
57+
log.ShowWrite("[Error] failed to parse error info to page: %s", err.Error())
5858
}
5959
}

‎internal/web/ginutils.go

+3-4
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ func isGitRepo(path string) bool {
114114
// This function is a modified version of the gin-client CloneRepo method.
115115
func remoteCloneRepo(gincl *ginclient.Client, repopath, clonedir string, clonechan chan<- gingit.RepoFileStatus) {
116116
defer close(clonechan)
117-
log.ShowWrite("[Info] Starting remoteCloneRepo")
117+
log.ShowWrite("[Info] starting remoteCloneRepo")
118118
clonestatus := make(chan gingit.RepoFileStatus)
119119
remotepath := fmt.Sprintf("%s/%s", gincl.GitAddress(), repopath)
120120

@@ -438,8 +438,7 @@ func remoteAnnexGet(gitdir string, getchan chan<- gingit.RepoFileStatus, rawMode
438438
err = json.Unmarshal(outline, &getresult)
439439
if err != nil || getresult.Command == "" {
440440
// Couldn't parse output
441-
log.ShowWrite("[Warning] Could not parse 'git annex get' output")
442-
log.ShowWrite(string(outline))
441+
log.ShowWrite("[Warning] Could not parse 'git annex get' output: %s", string(outline))
443442
// TODO: Print error at the end: Command succeeded but there was an error understanding the output
444443
continue
445444
}
@@ -490,7 +489,7 @@ func remoteCommitCheckout(gitdir, hash string) error {
490489
cmd.Args = cmdargs
491490
_, stderr, err := cmd.OutputError()
492491
if err != nil {
493-
log.ShowWrite("[Error] %s; %s", err.Error(), string(stderr))
492+
log.ShowWrite("[Error] err: %s; stderr: %s", err.Error(), string(stderr))
494493
return fmt.Errorf(string(stderr))
495494
}
496495
return nil

‎internal/web/hooks.go

+12-11
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ func EnableHook(w http.ResponseWriter, r *http.Request) {
2828
validator := strings.ToLower(vars["validator"])
2929
ut, err := getSessionOrRedirect(w, r)
3030
if err != nil {
31-
log.Write("[Info] %s: Redirecting to login", err.Error())
31+
log.ShowWrite("[Info] %s: redirecting to login", err.Error())
3232
return
3333
}
3434
if !helpers.SupportedValidator(validator) {
@@ -61,7 +61,7 @@ func DisableHook(w http.ResponseWriter, r *http.Request) {
6161

6262
ut, err := getSessionOrRedirect(w, r)
6363
if err != nil {
64-
log.Write("[Info] %s: Redirecting to login", err.Error())
64+
log.ShowWrite("[Info] %s: redirecting to login", err.Error())
6565
return
6666
}
6767

@@ -88,7 +88,7 @@ func createValidHook(repopath string, validator string, usertoken gweb.UserToken
8888
// TODO: AVOID DUPLICATES:
8989
// - If it's already hooked and we have it on record, do nothing
9090
// - If it's already hooked, but we don't know about it, check if it's valid and don't recreate
91-
log.Write("Adding %s hook to %s\n", validator, repopath)
91+
log.ShowWrite("[Info] adding %q hook to %q", validator, repopath)
9292

9393
cfg := config.Read()
9494
client := ginclient.New(serveralias)
@@ -98,7 +98,7 @@ func createValidHook(repopath string, validator string, usertoken gweb.UserToken
9898

9999
u, err := url.Parse(cfg.Settings.RootURL)
100100
if err != nil {
101-
log.Write("[error] failed to parse url: %s", err.Error())
101+
log.ShowWrite("[Error] failed to parse url: %s", err.Error())
102102
return fmt.Errorf("hook creation failed: %s", err.Error())
103103
}
104104
u.Path = path.Join(u.Path, "validate", validator, repopath)
@@ -113,13 +113,13 @@ func createValidHook(repopath string, validator string, usertoken gweb.UserToken
113113
}
114114
res, err := client.Post(fmt.Sprintf("/api/v1/repos/%s/hooks", repopath), data)
115115
if err != nil {
116-
log.Write("[error] failed to post: %s", err.Error())
116+
log.ShowWrite("[Error] failed to post: %s", err.Error())
117117
return fmt.Errorf("hook creation failed: %s", err.Error())
118118
}
119119
defer res.Body.Close()
120120

121121
if res.StatusCode != http.StatusCreated {
122-
log.Write("[error] non-OK response: %s", res.Status)
122+
log.ShowWrite("[Error] non-OK response: %s", res.Status)
123123
return fmt.Errorf("hook creation failed: %s", res.Status)
124124
}
125125

@@ -128,23 +128,24 @@ func createValidHook(repopath string, validator string, usertoken gweb.UserToken
128128
}
129129

130130
func deleteValidHook(repopath string, id int, usertoken gweb.UserToken) error {
131-
log.Write("Deleting %d from %s\n", id, repopath)
131+
log.ShowWrite("[Info] deleting hook %d from %q", id, repopath)
132132

133133
client := ginclient.New(serveralias)
134134
client.UserToken = usertoken
135135

136136
res, err := client.Delete(fmt.Sprintf("/api/v1/repos/%s/hooks/%d", repopath, id))
137137
if err != nil {
138-
log.Write("[error] bad response from server %s", err.Error())
138+
log.ShowWrite("[Error] bad response from server %s", err.Error())
139139
return err
140140
}
141141
defer res.Body.Close()
142-
log.Write("[info] removed hook for %s", repopath)
142+
log.ShowWrite("[Info] removed hook for %s", repopath)
143143

144-
log.Write("[info] removing repository -> token link")
144+
// TODO remove token link only if there are no other validator hooks for this repository left
145+
log.ShowWrite("[Info] removing repository -> token link")
145146
err = rmTokenRepoLink(repopath)
146147
if err != nil {
147-
log.Write("[error] failed to delete token link: %s", err.Error())
148+
log.ShowWrite("[Error] failed to delete token link: %s", err.Error())
148149
// don't fail
149150
}
150151

‎internal/web/results.go

+21-21
Original file line numberDiff line numberDiff line change
@@ -120,11 +120,11 @@ func Results(w http.ResponseWriter, r *http.Request) {
120120
repo := vars["repo"]
121121
validator := strings.ToLower(vars["validator"])
122122
if !helpers.SupportedValidator(validator) {
123-
log.ShowWrite("[Error] unsupported validator '%s'\n", validator)
123+
log.ShowWrite("[Error] unsupported validator '%s'", validator)
124124
http.ServeContent(w, r, "unavailable", time.Now(), bytes.NewReader([]byte("404 Nothing to see here...")))
125125
return
126126
}
127-
log.ShowWrite("[Info] '%s' results for repo '%s/%s'\n", validator, user, repo)
127+
log.ShowWrite("[Info] %q results for repo '%s/%s'", validator, user, repo)
128128

129129
srvcfg := config.Read()
130130
resID, ok := vars["id"]
@@ -143,7 +143,7 @@ func Results(w http.ResponseWriter, r *http.Request) {
143143
fp := filepath.Join(resdir, srvcfg.Label.ResultsBadge)
144144
badge, err := ioutil.ReadFile(fp)
145145
if err != nil {
146-
log.ShowWrite("[Error] serving '%s/%s' badge: %s\n", user, repo, err.Error())
146+
log.ShowWrite("[Error] serving '%s/%s' badge: %s", user, repo, err.Error())
147147
}
148148

149149
fp = filepath.Join(resdir, srvcfg.Label.ResultsFile)
@@ -176,13 +176,13 @@ func notValidatedYet(w http.ResponseWriter, r *http.Request, badge []byte, valid
176176
tmpl := template.New("layout")
177177
tmpl, err := tmpl.Parse(templates.Layout)
178178
if err != nil {
179-
log.ShowWrite("[Error] '%s/%s' result: %s\n", user, repo, err.Error())
179+
log.ShowWrite("[Error] '%s/%s' result: %s", user, repo, err.Error())
180180
http.ServeContent(w, r, "unavailable", time.Now(), bytes.NewReader([]byte("500 Something went wrong...")))
181181
return
182182
}
183183
tmpl, err = tmpl.Parse(templates.NotValidatedYet)
184184
if err != nil {
185-
log.ShowWrite("[Error] '%s/%s' result: %s\n", user, repo, err.Error())
185+
log.ShowWrite("[Error] '%s/%s' result: %s", user, repo, err.Error())
186186
http.ServeContent(w, r, "unavailable", time.Now(), bytes.NewReader([]byte("500 Something went wrong...")))
187187
return
188188
}
@@ -213,7 +213,7 @@ func notValidatedYet(w http.ResponseWriter, r *http.Request, badge []byte, valid
213213

214214
err = tmpl.ExecuteTemplate(w, "layout", info)
215215
if err != nil {
216-
log.ShowWrite("[Error] '%s/%s' result: %s\n", user, repo, err.Error())
216+
log.ShowWrite("[Error] '%s/%s' result: %s", user, repo, err.Error())
217217
http.ServeContent(w, r, "unavailable", time.Now(), bytes.NewReader([]byte("500 Something went wrong...")))
218218
return
219219
}
@@ -223,13 +223,13 @@ func renderInProgress(w http.ResponseWriter, r *http.Request, badge []byte, vali
223223
tmpl := template.New("layout")
224224
tmpl, err := tmpl.Parse(templates.Layout)
225225
if err != nil {
226-
log.ShowWrite("[Error] '%s/%s' result: %s\n", user, repo, err.Error())
226+
log.ShowWrite("[Error] '%s/%s' result: %s", user, repo, err.Error())
227227
http.ServeContent(w, r, "unavailable", time.Now(), bytes.NewReader([]byte("500 Something went wrong...")))
228228
return
229229
}
230230
tmpl, err = tmpl.Parse(templates.GenericResults)
231231
if err != nil {
232-
log.ShowWrite("[Error] '%s/%s' result: %s\n", user, repo, err.Error())
232+
log.ShowWrite("[Error] '%s/%s' result: %s", user, repo, err.Error())
233233
http.ServeContent(w, r, "unavailable", time.Now(), bytes.NewReader([]byte("500 Something went wrong...")))
234234
return
235235
}
@@ -252,7 +252,7 @@ func renderInProgress(w http.ResponseWriter, r *http.Request, badge []byte, vali
252252

253253
err = tmpl.ExecuteTemplate(w, "layout", info)
254254
if err != nil {
255-
log.ShowWrite("[Error] '%s/%s' result: %s\n", user, repo, err.Error())
255+
log.ShowWrite("[Error] '%s/%s' result: %s", user, repo, err.Error())
256256
http.ServeContent(w, r, "unavailable", time.Now(), bytes.NewReader([]byte("500 Something went wrong...")))
257257
return
258258
}
@@ -278,7 +278,7 @@ func resultsHistory(validator, user, repo string) ResultsHistoryStruct {
278278
resdir := filepath.Join(srvcfg.Dir.Result, validator, user, repo)
279279
fileinfos, err := myReadDir(resdir)
280280
if err != nil {
281-
log.ShowWrite("[Error] cannot retrieve results history '%s/%s' result: %s\n", user, repo, err.Error())
281+
log.ShowWrite("[Error] cannot retrieve results history '%s/%s' result: %s", user, repo, err.Error())
282282
return ret
283283
}
284284
for _, i := range fileinfos {
@@ -292,7 +292,7 @@ func resultsHistory(validator, user, repo string) ResultsHistoryStruct {
292292
var res Result
293293
res.Href = pth
294294
res.Alt = i.Name()
295-
res.Text1 = i.ModTime().Format("2006-01-02")
295+
res.Text1 = i.ModTime().UTC().Format("2006-01-02")
296296
res.Text2 = i.ModTime().Format("15:04:05")
297297
res.Badge = template.HTML(badge)
298298
ret.Results = append(ret.Results, res)
@@ -307,21 +307,21 @@ func renderBIDSResults(w http.ResponseWriter, r *http.Request, badge []byte, con
307307
err := json.Unmarshal(content, &resBIDS)
308308
errMsg := ""
309309
if err != nil {
310-
log.ShowWrite("[Error] unmarshalling '%s/%s' result: %s\n", user, repo, err.Error())
310+
log.ShowWrite("[Error] unmarshalling '%s/%s' result: %s", user, repo, err.Error())
311311
errMsg = "Could not validate format as BIDS."
312312
}
313313

314314
// Parse html template
315315
tmpl := template.New("layout")
316316
tmpl, err = tmpl.Parse(templates.Layout)
317317
if err != nil {
318-
log.ShowWrite("[Error] '%s/%s' result: %s\n", user, repo, err.Error())
318+
log.ShowWrite("[Error] '%s/%s' result: %s", user, repo, err.Error())
319319
http.ServeContent(w, r, "unavailable", time.Now(), bytes.NewReader([]byte("500 Something went wrong...")))
320320
return
321321
}
322322
tmpl, err = tmpl.Parse(templates.BidsResults)
323323
if err != nil {
324-
log.ShowWrite("[Error] '%s/%s' result: %s\n", user, repo, err.Error())
324+
log.ShowWrite("[Error] '%s/%s' result: %s", user, repo, err.Error())
325325
http.ServeContent(w, r, "unavailable", time.Now(), bytes.NewReader([]byte("500 Something went wrong...")))
326326
return
327327
}
@@ -345,7 +345,7 @@ func renderBIDSResults(w http.ResponseWriter, r *http.Request, badge []byte, con
345345

346346
err = tmpl.ExecuteTemplate(w, "layout", info)
347347
if err != nil {
348-
log.ShowWrite("[Error] '%s/%s' result: %s\n", user, repo, err.Error())
348+
log.ShowWrite("[Error] '%s/%s' result: %s", user, repo, err.Error())
349349
http.ServeContent(w, r, "unavailable", time.Now(), bytes.NewReader([]byte("500 Something went wrong...")))
350350
return
351351
}
@@ -357,13 +357,13 @@ func renderNIXResults(w http.ResponseWriter, r *http.Request, badge []byte, cont
357357
tmpl := template.New("layout")
358358
tmpl, err := tmpl.Parse(templates.Layout)
359359
if err != nil {
360-
log.ShowWrite("[Error] '%s/%s' result: %s\n", user, repo, err.Error())
360+
log.ShowWrite("[Error] '%s/%s' result: %s", user, repo, err.Error())
361361
http.ServeContent(w, r, "unavailable", time.Now(), bytes.NewReader([]byte("500 Something went wrong...")))
362362
return
363363
}
364364
tmpl, err = tmpl.Parse(templates.GenericResults)
365365
if err != nil {
366-
log.ShowWrite("[Error] '%s/%s' result: %s\n", user, repo, err.Error())
366+
log.ShowWrite("[Error] '%s/%s' result: %s", user, repo, err.Error())
367367
http.ServeContent(w, r, "unavailable", time.Now(), bytes.NewReader([]byte("500 Something went wrong...")))
368368
return
369369
}
@@ -386,7 +386,7 @@ func renderNIXResults(w http.ResponseWriter, r *http.Request, badge []byte, cont
386386

387387
err = tmpl.ExecuteTemplate(w, "layout", info)
388388
if err != nil {
389-
log.ShowWrite("[Error] '%s/%s' result: %s\n", user, repo, err.Error())
389+
log.ShowWrite("[Error] '%s/%s' result: %s", user, repo, err.Error())
390390
http.ServeContent(w, r, "unavailable", time.Now(), bytes.NewReader([]byte("500 Something went wrong...")))
391391
return
392392
}
@@ -398,13 +398,13 @@ func renderODMLResults(w http.ResponseWriter, r *http.Request, badge []byte, con
398398
tmpl := template.New("layout")
399399
tmpl, err := tmpl.Parse(templates.Layout)
400400
if err != nil {
401-
log.ShowWrite("[Error] '%s/%s' result: %s\n", user, repo, err.Error())
401+
log.ShowWrite("[Error] '%s/%s' result: %s", user, repo, err.Error())
402402
http.ServeContent(w, r, "unavailable", time.Now(), bytes.NewReader([]byte("500 Something went wrong...")))
403403
return
404404
}
405405
tmpl, err = tmpl.Parse(templates.GenericResults)
406406
if err != nil {
407-
log.ShowWrite("[Error] '%s/%s' result: %s\n", user, repo, err.Error())
407+
log.ShowWrite("[Error] '%s/%s' result: %s", user, repo, err.Error())
408408
http.ServeContent(w, r, "unavailable", time.Now(), bytes.NewReader([]byte("500 Something went wrong...")))
409409
return
410410
}
@@ -427,7 +427,7 @@ func renderODMLResults(w http.ResponseWriter, r *http.Request, badge []byte, con
427427

428428
err = tmpl.ExecuteTemplate(w, "layout", info)
429429
if err != nil {
430-
log.ShowWrite("[Error] '%s/%s' result: %s\n", user, repo, err.Error())
430+
log.ShowWrite("[Error] '%s/%s' result: %s", user, repo, err.Error())
431431
http.ServeContent(w, r, "unavailable", time.Now(), bytes.NewReader([]byte("500 Something went wrong...")))
432432
return
433433
}

‎internal/web/status.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -19,20 +19,20 @@ import (
1919
func Status(w http.ResponseWriter, r *http.Request) {
2020
validator := mux.Vars(r)["validator"]
2121
if !helpers.SupportedValidator(validator) {
22-
log.Write("[Error] unsupported validator '%s'\n", validator)
22+
log.ShowWrite("[Error] unsupported validator %q", validator)
2323
http.ServeContent(w, r, "unavailable", time.Now(), bytes.NewReader([]byte("404 Nothing to see here...")))
2424
return
2525
}
2626
user := mux.Vars(r)["user"]
2727
repo := mux.Vars(r)["repo"]
28-
log.Write("[Info] '%s' status for repo '%s/%s'\n", validator, user, repo)
28+
log.ShowWrite("[Info] %q status for repo '%s/%s'", validator, user, repo)
2929

3030
srvcfg := config.Read()
3131

3232
fp := filepath.Join(srvcfg.Dir.Result, "bids", user, repo, srvcfg.Label.ResultsFolder, srvcfg.Label.ResultsBadge)
3333
content, err := ioutil.ReadFile(fp)
3434
if err != nil {
35-
log.Write("[Error] serving '%s/%s' status: %s\n", user, repo, err.Error())
35+
log.ShowWrite("[Error] serving '%s/%s' status: %s", user, repo, err.Error())
3636
http.ServeContent(w, r, "unavailable.svg", time.Now(), bytes.NewReader([]byte(resources.UnavailableBadge)))
3737
return
3838
}

0 commit comments

Comments
 (0)