helm_upgrade_logs 0.2.3 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5195e2b08d8a4c6838d8cbf16fa070551bed1953008f46873d6f41ac07c829d
-  data.tar.gz: 338bab0411ebc7e0a059b66392a30342187a6a9fb1ba623a3796baee331a5119
+  metadata.gz: b684e4674b966c9d98079db28468bf57ef4001864339ee751fcac7f732f8ec6e
+  data.tar.gz: 159438d7491016b11312941dd3fe9a7ff9a89234587243e0ce879bf5675af6f1
 SHA512:
-  metadata.gz: 5d7b9c585181eef228e5bdaebacbc3d5d1764e6d0bbcb6aeb62db8389482f2011bba423d4d836dae44c8c16d0e2c94cab8352ef60b5376cb884b46ed2e858c75
-  data.tar.gz: 1417cbbe9bcbcc02501d62c30eac1b6d13b9ee8bbe060f577e2342d188539e215ea73c32d25a072bb3f401a29fd3436a5a8de524ebdd73fce829d820eed459a3
+  metadata.gz: 9617547cfeb95b3b547196844bfa8cdfc20b33246b28c6b65b274dd2cba2a0271dfbe0574f96eb46daf50fb413ec10d6a45412d8010d94500ec3fa90710a9fcb
+  data.tar.gz: 67e19d49ffdd9ad203de6c7adb82f4344e35fb2b8637d2e32fb6f9df83c1d552cf63506ea67e3ce2c0a714f72b2b1a841256c7d418e57356d445cfc6dc6e6c0e

data/.github/workflows/test.yml

@@ -30,8 +30,6 @@ jobs:
           ruby-version: ${{ matrix.ruby-version }}
       - name: Start KIND cluster
         run: bash -f bin/start_kind.sh
-      - name: Waiting for KIND cluster to get ready
-        run: sleep 70
       - name: Install gem
         run: gem install helm_upgrade_logs
       - name: Add bitnami repo
@@ -39,6 +37,21 @@ jobs:
       - name: Helm install debugging logs
         run: helm_upgrade_logs --install nginx bitnami/nginx --wait --debug --set service.type=ClusterIP
 
+  unit_test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.0']
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Run tests
+        run: bundle exec rake
+
   test_exe:
     runs-on: ubuntu-latest
     strategy:
@@ -49,11 +62,11 @@ jobs:
     - uses: actions/checkout@v3
     - name: Start KIND cluster
       run: bash -f bin/start_kind.sh
-#    - name: Waiting for KIND cluster to get ready
-#      run: sleep 70
     - name: Add bitnami repo
       run: helm repo add bitnami https://charts.bitnami.com/bitnami
     - name: Install bitnami
       run: ./exe/helm_upgrade_logs --install nginx bitnami/nginx --wait --debug --set service.type=ClusterIP --set replicaCount=2
+    - 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

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 3.0
 
 Style/StringLiterals:
   Enabled: true

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## [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
+
 ## [0.2.3] - 2022-04-20
 
 - Configuration on initial wait for pods logs and subsequent wait limits

data/README.md

@@ -51,9 +51,6 @@ However if you do want to try it, to install `nginx` from the chart `bitnami/ngi
 curl -s https://raw.githubusercontent.com/SamuelGarrattIqa/helm_upgrade_logs/main/bin/helm_upgrade_logs.sh | bash -s -- --install nginx bitnami/nginx
 ```
 
-## TODO
-* Make library handle `n`, `--namespace` from helm command
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -9,4 +9,4 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[spec rubocop]
+task default: %i[spec]

data/exe/helm_test_logs

@@ -2,13 +2,16 @@
 # frozen_string_literal: true
 
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
-require 'helm_upgrade_logs'
+require "helm_upgrade_logs"
 
-$release_name = ARGV.find { |arg| !arg.start_with?('-') }
+@release_name = ARGV.find { |arg| !arg.start_with?("-") }
+@namespace = namespace_from_args(ARGV)
 
-helm_pid = Process.spawn "helm test #{ARGV.join(' ')}"
+helm_pid = Process.spawn "helm test #{ARGV.join(" ")}"
 
-log_pid = Process.spawn "kubectl logs -lapp.kubernetes.io/managed-by=Helm,app.kubernetes.io/instance=#{$release_name} -f --all-containers --prefix --ignore-errors=true --max-log-requests=20 --timestamps=true"
+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
-puts `kill #{log_pid}`
+helm_status = $CHILD_STATUS.exitstatus
+`kill #{log_pid}`
+exit helm_status

data/exe/helm_upgrade_logs

@@ -1,42 +1,54 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'open3'
+require "open3"
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
-require 'helm_upgrade_logs'
+require "helm_upgrade_logs"
 
-$release_name = ARGV.find { |arg| !arg.start_with?('-') }
+@release_name = ARGV.find { |arg| !arg.start_with?("-") }
+@namespace = namespace_from_args(ARGV)
 
-helm_pid = Process.spawn "helm upgrade #{ARGV.join(' ')}"
+@helm_pid = Process.spawn "helm upgrade #{ARGV.join(" ")}"
 
-event_pid = Process.spawn 'kubectl get events --watch-only=true'
-service_pid = Process.spawn 'kubectl get services --watch-only=true'
+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 = {}
 
-while Process.waitpid(helm_pid, Process::WNOHANG) == nil do
-  pods = get_pods
+begin
+  Process.waitpid(@helm_pid, Process::WNOHANG)
+rescue Errno::ECHILD
+  `kill #{event_pid}`
+  `kill #{service_pid}`
+  raise HelmUpgradeLogs::Error, "Failed to find logs before helm finished"
+end
+
+while Process.waitpid(@helm_pid, Process::WNOHANG).nil?
+  pods = read_pods - pods_before_upgrade
   if pods != @pods
     @pods = pods
-    puts "[INFO] Pods: #{pods.join(',')}"
+    puts "[INFO] Pods: #{pods.join(",")}"
     # Could change this each to Parallel.each
     @pods.each do |pod|
-      if @pod_pids[pod].nil?
-        wait_for_specific_pod_to_log pod
-        log_pid = Process.spawn "kubectl logs #{pod} -f --all-containers --prefix --ignore-errors=true --timestamps=true"
-        @pod_pids[pod] = log_pid
-      end
+      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
     end
   end
   sleep 1
 end
+helm_status = $CHILD_STATUS.exitstatus
 `kill #{event_pid}`
 `kill #{service_pid}`
-@pod_pids.each do |pod, pid|
+@pod_pids.each do |_pod, pid|
   `kill #{pid}`
 end
-
-
+exit helm_status

data/lib/helm_upgrade_logs/version.rb

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

data/lib/helm_upgrade_logs.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
-require 'open3'
+require "open3"
+require 'English'
 require_relative "helm_upgrade_logs/version"
 
-ENV['helm_upgrade_logs_log_start'] ||= '90'
-ENV['helm_upgrade_logs_pod_start'] ||= '35'
+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
@@ -12,43 +13,61 @@ def wait_for_container_ready
   Process.wait wait_pid
 end
 
-# Wait for pods with logs to be present
+# 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|
+  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 "kubectl logs -lapp.kubernetes.io/instance=#{$release_name}"
+    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'
+      puts "[INFO] Pods with logs found"
       break
-    else
-      puts "[INFO] Waiting for pod logs: #{stderr}" if i % 3 == 0
+    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|
+  ENV["helm_upgrade_logs_pod_start"].to_i.times do |i|
     sleep 1
-    stdout, stderr, _ = Open3.capture3 "kubectl logs #{pod_name}"
+    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
-    else
-      puts "[INFO] Waiting for pod #{pod_name} logs: #{stderr}" if i % 2 == 0
+    elsif i.even?
+      puts "[INFO] Waiting for pod #{pod_name} logs: #{stderr}"
     end
   end
 end
 
-def get_pods
-  stdout, stderr, _ = Open3.capture3 "kubectl get pods -lapp.kubernetes.io/instance=#{$release_name} -o name"
+# 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 { |pod| pod.strip }
+    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
+
 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.3
+  version: 0.2.6
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-20 00:00:00.000000000 Z
+date: 2022-04-21 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
@@ -41,7 +41,6 @@ files:
 - bin/start_kind.sh
 - exe/helm_test_logs
 - exe/helm_upgrade_logs
-- get_pods.rb
 - helm_upgrade_logs.gemspec
 - lib/helm_upgrade_logs.rb
 - lib/helm_upgrade_logs/version.rb

data/get_pods.rb

@@ -1,7 +0,0 @@
-require 'open3'
-
-$release_name = 'redis'
-stdout, stderr, _ = Open3.capture3 "kubectl get pods -lapp.kubernetes.io/managed-by=Helm,app.kubernetes.io/instance=#{$release_name} -o name"
-if stderr.empty?
-  puts stdout.lines.join(',')
-end