managed

type ConnectionDetails map[string][]byte

type CrActualDiffObservation struct {
	// ResourceHasData can be true when a managed resource is created, but the
	// device had already data in that resource. The data needs to get aligned
	// with the intended resource data
	HasData bool
	// ResourceUpToDate should be true if the corresponding external resource
	// appears to be up-to-date with the resourceSpec
	IsUpToDate bool
	// when the resource is not up to date these 2 parameter determine what to do to realign the resource to the spec
	Deletes []*gnmi.Path
	Updates []*gnmi.Update
}

type CrObservation struct {
	// indicates if the device is exhausted or not, this can happen when too many api calls
	// occured towards the device
	Exhausted bool
	// indicates if the device in the proxy-cache is ready or not,
	// during proxy-cache initialization it can occur that the cache is not ready
	Ready bool
	// indicates if the MR is not yet reconciled, the reconciler should wait for further actions
	Pending bool
	// indicates if a MR exists in the proxy-cache
	Exists bool
	// indicates if the MR was not successfully applied to the device
	// unless the resourceSpec changes the transaction would not be successfull
	// we dont try to reconcile unless the spec changed
	Failed bool
	// Provides additional information why a MR is in failed status
	Message string
}

type CrSpecDiffObservation struct {
	// indicates if the spec was changed and subsequent actionsare required
	Deletes []*gnmi.Path
	Updates []*gnmi.Update
}

type CrSpecObservation struct {
	// validation was successfull
	Success bool
	// Provides additional information why a validation failured occured
	Message string
}

type ExternalClient interface {

	// Create an external resource per the specifications of the supplied
	// Managed resource. Called when thr diff reports that the associated
	// external resource does not exist.
	Create(ctx context.Context, mg resource.Managed, obs ExternalObservation) error

	// Update the external resource represented by the supplied Managed
	// resource, if necessary. Called when the diff reports that the
	// associated external resource is up to date.
	Update(ctx context.Context, mg resource.Managed, obs ExternalObservation) error

	// Delete the external resource upon deletion of its associated Managed
	// resource. Called when the managed resource has been deleted.
	Delete(ctx context.Context, mg resource.Managed, obs ExternalObservation) error

	// GetSystemConfig returns the system config for a particular device from
	// the system proxy cache
	GetSystemConfig(ctx context.Context, mg resource.Managed) (*ygotnddp.Device, error)

	// GetResourceName returns the running config for a particular device from
	// the running device proxy cache
	GetRunningConfig(ctx context.Context, mg resource.Managed) ([]byte, error)

	// Close the gnmi connection to the system proxy cache
	Close()
}

type ExternalClientFns struct {
	//ObserveFn          func(ctx context.Context, mg resource.Managed, runningCfg []byte) (ExternalObservation, error)
	CreateFn           func(ctx context.Context, mg resource.Managed, obs ExternalObservation) error
	UpdateFn           func(ctx context.Context, mg resource.Managed, obs ExternalObservation) error
	DeleteFn           func(ctx context.Context, mg resource.Managed, obs ExternalObservation) error
	GetSystemConfigFn  func(ctx context.Context, mg resource.Managed) (*ygotnddp.Device, error)
	GetRunningConfigFn func(ctx context.Context, mg resource.Managed) ([]byte, error)
	CloseFn            func()
}

type ExternalConnecter interface {
	// Connect to the provider specified by the supplied managed resource and
	// produce an ExternalClient.
	Connect(ctx context.Context, mg resource.Managed) (ExternalClient, error)
}

type ExternalConnectorFn func(ctx context.Context, mg resource.Managed) (ExternalClient, error)

type ExternalObservation struct {
	// HasData can be true when a managed resource is created, but the
	// device had already data in that resource. The data needs to get aligned
	// with the intended MR data
	HasData bool
	// IsUpToDate should be true if the corresponding MR
	// appears to be up-to-date with the cr spec
	IsUpToDate bool
	// when the resource is not up to date these 2 parameter determine what to do to realign
	// the external resource on the device to the cr spec
	Deletes []*gnmi.Path
	Updates []*gnmi.Update
}

type NopClient struct{}

type NopConnecter struct{}

type NopValidator struct{}

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

type ReconcilerOption func(*Reconciler)

type Validator interface {
	// GetCrStatus gets the status of the cr like pending, failed, not ready and also of the device is exhausted or not
	// this is used to trigger subsequent actions in the reconciler
	GetCrStatus(ctx context.Context, mg resource.Managed, systemCfg *ygotnddp.Device) (CrObservation, error)

	// ValidateCrSpecUpdate merges the running config and the new spec and validates the result.
	// If the result was not successfull the error message is returned to provide ctx of the error
	ValidateCrSpecUpdate(ctx context.Context, mg resource.Managed, runningCfg []byte) (CrSpecObservation, error)

	// ValidateCrSpecDelete deletes the rootPaths from the running config and validates the result.
	// If the result was not successfull the error message is returned to provide ctx of the error
	ValidateCrSpecDelete(ctx context.Context, mg resource.Managed, runningCfg []byte) (CrSpecObservation, error)

	// GetCrSpecDiff checks if the current cr spec differs from the original cr spec and triggers the necessary updates
	// to align the current cr spec with original spec. The method returns gnmi deletes and updates
	GetCrSpecDiff(ctx context.Context, mg resource.Managed, systemCfg *ygotnddp.Device) (CrSpecDiffObservation, error)

	// GetCrActualDiff checks if the current cr spec differs from the running config and triggers the necessary updates
	// to align the running config with the cr spec. The method returns gnmi deletes and updates
	GetCrActualDiff(ctx context.Context, mg resource.Managed, runningCfg []byte) (CrActualDiffObservation, error)

	// GetRootPaths returns the rootPaths of the current Spec
	GetRootPaths(ctx context.Context, mg resource.Managed) ([]string, error)
}

type ValidatorFn struct {
	GetCrStatusFn          func(ctx context.Context, mg resource.Managed, systemCfg *ygotnddp.Device) (CrObservation, error)
	ValidateCrSpecUpdateFn func(ctx context.Context, mg resource.Managed, runningCfg []byte) (CrSpecObservation, error)
	ValidateCrSpecDeleteFn func(ctx context.Context, mg resource.Managed, runningCfg []byte) (CrSpecObservation, error)
	GetCrSpecDiffFn        func(ctx context.Context, mg resource.Managed, systemCfg *ygotnddp.Device) (CrSpecDiffObservation, error)
	GetCrActualDiffFn      func(ctx context.Context, mg resource.Managed, runningCfg []byte) (CrActualDiffObservation, error)
	GetRootPathsFn         func(ctx context.Context, mg resource.Managed) ([]string, error)
}