helmsnap 0.6.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00d1a53c6e09960c8a7b6d21e9998aba27e0765959b4450f2e433754440fe65b
-  data.tar.gz: 0f9fc47f9897eb76745e817528646ac340e43e39fad563a8370560bde810274f
+  metadata.gz: c06eb415d8391af30d789fdf0a28d93c1fd3eeec961927623ee124f4a97c27da
+  data.tar.gz: 1955829609e08db79e13150e4fc96c3cd30df8242f08e00976040c407d2fba0d
 SHA512:
-  metadata.gz: d014a938da2ea497e3e751f5cb600940ccb77a1d7bd297399a7b3380ac74c2d5a47bb9b4c31f6a540992c72d3e1012540d19b264e49d3498ffc282cb4f63b68a
-  data.tar.gz: 17614166a76919b0353d7bf322062047c546c3256826758ef5d0991bf66e30ee7ad0552c117ebad489ecba205e7c4771340dde7c947975cd1101895954eb8fe9
+  metadata.gz: 8f58ea04641722e5adc18e604eb770e8bc1cf64b3db94fc450cd932d7e79e779c00fe88abbf676377499f6e4ec6179a1831f0688fee26fd77dbdc1d21fc99448
+  data.tar.gz: 11a731bf61117fbd8671b56993860b3fc35367d16699297bd962a61d990b187491199a4b06646c911ead81cb5677d8d259b6917737b9b0b6f48d3cca865ef7e8

data/Gemfile.lock

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

data/README.md

@@ -2,7 +2,7 @@
 
 ## About
 
-Helmsnap is a tool for generating and checking helm chart snapshots. Example:
+Helmsnap is a tool for generating and checking helmfile snapshots. Example:
 
 Generate snapshots (uses `helmfile template` under the hood):
 
@@ -16,6 +16,12 @@ Generate snapshots in a temporary directory and check (diff) them against existi
 helmsnap check
 ```
 
+Just build dependencies for each release in a helmfile:
+
+```sh
+helmsnap dependencies # or `helmsnap deps`
+```
+
 Get the full description of possible arguments:
 
 ```sh
@@ -59,13 +65,13 @@ Helmsnap will automically replace all occurencies of patterns that look like tim
 
 ## Installation
 
-Just install a gem and use the provided `helmsnap` binary.
+Just install the gem and use the provided `helmsnap` binary.
 
 ```sh
 gem install helmsnap
 ```
 
-Alaternatively, you can use a [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 locally.
+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.
 
 ## CI example
 

data/lib/helmsnap/args_parser.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 class Helmsnap::ArgsParser
+  InvalidConfigPath = Class.new(RuntimeError)
+
   Args = Struct.new(:config_path)
 
-  DEFAULT_CONFIG_PATH = ".helmsnap.yaml"
+  DEFAULT_CONFIG_PATH = Pathname.new(".helmsnap.yaml")
   CONFIG_PATH_HELP = %{Path to config (default: "#{DEFAULT_CONFIG_PATH}")}
   BANNER = "Usage: helmsnap CMD [options]"
 
@@ -16,8 +18,8 @@ class Helmsnap::ArgsParser
   def get_options!
     parser.parse!(options)
     args
-  rescue OptionParser::ParseError => error
-    print_help!(error)
+  rescue OptionParser::ParseError, InvalidConfigPath => error
+    print_help!(error.message)
   end
 
   def print_help!(msg)
@@ -32,15 +34,21 @@ class Helmsnap::ArgsParser
 
   def build_parser
     OptionParser.new(BANNER, 50) do |opts|
-      opts.separator("Supported commands: `generate` and `check`.")
+      opts.separator("Supported commands: `generate`, `check` and `dependencies`.")
       opts.separator("")
       opts.separator("Specific options:")
 
       opts.on("-c", "--config CONFIG_PATH", CONFIG_PATH_HELP) do |val|
-        args.config_path = Pathname.new(val)
+        path = Pathname.new(val)
+
+        unless path.file? && path.readable?
+          raise InvalidConfigPath, "Not a readable file: #{val}"
+        end
+
+        args.config_path = path
       end
 
-      opts.on("--version", "Show version") do
+      opts.on("-v", "--version", "Show version") do
         Helmsnap::Console.print($stdout, "#{Helmsnap::VERSION}\n")
         exit
       end

data/lib/helmsnap/config.rb

@@ -4,9 +4,15 @@ class Helmsnap::Config
   attr_reader :envs, :snapshots_path
 
   DEFAULT_ENV = "default"
+  DEFAULT_SNAPSHOTS_PATH = "helm/snapshots"
 
   def initialize(config_path)
-    yaml = YAML.load_file(config_path.to_s)
+    if config_path.exist?
+      yaml = YAML.load_file(config_path.to_s)
+    else
+      yaml = {}
+    end
+
     self.envs = parse_envs(yaml)
     self.snapshots_path = parse_snaphots_path(yaml)
   end
@@ -16,13 +22,11 @@ class Helmsnap::Config
   attr_writer :envs, :snapshots_path
 
   def parse_envs(yaml)
-    # TODO: check value type
     value = yaml.fetch("envs", [DEFAULT_ENV])
     value.map { |x| Helmsnap::Env.new(x) }
   end
 
   def parse_snaphots_path(yaml)
-    # TODO: chekc value type/presence
-    Pathname.new(yaml.fetch("snapshotsPath"))
+    Pathname.new(yaml.fetch("snapshotsPath", DEFAULT_SNAPSHOTS_PATH))
   end
 end

data/lib/helmsnap/env.rb

@@ -1,19 +1,20 @@
 # frozen_string_literal: true
 
 class Helmsnap::Env
-  attr_reader :name, :release_paths
+  attr_reader :name
 
   def initialize(name)
     self.name = name
-    self.release_paths = get_release_paths
   end
 
-  private
+  def release_paths
+    @release_paths ||= begin
+      json = Helmsnap.run_cmd("helmfile", "--environment", name, "list", "--output", "json").output
+      YAML.load(json).map { |x| Pathname.new(x.fetch("chart")) }
+    end
+  end
 
-  attr_writer :name, :release_paths
+  private
 
-  def get_release_paths
-    json = Helmsnap.run_cmd("helmfile", "--environment", name, "list", "--output", "json").output
-    YAML.load(json).map { |x| x.fetch("chart") }
-  end
+  attr_writer :name
 end

data/lib/helmsnap/generate.rb

@@ -10,9 +10,7 @@ class Helmsnap::Generate < Helmsnap::Service
   def call
     FileUtils.rmtree(snapshots_path)
 
-    config.envs.flat_map(&:release_paths).uniq.each do |release_path|
-      Helmsnap::SetupDependencies.call(release_path)
-    end
+    Helmsnap::SetupDependencies.call(config)
 
     config.envs.each do |env|
       run_cmd(

data/lib/helmsnap/runner.rb

@@ -26,6 +26,8 @@ class Helmsnap::Runner < Helmsnap::Service
       generate!
     when "check"
       check!
+    when "dependencies", "deps"
+      setup_deps!
     else
       parser.print_help!("Unknown command: #{cmd}.")
     end
@@ -55,4 +57,8 @@ class Helmsnap::Runner < Helmsnap::Service
       exit 1
     end
   end
+
+  def setup_deps!
+    Helmsnap::SetupDependencies.call(config)
+  end
 end

data/lib/helmsnap/setup_dependencies.rb

@@ -1,12 +1,22 @@
 # frozen_string_literal: true
 
 class Helmsnap::SetupDependencies < Helmsnap::Service
-  def initialize(chart_path)
+  def initialize(config)
     super()
-    self.chart_path = Pathname.new(chart_path)
+    self.config = config
   end
 
   def call
+    config.envs.flat_map(&:release_paths).uniq.each do |chart_path|
+      setup!(chart_path)
+    end
+  end
+
+  private
+
+  attr_accessor :config
+
+  def setup!(chart_path)
     dep_list = run_cmd("helm", "dependency", "list", "--max-col-width", 0, chart_path).output
 
     dep_list.scan(%r{file://(.+?)\t}) do |dep_path|
@@ -19,8 +29,4 @@ class Helmsnap::SetupDependencies < Helmsnap::Service
 
     run_cmd("helm", "dependency", "update", "--skip-refresh", chart_path)
   end
-
-  private
-
-  attr_accessor :chart_path
 end

data/lib/helmsnap/version.rb

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

metadata

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