Support Custom labels and annotations to be added to Pod template of a Gatling runner job (#63)

* Add label to Gatling job manifest

* delete commentout code

* delete Unnecessary code

* Add annotation to Gatling job manifest

* add labels & annotation Report Available

* fix code

* add runner label & reporter label

* fix code

* fix delete space

* Added behavior when label does not exist

* Add label to type even when label does not exist

* Move Add_labels_pods function to utils.go

* fix code

* fix code

* fix code

* add map linkage

* fix comment

* fix code

* fix ci test

* Update pkg/utils/utils.go

fix Streamlining the code

Co-authored-by: Yoichi Kawasaki <yokawasa@gmail.com>

* fix parameters

Co-authored-by: Yoichi Kawasaki <yokawasa@gmail.com>

Author: S-mishina

controllers/gatling_controller.go

@@ -81,7 +81,7 @@ func (r *GatlingReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
 	log.Info("Reconciling Gatling")
 	// r.dumpGatlingStatus(gatling, log)
 	if r.isGatlingCompleted(gatling) {
-		log.Info("Gatling job has completed!", "name", gatling.ObjectMeta.Name, "namespace", gatling.ObjectMeta.Namespace)
+		log.Info("Gatling job has completed!", "name", r.getObjectMeta(gatling).Name, "namespace", r.getObjectMeta(gatling).Namespace)
 
 		// Clean up Job resources if neccessary
 		if gatling.Spec.CleanupAfterJobDone {
@@ -458,6 +458,11 @@ func (r *GatlingReconciler) newGatlingRunnerJobForCR(gatling *gatlingv1alpha1.Ga
 				Parallelism: r.getGatlingRunnerJobParallelism(gatling),
 				Completions: r.getGatlingRunnerJobParallelism(gatling),
 				Template: corev1.PodTemplateSpec{
+					ObjectMeta: metav1.ObjectMeta{
+						Name:        r.getObjectMeta(gatling).Name,
+						Labels:      utils.AddMapValue("type", "runner", r.getObjectMeta(gatling).Labels, true),
+						Annotations: r.getObjectMeta(gatling).Annotations,
+					},
 					Spec: corev1.PodSpec{
 						Affinity:           r.getPodAffinity(gatling),
 						Tolerations:        r.getPodTolerations(gatling),
@@ -519,6 +524,11 @@ func (r *GatlingReconciler) newGatlingRunnerJobForCR(gatling *gatlingv1alpha1.Ga
 			Parallelism: &gatling.Spec.TestScenarioSpec.Parallelism,
 			Completions: &gatling.Spec.TestScenarioSpec.Parallelism,
 			Template: corev1.PodTemplateSpec{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:        r.getObjectMeta(gatling).Name,
+					Labels:      utils.AddMapValue("type", "runner", r.getObjectMeta(gatling).Labels, true),
+					Annotations: r.getObjectMeta(gatling).Annotations,
+				},
 				Spec: corev1.PodSpec{
 					Affinity:           r.getPodAffinity(gatling),
 					Tolerations:        r.getPodTolerations(gatling),
@@ -588,6 +598,11 @@ func (r *GatlingReconciler) newGatlingReporterJobForCR(gatling *gatlingv1alpha1.
 		},
 		Spec: batchv1.JobSpec{
 			Template: corev1.PodTemplateSpec{
+				ObjectMeta: metav1.ObjectMeta{
+					Name:        r.getObjectMeta(gatling).Name,
+					Labels:      utils.AddMapValue("type", "reporter", r.getObjectMeta(gatling).Labels, true),
+					Annotations: r.getObjectMeta(gatling).Annotations,
+				},
 				Spec: corev1.PodSpec{
 					Affinity:           r.getPodAffinity(gatling),
 					Tolerations:        r.getPodTolerations(gatling),
@@ -922,6 +937,14 @@ func (r *GatlingReconciler) getPodResources(gatling *gatlingv1alpha1.Gatling) co
 	return resources
 }
 
+func (r *GatlingReconciler) getObjectMeta(gatling *gatlingv1alpha1.Gatling) *metav1.ObjectMeta {
+	objectmeta := metav1.ObjectMeta{}
+	if &gatling != nil && &gatling.ObjectMeta != nil {
+		objectmeta = gatling.ObjectMeta
+	}
+	return &objectmeta
+}
+
 func (r *GatlingReconciler) getPodAffinity(gatling *gatlingv1alpha1.Gatling) *corev1.Affinity {
 	affinity := corev1.Affinity{}
 	if &gatling.Spec.PodSpec != nil && &gatling.Spec.PodSpec.Affinity != nil {

pkg/utils/utils.go

@@ -23,3 +23,16 @@ func GetMapValue(key string, dataMap map[string][]byte) (string, bool) {
 	}
 	return "", false
 }
+
+// Add key-value to map
+func AddMapValue(key string, value string, dataMap map[string]string, overwrite bool) map[string]string {
+	if _, ok := dataMap[key]; ok && !overwrite {
+		return dataMap
+	}
+	if dataMap == nil {
+		dataMap = map[string]string{}
+	}
+	dataMap[key] = value
+	return dataMap
+
+}