chef-config 12.5.0.alpha.1 → 12.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd54bc8331a2e6d540b5a40c05e99b22d3b0095c
-  data.tar.gz: ccb9d11331515e4a4bbc382948b8029b5c81e08f
+  metadata.gz: 3434a9979123f796c68bcf60049eff88bf93ce83
+  data.tar.gz: b33597d8c90263a4bea0a4358e804be0ff065e32
 SHA512:
-  metadata.gz: f4ed481b18587a5e02f5aa0ed30d0502b79dfafadfc4a7d4b86e48485b40bf191a71b868bbe37f6937dee03c1a528c7956220fbd9ff8f9b19fe82645cfe3fbd5
-  data.tar.gz: 9e980cf78672ae314dc33993ce574f4c5a7f23f4afaaf2484ba7a3e86feaf1240ad3b10b073cb661573b224caa2151693aff4942c8c5b45901cbd13f0dc55650
+  metadata.gz: c5d6bf5b9ad5b89e4001068ab2161d1a99b3f14aa6d35d996f40f4642525067dc3947547bba72efd6f7c45bc40b81e25733fcd8d3c800de9f5b587a2b63351bc
+  data.tar.gz: 8c55a928932d2a60299b39166777ae0f3fc538d069a1083d749c4496f4552d8dff17b0a4a9fc681fbb306c275363e85f12adefc788a0fde54bcf5522aa2b65ba

data/Rakefile

@@ -1,26 +1,8 @@
 require 'rspec/core/rake_task'
-require 'rubygems/package_task'
+require 'chef-config/package_task'
 
-VERSION = IO.read(File.expand_path("../../VERSION", __FILE__)).strip
-
-Dir[File.expand_path("../*gemspec", __FILE__)].reverse.each do |gemspec_path|
-  gemspec = eval(IO.read(gemspec_path))
-  Gem::PackageTask.new(gemspec).define
-end
-
-def with_clean_env(&block)
-  if defined?(Bundler)
-    Bundler.with_clean_env(&block)
-  else
-    block.call
-  end
-end
-
-desc "Build and install a chef-config gem"
-task :install => [:package] do
-  with_clean_env do
-    sh(%{gem install pkg/chef-config-#{ChefConfig::VERSION}.gem --no-rdoc --no-ri}, verbose: true)
-  end
+ChefConfig::PackageTask.new(File.expand_path('..', __FILE__), 'ChefConfig') do |package|
+  package.module_path = 'chef-config'
 end
 
 task :default => :spec
@@ -30,36 +12,3 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = FileList['spec/**/*_spec.rb']
 end
 
-desc "Regenerate lib/chef/version.rb from VERSION file"
-task :version do
-  contents = <<-VERSION_RB
-# Copyright:: Copyright (c) 2010-2015 Chef Software, Inc.
-# License:: Apache License, Version 2.0
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-#!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-# NOTE: This file is generated by running `rake version` in the top level of
-# this repo. Do not edit this manually. Edit the VERSION file and run the rake
-# task instead.
-#!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
-module ChefConfig
-  VERSION = '#{VERSION}'
-end
-
-VERSION_RB
-  version_rb_path = File.expand_path("../lib/chef-config/version.rb", __FILE__)
-  IO.write(version_rb_path, contents)
-end
-

data/lib/chef-config/config.rb

@@ -68,7 +68,7 @@ module ChefConfig
 
     default(:config_dir) do
       if config_file
-        PathHelper.dirname(config_file)
+        PathHelper.dirname(PathHelper.canonical_path(config_file, false))
       else
         PathHelper.join(user_home, ".chef", "")
       end
@@ -128,7 +128,7 @@ module ChefConfig
       if chef_repo_path.kind_of?(String)
         PathHelper.join(chef_repo_path, child_path)
       else
-        chef_repo_path.map { |path| PathHelper.join(path, child_path)}
+        chef_repo_path.uniq.map { |path| PathHelper.join(path, child_path)}
       end
     end
 
@@ -339,10 +339,33 @@ module ChefConfig
     # most of our testing scenarios)
     default :minimal_ohai, false
 
+    ###
+    # Policyfile Settings
+    #
     # Policyfile is a feature where a node gets its run list and cookbook
     # version set from a single document on the server instead of expanding the
     # run list and having the server compute the cookbook version set based on
     # environment constraints.
+    #
+    # Policyfiles are auto-versioned. The user groups nodes by `policy_name`,
+    # which generally describes a hosts's functional role, and `policy_group`,
+    # which generally groups nodes by deployment phase (a.k.a., "environment").
+    # The Chef Server maps a given set of `policy_name` plus `policy_group` to
+    # a particular revision of a policy.
+
+    default :policy_name, nil
+    default :policy_group, nil
+
+    # Policyfiles can have multiple run lists, via the named run list feature.
+    # Generally this will be set by a CLI option via Chef::Application::Client,
+    # but it could be set in client.rb if desired.
+
+    default :named_run_list, nil
+
+    # During initial development, users were required to set `use_policyfile true`
+    # in `client.rb` to opt-in to policyfile use. Chef Client now examines
+    # configuration, node json, and the stored node to determine if policyfile
+    # usage is desired. This flag is still honored if set, but is unnecessary.
     default :use_policyfile, false
 
     # Policyfiles can be used in a native mode (default) or compatibility mode.
@@ -356,6 +379,16 @@ module ChefConfig
     # policyfiles with servers that don't yet support the native endpoints.
     default :policy_document_native_api, true
 
+    # When policyfiles are used in compatibility mode, `policy_name` and
+    # `policy_group` are instead specified using a combined configuration
+    # setting, `deployment_group`. For example, if policy_name should be
+    # "webserver" and policy_group should be "staging", then `deployment_group`
+    # should be set to "webserver-staging", which is the name of the data bag
+    # item that the policy will be stored as. NOTE: this setting only has an
+    # effect if `policy_document_native_api` is set to `false`.
+    default :deployment_group, nil
+
+
     # Set these to enable SSL authentication / mutual-authentication
     # with the server
 
@@ -657,6 +690,14 @@ module ChefConfig
       default :watchdog_timeout, 2 * (60 * 60) # 2 hours
     end
 
+    # Add an empty and non-strict config_context for chefdk. This lets the user
+    # have code like `chefdk.generator_cookbook "/path/to/cookbook"` in their
+    # config.rb, and it will be ignored by tools like knife and ohai. ChefDK
+    # itself can define the config options it accepts and enable strict mode,
+    # and that will only apply when running `chef` commands.
+    config_context :chefdk do
+    end
+
     # Chef requires an English-language UTF-8 locale to function properly.  We attempt
     # to use the 'locale -a' command and search through a list of preferences until we
     # find one that we can use.  On Ubuntu systems we should find 'C.UTF-8' and be

data/lib/chef-config/package_task.rb

@@ -0,0 +1,223 @@
+#
+# Author:: Kartik Null Cating-Subramanian (<ksubramanian@chef.io>)
+# Copyright:: Copyright (c) 2015 Chef, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+require 'rake'
+require 'rubygems'
+require 'rubygems/package_task'
+
+module ChefConfig
+  class PackageTask < Rake::TaskLib
+
+    # Full path to root of top-level repository.  All other files (like VERSION or
+    # lib/<module_path>/version.rb are rooted at this path).
+    attr_accessor :root_path
+
+    # Name of the top-level module/library build built.  This is used to define
+    # the top level module which contains VERSION and MODULE_ROOT.
+    attr_accessor :module_name
+
+    # Should the generated version.rb be in a class or module?  Default is false (module).
+    attr_accessor :generate_version_class
+
+    # Paths to the roots of any components that also support ChefPackageTask.
+    # If relative paths are provided, they are rooted against root_path.
+    attr_accessor :component_paths
+
+    # This is the module name as it appears on the path "lib/module/".
+    # e.g. for module_name  "ChefDK", you'd want module_path to be "chef-dk".
+    # The default is module_name but lower-cased.
+    attr_writer :module_path
+
+    def module_path
+      @module_path || module_name.downcase
+    end
+
+    # Path to a VERSION file with a single string that contains the package version.
+    # By default, this is root_path/VERSION
+    attr_accessor :version_file_path
+
+    # Directory used to store package files and output that is generated.
+    # This has the same meaning (or lack thereof) as package_dir in
+    # rake/packagetask.
+    attr_accessor :package_dir
+
+    # Name of git remote used to push tags during a release.  Default is origin.
+    attr_accessor :git_remote
+
+    def initialize(root_path=nil, module_name=nil)
+      init(root_path, module_name)
+      yield self if block_given?
+      define unless root_path.nil? || module_name.nil?
+    end
+
+    def init(root_path, module_name)
+      @root_path = root_path
+      @module_name = module_name
+      @component_paths = []
+      @module_path = nil
+      @version_file_path = 'VERSION'
+      @package_dir = 'pkg'
+      @git_remote = 'origin'
+      @generate_version_class = false
+    end
+
+    def component_full_paths
+      component_paths.map { |path| File.expand_path(path, root_path)}
+    end
+
+    def version_rb_path
+      File.expand_path("lib/#{module_path}/version.rb", root_path)
+    end
+
+    def version
+      IO.read(File.expand_path(version_file_path, root_path)).strip
+    end
+
+    def full_package_dir
+      File.expand_path(package_dir, root_path)
+    end
+
+    def class_or_module
+      generate_version_class ? 'class' : 'module'
+    end
+
+    def with_clean_env(&block)
+      if defined?(Bundler)
+        Bundler.with_clean_env(&block)
+      else
+        block.call
+      end
+    end
+
+    def define
+      fail 'Need to provide package root and module name' if root_path.nil? || module_name.nil?
+
+      desc 'Build Gems of component dependencies'
+      task :package_components do
+        component_full_paths.each do |component_path|
+          Dir.chdir(component_path) do
+            sh 'rake package'
+          end
+        end
+      end
+
+      task :package => :package_components
+
+      desc 'Build and install component dependencies'
+      task :install_components => :package_components do
+        component_full_paths.each do |component_path|
+          Dir.chdir(component_path) do
+            sh 'rake install'
+          end
+        end
+      end
+
+      task :install => :install_components
+
+      desc 'Clean up builds of component dependencies'
+      task :clobber_component_packages do
+        component_full_paths.each do |component_path|
+          Dir.chdir(component_path) do
+            sh 'rake clobber_package'
+          end
+        end
+      end
+
+      task :clobber_package => :clobber_component_packages
+
+      desc 'Update the version number for component dependencies'
+      task :update_components_versions do
+        component_full_paths.each do |component_path|
+          Dir.chdir(component_path) do
+            sh 'rake version'
+          end
+        end
+      end
+
+      desc 'Regenerate lib/#{@module_path}/version.rb from VERSION file'
+      task :version => :update_components_versions do
+        contents = <<-VERSION_RB
+# Copyright:: Copyright (c) 2010-2015 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+#!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+# NOTE: This file is generated by running `rake version` in the top level of
+# this repo. Do not edit this manually. Edit the VERSION file and run the rake
+# task instead.
+#!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+#{class_or_module} #{module_name}
+  #{module_name.upcase}_ROOT = File.dirname(File.expand_path(File.dirname(__FILE__)))
+  VERSION = '#{version}'
+end
+
+#
+# NOTE: the Chef::Version class is defined in version_class.rb
+#
+# NOTE: DO NOT Use the Chef::Version class on #{module_name}::VERSIONs.  The
+#       Chef::Version class is for _cookbooks_ only, and cannot handle
+#       pre-release versions like "10.14.0.rc.2".  Please use Rubygem's
+#       Gem::Version class instead.
+#
+        VERSION_RB
+        IO.write(version_rb_path, contents)
+      end
+
+      Dir[File.expand_path("*gemspec", root_path)].reverse.each do |gemspec_path|
+        gemspec = eval(IO.read(gemspec_path))
+        Gem::PackageTask.new(gemspec) do |task|
+          task.package_dir = full_package_dir
+        end
+      end
+
+      desc "Build and install a #{module_path} gem"
+      task :install => [:package] do
+        with_clean_env do
+          full_module_path = File.join(full_package_dir, module_path)
+          sh %{gem install #{full_module_path}-#{version}.gem --no-rdoc --no-ri}
+        end
+      end
+
+      task :uninstall do
+        sh %{gem uninstall #{module_path} -x -v #{version} }
+      end
+
+      desc 'Build it, tag it and ship it'
+      task :ship => [:clobber_package, :gem] do
+        sh("git tag #{version}")
+        sh("git push #{git_remote} --tags")
+        Dir[File.expand_path('*.gem', full_package_dir)].reverse.each do |built_gem|
+          sh("gem push #{built_gem}")
+        end
+      end
+    end
+  end
+
+end

data/lib/chef-config/path_helper.rb

@@ -228,6 +228,37 @@ module ChefConfig
         joined_paths
       end
     end
+
+    # Determine if the given path is protected by OS X System Integrity Protection.
+    def self.is_sip_path?(path, node)
+      if node['platform'] == 'mac_os_x' and Gem::Version.new(node['platform_version']) >= Gem::Version.new('10.11')
+          # todo: parse rootless.conf for this?
+          sip_paths= [
+            '/System', '/bin', '/sbin', '/usr',
+          ]
+          sip_paths.each do |sip_path|
+            ChefConfig.logger.info("This is a SIP path, checking if it in exceptions list.")
+            return true if path.start_with?(sip_path)
+          end
+          false
+      else
+        false
+      end
+    end
+    # Determine if the given path is on the exception list for OS X System Integrity Protection.
+    def self.writable_sip_path?(path)
+      # todo: parse rootless.conf for this?
+      sip_exceptions = [
+        '/System/Library/Caches', '/System/Library/Extensions',
+        '/System/Library/Speech', '/System/Library/User Template',
+        '/usr/libexec/cups', '/usr/local', '/usr/share/man'
+      ]
+      sip_exceptions.each do |exception_path|
+        return true if path.start_with?(exception_path)
+      end
+      ChefConfig.logger.error("Cannot write to a SIP Path on OS X 10.11+")
+      false
+    end
   end
 end
 

data/lib/chef-config/version.rb

@@ -20,6 +20,15 @@
 #!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
 
 module ChefConfig
-  VERSION = '12.5.0.alpha.1'
+  CHEFCONFIG_ROOT = File.dirname(File.expand_path(File.dirname(__FILE__)))
+  VERSION = '12.5.1'
 end
 
+#
+# NOTE: the Chef::Version class is defined in version_class.rb
+#
+# NOTE: DO NOT Use the Chef::Version class on ChefConfig::VERSIONs.  The
+#       Chef::Version class is for _cookbooks_ only, and cannot handle
+#       pre-release versions like "10.14.0.rc.2".  Please use Rubygem's
+#       Gem::Version class instead.
+#

data/spec/unit/config_spec.rb

@@ -301,14 +301,36 @@ RSpec.describe ChefConfig::Config do
 
         describe "setting the config dir" do
 
+          context "when the config file is given with a relative path" do
+
+            before do
+              ChefConfig::Config.config_file = "client.rb"
+            end
+
+            it "expands the path when determining config_dir" do
+              # config_dir goes through PathHelper.canonical_path, which
+              # downcases on windows because the FS is case insensitive, so we
+              # have to downcase expected and actual to make the tests work.
+              expect(ChefConfig::Config.config_dir.downcase).to eq(to_platform(Dir.pwd).downcase)
+            end
+
+            it "does not set derived paths at FS root" do
+              ChefConfig::Config.local_mode = true
+              expect(ChefConfig::Config.cache_path.downcase).to eq(to_platform(File.join(Dir.pwd, 'local-mode-cache')).downcase)
+            end
+
+          end
+
           context "when the config file is /etc/chef/client.rb" do
 
             before do
-              ChefConfig::Config.config_file = to_platform("/etc/chef/client.rb")
+              config_location = to_platform("/etc/chef/client.rb").downcase
+              allow(File).to receive(:absolute_path).with(config_location).and_return(config_location)
+              ChefConfig::Config.config_file = config_location
             end
 
             it "config_dir is /etc/chef" do
-              expect(ChefConfig::Config.config_dir).to eq(to_platform("/etc/chef"))
+              expect(ChefConfig::Config.config_dir).to eq(to_platform("/etc/chef").downcase)
             end
 
             context "and chef is running in local mode" do
@@ -317,7 +339,7 @@ RSpec.describe ChefConfig::Config do
               end
 
               it "config_dir is /etc/chef" do
-                expect(ChefConfig::Config.config_dir).to eq(to_platform("/etc/chef"))
+                expect(ChefConfig::Config.config_dir).to eq(to_platform("/etc/chef").downcase)
               end
             end
 
@@ -539,6 +561,14 @@ RSpec.describe ChefConfig::Config do
     end
   end
 
+  describe "allowing chefdk configuration outside of chefdk" do
+
+    it "allows arbitrary settings in the chefdk config context" do
+      expect { ChefConfig::Config.chefdk.generator_cookbook("/path") }.to_not raise_error
+    end
+
+  end
+
   describe "Treating deprecation warnings as errors" do
 
     context "when using our default RSpec configuration" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chef-config
 version: !ruby/object:Gem::Version
-  version: 12.5.0.alpha.1
+  version: 12.5.1
 platform: ruby
 authors:
 - Adam Jacob
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-23 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mixlib-shellout
@@ -108,6 +108,7 @@ files:
 - lib/chef-config/config.rb
 - lib/chef-config/exceptions.rb
 - lib/chef-config/logger.rb
+- lib/chef-config/package_task.rb
 - lib/chef-config/path_helper.rb
 - lib/chef-config/version.rb
 - lib/chef-config/windows.rb
@@ -131,12 +132,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Chef's default configuration and config loading