helmsnap 0.4.2 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a5cb05f018581cbbccdfd9114f0ce1426457d63bd4fcd69864d558a6c790be5
-  data.tar.gz: c6ff86c42987cbebe2fb71889d05dd0d11e33d0ca164a89419c75b58a6b671ab
+  metadata.gz: 8fbee3f7ea1da8f3400fa518d3f2a083b62274d9e11f11d472da24e74904de2a
+  data.tar.gz: ee79318dba8a65d214e6d64e27f4f91ee56d3c6e3ba125825ec8b627daf31b9f
 SHA512:
-  metadata.gz: 60bf1bbab69d1990b05d93bcc3b22b67318f665d431ea2b770a6eddf894a6df800d139b32cdd35d61905067fd7e52ae21d91b069d94a99736ea57d25f9968ee6
-  data.tar.gz: 804d6d566f1e6c546f1f94a9235b43ba69fb451f298987855c40a281033144fd1ee44ea53e0fdf764f1d6f2bfe29e6902fd1bb065d75f6b4eba3212feaca367a
+  metadata.gz: 80a280fe7d8f000f0706e0087cbc7607acdb1962b04ccb4154c64263dfba0ebf9fc50c086786fd2c06251fc3918762a3b83b7058344261ad615c603d1d011dde
+  data.tar.gz: 7534803fc0f920d817905a4cbdcdea81fd603daa06ce614a10cdfeee2a28a13cd82691d6c6d2217b5c987e99e2a87a7999d35362fa7304718378b63300cea2b6

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.4.2)
+    helmsnap (0.6.1)
       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

@@ -4,16 +4,16 @@
 
 Helmsnap is a tool for generating and checking helm chart 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
 ```
 
 Get the full description of possible arguments:
@@ -30,6 +30,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
@@ -58,7 +75,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,22 +32,20 @@ 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("")
       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
@@ -61,8 +59,4 @@ class Helmsnap::ArgsParser
       end
     end
   end
-
-  def pn(...)
-    Pathname.new(...)
-  end
 end

data/lib/helmsnap/check.rb

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

data/lib/helmsnap/command.rb

@@ -1,13 +1,10 @@
 # frozen_string_literal: true
 
-class Helmsnap::Command
+class Helmsnap::Command < Helmsnap::Service
   Result = Struct.new(:success, :output)
 
-  def self.call(...)
-    new(...).call
-  end
-
   def initialize(cmd, stdout: $stdout, stderr: $stderr, allow_failure: false)
+    super()
     self.cmd = cmd
     self.output = +""
     self.stdout = stdout
@@ -38,6 +35,9 @@ class Helmsnap::Command
       Helmsnap::Console.print(stdout, "\n")
       Result.new(success, output)
     end
+  rescue SystemCallError => error
+    handle_error!(error.errno, error.message)
+    Result.new(false, error.message)
   end
 
   def handle_error!(exit_status, err_output)

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,19 @@
+# frozen_string_literal: true
+
+class Helmsnap::Env
+  attr_reader :name, :release_paths
+
+  def initialize(name)
+    self.name = name
+    self.release_paths = get_release_paths
+  end
+
+  private
+
+  attr_writer :name, :release_paths
+
+  def get_release_paths
+    json = Helmsnap.run_cmd("helmfile", "--environment", name, "list", "--output", "json").output
+    YAML.load(json).map { |x| x.fetch("chart") }
+  end
+end

data/lib/helmsnap/generate.rb

@@ -1,35 +1,31 @@
 # frozen_string_literal: true
 
-class Helmsnap::Generate
-  def self.call(...)
-    new(...).call
-  end
-
-  def initialize(chart_path:, snapshots_path:, values_path:)
-    self.chart_path = chart_path
-    self.snapshots_path = snapshots_path
-    self.values_path = values_path
+class Helmsnap::Generate < Helmsnap::Service
+  def initialize(config, snapshots_path: nil)
+    super()
+    self.config = config
+    self.snapshots_path = snapshots_path || config.snapshots_path
   end
 
   def call
-    dep_list = run_cmd("helm", "dependency", "list", "--max-col-width", 0, chart_path).output
+    FileUtils.rmtree(snapshots_path)
 
-    dep_list.scan(%r{file://(.+?)\t}) do |dep_path|
-      run_cmd("helm", "dependency", "update", "--skip-refresh", chart_path.join(dep_path.first))
+    config.envs.flat_map(&:release_paths).uniq.each do |release_path|
+      Helmsnap::SetupDependencies.call(release_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)
+    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
 
-    run_cmd("helm", "dependency", "update", "--skip-refresh", chart_path)
-
-    FileUtils.rmtree(snapshots_path)
-
-    run_cmd(
-      "helm", "template", chart_path, "--values", values_path, "--output-dir", snapshots_path
-    )
-
     snapshots_path.glob(["**/*yaml", "**/*.yml"]).each do |path|
       content = path.read
       content.gsub!(/\d\d\d\d-\d\d-\d\d \d\d:\d\d:\d\d\.\d+/, "2022-01-01 00:00:00.000") or next
@@ -39,9 +35,5 @@ class Helmsnap::Generate
 
   private
 
-  attr_accessor :chart_path, :snapshots_path, :values_path
-
-  def run_cmd(...)
-    Helmsnap.run_cmd(...)
-  end
+  attr_accessor :config, :snapshots_path
 end

data/lib/helmsnap/runner.rb

@@ -1,17 +1,15 @@
 # frozen_string_literal: true
 
-class Helmsnap::Runner
-  def self.call(...)
-    new(...).call
-  end
-
+class Helmsnap::Runner < Helmsnap::Service
   def initialize(args)
+    super()
     self.args = args.dup
   end
 
   def call
     parser = Helmsnap::ArgsParser.new(args)
     self.options = parser.get_options!
+    self.config = Helmsnap::Config.new(options.config_path)
 
     cmd, *rest = args
 
@@ -35,25 +33,18 @@ class Helmsnap::Runner
 
   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,

data/lib/helmsnap/service.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class Helmsnap::Service
+  def self.call(...)
+    new(...).call
+  end
+
+  private
+
+  def run_cmd(...)
+    Helmsnap.run_cmd(...)
+  end
+end

data/lib/helmsnap/setup_dependencies.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class Helmsnap::SetupDependencies < Helmsnap::Service
+  def initialize(chart_path)
+    super()
+    self.chart_path = Pathname.new(chart_path)
+  end
+
+  def call
+    dep_list = run_cmd("helm", "dependency", "list", "--max-col-width", 0, chart_path).output
+
+    dep_list.scan(%r{file://(.+?)\t}) do |dep_path|
+      run_cmd("helm", "dependency", "update", "--skip-refresh", chart_path.join(dep_path.first))
+    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", "--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.4.2"
+  VERSION = "0.6.1"
 end

data/lib/helmsnap.rb

@@ -7,17 +7,23 @@ 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"
+
   require_relative "helmsnap/args_parser"
   require_relative "helmsnap/check"
-  require_relative "helmsnap/console"
   require_relative "helmsnap/command"
+  require_relative "helmsnap/console"
   require_relative "helmsnap/generate"
   require_relative "helmsnap/runner"
-  require_relative "helmsnap/version"
+  require_relative "helmsnap/setup_dependencies"
 
   class Error < StandardError; end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: helmsnap
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.6.1
 platform: ruby
 authors:
 - Yuri Smirnov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-01 00:00:00.000000000 Z
+date: 2021-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorize
@@ -63,9 +63,13 @@ 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
+- lib/helmsnap/setup_dependencies.rb
 - lib/helmsnap/version.rb
 homepage: https://github.com/tycooon/helmsnap
 licenses: