helmsnap 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c1238eff1b14a2e564bd43769307c6cb94659b6c838029420bc6a95bf01bde4
-  data.tar.gz: f3c102029eb427e5d511062349007568e80a7c7b55ed6bd0adbabdf4593e0afe
+  metadata.gz: d23d2a85913e1acb605cf90521fdcf9f9ce6a3c95bfcecc24b1aae69a68d33a6
+  data.tar.gz: 927df5851020d802c04de2c2ebcb8e0c8078869087e7db735c39f02d1168b6bf
 SHA512:
-  metadata.gz: a0ca141cdc412b9f7ca384b0ce6169fedeb74796f11fa0e957e3f63f06c2e24fb3a3a957b7ce46a1af19cb884b5e3c37faca7e85935bb2db76c839e373136a96
-  data.tar.gz: ad5bccf70fc572be8d8dbd6e3f8c2ffeb166d92314c34e72a9090725c60cb60a02e6cc310f7577466a485c1113f76f90e68cb01a3a4d9dc85e0beca8e28137de
+  metadata.gz: 25a1d7514779a13e738169c2119bfc9ea27b1f5f092d2ac15fc381749763a5210efc07a8b52546eb7bc4045b3a6330d0e37176c8eea8bfb756176564551dfdda
+  data.tar.gz: 3ae5fe678eb301418175f688adc06478b7ac5b7e775d9a9e16e1bf5fcb97c8d48ed763fd7895ccddabe21d2e72e26acfb3616340ce1b4ab630d1ad0898b8baff

data/.rubocop.yml

@@ -1,13 +1,17 @@
-AllCops:
-  TargetRubyVersion: 2.6
-
-Style/StringLiterals:
-  Enabled: true
-  EnforcedStyle: double_quotes
+inherit_gem:
+  rubocop-config-umbrellio: lib/rubocop.yml
 
-Style/StringLiteralsInInterpolation:
-  Enabled: true
-  EnforcedStyle: double_quotes
-
-Layout/LineLength:
-  Max: 120
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.7
+  Include:
+    - bin/console
+    - Gemfile
+    - helmsnap.gemspec
+    - Rakefile
+    - lib/**/*
+    - spec/**/*
+    - gemfile/**/*
+  Exclude:
+    - vendor/**/*
+    - gemfiles/**/*

data/Gemfile.lock

@@ -6,16 +6,27 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.2)
     coderay (1.1.3)
+    concurrent-ruby (1.1.9)
     diff-lcs (1.4.4)
+    i18n (1.8.11)
+      concurrent-ruby (~> 1.0)
     method_source (1.0.0)
+    minitest (5.14.4)
     parallel (1.21.0)
-    parser (3.0.2.0)
+    parser (3.0.3.0)
       ast (~> 2.4.1)
     pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
+    rack (2.2.3)
     rainbow (3.0.0)
     rake (13.0.6)
     regexp_parser (2.1.1)
@@ -33,19 +44,43 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.3)
-    rubocop (1.23.0)
+    rubocop (1.17.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.12.0, < 2.0)
+      rubocop-ast (>= 1.7.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.13.0)
       parser (>= 3.0.1.1)
+    rubocop-config-umbrellio (1.17.0.53)
+      rubocop (= 1.17.0)
+      rubocop-performance (= 1.10.0)
+      rubocop-rails (= 2.9.1)
+      rubocop-rake (= 0.5.1)
+      rubocop-rspec (= 2.2.0)
+      rubocop-sequel (= 0.2.0)
+    rubocop-performance (1.10.0)
+      rubocop (>= 0.90.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.9.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 0.90.0, < 2.0)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    rubocop-sequel (0.2.0)
+      rubocop (~> 1.0)
     ruby-progressbar (1.11.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   x86_64-darwin-20
@@ -56,6 +91,7 @@ DEPENDENCIES
   rake
   rspec
   rubocop
+  rubocop-config-umbrellio
 
 BUNDLED WITH
    2.2.31

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/helmsnap

@@ -1,117 +1,6 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require "digest"
-require "fileutils"
-require "open3"
-require "optparse"
-require "pathname"
-require "shellwords"
+require_relative "../lib/helmsnap"
 
-def run(*cmd_parts)
-  cmd = Shellwords.join(cmd_parts)
-
-  puts "\e[1m\e[33m#{cmd}\e[0m\e[22m"
-
-  Open3.popen3(cmd) do |_stdin, stdout, stderr, wait_thr|
-    output = +""
-
-    while chunk = stdout.gets
-      $stdout.print(chunk)
-      output << chunk
-    end
-
-    exit_status = wait_thr.value
-
-    unless exit_status.success?
-      $stderr.print(stderr.read)
-      abort "Command failed with status #{exit_status.to_i}"
-    end
-
-    puts
-    output
-  end
-end
-
-class ArgsParser
-  Args = Struct.new(:chart, :snapshots, :values)
-  MissingOption = Class.new(OptionParser::ParseError)
-
-  def initialize(options)
-    self.options = options
-    self.args = Args.new("k8s/chart", "k8s/snapshots")
-    self.parser = build_parser
-  end
-
-  def get_options!
-    parser.parse!(options)
-    raise MissingOption, "missing option: VALUES" unless args.values
-    args
-  rescue OptionParser::ParseError => e
-    puts e, nil
-    print_help!
-    exit 1
-  end
-
-  private
-
-  attr_accessor :options, :parser, :args
-
-  def build_parser
-    OptionParser.new do |opts|
-      opts.banner = "Usage: render-helm [options]"
-
-      opts.on("-c", "--chart-dir [DIR]",
-              "Chart directory (default: #{args.chart})") do |option|
-        args.chart = option
-      end
-
-      opts.on("-s", "--snapshots-dir DIR",
-              "Snapshots directory (default #{args.snapshots})") do |option|
-        args.snapshots = option
-      end
-
-      opts.on("-v", "--values VALUES", "Values file") do |option|
-        args.values = option
-      end
-
-      opts.on("-h", "--help", "Show this message") do
-        puts opts
-        exit
-      end
-    end
-  end
-
-  def print_help!
-    puts parser.help
-  end
-end
-
-options = ArgsParser.new(ARGV).get_options!
-
-chart_path = Pathname.new(options.chart)
-snapshots_path = Pathname.new(options.snapshots)
-
-dep_list = run "helm", "dependency", "list", "--max-col-width", 0, chart_path
-
-dep_list.scan(%r{file://(.+?)\t}) do |dep_path|
-  run "helm", "dependency", "update", "--skip-refresh", chart_path.join(dep_path.first)
-end
-
-dep_list.scan(%r{(https?://.+?)\t}) do |dep_path|
-  run "helm", "repo", "add", Digest::MD5.hexdigest(dep_path.first), dep_path.first
-end
-
-run "helm", "dependency", "update", "--skip-refresh", chart_path
-
-FileUtils.rmtree(snapshots_path)
-
-run "helm", "template", chart_path,
-    "--values", options.values,
-    "--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
-  path.write(content)
-end
+Helmsnap::Runner.call(ARGV)

data/helmsnap.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
   spec.summary = "A tool for creating and checking helm chart snapshots."
   spec.homepage = "https://github.com/tycooon/helmsnap"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 2.7.0"
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
   spec.metadata["homepage_uri"] = spec.homepage
@@ -22,11 +22,13 @@ Gem::Specification.new do |spec|
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci))})
     end
   end
 
   spec.bindir = "exe"
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rubocop-config-umbrellio"
 end

data/lib/helmsnap/args_parser.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+class Helmsnap::ArgsParser
+  Args = Struct.new(:chart_path, :snapshots_path, :values_path, keyword_init: true)
+  MissingOption = Class.new(OptionParser::ParseError)
+
+  def initialize(options)
+    self.options = options
+    self.args = Args.new
+    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)
+  end
+
+  def print_help!(msg)
+    puts msg, nil
+    puts parser.help
+    exit 1
+  end
+
+  private
+
+  attr_accessor :options, :parser, :args
+
+  def build_parser
+    OptionParser.new do |opts|
+      opts.banner = "Usage: helmsnap CMD [options]"
+      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("-s", "--snapshots-dir SNAPDIR", "Snapshots directory") do |option|
+        args.snapshots_path = pn(option)
+      end
+
+      opts.on("-v", "--values VALUES", "Values file") do |option|
+        args.values_path = pn(option)
+      end
+
+      opts.on("-h", "--help", "Show this message") do
+        puts opts
+        exit
+      end
+    end
+  end
+
+  def pn(...)
+    Pathname.new(...)
+  end
+end

data/lib/helmsnap/check.rb

@@ -0,0 +1,31 @@
+# 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
+  end
+
+  def call
+    Dir.mktmpdir do |temp_dir|
+      pp temp_dir_path = Pathname.new(temp_dir)
+
+      Helmsnap::Generate.call(
+        chart_path: chart_path,
+        snapshots_path: temp_dir_path,
+        values_path: values_path,
+      )
+
+      Helmsnap.run_cmd!("colordiff", "-r", temp_dir_path, snapshots_path)
+    end
+  end
+
+  private
+
+  attr_accessor :chart_path, :snapshots_path, :values_path
+end

data/lib/helmsnap/command.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+class Helmsnap::Command
+  def self.call(...)
+    new(...).call
+  end
+
+  def initialize(cmd)
+    self.cmd = cmd
+  end
+
+  def call
+    puts "\e[1m\e[33m#{cmd}\e[0m\e[22m"
+
+    Open3.popen3(cmd) do |_stdin, stdout, stderr, wait_thr|
+      output = +""
+
+      while (chunk = stdout.gets)
+        $stdout.print(chunk)
+        output << chunk
+      end
+
+      exit_status = wait_thr.value
+
+      unless exit_status.success?
+        $stderr.print(stderr.read)
+        abort "Command failed with status #{exit_status.to_i}"
+      end
+
+      puts
+      output
+    end
+  end
+
+  private
+
+  attr_accessor :cmd
+end

data/lib/helmsnap/generate.rb

@@ -0,0 +1,47 @@
+# 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
+  end
+
+  def call
+    dep_list = run_cmd!("helm", "dependency", "list", "--max-col-width", 0, chart_path)
+
+    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)
+
+    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
+      path.write(content)
+    end
+  end
+
+  private
+
+  attr_accessor :chart_path, :snapshots_path, :values_path
+
+  def run_cmd!(...)
+    Helmsnap.run_cmd!(...)
+  end
+end

data/lib/helmsnap/runner.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+class Helmsnap::Runner
+  def self.call(...)
+    new(...).call
+  end
+
+  def initialize(args)
+    self.args = args.dup
+  end
+
+  def call
+    parser = Helmsnap::ArgsParser.new(args)
+    options = parser.get_options!
+
+    cmd, *rest = args
+
+    if cmd.nil?
+      parser.print_help!("Command not provided.")
+    end
+
+    if rest.size.positive?
+      parser.print_help!("Too many arguments.")
+    end
+
+    case cmd
+    when "generate"
+      Helmsnap::Generate.call(**options.to_h)
+    when "check"
+      Helmsnap::Check.call(**options.to_h)
+    else
+      parser.print_help!("Unknown command: #{cmd}.")
+    end
+  end
+
+  private
+
+  attr_accessor :args
+end

data/lib/helmsnap/version.rb

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

data/lib/helmsnap.rb

@@ -1,7 +1,25 @@
 # frozen_string_literal: true
 
-require_relative "helmsnap/version"
+require "digest"
+require "fileutils"
+require "open3"
+require "optparse"
+require "pathname"
+require "shellwords"
+require "tmpdir"
 
 module Helmsnap
+  require_relative "helmsnap/args_parser"
+  require_relative "helmsnap/check"
+  require_relative "helmsnap/command"
+  require_relative "helmsnap/generate"
+  require_relative "helmsnap/runner"
+  require_relative "helmsnap/version"
+
   class Error < StandardError; end
+
+  def self.run_cmd!(*cmd_parts)
+    cmd = Shellwords.join(cmd_parts)
+    Helmsnap::Command.call(cmd)
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: helmsnap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yuri Smirnov
@@ -9,7 +9,21 @@ autorequire:
 bindir: exe
 cert_chain: []
 date: 2021-11-27 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop-config-umbrellio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description:
 email:
 - tycooon@yandex.ru
@@ -26,9 +40,15 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/setup
 - exe/helmsnap
 - helmsnap.gemspec
 - lib/helmsnap.rb
+- lib/helmsnap/args_parser.rb
+- lib/helmsnap/check.rb
+- lib/helmsnap/command.rb
+- lib/helmsnap/generate.rb
+- lib/helmsnap/runner.rb
 - lib/helmsnap/version.rb
 homepage: https://github.com/tycooon/helmsnap
 licenses:
@@ -44,7 +64,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="