helmsnap 0.5.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f9aee0530e4f99cd1d96fbc07be33606ed5462ebbc08540c568a30848274b85
-  data.tar.gz: e2937f100b5e2008d3db5d720a3e4d79393cc760da004bb1453ddab3485a5d50
+  metadata.gz: 82cc0b42f25f49c54cb4ec921c092f7a3e6cc9de565bc3e39e357e4129b5c3ff
+  data.tar.gz: 0fc97b6105f8a9ab5fb8360bf390be3cfaea21bc24b21edf42960b88658c54a8
 SHA512:
-  metadata.gz: 872efd529c6367ca4dfe4468eae9a9d2164e844273a14e9cacea55e07c5c5a795509c7ece536c83e0be75e319651f44ef55d05816e967c4e841b4007d74d67c2
-  data.tar.gz: fdb9c9d45daea1554f0d03083e582b6f57be0f78da265b39e4eb11f62e54a0b02fdb5e5abc91f6881c041aad3c47e5501736bd97bc244e0341342d6a4c33dce5
+  metadata.gz: f514cd9633fab8f88efac3ae96dda8579c9b8dbd2a90da8822979958c334681e0b882c498e1b4acfeda279814beeaf181fd942366b036da04100b62cbe1d9dc8
+  data.tar.gz: 5b9046c477241a66acbe1a2bc8b7f982205b49bbcf3f53edbeb1f4f516b4008f0ab4c52aeb5f829538796a1f717931588bea7abce9d33ecd9726031fe43c24dd

data/Dockerfile

@@ -2,8 +2,9 @@ FROM alpine/helm
 
 RUN apk add --update --no-cache ruby git colordiff
 
-WORKDIR /app
+WORKDIR /wd
 
+COPY --from=quay.io/roboll/helmfile:v0.142.0 /usr/local/bin/helmfile /usr/local/bin/helmfile
 COPY . .
 
 RUN gem install colorize && gem build && gem install helmsnap --local

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    helmsnap (0.5.1)
+    helmsnap (0.7.0)
       colorize
 
 GEM
@@ -23,7 +23,7 @@ GEM
     method_source (1.0.0)
     minitest (5.14.4)
     parallel (1.21.0)
-    parser (3.0.3.0)
+    parser (3.0.3.1)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
@@ -31,7 +31,7 @@ GEM
     rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.6)
-    regexp_parser (2.1.1)
+    regexp_parser (2.2.0)
     rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -55,7 +55,7 @@ GEM
       rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.13.0)
+    rubocop-ast (1.14.0)
       parser (>= 3.0.1.1)
     rubocop-config-umbrellio (1.17.0.53)
       rubocop (= 1.17.0)

data/README.md

@@ -2,18 +2,24 @@
 
 ## 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 `helm template` under the hood):
+Generate snapshots (uses `helmfile template` under the hood):
 
 ```sh
-helmsnap generate -c helm/mychart -s helm/snapshots -v helm/values/production.yaml
+helmsnap generate
 ```
 
-Generate snapshots in some temp directory and check (diff) them against existing snapshots in `helm/snapshots` directory:
+Generate snapshots in a temporary directory and check (diff) them against existing snapshots in `helm/snapshots` directory:
 
 ```sh
-helmsnap check -c helm/mychart -s helm/snapshots -v helm/values/production.yaml
+helmsnap check
+```
+
+Just build dependencies for each release in a helmfile:
+
+```sh
+helmsnap dependencies # or `helmsnap deps`
 ```
 
 Get the full description of possible arguments:
@@ -30,6 +36,23 @@ The typical usage flow:
 
 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.
 
+## Configuration
+
+By default, helmsnap will render your helmfile using `default` environment and will place snapshots in `helm/snapshots` directory. If you want to configure that, create a `.helmsnap.yaml` file and put there configuration that looks like this:
+
+```yaml
+envs: [staging, production] # `[default]` by default
+snapshotsPath: somedir/snapshots # `helm/snapshots` by default
+```
+
+You can also override configuration file location using `--config` option.
+
+## Dependencies
+
+- Ruby 2.7+.
+- [Helmfile](https://github.com/roboll/helmfile), which in turn relies on [Helm](https://github.com/helm/helm).
+- Colordiff or diff utility.
+
 ## Features
 
 ### Helm dependency management
@@ -42,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
 
@@ -58,7 +81,7 @@ Example job for Gitlab CI:
 check-snapshots:
   stage: test
   image: ghcr.io/tycooon/helmsnap:latest
-  script: helmsnap check -c helm/mychart -s helm/snapshots -v helm/values/production.yaml
+  script: helmsnap check
 ```
 
 ## Contributing

data/lib/helmsnap/args_parser.rb

@@ -1,25 +1,25 @@
 # frozen_string_literal: true
 
 class Helmsnap::ArgsParser
-  Args = Struct.new(:chart_path, :snapshots_path, :values_path, keyword_init: true)
-  MissingOption = Class.new(OptionParser::ParseError)
+  InvalidConfigPath = Class.new(RuntimeError)
 
+  Args = Struct.new(:config_path)
+
+  DEFAULT_CONFIG_PATH = Pathname.new(".helmsnap.yaml")
+  CONFIG_PATH_HELP = %{Path to config (default: "#{DEFAULT_CONFIG_PATH}")}
   BANNER = "Usage: helmsnap CMD [options]"
 
   def initialize(options)
     self.options = options
-    self.args = Args.new
+    self.args = Args.new(DEFAULT_CONFIG_PATH)
     self.parser = build_parser
   end
 
   def get_options!
     parser.parse!(options)
-    raise MissingOption, "Missing option: CHARTDIR" unless args.chart_path
-    raise MissingOption, "Missing option: SNAPDIR" unless args.snapshots_path
-    raise MissingOption, "Missing option: VALUES" unless args.values_path
     args
-  rescue OptionParser::ParseError => error
-    print_help!(error)
+  rescue OptionParser::ParseError, InvalidConfigPath => error
+    print_help!(error.message)
   end
 
   def print_help!(msg)
@@ -32,25 +32,23 @@ class Helmsnap::ArgsParser
 
   attr_accessor :options, :parser, :args
 
-  def build_parser # rubocop:disable Metrics/MethodLength
+  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", "--chart-dir CHARTDIR", "Chart directory") do |option|
-        args.chart_path = pn(option)
-      end
+      opts.on("-c", "--config CONFIG_PATH", CONFIG_PATH_HELP) do |val|
+        path = Pathname.new(val)
 
-      opts.on("-s", "--snapshots-dir SNAPDIR", "Snapshots directory") do |option|
-        args.snapshots_path = pn(option)
-      end
+        unless path.file? && path.readable?
+          raise InvalidConfigPath, "Not a readable file: #{val}"
+        end
 
-      opts.on("-v", "--values VALUES", "Values file") do |option|
-        args.values_path = pn(option)
+        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
@@ -61,8 +59,4 @@ class Helmsnap::ArgsParser
       end
     end
   end
-
-  def pn(...)
-    Pathname.new(...)
-  end
 end

data/lib/helmsnap/check.rb

@@ -1,26 +1,20 @@
 # frozen_string_literal: true
 
 class Helmsnap::Check < Helmsnap::Service
-  def initialize(chart_path:, snapshots_path:, values_path:)
+  def initialize(config)
     super()
-    self.chart_path = chart_path
-    self.snapshots_path = snapshots_path
-    self.values_path = values_path
+    self.config = config
   end
 
   def call
     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(config, snapshots_path: temp_dir_path)
 
     result = run_cmd("which", "colordiff", allow_failure: true)
     util = result.success ? "colordiff" : "diff"
 
-    cmd_parts = [util, "--unified", "--recursive", snapshots_path, temp_dir_path]
+    cmd_parts = [util, "--unified", "--recursive", config.snapshots_path, temp_dir_path]
     diff = run_cmd(*cmd_parts, allow_failure: true).output
 
     diff.strip.empty?
@@ -30,5 +24,5 @@ class Helmsnap::Check < Helmsnap::Service
 
   private
 
-  attr_accessor :chart_path, :snapshots_path, :values_path
+  attr_accessor :config
 end

data/lib/helmsnap/config.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+class Helmsnap::Config
+  attr_reader :envs, :snapshots_path
+
+  DEFAULT_ENV = "default"
+  DEFAULT_SNAPSHOTS_PATH = "helm/snapshots"
+
+  def initialize(config_path)
+    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
+
+  private
+
+  attr_writer :envs, :snapshots_path
+
+  def parse_envs(yaml)
+    value = yaml.fetch("envs", [DEFAULT_ENV])
+    value.map { |x| Helmsnap::Env.new(x) }
+  end
+
+  def parse_snaphots_path(yaml)
+    Pathname.new(yaml.fetch("snapshotsPath", DEFAULT_SNAPSHOTS_PATH))
+  end
+end

data/lib/helmsnap/env.rb

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

data/lib/helmsnap/generate.rb

@@ -1,21 +1,28 @@
 # frozen_string_literal: true
 
 class Helmsnap::Generate < Helmsnap::Service
-  def initialize(chart_path:, snapshots_path:, values_path:)
+  def initialize(config, snapshots_path: nil)
     super()
-    self.chart_path = chart_path
-    self.snapshots_path = snapshots_path
-    self.values_path = values_path
+    self.config = config
+    self.snapshots_path = snapshots_path || config.snapshots_path
   end
 
   def call
-    Helmsnap::SetupDependencies.call(chart_path)
-
     FileUtils.rmtree(snapshots_path)
 
-    run_cmd(
-      "helm", "template", chart_path, "--values", values_path, "--output-dir", snapshots_path
-    )
+    Helmsnap::SetupDependencies.call(config)
+
+    config.envs.each do |env|
+      run_cmd(
+        "helmfile",
+        "--environment",
+        env.name,
+        "template",
+        "--output-dir-template",
+        snapshots_path.join(env.name).join("{{ .Release.Name }}"),
+        "--skip-deps",
+      )
+    end
 
     snapshots_path.glob(["**/*yaml", "**/*.yml"]).each do |path|
       content = path.read
@@ -26,5 +33,5 @@ class Helmsnap::Generate < Helmsnap::Service
 
   private
 
-  attr_accessor :chart_path, :snapshots_path, :values_path
+  attr_accessor :config, :snapshots_path
 end

data/lib/helmsnap/runner.rb

@@ -9,6 +9,7 @@ class Helmsnap::Runner < Helmsnap::Service
   def call
     parser = Helmsnap::ArgsParser.new(args)
     self.options = parser.get_options!
+    self.config = Helmsnap::Config.new(options.config_path)
 
     cmd, *rest = args
 
@@ -25,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
@@ -32,25 +35,18 @@ class Helmsnap::Runner < Helmsnap::Service
 
   private
 
-  attr_accessor :args, :options
+  attr_accessor :args, :options, :config
 
   def generate!
-    Helmsnap::Generate.call(**options.to_h)
+    Helmsnap::Generate.call(config)
     Helmsnap::Console.info($stdout, "Snapshots generated successfully.")
   end
 
   def check!
-    if Helmsnap::Check.call(**options.to_h)
+    if Helmsnap::Check.call(config)
       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
-        ],
-      )
+      example_cmd = Shellwords.join(["helmsnap", "generate", "--config", options.config_path])
 
       Helmsnap::Console.error(
         $stdout,
@@ -61,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.5.1"
+  VERSION = "0.7.0"
 end

data/lib/helmsnap.rb

@@ -7,10 +7,13 @@ require "optparse"
 require "pathname"
 require "shellwords"
 require "tmpdir"
+require "yaml"
 
 require "colorized_string"
 
 module Helmsnap
+  require_relative "helmsnap/config"
+  require_relative "helmsnap/env"
   require_relative "helmsnap/service"
   require_relative "helmsnap/version"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helmsnap
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Yuri Smirnov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-04 00:00:00.000000000 Z
+date: 2021-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -63,7 +63,9 @@ files:
 - lib/helmsnap/args_parser.rb
 - lib/helmsnap/check.rb
 - lib/helmsnap/command.rb
+- lib/helmsnap/config.rb
 - lib/helmsnap/console.rb
+- lib/helmsnap/env.rb
 - lib/helmsnap/generate.rb
 - lib/helmsnap/runner.rb
 - lib/helmsnap/service.rb