compose/pkg/progress/json.go

97 lines
2.1 KiB
Go
Raw Normal View History

/*
Copyright 2024 Docker Compose CLI authors
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package progress
import (
"context"
"encoding/json"
"fmt"
"io"
)
type jsonWriter struct {
out io.Writer
done chan bool
dryRun bool
}
type jsonMessage struct {
DryRun bool `json:"dry-run,omitempty"`
Tail bool `json:"tail,omitempty"`
ID string `json:"id,omitempty"`
ParentID string `json:"parent_id,omitempty"`
Text string `json:"text,omitempty"`
Status string `json:"status,omitempty"`
Current int64 `json:"current,omitempty"`
Total int64 `json:"total,omitempty"`
Percent int `json:"percent,omitempty"`
}
func (p *jsonWriter) Start(ctx context.Context) error {
select {
case <-ctx.Done():
return ctx.Err()
case <-p.done:
return nil
}
}
func (p *jsonWriter) Event(e Event) {
var message = &jsonMessage{
DryRun: p.dryRun,
Tail: false,
ID: e.ID,
Text: e.Text,
Status: e.StatusText,
ParentID: e.ParentID,
Current: e.Current,
Total: e.Total,
Percent: e.Percent,
}
marshal, err := json.Marshal(message)
if err == nil {
fix linting issues with golangci-lint 1.60.2 pkg/watch/watcher_darwin.go:96:16: Error return value of `d.stream.Start` is not checked (errcheck) d.stream.Start() ^ pkg/prompt/prompt.go:97:12: Error return value of `fmt.Fprint` is not checked (errcheck) fmt.Fprint(u.stdout, message) ^ pkg/prompt/prompt.go:99:12: Error return value of `fmt.Scanln` is not checked (errcheck) fmt.Scanln(&answer) ^ cmd/formatter/logs.go:118:15: Error return value of `fmt.Fprintf` is not checked (errcheck) fmt.Fprintf(w, "%s%s%s\n", p.prefix, timestamp, line) ^ cmd/formatter/logs.go:120:15: Error return value of `fmt.Fprintf` is not checked (errcheck) fmt.Fprintf(w, "%s%s\n", p.prefix, line) ^ pkg/progress/json.go:67:15: Error return value of `fmt.Fprintln` is not checked (errcheck) fmt.Fprintln(p.out, string(marshal)) ^ pkg/progress/json.go:87:15: Error return value of `fmt.Fprintln` is not checked (errcheck) fmt.Fprintln(p.out, string(marshal)) ^ pkg/progress/plain.go:47:14: Error return value of `fmt.Fprintln` is not checked (errcheck) fmt.Fprintln(p.out, prefix, e.ID, e.Text, e.StatusText) ^ pkg/progress/tty.go:162:12: Error return value of `fmt.Fprint` is not checked (errcheck) fmt.Fprint(w.out, b.Column(0).ANSI) ^ pkg/progress/tty.go:165:12: Error return value of `fmt.Fprint` is not checked (errcheck) fmt.Fprint(w.out, aec.Hide) ^ pkg/compose/attach.go:53:13: Error return value of `fmt.Fprintf` is not checked (errcheck) fmt.Fprintf(s.stdout(), "Attaching to %s\n", strings.Join(names, ", ")) ^ pkg/compose/compose.go:194:6: emptyStringTest: replace `len(dependencies) > 0` with `dependencies != ""` (gocritic) if len(dependencies) > 0 { ^ pkg/compose/convergence.go:461:2: builtinShadow: shadowing of predeclared identifier: max (gocritic) max := 0 ^ pkg/compose/run.go:127:5: emptyStringTest: replace `len(opts.User) > 0` with `opts.User != ""` (gocritic) if len(opts.User) > 0 { ^ pkg/compose/run.go:139:5: emptyStringTest: replace `len(opts.WorkingDir) > 0` with `opts.WorkingDir != ""` (gocritic) if len(opts.WorkingDir) > 0 { ^ pkg/compose/viz.go:91:8: emptyStringTest: replace `len(portConfig.HostIP) > 0` with `portConfig.HostIP != ""` (gocritic) if len(portConfig.HostIP) > 0 { ^ cmd/compatibility/convert.go:66:6: emptyStringTest: replace `len(arg) > 0` with `arg != ""` (gocritic) if len(arg) > 0 && arg[0] != '-' { ^ pkg/e2e/watch_test.go:208:25: printf: non-constant format string in call to gotest.tools/v3/poll.Continue (govet) return poll.Continue(res.Combined()) ^ pkg/e2e/watch_test.go:290:25: printf: non-constant format string in call to gotest.tools/v3/poll.Continue (govet) return poll.Continue(r.Combined()) ^ Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2024-09-11 12:52:55 +02:00
_, _ = fmt.Fprintln(p.out, string(marshal))
}
}
func (p *jsonWriter) Events(events []Event) {
for _, e := range events {
p.Event(e)
}
}
func (p *jsonWriter) TailMsgf(msg string, args ...interface{}) {
var message = &jsonMessage{
DryRun: p.dryRun,
Tail: true,
ID: "",
Text: fmt.Sprintf(msg, args...),
Status: "",
}
marshal, err := json.Marshal(message)
if err == nil {
fix linting issues with golangci-lint 1.60.2 pkg/watch/watcher_darwin.go:96:16: Error return value of `d.stream.Start` is not checked (errcheck) d.stream.Start() ^ pkg/prompt/prompt.go:97:12: Error return value of `fmt.Fprint` is not checked (errcheck) fmt.Fprint(u.stdout, message) ^ pkg/prompt/prompt.go:99:12: Error return value of `fmt.Scanln` is not checked (errcheck) fmt.Scanln(&answer) ^ cmd/formatter/logs.go:118:15: Error return value of `fmt.Fprintf` is not checked (errcheck) fmt.Fprintf(w, "%s%s%s\n", p.prefix, timestamp, line) ^ cmd/formatter/logs.go:120:15: Error return value of `fmt.Fprintf` is not checked (errcheck) fmt.Fprintf(w, "%s%s\n", p.prefix, line) ^ pkg/progress/json.go:67:15: Error return value of `fmt.Fprintln` is not checked (errcheck) fmt.Fprintln(p.out, string(marshal)) ^ pkg/progress/json.go:87:15: Error return value of `fmt.Fprintln` is not checked (errcheck) fmt.Fprintln(p.out, string(marshal)) ^ pkg/progress/plain.go:47:14: Error return value of `fmt.Fprintln` is not checked (errcheck) fmt.Fprintln(p.out, prefix, e.ID, e.Text, e.StatusText) ^ pkg/progress/tty.go:162:12: Error return value of `fmt.Fprint` is not checked (errcheck) fmt.Fprint(w.out, b.Column(0).ANSI) ^ pkg/progress/tty.go:165:12: Error return value of `fmt.Fprint` is not checked (errcheck) fmt.Fprint(w.out, aec.Hide) ^ pkg/compose/attach.go:53:13: Error return value of `fmt.Fprintf` is not checked (errcheck) fmt.Fprintf(s.stdout(), "Attaching to %s\n", strings.Join(names, ", ")) ^ pkg/compose/compose.go:194:6: emptyStringTest: replace `len(dependencies) > 0` with `dependencies != ""` (gocritic) if len(dependencies) > 0 { ^ pkg/compose/convergence.go:461:2: builtinShadow: shadowing of predeclared identifier: max (gocritic) max := 0 ^ pkg/compose/run.go:127:5: emptyStringTest: replace `len(opts.User) > 0` with `opts.User != ""` (gocritic) if len(opts.User) > 0 { ^ pkg/compose/run.go:139:5: emptyStringTest: replace `len(opts.WorkingDir) > 0` with `opts.WorkingDir != ""` (gocritic) if len(opts.WorkingDir) > 0 { ^ pkg/compose/viz.go:91:8: emptyStringTest: replace `len(portConfig.HostIP) > 0` with `portConfig.HostIP != ""` (gocritic) if len(portConfig.HostIP) > 0 { ^ cmd/compatibility/convert.go:66:6: emptyStringTest: replace `len(arg) > 0` with `arg != ""` (gocritic) if len(arg) > 0 && arg[0] != '-' { ^ pkg/e2e/watch_test.go:208:25: printf: non-constant format string in call to gotest.tools/v3/poll.Continue (govet) return poll.Continue(res.Combined()) ^ pkg/e2e/watch_test.go:290:25: printf: non-constant format string in call to gotest.tools/v3/poll.Continue (govet) return poll.Continue(r.Combined()) ^ Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
2024-09-11 12:52:55 +02:00
_, _ = fmt.Fprintln(p.out, string(marshal))
}
}
func (p *jsonWriter) Stop() {
p.done <- true
}
func (p *jsonWriter) HasMore(bool) {
}