- Move common interfaces and structures to the 'common' folder

- Update tests

Signed-off-by: Valery Piashchynski <[email protected]>

5 files changed, 90 insertions, 4 deletions

diff --git a/pkg/events/general.go b/pkg/events/general.go
index a09a8759..5cf13e10 100755
--- a/pkg/events/general.go
+++ b/pkg/events/general.go
@@ -4,6 +4,8 @@ import (
 	"sync"
 )
 
+const UnknownEventType string = "Unknown event type"
+
 // HandlerImpl helps to broadcast events to multiple listeners.
 type HandlerImpl struct {
 	listeners    []Listener
diff --git a/pkg/events/interface.go b/pkg/events/interface.go
index ac6c15a4..7d57e4d0 100644
--- a/pkg/events/interface.go
+++ b/pkg/events/interface.go
@@ -2,7 +2,7 @@ package events
 
 // Handler interface
 type Handler interface {
-	// Return number of active listeners
+	// NumListeners return number of active listeners
 	NumListeners() int
 	// AddListener adds lister to the publisher
 	AddListener(listener Listener)
@@ -10,5 +10,5 @@ type Handler interface {
 	Push(e interface{})
 }
 
-// Event listener listens for the events produced by worker, worker pool or other service.
+// Listener .. (type alias) event listener listens for the events produced by worker, worker pool or other service.
 type Listener func(event interface{})
diff --git a/pkg/events/jobs_events.go b/pkg/events/jobs_events.go
new file mode 100644
index 00000000..ed07c7da
--- /dev/null
+++ b/pkg/events/jobs_events.go
@@ -0,0 +1,84 @@
+package events
+
+import (
+	"time"
+)
+
+const (
+	// EventPushOK thrown when new job has been added. JobEvent is passed as context.
+	EventPushOK = iota + 12000
+
+	// EventPushError caused when job can not be registered.
+	EventPushError
+
+	// EventJobStart thrown when new job received.
+	EventJobStart
+
+	// EventJobOK thrown when job execution is successfully completed. JobEvent is passed as context.
+	EventJobOK
+
+	// EventJobError thrown on all job related errors. See JobError as context.
+	EventJobError
+
+	// EventPipeConsume when pipeline pipelines has been requested.
+	EventPipeConsume
+
+	// EventPipeActive when pipeline has started.
+	EventPipeActive
+
+	// EventPipeStop when pipeline has begun stopping.
+	EventPipeStop
+
+	// EventPipeStopped when pipeline has been stopped.
+	EventPipeStopped
+
+	// EventPipeError when pipeline specific error happen.
+	EventPipeError
+
+	// EventBrokerReady thrown when broken is ready to accept/serve tasks.
+	EventBrokerReady
+)
+
+type J int64
+
+func (ev J) String() string {
+	switch ev {
+	case EventPushOK:
+		return "EventPushOK"
+	case EventPushError:
+		return "EventPushError"
+	case EventJobStart:
+		return "EventJobStart"
+	case EventJobOK:
+		return "EventJobOK"
+	case EventJobError:
+		return "EventJobError"
+	case EventPipeConsume:
+		return "EventPipeConsume"
+	case EventPipeActive:
+		return "EventPipeActive"
+	case EventPipeStop:
+		return "EventPipeStop"
+	case EventPipeStopped:
+		return "EventPipeStopped"
+	case EventPipeError:
+		return "EventPipeError"
+	case EventBrokerReady:
+		return "EventBrokerReady"
+	}
+	return UnknownEventType
+}
+
+// JobEvent represent job event.
+type JobEvent struct {
+	Event J
+	// String is job id.
+	ID string
+
+	// Job is failed job.
+	Job interface{} // this is *jobs.Job, but interface used to avoid package import
+
+	// event timings
+	Start   time.Time
+	Elapsed time.Duration
+}
diff --git a/pkg/events/pool_events.go b/pkg/events/pool_events.go
index e7b451e0..4d4cae5d 100644
--- a/pkg/events/pool_events.go
+++ b/pkg/events/pool_events.go
@@ -57,7 +57,7 @@ func (ev P) String() string {
 	case EventPoolRestart:
 		return "EventPoolRestart"
 	}
-	return "Unknown event type"
+	return UnknownEventType
 }
 
 // PoolEvent triggered by pool on different events. Pool as also trigger WorkerEvent in case of log.
diff --git a/pkg/events/worker_events.go b/pkg/events/worker_events.go
index 11bd6ab7..39c38e57 100644
--- a/pkg/events/worker_events.go
+++ b/pkg/events/worker_events.go
@@ -20,7 +20,7 @@ func (ev W) String() string {
 	case EventWorkerStderr:
 		return "EventWorkerStderr"
 	}
-	return "Unknown event type"
+	return UnknownEventType
 }
 
 // WorkerEvent wraps worker events.