berkshelf 1.0.0.rc3 → 1.0.0

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 /spec/fixtures/vcr_cassettes
 /features/config.yml
 *.sw[op]
+\.\#*

data/features/cookbook_command.feature

@@ -8,32 +8,35 @@ Feature: cookbook command
     Then I should have a new cookbook skeleton "sparkle_motion"
     And the exit status should be 0
 
-  Scenario: creating a new cookbook skeleton with Foodcritic support
+  Scenario Outline: creating a new cookbook skeleton with affirmative options
     When I run the cookbook command to create "sparkle_motion" with options:
-      | --foodcritic |
-    Then I should have a new cookbook skeleton "sparkle_motion" with Foodcritic support
+      | --<option> |
+    Then I should have a new cookbook skeleton "sparkle_motion" with <feature> support
     And the exit status should be 0
 
-  Scenario: creating a new cookbook skeleton with SCMVersion support
-    When I run the cookbook command to create "sparkle_motion" with options:
-      | --scmversion |
-    Then I should have a new cookbook skeleton "sparkle_motion" with SCMVersion support
-    And the exit status should be 0
+  Examples:
+    | option       | feature    |
+    | foodcritic   | Foodcritic |
+    | scmversion   | SCMVersion |
+    | no-bundler   | no Bundler |
+    | skip-git     | no Git     |
+    | skip-vagrant | no Vagrant |
 
-  Scenario: creating a new cookbook skeleton without Bundler support
+  Scenario Outline: creating a new cookbook skeleton with options without the supporting gem installed
     When I run the cookbook command to create "sparkle_motion" with options:
-      | --no-bundler |
-    Then I should have a new cookbook skeleton "sparkle_motion" without Bundler support
+      | --<option> |
+    Then I should have a new cookbook skeleton "sparkle_motion" with <feature> support
+    And the output should contain a warning to suggest supporting the option "<option>" by installing "<gem>"
     And the exit status should be 0
 
-  Scenario: creating a new cookbook skeleton without Git support
-    When I run the cookbook command to create "sparkle_motion" with options:
-      | --skip-git |
-    Then I should have a new cookbook skeleton "sparkle_motion" without Git support
-    And the exit status should be 0
+  Examples:
+    | option     | feature    | gem             |
+    | foodcritic | Foodcritic | foodcritic      |
+    | scmversion | SCMVersion | thor-scmversion |
+    # | no-bundler   | no Bundler | bundler         |
+
+    @pending
+  Scenario: creating a new cookbook skeleton with bundler support without bundler installed
+    Given pending "Bundler is used in tests, so it always appears available. Need to mock out the Gem::Specification.find_by_name, but aruba is out of process testing."
+
 
-  Scenario: creating a new cookbook skeleton without Vagrant support
-    When I run the cookbook command to create "sparkle_motion" with options:
-      | --skip-vagrant |
-    Then I should have a new cookbook skeleton "sparkle_motion" without Vagrant support
-    And the exit status should be 0

data/features/install.feature

@@ -79,6 +79,72 @@ Feature: install cookbooks from a Berksfile
       """
     And the exit status should be 0
 
+  Scenario: installing a Berksfile that contains a GitHub location
+    Given I write to "Berksfile" with:
+      """
+      cookbook "artifact", github: "RiotGames/artifact-cookbook", ref: "0.9.8"
+      """
+    When I run the install command
+    Then the cookbook store should have the git cookbooks:
+      | artifact | 0.9.8 | c0a0b456a4716a81645bef1369f5fd1a4e62ce6d |
+    And the output should contain:
+      """
+      Installing artifact (0.9.8) from github: 'RiotGames/artifact-cookbook' with branch: '0.9.8'
+      """
+    And the exit status should be 0
+
+  Scenario Outline: installing a Berksfile that contains a Github location and the default protocol
+    Given I write to "Berksfile" with:
+      """
+      cookbook "artifact", github: "RiotGames/artifact-cookbook", ref: "0.9.8"<command postfix>
+      """
+    When I run the install command
+    Then the cookbook store should have the git cookbooks:
+      | artifact | 0.9.8 | c0a0b456a4716a81645bef1369f5fd1a4e62ce6d |
+    And the output should contain:
+      """
+      Installing artifact (0.9.8) from github: 'RiotGames/artifact-cookbook' with branch: '0.9.8'
+      """
+    And the exit status should be 0
+
+    Examples:
+      | command postfix   |
+      | , protocol: "git" |
+      |                   |
+
+  Scenario Outline: installing a Berksfile that contains a Github location and specific protocol
+    Given I write to "Berksfile" with:
+      """
+      cookbook "artifact", github: "RiotGames/artifact-cookbook", ref: "0.9.8", protocol: "<protocol>"
+      """
+    When I run the install command
+    Then the cookbook store should have the git cookbooks:
+      | artifact | 0.9.8 | c0a0b456a4716a81645bef1369f5fd1a4e62ce6d |
+    And the output should contain:
+      """
+      Installing artifact (0.9.8) from github: 'RiotGames/artifact-cookbook' with branch: '0.9.8' over protocol: '<protocol>'
+      """
+    And the exit status should be 0
+
+    Examples:
+      | protocol |
+      # GitHub over ssh requires push authorization. Nonpushers will
+      # get a test failure here.
+      # | ssh   |
+      | https |
+
+  Scenario: installing a Berksfile that contains a Github location and an unsupported protocol
+    Given I write to "Berksfile" with:
+      """
+      cookbook "artifact", github: "RiotGames/artifact-cookbook", ref: "0.9.8", protocol: "somethingabsurd"
+      """
+    When I run the install command
+    Then the output should contain:
+      """
+      'somethingabsurd' is not a supported Git protocol for the 'github' location key. Please use 'git' instead.
+      """
+    And the exit status should be 110      
+
   Scenario: installing a Berksfile that contains an explicit site location
     Given I write to "Berksfile" with:
       """

data/features/step_definitions/filesystem_steps.rb

@@ -143,7 +143,7 @@ Then /^I should have a new cookbook skeleton "(.*?)" with SCMVersion support$/ d
   }
 end
 
-Then /^I should have a new cookbook skeleton "(.*?)" without Bundler support$/ do |name|
+Then /^I should have a new cookbook skeleton "(.*?)" with no Bundler support$/ do |name|
   cb_path = Pathname.new(current_dir).join(name)
   cb_path.should have_structure {
     directory "attributes"
@@ -171,13 +171,13 @@ Then /^I should have a new cookbook skeleton "(.*?)" without Bundler support$/ d
   }
 end
 
-Then /^I should have a new cookbook skeleton "(.*?)" without Git support$/ do |name|
+Then /^I should have a new cookbook skeleton "(.*?)" with no Git support$/ do |name|
   Pathname.new(current_dir).join(name).should have_structure {
     no_file ".gitignore"
   }
 end
 
-Then /^I should have a new cookbook skeleton "(.*?)" without Vagrant support$/ do |name|
+Then /^I should have a new cookbook skeleton "(.*?)" with no Vagrant support$/ do |name|
   Pathname.new(current_dir).join(name).should have_structure {
     file "Gemfile" do
       does_not_contain "gem 'vagrant'"

data/features/step_definitions/gem_steps.rb

@@ -0,0 +1,11 @@
+Given /^the gem "(.*)" is not installed$/ do |gem_name|
+  # Because aruba is out of process, need to figure out how to mock the Gem::Specification.find_by_name call to pretend gems are not available.
+end
+
+Then /^the output should contain a warning to suggest supporting the option "(.*?)" by installing "(.*?)"$/ do |option, gem_name|
+  step "the output should contain \"This cookbook was generated with --#{option}, however, #{gem_name} is not installed.\nTo make use of --#{option}: gem install #{gem_name}\""
+end
+
+Then /^the output should contain a warning to suggest supporting the default for "(.*?)" by installing "(.*?)"$/ do |option, gem_name|
+  step "the output should contain \"By default, this cookbook was generated to support #{gem_name}, however, #{gem_name} is not installed.\nTo skip support for #{gem_name}, use --#{option}\"\nTo install #{gem_name}: gem install #{gem_name}"
+end

data/features/step_definitions/utility_steps.rb

@@ -0,0 +1,3 @@
+Given /^pending\s+"([^\"]+)"$/ do |msg|
+  pending
+end

data/features/support/env.rb

@@ -13,11 +13,24 @@ Spork.prefork do
 
   ENV["BERKSHELF_PATH"] = File.join(APP_ROOT, "tmp", "berkshelf")
   ENV["BERKSHELF_CHEF_CONFIG"] = File.join(APP_ROOT, "tmp", "knife.rb")
+  
+  # Workaround for RSA Fingerprint prompt in Travis CI 
+  git_ssh_path = '/tmp/git_ssh.sh'
+  unless File.exist? git_ssh_path
+    git_ssh = File.new(git_ssh_path, 'w+')
+    git_ssh.puts "ssh -o UserKnownHostsFile=/dev/null -o StrictHostKeyChecking=no $1 $2"
+    git_ssh.chmod 0775
+    git_ssh.flush
+    git_ssh.close
+  end
+
+  ENV["GIT_SSH"] = git_ssh_path
+
 
   Dir[File.join(APP_ROOT, "spec/support/**/*.rb")].each {|f| require f}
 
   Around do |scenario, block|
-    VCR.use_cassette(scenario.title) do
+    VCR.use_cassette(scenario.name) do
       block.call
     end
   end

data/lib/berkshelf/berksfile.rb

@@ -41,7 +41,7 @@ module Berkshelf
         end
 
         FileUtils.remove_dir(path, force: true)
-        File.rename(scratch, path)
+        FileUtils.mv(scratch, path)
 
         path
       end

data/lib/berkshelf/config.rb

@@ -66,6 +66,9 @@ module Berkshelf
         File.read(path) if File.exists?(path)
       end
 
+      # Instantiate and return or just return the currently instantiated Berkshelf
+      # configuration
+      #
       # @return [Config]
       def instance
         @instance ||= if file
@@ -74,6 +77,14 @@ module Berkshelf
           new
         end
       end
+
+      # Reload the currently instantiated Berkshelf configuration
+      #
+      # @return [Config]
+      def reload
+        @instance = nil
+        self.instance
+      end
     end
 
     # @param [String] path

data/lib/berkshelf/errors.rb

@@ -57,6 +57,20 @@ module Berkshelf
     end
   end
 
+  class UnknownGitHubProtocol < BerkshelfError
+    status_code(110)
+    attr_reader :protocol
+
+    # @param [String] protocol
+    def initialize(protocol)
+      @protocol = protocol
+    end
+
+    def to_s
+      "'#{self.protocol}' is not a supported Git protocol for the 'github' location key. Please use 'git' instead."
+    end
+  end
+
   class GitNotFound < BerkshelfError
     status_code(110)
 

data/lib/berkshelf/init_generator.rb

@@ -1,5 +1,6 @@
 module Berkshelf
   # @author Jamie Winsor <jamie@vialstudios.com>
+  # @author Josiah Kiehl <josiah@skirmisher.net>
   class InitGenerator < BaseGenerator
     def initialize(*args)
       super(*args)
@@ -47,8 +48,10 @@ module Berkshelf
       type: :hash,
       default: Config.instance
 
+    # Generate the cookbook
     def generate
       validate_configuration
+      check_option_support
 
       template "Berksfile.erb", target.join("Berksfile")
 
@@ -86,6 +89,10 @@ module Berkshelf
 
     private
 
+      # Read the cookbook name from the metadata.rb
+      #
+      # @return [String]
+      #   name of the cookbook
       def cookbook_name
         @cookbook_name ||= begin
           metadata = Chef::Cookbook::Metadata.new
@@ -97,10 +104,59 @@ module Berkshelf
         end
       end
 
+      # Assert valid configuration
+      #
+      # @raise [InvalidConfiguration] if the configuration is invalid
+      #
+      # @return [nil]
       def validate_configuration
         unless Config.instance.valid?
           raise InvalidConfiguration.new Config.instance.errors
         end
       end
+      
+
+      # Check for supporting gems for provided options
+      #
+      # @return [Boolean]
+      def check_option_support
+        assert_option_supported(:foodcritic) &&
+        assert_option_supported(:scmversion, 'thor-scmversion') &&
+        assert_default_supported(:no_bundler, 'bundler')
+        # Vagrant is a dependency of Berkshelf; it will always appear available to the Berkshelf process.
+      end
+
+      # Warn if the supporting gem for an option is not installed
+      #
+      # @return [Boolean]
+      def assert_option_supported(option, gem_name = option.to_s)
+        if options[option]
+          begin
+            Gem::Specification.find_by_name(gem_name)
+          rescue Gem::LoadError
+            Berkshelf.ui.warn "This cookbook was generated with --#{option}, however, #{gem_name} is not installed."
+            Berkshelf.ui.warn "To make use of --#{option}: gem install #{gem_name}"
+            return false
+          end
+        end
+        true
+      end
+
+      # Warn if the supporting gem for a default is not installed
+      #
+      # @return [Boolean]  
+      def assert_default_supported(option, gem_name = option.to_s)
+        unless options[option]
+          begin
+            Gem::Specification.find_by_name(gem_name)
+          rescue Gem::LoadError
+            Berkshelf.ui.warn "By default, this cookbook was generated to support #{gem_name}, however, #{gem_name} is not installed."
+            Berkshelf.ui.warn "To skip support for #{gem_name}, use --#{option}"
+            Berkshelf.ui.warn "To install #{gem_name}: gem install #{gem_name}"
+            return false
+          end
+        end
+        true
+      end
   end
 end

data/lib/berkshelf/locations/github_location.rb

@@ -0,0 +1,60 @@
+module Berkshelf
+  # @author Josiah Kiehl <josiah@skirmisher.net>
+  class GithubLocation < GitLocation
+    DEFAULT_PROTOCOL = 'git'
+
+    set_location_key :github
+    set_valid_options :protocol
+
+    attr_accessor :protocol
+    attr_accessor :repo_identifier
+
+    # Wraps GitLocation allowing the short form GitHub repo identifier
+    # to be used in place of the complete repo url.
+    # 
+    # @see GitLocation#initialize for parameter documentation
+    #
+    # @option options [String] :github
+    #   the GitHub repo identifier to clone
+    # @option options [String] :protocol
+    #   the protocol with which to communicate with GitHub
+    def initialize(name, version_constraint, options = {})
+      @repo_identifier = options.delete(:github)
+      @protocol = options.delete(:protocol) || DEFAULT_PROTOCOL
+      options[:git] = github_url
+      super
+    end
+
+    # Returns the appropriate GitHub url given the specified protocol
+    #
+    # @raise [UnknownGitHubProtocol] if the specified protocol is not supported.
+    #
+    # @return [String]
+    #   GitHub url
+    def github_url
+      case protocol.to_s
+      when 'ssh'
+        "git@github.com:#{repo_identifier}.git"
+      when 'https'
+        "https://github.com/#{repo_identifier}.git"
+      when 'git'
+        "git://github.com/#{repo_identifier}.git"
+      else
+        raise UnknownGitHubProtocol.new(protocol)
+      end
+    end
+
+    def to_s
+      s = "#{self.class.location_key}: '#{repo_identifier}'"
+      s << " with branch: '#{branch}'"     if branch
+      s << " over protocol: '#{protocol}'" unless default_protocol?
+      s
+    end
+
+    private
+
+      def default_protocol?
+        @protocol == DEFAULT_PROTOCOL
+      end
+  end
+end

data/lib/berkshelf/ui.rb

@@ -23,6 +23,12 @@ module Berkshelf
       super(status, message, log_status)
     end
 
+    def warn(message, color = :yellow)
+      return if quiet?
+      
+      say(message, color)
+    end
+
     def error(message, color = :red)
       return if quiet?
 

data/lib/berkshelf/version.rb

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

metadata

@@ -1,8 +1,8 @@
 --- !ruby/object:Gem::Specification
 name: berkshelf
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc3
-  prerelease: 6
+  version: 1.0.0
+  prerelease: 
 platform: ruby
 authors:
 - Jamie Winsor
@@ -225,7 +225,9 @@ files:
 - features/step_definitions/cli_steps.rb
 - features/step_definitions/configure_cli_steps.rb
 - features/step_definitions/filesystem_steps.rb
+- features/step_definitions/gem_steps.rb
 - features/step_definitions/json_steps.rb
+- features/step_definitions/utility_steps.rb
 - features/support/env.rb
 - features/update.feature
 - features/upload_command.feature
@@ -268,6 +270,7 @@ files:
 - lib/berkshelf/location.rb
 - lib/berkshelf/locations/chef_api_location.rb
 - lib/berkshelf/locations/git_location.rb
+- lib/berkshelf/locations/github_location.rb
 - lib/berkshelf/locations/path_location.rb
 - lib/berkshelf/locations/site_location.rb
 - lib/berkshelf/lockfile.rb
@@ -353,9 +356,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
+      segments:
+      - 0
+      hash: -4545769235326806267
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -377,7 +383,9 @@ test_files:
 - features/step_definitions/cli_steps.rb
 - features/step_definitions/configure_cli_steps.rb
 - features/step_definitions/filesystem_steps.rb
+- features/step_definitions/gem_steps.rb
 - features/step_definitions/json_steps.rb
+- features/step_definitions/utility_steps.rb
 - features/support/env.rb
 - features/update.feature
 - features/upload_command.feature