berkshelf 7.0.6 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 547a8faa0841fb8dbd0c8f534bcc47d765dd0a36ac9414248a0d60e5cb55bb0f
-  data.tar.gz: cc0b2093ad106ce83f9ff8903e78783d01aab14f71cb00983ef050ddf37c5252
+  metadata.gz: db4572fef41dd9da70dbc590f97cac73ff70ef9c5206ae82dca20145f2d64da7
+  data.tar.gz: b31969725a11b43359027fa3e729381bc1515fdc8845601d473aac647f521b7e
 SHA512:
-  metadata.gz: 4feca3fb0ac9ad3f92dc8e97cc3ffd1b265d70e8d6bacbc381cf9dddf183f3529c464923d7d24f69344a20fcaf623e72093900bd2f5adccb141e769a8e538e71
-  data.tar.gz: dac1553f7c1b03774847482c4adeee183deb874b9b2565ff71022bd4f88f38894f559ad01434f398d86e6ae98a1e4857e0aa12017e1aeb11b757c4600f78ce69
+  metadata.gz: f760c4eca41839953b82dc30c4cb50ef60aff3ec7fc7c13a80d313f72d4d0ce775a61ae4c49b95de52d5a29f963d6a0d70d5a511af37d8aca900f05f72ef7f7d
+  data.tar.gz: 40f5a28f40e62e91c0b69ac8020611f9513cf03fc4e376c3edb1d60ad327288ecb3060daf4b4fd3e392e2a068838ccc7b0e9da72d3be6a0620835bbc9e0783fa

data/Gemfile

@@ -10,13 +10,10 @@ group :build do
   gem "rake",          ">= 10.1"
 end
 
-# temporarily until 13.7.x is released
-gem "chef", git: "https://github.com/chef/chef", branch: "master"
-
 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-bin" # for the proxy tests
+  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"
@@ -24,11 +21,14 @@ group :development do
   gem "rspec",         ">= 3.0"
   gem "rspec-its",     ">= 1.2"
   gem "webmock",       ">= 1.11"
-  gem "yard",          ">= 0.8"
   gem "http",          ">= 0.9.8"
   gem "chefstyle", git: "https://github.com/chef/chefstyle.git", branch: "master"
 end
 
+group :docs do
+  gem "yard", ">= 0.8"
+end
+
 instance_eval(ENV["GEMFILE_MOD"]) if ENV["GEMFILE_MOD"]
 
 # If you want to load debugging tools into the bundle exec sandbox,

data/Rakefile

@@ -8,7 +8,7 @@ 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"
@@ -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

@@ -17,29 +17,28 @@ Gem::Specification.new do |s|
     "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.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.4.0"
   s.required_rubygems_version = ">= 2.0.0"
 
-  s.add_dependency "mixlib-shellout",      "~> 2.0"
+  s.add_dependency "mixlib-shellout",      ">= 2.0", "< 4.0"
   s.add_dependency "cleanroom",            "~> 1.0"
   s.add_dependency "minitar",              ">= 0.6"
-  s.add_dependency "retryable",            "~> 2.0"
+  s.add_dependency "retryable",            ">= 2.0", "< 4.0"
   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"
+  s.add_dependency "mixlib-archive",       ">= 0.4", "< 2.0"
   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

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

data/lib/berkshelf.rb

@@ -23,7 +23,7 @@ JSON.create_id = nil
 
 require_relative "berkshelf/core_ext"
 require_relative "berkshelf/thor_ext"
-require "berkshelf/chef_config_compat"
+require_relative "berkshelf/chef_config_compat"
 
 module Berkshelf
   Encoding.default_external = Encoding::UTF_8
@@ -169,7 +169,7 @@ module Berkshelf
         raise ChefConnectionError, "Missing required attribute in your Berkshelf configuration: chef.client_key"
       end
 
-      RidleyCompat.new_client(ridley_options, &block)
+      RidleyCompat.new_client(**ridley_options, &block)
     rescue ChefConnectionError, BerkshelfError
       raise
     rescue => ex

data/lib/berkshelf/api_client/chef_server_connection.rb

@@ -1,4 +1,4 @@
-require "berkshelf/ridley_compat"
+require_relative "../ridley_compat"
 
 module Berkshelf
   module APIClient
@@ -19,7 +19,8 @@ module Berkshelf
           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/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
@@ -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))
@@ -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
@@ -468,6 +468,10 @@ module Berkshelf
     # List of all the cookbooks which have a newer version found at a source
     # that satisfies the constraints of your dependencies.
     #
+    # @param [Boolean] include_non_satisfying
+    #   include cookbooks that would not satisfy the given constraints in the
+    #   +Berksfile+. Defaults to false.
+    #
     # @return [Hash]
     #   a hash of cached cookbooks and their latest version grouped by their
     #   remote API source. The hash will be empty if there are no newer
@@ -483,7 +487,7 @@ module Berkshelf
     #       }
     #     }
     #   }
-    def outdated(*names)
+    def outdated(*names, include_non_satisfying: false)
       validate_lockfile_present!
       validate_lockfile_trusted!
       validate_dependencies_installed!
@@ -494,9 +498,9 @@ module Berkshelf
           cookbooks = source.versions(name)
 
           latest = cookbooks.select do |cookbook|
-            dependency.version_constraint.satisfies?(cookbook.version) &&
+            (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.sort_by(&:version).last
 
           unless latest.nil?
             hash[name] ||= {
@@ -655,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|
@@ -736,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?
@@ -779,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
@@ -94,7 +94,7 @@ module Berkshelf
       [cookbook_name, version] <=> [other.cookbook_name, other.version]
     end
 
-    DIRNAME_REGEXP = /^(.+)-(.+)$/
+    DIRNAME_REGEXP = /^(.+)-(.+)$/.freeze
 
     extend Forwardable
 
@@ -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

@@ -13,6 +13,7 @@ module Berkshelf
       ChefConfig::WorkstationConfigLoader.new(path).load
       ChefConfig::Config.merge!(options)
       ChefConfig::Config.export_proxies # Set proxy settings as environment variables
+      ChefConfig::Config.init_openssl # setup openssl + fips mode
     end
 
     # Keep defaults that aren't in ChefConfig::Config

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,12 +15,14 @@ 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
-          next # It wasn't a cookbook.
+                   rescue IOError
+                     next # It wasn't a cookbook.
         end
         cookbooks << Berkshelf::APIClient::RemoteCookbook.new(
           cookbook.cookbook_name,

data/lib/berkshelf/cli.rb

@@ -1,4 +1,4 @@
-require "berkshelf"
+require_relative "../berkshelf"
 require_relative "config"
 require_relative "commands/shelf"
 
@@ -235,10 +235,15 @@ module Berkshelf
       type: :array,
       desc: "Only cookbooks that are in these groups.",
       aliases: "-o"
+    method_option :all,
+      type: :boolean,
+      desc: "Include cookbooks that don't satisfy the version constraints.",
+      aliases: "-a",
+      default: false
     desc "outdated [COOKBOOKS]", "List dependencies that have new versions available that satisfy their constraints"
     def outdated(*names)
       berksfile = Berksfile.from_options(options)
-      outdated  = berksfile.outdated(*names)
+      outdated  = berksfile.outdated(*names, include_non_satisfying: options[:all])
       Berkshelf.formatter.outdated(outdated)
     end
 
@@ -414,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