Extended scheduled job status messages (#603)

* Extended scheduled job status messages

* Extended scheduled job status messages

* Extended scheduled job status messages

* Extended scheduled job status messages

* Extended scheduled job and pods status messages with event message

* Generated swagger

* Fixing unit-tests

* Fixing unit-tests

* Fixing unit-tests

* Cleanup

* Updated versions, fixed unit-test

api/alerting/handler.go

@@ -9,11 +9,11 @@ import (
 	alertModels "github.com/equinor/radix-api/api/alerting/models"
 	"github.com/equinor/radix-api/api/utils/labelselector"
 	"github.com/equinor/radix-api/models"
+	"github.com/equinor/radix-common/utils"
 	operatoralert "github.com/equinor/radix-operator/pkg/apis/alert"
 	"github.com/equinor/radix-operator/pkg/apis/kube"
 	radixv1 "github.com/equinor/radix-operator/pkg/apis/radix/v1"
 	crdutils "github.com/equinor/radix-operator/pkg/apis/utils"
-	"github.com/equinor/radix-operator/pkg/apis/utils/slice"
 	corev1 "k8s.io/api/core/v1"
 	kubeErrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -195,7 +195,7 @@ func (h *handler) validateUpdateAlertingConfig(config *alertModels.UpdateAlertin
 			return InvalidAlertReceiverError(alert.Alert, alert.Receiver)
 		}
 		// Verify alert name is valid
-		if !slice.ContainsString(h.validAlertNames, alert.Alert) {
+		if !utils.ContainsString(h.validAlertNames, alert.Alert) {
 			return InvalidAlertError(alert.Alert)
 		}
 	}

api/deployments/component_handler.go

@@ -5,9 +5,12 @@ import (
 	"strings"
 
 	deploymentModels "github.com/equinor/radix-api/api/deployments/models"
+	"github.com/equinor/radix-api/api/kubequery"
 	"github.com/equinor/radix-api/api/utils"
+	"github.com/equinor/radix-api/api/utils/event"
 	"github.com/equinor/radix-api/api/utils/labelselector"
 	radixutils "github.com/equinor/radix-common/utils"
+	"github.com/equinor/radix-common/utils/slice"
 	"github.com/equinor/radix-operator/pkg/apis/defaults"
 	"github.com/equinor/radix-operator/pkg/apis/deployment"
 	"github.com/equinor/radix-operator/pkg/apis/kube"
@@ -169,7 +172,12 @@ func GetComponentStateFromSpec(
 		}
 		componentPodNames = getPodNames(componentPods)
 		environmentVariables = getRadixEnvironmentVariables(componentPods)
-		replicaSummaryList = getReplicaSummaryList(componentPods)
+		eventList, err := kubequery.GetEventsForEnvironment(ctx, kubeClient, appName, deployment.Environment)
+		if err != nil {
+			return nil, err
+		}
+		lastEventWarnings := event.ConvertToEventWarnings(eventList)
+		replicaSummaryList = getReplicaSummaryList(componentPods, lastEventWarnings)
 		auxResource, err = getAuxiliaryResources(ctx, kubeClient, appName, component, envNs)
 		if err != nil {
 			return nil, err
@@ -305,14 +313,10 @@ func getRadixEnvironmentVariables(pods []corev1.Pod) map[string]string {
 	return radixEnvironmentVariables
 }
 
-func getReplicaSummaryList(pods []corev1.Pod) []deploymentModels.ReplicaSummary {
-	replicaSummaryList := make([]deploymentModels.ReplicaSummary, 0, len(pods))
-
-	for _, pod := range pods {
-		replicaSummaryList = append(replicaSummaryList, deploymentModels.GetReplicaSummary(pod))
-	}
-
-	return replicaSummaryList
+func getReplicaSummaryList(pods []corev1.Pod, lastEventWarnings event.LastEventWarnings) []deploymentModels.ReplicaSummary {
+	return slice.Map(pods, func(pod corev1.Pod) deploymentModels.ReplicaSummary {
+		return deploymentModels.GetReplicaSummary(pod, lastEventWarnings[pod.GetName()])
+	})
 }
 
 func getAuxiliaryResources(ctx context.Context, kubeClient kubernetes.Interface, appName string, component v1.RadixCommonDeployComponent, envNamespace string) (auxResource deploymentModels.AuxiliaryResource, err error) {
@@ -357,7 +361,7 @@ func getAuxiliaryResourceDeployment(ctx context.Context, kubeClient kubernetes.I
 	if err != nil {
 		return nil, err
 	}
-	auxResourceDeployment.ReplicaList = getReplicaSummaryList(pods.Items)
+	auxResourceDeployment.ReplicaList = getReplicaSummaryList(pods.Items, nil)
 	auxResourceDeployment.Status = deploymentModels.ComponentStatusFromDeployment(&deployment).String()
 	return &auxResourceDeployment, nil
 }

api/deployments/models/component_deployment.go

@@ -6,6 +6,7 @@ import (
 	"strings"
 
 	radixutils "github.com/equinor/radix-common/utils"
+	"github.com/equinor/radix-common/utils/pointers"
 	corev1 "k8s.io/api/core/v1"
 )
 
@@ -280,7 +281,19 @@ type ReplicaSummary struct {
 	//
 	// required: false
 	// example: 2006-01-02T15:04:05Z
-	Created string `json:"created"`
+	Created string `json:"created,omitempty"`
+
+	// The time at which the batch job's pod startedAt
+	//
+	// required: false
+	// example: 2006-01-02T15:04:05Z
+	StartTime string `json:"startTime,omitempty"`
+
+	// The time at which the batch job's pod finishedAt.
+	//
+	// required: false
+	// example: 2006-01-02T15:04:05Z
+	EndTime string `json:"endTime,omitempty"`
 
 	// Container started timestamp
 	//
@@ -291,47 +304,58 @@ type ReplicaSummary struct {
 	// Status describes the component container status
 	//
 	// required: false
-	Status ReplicaStatus `json:"replicaStatus"`
+	Status ReplicaStatus `json:"replicaStatus,omitempty"`
 
 	// StatusMessage provides message describing the status of a component container inside a pod
 	//
 	// required: false
-	StatusMessage string `json:"statusMessage"`
+	StatusMessage string `json:"statusMessage,omitempty"`
 
 	// RestartCount count of restarts of a component container inside a pod
 	//
 	// required: false
-	RestartCount int32 `json:"restartCount"`
+	RestartCount int32 `json:"restartCount,omitempty"`
 
 	// The image the container is running.
 	//
 	// required: false
 	// example: radixdev.azurecr.io/app-server:cdgkg
-	Image string `json:"image"`
+	Image string `json:"image,omitempty"`
 
 	// ImageID of the container's image.
 	//
 	// required: false
 	// example: radixdev.azurecr.io/app-server@sha256:d40cda01916ef63da3607c03785efabc56eb2fc2e0dab0726b1a843e9ded093f
-	ImageId string `json:"imageId"`
+	ImageId string `json:"imageId,omitempty"`
+
+	// The index of the pod in the re-starts
+	PodIndex int `json:"podIndex,omitempty"`
+
+	// Exit status from the last termination of the container
+	ExitCode int32 `json:"exitCode"`
+
+	// A brief CamelCase message indicating details about why the job is in this phase
+	Reason string `json:"reason,omitempty"`
 
 	// Resources Resource requirements for the pod
 	//
 	// required: false
-	Resources ResourceRequirements `json:"resources,omitempty"`
+	Resources *ResourceRequirements `json:"resources,omitempty"`
 }
 
 // ReplicaStatus describes the status of a component container inside a pod
 // swagger:model ReplicaStatus
 type ReplicaStatus struct {
 	// Status of the container
 	// - Pending = Container in Waiting state and the reason is ContainerCreating
-	// - Failing = Container in Waiting state and the reason is anything else but ContainerCreating
+	// - Failed = Container is failed
+	// - Failing = Container is failed
 	// - Running = Container in Running state
+	// - Succeeded = Container in Succeeded state
 	// - Terminated = Container in Terminated state
 	//
 	// required: true
-	// enum: Pending,Failing,Running,Terminated,Starting
+	// enum: Pending,Succeeded,Failing,Failed,Running,Terminated,Starting
 	// example: Running
 	Status string `json:"status"`
 }
@@ -396,7 +420,7 @@ type ResourceRequirements struct {
 	Requests Resources `json:"requests,omitempty"`
 }
 
-func GetReplicaSummary(pod corev1.Pod) ReplicaSummary {
+func GetReplicaSummary(pod corev1.Pod, lastEventWarning string) ReplicaSummary {
 	replicaSummary := ReplicaSummary{}
 	replicaSummary.Name = pod.GetName()
 	creationTimestamp := pod.GetCreationTimestamp()
@@ -450,7 +474,10 @@ func GetReplicaSummary(pod corev1.Pod) ReplicaSummary {
 	replicaSummary.Image = containerStatus.Image
 	replicaSummary.ImageId = containerStatus.ImageID
 	if len(pod.Spec.Containers) > 0 {
-		replicaSummary.Resources = ConvertResourceRequirements(pod.Spec.Containers[0].Resources)
+		replicaSummary.Resources = pointers.Ptr(ConvertResourceRequirements(pod.Spec.Containers[0].Resources))
+	}
+	if len(replicaSummary.StatusMessage) == 0 && (replicaSummary.Status.Status == Failing.String() || replicaSummary.Status.Status == Pending.String()) {
+		replicaSummary.StatusMessage = lastEventWarning
 	}
 	return replicaSummary
 }

api/deployments/models/deployment_builder.go

@@ -4,12 +4,11 @@ import (
 	"errors"
 	"time"
 
-	"github.com/equinor/radix-common/utils/slice"
-	crdUtils "github.com/equinor/radix-operator/pkg/apis/utils"
-
 	radixutils "github.com/equinor/radix-common/utils"
+	"github.com/equinor/radix-common/utils/slice"
 	"github.com/equinor/radix-operator/pkg/apis/kube"
 	v1 "github.com/equinor/radix-operator/pkg/apis/radix/v1"
+	crdUtils "github.com/equinor/radix-operator/pkg/apis/utils"
 )
 
 // DeploymentBuilder Builds DTOs

api/deployments/models/scheduled_batch.go

@@ -30,7 +30,7 @@ type ScheduledJobSummary struct {
 	// Status of the job
 	//
 	// required: true
-	// enum: Running,Succeeded,Failed,Waiting,Stopping,Stopped
+	// enum: Running,Active,Succeeded,Failed,Waiting,Stopping,Stopped
 	// example: Waiting
 	Status string `json:"status"`
 

api/environments/environment_controller.go

@@ -1135,6 +1135,11 @@ func (c *environmentController) GetScheduledJobLog(accounts models.Accounts, w h
 	//   description: Name of scheduled job
 	//   type: string
 	//   required: true
+	// - name: replicaName
+	//   in: query
+	//   description: Name of the job replica
+	//   type: string
+	//   required: false
 	// - name: sinceTime
 	//   in: query
 	//   description: Get log only from sinceTime (example 2020-03-18T07:20:41+00:00)
@@ -1173,6 +1178,7 @@ func (c *environmentController) GetScheduledJobLog(accounts models.Accounts, w h
 	appName := mux.Vars(r)["appName"]
 	envName := mux.Vars(r)["envName"]
 	scheduledJobName := mux.Vars(r)["scheduledJobName"]
+	replicaName := r.FormValue("replicaName")
 
 	since, asFile, logLines, err, _ := logs.GetLogParams(r)
 	if err != nil {
@@ -1181,7 +1187,7 @@ func (c *environmentController) GetScheduledJobLog(accounts models.Accounts, w h
 	}
 
 	eh := c.environmentHandlerFactory(accounts)
-	logs, err := eh.GetScheduledJobLogs(r.Context(), appName, envName, scheduledJobName, &since, logLines)
+	logs, err := eh.GetScheduledJobLogs(r.Context(), appName, envName, scheduledJobName, replicaName, &since, logLines)
 	if err != nil {
 		c.ErrorResponse(w, r, err)
 		return