-
Notifications
You must be signed in to change notification settings - Fork 418
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Thomas Kosiewski <[email protected]>
- Loading branch information
1 parent
da85f9f
commit ad437c8
Showing
30 changed files
with
1,466 additions
and
80 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,241 @@ | ||
| package cmd | ||
|
|
||
| import ( | ||
| "context" | ||
| "encoding/json" | ||
| "errors" | ||
| "fmt" | ||
|
|
||
| managementv1 "github.com/loft-sh/api/v4/pkg/apis/management/v1" | ||
| "github.com/loft-sh/devpod/cmd/flags" | ||
| "github.com/loft-sh/devpod/cmd/provider" | ||
| "github.com/loft-sh/devpod/pkg/client" | ||
| "github.com/loft-sh/devpod/pkg/config" | ||
| "github.com/loft-sh/devpod/pkg/platform" | ||
| pkgprovider "github.com/loft-sh/devpod/pkg/provider" | ||
| "github.com/loft-sh/devpod/pkg/version" | ||
| "github.com/loft-sh/devpod/pkg/workspace" | ||
| "github.com/loft-sh/log" | ||
| "github.com/spf13/cobra" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| ) | ||
|
|
||
| type TroubleshootCmd struct { | ||
| *flags.GlobalFlags | ||
| } | ||
|
|
||
| func NewTroubleshootCmd(flags *flags.GlobalFlags) *cobra.Command { | ||
| cmd := &TroubleshootCmd{ | ||
| GlobalFlags: flags, | ||
| } | ||
| troubleshootCmd := &cobra.Command{ | ||
| Use: "troubleshoot [workspace-path|workspace-name]", | ||
| Short: "Prints the workspaces troubleshooting information", | ||
| Run: func(cobraCmd *cobra.Command, args []string) { | ||
| cmd.Run(cobraCmd.Context(), args) | ||
| }, | ||
| Hidden: true, | ||
| } | ||
|
|
||
| return troubleshootCmd | ||
| } | ||
|
|
||
| func (cmd *TroubleshootCmd) Run(ctx context.Context, args []string) { | ||
| // (ThomasK33): We're creating an anonymous struct here, so that we group | ||
| // everything and then we can serialize it in one call. | ||
| var info struct { | ||
| CLIVersion string | ||
| Config *config.Config | ||
| Providers map[string]provider.ProviderWithDefault | ||
| DevPodProInstances []DevPodProInstance | ||
| Workspace *pkgprovider.Workspace | ||
| WorkspaceStatus client.Status | ||
| WorkspaceTroubleshoot *managementv1.DevPodWorkspaceInstanceTroubleshoot | ||
|
|
||
| Errors []PrintableError `json:",omitempty"` | ||
| } | ||
| info.CLIVersion = version.GetVersion() | ||
|
|
||
| // (ThomasK33): We are defering the printing here, as we want to make sure | ||
| // that we will always print, even in the case of a panic. | ||
| defer func() { | ||
| out, err := json.MarshalIndent(info, "", " ") | ||
| if err == nil { | ||
| fmt.Print(string(out)) | ||
| } else { | ||
| fmt.Print(err) | ||
| fmt.Print(info) | ||
| } | ||
| }() | ||
|
|
||
| // NOTE(ThomasK33): Since this is a troubleshooting command, we want to | ||
| // collect as many relevant information as possible. | ||
| // For this reason we may not return with an error early. | ||
| // We are fine with a partially filled TrbouelshootInfo struct, as this | ||
| // already provides us with more information then before. | ||
| var err error | ||
| info.Config, err = config.LoadConfig(cmd.Context, cmd.Provider) | ||
| if err != nil { | ||
| info.Errors = append(info.Errors, PrintableError{fmt.Errorf("load config: %w", err)}) | ||
| // (ThomasK33): It's fine to return early here, as without the devpod config | ||
| // we cannot do any further troubleshooting. | ||
| return | ||
| } | ||
|
|
||
| logger := log.Default.ErrorStreamOnly() | ||
| info.Providers, err = collectProviders(info.Config, logger) | ||
| if err != nil { | ||
| info.Errors = append(info.Errors, PrintableError{fmt.Errorf("collect providers: %w", err)}) | ||
| } | ||
|
|
||
| info.DevPodProInstances, err = collectPlatformInfo(info.Config, logger) | ||
| if err != nil { | ||
| info.Errors = append(info.Errors, PrintableError{fmt.Errorf("collect platform info: %w", err)}) | ||
| } | ||
|
|
||
| workspaceClient, err := workspace.Get(ctx, info.Config, args, false, logger) | ||
| if err == nil { | ||
| info.Workspace = workspaceClient.WorkspaceConfig() | ||
| info.WorkspaceStatus, err = workspaceClient.Status(ctx, client.StatusOptions{}) | ||
| if err != nil { | ||
| info.Errors = append(info.Errors, PrintableError{fmt.Errorf("workspace status: %w", err)}) | ||
| } | ||
|
|
||
| if info.Workspace.Pro != nil { | ||
| // (ThomasK33): As there can be multiple pro instances configured | ||
| // we want to iterate over all and find the host that this workspace belongs to. | ||
| var proInstance DevPodProInstance | ||
|
|
||
| for _, instance := range info.DevPodProInstances { | ||
| if instance.ProviderName == info.Workspace.Provider.Name { | ||
| proInstance = instance | ||
| break | ||
| } | ||
| } | ||
|
|
||
| if proInstance.ProviderName != "" { | ||
| info.WorkspaceTroubleshoot, err = collectProWorkspaceInfo( | ||
| ctx, | ||
| info.Config, | ||
| proInstance.Host, | ||
| logger, | ||
| info.Workspace.UID, | ||
| info.Workspace.Pro.Project, | ||
| ) | ||
| if err != nil { | ||
| info.Errors = append(info.Errors, PrintableError{fmt.Errorf("collect pro workspace info: %w", err)}) | ||
| } | ||
| } | ||
| } | ||
| } else { | ||
| info.Errors = append(info.Errors, PrintableError{fmt.Errorf("get workspace: %w", err)}) | ||
| } | ||
| } | ||
|
|
||
| // collectProWorkspaceInfo collects troubleshooting information for a DevPod Pro instance. | ||
| // It initializes a client from the host, finds the workspace instance in the project, and retrieves | ||
| // troubleshooting information using the management client. | ||
| func collectProWorkspaceInfo( | ||
| ctx context.Context, | ||
| devPodConfig *config.Config, | ||
| host string, | ||
| logger log.Logger, | ||
| workspaceUID string, | ||
| project string, | ||
| ) (*managementv1.DevPodWorkspaceInstanceTroubleshoot, error) { | ||
| baseClient, err := platform.InitClientFromHost(ctx, devPodConfig, host, logger) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("init client from host: %w", err) | ||
| } | ||
|
|
||
| workspace, err := platform.FindInstanceInProject(ctx, baseClient, workspaceUID, project) | ||
| if err != nil { | ||
| return nil, err | ||
| } else if workspace == nil { | ||
| return nil, fmt.Errorf("couldn't find workspace") | ||
| } | ||
|
|
||
| managementClient, err := baseClient.Management() | ||
| if err != nil { | ||
| return nil, fmt.Errorf("management: %w", err) | ||
| } | ||
|
|
||
| troubleshoot, err := managementClient. | ||
| Loft(). | ||
| ManagementV1(). | ||
| DevPodWorkspaceInstances(workspace.Namespace). | ||
| Troubleshoot(ctx, workspace.Name, metav1.GetOptions{}) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("troubleshoot: %w", err) | ||
| } | ||
|
|
||
| return troubleshoot, nil | ||
| } | ||
|
|
||
| // collectProviders collects and configures providers based on the given devPodConfig. | ||
| // It returns a map of providers with their default settings and an error if any occurs. | ||
| func collectProviders(devPodConfig *config.Config, logger log.Logger) (map[string]provider.ProviderWithDefault, error) { | ||
| providers, err := workspace.LoadAllProviders(devPodConfig, logger) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| configuredProviders := devPodConfig.Current().Providers | ||
| if configuredProviders == nil { | ||
| configuredProviders = map[string]*config.ProviderConfig{} | ||
| } | ||
|
|
||
| retMap := map[string]provider.ProviderWithDefault{} | ||
| for k, entry := range providers { | ||
| if configuredProviders[entry.Config.Name] == nil { | ||
| continue | ||
| } | ||
|
|
||
| srcOptions := provider.MergeDynamicOptions(entry.Config.Options, configuredProviders[entry.Config.Name].DynamicOptions) | ||
| entry.Config.Options = srcOptions | ||
| retMap[k] = provider.ProviderWithDefault{ | ||
| ProviderWithOptions: *entry, | ||
| Default: devPodConfig.Current().DefaultProvider == entry.Config.Name, | ||
| } | ||
| } | ||
|
|
||
| return retMap, nil | ||
| } | ||
|
|
||
| type DevPodProInstance struct { | ||
| Host string | ||
| ProviderName string | ||
| Version string | ||
| } | ||
|
|
||
| // collectPlatformInfo collects information about all platform instances in a given devPodConfig. | ||
| // It iterates over the pro instances, retrieves their versions, and appends them to the ProInstance slice. | ||
| // Any errors encountered during this process are combined and returned along with the ProInstance slice. | ||
| // This means that even when an error value is returned, the pro instance slice will contain valid values. | ||
| func collectPlatformInfo(devPodConfig *config.Config, logger log.Logger) ([]DevPodProInstance, error) { | ||
| proInstanceList, err := workspace.ListProInstances(devPodConfig, logger) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("list pro instances: %w", err) | ||
| } | ||
|
|
||
| var proInstances []DevPodProInstance | ||
| var combinedErrs error | ||
|
|
||
| for _, proInstance := range proInstanceList { | ||
| version, err := platform.GetProInstanceDevPodVersion(&pkgprovider.ProInstance{Host: proInstance.Host}) | ||
| combinedErrs = errors.Join(combinedErrs, err) | ||
| proInstances = append(proInstances, DevPodProInstance{ | ||
| Host: proInstance.Host, | ||
| ProviderName: proInstance.Provider, | ||
| Version: version, | ||
| }) | ||
| } | ||
|
|
||
| return proInstances, combinedErrs | ||
| } | ||
|
|
||
| // (ThomasK33): Little type embedding here, so that we can | ||
| // serialize the error strings when invoking json.Marshal. | ||
| type PrintableError struct{ error } | ||
|
|
||
| func (p PrintableError) MarshalJSON() ([]byte, error) { return json.Marshal(p.Error()) } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.