helm_upgrade_logs 0.1.2 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1548a7c6316fbac1e944820b1b8e762d45d9f70592daacd825b688231a7a819
-  data.tar.gz: 0b0fe2f6b84bcc798c4cee1a41b1615a497a11ccbeb6b4c76bbb8708e1518628
+  metadata.gz: 2a29eb6e997adbed6f0efe098cbb272dfad2d134975caf54870e347de9346dae
+  data.tar.gz: 0bedaf088081958db6cfe90271d6e0138ab217f4392fbadc4252edbb9ed6771a
 SHA512:
-  metadata.gz: fbfa619f21a1e8f4b73ff646616556b2090686bc4dff46c31f8dd9d5eb0bac2bab0974d27c63804e42c2272c30710ebeeda94ef0120944409560e5578c63c54f
-  data.tar.gz: 96a1a1d4efdf94b83471d2472f437c5333418cd1a477558c50a04da611caa08a20873b3708c1685ec10552c28b99a9346aa390e0067ab78f7882e4d62aa58f16
+  metadata.gz: 0db53c0194211e9b8dde1c1fc817d3f23d462549fd45e7c55adff91beab54e394ae623e36229065d40041fa6b2fa2fe29f8a9818f37ae62d55b96b4ec4dca1fd
+  data.tar.gz: 332be004b62aac72c654948cab38ad0174a180614cdefa74afcc927d10b46172df947ed62dbc8179ef72ea088dbd075acfbf7cfc2122752e1c5247563ad4f6e1

data/.github/workflows/test.yml

@@ -17,8 +17,29 @@ permissions:
   contents: read
 
 jobs:
-  test:
-
+  demo_install_run_gem:
+    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 }}
+      - 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
+        run: helm repo add bitnami https://charts.bitnami.com/bitnami
+      - name: Helm install debugging logs
+        run: helm_upgrade_logs --install nginx bitnami/nginx --wait --debug --set service.type=ClusterIP
+
+  test_exe:
     runs-on: ubuntu-latest
     strategy:
       matrix:
@@ -26,41 +47,13 @@ jobs:
 
     steps:
     - uses: actions/checkout@v3
-#     - name: Set up Ruby
-#     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-#     # change this to (see https://github.com/ruby/setup-ruby#versioning):
-#     # uses: ruby/setup-ruby@v1
-#       uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
-#       with:
-#         ruby-version: ${{ matrix.ruby-version }}
-#         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
-    - name: Test
+    - name: Start KIND cluster
       run: bash -f bin/start_kind.sh
-    - name: Waiting for KIND cluster to get ready
-      run: sleep 70
+#    - 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 through gem exe
-      run: ./exe/helm_upgrade_logs --install nginx bitnami/nginx --wait --debug --set service.type=ClusterIP
-#    - name: Check pods
-#      run: kubectl get pods --all-namespaces
-#    - name: Check Events
-#      run: kubectl get events --all-namespaces
-#
-#    - name: Check logs
-#      run: kubectl logs -lapp.kubernetes.io/managed-by=Helm -f
-#    - name: helm upgrade install
-#      run: helm upgrade --install nginx bitnami/nginx --wait --debug --set service.type=ClusterIP
-#      continue-on-error: true
-#    - name: Check pods
-#      run: sleep 15 && kubectl get pods --all-namespaces
-#    - name: Check Events
-#      run: sleep 7 && kubectl get events --all-namespaces
-#    - name: Run from local
-#      run: bash bin/helm_upgrade_logs.sh --install nginx2 bitnami/nginx --wait --debug --set service.type=ClusterIP
-
-#    - name: Helm upgrade with logs
-#      run: curl -s https://raw.githubusercontent.com/SamuelGarrattIqa/helm_upgrade_logs/main/exe/helm_upgrade_logs | bash -s -- --install nginx2 bitnami/nginx --wait
-
-#     - name: Run tests
-#       run: bundle exec rake
+    - name: Install bitnami
+      run: ./exe/helm_upgrade_logs --install nginx bitnami/nginx --wait --debug --set service.type=ClusterIP --set replicaCount=2
+    - name: Install Redis
+      run: ./exe/helm_upgrade_logs --install redis bitnami/redis --set auth.enabled=false --version 14.0.2 --wait

data/CHANGELOG.md

@@ -1,5 +1,11 @@
-## [Unreleased]
+## [0.1.6] - 2022-04-17
 
-## [0.1.0] - 2022-04-14
+- Add `helm_test_logs` exe to check logs during `helm test`
 
-- Initial release
+## [0.1.5] - 2022-04-16
+
+- Only look at logs for release name
+
+## [0.1.4] - 2022-04-16
+
+- Wait for pods with logs to start before watching

data/README.md

@@ -20,10 +20,24 @@ Or install it yourself as:
 
 ## Usage
 
-Still not working in a proper sense of a gem but the following kinda works if you want to install a release called `nginx` from the chart `bitnami/nginx`.
+This gem is purely about an `exe` to wrap around `helm` commands and to log helpful commands.
+Once installed, install/upgrade a helm chart with
 
+```bash
+helm_upgrade_logs --install redis bitnami/redis --set auth.enabled=false --version 14.0.2 --wait
 ```
-curl -s https://gitlab.com/samuel-garratt/helm_upgrade_logs/-/raw/master/bin/helm_upgrade_logs.sh | bash -s -- --install nginx bitnami/nginx
+
+After the `helm_upgrade_logs` command put any options that would normally add after `helm upgrade`.
+
+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`.
+
+```
+curl -s https://raw.githubusercontent.com/SamuelGarrattIqa/helm_upgrade_logs/main/bin/helm_upgrade_logs.sh | bash -s -- --install nginx bitnami/nginx
 ```
 
 ## Development
@@ -34,7 +48,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/helm_upgrade_logs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://gitlab.com/samuel-garratt/helm_upgrade_logs/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/SamuelGarrattIqa/helm_upgrade_logs. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/SamuelGarrattIqa/helm_upgrade_logs/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -42,4 +56,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the HelmUpgradeLogs project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://gitlab.com/samuel-garratt/helm_upgrade_logs/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the HelmUpgradeLogs project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/SamuelGarrattIqa/helm_upgrade_logs/blob/main/CODE_OF_CONDUCT.md).

data/bin/start_kind.sh

@@ -55,7 +55,7 @@ done
 
 # Assign Deafults
 CLUSTER_NAME=${CLUSTER_NAME:-"testcluster"} # NOT USING THIS. Does not provide benefit for 1 cluster on kind
-KIND_VERSION=${KIND_VERSION:-v0.11.0}
+KIND_VERSION=${KIND_VERSION:-v0.12.0}
 KUBECTL_VERSION=${KUBECTL_VERSION:-v1.20.4}
 HELM_VERSION=${HELM_VERSION:-v3.8.0}
 

data/exe/helm_test_logs

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'helm_upgrade_logs'
+
+$release_name = ARGV.find { |arg| !arg.start_with?('-') }
+
+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"
+
+Process.wait helm_pid
+puts `kill #{log_pid}`

data/exe/helm_upgrade_logs

@@ -1,15 +1,21 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require 'open3'
 $LOAD_PATH.unshift File.join(File.dirname(__FILE__), "..", "lib")
 require 'helm_upgrade_logs'
 
+$release_name = ARGV.find { |arg| !arg.start_with?('-') }
+
 helm_pid = Process.spawn "helm upgrade #{ARGV.join(' ')}"
 
 event_pid = Process.spawn 'kubectl get events --watch-only=true'
-sleep 5
-log_pid = Process.spawn 'kubectl logs -lapp.kubernetes.io/managed-by=Helm -f --all-containers --prefix --pod-running-timeout=20s'
+service_pid = Process.spawn 'kubectl get services --watch-only=true'
+
+wait_for_pod_to_log
+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"
 
 Process.wait helm_pid
 puts `kill #{log_pid}`
 puts `kill #{event_pid}`
+puts `kill #{service_pid}`

data/lib/helm_upgrade_logs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HelmUpgradeLogs
-  VERSION = "0.1.2"
+  VERSION = "0.1.5"
 end

data/lib/helm_upgrade_logs.rb

@@ -1,7 +1,29 @@
 # frozen_string_literal: true
 
+require 'open3'
 require_relative "helm_upgrade_logs/version"
 
+# 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
+# Not ideal due to https://github.com/kubernetes/kubernetes/issues/28746
+def wait_for_pod_to_log
+  90.times {
+    sleep 1
+    stdout, stderr, _ = Open3.capture3 "kubectl logs -lapp.kubernetes.io/managed-by=Helm,app.kubernetes.io/instance=#{$release_name}"
+    if stderr.empty? && !stdout.strip.empty?
+      puts 'Pods with logs found'
+      break
+    else
+      puts "Waiting for pod logs: #{stderr}"
+    end
+  }
+end
+
 module HelmUpgradeLogs
   class Error < StandardError; end
   # Your code goes here...

metadata

@@ -1,20 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: helm_upgrade_logs
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors:
 - Samuel Garratt
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-15 00:00:00.000000000 Z
+date: 2022-04-16 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
 email:
 - samuel.garratt@sentify.co
 executables:
+- helm_test_logs
 - helm_upgrade_logs
 extensions: []
 extra_rdoc_files: []
@@ -38,6 +39,7 @@ files:
 - bin/helm_upgrade_logs.sh
 - bin/setup
 - bin/start_kind.sh
+- exe/helm_test_logs
 - exe/helm_upgrade_logs
 - helm_upgrade_logs.gemspec
 - lib/helm_upgrade_logs.rb