Skip to content
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

feat: ensure errors are logged using slog #384

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: ensure errors are logged using slog #384

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
8 changes: 4 additions & 4 deletions cmd/container/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,10 @@ import (
"os"
"path/filepath"

"github.com/spf13/cobra"

"github.com/controlplaneio/simulator/v2/core/tools"
"github.com/controlplaneio/simulator/v2/internal/cli"
"github.com/controlplaneio/simulator/v2/internal/config"
"github.com/controlplaneio/simulator/v2/internal/logging"
)

func main() {
Expand Down Expand Up @@ -75,6 +74,7 @@ func main() {
),
)

err := simulator.Execute()
cobra.CheckErr(err)
if err := simulator.Execute(); err != nil {
logging.LogFatal("Simulator CLI returned an error", err)
}
}
8 changes: 4 additions & 4 deletions cmd/simulator/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,12 @@ import (
"os"
"path/filepath"

"github.com/spf13/cobra"

"github.com/controlplaneio/simulator/v2/core/aws"
"github.com/controlplaneio/simulator/v2/core/tools"
"github.com/controlplaneio/simulator/v2/internal/cli"
"github.com/controlplaneio/simulator/v2/internal/config"
"github.com/controlplaneio/simulator/v2/internal/docker"
"github.com/controlplaneio/simulator/v2/internal/logging"
)

const (
Expand Down Expand Up @@ -167,8 +166,9 @@ func main() {
}),
)

err = simulator.Execute()
cobra.CheckErr(err)
if err := simulator.Execute(); err != nil {
logging.LogFatal("Simulator CLI returned an error", err)
}
}

func mkDirsIfNotExist(dirs ...string) {
Expand Down
33 changes: 18 additions & 15 deletions internal/cli/ami.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package cli

import (
"context"
"fmt"
"os"
"os/signal"
"syscall"
Expand Down Expand Up @@ -32,11 +33,13 @@ func WithAMIListCmd(manager aws.AMIManager) SimulatorCmdOptions {
amiListCmd := &cobra.Command{
Use: "list",
Short: "List simulator AMIs",
Run: func(cmd *cobra.Command, args []string) {
RunE: func(_ *cobra.Command, _ []string) error {
ctx := context.Background()

amis, err := manager.List(ctx)
cobra.CheckErr(err)
if err != nil {
return fmt.Errorf("unable to list simulator AMIs: %w", err)
}

table := tablewriter.NewWriter(os.Stdout)

Expand Down Expand Up @@ -64,6 +67,7 @@ func WithAMIListCmd(manager aws.AMIManager) SimulatorCmdOptions {
table.SetRowLine(true)
}
table.Render()
return nil
},
}

Expand All @@ -77,12 +81,15 @@ func WithAMIDeleteCmd(manager aws.AMIManager) SimulatorCmdOptions {
Use: "delete [ami id]",
Short: "Delete a simulator AMI",
Args: cobra.MinimumNArgs(1),
Run: func(cmd *cobra.Command, args []string) {
RunE: func(_ *cobra.Command, args []string) error {
ctx := context.Background()
id := args[0]

err := manager.Delete(ctx, id)
cobra.CheckErr(err)
if err != nil {
return fmt.Errorf("unable to delete simulator AMI: %w", err)
}
return nil
},
}

Expand All @@ -98,20 +105,16 @@ func WithAmiBuildCmd(builder tools.AMIBuilder) SimulatorCmdOptions {
Use: "build [name]",
Short: "Build the packer image",
Args: cobra.MinimumNArgs(1),
Run: func(cmd *cobra.Command, args []string) {
RunE: func(_ *cobra.Command, args []string) error {
ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
defer stop()

var err error
id := args[0]

// go func() {
err = builder.Build(ctx, id)
// }()
//
// <-ctx.Done() //TODO: Check out quitting
stop()

cobra.CheckErr(err)
err := builder.Build(ctx, id)
if err != nil {
return fmt.Errorf("unable to build packer image: %w", err)
}
return nil
},
}

Expand Down
15 changes: 11 additions & 4 deletions internal/cli/bucket.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package cli

import (
"context"
"fmt"
"log/slog"
"os"

Expand Down Expand Up @@ -29,7 +30,7 @@ func WithBucketCmd(opts ...SimulatorCmdOptions) SimulatorCmdOptions {
func WithCreateBucketCmd(config config.Config, manager aws.BucketManager) SimulatorCmdOptions {
bucketCreateCommand := &cobra.Command{
Use: "create",
Run: func(cmd *cobra.Command, args []string) {
RunE: func(_ *cobra.Command, _ []string) error {
ctx := context.Background()

if config.Bucket == "" {
Expand All @@ -38,7 +39,10 @@ func WithCreateBucketCmd(config config.Config, manager aws.BucketManager) Simula
}

err := manager.Create(ctx, config.Bucket)
cobra.CheckErr(err)
if err != nil {
return fmt.Errorf("unable to create bucket: %w", err)
}
return nil
},
}

Expand All @@ -50,11 +54,14 @@ func WithCreateBucketCmd(config config.Config, manager aws.BucketManager) Simula
func WithDeleteBucketCmd(config config.Config, manager aws.BucketManager) SimulatorCmdOptions {
bucketCreateCommand := &cobra.Command{
Use: "delete",
Run: func(cmd *cobra.Command, args []string) {
RunE: func(_ *cobra.Command, _ []string) error {
ctx := context.Background()

err := manager.Delete(ctx, config.Bucket)
cobra.CheckErr(err)
if err != nil {
return fmt.Errorf("unable to delete bucket: %w", err)
}
return nil
},
}

Expand Down
18 changes: 13 additions & 5 deletions internal/cli/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,16 @@ func WithConfigCmd(conf config.Config) SimulatorCmdOptions {
configCmd.PersistentFlags().BoolVar(&dev, "dev", false, "developer mode")
configCmd.PersistentFlags().BoolVar(&rootless, "rootless", false, "docker running in rootless mode")

configCmd.Run = func(_ *cobra.Command, _ []string) {
configCmd.RunE = func(_ *cobra.Command, _ []string) error {
if printDir {
dir, err := config.SimulatorDir()
cobra.CheckErr(err)
if err != nil {
return fmt.Errorf("unable to get simulator config directory: %w", err)
}

//nolint: forbidigo
fmt.Println(dir)
return
return nil
}

if name != "" {
Expand All @@ -46,7 +49,9 @@ func WithConfigCmd(conf config.Config) SimulatorCmdOptions {
conf.Container.Image = "controlplane/simulator:dev"

baseDir, err := os.Getwd()
cobra.CheckErr(err)
if err != nil {
return fmt.Errorf("unable to current working directory: %w", err)
}

conf.BaseDir = baseDir
} else {
Expand All @@ -58,7 +63,10 @@ func WithConfigCmd(conf config.Config) SimulatorCmdOptions {
conf.Container.Rootless = rootless

err := conf.Write()
cobra.CheckErr(err)
if err != nil {
return fmt.Errorf("unable to write simulator config to disk: %w", err)
}
return nil
}

return func(command *cobra.Command) {
Expand Down
8 changes: 6 additions & 2 deletions internal/cli/container.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package cli

import (
"context"
"fmt"

"github.com/spf13/cobra"

Expand All @@ -28,10 +29,13 @@ func WithContainerPullCmd(config config.Config, client *docker.Client) Simulator
imagePullCmd := &cobra.Command{
Use: "pull",
Short: "Pull the Simulator Container Image",
Run: func(cmd *cobra.Command, args []string) {
RunE: func(_ *cobra.Command, _ []string) error {
ctx := context.Background()
err := client.PullImage(ctx, config.Container.Image)
cobra.CheckErr(err)
if err != nil {
return fmt.Errorf("unable to pull simulator container image: %w", err)
}
return nil
},
}

Expand Down
48 changes: 35 additions & 13 deletions internal/cli/infra.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ package cli

import (
"context"
"fmt"
"os"
"os/signal"
"syscall"
Expand Down Expand Up @@ -30,13 +31,20 @@ func WithInfraCreateCmd(manager tools.InfraManager, opts ...SimulatorCmdOptions)
infraCreateCmd := &cobra.Command{
Use: "create",
Short: "Create simulator infrastructure",
Run: func(cmd *cobra.Command, args []string) {
RunE: func(cmd *cobra.Command, _ []string) error {
ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
defer stop()

stateBucket, stateKey, name := getTerraformFlags(cmd)
err := manager.Create(ctx, stateBucket, stateKey, name)
cobra.CheckErr(err)
stateBucket, stateKey, name, err := getTerraformFlags(cmd)
if err != nil {
return fmt.Errorf("unable to get terraform flags: %w", err)
}

err = manager.Create(ctx, stateBucket, stateKey, name)
if err != nil {
return fmt.Errorf("unable to create simulator infrastructure: %w", err)
}
return nil
},
}

Expand All @@ -53,13 +61,20 @@ func WithInfraDestroyCmd(manager tools.InfraManager, opts ...SimulatorCmdOptions
infraDestroyCmd := &cobra.Command{
Use: "destroy",
Short: "Destroy simulator infrastructure",
Run: func(cmd *cobra.Command, args []string) {
RunE: func(cmd *cobra.Command, _ []string) error {
ctx, stop := signal.NotifyContext(context.Background(), os.Interrupt, syscall.SIGTERM)
defer stop()

stateBucket, stateKey, name := getTerraformFlags(cmd)
err := manager.Destroy(ctx, stateBucket, stateKey, name)
cobra.CheckErr(err)
stateBucket, stateKey, name, err := getTerraformFlags(cmd)
if err != nil {
return fmt.Errorf("unable to get terraform flags: %w", err)
}

err = manager.Destroy(ctx, stateBucket, stateKey, name)
if err != nil {
return fmt.Errorf("unable to destroy simulator infrastructure: %w", err)
}
return nil
},
}

Expand All @@ -72,16 +87,23 @@ func WithInfraDestroyCmd(manager tools.InfraManager, opts ...SimulatorCmdOptions
}
}

func getTerraformFlags(cmd *cobra.Command) (string, string, string) {
func getTerraformFlags(cmd *cobra.Command) (string, string, string, error) {
stateBucket, err := cmd.Flags().GetString("stateBucket")
cobra.CheckErr(err)
if err != nil {
return "", "", "", fmt.Errorf("unable to get stateBucket flag: %w", err)
}

stateKey, err := cmd.Flags().GetString("stateKey")
cobra.CheckErr(err)
if err != nil {
return "", "", "", fmt.Errorf("unable to get stateKey flag: %w", err)
}

name, err := cmd.Flags().GetString("name")
cobra.CheckErr(err)
return stateBucket, stateKey, name
if err != nil {
return "", "", "", fmt.Errorf("unable to get name flag: %w", err)
}

return stateBucket, stateKey, name, nil
}

func WithFlag(name, value, usage string) SimulatorCmdOptions {
Expand Down
Loading
Loading