helm_upgrade_logs 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2dc5816493e1b7e6382d703dcc55063f5a6dd59557e233aeb8ad8f355a542c1
-  data.tar.gz: 2d5d74dc6af95bf6ff06ee3d3c5ad7c6d76baade4d405e141c274041c8ac5914
+  metadata.gz: 88dd5b1832da012298b7c2f8ce393bcc78df7b20014bc9514b37d70bb3c885fe
+  data.tar.gz: 4dd1b474d21f68ac9849d2523358e4550d518d81c0155d187cfe3b524b3236e7
 SHA512:
-  metadata.gz: c7ac65c07401d1a198e3e29ae710cf843b1601e0d7b4f24ae3401aa72b36e1b1bdd182e101df25bcafb01078fb8dae1af296b383b5ae77d3136ba84348d5dfc2
-  data.tar.gz: d4a00643a7461d16198e7a9f9dec6a93f782cb8790a53efc40344a3303a2c37dcbd939b88ab5d9ff95e482593a16c53283ef0acb4cf24161593aba14b9c3812a
+  metadata.gz: b6a0432ce7aee7a1a3b924e4599a0764674fb8ca3c61cab4862e51fefa57fe706dffeb15b3d9d134c22652fc65fbb5ccc4ae1e7383f78f65176bba50f93851b0
+  data.tar.gz: 8ddfd48e160614b8d7e3b03c6eca7699ab05b96f2ad3ecdcaa00f71981bcf5a040796d2fc689503496c3906fc9dc6a6a1a03a652e63f2190024f8bebe7e12458

data/.github/workflows/test.yml

@@ -60,6 +60,8 @@ jobs:
 
     steps:
     - uses: actions/checkout@v3
+    - name: Use Debug
+      run: export helm_upgrade_logs_debug=true
     - name: Start KIND cluster
       run: bash -f bin/start_kind.sh
     - name: Add bitnami repo
@@ -69,4 +71,4 @@ jobs:
     - name: Test bitnami
       run: ./exe/helm_test_logs nginx
     - name: Install Redis
-      run: ./exe/helm_upgrade_logs --install redis bitnami/redis --set auth.enabled=false --version 14.0.2 --wait
+      run: ./exe/helm_upgrade_logs --install redis bitnami/redis --set auth.enabled=false --version 15.7.2 --set replica.replicaCount=1 --wait

data/CHANGELOG.md

@@ -1,4 +1,18 @@
-## [0.2.4]
+## [0.3.0]
+
+- Log output to a file in a folder `helm_upgrade_logs` as well as STDOUT
+- If `helm_upgrade_logs_error_msg` is set then rethrow error after install finished. For AzureDevOps, setting
+`helm_upgrade_logs_ado_error` to `true` will raise an error in the build
+
+## [0.2.6]
+
+- Don't log pods existing before an upgrade
+
+## [0.2.5] 2022-04-21
+
+- Return helm status code as script's status code
+
+## [0.2.4] 2022-04-21
 
 - Handle `n`, `--namespace` from helm command
 - Exit if there is failure on helm command while trying to get logs

data/README.md

@@ -2,6 +2,8 @@
 
 Idea is to show logs of pods and events while doing a kubernetes helm install or upgrade.
 
+> This has only been tested on linux. More more would be needed to run script properly on Windows
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -35,6 +37,11 @@ This library waits for logs to start in pods for 90 seconds or controlled by env
 After that it waits 35 seconds for logs to start in pods after the first one. 
 This is controlled by environment variable `helm_upgrade_logs_pod_start`
 
+Logs are pushed to STDOUT and also to files in a folder `helm_upgrade_logs`. 
+The ENV variable `helm_upgrade_logs_error_msg` can be set to throw an error at the end for a certain string
+contained in the logs like `ERROR`. The `helm_upgrade_logs_ado_error` can be set to raise a signal to Azure
+Dev Ops to throw an error in the build.
+
 To test a chart showing it logs, in a similar way run
 ```bash
 helm_test_logs redis

data/exe/helm_test_logs

@@ -12,4 +12,6 @@ helm_pid = Process.spawn "helm test #{ARGV.join(" ")}"
 log_pid = Process.spawn(add_ns("kubectl logs -lapp.kubernetes.io/instance=#{@release_name} -f --all-containers --prefix --ignore-errors=true --max-log-requests=20 --timestamps=true --since=1s"))
 
 Process.wait helm_pid
+helm_status = $CHILD_STATUS.exitstatus
 `kill #{log_pid}`
+exit helm_status

data/exe/helm_upgrade_logs

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require "open3"
+require "fileutils"
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
 require "helm_upgrade_logs"
 
@@ -10,6 +11,9 @@ require "helm_upgrade_logs"
 
 @helm_pid = Process.spawn "helm upgrade #{ARGV.join(" ")}"
 
+pods_before_upgrade = read_pods
+puts "[INFO] Pods before upgrade #{pods_before_upgrade}" if pods_before_upgrade.size.positive?
+
 event_pid = Process.spawn(add_ns("kubectl get events --watch-only=true"))
 service_pid = Process.spawn(add_ns("kubectl get services --watch-only=true"))
 
@@ -26,8 +30,10 @@ rescue Errno::ECHILD
   raise HelmUpgradeLogs::Error, "Failed to find logs before helm finished"
 end
 
+FileUtils.mkdir_p "helm_upgrade_logs"
+
 while Process.waitpid(@helm_pid, Process::WNOHANG).nil?
-  pods = read_pods
+  pods = read_pods - pods_before_upgrade
   if pods != @pods
     @pods = pods
     puts "[INFO] Pods: #{pods.join(",")}"
@@ -36,14 +42,39 @@ while Process.waitpid(@helm_pid, Process::WNOHANG).nil?
       next unless @pod_pids[pod].nil?
 
       wait_for_specific_pod_to_log pod
-      log_pid = Process.spawn(add_ns("kubectl logs #{pod} -f --all-containers --prefix --ignore-errors=true --timestamps=true"))
-      @pod_pids[pod] = log_pid
+      std_out_pid = Process.spawn(
+        add_ns("kubectl logs #{pod} -f --all-containers --prefix --ignore-errors=true --timestamps=true")
+      )
+      logfile_pid = Process.spawn(
+        add_ns("kubectl logs #{pod} -f --all-containers --prefix --ignore-errors=true --timestamps=true"),
+        out: "helm_upgrade_logs/#{pod.gsub("/", "_")}.log"
+      )
+      @pod_pids["#{pod}_stdout"] = std_out_pid
+      @pod_pids["#{pod}_fileout"] = logfile_pid
     end
   end
   sleep 1
 end
+helm_status = $CHILD_STATUS.exitstatus
 `kill #{event_pid}`
 `kill #{service_pid}`
+puts @pod_pids if ENV["helm_upgrade_logs_debug"] == "true"
 @pod_pids.each do |_pod, pid|
+  puts "Terminating #{_pod} #{pid}" if ENV["helm_upgrade_logs_debug"] == "true"
   `kill #{pid}`
 end
+
+if ENV["helm_upgrade_logs_error_msg"]
+  pod_logs_files = Dir.glob("helm_logs/*.log")
+  pod_logs_files.each do |log_file|
+    lines = File.readlines log_file
+    lines.each_with_index do |line, index|
+      next unless line.include?(ENV["helm_upgrade_logs_error_msg"])
+
+      msg = "Helm install error: #{line} from #{log_file} (Line #{index + 1})"
+      puts "[ERROR] #{msg}"
+      puts "##vso[task.logissue type=error] #{msg}" if ENV["helm_upgrade_logs_ado_error"] == "true"
+    end
+  end
+end
+exit helm_status

data/lib/helm_upgrade_logs/version.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
 module HelmUpgradeLogs
-  VERSION = "0.2.4"
+  # @return [String] Version of helm upgrade logs
+  VERSION = "0.3.0"
 end

data/lib/helm_upgrade_logs.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "open3"
+require 'English'
 require_relative "helm_upgrade_logs/version"
 
 ENV["helm_upgrade_logs_log_start"] ||= "90"
@@ -67,6 +68,13 @@ def add_ns(kube_query)
   kube_query
 end
 
+# Add namespace to kube query
+def add_ns_file(kube_query, pod)
+  kube_query += " -n #{@namespace}" if @namespace
+  kube_query += "> #{pod}.log"
+  kube_query
+end
+
 module HelmUpgradeLogs
   class Error < StandardError; end
   # Your code goes here...

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helm_upgrade_logs
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-20 00:00:00.000000000 Z
+date: 2022-06-29 00:00:00.000000000 Z
 dependencies: []
 description: Basic wrapper around helm and kubectl to allow easy debugging of a helm
   release. All arguments after a usual helm upgrade are used as normal