helmsnap 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d23d2a85913e1acb605cf90521fdcf9f9ce6a3c95bfcecc24b1aae69a68d33a6
-  data.tar.gz: 927df5851020d802c04de2c2ebcb8e0c8078869087e7db735c39f02d1168b6bf
+  metadata.gz: ae526f7e855d2833a340fc35f9363f212fcfe687aebca504dc0e99e704c6393e
+  data.tar.gz: 41787e81ec544fc491d2273763a837594415a7792c823faf07fab94e72388845
 SHA512:
-  metadata.gz: 25a1d7514779a13e738169c2119bfc9ea27b1f5f092d2ac15fc381749763a5210efc07a8b52546eb7bc4045b3a6330d0e37176c8eea8bfb756176564551dfdda
-  data.tar.gz: 3ae5fe678eb301418175f688adc06478b7ac5b7e775d9a9e16e1bf5fcb97c8d48ed763fd7895ccddabe21d2e72e26acfb3616340ce1b4ab630d1ad0898b8baff
+  metadata.gz: 65fc8371b350ab030be1503d392b0a2fd5abbe9d68c64bffa1b44662d1c8339e3358b3e15d63de723498732e67540c8d1768272983213cbd7d0f0be47a6c4b1b
+  data.tar.gz: 3370e09e93f1a0d6b43eb2913046ce44c73905c8f61f6ce79601b627795b2aa69f67c1f7f110fa0f9ef39e0eabe6bf926633d2431d7250ac714d94ed819db3b0

data/.dockerignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Dockerfile

@@ -0,0 +1,12 @@
+FROM alpine/helm
+
+RUN apk add --update --no-cache ruby git colordiff
+
+WORKDIR /app
+
+COPY . .
+
+RUN gem install colorize && gem build && gem install helmsnap --local
+
+ENTRYPOINT []
+CMD []

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    helmsnap (0.1.0)
+    helmsnap (0.4.0)
+      colorize
 
 GEM
   remote: https://rubygems.org/
@@ -14,6 +15,7 @@ GEM
       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)
@@ -84,6 +86,7 @@ GEM
 
 PLATFORMS
   x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   helmsnap!
@@ -94,4 +97,4 @@ DEPENDENCIES
   rubocop-config-umbrellio
 
 BUNDLED WITH
-   2.2.31
+   2.2.32

data/README.md

@@ -1,38 +1,69 @@
 # Helmsnap
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/helmsnap`. To experiment with that code, run `bin/console` for an interactive prompt.
+## About
 
-TODO: Delete this and the text above, and describe your gem
+Helmsnap is a tool for generating and checking helm chart snapshots. Example:
 
-## Installation
+Generate snapshots (uses `helm template` under the hood):
+
+```sh
+helmsnap generate -c helm/mychart -s helm/snapshots -v helm/values/production.yaml
+```
+
+Generate snapshots in some temp directory and check (diff) them against existing snapshots in `helm/snapshots` directory:
 
-Add this line to your application's Gemfile:
+```sh
+helmsnap check -c helm/mychart -s helm/snapshots -v helm/values/production.yaml
+```
+
+Get the full description of possible arguments:
 
-```ruby
-gem 'helmsnap'
+```sh
+helmsnap --help
 ```
 
-And then execute:
+The typical usage flow:
 
-    $ bundle install
+1. You generate some snapshots using `helmsnap generate` command and check them into your git repo.
+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`.
 
-Or install it yourself as:
+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.
 
-    $ gem install helmsnap
+## Features
 
-## Usage
+### Helm dependency management
 
-TODO: Write usage instructions here
+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.
 
-## Development
+### Timestamp replacement
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+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.
+
+## Installation
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+Just install a 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.
+
+## CI example
+
+Example job for Gitlab CI:
+
+```yaml
+check-snapshots:
+  stage: test
+  image: ghcr.io/tycooon/helmsnap:latest
+  script: helmsnap check -c helm/mychart -s helm/snapshots -v helm/values/production.yaml
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/tycooon/helmsnap.
+Bug reports and pull requests are welcome.
 
 ## License
 

data/helmsnap.gemspec

@@ -30,5 +30,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "colorize"
+
   spec.add_development_dependency "rubocop-config-umbrellio"
 end

data/lib/helmsnap/args_parser.rb

@@ -4,6 +4,8 @@ class Helmsnap::ArgsParser
   Args = Struct.new(:chart_path, :snapshots_path, :values_path, keyword_init: true)
   MissingOption = Class.new(OptionParser::ParseError)
 
+  BANNER = "Usage: helmsnap CMD [options]"
+
   def initialize(options)
     self.options = options
     self.args = Args.new
@@ -21,8 +23,8 @@ class Helmsnap::ArgsParser
   end
 
   def print_help!(msg)
-    puts msg, nil
-    puts parser.help
+    Helmsnap::Console.error($stderr, "#{msg}\n") if msg
+    Helmsnap::Console.print($stdout, parser.help)
     exit 1
   end
 
@@ -30,9 +32,8 @@ class Helmsnap::ArgsParser
 
   attr_accessor :options, :parser, :args
 
-  def build_parser
-    OptionParser.new do |opts|
-      opts.banner = "Usage: helmsnap CMD [options]"
+  def build_parser # rubocop:disable Metrics/MethodLength
+    OptionParser.new(BANNER, 50) do |opts|
       opts.separator("Supported commands: `generate` and `check`.")
       opts.separator("")
       opts.separator("Specific options:")
@@ -49,8 +50,13 @@ class Helmsnap::ArgsParser
         args.values_path = pn(option)
       end
 
+      opts.on("--version", "Show version") do
+        Helmsnap::Console.print($stdout, "#{Helmsnap::VERSION}\n")
+        exit
+      end
+
       opts.on("-h", "--help", "Show this message") do
-        puts opts
+        print_help!(nil)
         exit
       end
     end

data/lib/helmsnap/check.rb

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

data/lib/helmsnap/command.rb

@@ -1,38 +1,48 @@
 # frozen_string_literal: true
 
 class Helmsnap::Command
+  Result = Struct.new(:success, :output)
+
   def self.call(...)
     new(...).call
   end
 
-  def initialize(cmd)
+  def initialize(cmd, stdout: $stdout, stderr: $stderr, allow_failure: false)
     self.cmd = cmd
+    self.stdout = stdout
+    self.stderr = stderr
+    self.allow_failure = allow_failure
   end
 
   def call
-    puts "\e[1m\e[33m#{cmd}\e[0m\e[22m"
+    Helmsnap::Console.info(stdout, "> #{cmd}")
+    run_command
+  end
+
+  private
 
-    Open3.popen3(cmd) do |_stdin, stdout, stderr, wait_thr|
+  attr_accessor :cmd, :stdout, :stderr, :allow_failure
+
+  def run_command
+    Open3.popen3(cmd) do |_in, out, err, wait_thr|
       output = +""
 
-      while (chunk = stdout.gets)
-        $stdout.print(chunk)
+      while (chunk = out.gets)
+        Helmsnap::Console.print(stdout, chunk)
         output << chunk
       end
 
       exit_status = wait_thr.value
+      success = exit_status.success?
 
-      unless exit_status.success?
-        $stderr.print(stderr.read)
-        abort "Command failed with status #{exit_status.to_i}"
+      if !success && !allow_failure
+        Helmsnap::Console.error(stderr, err.read)
+        Helmsnap::Console.error(stderr, "Command failed with status #{exit_status.to_i}")
+        abort
       end
 
-      puts
-      output
+      Helmsnap::Console.print(stdout, "\n")
+      Result.new(success, output)
     end
   end
-
-  private
-
-  attr_accessor :cmd
 end

data/lib/helmsnap/console.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Helmsnap::Console
+  extend self
+
+  def print(stream, msg)
+    stream.print(msg)
+  end
+
+  def info(stream, msg)
+    msg = ColorizedString[msg].colorize(:light_yellow)
+    stream.puts(msg)
+  end
+
+  def error(stream, msg)
+    msg = ColorizedString[msg].colorize(:light_red)
+    stream.puts(msg)
+  end
+end

data/lib/helmsnap/generate.rb

@@ -12,21 +12,21 @@ class Helmsnap::Generate
   end
 
   def call
-    dep_list = run_cmd!("helm", "dependency", "list", "--max-col-width", 0, 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|
-      run_cmd!("helm", "dependency", "update", "--skip-refresh", chart_path.join(dep_path.first))
+      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)
+      run_cmd("helm", "repo", "add", Digest::MD5.hexdigest(dep_path.first), dep_path.first)
     end
 
-    run_cmd!("helm", "dependency", "update", "--skip-refresh", chart_path)
+    run_cmd("helm", "dependency", "update", "--skip-refresh", chart_path)
 
     FileUtils.rmtree(snapshots_path)
 
-    run_cmd!(
+    run_cmd(
       "helm", "template", chart_path, "--values", values_path, "--output-dir", snapshots_path
     )
 
@@ -41,7 +41,7 @@ class Helmsnap::Generate
 
   attr_accessor :chart_path, :snapshots_path, :values_path
 
-  def run_cmd!(...)
-    Helmsnap.run_cmd!(...)
+  def run_cmd(...)
+    Helmsnap.run_cmd(...)
   end
 end

data/lib/helmsnap/runner.rb

@@ -11,7 +11,7 @@ class Helmsnap::Runner
 
   def call
     parser = Helmsnap::ArgsParser.new(args)
-    options = parser.get_options!
+    self.options = parser.get_options!
 
     cmd, *rest = args
 
@@ -25,9 +25,9 @@ class Helmsnap::Runner
 
     case cmd
     when "generate"
-      Helmsnap::Generate.call(**options.to_h)
+      generate!
     when "check"
-      Helmsnap::Check.call(**options.to_h)
+      check!
     else
       parser.print_help!("Unknown command: #{cmd}.")
     end
@@ -35,5 +35,33 @@ class Helmsnap::Runner
 
   private
 
-  attr_accessor :args
+  attr_accessor :args, :options
+
+  def generate!
+    Helmsnap::Generate.call(**options.to_h)
+    Helmsnap::Console.info($stdout, "Snapshots generated successfully.")
+  end
+
+  def check!
+    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 the following command:\n> #{example_cmd}",
+      )
+
+      exit 1
+    end
+  end
 end

data/lib/helmsnap/version.rb

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

data/lib/helmsnap.rb

@@ -8,9 +8,12 @@ require "pathname"
 require "shellwords"
 require "tmpdir"
 
+require "colorized_string"
+
 module Helmsnap
   require_relative "helmsnap/args_parser"
   require_relative "helmsnap/check"
+  require_relative "helmsnap/console"
   require_relative "helmsnap/command"
   require_relative "helmsnap/generate"
   require_relative "helmsnap/runner"
@@ -18,8 +21,8 @@ module Helmsnap
 
   class Error < StandardError; end
 
-  def self.run_cmd!(*cmd_parts)
+  def self.run_cmd(*cmd_parts, **options)
     cmd = Shellwords.join(cmd_parts)
-    Helmsnap::Command.call(cmd)
+    Helmsnap::Command.call(cmd, **options)
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: helmsnap
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
 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
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop-config-umbrellio
   requirement: !ruby/object:Gem::Requirement
@@ -32,8 +46,10 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".rspec"
 - ".rubocop.yml"
+- Dockerfile
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -47,6 +63,7 @@ files:
 - lib/helmsnap/args_parser.rb
 - lib/helmsnap/check.rb
 - lib/helmsnap/command.rb
+- lib/helmsnap/console.rb
 - lib/helmsnap/generate.rb
 - lib/helmsnap/runner.rb
 - lib/helmsnap/version.rb
@@ -71,7 +88,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.31
+rubygems_version: 3.2.32
 signing_key:
 specification_version: 4
 summary: A tool for creating and checking helm chart snapshots.