Skip to content

chore: Refactor output method #564

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
lourens-octopus merged 1 commit into from
Nov 11, 2025
Merged

chore: Refactor output method #564

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
46 changes: 1 addition & 45 deletions pkg/cmd/ephemeralenvironment/deprovision-environment/deprovision_environment.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,13 @@
package deprovision_environment

import (
"encoding/json"
"fmt"

"github.com/MakeNowJust/heredoc/v2"
"github.com/OctopusDeploy/cli/pkg/cmd"
"github.com/OctopusDeploy/cli/pkg/cmd/ephemeralenvironment/util"
"github.com/OctopusDeploy/cli/pkg/constants"
"github.com/OctopusDeploy/cli/pkg/factory"
"github.com/OctopusDeploy/cli/pkg/output"
"github.com/OctopusDeploy/cli/pkg/question/selectors"
"github.com/OctopusDeploy/cli/pkg/util/flag"
"github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/environments/v2/ephemeralenvironments"
Expand Down Expand Up @@ -107,53 +105,11 @@ func DeprovisionEnvironmentRun(deprovisionEnvironmentOptions *DeprovisionEnviron
return err
}

outputResult(deprovisionEnvironmentOptions, command, response)
util.OutPutDeprovisionResult(deprovisionEnvironmentOptions.Name.Value, command, response.DeprovisioningRuns)

return nil
}

func outputResult(deprovisionEnvironmentOptions *DeprovisionEnvironmentOptions, command *cobra.Command, response *ephemeralenvironments.DeprovisionEphemeralEnvironmentResponse) {
command.Println("Deprovisioning environment: " + deprovisionEnvironmentOptions.Name.Value)

outputFormat, err := command.Flags().GetString(constants.FlagOutputFormat)
if err != nil { // should never happen, but fallback if it does
outputFormat = constants.OutputFormatTable
}

switch outputFormat {
case constants.OutputFormatBasic:
if response.DeprovisioningRuns == nil || len(response.DeprovisioningRuns) == 0 {
command.Println("Environment deprovisioned without running a runbook.")
} else {
for _, run := range response.DeprovisioningRuns {
command.Printf("Runbook Run ID: %s \nServer Task ID %s \n", run.RunbookRunID, run.TaskId)
}
}
case constants.OutputFormatJson:
data, err := json.Marshal(response.DeprovisioningRuns)
if err != nil { // shouldn't happen but fallback in case
command.PrintErrln(err)
} else {
_, _ = command.OutOrStdout().Write(data)
command.Println()
}
default: // table
if response.DeprovisioningRuns == nil || len(response.DeprovisioningRuns) == 0 {
command.Println("Environment deprovisioned without running a runbook.")
} else {
t := output.NewTable(command.OutOrStdout())
t.AddRow(output.Bold("Runbook Run ID"), output.Bold("Server Task ID"))
for _, run := range response.DeprovisioningRuns {
t.AddRow(run.RunbookRunID, run.TaskId)
}
err := t.Print()
if err != nil {
command.PrintErrln(err)
}
}
}
}

func deprovisionEnvironment(deprovisionEnvironmentOptions *DeprovisionEnvironmentOptions, environment *ephemeralenvironments.EphemeralEnvironment) (*ephemeralenvironments.DeprovisionEphemeralEnvironmentResponse, error) {
response, err := ephemeralenvironments.Deprovision(deprovisionEnvironmentOptions.Client, deprovisionEnvironmentOptions.Space.ID, environment.ID)

Expand Down
50 changes: 50 additions & 0 deletions pkg/cmd/ephemeralenvironment/util/util.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
package util

import (
"encoding/json"
"fmt"
"strings"

"github.com/OctopusDeploy/cli/pkg/constants"
"github.com/OctopusDeploy/cli/pkg/output"
"github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/client"
"github.com/OctopusDeploy/go-octopusdeploy/v2/pkg/environments/v2/ephemeralenvironments"
"github.com/spf13/cobra"
)

func GetByName(client *client.Client, name string, spaceID string) (*ephemeralenvironments.EphemeralEnvironment, error) {
Expand Down Expand Up @@ -35,3 +39,49 @@ func GetByName(client *client.Client, name string, spaceID string) (*ephemeralen
return nil, fmt.Errorf("could not find an exact match of an ephemeral environment with the name '%s'. Please specify a more specific name", name)
}
}

func OutPutDeprovisionResult(environmentName string, command *cobra.Command, deprovisioningRuns []ephemeralenvironments.DeprovisioningRunbookRun) {
command.Println("Deprovisioning environment: " + environmentName)

outputFormat, err := command.Flags().GetString(constants.FlagOutputFormat)
if err != nil {
outputFormat = constants.OutputFormatTable
}

if deprovisioningRuns == nil {
deprovisioningRuns = []ephemeralenvironments.DeprovisioningRunbookRun{}
}

switch outputFormat {
case constants.OutputFormatBasic:
if len(deprovisioningRuns) == 0 {
command.Println("Environment deprovisioned without running a runbook.")
} else {
for _, run := range deprovisioningRuns {
command.Printf("Runbook Run ID: %s \nServer Task ID %s \n", run.RunbookRunID, run.TaskId)
}
}
case constants.OutputFormatJson:
data, err := json.Marshal(deprovisioningRuns)
if err != nil {
command.PrintErrln(err)
} else {
_, _ = command.OutOrStdout().Write(data)
command.Println()
}
default:
if len(deprovisioningRuns) == 0 {
command.Println("Environment deprovisioned without running a runbook.")
} else {
t := output.NewTable(command.OutOrStdout())
t.AddRow(output.Bold("Runbook Run ID"), output.Bold("Server Task ID"))
for _, run := range deprovisioningRuns {
t.AddRow(run.RunbookRunID, run.TaskId)
}
err := t.Print()
if err != nil {
command.PrintErrln(err)
}
}
}
}