device

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: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type InbandQueryor added in v1.1.0

type InbandQueryor interface {
	// Inventory returns the device inventory
	Inventory(ctx context.Context) (*common.Device, error)
	FirmwareInstall(ctx context.Context, component, vendor string, model, version, updateFile string, force bool) error
	FirmwareInstallRequirements(ctx context.Context, component, vendor, model string) (*ironlibm.UpdateRequirements, error)
}

type MockInbandQueryor added in v1.1.0

type MockInbandQueryor struct {
	mock.Mock
}

MockInbandQueryor is an autogenerated mock type for the InbandQueryor type

func NewMockInbandQueryor added in v1.1.0

func NewMockInbandQueryor(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockInbandQueryor

NewMockInbandQueryor creates a new instance of MockInbandQueryor. 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 (*MockInbandQueryor) EXPECT added in v1.1.0

func (*MockInbandQueryor) FirmwareInstall added in v1.1.0

func (_m *MockInbandQueryor) FirmwareInstall(ctx context.Context, component string, vendor string, _a3 string, version string, updateFile string, force bool) error

FirmwareInstall provides a mock function with given fields: ctx, component, vendor, _a3, version, updateFile, force

func (*MockInbandQueryor) FirmwareInstallRequirements added in v1.1.0

func (_m *MockInbandQueryor) FirmwareInstallRequirements(ctx context.Context, component string, vendor string, _a3 string) (*model.UpdateRequirements, error)

FirmwareInstallRequirements provides a mock function with given fields: ctx, component, vendor, _a3

func (*MockInbandQueryor) Inventory added in v1.1.0

func (_m *MockInbandQueryor) Inventory(ctx context.Context) (*common.Device, error)

Inventory provides a mock function with given fields: ctx

type MockInbandQueryor_Expecter added in v1.1.0

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

func (*MockInbandQueryor_Expecter) FirmwareInstall added in v1.1.0

func (_e *MockInbandQueryor_Expecter) FirmwareInstall(ctx interface{}, component interface{}, vendor interface{}, _a3 interface{}, version interface{}, updateFile interface{}, force interface{}) *MockInbandQueryor_FirmwareInstall_Call

FirmwareInstall is a helper method to define mock.On call

  • ctx context.Context
  • component string
  • vendor string
  • _a3 string
  • version string
  • updateFile string
  • force bool

func (*MockInbandQueryor_Expecter) FirmwareInstallRequirements added in v1.1.0

func (_e *MockInbandQueryor_Expecter) FirmwareInstallRequirements(ctx interface{}, component interface{}, vendor interface{}, _a3 interface{}) *MockInbandQueryor_FirmwareInstallRequirements_Call

FirmwareInstallRequirements is a helper method to define mock.On call

  • ctx context.Context
  • component string
  • vendor string
  • _a3 string

func (*MockInbandQueryor_Expecter) Inventory added in v1.1.0

func (_e *MockInbandQueryor_Expecter) Inventory(ctx interface{}) *MockInbandQueryor_Inventory_Call

Inventory is a helper method to define mock.On call

  • ctx context.Context

type MockInbandQueryor_FirmwareInstallRequirements_Call added in v1.1.0

type MockInbandQueryor_FirmwareInstallRequirements_Call struct {
	*mock.Call
}

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

func (*MockInbandQueryor_FirmwareInstallRequirements_Call) Return added in v1.1.0

func (*MockInbandQueryor_FirmwareInstallRequirements_Call) Run added in v1.1.0

func (*MockInbandQueryor_FirmwareInstallRequirements_Call) RunAndReturn added in v1.1.0

type MockInbandQueryor_FirmwareInstall_Call added in v1.1.0

type MockInbandQueryor_FirmwareInstall_Call struct {
	*mock.Call
}

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

func (*MockInbandQueryor_FirmwareInstall_Call) Return added in v1.1.0

func (*MockInbandQueryor_FirmwareInstall_Call) Run added in v1.1.0

func (_c *MockInbandQueryor_FirmwareInstall_Call) Run(run func(ctx context.Context, component string, vendor string, _a3 string, version string, updateFile string, force bool)) *MockInbandQueryor_FirmwareInstall_Call

func (*MockInbandQueryor_FirmwareInstall_Call) RunAndReturn added in v1.1.0

type MockInbandQueryor_Inventory_Call added in v1.1.0

type MockInbandQueryor_Inventory_Call struct {
	*mock.Call
}

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

func (*MockInbandQueryor_Inventory_Call) Return added in v1.1.0

func (*MockInbandQueryor_Inventory_Call) Run added in v1.1.0

func (*MockInbandQueryor_Inventory_Call) RunAndReturn added in v1.1.0

type MockOutofbandQueryor added in v1.1.0

type MockOutofbandQueryor struct {
	mock.Mock
}

MockOutofbandQueryor is an autogenerated mock type for the OutofbandQueryor type

func NewMockOutofbandQueryor added in v1.1.0

func NewMockOutofbandQueryor(t interface {
	mock.TestingT
	Cleanup(func())
}) *MockOutofbandQueryor

NewMockOutofbandQueryor creates a new instance of MockOutofbandQueryor. 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 (*MockOutofbandQueryor) Close added in v1.1.0

func (_m *MockOutofbandQueryor) Close(ctx context.Context) error

Close provides a mock function with given fields: ctx

func (*MockOutofbandQueryor) EXPECT added in v1.1.0

func (*MockOutofbandQueryor) FirmwareInstallSteps added in v1.1.0

func (_m *MockOutofbandQueryor) FirmwareInstallSteps(ctx context.Context, component string) ([]constants.FirmwareInstallStep, error)

FirmwareInstallSteps provides a mock function with given fields: ctx, component

func (*MockOutofbandQueryor) FirmwareInstallUploadAndInitiate added in v1.1.0

func (_m *MockOutofbandQueryor) FirmwareInstallUploadAndInitiate(ctx context.Context, component string, file *os.File) (string, error)

FirmwareInstallUploadAndInitiate provides a mock function with given fields: ctx, component, file

func (*MockOutofbandQueryor) FirmwareInstallUploaded added in v1.1.0

func (_m *MockOutofbandQueryor) FirmwareInstallUploaded(ctx context.Context, component string, uploadVerifyTaskID string) (string, error)

FirmwareInstallUploaded provides a mock function with given fields: ctx, component, uploadVerifyTaskID

func (*MockOutofbandQueryor) FirmwareTaskStatus added in v1.1.0

func (_m *MockOutofbandQueryor) FirmwareTaskStatus(ctx context.Context, kind constants.FirmwareInstallStep, component string, taskID string, installVersion string) (constants.TaskState, string, error)

FirmwareTaskStatus provides a mock function with given fields: ctx, kind, component, taskID, installVersion

func (*MockOutofbandQueryor) FirmwareUpload added in v1.1.0

func (_m *MockOutofbandQueryor) FirmwareUpload(ctx context.Context, component string, reader *os.File) (string, error)

FirmwareUpload provides a mock function with given fields: ctx, component, reader

func (*MockOutofbandQueryor) Inventory added in v1.1.0

func (_m *MockOutofbandQueryor) Inventory(ctx context.Context) (*common.Device, error)

Inventory provides a mock function with given fields: ctx

func (*MockOutofbandQueryor) Open added in v1.1.0

func (_m *MockOutofbandQueryor) Open(ctx context.Context) error

Open provides a mock function with given fields: ctx

func (*MockOutofbandQueryor) PowerStatus added in v1.1.0

func (_m *MockOutofbandQueryor) PowerStatus(ctx context.Context) (string, error)

PowerStatus provides a mock function with given fields: ctx

func (*MockOutofbandQueryor) ReinitializeClient added in v1.1.0

func (_m *MockOutofbandQueryor) ReinitializeClient(ctx context.Context)

ReinitializeClient provides a mock function with given fields: ctx

func (*MockOutofbandQueryor) ResetBMC added in v1.1.0

func (_m *MockOutofbandQueryor) ResetBMC(ctx context.Context) error

ResetBMC provides a mock function with given fields: ctx

func (*MockOutofbandQueryor) SetPowerState added in v1.1.0

func (_m *MockOutofbandQueryor) SetPowerState(ctx context.Context, state string) error

SetPowerState provides a mock function with given fields: ctx, state

type MockOutofbandQueryor_Close_Call added in v1.1.0

type MockOutofbandQueryor_Close_Call struct {
	*mock.Call
}

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

func (*MockOutofbandQueryor_Close_Call) Return added in v1.1.0

func (*MockOutofbandQueryor_Close_Call) Run added in v1.1.0

func (*MockOutofbandQueryor_Close_Call) RunAndReturn added in v1.1.0

type MockOutofbandQueryor_Expecter added in v1.1.0

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

func (*MockOutofbandQueryor_Expecter) Close added in v1.1.0

Close is a helper method to define mock.On call

  • ctx context.Context

func (*MockOutofbandQueryor_Expecter) FirmwareInstallSteps added in v1.1.0

func (_e *MockOutofbandQueryor_Expecter) FirmwareInstallSteps(ctx interface{}, component interface{}) *MockOutofbandQueryor_FirmwareInstallSteps_Call

FirmwareInstallSteps is a helper method to define mock.On call

  • ctx context.Context
  • component string

func (*MockOutofbandQueryor_Expecter) FirmwareInstallUploadAndInitiate added in v1.1.0

func (_e *MockOutofbandQueryor_Expecter) FirmwareInstallUploadAndInitiate(ctx interface{}, component interface{}, file interface{}) *MockOutofbandQueryor_FirmwareInstallUploadAndInitiate_Call

FirmwareInstallUploadAndInitiate is a helper method to define mock.On call

  • ctx context.Context
  • component string
  • file *os.File

func (*MockOutofbandQueryor_Expecter) FirmwareInstallUploaded added in v1.1.0

func (_e *MockOutofbandQueryor_Expecter) FirmwareInstallUploaded(ctx interface{}, component interface{}, uploadVerifyTaskID interface{}) *MockOutofbandQueryor_FirmwareInstallUploaded_Call

FirmwareInstallUploaded is a helper method to define mock.On call

  • ctx context.Context
  • component string
  • uploadVerifyTaskID string

func (*MockOutofbandQueryor_Expecter) FirmwareTaskStatus added in v1.1.0

func (_e *MockOutofbandQueryor_Expecter) FirmwareTaskStatus(ctx interface{}, kind interface{}, component interface{}, taskID interface{}, installVersion interface{}) *MockOutofbandQueryor_FirmwareTaskStatus_Call

FirmwareTaskStatus is a helper method to define mock.On call

  • ctx context.Context
  • kind constants.FirmwareInstallStep
  • component string
  • taskID string
  • installVersion string

func (*MockOutofbandQueryor_Expecter) FirmwareUpload added in v1.1.0

func (_e *MockOutofbandQueryor_Expecter) FirmwareUpload(ctx interface{}, component interface{}, reader interface{}) *MockOutofbandQueryor_FirmwareUpload_Call

FirmwareUpload is a helper method to define mock.On call

  • ctx context.Context
  • component string
  • reader *os.File

func (*MockOutofbandQueryor_Expecter) Inventory added in v1.1.0

Inventory is a helper method to define mock.On call

  • ctx context.Context

func (*MockOutofbandQueryor_Expecter) Open added in v1.1.0

Open is a helper method to define mock.On call

  • ctx context.Context

func (*MockOutofbandQueryor_Expecter) PowerStatus added in v1.1.0

func (_e *MockOutofbandQueryor_Expecter) PowerStatus(ctx interface{}) *MockOutofbandQueryor_PowerStatus_Call

PowerStatus is a helper method to define mock.On call

  • ctx context.Context

func (*MockOutofbandQueryor_Expecter) ReinitializeClient added in v1.1.0

func (_e *MockOutofbandQueryor_Expecter) ReinitializeClient(ctx interface{}) *MockOutofbandQueryor_ReinitializeClient_Call

ReinitializeClient is a helper method to define mock.On call

  • ctx context.Context

func (*MockOutofbandQueryor_Expecter) ResetBMC added in v1.1.0

ResetBMC is a helper method to define mock.On call

  • ctx context.Context

func (*MockOutofbandQueryor_Expecter) SetPowerState added in v1.1.0

func (_e *MockOutofbandQueryor_Expecter) SetPowerState(ctx interface{}, state interface{}) *MockOutofbandQueryor_SetPowerState_Call

SetPowerState is a helper method to define mock.On call

  • ctx context.Context
  • state string

type MockOutofbandQueryor_FirmwareInstallSteps_Call added in v1.1.0

type MockOutofbandQueryor_FirmwareInstallSteps_Call struct {
	*mock.Call
}

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

func (*MockOutofbandQueryor_FirmwareInstallSteps_Call) Return added in v1.1.0

func (*MockOutofbandQueryor_FirmwareInstallSteps_Call) Run added in v1.1.0

func (*MockOutofbandQueryor_FirmwareInstallSteps_Call) RunAndReturn added in v1.1.0

type MockOutofbandQueryor_FirmwareInstallUploadAndInitiate_Call added in v1.1.0

type MockOutofbandQueryor_FirmwareInstallUploadAndInitiate_Call struct {
	*mock.Call
}

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

func (*MockOutofbandQueryor_FirmwareInstallUploadAndInitiate_Call) Return added in v1.1.0

func (*MockOutofbandQueryor_FirmwareInstallUploadAndInitiate_Call) Run added in v1.1.0

func (*MockOutofbandQueryor_FirmwareInstallUploadAndInitiate_Call) RunAndReturn added in v1.1.0

type MockOutofbandQueryor_FirmwareInstallUploaded_Call added in v1.1.0

type MockOutofbandQueryor_FirmwareInstallUploaded_Call struct {
	*mock.Call
}

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

func (*MockOutofbandQueryor_FirmwareInstallUploaded_Call) Return added in v1.1.0

func (*MockOutofbandQueryor_FirmwareInstallUploaded_Call) Run added in v1.1.0

func (*MockOutofbandQueryor_FirmwareInstallUploaded_Call) RunAndReturn added in v1.1.0

type MockOutofbandQueryor_FirmwareTaskStatus_Call added in v1.1.0

type MockOutofbandQueryor_FirmwareTaskStatus_Call struct {
	*mock.Call
}

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

func (*MockOutofbandQueryor_FirmwareTaskStatus_Call) Return added in v1.1.0

func (*MockOutofbandQueryor_FirmwareTaskStatus_Call) Run added in v1.1.0

func (*MockOutofbandQueryor_FirmwareTaskStatus_Call) RunAndReturn added in v1.1.0

type MockOutofbandQueryor_FirmwareUpload_Call added in v1.1.0

type MockOutofbandQueryor_FirmwareUpload_Call struct {
	*mock.Call
}

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

func (*MockOutofbandQueryor_FirmwareUpload_Call) Return added in v1.1.0

func (*MockOutofbandQueryor_FirmwareUpload_Call) Run added in v1.1.0

func (*MockOutofbandQueryor_FirmwareUpload_Call) RunAndReturn added in v1.1.0

type MockOutofbandQueryor_Inventory_Call added in v1.1.0

type MockOutofbandQueryor_Inventory_Call struct {
	*mock.Call
}

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

func (*MockOutofbandQueryor_Inventory_Call) Return added in v1.1.0

func (*MockOutofbandQueryor_Inventory_Call) Run added in v1.1.0

func (*MockOutofbandQueryor_Inventory_Call) RunAndReturn added in v1.1.0

type MockOutofbandQueryor_Open_Call added in v1.1.0

type MockOutofbandQueryor_Open_Call struct {
	*mock.Call
}

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

func (*MockOutofbandQueryor_Open_Call) Return added in v1.1.0

func (*MockOutofbandQueryor_Open_Call) Run added in v1.1.0

func (*MockOutofbandQueryor_Open_Call) RunAndReturn added in v1.1.0

type MockOutofbandQueryor_PowerStatus_Call added in v1.1.0

type MockOutofbandQueryor_PowerStatus_Call struct {
	*mock.Call
}

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

func (*MockOutofbandQueryor_PowerStatus_Call) Return added in v1.1.0

func (*MockOutofbandQueryor_PowerStatus_Call) Run added in v1.1.0

func (*MockOutofbandQueryor_PowerStatus_Call) RunAndReturn added in v1.1.0

type MockOutofbandQueryor_ReinitializeClient_Call added in v1.1.0

type MockOutofbandQueryor_ReinitializeClient_Call struct {
	*mock.Call
}

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

func (*MockOutofbandQueryor_ReinitializeClient_Call) Return added in v1.1.0

func (*MockOutofbandQueryor_ReinitializeClient_Call) Run added in v1.1.0

func (*MockOutofbandQueryor_ReinitializeClient_Call) RunAndReturn added in v1.1.0

type MockOutofbandQueryor_ResetBMC_Call added in v1.1.0

type MockOutofbandQueryor_ResetBMC_Call struct {
	*mock.Call
}

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

func (*MockOutofbandQueryor_ResetBMC_Call) Return added in v1.1.0

func (*MockOutofbandQueryor_ResetBMC_Call) Run added in v1.1.0

func (*MockOutofbandQueryor_ResetBMC_Call) RunAndReturn added in v1.1.0

type MockOutofbandQueryor_SetPowerState_Call added in v1.1.0

type MockOutofbandQueryor_SetPowerState_Call struct {
	*mock.Call
}

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

func (*MockOutofbandQueryor_SetPowerState_Call) Return added in v1.1.0

func (*MockOutofbandQueryor_SetPowerState_Call) Run added in v1.1.0

func (*MockOutofbandQueryor_SetPowerState_Call) RunAndReturn added in v1.1.0

type OutofbandQueryor added in v1.1.0

type OutofbandQueryor interface {
	// Open opens the connection to the device.
	Open(ctx context.Context) error

	// Close closes the connection to the device.
	Close(ctx context.Context) error

	PowerStatus(ctx context.Context) (status string, err error)

	SetPowerState(ctx context.Context, state string) error

	ResetBMC(ctx context.Context) error

	// Reinitializes the underlying device queryor client to purge old session information.
	ReinitializeClient(ctx context.Context)

	// Inventory returns the device inventory
	Inventory(ctx context.Context) (*common.Device, error)

	FirmwareInstallSteps(ctx context.Context, component string) ([]bconsts.FirmwareInstallStep, error)

	FirmwareUpload(ctx context.Context, component string, reader *os.File) (uploadVerifyTaskID string, err error)

	FirmwareTaskStatus(ctx context.Context, kind bconsts.FirmwareInstallStep, component, taskID, installVersion string) (state bconsts.TaskState, status string, err error)

	FirmwareInstallUploaded(ctx context.Context, component, uploadVerifyTaskID string) (installTaskID string, err error)

	FirmwareInstallUploadAndInitiate(ctx context.Context, component string, file *os.File) (taskID string, err error)
}

QueryorOutofband interface defines the out-of-band methods to query a device.

This is common interface to the ironlib and bmclib libraries.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL