Skip to content

Use 'failed to' prefix for top-level CLI error messages #114

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
sgopinath1 merged 1 commit into from
Apr 14, 2026
Merged

Use 'failed to' prefix for top-level CLI error messages #114

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
6 changes: 3 additions & 3 deletions cmd/amd-ctk/cdi/generate/generate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,19 +72,19 @@ func validateGenOptions(c *cli.Context, genOptions *generateOptions) error {
func performAction(c *cli.Context, genOptions *generateOptions) error {
cdi, err := cdi.New(genOptions.output)
if err != nil {
return fmt.Errorf("creating CDI handler: %w", err)
return fmt.Errorf("failed to create CDI handler: %w", err)
}

// Generate CDI spec
err = cdi.GenerateSpec()
if err != nil {
return fmt.Errorf("generating CDI spec: %w", err)
return fmt.Errorf("failed to generate CDI spec: %w", err)
}

// Write updated CDI spec
err = cdi.WriteSpec()
if err != nil {
return fmt.Errorf("writing CDI spec: %w", err)
return fmt.Errorf("failed to write CDI spec: %w", err)
}

fmt.Printf("Generated CDI spec: %v\n", genOptions.output)
Expand Down
4 changes: 2 additions & 2 deletions cmd/amd-ctk/cdi/validate/validate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,14 +72,14 @@ func validateValOptions(c *cli.Context, valOptions *validateOptions) error {
func performAction(c *cli.Context, valOptions *validateOptions) error {
cdi, err := cdi.New(valOptions.cdiSpecPath)
if err != nil {
return fmt.Errorf("creating CDI handler: %w", err)
return fmt.Errorf("failed to create CDI handler: %w", err)
}

// Validate CDI spec
fmt.Printf("Validating CDI spec: %v\n", valOptions.cdiSpecPath)
result, err := cdi.ValidateSpec()
if err != nil {
return fmt.Errorf("validating CDI spec: %w", err)
return fmt.Errorf("failed to validate CDI spec: %w", err)
}
if result {
fmt.Println("CDI spec is valid")
Expand Down
6 changes: 3 additions & 3 deletions cmd/amd-ctk/gpu-tracker/disable/disable.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,12 @@ func validateGenOptions(c *cli.Context) error {
func performAction(c *cli.Context) error {
gpuTracker, err := gpuTracker.New()
if err != nil {
return fmt.Errorf("creating GPU tracker: %w", err)
return fmt.Errorf("failed to create GPU Tracker: %w", err)
}

enabled, err := gpuTracker.IsEnabled()
if err != nil {
return fmt.Errorf("checking GPU Tracker status: %w", err)
return fmt.Errorf("failed to check GPU Tracker status: %w", err)
}
if !enabled {
fmt.Println("GPU Tracker is already disabled")
Expand All @@ -67,7 +67,7 @@ func performAction(c *cli.Context) error {

err = gpuTracker.Disable()
if err != nil {
return fmt.Errorf("disabling GPU Tracker: %w", err)
return fmt.Errorf("failed to disable GPU Tracker: %w", err)
}

fmt.Println("GPU Tracker has been disabled")
Expand Down
6 changes: 3 additions & 3 deletions cmd/amd-ctk/gpu-tracker/enable/enable.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,12 @@ func validateGenOptions(c *cli.Context) error {
func performAction(c *cli.Context) error {
gpuTracker, err := gpuTracker.New()
if err != nil {
return fmt.Errorf("creating GPU tracker: %w", err)
return fmt.Errorf("failed to create GPU Tracker: %w", err)
}

enabled, err := gpuTracker.IsEnabled()
if err != nil {
return fmt.Errorf("checking GPU Tracker status: %w", err)
return fmt.Errorf("failed to check GPU Tracker status: %w", err)
}
if enabled {
fmt.Println("GPU Tracker is already enabled")
Expand All @@ -67,7 +67,7 @@ func performAction(c *cli.Context) error {

err = gpuTracker.Enable()
if err != nil {
return fmt.Errorf("enabling GPU Tracker: %w", err)
return fmt.Errorf("failed to enable GPU Tracker: %w", err)
}

fmt.Println("GPU Tracker has been enabled")
Expand Down
8 changes: 4 additions & 4 deletions cmd/amd-ctk/gpu-tracker/gpu-tracker.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,12 +91,12 @@ func performAction(c *cli.Context) error {

gpuTracker, err := gpuTrackerLib.New()
if err != nil {
return fmt.Errorf("creating GPU tracker: %w", err)
return fmt.Errorf("failed to create GPU Tracker: %w", err)
}

enabled, err := gpuTracker.IsEnabled()
if err != nil {
return fmt.Errorf("checking GPU Tracker status: %w", err)
return fmt.Errorf("failed to check GPU Tracker status: %w", err)
}
if !enabled {
fmt.Println("GPU Tracker is disabled")
Expand All @@ -108,7 +108,7 @@ func performAction(c *cli.Context) error {
case "exclusive":
res, err = gpuTracker.MakeGPUsExclusive(gpuIDs)
if err != nil {
return fmt.Errorf("making GPUs %s exclusive: %w", gpuIDs, err)
return fmt.Errorf("failed to make GPUs %s exclusive: %w", gpuIDs, err)
}
if len(res.Changed) > 0 {
fmt.Printf("GPUs %v have been made exclusive\n", res.Changed)
Expand All @@ -119,7 +119,7 @@ func performAction(c *cli.Context) error {
case "shared":
res, err = gpuTracker.MakeGPUsShared(gpuIDs)
if err != nil {
return fmt.Errorf("making GPUs %s shared: %w", gpuIDs, err)
return fmt.Errorf("failed to make GPUs %s shared: %w", gpuIDs, err)
}
if len(res.Changed) > 0 {
fmt.Printf("GPUs %v have been made shared\n", res.Changed)
Expand Down
4 changes: 2 additions & 2 deletions cmd/amd-ctk/gpu-tracker/initialize/initialize.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,12 @@ func validateGenOptions(c *cli.Context) error {
func performAction(c *cli.Context) error {
gpuTracker, err := gpuTracker.New()
if err != nil {
return fmt.Errorf("creating GPU tracker: %w", err)
return fmt.Errorf("failed to create GPU Tracker: %w", err)
}

err = gpuTracker.Init()
if err != nil {
return fmt.Errorf("initializing GPU Tracker: %w", err)
return fmt.Errorf("failed to initialize GPU Tracker: %w", err)
}

return nil
Expand Down
4 changes: 2 additions & 2 deletions cmd/amd-ctk/gpu-tracker/release/release.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,13 @@ func performAction(c *cli.Context) error {

gpuTracker, err := gpuTracker.New()
if err != nil {
return fmt.Errorf("creating GPU tracker: %w", err)
return fmt.Errorf("failed to create GPU Tracker: %w", err)
}

containerId := c.Args().Get(0)
err = gpuTracker.ReleaseGPUs(containerId)
if err != nil {
return fmt.Errorf("releasing GPUs for container %s: %w", containerId, err)
return fmt.Errorf("failed to release GPUs for container %s: %w", containerId, err)
}

return nil
Expand Down
6 changes: 3 additions & 3 deletions cmd/amd-ctk/gpu-tracker/reset/reset.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,17 +53,17 @@ func validateGenOptions(c *cli.Context) error {
func performAction(c *cli.Context) error {
gpuTracker, err := gpuTracker.New()
if err != nil {
return fmt.Errorf("creating GPU tracker: %w", err)
return fmt.Errorf("failed to create GPU Tracker: %w", err)
}

wasEnabled, err := gpuTracker.IsEnabled()
if err != nil {
return fmt.Errorf("checking GPU Tracker status: %w", err)
return fmt.Errorf("failed to check GPU Tracker status: %w", err)
}

err = gpuTracker.Reset()
if err != nil {
return fmt.Errorf("resetting GPU Tracker: %w", err)
return fmt.Errorf("failed to reset GPU Tracker: %w", err)
}

fmt.Println("GPU Tracker has been reset")
Expand Down
6 changes: 3 additions & 3 deletions cmd/amd-ctk/gpu-tracker/status/status.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,12 @@ func validateGenOptions(c *cli.Context) error {
func performAction(c *cli.Context) error {
tracker, err := gpuTracker.New()
if err != nil {
return fmt.Errorf("creating GPU tracker: %w", err)
return fmt.Errorf("failed to create GPU Tracker: %w", err)
}

enabled, err := tracker.IsEnabled()
if err != nil {
return fmt.Errorf("checking GPU Tracker status: %w", err)
return fmt.Errorf("failed to check GPU Tracker status: %w", err)
}
if !enabled {
fmt.Println("GPU Tracker is disabled")
Expand All @@ -68,7 +68,7 @@ func performAction(c *cli.Context) error {

entries, err := tracker.ShowStatus()
if err != nil {
return fmt.Errorf("showing GPU status: %w", err)
return fmt.Errorf("failed to show GPU Tracker status: %w", err)
}

fmt.Println(strings.Repeat("-", 120))
Expand Down
Loading