Merge branch '51792-improve-debugging-capabilities-for-helm-installs' into 'master'

Improve Debugging Capabilities For Helm Application Installs

See merge request gitlab-org/gitlab-ce!22924

app/models/clusters/applications/knative.rb

@@ -44,7 +44,7 @@ module Clusters
       private
 
       def install_script
-        ["/usr/bin/kubectl apply -f #{ISTIO_CRDS} >/dev/null"]
+        ["/usr/bin/kubectl apply -f #{ISTIO_CRDS}"]
       end
     end
   end

lib/gitlab/kubernetes/helm/base_command.rb

@@ -10,7 +10,7 @@ module Gitlab
 
         def generate_script
           <<~HEREDOC
-            set -eo pipefail
+            set -xeo pipefail
           HEREDOC
         end
 

lib/gitlab/kubernetes/helm/init_command.rb

@@ -45,7 +45,7 @@ module Gitlab
         def init_helm_command
           command = %w[helm init] + init_command_flags
 
-          command.shelljoin + " >/dev/null\n"
+          command.shelljoin
         end
 
         def init_command_flags

lib/gitlab/kubernetes/helm/install_command.rb

@@ -35,7 +35,7 @@ module Gitlab
         private
 
         def init_command
-          'helm init --client-only >/dev/null'
+          'helm init --client-only'
         end
 
         def repository_command
@@ -43,13 +43,13 @@ module Gitlab
         end
 
         def repository_update_command
-          'helm repo update >/dev/null' if repository
+          'helm repo update' if repository
         end
 
         def install_command
           command = ['helm', 'install', chart] + install_command_flags
 
-          command.shelljoin + " >/dev/null\n"
+          command.shelljoin
         end
 
         def preinstall_command

lib/gitlab/kubernetes/helm/upgrade_command.rb

@@ -36,7 +36,7 @@ module Gitlab
         private
 
         def init_command
-          'helm init --client-only >/dev/null'
+          'helm init --client-only'
         end
 
         def repository_command
@@ -50,7 +50,7 @@ module Gitlab
             " --namespace #{::Gitlab::Kubernetes::Helm::NAMESPACE}" \
             " -f /data/helm/#{name}/config/values.yaml"
 
-          "helm upgrade #{name} #{chart}#{upgrade_flags} >/dev/null\n"
+          "helm upgrade #{name} #{chart}#{upgrade_flags}"
         end
 
         def optional_version_flag

spec/lib/gitlab/kubernetes/helm/init_command_spec.rb

@@ -8,7 +8,7 @@ describe Gitlab::Kubernetes::Helm::InitCommand do
 
   let(:commands) do
     <<~EOS
-    helm init --tiller-tls --tiller-tls-verify --tls-ca-cert /data/helm/helm/config/ca.pem --tiller-tls-cert /data/helm/helm/config/cert.pem --tiller-tls-key /data/helm/helm/config/key.pem >/dev/null
+    helm init --tiller-tls --tiller-tls-verify --tls-ca-cert /data/helm/helm/config/ca.pem --tiller-tls-cert /data/helm/helm/config/cert.pem --tiller-tls-key /data/helm/helm/config/key.pem
     EOS
   end
 
@@ -22,7 +22,7 @@ describe Gitlab::Kubernetes::Helm::InitCommand do
     it_behaves_like 'helm commands' do
       let(:commands) do
         <<~EOS
-        helm init --tiller-tls --tiller-tls-verify --tls-ca-cert /data/helm/helm/config/ca.pem --tiller-tls-cert /data/helm/helm/config/cert.pem --tiller-tls-key /data/helm/helm/config/key.pem --service-account tiller >/dev/null
+        helm init --tiller-tls --tiller-tls-verify --tls-ca-cert /data/helm/helm/config/ca.pem --tiller-tls-cert /data/helm/helm/config/cert.pem --tiller-tls-key /data/helm/helm/config/key.pem --service-account tiller
         EOS
       end
     end

spec/lib/gitlab/kubernetes/helm/install_command_spec.rb

@@ -26,9 +26,9 @@ describe Gitlab::Kubernetes::Helm::InstallCommand do
   it_behaves_like 'helm commands' do
     let(:commands) do
       <<~EOS
-      helm init --client-only >/dev/null
+      helm init --client-only
       helm repo add app-name https://repository.example.com
-      helm repo update >/dev/null
+      helm repo update
       #{helm_install_comand}
       EOS
     end
@@ -43,7 +43,7 @@ describe Gitlab::Kubernetes::Helm::InstallCommand do
         --tls-key /data/helm/app-name/config/key.pem
         --version 1.2.3
         --namespace gitlab-managed-apps
-        -f /data/helm/app-name/config/values.yaml >/dev/null
+        -f /data/helm/app-name/config/values.yaml
       EOS
     end
   end
@@ -54,9 +54,9 @@ describe Gitlab::Kubernetes::Helm::InstallCommand do
     it_behaves_like 'helm commands' do
       let(:commands) do
         <<~EOS
-        helm init --client-only >/dev/null
+        helm init --client-only
         helm repo add app-name https://repository.example.com
-        helm repo update >/dev/null
+        helm repo update
         #{helm_install_command}
         EOS
       end
@@ -72,7 +72,7 @@ describe Gitlab::Kubernetes::Helm::InstallCommand do
           --version 1.2.3
           --set rbac.create\\=true,rbac.enabled\\=true
           --namespace gitlab-managed-apps
-          -f /data/helm/app-name/config/values.yaml >/dev/null
+          -f /data/helm/app-name/config/values.yaml
         EOS
       end
     end
@@ -84,7 +84,7 @@ describe Gitlab::Kubernetes::Helm::InstallCommand do
     it_behaves_like 'helm commands' do
       let(:commands) do
         <<~EOS
-        helm init --client-only >/dev/null
+        helm init --client-only
         #{helm_install_command}
         EOS
       end
@@ -99,7 +99,7 @@ describe Gitlab::Kubernetes::Helm::InstallCommand do
           --tls-key /data/helm/app-name/config/key.pem
           --version 1.2.3
           --namespace gitlab-managed-apps
-          -f /data/helm/app-name/config/values.yaml >/dev/null
+          -f /data/helm/app-name/config/values.yaml
         EOS
       end
     end
@@ -111,9 +111,9 @@ describe Gitlab::Kubernetes::Helm::InstallCommand do
     it_behaves_like 'helm commands' do
       let(:commands) do
         <<~EOS
-        helm init --client-only >/dev/null
+        helm init --client-only
         helm repo add app-name https://repository.example.com
-        helm repo update >/dev/null
+        helm repo update
         #{helm_install_command}
         EOS
       end
@@ -122,7 +122,7 @@ describe Gitlab::Kubernetes::Helm::InstallCommand do
         <<~EOS.strip
         /bin/date
         /bin/true
-        helm install chart-name --name app-name --tls --tls-ca-cert /data/helm/app-name/config/ca.pem --tls-cert /data/helm/app-name/config/cert.pem --tls-key /data/helm/app-name/config/key.pem --version 1.2.3 --namespace gitlab-managed-apps -f /data/helm/app-name/config/values.yaml >/dev/null
+        helm install chart-name --name app-name --tls --tls-ca-cert /data/helm/app-name/config/ca.pem --tls-cert /data/helm/app-name/config/cert.pem --tls-key /data/helm/app-name/config/key.pem --version 1.2.3 --namespace gitlab-managed-apps -f /data/helm/app-name/config/values.yaml
         EOS
       end
     end
@@ -134,17 +134,16 @@ describe Gitlab::Kubernetes::Helm::InstallCommand do
     it_behaves_like 'helm commands' do
       let(:commands) do
         <<~EOS
-        helm init --client-only >/dev/null
+        helm init --client-only
         helm repo add app-name https://repository.example.com
-        helm repo update >/dev/null
+        helm repo update
         #{helm_install_command}
         EOS
       end
 
       let(:helm_install_command) do
         <<~EOS.strip
-        helm install chart-name --name app-name --tls --tls-ca-cert /data/helm/app-name/config/ca.pem --tls-cert /data/helm/app-name/config/cert.pem --tls-key /data/helm/app-name/config/key.pem --version 1.2.3 --namespace gitlab-managed-apps -f /data/helm/app-name/config/values.yaml >/dev/null
-
+        helm install chart-name --name app-name --tls --tls-ca-cert /data/helm/app-name/config/ca.pem --tls-cert /data/helm/app-name/config/cert.pem --tls-key /data/helm/app-name/config/key.pem --version 1.2.3 --namespace gitlab-managed-apps -f /data/helm/app-name/config/values.yaml
         /bin/date
         /bin/false
         EOS
@@ -158,9 +157,9 @@ describe Gitlab::Kubernetes::Helm::InstallCommand do
     it_behaves_like 'helm commands' do
       let(:commands) do
         <<~EOS
-        helm init --client-only >/dev/null
+        helm init --client-only
         helm repo add app-name https://repository.example.com
-        helm repo update >/dev/null
+        helm repo update
         #{helm_install_command}
         EOS
       end
@@ -171,7 +170,7 @@ describe Gitlab::Kubernetes::Helm::InstallCommand do
            --name app-name
            --version 1.2.3
            --namespace gitlab-managed-apps
-           -f /data/helm/app-name/config/values.yaml >/dev/null
+           -f /data/helm/app-name/config/values.yaml
         EOS
       end
     end
@@ -183,9 +182,9 @@ describe Gitlab::Kubernetes::Helm::InstallCommand do
     it_behaves_like 'helm commands' do
       let(:commands) do
         <<~EOS
-        helm init --client-only >/dev/null
+        helm init --client-only
         helm repo add app-name https://repository.example.com
-        helm repo update >/dev/null
+        helm repo update
         #{helm_install_command}
         EOS
       end
@@ -199,7 +198,7 @@ describe Gitlab::Kubernetes::Helm::InstallCommand do
           --tls-cert /data/helm/app-name/config/cert.pem
           --tls-key /data/helm/app-name/config/key.pem
           --namespace gitlab-managed-apps
-          -f /data/helm/app-name/config/values.yaml >/dev/null
+          -f /data/helm/app-name/config/values.yaml
         EOS
       end
     end

spec/lib/gitlab/kubernetes/helm/upgrade_command_spec.rb

@@ -21,8 +21,8 @@ describe Gitlab::Kubernetes::Helm::UpgradeCommand do
   it_behaves_like 'helm commands' do
     let(:commands) do
       <<~EOS
-         helm init --client-only >/dev/null
-         helm upgrade #{application.name} #{application.chart} --tls --tls-ca-cert /data/helm/#{application.name}/config/ca.pem --tls-cert /data/helm/#{application.name}/config/cert.pem --tls-key /data/helm/#{application.name}/config/key.pem --reset-values --install --namespace #{namespace} -f /data/helm/#{application.name}/config/values.yaml >/dev/null
+         helm init --client-only
+         helm upgrade #{application.name} #{application.chart} --tls --tls-ca-cert /data/helm/#{application.name}/config/ca.pem --tls-cert /data/helm/#{application.name}/config/cert.pem --tls-key /data/helm/#{application.name}/config/key.pem --reset-values --install --namespace #{namespace} -f /data/helm/#{application.name}/config/values.yaml
       EOS
     end
   end
@@ -33,8 +33,8 @@ describe Gitlab::Kubernetes::Helm::UpgradeCommand do
     it_behaves_like 'helm commands' do
       let(:commands) do
         <<~EOS
-         helm init --client-only >/dev/null
-         helm upgrade #{application.name} #{application.chart} --tls --tls-ca-cert /data/helm/#{application.name}/config/ca.pem --tls-cert /data/helm/#{application.name}/config/cert.pem --tls-key /data/helm/#{application.name}/config/key.pem --reset-values --install --namespace #{namespace} -f /data/helm/#{application.name}/config/values.yaml >/dev/null
+         helm init --client-only
+         helm upgrade #{application.name} #{application.chart} --tls --tls-ca-cert /data/helm/#{application.name}/config/ca.pem --tls-cert /data/helm/#{application.name}/config/cert.pem --tls-key /data/helm/#{application.name}/config/key.pem --reset-values --install --namespace #{namespace} -f /data/helm/#{application.name}/config/values.yaml
         EOS
       end
     end
@@ -56,9 +56,9 @@ describe Gitlab::Kubernetes::Helm::UpgradeCommand do
     it_behaves_like 'helm commands' do
       let(:commands) do
         <<~EOS
-           helm init --client-only >/dev/null
+           helm init --client-only
            helm repo add #{application.name} #{application.repository}
-           helm upgrade #{application.name} #{application.chart} --tls --tls-ca-cert /data/helm/#{application.name}/config/ca.pem --tls-cert /data/helm/#{application.name}/config/cert.pem --tls-key /data/helm/#{application.name}/config/key.pem --reset-values --install --namespace #{namespace} -f /data/helm/#{application.name}/config/values.yaml >/dev/null
+           helm upgrade #{application.name} #{application.chart} --tls --tls-ca-cert /data/helm/#{application.name}/config/ca.pem --tls-cert /data/helm/#{application.name}/config/cert.pem --tls-key /data/helm/#{application.name}/config/key.pem --reset-values --install --namespace #{namespace} -f /data/helm/#{application.name}/config/values.yaml
         EOS
       end
     end
@@ -70,8 +70,8 @@ describe Gitlab::Kubernetes::Helm::UpgradeCommand do
     it_behaves_like 'helm commands' do
       let(:commands) do
         <<~EOS
-         helm init --client-only >/dev/null
-         helm upgrade #{application.name} #{application.chart} --reset-values --install --namespace #{namespace} -f /data/helm/#{application.name}/config/values.yaml >/dev/null
+         helm init --client-only
+         helm upgrade #{application.name} #{application.chart} --reset-values --install --namespace #{namespace} -f /data/helm/#{application.name}/config/values.yaml
         EOS
       end
     end

spec/support/shared_examples/helm_generated_script.rb

@@ -2,12 +2,12 @@ shared_examples 'helm commands' do
   describe '#generate_script' do
     let(:helm_setup) do
       <<~EOS
-         set -eo pipefail
+         set -xeo pipefail
       EOS
     end
 
     it 'should return appropriate command' do
-      expect(subject.generate_script).to eq(helm_setup + commands)
+      expect(subject.generate_script.strip).to eq((helm_setup + commands).strip)
     end
   end
 end