Skip to content

feat(cli): add json output to coder speedtest #13475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Jun 5, 2024
Merged

feat(cli): add json output to coder speedtest #13475

Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
362811b
impl'd speedtest json output
ethanndickson Jun 3, 2024
858e15c
added separator back to table output
ethanndickson Jun 4, 2024
9a195f7
.
ethanndickson Jun 4, 2024
ff91d68
WIP
ethanndickson Jun 4, 2024
db700cb
WIP
ethanndickson Jun 4, 2024
5de0f3b
WIP
ethanndickson Jun 4, 2024
2a1eebe
WIP
ethanndickson Jun 5, 2024
a93efdb
WIP
ethanndickson Jun 5, 2024
ed03cec
WIP
ethanndickson Jun 5, 2024
f3cc1ea
WIP
ethanndickson Jun 5, 2024
fa5e1c0
WIP
ethanndickson Jun 5, 2024
451180c
WIP
ethanndickson Jun 5, 2024
1c4378e
WIP
ethanndickson Jun 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
WIP
  • Loading branch information
@ethanndickson
ethanndickson committed Jun 5, 2024
commit ed03cec24c1a5c00711d809ef3b2aafc444af298
59 changes: 20 additions & 39 deletions cli/speedtest.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,6 @@ import (
"github.com/coder/serpent"
)

// clui will either format this as json,
// or our speedtestTableFormatter will format this as a table
type speedtestResult struct {
Overall speedtestResultInterval `json:"overall"`
Intervals []speedtestResultInterval `json:"intervals"`
Expand All @@ -36,50 +34,33 @@ type speedtestTableItem struct {
Throughput string `table:"Throughput"`
}

// Attaches a CLI arg with table output
type speedtestTableFormatter struct {
tableFormatter cliui.OutputFormat
}

var _ cliui.OutputFormat = &speedtestTableFormatter{}

func (*speedtestTableFormatter) ID() string {
return "table"
}

func (f *speedtestTableFormatter) AttachOptions(opts *serpent.OptionSet) {
f.tableFormatter = cliui.TableFormat([]speedtestTableItem{}, []string{"Interval", "Throughput"})
f.tableFormatter.AttachOptions(opts)
}

func (f *speedtestTableFormatter) Format(ctx context.Context, data any) (string, error) {
res, ok := data.(speedtestResult)
if !ok {
panic("attempted speedtest table format with an invalid result")
}
tableRows := make([]any, len(res.Intervals)+2)
for i, r := range res.Intervals {
tableRows[i] = speedtestTableItem{
Interval: fmt.Sprintf("%.2f-%.2f sec", r.StartTimeSeconds, r.EndTimeSeconds),
Throughput: fmt.Sprintf("%.4f Mbits/sec", r.ThroughputMbits),
}
}
tableRows[len(res.Intervals)] = cliui.TableSeparator{}
tableRows[len(res.Intervals)+1] = speedtestTableItem{
Interval: "Total",
Throughput: fmt.Sprintf("%.4f Mbits/sec", res.Overall.ThroughputMbits),
}
return f.tableFormatter.Format(ctx, tableRows)
}

func (r *RootCmd) speedtest() *serpent.Command {
var (
direct bool
duration time.Duration
direction string
pcapFile string
formatter = cliui.NewOutputFormatter(
&speedtestTableFormatter{},
cliui.ChangeFormatterData(cliui.TableFormat([]speedtestTableItem{}, []string{"Interval", "Throughput"}), func(data any) (any, error) {
res, ok := data.(speedtestResult)
if !ok {
// This should never happen
return "", xerrors.Errorf("expected speedtestResult, got %T", data)
}
tableRows := make([]any, len(res.Intervals)+2)
for i, r := range res.Intervals {
tableRows[i] = speedtestTableItem{
Interval: fmt.Sprintf("%.2f-%.2f sec", r.StartTimeSeconds, r.EndTimeSeconds),
Throughput: fmt.Sprintf("%.4f Mbits/sec", r.ThroughputMbits),
}
}
tableRows[len(res.Intervals)] = cliui.TableSeparator{}
tableRows[len(res.Intervals)+1] = speedtestTableItem{
Interval: "Total",
Throughput: fmt.Sprintf("%.4f Mbits/sec", res.Overall.ThroughputMbits),
}
return tableRows, nil
}),
cliui.JSONFormat(),
)
)
Expand Down