Documentation
¶
Index ¶
- Constants
- Variables
- type Client
- type Def
- type ExecuteIn
- type ExecuteOut
- type ExecuteResponse
- type Executor
- func (_c Executor) ForHost(host string) Executor
- func (_c Executor) WithInputFlow(flow *workflow.Flow) Executor
- func (_c Executor) WithOptions(opts ...pub.Option) Executor
- func (_c Executor) WithOutputFlow(flow *workflow.Flow) Executor
- func (_c Executor) WithWorkflowRunner(runner WorkflowRunner) Executor
- type Hook
- type MulticastClient
- type MulticastTrigger
- type WorkflowRunner
Constants ¶
const Hostname = "shell.core"
Hostname is the default hostname of the microservice.
Variables ¶
var ( // HINT: Insert endpoint definitions here Execute = Def{Method: "POST", Route: ":444/execute"} // MARKER: Execute )
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client is a lightweight proxy for making unicast calls to the microservice.
func (Client) Execute ¶
func (_c Client) Execute(ctx context.Context, cmd string, workDir string, stdin string, envars map[string]string) (exitCode int, stdout string, stderr string, err error)
Execute runs a shell command on the host and returns the exit code, standard output, and standard error.
Input:
- cmd: the shell command to execute
- workDir: optional working directory for the command
- stdin: optional standard input to feed to the command
- envars: optional environment variables to set for the command, as key-value pairs
Output:
- exitCode: the exit code of the command
- stdout: the standard output of the command
- stderr: the standard error of the command
type ExecuteIn ¶
type ExecuteIn struct {
Cmd string `json:"cmd,omitzero"`
WorkDir string `json:"workDir,omitzero"`
Stdin string `json:"stdin,omitzero"`
Envars map[string]string `json:"envars,omitzero"`
}
ExecuteIn are the input arguments of Execute.
type ExecuteOut ¶
type ExecuteOut struct {
ExitCode int `json:"exitCode,omitzero"`
Stdout string `json:"stdout,omitzero"`
Stderr string `json:"stderr,omitzero"`
}
ExecuteOut are the output arguments of Execute.
type ExecuteResponse ¶
type ExecuteResponse multicastResponse // MARKER: Execute
ExecuteResponse packs the response of Execute.
type Executor ¶
type Executor struct {
// contains filtered or unexported fields
}
Executor runs tasks and workflows synchronously, blocking until termination. It is primarily intended for integration tests.
func NewExecutor ¶
NewExecutor creates a new executor proxy to the microservice.
func (Executor) ForHost ¶
ForHost returns a copy of the executor with a different hostname to be applied to requests.
func (Executor) WithInputFlow ¶
WithInputFlow returns a copy of the executor with an input flow to use for task execution. The input flow's state is available to the task in addition to the typed input arguments.
func (Executor) WithOptions ¶
WithOptions returns a copy of the executor with options to be applied to requests.
func (Executor) WithOutputFlow ¶
WithOutputFlow returns a copy of the executor with an output flow to populate after task execution. The output flow captures the full flow state including control signals (Goto, Retry, Interrupt, Sleep).
func (Executor) WithWorkflowRunner ¶
func (_c Executor) WithWorkflowRunner(runner WorkflowRunner) Executor
WithWorkflowRunner returns a copy of the executor with a workflow runner for executing workflows. foremanapi.NewClient(svc) satisfies the WorkflowRunner interface.
type Hook ¶
type Hook struct {
// contains filtered or unexported fields
}
Hook assists in the subscription to the events of the microservice.
func NewHook ¶
func NewHook(listener service.Subscriber) Hook
NewHook creates a new hook to the events of the microservice.
type MulticastClient ¶
type MulticastClient struct {
// contains filtered or unexported fields
}
MulticastClient is a lightweight proxy for making multicast calls to the microservice.
func NewMulticastClient ¶
func NewMulticastClient(caller service.Publisher) MulticastClient
NewMulticastClient creates a new multicast client proxy to the microservice.
func (MulticastClient) Execute ¶
func (_c MulticastClient) Execute(ctx context.Context, cmd string, workDir string, stdin string, envars map[string]string) iter.Seq[*ExecuteResponse]
Execute runs a shell command on the host and returns the exit code, standard output, and standard error.
Input:
- cmd: the shell command to execute
- workDir: optional working directory for the command
- stdin: optional standard input to feed to the command
- envars: optional environment variables to set for the command, as key-value pairs
Output:
- exitCode: the exit code of the command
- stdout: the standard output of the command
- stderr: the standard error of the command
func (MulticastClient) ForHost ¶
func (_c MulticastClient) ForHost(host string) MulticastClient
ForHost returns a copy of the client with a different hostname to be applied to requests.
func (MulticastClient) WithOptions ¶
func (_c MulticastClient) WithOptions(opts ...pub.Option) MulticastClient
WithOptions returns a copy of the client with options to be applied to requests.
type MulticastTrigger ¶
type MulticastTrigger struct {
// contains filtered or unexported fields
}
MulticastTrigger is a lightweight proxy for triggering the events of the microservice.
func NewMulticastTrigger ¶
func NewMulticastTrigger(caller service.Publisher) MulticastTrigger
NewMulticastTrigger creates a new multicast trigger of events of the microservice.
func (MulticastTrigger) ForHost ¶
func (_c MulticastTrigger) ForHost(host string) MulticastTrigger
ForHost returns a copy of the trigger with a different hostname to be applied to requests.
func (MulticastTrigger) WithOptions ¶
func (_c MulticastTrigger) WithOptions(opts ...pub.Option) MulticastTrigger
WithOptions returns a copy of the trigger with options to be applied to requests.
type WorkflowRunner ¶
type WorkflowRunner interface {
Run(ctx context.Context, workflowName string, initialState any) (status string, state map[string]any, err error)
}
WorkflowRunner executes a workflow by name with initial state, blocking until termination. foremanapi.Client satisfies this interface.
Source Files