helm_upgrade_logs 0.2.5 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05d454e1aeebb7122327e049f950b33f35161484018f71fbc2d49482e8830bf3
-  data.tar.gz: 3482c02fd2cc6c0a4ce397f8d08aba0a95b75a31c8d43ae595df6bb61bfce442
+  metadata.gz: 2b0bd4dec8d15bd330ceb45ba82dc81e0a5ca0301c8032037462bd532ed6f75a
+  data.tar.gz: d4bd99f9a4d04e25b8f34089169f3355ac43d75081438aa3d8ed6854b0f787f6
 SHA512:
-  metadata.gz: 19398249dbecf3c5e8b6d05eca07e33a9c950a6399cc954f4d9db103c25a0824abb770b2972c0fa9b113f6313650610edd5593eac5110a702e1133dc28371331
-  data.tar.gz: eb1efb17c3b164b4c4c6e49be16cb7db923d7c96321e2f0e9089ee7e06faf2f79699e9813d60d679de77dad266bbcaffd4ea4cffd2fed12095664761b00cea1a
+  metadata.gz: c097c2af0698ad0c844c97c78f94498edafa94f66213d782a9fa9b5dc959cc6a0f9bf3ae11b39ce70860b7e91de92e00d4da6d0cd07b361145b4c6d04f118115
+  data.tar.gz: a8e3188650ec71f1a8de1c44c2f6105d02c09247e18feebbd2f625b898a9cc983f92c4eab9e0dec08d7daabd4e1298f720fc901a985be65658f274e5a8764c97

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,3 +1,17 @@
+## [0.3.1]
+
+- Fix LOG folder parsed to check error message
+
+## [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

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_upgrade_logs

@@ -2,14 +2,19 @@
 # frozen_string_literal: true
 
 require "open3"
+require "fileutils"
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
 require "helm_upgrade_logs"
+UPGRADE_LOG_FOLDER = "helm_upgrade_logs"
 
 @release_name = ARGV.find { |arg| !arg.start_with?("-") }
 @namespace = namespace_from_args(ARGV)
 
 @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 +31,10 @@ rescue Errno::ECHILD
   raise HelmUpgradeLogs::Error, "Failed to find logs before helm finished"
 end
 
+FileUtils.mkdir_p UPGRADE_LOG_FOLDER
+
 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,8 +43,15 @@ 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: "#{UPGRADE_LOG_FOLDER}/#{pod.gsub("/", "_")}.log"
+      )
+      @pod_pids["#{pod}_stdout"] = std_out_pid
+      @pod_pids["#{pod}_fileout"] = logfile_pid
     end
   end
   sleep 1
@@ -45,7 +59,24 @@ 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("#{UPGRADE_LOG_FOLDER}/*.log")
+  puts "Reading logs from #{pod_logs_files.count} pod logs" if ENV["helm_upgrade_logs_debug"] == "true"
+  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

@@ -2,5 +2,5 @@
 
 module HelmUpgradeLogs
   # @return [String] Version of helm upgrade logs
-  VERSION = "0.2.5"
+  VERSION = "0.3.1"
 end

data/lib/helm_upgrade_logs.rb

@@ -68,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.5
+  version: 0.3.1
 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