helmsnap 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 926b5a2923e842e0fe10f3d2050e785a0a140edbb0c3de40c30880e9e7dac3ba
-  data.tar.gz: 5f99aaac6f14b66727365bbde866896f9c75bd98e129d48de07d76ebdd7ff6a2
+  metadata.gz: bd784fcd78ea76eeb09743cf411b599c9cd6ab2299a1a647a037d0dcc667cdb0
+  data.tar.gz: a53928f8100827b1cd738840abff6ab43d875c0d44f5c7400023aa185d5ffeb3
 SHA512:
-  metadata.gz: 1ba861f010040454c80b4413f3b5e7b74213e0ad041f6c8311ca8295bfb06b71a04a98323f2b6714691e2450f0ce54897ff340a2534cfa66cd79f73884741614
-  data.tar.gz: 4e164358cf3084a01fc026fcf44670939c6871035883afde758624f31b31739a6fc48d610e9a6a81204fef8535e9c417c95e705c02998a07edf7913e28a16745
+  metadata.gz: 9e5f7c1f7516cf65c9bcb3dde36977e739a5973ec7eaf7147380b797c9acc271b889a637fe6b9d3a6764839ed8362270e77c8160cc0fbcab1aee9775421c7c07
+  data.tar.gz: 12d305a44dfc9c07956aa84ad5c221a7bf2b404888be7750de6bdcd06617c69d13e9c0a1846e2f07157b029a55b23b867a541014e550f6d94e62989a569494a7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    helmsnap (0.3.0)
+    helmsnap (0.4.1)
       colorize
 
 GEM

data/README.md

@@ -28,6 +28,8 @@ The typical usage flow:
 2. You add `helmsnap check` command to your CI (or run it manually on every commit).
 3. In case snapshots differ, you should carefully check the updates and either fix your chart or update the snapshots using `helmsnap generate`.
 
+This tool can also be useful when you are developing a new chart or updating an existing one: you can generate snapshots and see what is rendered without need to deploy the chart in your cluster.
+
 ## Features
 
 ### Helm dependency management
@@ -55,9 +57,7 @@ Example job for Gitlab CI:
 ```yaml
 check-snapshots:
   stage: test
-  image:
-    name: ghcr.io/tycooon/helmsnap:master
-    entrypoint: []
+  image: ghcr.io/tycooon/helmsnap:latest
   script: helmsnap check -c helm/mychart -s helm/snapshots -v helm/values/production.yaml
 ```
 

data/lib/helmsnap/check.rb

@@ -12,21 +12,24 @@ class Helmsnap::Check
   end
 
   def call
-    Dir.mktmpdir do |temp_dir|
-      temp_dir_path = Pathname.new(temp_dir)
+    temp_dir_path = Pathname.new(Dir.mktmpdir)
 
-      Helmsnap::Generate.call(
-        chart_path: chart_path,
-        snapshots_path: temp_dir_path,
-        values_path: values_path,
-      )
+    Helmsnap::Generate.call(
+      chart_path: chart_path,
+      snapshots_path: temp_dir_path,
+      values_path: values_path,
+    )
 
-      result = Helmsnap.run_cmd("which", "colordiff", allow_failure: true)
-      util = result.success ? "colordiff" : "diff"
+    result = Helmsnap.run_cmd("which", "colordiff", allow_failure: true)
+    util = result.success ? "colordiff" : "diff"
 
-      diff = Helmsnap.run_cmd(util, "-r", temp_dir_path, snapshots_path, allow_failure: true).output
-      diff.strip.empty?
-    end
+    diff = Helmsnap.run_cmd(
+      util, "--unified", "--recursive", snapshots_path, temp_dir_path, allow_failure: true
+    ).output
+
+    diff.strip.empty?
+  ensure
+    FileUtils.rmtree(temp_dir_path)
   end
 
   private

data/lib/helmsnap/command.rb

@@ -36,9 +36,9 @@ class Helmsnap::Command
       success = exit_status.success?
 
       if !success && !allow_failure
-        Helmsnap::Console.error(stderr, err.read, :red)
-        Helmsnap::Console.error(stderr, "Command failed with status #{exit_status.to_i}", :red)
-        abort
+        Helmsnap::Console.error(stderr, err.read)
+        Helmsnap::Console.error(stderr, "Command failed with status #{exit_status.to_i}")
+        exit 1
       end
 
       Helmsnap::Console.print(stdout, "\n")

data/lib/helmsnap/runner.rb

@@ -46,10 +46,19 @@ class Helmsnap::Runner
     if Helmsnap::Check.call(**options.to_h)
       Helmsnap::Console.info($stdout, "Snapshots are up-to-date.")
     else
+      example_cmd = Shellwords.join(
+        [
+          "helmsnap", "generate",
+          "--chart-dir", options.chart_path,
+          "--snapshots-dir", options.snapshots_path,
+          "--values", options.values_path
+        ],
+      )
+
       Helmsnap::Console.error(
         $stdout,
-        "Snapshots are outdated, you should check the diff above and either fix your chart or " \
-        "update the snapshots using `helmsnap generate` command.",
+        "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}",
       )
 
       exit 1

data/lib/helmsnap/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helmsnap
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Yuri Smirnov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-27 00:00:00.000000000 Z
+date: 2021-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize