datastructures

type BaseReport struct {
	CustomerGUID string    `json:"customerGUID"` // customerGUID as declared in environment
	Reporter     string    `json:"reporter"`     // component reporting the event
	Target       string    `json:"target"`       // wlid, cluster,etc. - which component this event is applicable on
	Status       string    `json:"status"`       // Action scope: Before action use "started", after action use "failure/success". Reporter scope: Before action use "started", after action use "done".
	ActionName   string    `json:"action"`       // Stage action. short description of the action to-be-done. When defining an action
	Errors       []string  `json:"errors,omitempty"`
	ActionID     string    `json:"actionID"`               // Stage counter of the E2E process. initialize at 1. The number is increased when sending job report
	ActionIDN    int       `json:"numSeq"`                 // The ActionID in number presentation
	JobID        string    `json:"jobID"`                  // UID received from the eventReceiver after first report (the initializing is part of the first report)
	ParentAction string    `json:"parentAction,omitempty"` // Parent JobID
	Details      string    `json:"details,omitempty"`      // Details of the action
	Timestamp    time.Time `json:"timestamp"`              //
	// contains filtered or unexported fields
}

type BaseReportMock struct {
	BaseReport `json:",inline"`
}

type IReporter interface {

	/*
		send the report
		@Output:
		int: http Status Code,
		string: message: can be jobID for successful 1st report or "OK" from 2nd report onwards or "body could not be fetched"
		error: error from event receiver
	*/
	Send() (int, string, error) //send logic here
	GetReportID() string
	/* a multiple errors can occur but these error are not critical,
	errorString will be added to a vector of errors so the error flow until the critical error will be clear
	*/
	AddError(errorString string)
	GetNextActionId() string
	NextActionID()
	/*
		SimpleReportAnnotations - create an object that can be passed on as annotation and serialize it.

		This objects can be shared between the different microservices processing the same workload.

		thus this will save the jobID,it's latest actionID.
		@Input:
		setParent- set parentJobID to the jobID
		setCurrent - set the jobID to the current jobID

		@returns:
		 jsonAsString, nextActionID
	*/
	SimpleReportAnnotations(setParent bool, setCurrent bool) (string, string)

	/*
		SendAsRoutine
		@input:
		collector []string - leave as empty (a way to hold all previous failed reports and send them in bulk)
		progressNext bool - increase actionID, sometimes u send parallel jobs that have the same order - (vuln scanning a cluster for eg. all wl scans have the same order)
		errChan - chan to allow the goroutine to return the errors inside
	*/
	SendAsRoutine(bool, chan<- error) //goroutine wrapper

	// set methods
	SendAction(action string, sendReport bool, errChan chan<- error)
	SendError(err error, sendReport bool, initErrors bool, errChan chan<- error)
	SendStatus(status string, sendReport bool, errChan chan<- error)
	SendDetails(details string, sendReport bool, errChan chan<- error)
	SendWarning(warning string, sendReport bool, initWarnings bool, errChan chan<- error)

	// set methods
	SetReporter(string)
	SetStatus(string)
	SetActionName(string)
	SetTarget(string)
	SetActionID(string)
	SetJobID(string)
	SetParentAction(string)
	SetTimestamp(time.Time)
	SetActionIDN(int)
	SetCustomerGUID(string)
	SetDetails(string)

	// get methods
	GetReporter() string
	GetStatus() string
	GetActionName() string
	GetTarget() string
	GetErrorList() []string
	GetActionID() string
	GetJobID() string
	GetParentAction() string
	GetTimestamp() time.Time
	GetActionIDN() int
	GetCustomerGUID() string
	GetDetails() string
}

type JobsAnnotations struct {
	/* jobID: context   eg. if a certain job has multiple stages
	  eg. attach namespace>attach wlid in ns
	  so obj when pod is cached should look like:
	  {
		  jobID#1: {
			"attach namespace"
		  }
	  }
	  - SHOULD BE RETHINK
	*/
	// JobIDsContex map[string]string `json:"jobIDsContex,omitempty"`
	CurrJobID    string `json:"jobID"`       //simplest case (for now till we have a better idea)
	ParentJobID  string `json:"parentJobID"` //simplest case (for now till we have a better idea)
	LastActionID string `json:"actionID"`    //simplest case (for now till we have a better idea) used to pass as defining ordering between multiple components
}

type StatusType string