Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion cmd/ci/ci.go
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ func (cmd *CICmd) execute(ctx context.Context, source string) (err error) {
// workspace.
ctx, cancel := up.WithSignals(ctx)
defer cancel()
reporter, err := newStatusReporter(os.Stderr, cmd.Verbosity > 0 || cmd.Debug)
reporter, err := newStatusReporter(os.Stderr, cmd.Verbosity > 0 || cmd.Debug, cmd.NoStatus)
if err != nil {
return err
}
Expand Down
3 changes: 2 additions & 1 deletion cmd/ci/status.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ import (
"github.com/devsy-org/devsy/pkg/status"
)

func newStatusReporter(out io.Writer, verbose bool) (status.Reporter, error) {
func newStatusReporter(out io.Writer, verbose bool, noStatus bool) (status.Reporter, error) {
return status.NewCLIReporter(status.CLIOptions{
Format: "plain",
Out: out,
Prefix: "ci",
Verbose: verbose,
NoStatus: noStatus,
Pipeline: status.PipelineWorkspaceUp,
Labels: map[status.Phase]string{
status.PhaseCloningRepository: "cloning repository",
Expand Down
16 changes: 15 additions & 1 deletion cmd/ci/status_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (

func TestStatusReporterUsesDeterministicASCIIOutput(t *testing.T) {
var out bytes.Buffer
reporter, err := newStatusReporter(&out, false)
reporter, err := newStatusReporter(&out, false, false)
if err != nil {
t.Fatalf("newStatusReporter: %v", err)
}
Expand All @@ -35,3 +35,17 @@ func TestStatusReporterUsesDeterministicASCIIOutput(t *testing.T) {
}
}
}

func TestStatusReporterNoStatus(t *testing.T) {
for _, verbose := range []bool{false, true} {
var out bytes.Buffer
reporter, err := newStatusReporter(&out, verbose, true)
if err != nil {
t.Fatal(err)
}
reporter.Report(status.Event{Phase: status.PhaseRunningCommand, State: status.StateStarted})
if out.Len() != 0 {
t.Fatalf("unexpected status: %q", out.String())
}
}
}
15 changes: 13 additions & 2 deletions cmd/config/apply.go
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,12 @@ func (cmd *ApplyCmd) Run(ctx context.Context) error {
return err
}
emitJSON := mode == output.ModeJSON
reporter, err := newStatusReporter(cmd.ResultFormat, os.Stdout, cmd.Verbosity > 0 || cmd.Debug)
reporter, err := newStatusReporter(
cmd.ResultFormat,
os.Stdout,
cmd.Verbosity > 0 || cmd.Debug,
cmd.NoStatus,
)
if err != nil {
return err
}
Expand Down Expand Up @@ -189,12 +194,18 @@ func (cmd *ApplyCmd) prepareContainer(
return containerDetails, result, nil
}

func newStatusReporter(resultFormat string, out io.Writer, verbose bool) (status.Reporter, error) {
func newStatusReporter(
resultFormat string,
out io.Writer,
verbose bool,
noStatus bool,
) (status.Reporter, error) {
return status.NewCLIReporter(status.CLIOptions{
Format: resultFormat,
Out: out,
Prefix: "config",
Verbose: verbose,
NoStatus: noStatus,
Pipeline: status.PipelineWorkspaceUp,
Labels: map[status.Phase]string{
status.PhaseResolvingConfig: "resolving devcontainer config",
Expand Down
14 changes: 13 additions & 1 deletion cmd/config/apply_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ func TestApplyCmd_ResolveDockerPath_Custom(t *testing.T) {

func TestApplyStatusReporterEmitsCurrentStatusEnvelope(t *testing.T) {
var out bytes.Buffer
reporter, err := newStatusReporter("json", &out, false)
reporter, err := newStatusReporter("json", &out, false, false)
require.NoError(t, err)
reporter.Report(status.Event{
Phase: status.PhaseReady,
Expand All @@ -111,3 +111,15 @@ func TestApplyStatusReporterEmitsCurrentStatusEnvelope(t *testing.T) {
assert.Equal(t, string(status.PipelineWorkspaceUp), envelope["pipeline"])
assert.Equal(t, string(status.StateSucceeded), envelope["state"])
}

func TestStatusReporterNoStatus(t *testing.T) {
for _, format := range []string{"plain", "json"} {
t.Run(format, func(t *testing.T) {
var out bytes.Buffer
reporter, err := newStatusReporter(format, &out, false, true)
require.NoError(t, err)
reporter.Report(status.Event{Phase: status.PhaseReady, State: status.StateSucceeded})
require.Empty(t, out.String())
})
}
}
36 changes: 35 additions & 1 deletion cmd/flag_aliases_test.go
Original file line number Diff line number Diff line change
@@ -1,14 +1,19 @@
package cmd

import (
"bytes"
"strings"
"testing"

"github.com/devsy-org/devsy/pkg/flags/names"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

const formatJSON = "json"
const (
formatJSON = "json"
flagHelp = "--help"
)

func TestGlobalFlags_LogFormatAlias(t *testing.T) {
rootCmd, globalFlags := BuildRoot()
Expand All @@ -18,6 +23,35 @@ func TestGlobalFlags_LogFormatAlias(t *testing.T) {
assert.Equal(t, formatJSON, globalFlags.LogOutput)
}

func TestGlobalFlags_NoStatus(t *testing.T) {
for _, tc := range []struct {
name string
args []string
want bool
}{
{name: "default", args: []string{"ci", flagHelp}},
{name: "before command", args: []string{"--no-status", "ci", flagHelp}, want: true},
{name: "after command", args: []string{"ci", "--no-status", flagHelp}, want: true},
{name: "explicit false", args: []string{"ci", "--no-status=false", flagHelp}},
} {
t.Run(tc.name, func(t *testing.T) {
rootCmd, globalFlags := BuildRoot()
var out bytes.Buffer
rootCmd.SetOut(&out)
rootCmd.SetErr(&out)
rootCmd.SetArgs(tc.args)
require.NoError(t, rootCmd.Execute())
assert.Equal(t, tc.want, globalFlags.NoStatus)
assert.Contains(t, out.String(), "--no-status")
assert.Contains(
t,
strings.Join(strings.Fields(out.String()), " "),
"Suppress live CLI progress messages; preserve results, errors, and recorded events",
)
})
}
}

func TestLogFormatAlias_IsHidden(t *testing.T) {
rootCmd, _ := BuildRoot()
f := rootCmd.PersistentFlags().Lookup(names.LogFormat)
Expand Down
5 changes: 5 additions & 0 deletions cmd/flags/flags.go
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ type GlobalFlags struct {
Verbosity int
Quiet bool
Debug bool
NoStatus bool
}

// SetGlobalFlags applies the global flags.
Expand Down Expand Up @@ -59,6 +60,10 @@ func registerCoreFlags(flags *flag.FlagSet, globalFlags *GlobalFlags) {
}

func registerOutputFlags(flags *flag.FlagSet, globalFlags *GlobalFlags) {
flags.BoolVar(
&globalFlags.NoStatus, names.NoStatus, false,
"Suppress live CLI progress messages; preserve results, errors, and recorded events",
Comment thread
skevetter marked this conversation as resolved.
Resolved
)
flags.StringVar(
&globalFlags.ResultFormat,
names.ResultFormat,
Expand Down
19 changes: 9 additions & 10 deletions cmd/internal/runusercommands.go
Original file line number Diff line number Diff line change
Expand Up @@ -77,13 +77,15 @@ func newLifecycleStatusReporter(
resultFormat string,
out *os.File,
verbose bool,
noStatus bool,
) (status.Reporter, error) {
reporter, err := status.NewReporter(status.ReporterOptions{
Format: resultFormat,
Out: out,
Prefix: "lifecycle",
Verbose: verbose,
SuppressFailureDetails: true,
return status.NewCLIReporter(status.CLIOptions{
Format: resultFormat,
Out: out,
Prefix: "lifecycle",
Verbose: verbose,
NoStatus: noStatus,
Pipeline: status.PipelineWorkspaceUp,
Labels: map[status.Phase]string{
status.PhaseRunningLifecycleHook: "running lifecycle hooks",
status.PhaseReady: "ready",
Expand All @@ -92,10 +94,6 @@ func newLifecycleStatusReporter(
return devcconfig.WriteStatusJSON(out, e)
},
})
if err != nil {
return nil, err
}
return status.ForPipeline(reporter, status.PipelineWorkspaceUp), nil
}

// Run executes the run-user-commands logic.
Expand All @@ -107,6 +105,7 @@ func (cmd *RunUserCommandsCmd) Run(ctx context.Context) error {
cmd.ResultFormat,
os.Stderr,
cmd.Verbosity > 0 || cmd.Debug,
cmd.NoStatus,
)
if err != nil {
return err
Expand Down
25 changes: 25 additions & 0 deletions cmd/internal/status_no_status_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
package cmdinternal

import (
"os"
"testing"

"github.com/devsy-org/devsy/pkg/status"
"github.com/stretchr/testify/require"
)

func TestLifecycleStatusReporterNoStatus(t *testing.T) {
for _, format := range []string{"plain", "json"} {
t.Run(format, func(t *testing.T) {
out, err := os.CreateTemp(t.TempDir(), "status")
require.NoError(t, err)
t.Cleanup(func() { _ = out.Close() })
reporter, err := newLifecycleStatusReporter(format, out, false, true)
require.NoError(t, err)
reporter.Report(status.Event{Phase: status.PhaseReady, State: status.StateSucceeded})
info, err := out.Stat()
require.NoError(t, err)
require.Zero(t, info.Size())
})
}
}
7 changes: 6 additions & 1 deletion cmd/provider/add.go
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,12 @@ func (cmd *AddCmd) Run(ctx context.Context, devsyConfig *config.Config, args []s
return err
}

reporter, err := newStatusReporter(cmd.ResultFormat, os.Stdout, cmd.Verbosity > 0 || cmd.Debug)
reporter, err := newStatusReporter(
cmd.ResultFormat,
os.Stdout,
cmd.Verbosity > 0 || cmd.Debug,
cmd.NoStatus,
)
if err != nil {
return err
}
Expand Down
1 change: 1 addition & 0 deletions cmd/provider/init.go
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@ func NewInitCmd(f *flags.GlobalFlags) *cobra.Command {
cmd.ResultFormat,
os.Stdout,
cmd.Verbosity > 0 || cmd.Debug,
cmd.NoStatus,
)
if err != nil {
return err
Expand Down
7 changes: 6 additions & 1 deletion cmd/provider/set_source.go
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,12 @@ func (cmd *SetSourceCmd) Run(ctx context.Context, devsyConfig *config.Config, ar
providerSource = args[1]
}

reporter, err := newStatusReporter(cmd.ResultFormat, os.Stdout, cmd.Verbosity > 0 || cmd.Debug)
reporter, err := newStatusReporter(
cmd.ResultFormat,
os.Stdout,
cmd.Verbosity > 0 || cmd.Debug,
cmd.NoStatus,
)
if err != nil {
return err
}
Expand Down
7 changes: 4 additions & 3 deletions cmd/provider/status.go
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,15 @@ import (
func newStatusReporter(
resultFormat string,
out io.Writer,
verbose ...bool,
verbose bool,
noStatus bool,
) (status.Reporter, error) {
showDurations := len(verbose) > 0 && verbose[0]
return status.NewCLIReporter(status.CLIOptions{
Format: resultFormat,
Out: out,
Prefix: "provider",
Verbose: showDurations,
Verbose: verbose,
NoStatus: noStatus,
Pipeline: status.PipelineProvider,
Labels: phaseLabels,
Envelope: func(e status.Event) error {
Expand Down
21 changes: 21 additions & 0 deletions cmd/provider/status_no_status_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
package provider

import (
"bytes"
"testing"

"github.com/devsy-org/devsy/pkg/status"
"github.com/stretchr/testify/require"
)

func TestStatusReporterNoStatus(t *testing.T) {
for _, format := range []string{"plain", "json"} {
t.Run(format, func(t *testing.T) {
var out bytes.Buffer
reporter, err := newStatusReporter(format, &out, false, true)
require.NoError(t, err)
reporter.Report(status.Event{Phase: status.PhaseReady, State: status.StateSucceeded})
require.Empty(t, out.String())
})
}
}
1 change: 1 addition & 0 deletions cmd/workspace/build.go
Original file line number Diff line number Diff line change
Expand Up @@ -257,6 +257,7 @@ func (cmd *BuildCmd) build(
cmd.ResultFormat,
os.Stdout,
cmd.Verbosity > 0 || cmd.Debug,
cmd.NoStatus,
)
if err != nil {
return err
Expand Down
1 change: 1 addition & 0 deletions cmd/workspace/delete.go
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ func (cmd *DeleteCmd) Run(cobraCmd *cobra.Command, args []string) error {
cmd.ResultFormat,
os.Stdout,
cmd.Verbosity > 0 || cmd.Debug,
cmd.NoStatus,
)
if err != nil {
return err
Expand Down
4 changes: 2 additions & 2 deletions cmd/workspace/delete_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ func TestDeleteCmd_DeleteResolvedJournalsUnderSelectedWorkspace(t *testing.T) {
DefaultContext: testContext,
Contexts: map[string]*config.ContextConfig{testContext: {}},
}
reporter, err := newWorkspaceStatusReporter(formatPlain, os.Stdout, false)
reporter, err := newWorkspaceStatusReporter(formatPlain, os.Stdout, false, false)
require.NoError(t, err)

captureStdout(t, func() {
Expand Down Expand Up @@ -166,7 +166,7 @@ func TestDeleteCmd_DeleteMultipleReusesResolvedClients(t *testing.T) {
DefaultContext: testContext,
Contexts: map[string]*config.ContextConfig{testContext: {}},
}
reporter, err := newWorkspaceStatusReporter(formatPlain, os.Stdout, false)
reporter, err := newWorkspaceStatusReporter(formatPlain, os.Stdout, false, false)
require.NoError(t, err)

targets := map[string]resolvedDeleteTarget{
Expand Down
1 change: 1 addition & 0 deletions cmd/workspace/exec.go
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,7 @@ func (cmd *ExecCmd) Run(ctx context.Context, args []string) error {
cmd.ResultFormat,
os.Stderr,
cmd.Verbosity > 0 || cmd.Debug,
cmd.NoStatus,
)
if err != nil {
return err
Expand Down
1 change: 1 addition & 0 deletions cmd/workspace/import.go
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,7 @@ func (cmd *ImportCmd) execute(ctx context.Context) error {
cmd.ResultFormat,
os.Stdout,
cmd.Verbosity > 0 || cmd.Debug,
cmd.NoStatus,
)
if err != nil {
return err
Expand Down
Loading
Loading