Issue fabric8-services#143 Improving handling of OpenShift events

internal/api/api.go

@@ -26,12 +26,8 @@ type IdlerAPI interface {
 	// If an error occurs a response with the HTTP status 500 is returned.
 	IsIdle(w http.ResponseWriter, r *http.Request, ps httprouter.Params)
 
-	// User writes a JSON representation of the User struct to the HTTP response.
-	// If no namespace parameter is specified all Users are included into the response. If the namespace
-	// parameter is set only the user with the specified namespace gets added to the response.
-	//
-	// NOTE: This endpoint is for debugging purposes and will be removed at some stage.
-	User(w http.ResponseWriter, r *http.Request, ps httprouter.Params)
+	// Info writes a JSON representation of internal state of the specified namespace to the response writer.
+	Info(w http.ResponseWriter, r *http.Request, ps httprouter.Params)
 }
 
 type idler struct {
@@ -87,7 +83,7 @@ func (api *idler) IsIdle(w http.ResponseWriter, r *http.Request, ps httprouter.P
 	json.NewEncoder(w).Encode(s)
 }
 
-func (api *idler) User(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
+func (api *idler) Info(w http.ResponseWriter, r *http.Request, ps httprouter.Params) {
 	w.Header().Set("Content-Type", "application/json")
 	ns := ps.ByName("namespace")
 

internal/idler/user_idler.go

@@ -103,14 +103,14 @@ func (idler *UserIdler) Run(wg *sync.WaitGroup, ctx context.Context, cancel cont
 				cancel()
 				return
 			case idler.user = <-idler.userChan:
-				idler.logger.WithField("data", idler.user.String()).Debug("Received user data.")
+				idler.logger.WithField("state", idler.user.String()).Debug("Received user data.")
 
 				err := idler.checkIdle()
 				if err != nil {
 					idler.logger.WithField("error", err.Error()).Warn("Error during idle check.")
 				}
 			case <-ticker:
-				idler.logger.Info("Time based idle check.")
+				idler.logger.WithField("state", idler.user.String()).Info("Time based idle check.")
 				idler.resetCounters()
 				err := idler.checkIdle()
 				if err != nil {

internal/model/openshift_objects.go

@@ -146,7 +146,7 @@ func (s DCStatus) GetByType(t string) (Condition, error) {
 		}
 	}
 
-	return Condition{}, fmt.Errorf("Could not find condition '%s'", t)
+	return Condition{}, fmt.Errorf("could not find condition '%s'", t)
 }
 
 var Phases = map[string]int{

internal/model/user.go

@@ -13,16 +13,9 @@ type User struct {
 	ID                string
 	ActiveBuild       Build
 	DoneBuild         Build
-	JenkinsStateList  []JenkinsState
 	JenkinsLastUpdate time.Time
 }
 
-type JenkinsState struct {
-	Running bool
-	Time    time.Time
-	Message string
-}
-
 func NewUser(id string, name string) User {
 	return User{
 		ID:          id,

internal/openshift/client/openshift_client.go

@@ -338,7 +338,7 @@ func (o OpenShift) WatchBuilds(namespace string, buildType string, callback func
 				logger.WithField("namespace", o.Object.Metadata.Namespace).Debugf("Skipping build %s (type: %s)", o.Object.Metadata.Name, o.Object.Spec.Strategy.Type)
 				continue
 			}
-			logger.WithField("namespace", o.Object.Metadata.Namespace).Debug("Handling Build change event")
+			logger.WithFields(log.Fields{"namespace": o.Object.Metadata.Namespace, "data": o}).Debug("Handling Build change event")
 			err = callback(o)
 			if err != nil {
 				logger.Errorf("Error from callback: %s", err)
@@ -402,7 +402,7 @@ func (o OpenShift) WatchDeploymentConfigs(namespace string, nsSuffix string, cal
 				continue
 			}
 
-			logger.WithField("namespace", o.Object.Metadata.Namespace).Debug("Handling DC change event")
+			logger.WithFields(log.Fields{"namespace": o.Object.Metadata.Namespace, "data": o}).Debug("Handling DC change event")
 			err = callback(o)
 			if err != nil {
 				logger.Errorf("Error from DC callback: %s", err)

internal/openshift/controller.go

@@ -69,9 +69,7 @@ func (oc *OpenShiftController) GetUser(ns string) model.User {
 // just does couple comparisons and returns
 func (oc *OpenShiftController) HandleBuild(o model.Object) error {
 	ns := o.Object.Metadata.Namespace
-	logger.WithField("ns", ns).Infof("Processing build event '%s'", o.Object.Metadata.Name)
-
-	err := oc.createIfNotExist(o.Object.Metadata.Namespace)
+	err := oc.createIfNotExist(ns)
 	if err != nil {
 		return err
 	}
@@ -112,8 +110,6 @@ func (oc *OpenShiftController) HandleBuild(o model.Object) error {
 // of ConfigChange or manual intervention.
 func (oc *OpenShiftController) HandleDeploymentConfig(dc model.DCObject) error {
 	ns := dc.Object.Metadata.Namespace[:len(dc.Object.Metadata.Namespace)-len(jenkinsNamespaceSuffix)]
-	logger.WithField("ns", ns).Infof("Processing deployment config change event '%s'", dc.Object.Metadata.Name)
-
 	err := oc.createIfNotExist(ns)
 	if err != nil {
 		return err

internal/router/router.go

@@ -77,8 +77,8 @@ func (r *Router) Shutdown() {
 func CreateAPIRouter(api api.IdlerAPI) *httprouter.Router {
 	router := httprouter.New()
 
-	router.GET("/iapi/idler/builds/:namespace", api.User)
-	router.GET("/iapi/idler/builds/:namespace/", api.User)
+	router.GET("/iapi/idler/info/:namespace", api.Info)
+	router.GET("/iapi/idler/info/:namespace/", api.Info)
 
 	router.GET("/iapi/idler/idle/:namespace", api.Idle)
 	router.GET("/iapi/idler/idle/:namespace/", api.Idle)

scripts/setupLocalIdler.sh

@@ -187,7 +187,7 @@ setTokens() {
 #   None
 ###############################################################################
 login() {
-    [ -z "${DSAAS_PREVIEW_TOKEN}" ] && echo "DSAAS_PREVIEW_TOKEN needs to be exported." && printHelp && exit 1
+    [ -z "${DSAAS_PREVIEW_TOKEN}" ] && echo "DSAAS_PREVIEW_TOKEN needs to be exported." && exit 1
 
     loc login https://api.rh-idev.openshift.com -n dsaas-preview --token=${DSAAS_PREVIEW_TOKEN} >/dev/null
 }
@@ -202,7 +202,7 @@ login() {
 #   None
 ###############################################################################
 start() {
-    [ -z "${DSAAS_PREVIEW_TOKEN}" ] && echo "DSAAS_PREVIEW_TOKEN needs to be exported." && printHelp && exit 1
+    [ -z "${DSAAS_PREVIEW_TOKEN}" ] && echo "DSAAS_PREVIEW_TOKEN needs to be exported." && exit 1
 
     login
     forwardProxyService &
@@ -220,8 +220,8 @@ start() {
 #   None
 ###############################################################################
 env() {
-    [ -z "${DSAAS_PREVIEW_TOKEN}" ] && echo "DSAAS_PREVIEW_TOKEN needs to be exported." && printHelp && exit 1
-    [ -z "${JC_FIXED_UUIDS}" ] && echo "JC_FIXED_UUID needs to be exported." && printHelp && exit 1
+    [ -z "${DSAAS_PREVIEW_TOKEN}" ] && echo "DSAAS_PREVIEW_TOKEN needs to be exported." && exit 1
+    [ -z "${JC_FIXED_UUIDS}" ] && echo "JC_FIXED_UUIDS needs to be exported." && exit 1
 
     login
     setTokens