berkshelf 7.0.8 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7106f564a5687739b6b869ddb82caab720210cb55ceaec843de5864321752591
-  data.tar.gz: 4196d7280ddf0bcec16c38c6cde5b9829a8e7d37b3aed818671e23294d1af301
+  metadata.gz: 74b3f02281f737a99b466bb6e902b83e14dc4753eca57e4c53ebcc9d18147c4b
+  data.tar.gz: e8c566401ba73574604f2427b91a414af8a10e04d20d6c78df0e5cac58bc9ebc
 SHA512:
-  metadata.gz: ba89f50812a6ffa647fc6c9cb349ce169e9fbb2c641d635157ed4410e75363f5eb2a4ab817002de907965bde4234fd9d7930dfe1a3f76bd8997aa4f2efe30a72
-  data.tar.gz: 51c592e399c3213ec72755dca557b7926e1d8abd14659bcc6e2547d032b018eac8c4b3fb69037e4c26fefe7611b0d3c96465af6fe7f67e62915107476b6018d7
+  metadata.gz: ad41f78382168194e5e7289a58ddb2213724839c64a5cf033551d874f935af0b2f6343a64499649499aed797a63b5d5d261298733cd4131e56b072a1671e55ee
+  data.tar.gz: 19735889f013e0c9afca6ae0ab3b4496d2d35d09dc85592fb2b6d549a5e1224f19dc76926021f7ec5be735ff44d49299f0b6a69122e27f719a72611a91424dda

data/Gemfile

@@ -2,18 +2,13 @@ source "https://rubygems.org"
 
 gemspec
 
-group :changelog do
-  gem "github_changelog_generator"
-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 "aruba",         "~> 0.10" # Stay below 1 until aruba/in_process monkeypatching stops
+  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"
@@ -22,11 +17,7 @@ group :development do
   gem "rspec-its",     ">= 1.2"
   gem "webmock",       ">= 1.11"
   gem "http",          ">= 0.9.8"
-  gem "chefstyle", git: "https://github.com/chef/chefstyle.git", branch: "master"
-end
-
-group :docs do
-  gem "yard", ">= 0.8"
+  gem "chefstyle"
 end
 
 instance_eval(ENV["GEMFILE_MOD"]) if ENV["GEMFILE_MOD"]

data/Rakefile

@@ -14,8 +14,8 @@ 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,7 +35,7 @@ begin
 rescue LoadError
 end
 
-task default: [:spec, :features]
+task default: %i{spec features}
 task :ci do
   ENV["CI"] = "true"
   Rake::Task[:spec].invoke

data/berkshelf.gemspec

@@ -1,5 +1,4 @@
-# -*- 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 = [
@@ -36,9 +35,9 @@ Gem::Specification.new do |s|
   s.add_dependency "solve",                "~> 4.0"
   s.add_dependency "thor",                 ">= 0.20"
   s.add_dependency "octokit",              "~> 4.0"
-  s.add_dependency "mixlib-archive",       ">= 0.4", "< 2.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 "chef",                 ">= 13.6.52"
+  s.add_dependency "chef",                 ">= 15.7.32" # needed for --skip-syntax-check
   s.add_dependency "chef-config"
   # this is required for Mixlib::Config#from_json
   s.add_dependency "mixlib-config", ">= 2.2.5"

data/bin/berks

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

data/lib/berkshelf/api_client/chef_server_connection.rb

@@ -1,25 +1,24 @@
-require "berkshelf/ridley_compat"
+require_relative "../ridley_compat"
 
 module Berkshelf
   module APIClient
     require_relative "errors"
 
     class ChefServerConnection
-      attr_reader :client
-
-      def initialize(*args)
-        @client = Berkshelf::RidleyCompat.new(*args)
-        @url = args[0][:server_url]
+      def initialize(**args)
+        @client = Berkshelf::RidleyCompat.new(**args)
+        @url = args[:server_url]
       end
 
       def universe
-        response = client.get("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
+              cookbooks << RemoteCookbook.new(name, version, attributes)
+            end
           end
         end
       rescue Ridley::Errors::HTTPNotFound

data/lib/berkshelf/api_client/connection.rb

@@ -1,4 +1,4 @@
-require "berkshelf/ridley_compat"
+require_relative "../ridley_compat"
 
 module Berkshelf
   module APIClient

data/lib/berkshelf/api_client/remote_cookbook.rb

@@ -1,4 +1,4 @@
-require "json"
+require "json" unless defined?(JSON)
 require "chef/mash"
 
 module Berkshelf

data/lib/berkshelf/api_client.rb

@@ -16,8 +16,8 @@ module Berkshelf
         Connection.new(*args)
       end
 
-      def chef_server(*args)
-        ChefServerConnection.new(*args)
+      def chef_server(**args)
+        ChefServerConnection.new(**args)
       end
     end
   end

data/lib/berkshelf/berksfile.rb

@@ -13,7 +13,7 @@ module Berkshelf
       def from_options(options = {})
         options[:berksfile] ||= File.join(Dir.pwd, Berkshelf::DEFAULT_FILENAME)
         symbolized = Hash[options.map { |k, v| [k.to_sym, v] }]
-        from_file(options[:berksfile], symbolized.select { |k,| [:except, :only, :delete].include? k })
+        from_file(options[:berksfile], symbolized.select { |k,| %i{except only delete}.include? k })
       end
 
       # @param [#to_s] file
@@ -66,8 +66,8 @@ module Berkshelf
     #   group to be installed and all others to be ignored
     def initialize(path, options = {})
       @filepath         = File.expand_path(path)
-      @dependencies     = Hash.new
-      @sources          = Hash.new
+      @dependencies     = {}
+      @sources          = {}
       @delete           = options[:delete]
 
       # defaults for what solvers to use
@@ -118,7 +118,7 @@ module Berkshelf
     #   cookbook 'artifact', path: '/Users/reset/code/artifact'
     #
     # @example a cookbook dependency that will be retrieved from a Git server
-    #   cookbook 'artifact', git: 'git://github.com/RiotGames/artifact-cookbook.git'
+    #   cookbook 'artifact', git: 'https://github.com/chef/artifact-cookbook.git'
     #
     # @overload cookbook(name, version_constraint, options = {})
     #   @param [#to_s] name
@@ -146,7 +146,7 @@ module Berkshelf
     #   @see PathLocation
     #   @see GitLocation
     def cookbook(*args)
-      options = args.last.is_a?(Hash) ? args.pop : Hash.new
+      options = args.last.is_a?(Hash) ? args.pop : {}
       name, constraint = args
 
       options[:path] &&= File.expand_path(options[:path], File.dirname(filepath))
@@ -156,7 +156,7 @@ module Berkshelf
         options[:group] += @active_group
       end
 
-      add_dependency(name, constraint, options)
+      add_dependency(name, constraint, **options)
     end
     expose :cookbook
 
@@ -176,10 +176,10 @@ module Berkshelf
     # @option options [String] :path
     #   path to the metadata file
     def metadata(options = {})
-      path          = options[:path] || File.dirname(filepath)
+      path = options[:path] || File.dirname(filepath)
 
       loader = Chef::Cookbook::CookbookVersionLoader.new(path)
-      loader.load_cookbooks
+      loader.load!
       cookbook_version = loader.cookbook_version
       metadata = cookbook_version.metadata
 
@@ -282,7 +282,7 @@ module Berkshelf
       if @dependencies[name]
         # Only raise an exception if the dependency is a true duplicate
         groups = (options[:group].nil? || options[:group].empty?) ? [:default] : options[:group]
-        if !(@dependencies[name].groups & groups).empty?
+        unless (@dependencies[name].groups & groups).empty?
           raise DuplicateDependencyDefined.new(name)
         end
       end
@@ -500,7 +500,7 @@ module Berkshelf
           latest = cookbooks.select do |cookbook|
             (include_non_satisfying || dependency.version_constraint.satisfies?(cookbook.version)) &&
               Semverse::Version.coerce(cookbook.version) > dependency.locked_version
-          end.sort_by { |cookbook| cookbook.version }.last
+          end.max_by(&:version)
 
           unless latest.nil?
             hash[name] ||= {
@@ -644,7 +644,7 @@ module Berkshelf
           FileUtils.mkdir_p(cookbook_destination)
 
           # Dir.glob does not support backslash as a File separator
-          src   = cookbook.path.to_s.tr('\\', "/")
+          src   = cookbook.path.to_s.tr("\\", "/")
           files = FileSyncer.glob(File.join(src, "**/*"))
 
           # strip directories
@@ -659,7 +659,7 @@ module Berkshelf
           files.reject! { |file_path| chefignore.ignored?(file_path) }
 
           # convert Pathname objects back to strings
-          files.map! { |f| f.to_s }
+          files.map!(&:to_s)
 
           # copy each file to destination
           files.each do |rpath|
@@ -740,39 +740,41 @@ module Berkshelf
 
     private
 
-      # Ensure the lockfile is present on disk.
-      #
-      # @raise [LockfileNotFound]
-      #   if the lockfile does not exist on disk
-      #
-      # @return [true]
+    # Ensure the lockfile is present on disk.
+    #
+    # @raise [LockfileNotFound]
+    #   if the lockfile does not exist on disk
+    #
+    # @return [true]
     def validate_lockfile_present!
       raise LockfileNotFound unless lockfile.present?
+
       true
     end
 
-      # Ensure that all dependencies defined in the Berksfile exist in this
-      # lockfile.
-      #
-      # @raise [LockfileOutOfSync]
-      #   if there are dependencies specified in the Berksfile which do not
-      #   exist (or are not satisifed by) the lockfile
-      #
-      # @return [true]
+    # Ensure that all dependencies defined in the Berksfile exist in this
+    # lockfile.
+    #
+    # @raise [LockfileOutOfSync]
+    #   if there are dependencies specified in the Berksfile which do not
+    #   exist (or are not satisifed by) the lockfile
+    #
+    # @return [true]
     def validate_lockfile_trusted!
       raise LockfileOutOfSync unless lockfile.trusted?
+
       true
     end
 
-      # Ensure that all dependencies in the lockfile are installed on this
-      # system. You should validate that the lockfile can be trusted before
-      # using this method.
-      #
-      # @raise [DependencyNotInstalled]
-      #   if the dependency in the lockfile is not in the Berkshelf shelf on
-      #   this system
-      #
-      # @return [true]
+    # Ensure that all dependencies in the lockfile are installed on this
+    # system. You should validate that the lockfile can be trusted before
+    # using this method.
+    #
+    # @raise [DependencyNotInstalled]
+    #   if the dependency in the lockfile is not in the Berkshelf shelf on
+    #   this system
+    #
+    # @return [true]
     def validate_dependencies_installed!
       lockfile.graph.locks.each do |_, dependency|
         unless dependency.installed?
@@ -783,13 +785,13 @@ module Berkshelf
       true
     end
 
-      # Determine if any cookbooks were specified that aren't in our shelf.
-      #
-      # @param [Array<String>] names
-      #   a list of cookbook names
-      #
-      # @raise [DependencyNotFound]
-      #   if a cookbook name is given that does not exist
+    # Determine if any cookbooks were specified that aren't in our shelf.
+    #
+    # @param [Array<String>] names
+    #   a list of cookbook names
+    #
+    # @raise [DependencyNotFound]
+    #   if a cookbook name is given that does not exist
     def validate_cookbook_names!(names)
       missing = names - lockfile.graph.locks.keys
 

data/lib/berkshelf/cached_cookbook.rb

@@ -1,6 +1,6 @@
 require "chef/cookbook/cookbook_version_loader"
 require "chef/cookbook/syntax_check"
-require "berkshelf/errors"
+require_relative "errors"
 require "chef/json_compat"
 
 module Berkshelf
@@ -66,7 +66,7 @@ module Berkshelf
       @loader ||=
         begin
           loader = Chef::Cookbook::CookbookVersionLoader.new(@path)
-          loader.load_cookbooks
+          loader.load!
           loader
         end
     end
@@ -151,7 +151,8 @@ module Berkshelf
     def validate
       raise IOError, "No Cookbook found at: #{path}" unless path.exist?
 
-      syntax_checker = Chef::Cookbook::SyntaxCheck.for_cookbook(cookbook_name, path)
+      syntax_checker = Chef::Cookbook::SyntaxCheck.new(path.to_path)
+
       unless syntax_checker.validate_ruby_files
         raise Berkshelf::Errors::CookbookSyntaxError, "Invalid ruby files in cookbook: #{cookbook_name} (#{version})."
       end
@@ -166,6 +167,7 @@ module Berkshelf
       json_file = "#{path}/metadata.json"
       rb_file = "#{path}/metadata.rb"
       return nil if File.exist?(json_file)
+
       md = Chef::Cookbook::Metadata.new
       md.from_file(rb_file)
       f = File.open(json_file, "w")

data/lib/berkshelf/chef_config_compat.rb

@@ -1,6 +1,6 @@
 require "chef-config/config"
 require "chef-config/workstation_config_loader"
-require "socket" # FIXME: why?
+require "socket" unless defined?(Socket) # FIXME: why?
 
 module Berkshelf
   class ChefConfigCompat

data/lib/berkshelf/chef_repo_universe.rb

@@ -1,5 +1,5 @@
-require "berkshelf/api_client/remote_cookbook"
-require "berkshelf/cached_cookbook"
+require_relative "api_client/remote_cookbook"
+require_relative "cached_cookbook"
 
 module Berkshelf
   # Shim to look like a Berkshelf::APIClient but for a chef repo folder.
@@ -15,8 +15,10 @@ module Berkshelf
     def universe
       Dir.entries(cookbooks_path).sort.each_with_object([]) do |entry, cookbooks|
         next if entry[0] == "." # Skip hidden folders.
+
         entry_path = "#{cookbooks_path}/#{entry}"
         next unless File.directory?(entry_path) # Skip non-dirs.
+
         cookbook = begin
           Berkshelf::CachedCookbook.from_path(entry_path)
                    rescue IOError

data/lib/berkshelf/cli.rb

@@ -1,4 +1,4 @@
-require "berkshelf"
+require_relative "../berkshelf"
 require_relative "config"
 require_relative "commands/shelf"
 
@@ -419,11 +419,11 @@ module Berkshelf
 
     private
 
-      # Print a list of the given cookbooks. This is used by various
-      # methods like {list} and {contingent}.
-      #
-      # @param [Array<CachedCookbook>] cookbooks
-      #
+    # Print a list of the given cookbooks. This is used by various
+    # methods like {list} and {contingent}.
+    #
+    # @param [Array<CachedCookbook>] cookbooks
+    #
     def print_list(cookbooks)
       Array(cookbooks).sort.each do |cookbook|
         Berkshelf.formatter.msg "  * #{cookbook.cookbook_name} (#{cookbook.version})"

data/lib/berkshelf/commands/shelf.rb

@@ -13,7 +13,7 @@ module Berkshelf
       else
         Berkshelf.formatter.msg "Cookbooks in the Berkshelf shelf:"
         cookbooks.sort.each do |cookbook, versions|
-          Berkshelf.formatter.msg("  * #{cookbook} (#{versions.sort.join(', ')})")
+          Berkshelf.formatter.msg("  * #{cookbook} (#{versions.sort.join(", ")})")
         end
       end
     end

data/lib/berkshelf/community_rest.rb

@@ -1,5 +1,5 @@
-require "retryable"
-require "mixlib/archive"
+require "retryable" unless defined?(Retryable)
+require "mixlib/archive" unless defined?(Mixlib::Archive)
 
 module Berkshelf
   class CommunityREST
@@ -69,13 +69,13 @@ module Berkshelf
     #   how often we should pause between retries
     def initialize(uri = V1_API, options = {})
       options = options.dup
-      options         = { retries: 5, retry_interval: 0.5, ssl: Berkshelf::Config.instance.ssl }.merge(options)
-      @api_uri        = uri
+      options = { retries: 5, retry_interval: 0.5, ssl: Berkshelf::Config.instance.ssl }.merge(options)
+      @api_uri = uri
       options[:server_url] = uri
-      @retries        = options.delete(:retries)
+      @retries = options.delete(:retries)
       @retry_interval = options.delete(:retry_interval)
 
-      @connection = Berkshelf::RidleyCompatJSON.new(options)
+      @connection = Berkshelf::RidleyCompatJSON.new(**options)
     end
 
     # Download and extract target cookbook archive to the local file system,

data/lib/berkshelf/config.rb

@@ -1,5 +1,5 @@
-require "mixlib/config"
-require "openssl"
+require "mixlib/config" unless defined?(Mixlib::Config)
+require "openssl" unless defined?(OpenSSL)
 
 # we need this method, but have to inject it into mixlib-config directly
 # to have it available from config contexts
@@ -122,7 +122,7 @@ module Berkshelf
             default :email, nil
             default :license, nil
           end
-          default :allowed_licenses, Array.new
+          default :allowed_licenses, []
           default :raise_license_exception, false
           config_context :vagrant do
             config_context :vm do

data/lib/berkshelf/cookbook_store.rb

@@ -1,4 +1,4 @@
-require "fileutils"
+require "fileutils" unless defined?(FileUtils)
 require "chef/exceptions"
 
 module Berkshelf
@@ -49,9 +49,7 @@ module Berkshelf
 
     # Destroy the contents of the initialized storage path.
     def clean!
-      Dir.chdir(storage_path) do
-        FileUtils.rm_rf(Dir.glob("*"))
-      end
+      FileUtils.rm_rf(Dir.glob("#{storage_path}/*"))
     end
 
     # Import a cookbook found on the local filesystem into this instance of the cookbook store.

data/lib/berkshelf/core_ext/file_utils.rb

@@ -1,4 +1,4 @@
-require "fileutils"
+require "fileutils" unless defined?(FileUtils)
 
 module FileUtils
   class << self
@@ -14,10 +14,10 @@ module FileUtils
     # symlink on Linux
     # @see {FileUtils::mv}
     def mv(src, dest, options = {})
-      old_mv(src, dest, options)
+      old_mv(src, dest, **options)
     rescue Errno::EACCES, Errno::ENOENT
       options.delete(:force) if options.key?(:force)
-      FileUtils.cp_r(src, dest, options)
+      FileUtils.cp_r(src, dest, **options)
       FileUtils.rm_rf(src)
     end
   end

data/lib/berkshelf/core_ext.rb

@@ -1,3 +1,3 @@
 Dir["#{File.dirname(__FILE__)}/core_ext/*.rb"].sort.each do |path|
-  require_relative "core_ext/#{File.basename(path, '.rb')}"
+  require_relative "core_ext/#{File.basename(path, ".rb")}"
 end

data/lib/berkshelf/dependency.rb

@@ -171,7 +171,7 @@ module Berkshelf
         "#{name} (#{version_constraint})",
         "locked_version: #{locked_version.inspect}",
         "groups: #{groups}",
-        "location: #{location || 'default'}>",
+        "location: #{location || "default"}>",
       ].join(", ")
     end
 

data/lib/berkshelf/downloader.rb

@@ -1,6 +1,7 @@
-require "net/http"
-require "mixlib/archive"
-require "berkshelf/ssl_policies"
+require "net/http" unless defined?(Net::HTTP)
+require "mixlib/archive" unless defined?(Mixlib::Archive)
+require_relative "ssl_policies"
+require "faraday" unless defined?(Faraday)
 
 module Berkshelf
   class Downloader
@@ -83,7 +84,7 @@ module Berkshelf
           client_key: source.options[:client_key] || Berkshelf::Config.instance.chef.client_key,
           ssl: source.options[:ssl],
         }
-        RidleyCompat.new_client(credentials) do |conn|
+        RidleyCompat.new_client(**credentials) do |conn|
           cookbook = Chef::CookbookVersion.load(name, version)
           manifest = cookbook.cookbook_manifest
           manifest.by_parent_directory.each do |segment, files|
@@ -120,7 +121,7 @@ module Berkshelf
         )
 
         begin
-          url = URI(github_client.archive_link(cookbook_uri.path.gsub(/^\//, ""), ref: "v#{version}"))
+          url = URI(github_client.archive_link(cookbook_uri.path.gsub(%r{^/}, ""), ref: "v#{version}"))
         rescue Octokit::Unauthorized
           return nil
         end
@@ -131,6 +132,7 @@ module Berkshelf
         http.verify_mode = (options["ssl_verify"].nil? || options["ssl_verify"]) ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
         resp = http.get(url.request_uri)
         return nil unless resp.is_a?(Net::HTTPSuccess)
+
         open(archive_path, "wb") { |file| file.write(resp.body) }
 
         Mixlib::Archive.new(archive_path).extract(unpack_dir)
@@ -143,7 +145,7 @@ module Berkshelf
 
         File.join(unpack_dir, cookbook_directory)
       when :uri
-        require "open-uri"
+        require "open-uri" unless defined?(OpenURI)
 
         tmp_dir      = Dir.mktmpdir
         archive_path = Pathname.new(tmp_dir) + "#{name}-#{version}.tar.gz"
@@ -183,6 +185,7 @@ module Berkshelf
 
         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) }
 
         Mixlib::Archive.new(archive_path).extract(unpack_dir)

data/lib/berkshelf/errors.rb

@@ -83,7 +83,7 @@ module Berkshelf
 
     def to_s
       @original_exception.to_s +
-        "Unable to find a solution for demands: #{demands.join(', ')}"
+        "Unable to find a solution for demands: #{demands.join(", ")}"
     end
 
     alias_method :message, :to_s
@@ -91,6 +91,7 @@ module Berkshelf
 
   class CookbookSyntaxError < BerkshelfError; set_status_code(107); end
   class ConstraintNotSatisfied < BerkshelfError; set_status_code(111); end
+
   class BerksfileReadError < BerkshelfError
     set_status_code(113)
 
@@ -254,6 +255,7 @@ module Berkshelf
   end
 
   class UploadFailure < BerkshelfError; end
+
   class FrozenCookbook < UploadFailure
     set_status_code(126)
 
@@ -372,7 +374,7 @@ module Berkshelf
 
     def to_s
       "Unknown license: '#{license}'\n" +
-        "Available licenses: #{CookbookGenerator::LICENSES.join(', ')}"
+        "Available licenses: #{CookbookGenerator::LICENSES.join(", ")}"
     end
 
     alias_method :message, :to_s
@@ -436,6 +438,7 @@ module Berkshelf
   end
 
   class DuplicateDemand < BerkshelfError; set_status_code(138); end
+
   class LockfileNotFound < BerkshelfError
     set_status_code(140)