util

Documentation

Index

• func FindExternalNode(store ExternalNodeStore, name string) (*nodev1.ExternalNode, error)
• func GetAnyWorkspaceByIDOrNameInActiveOrgErr(storeQ GetWorkspaceByNameOrIDErrStore, workspaceNameOrID string) (*entity.Workspace, error)
• func GetClassIDString(classID string) string
• func GetInstanceNames(args []string) ([]string, error)
• func GetInstanceNamesWithPipeInfo(args []string) ([]string, bool)
• func GetInstanceString(w entity.Workspace) string
• func GetUserWorkspaceByNameOrIDErr(storeQ GetWorkspaceByNameOrIDErrStore, workspaceNameOrID string) (*entity.Workspace, error)
• func IsStdinPiped() bool
• func IsStdoutPiped() bool
• func OpenPort(store ExternalNodeStore, nodeID string, portNumber int32, ...) (*nodev1.Port, error)
• func PollUntil(s *spinner.Spinner, wsid string, state string, ...) error
• func ResolveNodeSSHEntry(userID string, node *nodev1.ExternalNode) *ssh.ExternalNodeSSHEntry
• func StartWorkspaceIfStopped(t *terminal.Terminal, s *spinner.Spinner, tstore WorkspaceStartStore, ...) error
• func WaitForSSHToBeAvailable(sshAlias string, s *spinner.Spinner) error
• type ExternalNodeSSHInfo
  • func ResolveExternalNodeSSH(store ExternalNodeStore, node *nodev1.ExternalNode) (*ExternalNodeSSHInfo, error)
  • func (info *ExternalNodeSSHInfo) HomePath() string
  • func (info *ExternalNodeSSHInfo) SSHAlias() string
  • func (info *ExternalNodeSSHInfo) SSHTarget() string
• type ExternalNodeStore
• type GetWorkspaceByNameOrIDErrStore
• type MakeWorkspaceWithMetaStore
• type WorkspaceOrNode
  • func ResolveWorkspaceOrNode(store WorkspaceOrNodeResolver, nameOrID string) (*WorkspaceOrNode, error)
• type WorkspaceOrNodeResolver
• type WorkspacePollingStore
• type WorkspaceStartStore

Functions

func FindExternalNode

func FindExternalNode(store ExternalNodeStore, name string) (*nodev1.ExternalNode, error)

FindExternalNode searches for an external node by name in the user's active organization. Returns (nil, nil) if no matching node is found.

func GetAnyWorkspaceByIDOrNameInActiveOrgErr

func GetAnyWorkspaceByIDOrNameInActiveOrgErr(storeQ GetWorkspaceByNameOrIDErrStore, workspaceNameOrID string) (*entity.Workspace, error)

func GetClassIDString

func GetClassIDString(classID string) string

func GetInstanceNames

func GetInstanceNames(args []string) ([]string, error)

GetInstanceNames gets instance names from args or stdin (supports piping) Returns error if no names are provided

func GetInstanceNamesWithPipeInfo

func GetInstanceNamesWithPipeInfo(args []string) ([]string, bool)

GetInstanceNamesWithPipeInfo gets instance names from args or stdin and returns whether stdin was piped. Useful when you need to know if input came from a pipe vs args.

func GetInstanceString

func GetInstanceString(w entity.Workspace) string

func GetUserWorkspaceByNameOrIDErr

func GetUserWorkspaceByNameOrIDErr(storeQ GetWorkspaceByNameOrIDErrStore, workspaceNameOrID string) (*entity.Workspace, error)

func IsStdinPiped

func IsStdinPiped() bool

IsStdinPiped returns true if stdin is being piped from another command

func IsStdoutPiped

func IsStdoutPiped() bool

IsStdoutPiped returns true if stdout is being piped to another command Enables command chaining like: brev ls | grep RUNNING | brev stop

func OpenPort

func OpenPort(store ExternalNodeStore, nodeID string, portNumber int32, protocol nodev1.PortProtocol) (*nodev1.Port, error)

OpenPort calls the OpenPort RPC to open a port on an external node via netbird. This must be called before attempting to connect to a non-SSH port on a node.

func PollUntil

func PollUntil(s *spinner.Spinner, wsid string, state string, pollingStore WorkspacePollingStore, waitMsg string, timeout time.Duration) error

PollUntil polls the workspace status until it matches the desired state or times out

func ResolveNodeSSHEntry

func ResolveNodeSSHEntry(userID string, node *nodev1.ExternalNode) *ssh.ExternalNodeSSHEntry

ResolveNodeSSHEntry is a pure data function that extracts the SSH config entry for a given user from a node. Returns nil if the user has no access or the node has no SSH port. This is the single source of truth for node→SSHEntry conversion, used by both ResolveExternalNodeSSH (for commands) and refresh (for SSH config generation).

func StartWorkspaceIfStopped

func StartWorkspaceIfStopped(t *terminal.Terminal, s *spinner.Spinner, tstore WorkspaceStartStore, wsIDOrName string, workspace *entity.Workspace, timeout time.Duration) error

StartWorkspaceIfStopped starts a workspace and waits for it to be running

func WaitForSSHToBeAvailable

func WaitForSSHToBeAvailable(sshAlias string, s *spinner.Spinner) error

WaitForSSHToBeAvailable polls until an SSH connection can be established

Types

type ExternalNodeSSHInfo

type ExternalNodeSSHInfo struct {
	Node      *nodev1.ExternalNode
	LinuxUser string
	Hostname  string
	Port      int32
}

ExternalNodeSSHInfo holds resolved SSH connection details for an external node.

func ResolveExternalNodeSSH

func ResolveExternalNodeSSH(store ExternalNodeStore, node *nodev1.ExternalNode) (*ExternalNodeSSHInfo, error)

ResolveExternalNodeSSH resolves the SSH connection details for an external node by finding the current user's SSH access and the node's SSH port.

func (*ExternalNodeSSHInfo) HomePath

func (info *ExternalNodeSSHInfo) HomePath() string

HomePath returns the home directory path for the linux user.

func (*ExternalNodeSSHInfo) SSHAlias

func (info *ExternalNodeSSHInfo) SSHAlias() string

SSHAlias returns a sanitized node name suitable for use as an SSH config Host alias.

func (*ExternalNodeSSHInfo) SSHTarget

func (info *ExternalNodeSSHInfo) SSHTarget() string

SSHTarget returns the "user@host" string for direct SSH.

type ExternalNodeStore

type ExternalNodeStore interface {
	GetActiveOrganizationOrDefault() (*entity.Organization, error)
	GetAccessToken() (string, error)
	GetCurrentUser() (*entity.User, error)
}

ExternalNodeStore is the minimal interface needed for external node lookup and SSH resolution.

type GetWorkspaceByNameOrIDErrStore

type GetWorkspaceByNameOrIDErrStore interface {
	GetActiveOrganizationOrDefault() (*entity.Organization, error)
	GetWorkspaceByNameOrID(orgID string, nameOrID string) ([]entity.Workspace, error)
	GetCurrentUser() (*entity.User, error)
}

type MakeWorkspaceWithMetaStore

type MakeWorkspaceWithMetaStore interface {
	GetWorkspaceMetaData(workspaceID string) (*entity.WorkspaceMetaData, error)
}

type WorkspaceOrNode

type WorkspaceOrNode struct {
	Workspace *entity.Workspace
	Node      *nodev1.ExternalNode
}

WorkspaceOrNode is returned by ResolveWorkspaceOrNode. Exactly one field is non-nil.

func ResolveWorkspaceOrNode

func ResolveWorkspaceOrNode(store WorkspaceOrNodeResolver, nameOrID string,
) (*WorkspaceOrNode, error)

ResolveWorkspaceOrNode looks up a workspace first; if not found, falls back to external nodes. The store must satisfy both GetWorkspaceByNameOrIDErrStore and ExternalNodeStore.

type WorkspaceOrNodeResolver

type WorkspaceOrNodeResolver interface {
	GetWorkspaceByNameOrIDErrStore
	ExternalNodeStore
}

type WorkspacePollingStore

type WorkspacePollingStore interface {
	GetWorkspace(workspaceID string) (*entity.Workspace, error)
}

WorkspacePollingStore is the minimal interface needed for polling workspace state

type WorkspaceStartStore

type WorkspaceStartStore interface {
	GetWorkspaceByNameOrIDErrStore
	WorkspacePollingStore
	StartWorkspace(workspaceID string) (*entity.Workspace, error)
}

WorkspaceStartStore is the interface needed for starting stopped workspaces