Merge pull request #65 from st-tech/update-gatling-runner-pod

Modify Gatling Runner Pod’s Multi-Containers Structure to make gatling-runner run as main container

Author: yokawasa

assets/gatling-operator-pod-before-v0.8.1.svg

@@ -1 +1 @@
-<mxfile host="Electron" modified="2022-01-31T00:23:21.667Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_16_0) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/12.4.2 Chrome/78.0.3904.130 Electron/7.1.4 Safari/537.36" etag="nv17sorJ1h5sI8vYcWfk" version="12.4.2" type="device" pages="1"><diagram id="T8mv4ZMTSljegyqvK_3A" name="ページ1">5Vrbdps4FP0ar5U+uAuBwfZjYyedSzptx2tymTcFZEyLkSNEbObrR0ICIQSOk/ElySQPkbYuyGfvc3Q4Ts+ZLDefCVwtvuAAxT3bCjY9Z9qzbTAY2+wPR3KJOO5IICGJAokpYBb9gyRoSTSLApRqEynGMY1WOujjJEE+1TBICF7r0+Y41p+6gqF8oqWAmQ9jZEy7iQK6EOjIHir8FxSFi/LJwBuLkSUsJ8uN0wUM8LoGORc9Z0IwpqK13ExQzK1X2kWsu+wYrQ5GUEJ3WZBcbx7+uryxbs4hzNd/DPLb1e992xPbPMI4k59YnpbmpQkIzpIA8V2snnO+XkQUzVbQ56NrxjrDFnQZsx5gzZQS/LMylUImOMak2M/xih82Mo/iuIbPXf7L8ACmi+J5fPkcJ7Q2SfwwXJ4bEYo2nRYBlZ2ZQhFeIkpyNkUu6NsDyU1eAqXs1oprz3IEtqjzPJQTodRXWO2uKGANycIzGAGjIzOS4ASZZEwmF+7l5b7sDIa6nYFr2tkpHUWzs7UHO48eqDdbOL9dO3+nt8vv6Y/b5GsftJjZiyk3zwommr29h4w76bkvzPOJDZLw/sxlW7DTscdbWvMDb3PDWQUz/VRQw5clmCxhrHZkrZD/nS2YMQM24RrH2RKVJ7kn5YQztFzRfBqRD+ZYiTAziKOXcEM1LACteNPP44jJhzwtnXuhs6v7CoD+z7BQ39eMsl1Qq8aUexoaaVFSp2w8VxONbUoGgBbJjA/lmc7BHVMLfLt46dS9GE0H+/FS4ICnndQG9oGctD0YWoaJUcDuZ9nFhC5wiBMYXyj0XCdBzbnCeCVt+wNRmstkA2YU68Qwg5H8Vq4vOne889Etu9NNfXCay55JqDg9P/J2UtgnxBnx0RZTDGTyA0mI6JZ5bjvJBMWQRo/6OfbO18BwkRDyOBH215D5AtniMOC5DrOvJACMm5dTW6Rpu5zcg8keGIY6guwPKl93R/l6p5RvGdxObXc/I4+VUxyWhO7c6FQkuJ0xhGTsHe9VxpDB6wshzgukrOnuALpWF6u6S++0q7T9YkWbiNaWsd5duSNrq0W8U67Zo9t4R3IbufQbjtgJVV42cnRx2Q3NiHPJVQ3ZVMd4uZLs0StU0mHZbZ03PmVQNMs0VVBEaRbTPiUwSeeIvMr4CIYNCbfGR+eY8XFoGLR8jeYFp9bXfz7QTwuN8nd54K425pv8r0nEV0/YXMjej0laezsXO3e8nXMtX8F7FOt8wDgKE9b2mamLV3ZOROTD+JMcWEZBIPIQxM4G74v9uJ+teEAozOae99zpNiZl8VQu7tVqoTvfgEPw0W1w7DnPDnXaDra+HM/nKTpIhGuruD1RCtpJC1+YArq0sLVS87a1YDujphIGb0QJ4+cr4XBFwUmMM14TnFFMYIjSN1L566rqb/ke4HAl/sFAv3lOXkSsyqBKYjeEUcGgz+JGL3IKfqezBrMl571BJzMHbbu1t9QKJbR7BGnTh57H/Rd2VInRoGPUwkYz490fG2bB6k8Eg24y3iEX5QK3GbWHJ+bGLARM8Cr/P3LjjDydm4EZxo7KTZmqt1yUQfTYvJ70u0leYk1g17Sb2a0l1fqGg85Eu4KNZxr3ZgVrn+Ldyqr57bcFDFkNh8eUlXk5+mXybJbE3w0PfTBu+Ddwxi15yuiYVNjdVDw3KYZnVpUJt7ZUclw4+xwuozgXy5c4wSJX1qaoeFCEg+7UuuDMCBc9223+05LLjMPR4h9yql5pLLcwF0OmvM0P7nLzuMzGT80F1dxSEi/axlbbCE6qkbqLlFMEJdWUwlVYTzgLh0HRrTsMRwv/4APKaTRYOA6HpOtwUHcePijdhw/WHIiPCDpc5UQctAqk9vmEM+1iwWqoMp5yL5c7WDWzPx6rbXKFO8Pa9sLd1O7c5cox6XaKEMUed78KD2sHaHJbdCuC66AuOznP0Odur3vvJzAa36ucPi6a/wVS+Z/5lcu7YQIMm9W9lhR0X0z0pDvUSjvKEZyLfwE=</diagram></mxfile>
+<mxfile host="Electron" modified="2022-11-13T11:56:38.076Z" agent="5.0 (Macintosh; Intel Mac OS X 12_6_0) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/14.6.13 Chrome/89.0.4389.128 Electron/12.0.7 Safari/537.36" etag="1Q8QceXm8HZWomG-fEl9" version="14.6.13" type="device"><diagram id="T8mv4ZMTSljegyqvK_3A" name="ページ1">5Vrbdto4FP0a1kof6PIFc3kskGQu6bQd1uQyb4otjFvbcmQR8Hz9SLYsWZYgJAOEMslDpK2LrbPPPjqS03Enyfoag2zxGQUw7jhWsO64047j2CPPoX8YUnCk544qJMRRwDEJzKJ/IActji6jAOZKR4JQTKJMBX2UptAnCgYwRiu12xzF6lMzEPInWhKY+SCGWre7KCCLCh06A4n/AqNwUT/Z7vP1JaDuzCfOFyBAqwbkXnbcCUaIVKVkPYExs15tl2rc1YZW8WIYpmSXAent+umvqzvrbgxAsfqjV9xnv3edfjXNM4iXfMX8bUlRmwCjZRpANovVccerRUTgLAM+a11R1im2IElMazYt5gSjH8JUEpmgGOFyPrdf/tCWeRTHDXzusV+KByBflM9jw+coJY1O1Q/F9eVzizxDTOC6AXFzXEOUQIIL2oW3dp0e56aogdrtVpJrb8ixRZPnAQcB969QzC4poAXOwisYsYdHZiRFKdTJmEwuvaurfdnZadnZ9nQ72/2Bwc7WHuw8fCL92cL97db9O79PvuXf79MvXdtg5n5MmHkykCr27j8tmUjHfmWeT7QRh48XHp2Cvh19vKUUP7AyM5xVMtPNK2rYsBThBMRyRloK2d/Zgto3oB1uUbxMYP0mj7jucAGTjBTTCH/Q22qEmqF69RpueQ0NQBkr+kUcUffBL7vOY+VnN48CAP6PsPS+L0tCZ4FGH9uTPEee4jSOwWVsgzRHh1Kme3BhKoFvF5VOvcvhtLcnldo7iNR1TcFwHyI1B0NLMzEM6P7MqwiTBQpRCuJLiY5VEmSfG4QybtvvkJCCJxtgSdBLxMB1RO4b5Qc2+UeP16Zr/qyyUtSVlFrgvllpjGJVOays1eM2UpmjJfbhDlsHATiE5GVPZqbc6hkYxoBEz2oqZCKZD/2KIvrO0qP6LY+qFV1PUa2Ij2qmLu2JaqkJ12x7XLVkbabS6cSC3u6HPU36IWDxL+yuANU43hII7NcGgr0lN1Zbz6YIatKzdzA56xHzXeTsL/GzIOftevN0uW1LNfYnt/9EgrfRl/GSnqFO0ZeHH9VU4BRc2X2DKyt+d4htSmw5cpd5UDYZ85ZTb29yS3tobHbm7e3tsum/l2zMm4s9dFXnco67tzjDE/SkvbJr7Dc6qaCoX4OIoAjzZUy6BIM0n0N8kvHRbidatj0yxMfREePjQDNofUxlFzrG4zVr6Oalj7Kzsu1la/2k/GsasdET2hfQ8yfOG6ffauYNp1/maDfgEcYqHyCOwpSWfWr98kjMrB75IP7EG5IoCKo8BNJ3A4/lfExnGQsIpdm8ccebUiRm04/FEbl1dNudZ3GbyZ/WaV4Ymo9urq1tkf3eqyOhMoOjDkfzeQ4PEgBNF14v3MTs5CqfqYNscpWtFyXn7Cp276f1k9Hr/eRwN3aTGC3Zhd2MIAxCmP8k13Kbrty3XNIf7v6917oWfvcbPrEE6WJ3mFJBoesqHSgTEpYQ0AK1JeO9RSddOzFt+Vsu8ji0e3wx+YeaBO6BHf3OXmPH9GWknT3vjxz9EuZPCILN3JwvNfbw1LjRLxUmKCv+j9y4gxY3PT2qHZWb+lrEsG8G0XN7t1K3Kr6ntYFdU3hqSkNe9hUFG5N2AWvP1LZRASurOFu3an+ptmzNrQaGD6iHcyt9r/TrTNs+Xx669nDUir2u4axdf4o5DhXOZipemyODC0skxsaSzJVLsc9BEsVFNTxBKapSZ6WLjAdlONicaZecaeGi43jtfzDyqHEYWv7zjKjVxvJKc1FkysrsxT1mHo/a+KW+tuhbe8mbpnHkNBUnoqUpkbpLRYnoUkqF1iqxMNguq03BMLTUB2uQolHgSjgM4tJhoCoe1sjlwxobAmItFR2eFBEDrRJprK9Szi4WFE3CeFJeHhOY6NkdjeQ0hcTdQWP6Sm5ydia5uo3LThIi2WPyE3jYeIE2t2VVENwEVbfj/TT/3O30dzaBUf9GY0h8jhwX9f/YEPrTP9+cDRP2wDomFx0uiMZdj5SCe/kv</diagram></mxfile>

assets/gatling-operator-pod.svg

@@ -481,6 +481,8 @@ func (r *GatlingReconciler) newGatlingRunnerJobForCR(gatling *gatlingv1alpha1.Ga
 									},
 								},
 							},
+						},
+						Containers: []corev1.Container{
 							{
 								Name:         "gatling-runner",
 								Image:        r.getGatlingContainerImage(gatling),
@@ -490,8 +492,6 @@ func (r *GatlingReconciler) newGatlingRunnerJobForCR(gatling *gatlingv1alpha1.Ga
 								Resources:    r.getPodResources(gatling),
 								VolumeMounts: r.getGatlingRunnerJobVolumeMounts(gatling),
 							},
-						},
-						Containers: []corev1.Container{
 							{
 								Name:    "gatling-result-transferer",
 								Image:   r.getRcloneContainerImage(gatling),

assets/gatling-operator-pod.xml

@@ -43,4 +43,4 @@ Gatling Runner Pod runs multiple containers. The diagram below shows how those c
 - gatling-result-transferer
   - Uploads the simulation.log file to to user-selected Cloud Storage (can be configured in `.spec.cloudStorageSpec`)
 
-📝 It is noted that gatling-waiter and gatling-runner run as init containers and gatling-result-transferer as a main container in Gatling Runner Pod in the case of generating an aggregated Gatling result report. However it's also noted that gatling-waitner runs as an init container and gatling-runner run as a main container in the case of not generating the report.
+📝 It is noted that **from gatling-operator-v0.8.1** gatling-waiter runs as an init container and both gatling-runner and gatling-result-transferer runs as main containers in a Gatling Runner Pod. However, **before gatling-operator-v0.8.1** both gatling-waiter and gatling-runner run as init containers and gatling-result-transferer as a main container in the case of generating an aggregated Gatling result report while gatling-runner runs as a main container in the case of not generating the report.

controllers/gatling_controller.go

@@ -28,9 +28,19 @@ func (p *AWSCloudStorageProvider) GetGatlingTransferResultCommand(resultsDirecto
 	template := `
 RESULTS_DIR_PATH=%s
 rclone config create s3 s3 env_auth=true region %s
-for source in $(find ${RESULTS_DIR_PATH} -type f -name *.log)
-do
-	rclone copyto ${source} --s3-no-check-bucket --s3-env-auth %s/${HOSTNAME}.log
+while true; do
+  if [ -f "${RESULTS_DIR_PATH}/FAILED" ]; then
+    echo "Skip transfering gatling results"
+    break
+  fi
+  if [ -f "${RESULTS_DIR_PATH}/COMPLETED" ]; then
+    for source in $(find ${RESULTS_DIR_PATH} -type f -name *.log)
+    do
+      rclone copyto ${source} --s3-no-check-bucket --s3-env-auth %s/${HOSTNAME}.log
+    done
+    break
+  fi
+  sleep 1;
 done
 `
 	return fmt.Sprintf(template, resultsDirectoryPath, region, storagePath)

docs/architecture.md

@@ -84,9 +84,19 @@ var _ = Describe("GetGatlingTransferResultCommand", func() {
 		expectedValue = `
 RESULTS_DIR_PATH=testResultsDirectoryPath
 rclone config create s3 s3 env_auth=true region ap-northeast-1
-for source in $(find ${RESULTS_DIR_PATH} -type f -name *.log)
-do
-	rclone copyto ${source} --s3-no-check-bucket --s3-env-auth testStoragePath/${HOSTNAME}.log
+while true; do
+  if [ -f "${RESULTS_DIR_PATH}/FAILED" ]; then
+    echo "Skip transfering gatling results"
+    break
+  fi
+  if [ -f "${RESULTS_DIR_PATH}/COMPLETED" ]; then
+    for source in $(find ${RESULTS_DIR_PATH} -type f -name *.log)
+    do
+      rclone copyto ${source} --s3-no-check-bucket --s3-env-auth testStoragePath/${HOSTNAME}.log
+    done
+    break
+  fi
+  sleep 1;
 done
 `
 	})

pkg/cloudstorages/aws.go

@@ -43,10 +43,20 @@ export RCLONE_AZUREBLOB_KEY=${AZUREBLOB_KEY}
 export RCLONE_AZUREBLOB_SAS_URL=${AZUREBLOB_SAS_URL}
 RESULTS_DIR_PATH=%s
 rclone config create az azureblob env_auth=true
-for source in $(find ${RESULTS_DIR_PATH} -type f -name *.log)
-do
-	rclone copyto ${source} %s/${HOSTNAME}.log
-done
+while true; do
+  if [ -f "${RESULTS_DIR_PATH}/FAILED" ]; then
+    echo "Skip transfering gatling results"
+    break
+  fi
+  if [ -f "${RESULTS_DIR_PATH}/COMPLETED" ]; then
+    for source in $(find ${RESULTS_DIR_PATH} -type f -name *.log)
+    do
+      rclone copyto ${source} %s/${HOSTNAME}.log
+    done
+    break
+  fi
+  sleep 1;
+done	
 `
 	return fmt.Sprintf(template, resultsDirectoryPath, storagePath)
 }

pkg/cloudstorages/aws_test.go

@@ -104,10 +104,20 @@ export RCLONE_AZUREBLOB_KEY=${AZUREBLOB_KEY}
 export RCLONE_AZUREBLOB_SAS_URL=${AZUREBLOB_SAS_URL}
 RESULTS_DIR_PATH=%s
 rclone config create az azureblob env_auth=true
-for source in $(find ${RESULTS_DIR_PATH} -type f -name *.log)
-do
-	rclone copyto ${source} %s/${HOSTNAME}.log
-done
+while true; do
+  if [ -f "${RESULTS_DIR_PATH}/FAILED" ]; then
+    echo "Skip transfering gatling results"
+    break
+  fi
+  if [ -f "${RESULTS_DIR_PATH}/COMPLETED" ]; then
+    for source in $(find ${RESULTS_DIR_PATH} -type f -name *.log)
+    do
+      rclone copyto ${source} %s/${HOSTNAME}.log
+    done
+    break
+  fi
+  sleep 1;
+done	
 `, resultsDirectoryPath, storagePath)
 	})
 	Context("Provider is azure", func() {

pkg/cloudstorages/azure.go

@@ -30,10 +30,20 @@ func (p *GCPCloudStorageProvider) GetGatlingTransferResultCommand(resultsDirecto
 RESULTS_DIR_PATH=%s
 # assumes gcs bucket using uniform bucket-level access control
 rclone config create gs "google cloud storage" bucket_policy_only true --non-interactive
-# assumes each pod only contain single gatling log file but use for loop to use find command result
-for source in $(find ${RESULTS_DIR_PATH} -type f -name *.log)
-do
-	rclone copyto ${source} %s/${HOSTNAME}.log
+while true; do
+  if [ -f "${RESULTS_DIR_PATH}/FAILED" ]; then
+    echo "Skip transfering gatling results"
+    break
+  fi
+  if [ -f "${RESULTS_DIR_PATH}/COMPLETED" ]; then
+    # assumes each pod only contain single gatling log file but use for loop to use find command result
+    for source in $(find ${RESULTS_DIR_PATH} -type f -name *.log)
+    do
+      rclone copyto ${source} %s/${HOSTNAME}.log
+    done
+    break
+  fi
+  sleep 1;
 done
 `
 	return fmt.Sprintf(template, resultsDirectoryPath, storagePath)

pkg/cloudstorages/azure_test.go

@@ -85,10 +85,20 @@ var _ = Describe("GetGatlingTransferResultCommand", func() {
 RESULTS_DIR_PATH=testResultsDirectoryPath
 # assumes gcs bucket using uniform bucket-level access control
 rclone config create gs "google cloud storage" bucket_policy_only true --non-interactive
-# assumes each pod only contain single gatling log file but use for loop to use find command result
-for source in $(find ${RESULTS_DIR_PATH} -type f -name *.log)
-do
-	rclone copyto ${source} testStoragePath/${HOSTNAME}.log
+while true; do
+  if [ -f "${RESULTS_DIR_PATH}/FAILED" ]; then
+    echo "Skip transfering gatling results"
+    break
+  fi
+  if [ -f "${RESULTS_DIR_PATH}/COMPLETED" ]; then
+    # assumes each pod only contain single gatling log file but use for loop to use find command result
+    for source in $(find ${RESULTS_DIR_PATH} -type f -name *.log)
+    do
+      rclone copyto ${source} testStoragePath/${HOSTNAME}.log
+    done
+    break
+  fi
+  sleep 1;
 done
 `
 	})

pkg/cloudstorages/gcp.go

@@ -41,6 +41,7 @@ TEMP_SIMULATIONS_DIR_PATH=%s
 RESOURCES_DIR_PATH=%s
 RESULTS_DIR_PATH=%s
 START_TIME="%s"
+RUN_STATUS_FILE="${RESULTS_DIR_PATH}/COMPLETED"
 if [ -z "${START_TIME}" ]; then
   START_TIME=$(date +"%%Y-%%m-%%d %%H:%%M:%%S" --utc)
 fi
@@ -66,6 +67,12 @@ if [ ! -d ${RESULTS_DIR_PATH} ]; then
   mkdir -p ${RESULTS_DIR_PATH}
 fi
 gatling.sh -sf ${SIMULATIONS_DIR_PATH} -s %s -rsf ${RESOURCES_DIR_PATH} -rf ${RESULTS_DIR_PATH} %s
+
+if [ $? -ne 0 ]; then
+  RUN_STATUS_FILE="${RESULTS_DIR_PATH}/FAILED"
+  echo "gatling.sh has failed!" 1>&2
+fi
+touch ${RUN_STATUS_FILE}
 `
 	generateLocalReportOption := "-nr"
 	if generateLocalReport {

pkg/cloudstorages/gcp_test.go

@@ -58,6 +58,7 @@ TEMP_SIMULATIONS_DIR_PATH=testTempSimulationsDirectoryPath
 RESOURCES_DIR_PATH=testResourcesDirectoryPath
 RESULTS_DIR_PATH=testResultsDirectoryPath
 START_TIME="2021-09-10 08:45:31"
+RUN_STATUS_FILE="${RESULTS_DIR_PATH}/COMPLETED"
 if [ -z "${START_TIME}" ]; then
   START_TIME=$(date +"%Y-%m-%d %H:%M:%S" --utc)
 fi
@@ -83,6 +84,12 @@ if [ ! -d ${RESULTS_DIR_PATH} ]; then
   mkdir -p ${RESULTS_DIR_PATH}
 fi
 gatling.sh -sf ${SIMULATIONS_DIR_PATH} -s testSimulationClass -rsf ${RESOURCES_DIR_PATH} -rf ${RESULTS_DIR_PATH} 
+
+if [ $? -ne 0 ]; then
+  RUN_STATUS_FILE="${RESULTS_DIR_PATH}/FAILED"
+  echo "gatling.sh has failed!" 1>&2
+fi
+touch ${RUN_STATUS_FILE}
 `
 		Expect(GetGatlingRunnerCommand(simulationsDirectoryPath, tempSimulationsDirectoryPath, resourcesDirectoryPath, resultsDirectoryPath, startTime, simulationClass, generateLocalReport)).To(Equal(expectedValue))
 	})
@@ -95,6 +102,7 @@ TEMP_SIMULATIONS_DIR_PATH=testTempSimulationsDirectoryPath
 RESOURCES_DIR_PATH=testResourcesDirectoryPath
 RESULTS_DIR_PATH=testResultsDirectoryPath
 START_TIME="2021-09-10 08:45:31"
+RUN_STATUS_FILE="${RESULTS_DIR_PATH}/COMPLETED"
 if [ -z "${START_TIME}" ]; then
   START_TIME=$(date +"%Y-%m-%d %H:%M:%S" --utc)
 fi
@@ -120,6 +128,12 @@ if [ ! -d ${RESULTS_DIR_PATH} ]; then
   mkdir -p ${RESULTS_DIR_PATH}
 fi
 gatling.sh -sf ${SIMULATIONS_DIR_PATH} -s testSimulationClass -rsf ${RESOURCES_DIR_PATH} -rf ${RESULTS_DIR_PATH} -nr
+
+if [ $? -ne 0 ]; then
+  RUN_STATUS_FILE="${RESULTS_DIR_PATH}/FAILED"
+  echo "gatling.sh has failed!" 1>&2
+fi
+touch ${RUN_STATUS_FILE}
 `
 		Expect(GetGatlingRunnerCommand(simulationsDirectoryPath, tempSimulationsDirectoryPath, resourcesDirectoryPath, resultsDirectoryPath, startTime, simulationClass, generateLocalReport)).To(Equal(expectedValue))
 	})