helmsnap 0.7.3 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ffc691f40a8c6b4f4d28d2379e21e45cc032bf743f71d5cf0df9de0a35f69fe4
-  data.tar.gz: b50966b9642e57d6a286e0e20e8dd323711aafeb4723a245125d9e522b05547b
+  metadata.gz: 594265027f90c4a67adaf63dc8f1cad703f020a755d1c9a4f038549641637b37
+  data.tar.gz: 9171632fcf284a60529ea55cf76fd4e79cd8b759b7a2a9eb20bcb832c3d5ed11
 SHA512:
-  metadata.gz: 2f4bb8e9617bc866856f5160933fc7a755b441ed397374a57ed7cf9b01625b795163a448154af200af5b830bbf46107d45397fe35380d236a45e978ee66c09dd
-  data.tar.gz: b63cab9f3767a79586beec2279a4b490c3ff144b426482504233e7a19741dd168bb90c8f21b96a2fc83b32e5ea962f7a970faecf043bf1880e3ce461cf2ed101
+  metadata.gz: 5f0adbcd7556e6a76a35d3955f4f774bde0131f4eaa13066f31a8a4cf1880f0ba1e0378f2bf614d2cab7ea1057cd21e5cf65ff2d9fddb871252c90ae39a7214d
+  data.tar.gz: 21948d7c1025f749d195730bd65678b2d9129b01d0caddfe12b9c786c2de695592ce16412343025115b7d012544b4da704037f294411b9a51875553f7c0611b2

data/Dockerfile

@@ -4,7 +4,7 @@ RUN apk add --update --no-cache ruby git colordiff
 
 WORKDIR /wd
 
-COPY --from=quay.io/roboll/helmfile:v0.142.0 /usr/local/bin/helmfile /usr/local/bin/helmfile
+COPY --from=quay.io/roboll/helmfile:v0.144.0 /usr/local/bin/helmfile /usr/local/bin/helmfile
 COPY . .
 
 RUN gem install colorize && gem build && gem install helmsnap --local

data/Gemfile.lock

@@ -1,91 +1,89 @@
 PATH
   remote: .
   specs:
-    helmsnap (0.7.3)
+    helmsnap (0.7.5)
       colorize
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4.1)
+    activesupport (7.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     ast (2.4.2)
     coderay (1.1.3)
     colorize (0.8.1)
-    concurrent-ruby (1.1.9)
-    diff-lcs (1.4.4)
-    i18n (1.8.11)
+    concurrent-ruby (1.1.10)
+    diff-lcs (1.5.0)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     method_source (1.0.0)
-    minitest (5.14.4)
-    parallel (1.21.0)
-    parser (3.0.3.1)
+    minitest (5.15.0)
+    parallel (1.22.1)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    rack (2.2.3)
-    rainbow (3.0.0)
+    rack (2.2.3.1)
+    rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.2.0)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.3)
-    rubocop (1.17.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.30.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.7.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.14.0)
-      parser (>= 3.0.1.1)
-    rubocop-config-umbrellio (1.17.0.53)
-      rubocop (= 1.17.0)
-      rubocop-performance (= 1.10.0)
-      rubocop-rails (= 2.9.1)
-      rubocop-rake (= 0.5.1)
-      rubocop-rspec (= 2.2.0)
-      rubocop-sequel (= 0.2.0)
-    rubocop-performance (1.10.0)
-      rubocop (>= 0.90.0, < 2.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-config-umbrellio (1.30.0.65)
+      rubocop (~> 1.30.0)
+      rubocop-performance (~> 1.14.0)
+      rubocop-rails (~> 2.14.2)
+      rubocop-rake (~> 0.6.0)
+      rubocop-rspec (~> 2.11.1)
+      rubocop-sequel (~> 0.3.3)
+    rubocop-performance (1.14.0)
+      rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    rubocop-rails (2.9.1)
+    rubocop-rails (2.14.2)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 0.90.0, < 2.0)
-    rubocop-rake (0.5.1)
-      rubocop
-    rubocop-rspec (2.2.0)
+      rubocop (>= 1.7.0, < 2.0)
+    rubocop-rake (0.6.0)
       rubocop (~> 1.0)
-      rubocop-ast (>= 1.1.0)
-    rubocop-sequel (0.2.0)
+    rubocop-rspec (2.11.1)
+      rubocop (~> 1.19)
+    rubocop-sequel (0.3.3)
       rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
-    zeitwerk (2.5.1)
 
 PLATFORMS
   arm64-darwin-21
+  ruby
   x86_64-darwin-20
   x86_64-linux
 
@@ -98,4 +96,4 @@ DEPENDENCIES
   rubocop-config-umbrellio
 
 BUNDLED WITH
-   2.2.33
+   2.3.14

data/README.md

@@ -57,11 +57,11 @@ You can also override configuration file location using `--config` option.
 
 ### Helm dependency management
 
-Helmsnap will automically rebuild your chart dependencies on every snapshot generation or check. In case your dependency is using url to some local helm repo and you don't have a proper repo added, it will add it automically which is useful in CI. It also will detect local dependencies (those that start with `file://`) and rebuild their dependencies as well.
+Helmsnap will automatically rebuild your chart dependencies on every snapshot generation or check. In case your dependency is using url to some local helm repo and you don't have a proper repo added, it will add it automatically which is useful in CI. It also will detect local dependencies (those that start with `file://`) and rebuild their dependencies as well.
 
 ### Timestamp replacement
 
-Helmsnap will automically replace all occurencies of patterns that look like timestamps (format like `2022-01-01 00:00:00.000`) in your templates. This is useful in case you have some annotations like `releaseTime` that would break your snapshots checks otherwise.
+Helmsnap will automatically replace all occurencies of patterns that look like timestamps (format like `2022-01-01 00:00:00.000`) in your templates. This is useful in case you have some annotations like `releaseTime` that would break your snapshots checks otherwise.
 
 ## Installation
 
@@ -71,7 +71,11 @@ Just install the gem and use the provided `helmsnap` binary.
 gem install helmsnap
 ```
 
-Alaternatively, you can use the [Docker image](https://github.com/tycooon/helmsnap/pkgs/container/helmsnap) with Ruby, helm and helmsnap gem preinstalled. This is useful for CIs or if you don't want to install Ruby and Helmfile on your machine.
+Alaternatively, you can use the [Docker image](https://github.com/tycooon/helmsnap/pkgs/container/helmsnap) with Ruby, helm and helmsnap gem preinstalled. This is useful for CIs or if you don't want to install Ruby and Helmfile on your machine. Here is an example docker command that can be used to generate snapshots:
+
+```sh
+docker run --rm -it -w /wd -v $PWD:/wd ghcr.io/tycooon/helmsnap helmsnap generate
+```
 
 ## CI example
 

data/lib/helmsnap/command.rb

@@ -7,8 +7,8 @@ class Helmsnap::Command < Helmsnap::Service
     super()
     self.cmd = cmd
     self.output = +""
-    self.stdout = stdout
-    self.stderr = stderr
+    self.stdout = stdout || null_file
+    self.stderr = stderr || null_file
     self.allow_failure = allow_failure
   end
 
@@ -21,6 +21,10 @@ class Helmsnap::Command < Helmsnap::Service
 
   attr_accessor :cmd, :output, :stdout, :stderr, :allow_failure
 
+  def null_file
+    File.open(File::NULL, "w")
+  end
+
   def run_command
     Open3.popen3(cmd) do |_in, out, err, wait_thr|
       while (chunk = out.gets)

data/lib/helmsnap/generate.rb

@@ -8,10 +8,10 @@ class Helmsnap::Generate < Helmsnap::Service
   end
 
   def call
-    FileUtils.rmtree(snapshots_path)
-
     Helmsnap::SetupDependencies.call(config)
 
+    FileUtils.rmtree(snapshots_path)
+
     config.envs.each do |env|
       run_cmd(
         "helmfile",

data/lib/helmsnap/runner.rb

@@ -51,7 +51,10 @@ class Helmsnap::Runner < Helmsnap::Service
       Helmsnap::Console.error(
         $stdout,
         "Snapshots are outdated. You should check the diff above and either fix your chart or " \
-        "update the snapshots using the following command:\n> #{example_cmd}",
+        "update the snapshots using the following command:\n> #{example_cmd}\n" \
+        "Please make sure that you have the latest version of helmsnap installed!\n\n" \
+        "In case you don't have Ruby on your machine, you can use the following Docker command:\n" \
+        "> docker run --rm -it -w /wd -v $PWD:/wd ghcr.io/tycooon/helmsnap #{example_cmd}",
       )
 
       exit 1

data/lib/helmsnap/setup_dependencies.rb

@@ -4,38 +4,42 @@ class Helmsnap::SetupDependencies < Helmsnap::Service
   def initialize(config)
     super()
     self.config = config
+    self.processed_paths = Set.new
   end
 
   def call
-    config.envs.flat_map(&:release_paths).uniq.each do |chart_path|
+    config.envs.flat_map(&:release_paths).each do |chart_path|
       setup!(chart_path)
     end
   end
 
   private
 
-  attr_accessor :config
+  attr_accessor :config, :processed_paths
 
   def setup!(chart_path)
+    normalized_path = chart_path.expand_path
+    return if processed_paths.include?(normalized_path)
+    processed_paths << normalized_path
+
     dep_list = get_dependency_list(chart_path)
 
     dep_list.scan(%r{file://(.+?)\t}) do |dep_path|
-      run_cmd("helm", "dependency", "update", chart_path.join(dep_path.first))
+      subchart_path = chart_path.join(dep_path.first)
+      setup!(subchart_path)
     end
 
     dep_list.scan(%r{(https?://.+?)\t}) do |dep_path|
       run_cmd("helm", "repo", "add", Digest::MD5.hexdigest(dep_path.first), dep_path.first)
     end
 
-    run_cmd("helm", "dependency", "update", chart_path)
+    update_deps!(chart_path)
   end
 
   def get_dependency_list(chart_path)
     base_cmd = ["helm", "dependency", "list", chart_path]
 
-    result = run_cmd(
-      *base_cmd, "--max-col-width", 0, allow_failure: true, stderr: File.open(File::NULL, "w")
-    )
+    result = run_cmd(*base_cmd, "--max-col-width", 0, allow_failure: true, stderr: nil)
 
     if result.success
       result.output
@@ -47,4 +51,11 @@ class Helmsnap::SetupDependencies < Helmsnap::Service
       end
     end
   end
+
+  def update_deps!(chart_path)
+    base_cmd = ["helm", "dependency", "update", chart_path]
+    result = run_cmd(*base_cmd, "--skip-refresh", allow_failure: true)
+    run_cmd(*base_cmd) unless result.success # Try with deps refresh in case of any failure
+    true
+  end
 end

data/lib/helmsnap/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Helmsnap
-  VERSION = "0.7.3"
+  VERSION = "0.8.0"
 end

data/lib/helmsnap.rb

@@ -6,6 +6,7 @@ require "open3"
 require "optparse"
 require "pathname"
 require "shellwords"
+require "set"
 require "tmpdir"
 require "yaml"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helmsnap
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.8.0
 platform: ruby
 authors:
 - Yuri Smirnov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-15 00:00:00.000000000 Z
+date: 2022-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -92,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.3.14
 signing_key:
 specification_version: 4
 summary: A tool for creating and checking helm chart snapshots.