berkshelf 0.4.0.rc3 → 0.4.0.rc4

data/berkshelf.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'solve',           '~> 0.2.1'
   s.add_runtime_dependency 'chef',            '~> 10.12.0'
   s.add_runtime_dependency 'minitar'
-  s.add_runtime_dependency 'thor',            '~> 0.15.2'
+  s.add_runtime_dependency 'thor',            '~> 0.16.0'
 
   s.add_development_dependency 'redcarpet'
   s.add_development_dependency 'cucumber'

data/features/install.feature

@@ -258,10 +258,10 @@ Feature: install cookbooks from a Berksfile
     When I run the install command
     Then the output should contain:
       """
-      Installing artifact (0.10.0) from chef_api:
+      Installing artifact (0.10.2) from chef_api:
       """
     And the cookbook store should have the cookbooks:
-      | artifact | 0.10.0 |
+      | artifact | 0.10.2 |
     And the exit status should be 0
 
   Scenario: with a chef_api source location specifying :knife when a Knife config is not found at the given path

data/features/json_formatter.feature

@@ -0,0 +1,62 @@
+Feature: --format json
+  As a user
+  I want to be able to get all output in JSON format
+  So I can easily parse the output in scripts
+
+  Scenario: JSON output installing a cookbook from the default location
+    Given I write to "Berksfile" with:
+      """
+      cookbook "mysql", "= 1.2.4"
+      """
+    When I run the install command with flags:
+      | --format json |
+    Then the output should be JSON
+    And the JSON at "cookbooks" should have 2 cookbooks
+    And the JSON at "cookbooks/0/version" should be "1.2.4"
+    And the JSON at "cookbooks/0/location" should be "site: 'http://cookbooks.opscode.com/api/v1/cookbooks'"
+
+  Scenario: JSON output installing a cookbook we already have
+    Given the cookbook store has the cookbooks:
+      | mysql   | 1.2.4 |
+    And I write to "Berksfile" with:
+      """
+      cookbook "mysql", "= 1.2.4"
+      """
+    When I run the install command with flags:
+      | --format json |
+    Then the output should be JSON
+    And the JSON at "cookbooks" should have 1 cookbook
+    And the JSON at "cookbooks/0/version" should be "1.2.4"
+    And the JSON should not have "cookbooks/0/location"
+
+  @slow_process
+  Scenario: JSON output when running the upload command
+    Given a Berksfile with path location sources to fixtures:
+      | example_cookbook | example_cookbook-0.5.0 |
+    And the Chef server does not have the cookbooks:
+      | example_cookbook | 0.5.0 |
+    When I run the upload command with flags:
+      | --format json |
+    Then the output should be JSON
+    And the JSON at "cookbooks" should have 1 cookbook
+    And the JSON at "cookbooks/0/version" should be "0.5.0"
+    And the JSON should have "cookbooks/0/uploaded_to"
+    And the Chef server should have the cookbooks:
+      | example_cookbook | 0.5.0 |
+
+  Scenario: JSON output when running install command with the --shims flag
+    Given I write to "Berksfile" with:
+      """
+      cookbook "mysql", "1.2.4"
+      """
+    When I run the install command with flags:
+      | --shims |
+      | --format json|
+    Then the following directories should exist:
+      | cookbooks       |
+      | cookbooks/mysql |
+    And the output should be JSON
+    And the JSON should have "shims_dir"
+
+
+

data/features/step_definitions/cli_steps.rb

@@ -54,6 +54,10 @@ When /^I run the upload command$/ do
   run_simple(unescape("berks upload"), true)
 end
 
+When /^I run the upload command with flags:$/ do |flags|
+  run_simple(unescape("berks upload #{flags.raw.join(" ")}"), false)
+end
+
 When /^I run the cookbook command to create "(.*?)"$/ do |name|
   run_simple(unescape("berks cookbook #{name}"))
 end

data/features/step_definitions/json_steps.rb

@@ -0,0 +1,3 @@
+Then /^the output should be JSON$/ do
+  lambda { parse_json(all_output) }.should_not raise_error
+end

data/features/support/env.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'bundler'
 require 'spork'
+require "json_spec/cucumber"
 
 Spork.prefork do
   require 'rspec'
@@ -51,6 +52,11 @@ Spork.prefork do
   def fixtures_path
     app_root_path.join('spec/fixtures')
   end
+
+  # Set the output json_spec will parse for testing JSON responses
+  def last_json
+    all_output
+  end
 end
 
 Spork.each_run do

data/features/update.feature

@@ -16,7 +16,7 @@ Feature: update
     When I run the update command
     Then the file "Berksfile.lock" should contain exactly:
       """
-      cookbook 'mysql', :locked_version => '1.2.6'
+      cookbook 'mysql', :locked_version => '1.3.0'
       cookbook 'openssl', :locked_version => '1.0.0'
       cookbook 'windows', :locked_version => '1.3.2'
       cookbook 'chef_handler', :locked_version => '1.0.6'

data/lib/berkshelf.rb

@@ -107,6 +107,33 @@ module Berkshelf
       end
     end
 
+    # Get the appropriate Formatter object based on the formatter
+    # classes that have been registered.
+    #
+    # @return [~Formatter]
+    def formatter
+      @formatter ||= (formatters.has_key?(@_format) ? formatters[@_format] : Formatters::HumanReadable).new
+    end
+
+    # Specify a formatter identifier
+    #
+    # @param [String] format
+    #   which formatter to use
+    #
+    # @example Berkshelf.set_format "json"
+    def set_format(format)
+      @_format = format
+      @formatter = nil
+    end
+
+    # Access the formatters map that links string symbols to Formatter
+    # implementations
+    #
+    # @return [Hash]
+    def formatters
+      @formatters ||= {}
+    end
+
     private
 
       def null_stream
@@ -119,3 +146,5 @@ module Berkshelf
       end
   end
 end
+
+require 'berkshelf/formatters'

data/lib/berkshelf/berksfile.rb

@@ -126,7 +126,7 @@ module Berkshelf
       solution = resolver.resolve
       if options[:shims]
         write_shims(options[:shims], solution)
-        Berkshelf.ui.info "Shims written to: '#{options[:shims]}'"
+        Berkshelf.formatter.shims_written options[:shims]
       end
       write_lockfile(resolver.sources) unless lockfile_present?
     end
@@ -153,7 +153,7 @@ module Berkshelf
       solution = resolve(options)
 
       solution.each do |cb|
-        Berkshelf.ui.info "Uploading #{cb.cookbook_name} (#{cb.version}) to: '#{chef_server_url}'"
+        Berkshelf.formatter.upload cb.cookbook_name, cb.version, chef_server_url
         uploader.upload!(cb, options)
       end
     end
@@ -212,7 +212,7 @@ module Berkshelf
       begin
         instance_eval(content)
       rescue => e
-        raise BerksfileReadError.new(e), "An error occurred while reading the Berksfile: #{e.message}"
+        raise BerksfileReadError.new(e), "An error occurred while reading the Berksfile: #{e.to_s}"
       end
       self
     end

data/lib/berkshelf/cli.rb

@@ -4,11 +4,19 @@ require 'berkshelf'
 module Berkshelf
   # @author Jamie Winsor <jamie@vialstudios.com>
   class Cli < Thor
+    class << self
+      def dispatch(meth, given_args, given_opts, config)
+        super
+        Berkshelf.formatter.cleanup_hook unless config[:current_task].name == "help"
+      end
+    end
+    
     def initialize(*)
       super
       # JW TODO: Replace Chef::Knife::UI with our own UI class
       ::Berkshelf.ui = Chef::Knife::UI.new(STDOUT, STDERR, STDIN, {})
       ::Berkshelf.config_path = @options[:config]
+      ::Berkshelf.set_format @options[:format]
       @options = options.dup # unfreeze frozen options Hash from Thor
     end
 
@@ -26,6 +34,11 @@ module Berkshelf
       desc: "Path to Knife or Chef configuration to use.",
       aliases: "-c",
       banner: "PATH"
+    class_option :format,
+      type: :string,
+      desc: "Output format to use.",
+      aliases: "-F",
+      banner: "FORMAT"
 
     method_option :shims,
       type: :string,
@@ -44,7 +57,7 @@ module Berkshelf
       desc: "Path to a Berksfile to operate off of.",
       aliases: "-b",
       banner: "PATH"
-    desc "install", "Install the Cookbooks specified by a Berksfile or a Berskfile.lock."
+    desc "install", "Install the Cookbooks specified by a Berksfile or a Berksfile.lock."
     def install
       berksfile = ::Berkshelf::Berksfile.from_file(options[:berksfile])
       berksfile.install(options)
@@ -102,14 +115,14 @@ module Berkshelf
 
       ::Berkshelf::InitGenerator.new([path], options).invoke_all
 
-      ::Berkshelf.ui.info "Successfully initialized"
+      ::Berkshelf.formatter.msg "Successfully initialized"
     end
 
     desc "version", "Display version and copyright information"
     def version
-      Berkshelf.ui.info version_header
-      Berkshelf.ui.info "\n"
-      Berkshelf.ui.info license
+      Berkshelf.formatter.msg version_header
+      Berkshelf.formatter.msg "\n"
+      Berkshelf.formatter.msg license
     end
 
     method_option :vagrant,

data/lib/berkshelf/errors.rb

@@ -12,6 +12,8 @@ module Berkshelf
   end
 
   class InternalError < BerkshelfError; status_code(99); end
+  class MethodNotImplmentedError < ::Berkshelf::InternalError ; end
+  
   class BerksfileNotFound < BerkshelfError; status_code(100); end
   class NoVersionForConstraints < BerkshelfError; status_code(101); end
   class DownloadFailure < BerkshelfError; status_code(102); end
@@ -60,5 +62,15 @@ module Berkshelf
 
   class ConstraintNotSatisfied < BerkshelfError; status_code(111); end
   class InvalidChefAPILocation < BerkshelfError; status_code(112); end
-  class BerksfileReadError < BerkshelfError; status_code(113); end
+  class BerksfileReadError < BerkshelfError
+    def initialize(original_error)
+      @original_error = original_error
+    end
+
+    status_code(113)
+
+    def status_code
+      @original_error ? @original_error.status_code : 113
+    end
+  end
 end

data/lib/berkshelf/formatters.rb

@@ -0,0 +1,41 @@
+module Berkshelf
+  module Formatters
+    # @abstract Include and override {#install} {#use} {#upload} 
+    #   {#shims_written} {#msg} {#error} to implement.
+    #
+    #   Implement {#cleanup_hook} to run any steps required to run after the task is finished
+    module AbstractFormatter
+      def cleanup_hook
+        # run after the task is finished
+      end
+
+      def install(cookbook, version, location)
+        raise MethodNotImplmentedError, "#install must be implemented on #{self.class}"
+      end
+
+      def use(cookbook, version, path = nil)
+        raise MethodNotImplmentedError, "#install must be implemented on #{self.class}"
+      end
+
+      def upload(cookbook, version, chef_server_url)
+        raise MethodNotImplmentedError, "#upload must be implemented on #{self.class}"
+      end
+
+      def shims_written(directory)
+        raise MethodNotImplmentedError, "#shims_written must be implemented on #{self.class}"
+      end
+
+      def msg(message)
+        raise MethodNotImplmentedError, "#msg must be implemented on #{self.class}"
+      end
+
+      def error(message)
+        raise MethodNotImplmentedError, "#error must be implemented on #{self.class}"
+      end
+    end
+  end
+end
+
+Dir["#{File.dirname(__FILE__)}/formatters/*.rb"].sort.each do |path|
+  require "berkshelf/formatters/#{File.basename(path, '.rb')}"
+end

data/lib/berkshelf/formatters/human_readable.rb

@@ -0,0 +1,33 @@
+module Berkshelf
+  module Formatters
+    class HumanReadable
+      include AbstractFormatter
+
+      Berkshelf.formatters["human"] = self
+
+      def install(cookbook, version, location)
+        Berkshelf.ui.info "Installing #{cookbook} (#{version}) from #{location}"
+      end
+
+      def use(cookbook, version, path=nil)
+        Berkshelf.ui.info "Using #{cookbook} (#{version})#{' at '+path if path}"
+      end
+
+      def upload(cookbook, version, chef_server_url)
+        Berkshelf.ui.info "Uploading #{cookbook} (#{version}) to: '#{chef_server_url}'"
+      end
+
+      def shims_written(directory)
+        Berkshelf.ui.info "Shims written to: '#{directory}'"
+      end
+
+      def msg(message)
+        Berkshelf.ui.info message
+      end
+
+      def error(message)
+        Berkshelf.ui.error message
+      end
+    end
+  end
+end

data/lib/berkshelf/formatters/json.rb

@@ -0,0 +1,53 @@
+module Berkshelf
+  module Formatters
+    class JSON
+      include AbstractFormatter
+
+      Berkshelf.formatters["json"] = self
+
+      def initialize
+        @output = {cookbooks: [], errors: [], messages: []}
+        @cookbooks = {}
+        super
+      end
+
+      def cleanup_hook
+        @cookbooks.each do |name, details|
+          details[:name] = name
+          @output[:cookbooks] << details
+        end
+        print @output.to_json
+      end
+
+      def install(cookbook, version, location)
+        @cookbooks[cookbook] ||= {}
+        @cookbooks[cookbook][:version] = version
+        @cookbooks[cookbook][:location] = location
+      end
+
+      def use(cookbook, version, path=nil)
+        @cookbooks[cookbook] ||= {}
+        @cookbooks[cookbook][:version] = version
+        @cookbooks[cookbook][:location] = path if path
+      end
+
+      def upload(cookbook, version, chef_server_url)
+        @cookbooks[cookbook] ||= {}
+        @cookbooks[cookbook][:version] = version
+        @cookbooks[cookbook][:uploaded_to] = chef_server_url
+      end
+
+      def shims_written(directory)
+        @output[:shims_dir] = directory
+      end
+
+      def msg(message)
+        @output[:messages] << message
+      end
+
+      def error(message)
+        @output[:errors] << message
+      end
+    end
+  end
+end

data/lib/berkshelf/resolver.rb

@@ -126,7 +126,7 @@ module Berkshelf
       # @return [Boolean]
       def install_source(source)
         downloader.download!(source)
-        Berkshelf.ui.info "Installing #{source.name} (#{source.cached_cookbook.version}) from #{source.location}"
+        Berkshelf.formatter.install source.name, source.cached_cookbook.version, source.location
       end
 
       # Use the given source to create a constraint solution if the source has been downloaded or can
@@ -158,9 +158,8 @@ module Berkshelf
           get_source(source).cached_cookbook = cached
         end
 
-        msg = "Using #{cached.cookbook_name} (#{cached.version})"
-        msg << " at #{source.location}" if source.location.is_a?(CookbookSource::PathLocation)
-        Berkshelf.ui.info msg
+        path = source.location.is_a?(CookbookSource::PathLocation) ? "#{source.location}" : nil
+        Berkshelf.formatter.use cached.cookbook_name, cached.version, path
 
         true
       end

data/lib/berkshelf/version.rb

@@ -1,3 +1,3 @@
 module Berkshelf
-  VERSION = "0.4.0.rc3"
+  VERSION = "0.4.0.rc4"
 end

data/spec/fixtures/lockfile_spec/without_lock/Berksfile.lock

@@ -1,5 +1,5 @@
 cookbook 'nginx', :locked_version => '0.101.0'
-cookbook 'build-essential', :locked_version => '1.0.2'
+cookbook 'build-essential', :locked_version => '1.1.0'
 cookbook 'runit', :locked_version => '0.15.0'
-cookbook 'bluepill', :locked_version => '1.0.4'
+cookbook 'bluepill', :locked_version => '1.0.6'
 cookbook 'ohai', :locked_version => '1.0.2'

data/spec/unit/berkshelf/formatters_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+module Berkshelf
+  module Formatters
+    class TestFormatter
+      include AbstractFormatter
+    end
+
+    describe AbstractFormatter do
+      
+      subject { TestFormatter.new }
+
+      it "has abstract methods for all the messaging modes" do
+        lambda { subject.install("my_coobook","1.2.3","http://community") }.should raise_error(MethodNotImplmentedError)
+        lambda { subject.use("my_coobook","1.2.3") }.should raise_error(MethodNotImplmentedError)
+        lambda { subject.use("my_coobook","1.2.3","http://community") }.should raise_error(MethodNotImplmentedError)
+        lambda { subject.upload("my_coobook","1.2.3","http://chef_server") }.should raise_error(MethodNotImplmentedError)
+        lambda { subject.shims_written("/Users/jcocktosten") }.should raise_error(MethodNotImplmentedError)
+        lambda { subject.msg("something you should know") }.should raise_error(MethodNotImplmentedError)
+        lambda { subject.error("whoa this is bad") }.should raise_error(MethodNotImplmentedError)
+      end
+    end
+  end
+end

data/spec/unit/berkshelf/lockfile_spec.rb

@@ -14,8 +14,8 @@ describe Berkshelf::Lockfile do
       Berkshelf::Lockfile.new(resolver.sources).write
 
       File.read('Berksfile.lock').split(/\r?\n/).sort.should == [
-        "cookbook 'bluepill', :locked_version => '1.0.4'",
-        "cookbook 'build-essential', :locked_version => '1.0.2'", 
+        "cookbook 'bluepill', :locked_version => '1.0.6'",
+        "cookbook 'build-essential', :locked_version => '1.1.0'", 
         "cookbook 'nginx', :locked_version => '0.101.0'", 
         "cookbook 'ohai', :locked_version => '1.0.2'", 
         "cookbook 'runit', :locked_version => '0.15.0'"

data/spec/unit/berkshelf_spec.rb

@@ -45,5 +45,32 @@ describe Berkshelf do
         subject.load_config
       end
     end
+
+    describe "::formatter" do
+      context "with default formatter" do
+        it "should be human readable" do
+          Berkshelf.formatter.should be_an_instance_of(Berkshelf::Formatters::HumanReadable)
+        end
+      end
+
+      context "with a custom formatter" do
+        before(:all) do
+          Berkshelf.instance_eval { @formatter = nil }
+        end
+
+        class CustomFormatter
+          include Berkshelf::Formatters::AbstractFormatter
+          Berkshelf.formatters["custom"] = self
+        end
+
+        before do
+          Berkshelf.set_format "custom"
+        end
+
+        it "should be the custom class" do
+          Berkshelf.formatter.should be_an_instance_of(CustomFormatter)
+        end
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: berkshelf
 version: !ruby/object:Gem::Version
-  version: 0.4.0.rc3
+  version: 0.4.0.rc4
   prerelease: 6
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-20 00:00:00.000000000 Z
+date: 2012-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: solve
@@ -69,7 +69,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.15.2
+        version: 0.16.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -77,7 +77,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.15.2
+        version: 0.16.0
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
@@ -373,11 +373,13 @@ files:
 - features/cookbook_command.feature
 - features/init_command.feature
 - features/install.feature
+- features/json_formatter.feature
 - features/lockfile.feature
 - features/step_definitions/berksfile_steps.rb
 - features/step_definitions/chef_server_steps.rb
 - features/step_definitions/cli_steps.rb
 - features/step_definitions/filesystem_steps.rb
+- features/step_definitions/json_steps.rb
 - features/support/env.rb
 - features/update.feature
 - features/upload_command.feature
@@ -418,6 +420,9 @@ files:
 - lib/berkshelf/downloader.rb
 - lib/berkshelf/dsl.rb
 - lib/berkshelf/errors.rb
+- lib/berkshelf/formatters.rb
+- lib/berkshelf/formatters/human_readable.rb
+- lib/berkshelf/formatters/json.rb
 - lib/berkshelf/git.rb
 - lib/berkshelf/init_generator.rb
 - lib/berkshelf/lockfile.rb
@@ -431,6 +436,7 @@ files:
 - spec/fixtures/cookbooks/example_cookbook-0.5.0/README.md
 - spec/fixtures/cookbooks/example_cookbook-0.5.0/metadata.rb
 - spec/fixtures/cookbooks/example_cookbook-0.5.0/recipes/default.rb
+- spec/fixtures/cookbooks/example_cookbook/Berksfile.lock
 - spec/fixtures/cookbooks/example_cookbook/README.md
 - spec/fixtures/cookbooks/example_cookbook/metadata.rb
 - spec/fixtures/cookbooks/example_cookbook/recipes/default.rb
@@ -471,6 +477,7 @@ files:
 - spec/unit/berkshelf/core_ext/fileutils_spec.rb
 - spec/unit/berkshelf/downloader_spec.rb
 - spec/unit/berkshelf/dsl_spec.rb
+- spec/unit/berkshelf/formatters_spec.rb
 - spec/unit/berkshelf/git_spec.rb
 - spec/unit/berkshelf/init_generator_spec.rb
 - spec/unit/berkshelf/lockfile_spec.rb
@@ -507,11 +514,13 @@ test_files:
 - features/cookbook_command.feature
 - features/init_command.feature
 - features/install.feature
+- features/json_formatter.feature
 - features/lockfile.feature
 - features/step_definitions/berksfile_steps.rb
 - features/step_definitions/chef_server_steps.rb
 - features/step_definitions/cli_steps.rb
 - features/step_definitions/filesystem_steps.rb
+- features/step_definitions/json_steps.rb
 - features/support/env.rb
 - features/update.feature
 - features/upload_command.feature
@@ -520,6 +529,7 @@ test_files:
 - spec/fixtures/cookbooks/example_cookbook-0.5.0/README.md
 - spec/fixtures/cookbooks/example_cookbook-0.5.0/metadata.rb
 - spec/fixtures/cookbooks/example_cookbook-0.5.0/recipes/default.rb
+- spec/fixtures/cookbooks/example_cookbook/Berksfile.lock
 - spec/fixtures/cookbooks/example_cookbook/README.md
 - spec/fixtures/cookbooks/example_cookbook/metadata.rb
 - spec/fixtures/cookbooks/example_cookbook/recipes/default.rb
@@ -560,6 +570,7 @@ test_files:
 - spec/unit/berkshelf/core_ext/fileutils_spec.rb
 - spec/unit/berkshelf/downloader_spec.rb
 - spec/unit/berkshelf/dsl_spec.rb
+- spec/unit/berkshelf/formatters_spec.rb
 - spec/unit/berkshelf/git_spec.rb
 - spec/unit/berkshelf/init_generator_spec.rb
 - spec/unit/berkshelf/lockfile_spec.rb