runner

package
v1.4.8 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 24, 2025 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Graph added in v1.0.8 

func Graph() *dot.Graph

Types

type ActionHandler added in v1.0.8 

type ActionHandler interface {
	ComposeAction(ctx context.Context, actionCtx *ActionHandlerContext) (*model.Action, error)
}

type ActionHandlerContext added in v1.0.8 

type ActionHandlerContext struct {
	*TaskHandlerContext

	// The first action to be run
	First bool

	// The final action to be run
	Last bool

	// The firmware to be installed
	Firmware *rctypes.Firmware
}

The ActionHandlerContext passed to action handlers

type MockActionHandler added in v1.0.8 

type MockActionHandler struct {
	mock.Mock
}

MockActionHandler is an autogenerated mock type for the ActionHandler type

func NewMockActionHandler added in v1.0.8 

func NewMockActionHandler(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockActionHandler

NewMockActionHandler creates a new instance of MockActionHandler. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockActionHandler) ComposeAction added in v1.0.8 

func (_m *MockActionHandler) ComposeAction(ctx context.Context, actionCtx *ActionHandlerContext) (*model.Action, error)

ComposeAction provides a mock function with given fields: ctx, actionCtx

func (*MockActionHandler) EXPECT added in v1.0.8 

func (_m *MockActionHandler) EXPECT() *MockActionHandler_Expecter

type MockActionHandler_ComposeAction_Call added in v1.0.8 

type MockActionHandler_ComposeAction_Call struct {
	*mock.Call
}

MockActionHandler_ComposeAction_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'ComposeAction'

func (*MockActionHandler_ComposeAction_Call) Return added in v1.0.8 

func (_c *MockActionHandler_ComposeAction_Call) Return(_a0 *model.Action, _a1 error) *MockActionHandler_ComposeAction_Call

func (*MockActionHandler_ComposeAction_Call) Run added in v1.0.8 

func (_c *MockActionHandler_ComposeAction_Call) Run(run func(ctx context.Context, actionCtx *ActionHandlerContext)) *MockActionHandler_ComposeAction_Call

func (*MockActionHandler_ComposeAction_Call) RunAndReturn added in v1.0.8 

func (_c *MockActionHandler_ComposeAction_Call) RunAndReturn(run func(context.Context, *ActionHandlerContext) (*model.Action, error)) *MockActionHandler_ComposeAction_Call

type MockActionHandler_Expecter added in v1.0.8 

type MockActionHandler_Expecter struct {
	// contains filtered or unexported fields
}

func (*MockActionHandler_Expecter) ComposeAction added in v1.0.8 

func (_e *MockActionHandler_Expecter) ComposeAction(ctx interface{}, actionCtx interface{}) *MockActionHandler_ComposeAction_Call

ComposeAction is a helper method to define mock.On call

  • ctx context.Context
  • actionCtx *ActionHandlerContext

type MockTaskHandler added in v1.0.8 

type MockTaskHandler struct {
	mock.Mock
}

MockTaskHandler is an autogenerated mock type for the TaskHandler type

func NewMockTaskHandler added in v1.0.8 

func NewMockTaskHandler(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockTaskHandler

NewMockTaskHandler creates a new instance of MockTaskHandler. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations. The first argument is typically a *testing.T value.

func (*MockTaskHandler) EXPECT added in v1.0.8 

func (_m *MockTaskHandler) EXPECT() *MockTaskHandler_Expecter

func (*MockTaskHandler) Initialize added in v1.0.8 

func (_m *MockTaskHandler) Initialize(ctx context.Context) error

Initialize provides a mock function with given fields: ctx

func (*MockTaskHandler) OnFailure added in v1.0.8 

func (_m *MockTaskHandler) OnFailure(ctx context.Context, task *model.Task)

OnFailure provides a mock function with given fields: ctx, task

func (*MockTaskHandler) OnSuccess added in v1.0.8 

func (_m *MockTaskHandler) OnSuccess(ctx context.Context, task *model.Task)

OnSuccess provides a mock function with given fields: ctx, task

func (*MockTaskHandler) PlanActions added in v1.0.8 

func (_m *MockTaskHandler) PlanActions(ctx context.Context) error

PlanActions provides a mock function with given fields: ctx

func (*MockTaskHandler) Publish added in v1.0.8 

func (_m *MockTaskHandler) Publish(ctx context.Context)

Publish provides a mock function with given fields: ctx

func (*MockTaskHandler) Query added in v1.0.8 

func (_m *MockTaskHandler) Query(ctx context.Context) error

Query provides a mock function with given fields: ctx

type MockTaskHandler_Expecter added in v1.0.8 

type MockTaskHandler_Expecter struct {
	// contains filtered or unexported fields
}

func (*MockTaskHandler_Expecter) Initialize added in v1.0.8 

func (_e *MockTaskHandler_Expecter) Initialize(ctx interface{}) *MockTaskHandler_Initialize_Call

Initialize is a helper method to define mock.On call

  • ctx context.Context

func (*MockTaskHandler_Expecter) OnFailure added in v1.0.8 

func (_e *MockTaskHandler_Expecter) OnFailure(ctx interface{}, task interface{}) *MockTaskHandler_OnFailure_Call

OnFailure is a helper method to define mock.On call

  • ctx context.Context
  • task *model.Task

func (*MockTaskHandler_Expecter) OnSuccess added in v1.0.8 

func (_e *MockTaskHandler_Expecter) OnSuccess(ctx interface{}, task interface{}) *MockTaskHandler_OnSuccess_Call

OnSuccess is a helper method to define mock.On call

  • ctx context.Context
  • task *model.Task

func (*MockTaskHandler_Expecter) PlanActions added in v1.0.8 

func (_e *MockTaskHandler_Expecter) PlanActions(ctx interface{}) *MockTaskHandler_PlanActions_Call

PlanActions is a helper method to define mock.On call

  • ctx context.Context

func (*MockTaskHandler_Expecter) Publish added in v1.0.8 

func (_e *MockTaskHandler_Expecter) Publish(ctx interface{}) *MockTaskHandler_Publish_Call

Publish is a helper method to define mock.On call

  • ctx context.Context

func (*MockTaskHandler_Expecter) Query added in v1.0.8 

func (_e *MockTaskHandler_Expecter) Query(ctx interface{}) *MockTaskHandler_Query_Call

Query is a helper method to define mock.On call

  • ctx context.Context

type MockTaskHandler_Initialize_Call added in v1.0.8 

type MockTaskHandler_Initialize_Call struct {
	*mock.Call
}

MockTaskHandler_Initialize_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Initialize'

func (*MockTaskHandler_Initialize_Call) Return added in v1.0.8 

func (_c *MockTaskHandler_Initialize_Call) Return(_a0 error) *MockTaskHandler_Initialize_Call

func (*MockTaskHandler_Initialize_Call) Run added in v1.0.8 

func (_c *MockTaskHandler_Initialize_Call) Run(run func(ctx context.Context)) *MockTaskHandler_Initialize_Call

func (*MockTaskHandler_Initialize_Call) RunAndReturn added in v1.0.8 

func (_c *MockTaskHandler_Initialize_Call) RunAndReturn(run func(context.Context) error) *MockTaskHandler_Initialize_Call

type MockTaskHandler_OnFailure_Call added in v1.0.8 

type MockTaskHandler_OnFailure_Call struct {
	*mock.Call
}

MockTaskHandler_OnFailure_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'OnFailure'

func (*MockTaskHandler_OnFailure_Call) Return added in v1.0.8 

func (_c *MockTaskHandler_OnFailure_Call) Return() *MockTaskHandler_OnFailure_Call

func (*MockTaskHandler_OnFailure_Call) Run added in v1.0.8 

func (_c *MockTaskHandler_OnFailure_Call) Run(run func(ctx context.Context, task *model.Task)) *MockTaskHandler_OnFailure_Call

func (*MockTaskHandler_OnFailure_Call) RunAndReturn added in v1.0.8 

func (_c *MockTaskHandler_OnFailure_Call) RunAndReturn(run func(context.Context, *model.Task)) *MockTaskHandler_OnFailure_Call

type MockTaskHandler_OnSuccess_Call added in v1.0.8 

type MockTaskHandler_OnSuccess_Call struct {
	*mock.Call
}

MockTaskHandler_OnSuccess_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'OnSuccess'

func (*MockTaskHandler_OnSuccess_Call) Return added in v1.0.8 

func (_c *MockTaskHandler_OnSuccess_Call) Return() *MockTaskHandler_OnSuccess_Call

func (*MockTaskHandler_OnSuccess_Call) Run added in v1.0.8 

func (_c *MockTaskHandler_OnSuccess_Call) Run(run func(ctx context.Context, task *model.Task)) *MockTaskHandler_OnSuccess_Call

func (*MockTaskHandler_OnSuccess_Call) RunAndReturn added in v1.0.8 

func (_c *MockTaskHandler_OnSuccess_Call) RunAndReturn(run func(context.Context, *model.Task)) *MockTaskHandler_OnSuccess_Call

type MockTaskHandler_PlanActions_Call added in v1.0.8 

type MockTaskHandler_PlanActions_Call struct {
	*mock.Call
}

MockTaskHandler_PlanActions_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'PlanActions'

func (*MockTaskHandler_PlanActions_Call) Return added in v1.0.8 

func (_c *MockTaskHandler_PlanActions_Call) Return(_a0 error) *MockTaskHandler_PlanActions_Call

func (*MockTaskHandler_PlanActions_Call) Run added in v1.0.8 

func (_c *MockTaskHandler_PlanActions_Call) Run(run func(ctx context.Context)) *MockTaskHandler_PlanActions_Call

func (*MockTaskHandler_PlanActions_Call) RunAndReturn added in v1.0.8 

func (_c *MockTaskHandler_PlanActions_Call) RunAndReturn(run func(context.Context) error) *MockTaskHandler_PlanActions_Call

type MockTaskHandler_Publish_Call added in v1.0.8 

type MockTaskHandler_Publish_Call struct {
	*mock.Call
}

MockTaskHandler_Publish_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Publish'

func (*MockTaskHandler_Publish_Call) Return added in v1.0.8 

func (_c *MockTaskHandler_Publish_Call) Return() *MockTaskHandler_Publish_Call

func (*MockTaskHandler_Publish_Call) Run added in v1.0.8 

func (_c *MockTaskHandler_Publish_Call) Run(run func(ctx context.Context)) *MockTaskHandler_Publish_Call

func (*MockTaskHandler_Publish_Call) RunAndReturn added in v1.0.8 

func (_c *MockTaskHandler_Publish_Call) RunAndReturn(run func(context.Context)) *MockTaskHandler_Publish_Call

type MockTaskHandler_Query_Call added in v1.0.8 

type MockTaskHandler_Query_Call struct {
	*mock.Call
}

MockTaskHandler_Query_Call is a *mock.Call that shadows Run/Return methods with type explicit version for method 'Query'

func (*MockTaskHandler_Query_Call) Return added in v1.0.8 

func (_c *MockTaskHandler_Query_Call) Return(_a0 error) *MockTaskHandler_Query_Call

func (*MockTaskHandler_Query_Call) Run added in v1.0.8 

func (_c *MockTaskHandler_Query_Call) Run(run func(ctx context.Context)) *MockTaskHandler_Query_Call

func (*MockTaskHandler_Query_Call) RunAndReturn added in v1.0.8 

func (_c *MockTaskHandler_Query_Call) RunAndReturn(run func(context.Context) error) *MockTaskHandler_Query_Call

type Runner 

type Runner struct {
	// contains filtered or unexported fields
}

A Runner instance runs a single task, to install firmware on one or more server components.

func New 

func New(logger *logrus.Entry) *Runner

func (*Runner) RunTask 

func (r *Runner) RunTask(ctx context.Context, task *model.Task, handler TaskHandler) error

type TaskHandler added in v1.0.8 

type TaskHandler interface {
	Initialize(ctx context.Context) error
	Query(ctx context.Context) error
	PlanActions(ctx context.Context) error
	OnSuccess(ctx context.Context, task *model.Task)
	OnFailure(ctx context.Context, task *model.Task)
	Publish(ctx context.Context)
}

type TaskHandlerContext added in v1.0.8 

type TaskHandlerContext struct {
	// Publisher provides a method to publish task information
	Publisher model.Publisher

	// The task this action belongs to
	Task *model.Task

	// Logger is the task, action handler logger.
	Logger *logrus.Entry

	// Device queryor interface
	//
	// type asserted to InbandQueryor or OutofbandQueryor at invocation
	DeviceQueryor any

	// Data store repository
	Store store.Repository
}

The TaskHandlerContext is passed to task handlers

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.