Bumps version v2.0.1 -> v2.0.2

- Streams to STDOUT for commands executed by backticks
- Fixes `rake dependency:update` not updating due to metadata.rb pins
- Fixes borked tests

Author: TheLonelyGhost

CHANGELOG.md

@@ -3,6 +3,12 @@
 We follow [Semantic Versioning](http://semver.org/) as a way of measuring stability of an update. This
 means we will never make a backwards-incompatible change within a major version of the project.
 
+## v2.0.2 (2018-09-17)
+
+- Adds missing dependencies to gemspec for berkshelf and chef (dependency management)
+- [BUG] `rake dependency:update` leaves dependencies in wrapper cookbook on older than latest allowable version, per constraints defined in `Berksfile`
+- [BUG] `berks` commands seem unresponsive due to no output to STDOUT
+
 ## v2.0.1 (2018-09-17)
 
 - Adds missing spec for minimum ruby version supported (v2.3.0 or higher in the v2.x release)

lib/rordan_gramsay.rb

@@ -8,4 +8,17 @@ def self.silence_warnings
     yield
     $VERBOSE = original_verbosity
   end
+
+  def self.stream_command(cmd)
+    require 'pty'
+    PTY.spawn(cmd) do |stdout, _stdin, _pid|
+      begin
+        stdout.each { |line| $stdout.puts(line) }
+      rescue Errno::EIO
+        nil # noop
+      end
+    end
+  rescue PTY::ChildExited
+    nil # noop
+  end
 end

lib/rordan_gramsay/chef_tasks/dependencies.rb

@@ -1,57 +1,62 @@
 require 'paint'
 require_relative '../dependencies'
+require_relative '../../rordan_gramsay'
 
 # rubocop:disable Lint/UnneededCopDisableDirective
 
 file 'Berksfile.lock' do
-  `berks install`
+  RordanGramsay.stream_command('berks install')
 end
 
 task dependency: ['dependency:check']
 
 namespace :dependency do
   desc 'Check if version pinning has been done correctly'
   task :check do
-    $stdout.puts(Paint['Inspecting version constraints for errors', :yellow, :bold])
     obj = RordanGramsay::Dependencies::Pinning.new
-    obj.check
+    obj.check do
+      $stdout.puts(Paint['Inspecting version constraints for errors', :yellow, :bold])
+    end
     abort if obj.failure?
   end
 
   desc 'Remove pinned dependencies from metadata.rb'
   task :clean do
-    $stdout.puts(Paint['Removing dependency entries from metadata.rb', :yellow, :bold])
     obj = RordanGramsay::Dependencies::Pinning.new
-    obj.clean
+    obj.clean do
+      $stdout.puts(Paint['Removing dependency entries from metadata.rb', :yellow, :bold])
+    end
     abort if obj.failure?
   end
 
   desc '[EXPERIMENTAL] Migrate cookbook dependencies from metadata.rb to Berksfile (for use with dependency:pin task)'
   task :migrate do
-    $stdout.puts(Paint['Attempting to migrate dependencies from metadata.rb to Berksfile', :yellow, :bold])
     obj = RordanGramsay::Dependencies::Pinning.new
-    obj.migrate
+    obj.migrate do
+      $stdout.puts(Paint['Attempting to migrate dependencies from metadata.rb to Berksfile', :yellow, :bold])
+    end
     abort if obj.failure?
     $stdout.puts(Paint['  This may or may not have worked. Please audit the dependencies in Berksfile', :yellow, :bold])
     $stdout.puts(Paint % ['  to ensure they look correct, then run %{cmd}', :yellow, :bold, cmd: Paint['rake dependency:update', :white, :bold]])
   end
 
   desc 'Update dependency graph'
   task :update do
-    $stdout.puts(Paint['Updating Berksfile.lock', :yellow, :bold])
-    `berks update`
-
-    $stdout.puts(Paint['Pinning dependencies from Berksfile to metadata.rb', :yellow, :bold])
     obj = RordanGramsay::Dependencies::Pinning.new
-    obj.call
+    obj.update do
+      $stdout.puts(Paint['Updating Berksfile.lock', :yellow, :bold])
+      RordanGramsay.stream_command('berks update')
+      $stdout.puts(Paint['Pinning dependencies from Berksfile to metadata.rb', :yellow, :bold])
+    end
     abort if obj.failure?
   end
 
   desc 'Pin dependencies'
   task :pin do
-    $stdout.puts(Paint['Pinning dependencies from Berksfile to metadata.rb', :yellow, :bold])
     obj = RordanGramsay::Dependencies::Pinning.new
-    obj.call
+    obj.call do
+      $stdout.puts(Paint['Pinning dependencies from Berksfile to metadata.rb', :yellow, :bold])
+    end
     abort if obj.failure?
   end
 end

lib/rordan_gramsay/chef_tasks/test.rb

@@ -12,3 +12,4 @@
 
 require_relative 'lint'
 require_relative 'kitchen'
+require_relative 'dependencies'

lib/rordan_gramsay/dependencies.rb

@@ -2,6 +2,7 @@
 require 'berkshelf'
 require 'chef/cookbook/metadata'
 require_relative 'exceptions'
+require_relative '../rordan_gramsay'
 
 module RordanGramsay
   module Dependencies
@@ -36,13 +37,67 @@ def berksfile_lock
         end
       rescue FileMissing
         $stdout.puts('berks install')
-        out = `berks install`
+        RordanGramsay.stream_command('berks install')
         retry if $CHILD_STATUS.success?
-        raise out
       end
     end
 
     # :nodoc:
+    module Helpers
+      def initialize
+        super
+        @is_fail = false
+      end
+
+      def failure?
+        @is_fail
+      end
+
+      private
+
+      def version_from_constraint(constraint)
+        constraint.strip.gsub(/[^0-9.]+/, '')
+      end
+
+      def corrected_constraint(cookbook, constraint)
+        # Correct constraints `~> 0.1.0` or `~> 4.9`
+        return constraint if constraint =~ /^\s*~>\s*[1-9][0-9]*\.\d+\s*$/
+        return constraint if constraint =~ /^\s*~>0\.\d+\.\d+\s*$/
+
+        version = version_from_constraint(constraint).split('.')
+        major = version.shift || '0'
+        minor = version.shift || '0'
+        patch = version.shift || '0'
+
+        if major == '0' && minor == '0' && patch == '0'
+          # Pull in the latest version from berksfile_lock and "correct"
+          # that version as if it is a constraint. This is so we can apply
+          # some sort of reasonable version constraint on `0.0.0` dependencies
+          version = berksfile_lock.graph.find(cookbook).version
+
+          corrected_constraint(cookbook, "~> #{version}")
+        elsif major == '0'
+          "~> #{major}.#{minor}.#{patch}"
+        else
+          "~> #{major}.#{minor}"
+        end
+      end
+
+      def report_change(cookbook, previous, now)
+        return if previous == now
+        $stderr.puts(Paint % ['  %{cookbook} : %{previous} -> %{now}', cookbook: Paint[cookbook, :white, :bold], now: Paint[now, :green], previous: Paint[previous, :yellow]])
+      end
+
+      def log_error(msg, opts = {})
+        @is_fail = true
+        $stderr.puts(msg)
+        raise NextIteration if opts[:next]
+      end
+    end
+
+    # This is the main entry point if you don't know/care what cookbook
+    # type whose dependencies you're managing. It should match all methods
+    # on the public interface of both `WrapperPinning` or `CookbookPinning`
     class Pinning
       extend Forwardable
       include FileAccessor
@@ -55,7 +110,7 @@ def initialize
                end
       end
 
-      def_delegators :@obj, :call, :check, :clean, :migrate, :dependencies, :failure?
+      def_delegators :@obj, :call, :check, :clean, :migrate, :update, :dependencies, :failure?
     end
 
     # Most cookbooks should use this, unless you desire a layout
@@ -65,16 +120,11 @@ def initialize
     # `WrapperPinning` class.
     class CookbookPinning
       include FileAccessor
-
-      def initialize
-        @is_fail = false
-      end
-
-      def failure?
-        @is_fail
-      end
+      include Helpers
 
       def call
+        yield if block_given?
+
         File.open('metadata.new.rb', 'w') do |fd|
           File.readlines(metadata.source_file).each do |line|
             next if line =~ /\bdepends\b/i
@@ -98,6 +148,8 @@ def call
       end
 
       def clean
+        yield if block_given?
+
         File.open('metadata.new.rb', 'w') do |fd|
           File.readlines(metadata.source_file).each do |line|
             next if line =~ /\bdepends\b/i
@@ -110,6 +162,8 @@ def clean
       end
 
       def check
+        yield if block_given?
+
         berksfile
         metadata.dependencies.each do |(cookbook, constraint)|
           next if constraint =~ /^\s*~>\s*[1-9][0-9]*\.\d+\s*$/
@@ -150,11 +204,43 @@ def migrate
         @berksfile = nil
         File.unlink(berksfile_lock.source_file)
         @berksfile_lock = nil
-
         clean
+
+        yield if block_given?
         call
       end
 
+      def update
+        deps = metadata.dependencies.dup
+        clean
+        if block_given?
+          yield
+        else
+          RordanGramsay.stream_command('berks update')
+        end
+
+        File.open('metadata.new.rb', 'w') do |fd|
+          File.readlines(metadata.source_file).each do |line|
+            next if line =~ /\bdepends\b/i
+            fd.puts(line)
+          end
+
+          dependencies.each do |(cookbook, constraint)|
+            old = deps[cookbook]
+            if old
+              report_change(cookbook, old, constraint)
+            else
+              report_change(cookbook, '<missing>', constraint)
+            end
+
+            fd.puts(%(depends '#{cookbook}', '#{constraint}'))
+          end
+        end
+
+        File.rename('metadata.new.rb', metadata.source_file)
+        @metadata = nil # Because we just modified it, clear cache
+      end
+
       def dependencies
         @dependencies ||= begin
           berksfile.dependencies.each_with_object({}) do |item, deps|
@@ -167,53 +253,13 @@ def dependencies
           end
         end
       end
-
-      private
-
-      def version_from_constraint(constraint)
-        constraint.strip.gsub(/[^0-9.]+/, '')
-      end
-
-      def corrected_constraint(cookbook, constraint)
-        # Correct constraints `~> 0.1.0` or `~> 4.9`
-        return constraint if constraint =~ /^\s*~>\s*[1-9][0-9]*\.\d+\s*$/
-        return constraint if constraint =~ /^\s*~>0\.\d+\.\d+\s*$/
-
-        version = version_from_constraint(constraint).split('.')
-        major = version.shift || '0'
-        minor = version.shift || '0'
-        patch = version.shift || '0'
-
-        if major == '0' && minor == '0' && patch == '0'
-          # Pull in the latest version from berksfile_lock and "correct"
-          # that version as if it is a constraint. This is so we can apply
-          # some sort of reasonable version constraint on `0.0.0` dependencies
-          version = berksfile_lock.graph.find(cookbook).version
-
-          corrected_constraint(cookbook, "~> #{version}")
-        elsif major == '0'
-          "~> #{major}.#{minor}.#{patch}"
-        else
-          "~> #{major}.#{minor}"
-        end
-      end
-
-      def report_change(cookbook, previous, now)
-        return if previous == now
-        $stderr.puts(Paint % ['  %{cookbook} : %{previous} -> %{now}', cookbook: Paint[cookbook, :white, :bold], now: Paint[now, :green], previous: Paint[previous, :yellow]])
-      end
-
-      def log_error(msg, opts = {})
-        @is_fail = true
-        $stderr.puts(msg)
-        raise NextIteration if opts[:next]
-      end
     end
 
     # Pinning specifics for role- and wrapper-cookbooks
     class WrapperPinning < CookbookPinning
       def check
-        @is_fail = false
+        yield if block_given?
+
         deps = metadata.dependencies.each_with_object({}) do |(cookbook, constraint), dep|
           dep[cookbook] = constraint
         end

lib/rordan_gramsay/version.rb

@@ -1,5 +1,5 @@
 module RordanGramsay
-  VERSION = '2.0.1'.freeze
+  VERSION = '2.0.2'.freeze
   EXECUTABLE = 'gramsay'.freeze
   GEM_NAME = 'rordan_gramsay'.freeze
 end

rordan_gramsay.gemspec

@@ -21,6 +21,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '~> 2.3'
 
+  spec.add_runtime_dependency 'berkshelf'
+  spec.add_runtime_dependency 'chef'
   spec.add_runtime_dependency 'cookstyle', '~> 3.0'
   spec.add_runtime_dependency 'foodcritic', '~> 14.0'
   spec.add_runtime_dependency 'paint', '~> 2.0'

spec/rake/test_spec.rb

@@ -45,9 +45,10 @@
       expect(all_tasks).to include 'test:quick'
     end
 
-    it "should defer to 'lint:all'" do
+    it "should defer to 'lint:all' and 'dependency:check'" do
       out = run_command('rake --dry-run test:quick')
       expect(out).to include 'lint:all'
+      expect(out).to include 'dependency:check'
     end
   end