From ab2f3930400de0cbb119c4365f051d40010c8ecb Mon Sep 17 00:00:00 2001
From: Rohith Jayawardene <gambol99@gmail.com>
Date: Tue, 6 Sep 2022 18:16:53 +0100
Subject: [PATCH] [BUGFIX] - Init Errors Showing in Logs

When the job has an issue in the init stage the logs aren't appearing to the user. With this
PR we correctly end on a failed pod and render the logs to the user.

- added a e2e check to ensure the logs are functioning correctly
---
 pkg/apiserver/handlers.go               |  2 +-
 test/e2e/check-suite.sh                 |  1 +
 test/e2e/integration/error-handler.bats | 68 +++++++++++++++++++++++++
 3 files changed, 70 insertions(+), 1 deletion(-)
 create mode 100644 test/e2e/integration/error-handler.bats

diff --git a/pkg/apiserver/handlers.go b/pkg/apiserver/handlers.go
index 5390fbccc..1a933be89 100644
--- a/pkg/apiserver/handlers.go
+++ b/pkg/apiserver/handlers.go
@@ -157,7 +157,7 @@ func (s *Server) handleBuilds(w http.ResponseWriter, req *http.Request) {
 
 		pod = kubernetes.FindLatestPod(pods)
 		switch pod.Status.Phase {
-		case v1.PodRunning, v1.PodSucceeded:
+		case v1.PodRunning, v1.PodSucceeded, v1.PodFailed:
 			return true, nil
 		}
 
diff --git a/test/e2e/check-suite.sh b/test/e2e/check-suite.sh
index da5840115..f5838e989 100755
--- a/test/e2e/check-suite.sh
+++ b/test/e2e/check-suite.sh
@@ -90,6 +90,7 @@ run_checks() {
     "${UNITS}/infracost.bats"
     "${UNITS}/checkov.bats"
     "${UNITS}/private.bats"
+    "${UNITS}/error-handler.bats"
   )
   local CONSTRAINTS_FILES=(
     "${UNITS}/constraints/setup.bats"
diff --git a/test/e2e/integration/error-handler.bats b/test/e2e/integration/error-handler.bats
new file mode 100644
index 000000000..9e10f3e4c
--- /dev/null
+++ b/test/e2e/integration/error-handler.bats
@@ -0,0 +1,68 @@
+#!/usr/bin/env bats
+#
+# Copyright 2021 Appvia Ltd <info@appvia.io>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+load ../lib/helper
+
+setup() {
+  [[ ! -f ${BATS_PARENT_TMPNAME}.skip ]] || skip "skip remaining tests"
+  [[ ${CLOUD} == "aws" ]] || skip "drift check only runs on aws"
+}
+
+teardown() {
+  [[ -n "$BATS_TEST_COMPLETED" ]] || touch ${BATS_PARENT_TMPNAME}.skip
+}
+
+@test "We should create a namespace for testing the error handling" {
+  NAMESPACE="error-handling"
+
+  if kubectl get namespace ${NAMESPACE}; then
+    skip "namespace already exists"
+  fi
+
+  runit "kubectl create namespace {NAMESPACE}"
+  [ "$status" -eq 0 ]
+}
+
+@test "We should be able to create a failing configuration" {
+  NAMESPACE="error-handling"
+
+  cat <<EOF >> ${BATS_TMPDIR}/resource.yaml
+---
+apiVersion: terraform.appvia.io/v1alpha1
+kind: Configuration
+metadata:
+  name: ${RESOURCE_NAME}
+spec:
+  module: https://github.com/terraform-aws-modules/terraform-aws-s3-bucket.git?v3.1.0
+  providerRef:
+    name: aws
+  variables:
+    unused: $(date +"%s")
+    bucket_name: ${RESOURCE_NAME}
+EOF
+  runit "kubectl -n ${NAMESPACE} apply -f ${BATS_TMPDIR}/resource.yaml"
+  [[ "$status" -eq 0 ]]
+}
+
+@test "We should be able to see the logs from the failing resource" {
+  NAMESPACE="error-handling"
+  POD=$(kubectl -n ${NAMESPACE} get pod -l terraform.appvia.io/configuration=${RESOURCE_NAME} -l terraform.appvia.io/stage=plan -o json | jq -r '.items[0].metadata.name')
+  [[ "$status" -eq 0 ]]
+  runit "kubectl -n ${NAMESPACE} logs ${POD} 2>&1" "grep -q 'failed to download the source'"
+  [[ "$status" -eq 0 ]]
+}
+