helm_upgrade_logs 0.3.3 → 0.3.6

data/exe/helm_upgrade_logs

@@ -1,86 +1,97 @@
-#!/usr/bin/env ruby
-# 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"))
-
-wait_for_pod_to_log
-
-@pods = []
-@pod_pids = {}
-
-begin
-  Process.waitpid(@helm_pid, Process::WNOHANG)
-rescue Errno::ECHILD
-  Process.kill("KILL", event_pid)
-  Process.kill("KILL", service_pid)
-  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_before_upgrade
-  if pods != @pods
-    @pods = pods
-    puts "[INFO] Pods: #{pods.join(",")}"
-    # Could change this each to Parallel.each
-    @pods.each do |pod|
-      next unless @pod_pids[pod].nil?
-
-      wait_for_specific_pod_to_log pod
-      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
-end
-puts "[INFO] Cleaning up loggers after helm upgrade"
-helm_status = $CHILD_STATUS.exitstatus
-Process.kill("KILL", event_pid)
-Process.kill("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"
-  Process.kill("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})"
-      if ENV["helm_upgrade_logs_ado_error"] == "true"
-        puts "##vso[task.logissue type=error] #{msg}"
-      else
-        puts "[ERROR] #{msg}"
-      end
-    end
-  end
-end
-exit helm_status
+#!/usr/bin/env ruby
+# 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"))
+
+wait_for_pod_to_log
+
+@pods = []
+@pod_pids = {}
+
+begin
+  Process.waitpid(@helm_pid, Process::WNOHANG)
+rescue Errno::ECHILD
+  Process.kill("KILL", event_pid)
+  Process.kill("KILL", service_pid)
+  raise HelmUpgradeLogs::Error, "Failed to find logs before helm finished"
+end
+
+FileUtils.mkdir_p(UPGRADE_LOG_FOLDER) if ENV["helm_upgrade_logs_error_msg"]
+
+while Process.waitpid(@helm_pid, Process::WNOHANG).nil?
+  pods = read_pods - pods_before_upgrade
+  if pods != @pods
+    @pods = pods
+    puts "[INFO] Pods: #{pods.join(",")}"
+    # Could change this each to Parallel.each
+    @pods.each do |pod|
+      next unless @pod_pids[pod].nil?
+
+      wait_for_specific_pod_to_log pod
+      std_out_pid = Process.spawn(
+        add_ns("kubectl logs #{pod} -f --all-containers --prefix --ignore-errors=true --timestamps=true")
+      )
+      @pod_pids[pod] = std_out_pid
+      next unless ENV["helm_upgrade_logs_error_msg"]
+
+      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}_fileout"] = logfile_pid
+    end
+  end
+  sleep 1
+end
+puts "[INFO] Cleaning up loggers after helm upgrade"
+helm_status = $CHILD_STATUS.exitstatus
+Process.kill("KILL", event_pid)
+Process.wait event_pid
+Process.kill("KILL", service_pid)
+Process.wait service_pid
+
+if ENV["helm_upgrade_logs_debug"] == "true"
+  puts "[INFO] Log processes"
+  puts @pod_pids
+end
+@pod_pids.each do |_pod, pid|
+  puts "Terminating #{_pod} #{pid}" if ENV["helm_upgrade_logs_debug"] == "true"
+  Process.kill("KILL", pid)
+  Process.wait pid
+end
+puts `ps` if ENV["helm_upgrade_logs_debug"] == "true"
+
+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"
+  error_messages = ENV["helm_upgrade_logs_error_msg"].split(",")
+  pod_logs_files.each do |log_file|
+    lines = File.readlines log_file
+    lines.each_with_index do |line, index|
+      next unless error_messages.any? { |error| line.include? error  }
+
+      msg = "Helm install error: #{line} from #{log_file} (Line #{index + 1})"
+      if ENV["helm_upgrade_logs_ado_error"] == "true"
+        puts "##vso[task.logissue type=error] #{msg}"
+      else
+        puts "[ERROR] #{msg}"
+      end
+    end
+  end
+end
+exit helm_status

data/helm_upgrade_logs.gemspec

@@ -1,35 +1,35 @@
-# frozen_string_literal: true
-
-require_relative "lib/helm_upgrade_logs/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "helm_upgrade_logs"
-  spec.version       = HelmUpgradeLogs::VERSION
-  spec.authors       = ["Samuel Garratt"]
-  spec.email         = ["samuel.garratt@sentify.co"]
-
-  spec.summary       = "Basic wrapper around helm and kubectl to allow easy debugging of a helm release."
-  spec.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"
-  spec.homepage      = "https://gitlab.com/samuel-garratt/helm_upgrade_logs"
-  spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://gitlab.com/samuel-garratt/helm_upgrade_logs"
-  spec.metadata["changelog_uri"] = "https://gitlab.com/samuel-garratt/helm_upgrade_logs/CHANGELOG.md"
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:spec)/}) }
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end
+# frozen_string_literal: true
+
+require_relative "lib/helm_upgrade_logs/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "helm_upgrade_logs"
+  spec.version       = HelmUpgradeLogs::VERSION
+  spec.authors       = ["Samuel Garratt"]
+  spec.email         = ["samuel.garratt@sentify.co"]
+
+  spec.summary       = "Basic wrapper around helm and kubectl to allow easy debugging of a helm release."
+  spec.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"
+  spec.homepage      = "https://gitlab.com/samuel-garratt/helm_upgrade_logs"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://gitlab.com/samuel-garratt/helm_upgrade_logs"
+  spec.metadata["changelog_uri"] = "https://gitlab.com/samuel-garratt/helm_upgrade_logs/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:spec)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/helm_upgrade_logs/version.rb

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

data/lib/helm_upgrade_logs.rb

@@ -1,81 +1,81 @@
-# frozen_string_literal: true
-
-require "open3"
-require 'English'
-require_relative "helm_upgrade_logs/version"
-
-ENV["helm_upgrade_logs_log_start"] ||= "90"
-ENV["helm_upgrade_logs_pod_start"] ||= "35"
-
-# Approach not ideal as it will for all containers to be ready and want to stream logs before that
-def wait_for_container_ready
-  wait_pid = Process.spawn 'kubectl wait --for=condition=ContainersReady pod --selector "app.kubernetes.io/managed-by=Helm" --timeout=30s'
-  Process.wait wait_pid
-end
-
-# Wait for very first pods with logs to be present
-# Not ideal due to https://github.com/kubernetes/kubernetes/issues/28746
-def wait_for_pod_to_log
-  ENV["helm_upgrade_logs_log_start"].to_i.times do |i|
-    break unless Process.waitpid(@helm_pid, Process::WNOHANG).nil?
-
-    sleep 1
-    stdout, stderr, = Open3.capture3(add_ns("kubectl logs -lapp.kubernetes.io/instance=#{@release_name}"))
-    if stderr.empty? && !stdout.strip.empty?
-      puts "[INFO] Pods with logs found"
-      break
-    elsif (i % 3).zero?
-      puts "[INFO] Waiting for pod logs: #{stderr}"
-    end
-  end
-end
-
-# Wait for logs from a specific pod
-def wait_for_specific_pod_to_log(pod_name)
-  ENV["helm_upgrade_logs_pod_start"].to_i.times do |i|
-    sleep 1
-    stdout, stderr, = Open3.capture3(add_ns("kubectl logs #{pod_name}"))
-    if stderr.empty? && !stdout.strip.empty?
-      puts "[INFO] Pod #{pod_name} with logs found"
-      break
-    elsif i.even?
-      puts "[INFO] Waiting for pod #{pod_name} logs: #{stderr}"
-    end
-  end
-end
-
-# Get pods
-def read_pods
-  stdout, stderr, = Open3.capture3(add_ns("kubectl get pods -lapp.kubernetes.io/instance=#{@release_name} -o name"))
-  if stderr.empty?
-    stdout.lines.collect(&:strip)
-  else
-    []
-  end
-end
-
-# @param [Array] args
-def namespace_from_args(args)
-  match_index = args.find_index { |arg| %w[-n --namespace].include?(arg) }
-  return nil unless match_index
-
-  args[match_index + 1]
-end
-
-# Add namespace to kube query
-def add_ns(kube_query)
-  kube_query += " -n #{@namespace}" if @namespace
-  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...
-end
+# frozen_string_literal: true
+
+require "open3"
+require 'English'
+require_relative "helm_upgrade_logs/version"
+
+ENV["helm_upgrade_logs_log_start"] ||= "90"
+ENV["helm_upgrade_logs_pod_start"] ||= "35"
+
+# Approach not ideal as it will for all containers to be ready and want to stream logs before that
+def wait_for_container_ready
+  wait_pid = Process.spawn 'kubectl wait --for=condition=ContainersReady pod --selector "app.kubernetes.io/managed-by=Helm" --timeout=30s'
+  Process.wait wait_pid
+end
+
+# Wait for very first pods with logs to be present
+# Not ideal due to https://github.com/kubernetes/kubernetes/issues/28746
+def wait_for_pod_to_log
+  ENV["helm_upgrade_logs_log_start"].to_i.times do |i|
+    break unless Process.waitpid(@helm_pid, Process::WNOHANG).nil?
+
+    sleep 1
+    stdout, stderr, = Open3.capture3(add_ns("kubectl logs -lapp.kubernetes.io/instance=#{@release_name}"))
+    if stderr.empty? && !stdout.strip.empty?
+      puts "[INFO] Pods with logs found"
+      break
+    elsif (i % 3).zero?
+      puts "[INFO] Waiting for pod logs: #{stderr}"
+    end
+  end
+end
+
+# Wait for logs from a specific pod
+def wait_for_specific_pod_to_log(pod_name)
+  ENV["helm_upgrade_logs_pod_start"].to_i.times do |i|
+    sleep 1
+    stdout, stderr, = Open3.capture3(add_ns("kubectl logs #{pod_name}"))
+    if stderr.empty? && !stdout.strip.empty?
+      puts "[INFO] Pod #{pod_name} with logs found"
+      break
+    elsif i.even?
+      puts "[INFO] Waiting for pod #{pod_name} logs: #{stderr}"
+    end
+  end
+end
+
+# Get pods
+def read_pods
+  stdout, stderr, = Open3.capture3(add_ns("kubectl get pods -lapp.kubernetes.io/instance=#{@release_name} -o name"))
+  if stderr.empty?
+    stdout.lines.collect(&:strip)
+  else
+    []
+  end
+end
+
+# @param [Array] args
+def namespace_from_args(args)
+  match_index = args.find_index { |arg| %w[-n --namespace].include?(arg) }
+  return nil unless match_index
+
+  args[match_index + 1]
+end
+
+# Add namespace to kube query
+def add_ns(kube_query)
+  kube_query += " -n #{@namespace}" if @namespace
+  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...
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helm_upgrade_logs
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.6
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-06-29 00:00:00.000000000 Z
+date: 2022-08-24 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
@@ -66,7 +66,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: Basic wrapper around helm and kubectl to allow easy debugging of a helm release.