berkshelf 4.3.5 → 5.0.0

data/README.md

@@ -25,7 +25,9 @@ gem 'berkshelf'
 
 Or run it as a standalone:
 
-    $ gem install berkshelf
+```shell
+$ gem install berkshelf
+```
 
 ## Usage
 
@@ -33,11 +35,7 @@ See [berkshelf.com](http://berkshelf.com) for up-to-date usage instructions.
 
 ## Supported Platforms
 
-Berkshelf is tested on Ruby 1.9.3, 2.0, and 2.1.
-
-Ruby 1.9 mode is required on all interpreters.
-
-Ruby 1.9.1 and 1.9.2 are not officially supported. If you encounter problems, please upgrade to Ruby 2.0 or 1.9.3.
+Berkshelf is tested and supported on Ruby 2.2 and 2.3.
 
 ## Configuration
 

data/Rakefile

@@ -1,10 +1,14 @@
 require "bundler/gem_tasks"
 
-require "github_changelog_generator/task"
+begin
+  require "github_changelog_generator/task"
 
-GitHubChangelogGenerator::RakeTask.new :changelog do |config|
-  config.future_release = Berkshelf::VERSION
-  config.enhancement_labels = "enhancement,Enhancement,New Feature,Feature".split(",")
-  config.bug_labels = "bug,Bug,Improvement".split(",")
-  config.exclude_labels = "duplicate,question,invalid,wontfix,no_changelog,Exclude From Changelog,Question,Upstream Bug,Discussion".split(",")
+  GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+    config.future_release = Berkshelf::VERSION
+    config.issues = false
+    config.enhancement_labels = "enhancement,Enhancement,New Feature,Feature".split(",")
+    config.bug_labels = "bug,Bug,Improvement".split(",")
+    config.exclude_labels = "duplicate,question,invalid,wontfix,no_changelog,Exclude From Changelog,Question,Upstream Bug,Discussion".split(",")
+  end
+rescue LoadError
 end

data/berkshelf.gemspec

@@ -27,36 +27,22 @@ Gem::Specification.new do |s|
   s.name                      = 'berkshelf'
   s.require_paths             = ['lib']
   s.version                   = Berkshelf::VERSION
-  s.required_ruby_version     = '>= 2.0.0'
-  s.required_rubygems_version = '>= 1.8.0'
+  s.required_ruby_version     = '>= 2.2.0'
+  s.required_rubygems_version = '>= 2.0.0'
 
   s.add_dependency 'addressable',          '~> 2.3', '>= 2.3.4'
-  s.add_dependency 'berkshelf-api-client', '~> 2.0', '>= 2.0.2'
-  s.add_dependency 'buff-config',          '~> 1.0'
-  s.add_dependency 'buff-extensions',      '~> 1.0'
+  s.add_dependency 'berkshelf-api-client', '>= 2.0.2', '< 4.0'
+  s.add_dependency 'buff-config',          '~> 2.0'
+  s.add_dependency 'buff-extensions',      '~> 2.0'
   s.add_dependency 'buff-shell_out',       '~> 0.1'
   s.add_dependency 'cleanroom',            '~> 1.0'
   s.add_dependency 'faraday',              '~> 0.9'
   s.add_dependency 'httpclient',           '~> 2.7'
   s.add_dependency 'minitar',              '~> 0.5', '>= 0.5.4'
   s.add_dependency 'retryable',            '~> 2.0'
-  s.add_dependency 'ridley',               '~> 4.5'
-  s.add_dependency 'solve',                '~> 2.0'
+  s.add_dependency 'ridley',               '~> 5.0'
+  s.add_dependency 'solve',                '> 2.0', '< 4.0'
   s.add_dependency 'thor',                 '~> 0.19'
   s.add_dependency 'octokit',              '~> 4.0'
-  s.add_dependency 'celluloid',            '= 0.16.0'
-  s.add_dependency 'celluloid-io',         '~> 0.16.1'
   s.add_dependency 'mixlib-archive',       '~> 0.1'
-
-  s.add_development_dependency 'aruba',         '~> 0.10.0' # Lock this here to avoid problems with public API changes
-  s.add_development_dependency 'chef-zero',     '~> 4.0'
-  s.add_development_dependency 'dep_selector',  '~> 1.0'
-  s.add_development_dependency 'fuubar',        '~> 2.0'
-  s.add_development_dependency 'rake',          '~> 10.1'
-  s.add_development_dependency 'rspec',         '~> 3.0'
-  s.add_development_dependency 'spork',         '~> 0.9'
-  s.add_development_dependency 'test-kitchen',  '~> 1.2'
-  s.add_development_dependency 'webmock',       '~> 1.11'
-  s.add_development_dependency 'yard',          '~> 0.8'
-  s.add_development_dependency 'http',          '~> 0.9', '>= 0.9.8'
 end

data/docs/berkshelf_for_newcomers.md

@@ -0,0 +1,65 @@
+# Berkshelf for Newcomers
+
+Berkshelf is a tool to help manage cookbook dependencies.  If your cookbook depends on other cookbooks, Berkshelf lets you do the following:
+
+* download all cookbooks you depend on to your local machine for development and testing using `berks install`
+* upload your cookbook and all dependencies to your Chef server using `berks upload`
+* update your dependencies using `berks update`
+
+The above are the main Berkshelf commands that will comprise the bulk of your workflow.
+
+Berkshelf is included in the ChefDK (at least at v.0.10.0), and `chef generate cookbook` will set up your cookbook with the necessary files for Berkshelf usage.
+
+## A quick example
+
+Suppose you have a cookbook with the following `metadata.rb`:
+
+```
+name 'example_cookbook'
+description 'Installs/Configures example_cookbook'
+long_description 'Installs/Configures example_cookbook'
+version '0.1.0'
+
+depends 'apt', '~> 2.3'
+```
+
+To work on this cookbook locally, you need to download an `apt` cookbook matching the constraints.  Berkshelf handles this for you:
+
+```
+$ berks install
+Resolving cookbook dependencies...
+Fetching 'example_cookbook' from source at .
+Fetching cookbook index from https://supermarket.chef.io...
+Using example_cookbook (0.1.0) from source at .
+Using apt (2.9.2)
+```
+
+When done your work, you need to push both your cookbook and the apt cookbook up to your Chef server.  With Berkshelf:
+
+```
+$ berks upload
+Uploaded apt (2.9.2) to: 'https://your_chef_server_url'
+Uploaded example_cookbook (0.1.0) to: 'your_chef_server_url'
+```
+
+The above is a trivial example.  If your cookbook has several dependencies, which in turn have dependencies, Berkshelf handles it all automatically, significantly improving your workflow.
+
+## What's in the background
+
+* the cookbook's `metadata.rb` specifies the cookbook dependencies and required versions
+* the [Berksfile](http://berkshelf.com/v2.0/#the-berksfile) in your cookbook's root directory tells Berkshelf where to find cookbooks.  You can have multiple sources, or can pull individual cookbooks from specific locations, such as your own Supermarket, GitHub, or a file server.
+* `berks install` downloads cookbooks and their dependencies to the [Berkshelf](http://berkshelf.com/v2.0/#the-berkshelf), a place on your local disk.
+* a Berksfile.lock is generated on `berks install` which specifies the exact cookbook versions that were used at that point
+
+## Cookbook versioning
+
+Berkshelf relies on cookbook versioning to work correctly.  A cookbook's version is tracked in its `metadata.rb`, and should follow the guidelines outlined at http://semver.org/.
+
+# Further reading
+
+* The project homepage, http://http://berkshelf.com/v2.0/
+* https://sethvargo.com/berkshelf-workflow/
+
+--
+
+Good luck with Berkshelf!

data/features/commands/install.feature

@@ -234,9 +234,9 @@ Feature: berks install
       | berkshelf-cookbook-fixture | 1.0.0 | 93f5768b7d14df45e10d16c8bf6fe98ba3ff809a |
     And the output should contain:
       """
-      Fetching 'berkshelf-cookbook-fixture' from git://github.com/RiotGames/berkshelf-cookbook-fixture.git (at rel/cookbooks/berkshelf-cookbook-fixture)
+      Fetching 'berkshelf-cookbook-fixture' from https://github.com/RiotGames/berkshelf-cookbook-fixture.git (at rel/cookbooks/berkshelf-cookbook-fixture)
       Fetching cookbook index from http://0.0.0.0:26210...
-      Using berkshelf-cookbook-fixture (1.0.0) from git://github.com/RiotGames/berkshelf-cookbook-fixture.git (at rel/cookbooks/berkshelf-cookbook-fixture)
+      Using berkshelf-cookbook-fixture (1.0.0) from https://github.com/RiotGames/berkshelf-cookbook-fixture.git (at rel/cookbooks/berkshelf-cookbook-fixture)
       """
 
   Scenario: installing a Berksfile that contains a Git location
@@ -307,9 +307,9 @@ Feature: berks install
       | berkshelf-cookbook-fixture | 0.2.0 | 70a527e17d91f01f031204562460ad1c17f972ee |
     And the output should contain:
       """
-      Fetching 'berkshelf-cookbook-fixture' from git://github.com/RiotGames/berkshelf-cookbook-fixture.git (at v0.2.0)
+      Fetching 'berkshelf-cookbook-fixture' from https://github.com/RiotGames/berkshelf-cookbook-fixture.git (at v0.2.0)
       Fetching cookbook index from http://0.0.0.0:26210...
-      Using berkshelf-cookbook-fixture (0.2.0) from git://github.com/RiotGames/berkshelf-cookbook-fixture.git (at v0.2.0)
+      Using berkshelf-cookbook-fixture (0.2.0) from https://github.com/RiotGames/berkshelf-cookbook-fixture.git (at v0.2.0)
       """
 
   Scenario: installing a Berksfile that contains a GitHub location
@@ -322,9 +322,9 @@ Feature: berks install
       | berkshelf-cookbook-fixture | 0.2.0 | 70a527e17d91f01f031204562460ad1c17f972ee |
     And the output should contain:
       """
-      Fetching 'berkshelf-cookbook-fixture' from git://github.com/RiotGames/berkshelf-cookbook-fixture.git (at v0.2.0)
+      Fetching 'berkshelf-cookbook-fixture' from https://github.com/RiotGames/berkshelf-cookbook-fixture.git (at v0.2.0)
       Fetching cookbook index from http://0.0.0.0:26210...
-      Using berkshelf-cookbook-fixture (0.2.0) from git://github.com/RiotGames/berkshelf-cookbook-fixture.git (at v0.2.0)
+      Using berkshelf-cookbook-fixture (0.2.0) from https://github.com/RiotGames/berkshelf-cookbook-fixture.git (at v0.2.0)
       """
 
   Scenario: running install when current project is a cookbook and the 'metadata' is specified

data/features/commands/search.feature

@@ -11,6 +11,6 @@ Feature: berks search
     * the output should contain:
       """
       berkshelf-api (1.2.2)
-      berkshelf-api-server (2.1.1)
+      berkshelf-api-server (2.2.0)
       berkshelf-cookbook-fixture (1.0.0)
       """

data/features/config.feature

@@ -3,7 +3,7 @@ Feature: Reading a Berkshelf configuration file
     When I successfully run `berks cookbook sparkle_motion`
     Then the resulting "sparkle_motion" Vagrantfile should contain:
       | config.omnibus.chef_version = 'latest' |
-      | config.vm.box = 'chef/ubuntu-14.04' |
+      | config.vm.box = 'bento/ubuntu-14.04' |
 
   Scenario: Using a Berkshelf configuration file that sets the vagrant-omnibus plugin chef version
     Given I have a Berkshelf config file containing:
@@ -14,7 +14,7 @@ Feature: Reading a Berkshelf configuration file
           "version": "11.4.4"
         },
         "vm": {
-          "box": "chef/ubuntu-14.04",
+          "box": "bento/ubuntu-14.04",
           "forward_port": {
             "12345": "54321"
           }
@@ -25,7 +25,7 @@ Feature: Reading a Berkshelf configuration file
     When I successfully run `berks cookbook sparkle_motion`
     Then the resulting "sparkle_motion" Vagrantfile should contain:
       | config.omnibus.chef_version = '11.4.4' |
-      | config.vm.box = 'chef/ubuntu-14.04' |
+      | config.vm.box = 'bento/ubuntu-14.04' |
       | config.vm.network :forwarded_port, guest: 12345, host: 54321 |
       | config.vm.network :private_network, type: 'dhcp' |
     And the exit status should be 0
@@ -39,7 +39,7 @@ Feature: Reading a Berkshelf configuration file
           "version": "latest"
         },
         "vm": {
-          "box": "chef/ubuntu-14.04",
+          "box": "bento/ubuntu-14.04",
           "forward_port": {
             "12345": "54321"
           }
@@ -50,7 +50,7 @@ Feature: Reading a Berkshelf configuration file
     When I successfully run `berks cookbook sparkle_motion`
     Then the resulting "sparkle_motion" Vagrantfile should contain:
       | config.omnibus.chef_version = 'latest' |
-      | config.vm.box = 'chef/ubuntu-14.04' |
+      | config.vm.box = 'bento/ubuntu-14.04' |
       | config.vm.network :forwarded_port, guest: 12345, host: 54321 |
       | config.vm.network :private_network, type: 'dhcp' |
 

data/features/lockfile.feature

@@ -230,7 +230,7 @@ Feature: Creating and reading the Berkshelf lockfile
       """
       DEPENDENCIES
         berkshelf-cookbook-fixture
-          git: git://github.com/RiotGames/berkshelf-cookbook-fixture.git
+          git: https://github.com/RiotGames/berkshelf-cookbook-fixture.git
           revision: 919afa0c402089df23ebdf36637f12271b8a96b4
           ref: 919afa0
 
@@ -248,7 +248,7 @@ Feature: Creating and reading the Berkshelf lockfile
       """
       DEPENDENCIES
         berkshelf-cookbook-fixture
-          git: git://github.com/RiotGames/berkshelf-cookbook-fixture.git
+          git: https://github.com/RiotGames/berkshelf-cookbook-fixture.git
           revision: 93f5768b7d14df45e10d16c8bf6fe98ba3ff809a
           branch: rel
           rel: cookbooks/berkshelf-cookbook-fixture

data/features/step_definitions/utility_steps.rb

@@ -3,7 +3,9 @@ Given /^skip\s+"([^\"]+)"$/ do |msg|
 end
 
 Then /the output from \`(.+)\` should be the same as \`(.+)\`/ do |actual, expected|
-  run_simple(actual)
-  run_simple(expected)
-  expect(output_from(actual)).to eq(output_from(expected))
+  run(actual)
+  actual_output = last_command_started.stdout
+  run(expected)
+  expected_output = last_command_started.stdout
+  expect(actual_output).to eql(expected_output)
 end

data/features/support/env.rb

@@ -26,7 +26,9 @@ Spork.prefork do
   end
 
   Before do
+
     # Legacy ENV variables until we can move over to all InProcess
+    Berkshelf.instance_variable_set(:@berkshelf_path, nil)
     ENV['BERKSHELF_PATH'] = berkshelf_path.to_s
     ENV['BERKSHELF_CONFIG'] = Berkshelf.config.path.to_s
     ENV['BERKSHELF_CHEF_CONFIG'] = chef_config_path.to_s
@@ -63,6 +65,7 @@ Spork.prefork do
   Before('@spawn') do
     aruba.config.command_launcher = :spawn
 
+    Berkshelf.instance_variable_set(:@berkshelf_path, nil)
     set_environment_variable('BERKSHELF_PATH', berkshelf_path.to_s)
     set_environment_variable('BERKSHELF_CONFIG', Berkshelf.config.path.to_s)
     set_environment_variable('BERKSHELF_CHEF_CONFIG', chef_config_path.to_s)

data/lib/berkshelf.rb

@@ -17,6 +17,8 @@ require_relative 'berkshelf/core_ext'
 require_relative 'berkshelf/thor_ext'
 
 module Berkshelf
+  Encoding.default_external = Encoding::UTF_8
+
   require_relative 'berkshelf/version'
   require_relative 'berkshelf/errors'
 
@@ -67,8 +69,7 @@ module Berkshelf
     #
     # @return [String]
     def berkshelf_path
-      path = @berkshelf_path || ENV['BERKSHELF_PATH'] || '~/.berkshelf'
-      File.expand_path(path)
+      @berkshelf_path ||= File.expand_path(ENV['BERKSHELF_PATH'] || '~/.berkshelf')
     end
 
     # The Berkshelf configuration.

data/lib/berkshelf/config.rb

@@ -107,7 +107,7 @@ module Berkshelf
       default: false
     attribute 'vagrant.vm.box',
       type: String,
-      default: 'chef/ubuntu-14.04',
+      default: 'bento/ubuntu-14.04',
       required: true
     # @todo Deprecated, remove?
     attribute 'vagrant.vm.box_url',
@@ -135,5 +135,14 @@ module Berkshelf
       type: Array,
       default: [],
       required: false
+    attribute 'gitlab',
+      type: Array,
+      default: [],
+      required: false
+    attribute 'github_protocol',
+      # :git, :ssh, or :https
+      type: Symbol,
+      default: :https,
+      required: false
   end
 end

data/lib/berkshelf/downloader.rb

@@ -137,6 +137,40 @@ module Berkshelf
           (! filename.to_s.start_with?('.')) && (unpack_dir + filename).cookbook?
         end.first
 
+        (unpack_dir + cookbook_directory).to_s
+      when :gitlab
+        #Thread.exclusive { require 'octokit' unless defined?(Octokit) }
+
+        tmp_dir      = Dir.mktmpdir
+        archive_path = Pathname.new(tmp_dir) + "#{name}-#{version}.tar.gz"
+        unpack_dir   = Pathname.new(tmp_dir) + "#{name}-#{version}"
+
+        # Find the correct gitlab connection options for this specific cookbook.
+        cookbook_uri = URI.parse(remote_cookbook.location_path)
+        if cookbook_uri.host
+          options = Berkshelf::Config.instance.gitlab.detect { |opts| opts["web_endpoint"] == "#{cookbook_uri.scheme}://#{cookbook_uri.host}" }
+          raise ConfigurationError.new "Missing github endpoint configuration for #{cookbook_uri.scheme}://#{cookbook_uri.host}" if options == nil
+        end
+
+        connection ||= Faraday.new(url: options[:web_endpoint]) do |faraday|
+          faraday.headers[:accept] = 'application/x-tar'
+          faraday.response :logger, @logger unless @logger.nil?
+          faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
+        end
+
+        resp = connection.get(cookbook_uri.request_uri + '&private_token=' + options[:private_token])
+        return nil unless resp.status == 200
+        open(archive_path, "wb") { |file| file.write(resp.body) }
+
+        tgz = Zlib::GzipReader.new(File.open(archive_path, "rb"))
+        Archive::Tar::Minitar.unpack(tgz, unpack_dir)
+
+        # The top level directory is inconsistant. So we unpack it and
+        # use the only directory created in the unpack_dir.
+        cookbook_directory = unpack_dir.entries.select do |filename|
+          (! filename.to_s.start_with?('.')) && (unpack_dir + filename).cookbook?
+        end.first
+
         (unpack_dir + cookbook_directory).to_s
       when :file_store
         tmp_dir = Dir.mktmpdir

data/lib/berkshelf/locations/git.rb

@@ -66,9 +66,9 @@ module Berkshelf
       # Validate the scratched path is a valid cookbook
       validate_cached!(scratch_path)
 
-      # If we got this far, we should copy
+      # If we got this far, we should atomically move
       FileUtils.rm_rf(install_path) if install_path.exist?
-      FileUtils.cp_r(scratch_path, install_path)
+      FileUtils.mv(scratch_path, install_path)
 
       # Remove the git history
       FileUtils.rm_rf(File.join(install_path, '.git'))

data/lib/berkshelf/locations/github.rb

@@ -1,7 +1,19 @@
 module Berkshelf
   class GithubLocation < GitLocation
+    HOST = 'github.com'
     def initialize(dependency, options = {})
-      options[:git] = "git://github.com/#{options.delete(:github)}.git"
+      protocol = Berkshelf::Config.instance.github_protocol || :https
+      case protocol
+      when :ssh
+        options[:git] = "git@#{HOST}:#{options.delete(:github)}.git"
+      when :https
+        options[:git] = "https://#{HOST}/#{options.delete(:github)}.git"
+      when :git
+        options[:git] = "git://#{HOST}/#{options.delete(:github)}.git"
+      else
+        # if some bizarre value is provided, treat it as :https
+        options[:git] = "https://#{HOST}/#{options.delete(:github)}.git"
+      end
       super
     end
   end

data/lib/berkshelf/lockfile.rb

@@ -113,7 +113,7 @@ module Berkshelf
           return false
         end
 
-        if cookbook = dependency.cached_cookbook
+        if cookbook = locked.cached_cookbook
           Berkshelf.log.debug "  Detected there is a cached cookbook"
 
           unless (cookbook.dependencies.keys - graphed.dependencies.keys).empty?
@@ -587,6 +587,9 @@ module Berkshelf
           end
 
           @parsed_dependencies.each do |name, options|
+            graph_item = @lockfile.graph.find(name)
+            options[:locked_version] = graph_item.version if graph_item
+
             dependency = Dependency.new(@berksfile, name, options)
             @lockfile.add(dependency)
           end
@@ -667,7 +670,7 @@ module Berkshelf
             # We need to make a copy of the dependency, or else we could be
             # modifying an existing object that other processes depend on!
             dependency = dependency.dup
-            dependency.locked_version = item.version
+            dependency.locked_version = item.version unless dependency.locked_version 
 
             hash[item.name] = dependency
             hash

data/lib/berkshelf/version.rb

@@ -1,3 +1,3 @@
 module Berkshelf
-  VERSION = "4.3.5"
+  VERSION = "5.0.0"
 end