local

Documentation

Index

• func GetDebugPortFromCrd(daName, daNamespace string) (int, error)
• func GetPortForwardCmd(targetName, targetNamespace string, localPort, targetRemotePort int) *exec.Cmd
• type DLV
  • func (d *DLV) ExpectRunningPlank() bool
  • func (d *DLV) GetDebugCmd(localPort int) *exec.Cmd
  • func (d *DLV) GetEditorRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, remotePort int) string
  • func (d *DLV) GetRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, ...) *exec.Cmd
  • func (d *DLV) WindowsSupportWarning() string
• type GdbInterface
  • func (d *GdbInterface) ExpectRunningPlank() bool
  • func (d *GdbInterface) GetDebugCmd(localPort int) *exec.Cmd
  • func (g *GdbInterface) GetEditorRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, remotePort int) string
  • func (g *GdbInterface) GetRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, ...) *exec.Cmd
  • func (g *GdbInterface) WindowsSupportWarning() string
• type JavaInterface
  • func (d *JavaInterface) ExpectRunningPlank() bool
  • func (d *JavaInterface) GetDebugCmd(localPort int) *exec.Cmd
  • func (j *JavaInterface) GetEditorRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, remotePort int) string
  • func (g *JavaInterface) GetRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, ...) *exec.Cmd
  • func (j *JavaInterface) WindowsSupportWarning() string
• type JavaPortInterface
  • func (d *JavaPortInterface) ExpectRunningPlank() bool
  • func (d *JavaPortInterface) GetDebugCmd(localPort int) *exec.Cmd
  • func (j *JavaPortInterface) GetEditorRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, remotePort int) string
  • func (g *JavaPortInterface) GetRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, ...) *exec.Cmd
  • func (j *JavaPortInterface) WindowsSupportWarning() string
• type Local
  • func GetParticularDebugger(dbgtype string) Local
• type NodeJsDebugger
  • func (d *NodeJsDebugger) ExpectRunningPlank() bool
  • func (d *NodeJsDebugger) GetDebugCmd(localPort int) *exec.Cmd
  • func (n *NodeJsDebugger) GetEditorRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, remotePort int) string
  • func (g *NodeJsDebugger) GetRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, ...) *exec.Cmd
  • func (n *NodeJsDebugger) WindowsSupportWarning() string
• type PythonInterface
  • func (d *PythonInterface) ExpectRunningPlank() bool
  • func (d *PythonInterface) GetDebugCmd(localPort int) *exec.Cmd
  • func (p *PythonInterface) GetEditorRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, remotePort int) string
  • func (i *PythonInterface) GetRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, ...) *exec.Cmd
  • func (p *PythonInterface) WindowsSupportWarning() string

Functions

func GetDebugPortFromCrd

func GetDebugPortFromCrd(daName, daNamespace string) (int, error)

func GetPortForwardCmd

func GetPortForwardCmd(targetName, targetNamespace string, localPort, targetRemotePort int) *exec.Cmd

Types

type DLV

type DLV struct {
}

func (*DLV) ExpectRunningPlank

func (d *DLV) ExpectRunningPlank() bool

func (*DLV) GetDebugCmd

func (d *DLV) GetDebugCmd(localPort int) *exec.Cmd

func (*DLV) GetEditorRemoteConnectionCmd

func (d *DLV) GetEditorRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, remotePort int) string

func (*DLV) GetRemoteConnectionCmd

func (d *DLV) GetRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, localPort, remotePort int) *exec.Cmd

func (*DLV) WindowsSupportWarning

func (d *DLV) WindowsSupportWarning() string

type GdbInterface

type GdbInterface struct{}

func (*GdbInterface) ExpectRunningPlank

func (d *GdbInterface) ExpectRunningPlank() bool

func (*GdbInterface) GetDebugCmd

func (d *GdbInterface) GetDebugCmd(localPort int) *exec.Cmd

func (*GdbInterface) GetEditorRemoteConnectionCmd

func (g *GdbInterface) GetEditorRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, remotePort int) string

func (*GdbInterface) GetRemoteConnectionCmd

func (g *GdbInterface) GetRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, localPort, remotePort int) *exec.Cmd

func (*GdbInterface) WindowsSupportWarning

func (g *GdbInterface) WindowsSupportWarning() string

type JavaInterface

type JavaInterface struct{}

func (*JavaInterface) ExpectRunningPlank

func (d *JavaInterface) ExpectRunningPlank() bool

func (*JavaInterface) GetDebugCmd

func (d *JavaInterface) GetDebugCmd(localPort int) *exec.Cmd

func (*JavaInterface) GetEditorRemoteConnectionCmd

func (j *JavaInterface) GetEditorRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, remotePort int) string

func (*JavaInterface) GetRemoteConnectionCmd

func (g *JavaInterface) GetRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, localPort, remotePort int) *exec.Cmd

func (*JavaInterface) WindowsSupportWarning

func (j *JavaInterface) WindowsSupportWarning() string

type JavaPortInterface

type JavaPortInterface struct{}

func (*JavaPortInterface) ExpectRunningPlank

func (d *JavaPortInterface) ExpectRunningPlank() bool

func (*JavaPortInterface) GetDebugCmd

func (d *JavaPortInterface) GetDebugCmd(localPort int) *exec.Cmd

func (*JavaPortInterface) GetEditorRemoteConnectionCmd

func (j *JavaPortInterface) GetEditorRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, remotePort int) string

func (*JavaPortInterface) GetRemoteConnectionCmd

func (g *JavaPortInterface) GetRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, localPort, remotePort int) *exec.Cmd

func (*JavaPortInterface) WindowsSupportWarning

func (j *JavaPortInterface) WindowsSupportWarning() string

type Local

type Local interface {

	// TODO - refactor this to use v2 DA api
	// (since all of these args belong in the DA spec)
	GetRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, localPort, remotePort int) *exec.Cmd

	// returns the kubectl port-forward command to be called by the editor extension
	GetEditorRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, remotePort int) string

	GetDebugCmd(localPort int) *exec.Cmd

	// ExpectRunningPod indicates if this local debugger should be paired with an active plank pod
	ExpectRunningPlank() bool

	// WindowsSupportWarning returns a warning message if there are any caveats associated
	// with running this debugger locally on windows. Otherwise returns ""
	WindowsSupportWarning() string
}

/ Debugger interface. implement this to add a new debugger support to squash.

func GetParticularDebugger

func GetParticularDebugger(dbgtype string) Local

type NodeJsDebugger

type NodeJsDebugger struct{}

func (*NodeJsDebugger) ExpectRunningPlank

func (d *NodeJsDebugger) ExpectRunningPlank() bool

func (*NodeJsDebugger) GetDebugCmd

func (d *NodeJsDebugger) GetDebugCmd(localPort int) *exec.Cmd

func (*NodeJsDebugger) GetEditorRemoteConnectionCmd

func (n *NodeJsDebugger) GetEditorRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, remotePort int) string

func (*NodeJsDebugger) GetRemoteConnectionCmd

func (g *NodeJsDebugger) GetRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, localPort, remotePort int) *exec.Cmd

func (*NodeJsDebugger) WindowsSupportWarning

func (n *NodeJsDebugger) WindowsSupportWarning() string

type PythonInterface

type PythonInterface struct{}

func (*PythonInterface) ExpectRunningPlank

func (d *PythonInterface) ExpectRunningPlank() bool

func (*PythonInterface) GetDebugCmd

func (d *PythonInterface) GetDebugCmd(localPort int) *exec.Cmd

func (*PythonInterface) GetEditorRemoteConnectionCmd

func (p *PythonInterface) GetEditorRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, remotePort int) string

func (*PythonInterface) GetRemoteConnectionCmd

func (i *PythonInterface) GetRemoteConnectionCmd(plankName, plankNamespace, podName, podNamespace string, localPort, remotePort int) *exec.Cmd

func (*PythonInterface) WindowsSupportWarning

func (p *PythonInterface) WindowsSupportWarning() string