chef-dk 3.3.23 → 3.4.38

data/lib/chef-dk/component_test.rb

@@ -176,13 +176,13 @@ module ChefDK
 
     def default_command_options
       {
-        :cwd => component_path,
-        :env => {
+        cwd: component_path,
+        env: {
           # Add the embedded/bin to the PATH so that bundle executable can
           # be found while running the tests.
           path_variable_key => omnibus_path,
         },
-        :timeout => 3600,
+        timeout: 3600,
       }
     end
 

data/lib/chef-dk/exceptions.rb

@@ -128,12 +128,12 @@ module ChefDK
     def resolution_message(overlapping_cookbooks)
       example_source       = cookbook_sources.first
       source_key, location = example_source.default_source_args
-      <<-EXAMPLE
-You can set a preferred source to resolve this issue with code like:
+      <<~EXAMPLE
+        You can set a preferred source to resolve this issue with code like:
 
-default_source :#{source_key}, "#{location}" do |s|
-  s.preferred_for "#{overlapping_cookbooks.join('", "')}"
-end
+        default_source :#{source_key}, "#{location}" do |s|
+          s.preferred_for "#{overlapping_cookbooks.join('", "')}"
+        end
       EXAMPLE
     end
 

data/lib/chef-dk/generator.rb

@@ -75,79 +75,79 @@ module ChefDK
         when "all_rights", "none"
           result = "Copyright:: #{year}, #{copyright_holder}, All Rights Reserved."
         when "apachev2"
-          result = <<-EOH
-Copyright:: #{year}, #{copyright_holder}
+          result = <<~EOH
+            Copyright:: #{year}, #{copyright_holder}
 
-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
+            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
+                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.
+            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.
 EOH
         when "mit"
-          result = <<-EOH
-The MIT License (MIT)
-
-Copyright:: #{year}, #{copyright_holder}
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+          result = <<~EOH
+            The MIT License (MIT)
+
+            Copyright:: #{year}, #{copyright_holder}
+
+            Permission is hereby granted, free of charge, to any person obtaining a copy
+            of this software and associated documentation files (the "Software"), to deal
+            in the Software without restriction, including without limitation the rights
+            to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+            copies of the Software, and to permit persons to whom the Software is
+            furnished to do so, subject to the following conditions:
+
+            The above copyright notice and this permission notice shall be included in
+            all copies or substantial portions of the Software.
+
+            THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+            IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+            FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+            AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+            LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+            OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+            THE SOFTWARE.
 EOH
         when "gplv2"
-          result = <<-EOH
-Copyright:: #{year},  #{copyright_holder}
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License along
-with this program; if not, write to the Free Software Foundation, Inc.,
-51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+          result = <<~EOH
+            Copyright:: #{year},  #{copyright_holder}
+
+            This program is free software; you can redistribute it and/or modify
+            it under the terms of the GNU General Public License as published by
+            the Free Software Foundation; either version 2 of the License, or
+            (at your option) any later version.
+
+            This program is distributed in the hope that it will be useful,
+            but WITHOUT ANY WARRANTY; without even the implied warranty of
+            MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+            GNU General Public License for more details.
+
+            You should have received a copy of the GNU General Public License along
+            with this program; if not, write to the Free Software Foundation, Inc.,
+            51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 EOH
         when "gplv3"
-          result = <<-EOH
-Copyright:: #{year},  #{copyright_holder}
+          result = <<~EOH
+            Copyright:: #{year},  #{copyright_holder}
 
-This program is free software: you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation, either version 3 of the License, or
-(at your option) any later version.
+            This program is free software: you can redistribute it and/or modify
+            it under the terms of the GNU General Public License as published by
+            the Free Software Foundation, either version 3 of the License, or
+            (at your option) any later version.
 
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
+            This program is distributed in the hope that it will be useful,
+            but WITHOUT ANY WARRANTY; without even the implied warranty of
+            MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+            GNU General Public License for more details.
 
-You should have received a copy of the GNU General Public License
-along with this program.  If not, see <http://www.gnu.org/licenses/>.
+            You should have received a copy of the GNU General Public License
+            along with this program.  If not, see <http://www.gnu.org/licenses/>.
 EOH
         else
           raise ArgumentError, "Invalid generator.license setting: #{license}.  See available licenses at https://docs.chef.io/ctl_chef.html#chef-generate-cookbook"

data/lib/chef-dk/helpers.rb

@@ -159,7 +159,7 @@ module ChefDK
       File.open(path, mode, &block)
     end
 
-    #@api private
+    # @api private
     # This method resets all the instance variables used. It
     # should only be used for testing
     def reset!

data/lib/chef-dk/policyfile/cookbook_location_specification.rb

@@ -29,7 +29,7 @@ module ChefDK
       # API contract
       include StorageConfigDelegation
 
-      SOURCE_TYPES = [:git, :github, :path, :artifactserver, :chef_server, :chef_server_artifact, :artifactory]
+      SOURCE_TYPES = [:git, :github, :path, :artifactserver, :chef_server, :chef_server_artifact, :artifactory].freeze
 
       #--
       # Required by CookbookOmnifetch API contract

data/lib/chef-dk/policyfile/cookbook_locks.rb

@@ -34,7 +34,7 @@ module ChefDK
     # Base class for CookbookLock implementations
     class CookbookLock
 
-      REQUIRED_LOCK_DATA_KEYS = %w{version identifier dotted_decimal_identifier cache_key source_options}
+      REQUIRED_LOCK_DATA_KEYS = %w{version identifier dotted_decimal_identifier cache_key source_options}.freeze
       REQUIRED_LOCK_DATA_KEYS.each(&:freeze)
       REQUIRED_LOCK_DATA_KEYS.freeze
 

data/lib/chef-dk/policyfile/git_lock_fetcher.rb

@@ -105,15 +105,15 @@ module ChefDK
       def lock_data
         @lock_data ||= fetch_lock_data.tap do |data|
           data["cookbook_locks"].each do |cookbook_name, cookbook_lock|
-            if cookbook_lock["source_options"].has_key?("path")
+            if cookbook_lock["source_options"].key?("path")
               cookbook_lock["source_options"].tap do |opt|
-                opt["git"]      = uri unless opt.has_key?("git")
-                opt["revision"] = revision unless opt.has_key?("revision")
-                opt["branch"]   = branch unless opt.has_key?("branch") || branch.nil?
-                opt["tag"]      = tag unless opt.has_key?("tag") || branch.nil?
-                opt["ref"]      = ref unless opt.has_key?("ref") || ref.nil?
+                opt["git"]      = uri unless opt.key?("git")
+                opt["revision"] = revision unless opt.key?("revision")
+                opt["branch"]   = branch unless opt.key?("branch") || branch.nil?
+                opt["tag"]      = tag unless opt.key?("tag") || branch.nil?
+                opt["ref"]      = ref unless opt.key?("ref") || ref.nil?
 
-                path_keys = %w{path rel}.map { |path_key| path_key if opt.has_key?(path_key) }.compact
+                path_keys = %w{path rel}.map { |path_key| path_key if opt.key?(path_key) }.compact
 
                 path_keys.each do |name|
                   # We can safely grab the entire cookbook when the Policyfile defines a cookbook path of itself (".")

data/lib/chef-dk/policyfile/policyfile_location_specification.rb

@@ -37,7 +37,7 @@ module ChefDK
       attr_reader :chef_config
       attr_reader :ui
 
-      LOCATION_TYPES = [:path, :server, :git]
+      LOCATION_TYPES = [:path, :server, :git].freeze
 
       # Initialize a location spec
       #

data/lib/chef-dk/policyfile/uploader.rb

@@ -53,10 +53,10 @@ module ChefDK
         ui.msg("Uploading policy #{policy_name} (#{short_revision_id}) to policy group #{policy_group}")
 
         if !using_policy_document_native_api?
-          ui.msg(<<-DRAGONS)
-WARN: Uploading policy to policy group #{policy_group} in compatibility mode.
-Cookbooks will be uploaded with very large version numbers, which may be picked
-up by existing nodes.
+          ui.msg(<<~DRAGONS)
+            WARN: Uploading policy to policy group #{policy_group} in compatibility mode.
+            Cookbooks will be uploaded with very large version numbers, which may be picked
+            up by existing nodes.
 DRAGONS
         end
 

data/lib/chef-dk/policyfile_compiler.rb

@@ -390,7 +390,7 @@ module ChefDK
       preferred = default_source.find { |s| s.preferred_source_for?(cookbook_name) }
       if preferred.nil?
         default_source.find do |s|
-          s.universe_graph.has_key?(cookbook_name)
+          s.universe_graph.key?(cookbook_name)
         end
       else
         preferred

data/lib/chef-dk/policyfile_services/export_repo.rb

@@ -228,32 +228,32 @@ module ChefDK
 
       def create_client_rb
         File.open(client_rb_staging_path, "wb+") do |f|
-          f.print( <<-CONFIG )
-### Chef Client Configuration ###
-# The settings in this file will configure chef to apply the exported policy in
-# this directory. To use it, run:
-#
-# chef-client -z
-#
-
-policy_name '#{policy_name}'
-policy_group 'local'
-
-use_policyfile true
-policy_document_native_api true
-
-# In order to use this repo, you need a version of Chef Client and Chef Zero
-# that supports policyfile "native mode" APIs:
-current_version = Gem::Version.new(Chef::VERSION)
-unless Gem::Requirement.new(">= 12.7").satisfied_by?(current_version)
-  puts("!" * 80)
-  puts(<<-MESSAGE)
-This Chef Repo requires features introduced in Chef 12.7, but you are using
-Chef \#{Chef::VERSION}. Please upgrade to Chef 12.7 or later.
-MESSAGE
-  puts("!" * 80)
-  exit!(1)
-end
+          f.print( <<~CONFIG )
+            ### Chef Client Configuration ###
+            # The settings in this file will configure chef to apply the exported policy in
+            # this directory. To use it, run:
+            #
+            # chef-client -z
+            #
+
+            policy_name '#{policy_name}'
+            policy_group 'local'
+
+            use_policyfile true
+            policy_document_native_api true
+
+            # In order to use this repo, you need a version of Chef Client and Chef Zero
+            # that supports policyfile "native mode" APIs:
+            current_version = Gem::Version.new(Chef::VERSION)
+            unless Gem::Requirement.new(">= 12.7").satisfied_by?(current_version)
+              puts("!" * 80)
+              puts(<<-MESSAGE)
+            This Chef Repo requires features introduced in Chef 12.7, but you are using
+            Chef \#{Chef::VERSION}. Please upgrade to Chef 12.7 or later.
+            MESSAGE
+              puts("!" * 80)
+              exit!(1)
+            end
 
 CONFIG
         end
@@ -261,42 +261,42 @@ CONFIG
 
       def create_readme_md
         File.open(readme_staging_path, "wb+") do |f|
-          f.print( <<-README )
-# Exported Chef Repository for Policy '#{policy_name}'
+          f.print( <<~README )
+            # Exported Chef Repository for Policy '#{policy_name}'
 
-Policy revision: #{policyfile_lock.revision_id}
+            Policy revision: #{policyfile_lock.revision_id}
 
-This directory contains all the cookbooks and configuration necessary for Chef
-to converge a system using this exported policy. To converge a system with the
-exported policy, use a privileged account to run `chef-client -z` from the
-directory containing the exported policy.
+            This directory contains all the cookbooks and configuration necessary for Chef
+            to converge a system using this exported policy. To converge a system with the
+            exported policy, use a privileged account to run `chef-client -z` from the
+            directory containing the exported policy.
 
-## Contents:
+            ## Contents:
 
-### Policyfile.lock.json
+            ### Policyfile.lock.json
 
-A copy of the exported policy, used by the `chef push-archive` command.
+            A copy of the exported policy, used by the `chef push-archive` command.
 
-### .chef/config.rb
+            ### .chef/config.rb
 
-A configuration file for Chef Client. This file configures Chef Client to use
-the correct `policy_name` and `policy_group` for this exported repository. Chef
-Client will use this configuration automatically if you've set your working
-directory properly.
+            A configuration file for Chef Client. This file configures Chef Client to use
+            the correct `policy_name` and `policy_group` for this exported repository. Chef
+            Client will use this configuration automatically if you've set your working
+            directory properly.
 
-### cookbook_artifacts/
+            ### cookbook_artifacts/
 
-All of the cookbooks required by the policy will be stored in this directory.
+            All of the cookbooks required by the policy will be stored in this directory.
 
-### policies/
+            ### policies/
 
-A different copy of the exported policy, used by the `chef-client` command.
+            A different copy of the exported policy, used by the `chef-client` command.
 
-### policy_groups/
+            ### policy_groups/
 
-Policy groups are used by Chef Server to manage multiple revisions of the same
-policy. However, exported policies contain only a single policy revision, so
-this policy group name is hardcoded to "local" and should not be changed.
+            Policy groups are used by Chef Server to manage multiple revisions of the same
+            policy. However, exported policies contain only a single policy revision, so
+            this policy group name is hardcoded to "local" and should not be changed.
 
 README
         end

data/lib/chef-dk/policyfile_services/install.rb

@@ -145,9 +145,9 @@ module ChefDK
       end
 
       def prepare_constraints_for_policies
-        Policyfile::LockApplier.
-          new(policyfile_lock, policyfile_compiler).
-          apply!
+        Policyfile::LockApplier
+          .new(policyfile_lock, policyfile_compiler)
+          .apply!
       end
 
       def install_from_lock

data/lib/chef-dk/policyfile_services/push_archive.rb

@@ -86,12 +86,12 @@ module ChefDK
         policyfile_lock_path = File.join(staging_dir, "Policyfile.lock.json")
 
         if looks_like_old_format_archive?(staging_dir)
-          raise InvalidPolicyArchive, <<-MESSAGE
-This archive is in an unsupported format.
+          raise InvalidPolicyArchive, <<~MESSAGE
+            This archive is in an unsupported format.
 
-This archive was created with an older version of ChefDK. This version of
-ChefDK does not support archives in the older format. Re-create the archive
-with a newer version of ChefDK or downgrade ChefDK.
+            This archive was created with an older version of ChefDK. This version of
+            ChefDK does not support archives in the older format. Re-create the archive
+            with a newer version of ChefDK or downgrade ChefDK.
 MESSAGE
         end
 

data/lib/chef-dk/policyfile_services/rm_policy_group.rb

@@ -52,7 +52,7 @@ module ChefDK
         undo_record.description = "delete-policy-group #{policy_group}"
         policy_group_list = http_client.get("/policy_groups")
 
-        unless policy_group_list.has_key?(policy_group)
+        unless policy_group_list.key?(policy_group)
           ui.err("Policy group '#{policy_group}' does not exist on the server")
           return false
         end

data/lib/chef-dk/policyfile_services/update_attributes.rb

@@ -102,8 +102,8 @@ module ChefDK
       end
 
       def prepare_constraints
-        Policyfile::LockApplier.new(policyfile_lock, policyfile_compiler).
-          apply!
+        Policyfile::LockApplier.new(policyfile_lock, policyfile_compiler)
+          .apply!
       end
     end
   end

data/lib/chef-dk/service_exception_inspectors/http.rb

@@ -32,17 +32,17 @@ module ChefDK
       end
 
       def extended_error_info
-        <<-END
---- REQUEST DATA ----
-#{http_method} #{uri}
-#{request_headers}
-#{req_body}
+        <<~END
+          --- REQUEST DATA ----
+          #{http_method} #{uri}
+          #{request_headers}
+          #{req_body}
 
---- RESPONSE DATA ---
-#{code} #{response_message}
-#{response_headers}
+          --- RESPONSE DATA ---
+          #{code} #{response_message}
+          #{response_headers}
 
-#{response_body}
+          #{response_body}
 
 END
       end