recovery

Documentation

Overview

Package recovery provides ability to run recovery tasks against on the target units.

Index

• Constants
• func NewLocalTLWAccess(ufs localtlw.UFSClient, csac localtlw.CSAClient) (tlw.Access, error)
• func Run(ctx context.Context, args *RunArgs) error
• type RunArgs

Constants

const (
	PlanRepairDUT        = "repair_dut"
	PlanRepairServo      = "repair_servo"
	PlanRepairLabstation = "repair_labstation"
	PlanRepairJetstream  = "repair_jetstream"
)

List of predefined plans. TODO(otabek@): Update list of plans and mapping with final version.

Functions

func NewLocalTLWAccess

func NewLocalTLWAccess(ufs localtlw.UFSClient, csac localtlw.CSAClient) (tlw.Access, error)

NewLocalTLWAccess provides instance of local implementation of TLW Access.

func Run

func Run(ctx context.Context, args *RunArgs) error

Run runs the recovery tasks against the provide unit. Process includes:

• Verification of input data.
• Set logger.
• Collect DUTs info.
• Load execution plan for required task with verification.
• Send DUTs info to inventory.

Types

type RunArgs

type RunArgs struct {
	Access tlw.Access
	// UnitName represents some device setup against which running some tests or task in the system.
	// The unit can be represented as a single DUT or group of the DUTs registered in inventory as single unit.
	UnitName string
	// Provide access to read custom plans outside recovery. The default plans with actions will be ignored.
	ConfigReader io.Reader
	// Logger prints message to the logs.
	Logger logger.Logger
}

RunArgs holds input arguments for recovery process.