helm_upgrade_logs 0.2.2 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa3f3a0b230ebece6f834e3f1d350f7dce7efdc38e9798f6e88e2c2ac2e4ebea
-  data.tar.gz: '09b2dc417d34ceada26ea29976dceab275d035c69da9fac86afbf613b2f239b1'
+  metadata.gz: 05d454e1aeebb7122327e049f950b33f35161484018f71fbc2d49482e8830bf3
+  data.tar.gz: 3482c02fd2cc6c0a4ce397f8d08aba0a95b75a31c8d43ae595df6bb61bfce442
 SHA512:
-  metadata.gz: 6b079a3c801b1cfc3ed7ebfe43b669e8845cf02bb2980e541e58fe1b049d4138e0cbb120a64099e97335bc95b0b98f2510a934299ff470251ebf56bf247cfbb3
-  data.tar.gz: 40d106a0b06352621fc90cfb8653fbc3f279d8676d438eeb592e6fa94a39bc896f8a690df4a6633654d410f9bae5600605790fbcd1bdbf33c95aa114d9403053
+  metadata.gz: 19398249dbecf3c5e8b6d05eca07e33a9c950a6399cc954f4d9db103c25a0824abb770b2972c0fa9b113f6313650610edd5593eac5110a702e1133dc28371331
+  data.tar.gz: eb1efb17c3b164b4c4c6e49be16cb7db923d7c96321e2f0e9089ee7e06faf2f79699e9813d60d679de77dad266bbcaffd4ea4cffd2fed12095664761b00cea1a

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.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
+
 ## [0.2.2] - 2022-04-20
 
 - Wait for logs on each pod having a process for logging each pod

data/README.md

@@ -20,7 +20,9 @@ Or install it yourself as:
 
 ## Usage
 
-This gem is purely about an `exe` to wrap around `helm` commands and to log helpful commands.
+This gem is purely about an `exe` to wrap around `helm` commands and to log events and pod logs that happen as
+part of that release while it is being released. 
+
 Once installed, install/upgrade a helm chart with
 
 ```bash
@@ -29,12 +31,21 @@ helm_upgrade_logs --install redis bitnami/redis --set auth.enabled=false --versi
 
 After the `helm_upgrade_logs` command put any options that would normally add after `helm upgrade`.
 
+This library waits for logs to start in pods for 90 seconds or controlled by environment variable `helm_upgrade_logs_log_start`.
+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`
+
 To test a chart showing it logs, in a similar way run
 ```bash
 helm_test_logs redis
 ```
 
-This also has a bash script which can be used directly. E.g., to install `nginx` from the chart `bitnami/nginx`.
+### Aside bash script
+
+This also has a bash script which can be used directly although it will probably not work on CI
+and also does not close background processes so not ideal.
+
+However if you do want to try it, to install `nginx` from the chart `bitnami/nginx` run
 
 ```
 curl -s https://raw.githubusercontent.com/SamuelGarrattIqa/helm_upgrade_logs/main/bin/helm_upgrade_logs.sh | bash -s -- --install nginx bitnami/nginx

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,51 @@
 #!/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'
+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
   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.2"
+  # @return [String] Version of helm upgrade logs
+  VERSION = "0.2.5"
 end

data/lib/helm_upgrade_logs.rb

@@ -1,51 +1,73 @@
 # 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"
+
 # 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 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
-  90.times {
+  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/managed-by=Helm,app.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 'Pods with logs found'
+      puts "[INFO] Pods with logs found"
       break
-    else
-      puts "Waiting for pod logs: #{stderr}"
+    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)
-  30.times {
+  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 "Pod #{pod_name} with logs found"
+      puts "[INFO] Pod #{pod_name} with logs found"
       break
-    else
-      puts "Waiting for pod #{pod_name} logs: #{stderr}"
+    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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: helm_upgrade_logs
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.5
 platform: ruby
 authors:
 - Samuel Garratt
@@ -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