berkshelf 5.2.0 → 8.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5089b7006471b9e1a535ab4fc5f3ee1b83ae6114
-  data.tar.gz: 15c5ac0f94f60ea0d741975e13ed4af81fa5ef70
+SHA256:
+  metadata.gz: 547ce4d95888e7fd0fcfb2b50c449cc78c67ffb4885b44d953e69383d5d5ed26
+  data.tar.gz: 472be5adafecb5a2741701dc0c083017126c2cd9fb91bc5692a4d3f80beb2db6
 SHA512:
-  metadata.gz: a6a0945ca8000eb04ae6d381c04235ad9c9657635ba6eda6453134207421a8054df09407972988750ff89b5d93d183e2f2a966933eabc977471672ffd07ab530
-  data.tar.gz: ae1cfadeee18dda60605775d86d31720524636eb4e600a13d1802a75e4fa955621ba37463af8dc5b41c9537b5028d2274eda88e3a4c398dfae75a59c71dfafe3
+  metadata.gz: b28e165ac351b1902ba1bc65f7715d5a1a709881f46c039f4186b7dd6e924a9412789332cae9c37db8e75caff2a503d4fa91637d872fc7f12b51fa6cc04dcea0
+  data.tar.gz: 78c7e37a5ebee0dbb8faa346cd5807f888fd16b8591688ee3248d04be4372035561ba65765700d6c39ab56d2d09f22acdc4d1aad24f416537babc5f042ae3caa

data/Gemfile

@@ -1,56 +1,28 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-group :guard do
-  gem 'coolline'
-  gem 'guard'
-  gem 'guard-cucumber'
-  gem 'guard-rspec'
-  gem 'guard-spork'
-
-  require 'rbconfig'
-
-  if RbConfig::CONFIG['target_os'] =~ /darwin/i
-    gem 'growl', require: false
-    gem 'rb-fsevent', require: false
-
-    if `uname`.strip == 'Darwin' && `sw_vers -productVersion`.strip >= '10.8'
-      gem 'terminal-notifier-guard', '~> 1.5.3', require: false
-    end rescue Errno::ENOENT
-
-  elsif RbConfig::CONFIG['target_os'] =~ /linux/i
-    gem 'libnotify',  '~> 0.8.0', require: false
-    gem 'rb-inotify', require: false
-
-  elsif RbConfig::CONFIG['target_os'] =~ /mswin|mingw/i
-    gem 'rb-notifu', '>= 0.0.4', require: false
-    gem 'wdm', require: false
-    gem 'win32console', require: false
-  end
+group :build do
+  gem "rake",          ">= 10.1"
 end
 
 group :development do
-  # these all deliberately float because berkshelf has a Gemfile.lock that
-  # equality pins them.  temporarily pin as necessary for API breaks.
-  gem 'aruba',         '>= 0.10.0'
-  gem 'chef-zero',     '>= 4.0'
-  gem 'dep_selector',  '>= 1.0'
-  gem 'fuubar',        '>= 2.0'
-  gem 'rake',          '>= 10.1'
-  gem 'rspec',         '>= 3.0'
-  gem 'spork',         '>= 0.9'
-  gem 'test-kitchen',  '>= 1.2'
-  gem 'webmock',       '>= 1.11'
-  gem 'yard',          '>= 0.8'
-  gem 'http',          '>= 0.9.8'
-  gem 'activesupport', '~> 4.0'  # pinning for ruby 2.1.x
+  gem "aruba",         "~> 0.10" # Stay below 1 until aruba/in_process monkeypatching stops
+  gem "debug"
+  gem "cucumber",      "< 4.0" # until we identify what is generating the ~@no_run tag in CI
+  gem "cucumber-expressions", "= 5.0.13"
+  gem "chef-zero",     ">= 4.0"
+  gem "dep_selector",  ">= 1.0"
+  gem "fuubar",        ">= 2.0"
+  gem "rspec",         ">= 3.0"
+  gem "rspec-its",     ">= 1.2"
+  gem "webmock",       ">= 1.11"
+  gem "http",          ">= 0.9.8"
+  gem "chefstyle"
 end
 
-group :changelog do
-  gem 'github_changelog_generator', "1.11.3"
-end
+instance_eval(ENV["GEMFILE_MOD"]) if ENV["GEMFILE_MOD"]
 
-group :test do
-  gem "berkshelf-api", git: "https://github.com/berkshelf/berkshelf-api.git", ref: "9fb3d95779c4ff72b0074072105caaf70b978bf0"
-end
+# If you want to load debugging tools into the bundle exec sandbox,
+# add these additional dependencies into Gemfile.local
+eval_gemfile(__FILE__ + ".local") if File.exist?(__FILE__ + ".local")

data/Rakefile

@@ -8,14 +8,14 @@ rescue LoadError
   task :spec
 end
 
-WINDOWS_PLATFORM = /mswin|win32|mingw/ unless defined? WINDOWS_PLATFORM
+WINDOWS_PLATFORM = /mswin|win32|mingw/.freeze unless defined? WINDOWS_PLATFORM
 
 begin
   require "cucumber"
   require "cucumber/rake/task"
   Cucumber::Rake::Task.new(:features) do |t|
-    if RUBY_PLATFORM =~ WINDOWS_PLATFORM
-      t.cucumber_opts = "--tags ~@not-windows"
+    if RUBY_PLATFORM =~ WINDOWS_PLATFORM || RUBY_PLATFORM =~ /darwin/
+      t.cucumber_opts = "--tags 'not @not-windows'"
     end
   end
 rescue LoadError
@@ -35,9 +35,19 @@ begin
 rescue LoadError
 end
 
-task default: [:spec, :features]
+task default: %i{spec features}
 task :ci do
   ENV["CI"] = "true"
   Rake::Task[:spec].invoke
   Rake::Task[:features].invoke
 end
+
+begin
+  require "chefstyle"
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new(:style) do |task|
+    task.options += ["--display-cop-names", "--no-color"]
+  end
+rescue LoadError
+  puts "chefstyle/rubocop is not available.  gem install chefstyle to do style checking."
+end

data/berkshelf.gemspec

@@ -1,48 +1,69 @@
-# -*- encoding: utf-8; mode: ruby -*-
-require File.expand_path('../lib/berkshelf/version', __FILE__)
+require File.expand_path("lib/berkshelf/version", __dir__)
 
 Gem::Specification.new do |s|
-  s.authors               = [
-    'Jamie Winsor',
-    'Josiah Kiehl',
-    'Michael Ivey',
-    'Justin Campbell',
-    'Seth Vargo'
+  s.authors = [
+    "Jamie Winsor",
+    "Josiah Kiehl",
+    "Michael Ivey",
+    "Justin Campbell",
+    "Seth Vargo",
   ]
-  s.email                 = [
-    'jamie@vialstudios.com',
-    'jkiehl@riotgames.com',
-    'michael.ivey@riotgames.com',
-    'justin@justincampbell.me',
-    'sethvargo@gmail.com'
+  s.email = [
+    "jamie@vialstudios.com",
+    "jkiehl@riotgames.com",
+    "michael.ivey@riotgames.com",
+    "justin@justincampbell.me",
+    "sethvargo@gmail.com",
   ]
 
-  s.description               = %q{Manages a Cookbook's, or an Application's, Cookbook dependencies}
+  s.description               = %q{Manages a Chef cookbook's dependencies}
   s.summary                   = s.description
-  s.homepage                  = 'http://berkshelf.com'
-  s.license                   = 'Apache 2.0'
-  s.files                     = `git ls-files`.split($\)
-  s.executables               = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  s.test_files                = s.files.grep(%r{^(test|spec|features)/})
-  s.name                      = 'berkshelf'
-  s.require_paths             = ['lib']
+  s.homepage                  = "https://docs.chef.io/berkshelf.html"
+  s.license                   = "Apache-2.0"
+  s.files                     = %w{LICENSE Gemfile Rakefile} + Dir.glob("*.gemspec") + Dir.glob("{lib,spec, features}/**/*")
+  s.executables               = Dir.glob("bin/**/*").map { |f| File.basename(f) }
+  s.name                      = "berkshelf"
+  s.require_paths             = ["lib"]
   s.version                   = Berkshelf::VERSION
-  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', '< 4.0'
-  s.add_dependency 'buff-config',          '~> 2.0'
-  s.add_dependency 'buff-extensions',      '~> 2.0'
-  s.add_dependency 'buff-shell_out',       '~> 1.0'
-  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',               '~> 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 'mixlib-archive',       '~> 0.1'
+  s.required_ruby_version     = ">= 2.7.0"
+  s.required_rubygems_version = ">= 2.0.0"
+  s.metadata                  = {
+    "bug_tracker_uri" => "https://github.com/chef/berkshelf/issues",
+    "source_code_uri" => "https://github.com/chef/berkshelf",
+    "changelog_uri"   => "https://github.com/chef/berkshelf/blob/main/CHANGELOG.md",
+  }
+
+  ruby_version = Gem::Version.new(RUBY_VERSION)
+
+  s.add_dependency "mixlib-shellout",      ">= 2.0", "< 4.0"
+
+  s.add_dependency "chef-cleanroom",            "~> 1.0"
+
+  if ruby_version >= Gem::Version.new("3.1.0")
+    s.add_dependency "minitar",              "~> 1.0"
+    s.add_dependency "chef",                 ">= 18.0.0"
+  else
+    s.add_dependency "minitar",              "~> 0.12"
+
+    if ruby_version >= Gem::Version.new("3.0.0")
+      s.add_dependency "chef",                 "~> 17.0" # needed for --skip-syntax-check
+    else
+      s.add_dependency "chef",                 ">= 15.7.32"
+    end
+  end
+
+  s.add_dependency "retryable",            ">= 2.0", "< 4.0"
+  s.add_dependency "solve",                "~> 4.0"
+
+  s.add_dependency "thor",                 ">= 0.20", "< 1.3.0"
+  s.add_dependency "octokit",              ">= 4.0", "< 6.0"
+
+  s.add_dependency "mixlib-archive",       ">= 1.1.4", "< 2.0" # needed for ruby 3.0 / Dir.chdir removal
+  s.add_dependency "concurrent-ruby",      "~> 1.0"
+
+  s.add_dependency "ffi",                "~> 1.9", "< 1.16.0" #
+
+  s.add_dependency "chef-config"
+  # this is required for Mixlib::Config#from_json
+  s.add_dependency "mixlib-config", ">= 2.2.5"
 end

data/bin/berks

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
-$:.push File.expand_path('../../lib', __FILE__)
-require 'berkshelf/cli'
+$:.push File.expand_path("../lib", __dir__)
+require "berkshelf/cli"
 
 Berkshelf::Cli::Runner.new(ARGV.dup).execute!

data/lib/berkshelf/api-client.rb

@@ -0,0 +1 @@
+require_relative "api_client"

data/lib/berkshelf/api_client/chef_server_connection.rb

@@ -0,0 +1,29 @@
+require_relative "../ridley_compat"
+
+module Berkshelf
+  module APIClient
+    require_relative "errors"
+
+    class ChefServerConnection
+      def initialize(**args)
+        @client = Berkshelf::RidleyCompat.new(**args)
+        @url = args[:server_url]
+      end
+
+      def universe
+        response = @client.get("universe")
+
+        [].tap do |cookbooks|
+          response.each do |name, versions|
+            versions.each do |version, attributes|
+              attributes[:location_path] = @url
+              cookbooks << RemoteCookbook.new(name, version, attributes)
+            end
+          end
+        end
+      rescue Ridley::Errors::HTTPNotFound
+        raise ServiceNotFound, "service not found at: #{@url}"
+      end
+    end
+  end
+end

data/lib/berkshelf/api_client/connection.rb

@@ -0,0 +1,57 @@
+require_relative "../ridley_compat"
+
+module Berkshelf
+  module APIClient
+    require_relative "errors"
+
+    class Connection
+      # @return [String]
+      attr_reader :url
+
+      # @return [Integer]
+      #   how many retries to attempt on HTTP requests
+      attr_reader :retries
+
+      # @return [Float]
+      #   time to wait between retries
+      attr_reader :retry_interval
+
+      # @param [String, Addressable::URI] url
+      #
+      # @option options [Integer] :open_timeout (3)
+      #   how long to wait (in seconds) for connection open to the API server
+      # @option options [Integer] :timeout (30)
+      #   how long to wait (in seconds) before getting a response from the API server
+      # @option options [Integer] :retries (3)
+      #   how many retries to perform before giving up
+      # @option options [Float] :retry_interval (0.5)
+      #   how long to wait (in seconds) between each retry
+      def initialize(url, options = {})
+        # it looks like Faraday mutates the URI argument it is given, when we ripped Faraday out of this
+        # API it stopped doing that.  this may or may not be a breaking change (it broke some fairly
+        # brittle berkshelf tests).  if it causes too much berkshelf chaos we could revert by uncommenting
+        # the next line.  as it is removing this behavior feels more like fixing a bug.
+        # @url = url.normalize! if url.is_a?(Addressable::URI)
+        options = { retries: 3, retry_interval: 0.5, open_timeout: 30, timeout: 30 }.merge(options)
+        options[:server_url] = url
+
+        @client = Berkshelf::RidleyCompatJSON.new(**options)
+      end
+
+      # Retrieves the entire universe of known cookbooks from the API source
+      #
+      # @raise [APIClient::TimeoutError]
+      #
+      # @return [Array<APIClient::RemoteCookbook>]
+      def universe
+        response = @client.get("universe")
+
+        [].tap do |cookbooks|
+          response.each do |name, versions|
+            versions.each { |version, attributes| cookbooks << RemoteCookbook.new(name, version, attributes) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/berkshelf/api_client/errors.rb

@@ -0,0 +1,10 @@
+module Berkshelf
+  class APIClientError < StandardError; end
+
+  module APIClient
+    class TimeoutError < APIClientError; end
+    class BadResponse < APIClientError; end
+    class ServiceUnavailable < APIClientError; end
+    class ServiceNotFound < APIClientError; end
+  end
+end

data/lib/berkshelf/api_client/remote_cookbook.rb

@@ -0,0 +1,56 @@
+require "json" unless defined?(JSON)
+require "chef/mash"
+
+module Berkshelf
+  module APIClient
+    # A representation of cookbook metadata indexed by a Berkshelf API Server. Returned
+    # by sending messages to a {Berkshelf::APIClient} and used to download cookbooks
+    # indexed by the Berkshelf API Server.
+    class RemoteCookbook
+      # @return [String]
+      attr_reader :name
+      # @return [String]
+      attr_reader :version
+
+      # @param [String] name
+      # @param [String] version
+      # @param [Hash] attributes
+      def initialize(name, version, attributes = {})
+        @name       = name
+        @version    = version
+        @attributes = ::Mash.new(attributes)
+      end
+
+      # @return [Hash]
+      def dependencies
+        @attributes[:dependencies]
+      end
+
+      # @return [Hash]
+      def platforms
+        @attributes[:platforms]
+      end
+
+      # @return [Symbol]
+      def location_type
+        @attributes[:location_type].to_sym
+      end
+
+      # @return [String]
+      def location_path
+        @attributes[:location_path]
+      end
+
+      def to_hash
+        {
+          name: name,
+          version: version,
+        }
+      end
+
+      def to_json(options = {})
+        ::JSON.pretty_generate(to_hash, options)
+      end
+    end
+  end
+end

data/lib/berkshelf/api_client/version.rb

@@ -0,0 +1,5 @@
+module Berkshelf
+  module APIClient
+    VERSION = "4.0.1".freeze
+  end
+end

data/lib/berkshelf/api_client.rb

@@ -0,0 +1,24 @@
+module Berkshelf
+  # Used to communicate with a remotely hosted [Berkshelf API Server](https://github.com/berkshelf/berkshelf-api).
+  #
+  # @example
+  #   client = Berkshelf::APIClient.new("https://api.berkshelf.com")
+  #   client.universe #=> [...]
+  module APIClient
+    require_relative "api_client/version"
+    require_relative "api_client/errors"
+    require_relative "api_client/remote_cookbook"
+    require_relative "api_client/connection"
+    require_relative "api_client/chef_server_connection"
+
+    class << self
+      def new(*args)
+        Connection.new(*args)
+      end
+
+      def chef_server(**args)
+        ChefServerConnection.new(**args)
+      end
+    end
+  end
+end