chef-dk 2.6.2 → 3.0.36

data/lib/chef-dk/configurable.rb

@@ -1,88 +1,88 @@
-#
-# Copyright:: Copyright (c) 2014 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.
-#
-
-require "chef/config"
-require "chef/workstation_config_loader"
-
-require "chef-dk/cookbook_omnifetch"
-require "chef-dk/chef_server_api_multi"
-
-# Define a config context for ChefDK
-class Chef::Config
-
-  default(:policy_document_native_api, true)
-
-  config_context(:chefdk) do
-
-    # Error when we encounter unknown keys. This makes it clear to the user if
-    # they get the name of the config key wrong (e.g., `chefdk.generator`
-    # instead of `chefdk.generator_cookbook`).
-    config_strict_mode(true)
-
-    default(:generator_cookbook, File.expand_path("../skeletons/code_generator", __FILE__))
-
-    config_context(:generator) do
-      config_strict_mode(true)
-      configurable :copyright_holder
-      configurable :email
-      configurable :license
-    end
-  end
-end
-
-module ChefDK
-  module Configurable
-
-    def chef_config
-      return @chef_config if @chef_config
-      config_loader.load
-      @chef_config = Chef::Config
-      CookbookOmnifetch.integration.default_chef_server_http_client = default_chef_server_http_client
-      @chef_config
-    end
-
-    def chefdk_config
-      chef_config.chefdk
-    end
-
-    def config_loader
-      @config_loader ||= Chef::WorkstationConfigLoader.new(config[:config_file])
-    end
-
-    def generator_config
-      chefdk_config.generator
-    end
-
-    def knife_config
-      chef_config.knife
-    end
-
-    def reset_config!
-      @chef_config = nil
-      @config_loader = nil
-    end
-
-    def default_chef_server_http_client
-      lambda do
-        ChefServerAPIMulti.new(@chef_config.chef_server_url,
-                               signing_key_filename: @chef_config.client_key,
-                               client_name: @chef_config.node_name)
-      end
-    end
-
-  end
-end
+#
+# Copyright:: Copyright (c) 2014-2018 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.
+#
+
+require "chef/config"
+require "chef/workstation_config_loader"
+
+require "chef-dk/cookbook_omnifetch"
+require "chef-dk/chef_server_api_multi"
+
+# Define a config context for ChefDK
+class Chef::Config
+
+  default(:policy_document_native_api, true)
+
+  config_context(:chefdk) do
+
+    # Error when we encounter unknown keys. This makes it clear to the user if
+    # they get the name of the config key wrong (e.g., `chefdk.generator`
+    # instead of `chefdk.generator_cookbook`).
+    config_strict_mode(true)
+
+    default(:generator_cookbook, File.expand_path("../skeletons/code_generator", __FILE__))
+
+    config_context(:generator) do
+      config_strict_mode(true)
+      configurable :copyright_holder
+      configurable :email
+      configurable :license
+    end
+  end
+end
+
+module ChefDK
+  module Configurable
+
+    def chef_config
+      return @chef_config if @chef_config
+      config_loader.load
+      @chef_config = Chef::Config
+      CookbookOmnifetch.integration.default_chef_server_http_client = default_chef_server_http_client
+      @chef_config
+    end
+
+    def chefdk_config
+      chef_config.chefdk
+    end
+
+    def config_loader
+      @config_loader ||= Chef::WorkstationConfigLoader.new(config[:config_file])
+    end
+
+    def generator_config
+      chefdk_config.generator
+    end
+
+    def knife_config
+      chef_config.knife
+    end
+
+    def reset_config!
+      @chef_config = nil
+      @config_loader = nil
+    end
+
+    def default_chef_server_http_client
+      lambda do
+        ChefServerAPIMulti.new(@chef_config.chef_server_url,
+                               signing_key_filename: @chef_config.client_key,
+                               client_name: @chef_config.node_name)
+      end
+    end
+
+  end
+end

data/lib/chef-dk/cookbook_metadata.rb

@@ -1,45 +1,45 @@
-#
-# Copyright:: Copyright (c) 2014 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.
-#
-
-require "chef-dk/exceptions"
-require "chef/cookbook/metadata"
-
-module ChefDK
-
-  # Subclass of Chef's Cookbook::Metadata class that provides the API expected
-  # by CookbookOmnifetch
-  class CookbookMetadata < Chef::Cookbook::Metadata
-
-    def self.from_path(path)
-      metadata_json_path = File.join(path, "metadata.json")
-      metadata_rb_path = File.join(path, "metadata.rb")
-
-      if File.exist?(metadata_json_path)
-        new.tap { |m| m.from_json(File.read(metadata_json_path)) }
-      elsif File.exist?(metadata_rb_path)
-        new.tap { |m| m.from_file(metadata_rb_path) }
-      else
-        raise MalformedCookbook, "Cookbook at #{path} has neither metadata.json or metadata.rb"
-      end
-    end
-
-    def cookbook_name
-      name
-    end
-
-  end
-end
+#
+# Copyright:: Copyright (c) 2014-2018 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.
+#
+
+require "chef-dk/exceptions"
+require "chef/cookbook/metadata"
+
+module ChefDK
+
+  # Subclass of Chef's Cookbook::Metadata class that provides the API expected
+  # by CookbookOmnifetch
+  class CookbookMetadata < Chef::Cookbook::Metadata
+
+    def self.from_path(path)
+      metadata_json_path = File.join(path, "metadata.json")
+      metadata_rb_path = File.join(path, "metadata.rb")
+
+      if File.exist?(metadata_json_path)
+        new.tap { |m| m.from_json(File.read(metadata_json_path)) }
+      elsif File.exist?(metadata_rb_path)
+        new.tap { |m| m.from_file(metadata_rb_path) }
+      else
+        raise MalformedCookbook, "Cookbook at #{path} has neither metadata.json or metadata.rb"
+      end
+    end
+
+    def cookbook_name
+      name
+    end
+
+  end
+end

data/lib/chef-dk/cookbook_omnifetch.rb

@@ -1,32 +1,32 @@
-#
-# Copyright:: Copyright (c) 2014 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.
-#
-
-require "cookbook-omnifetch"
-require "chef-dk/shell_out"
-require "chef-dk/cookbook_metadata"
-require "chef-dk/helpers"
-
-require "chef/http/simple"
-
-# Configure CookbookOmnifetch's dependency injection settings to use our classes and config.
-CookbookOmnifetch.configure do |c|
-  c.cache_path = File.expand_path(File.join(ChefDK::Helpers.chefdk_home, "cache"))
-  c.storage_path = Pathname.new(File.expand_path(File.join(ChefDK::Helpers.chefdk_home, "cache", "cookbooks")))
-  c.shell_out_class = ChefDK::ShellOut
-  c.cached_cookbook_class = ChefDK::CookbookMetadata
-  c.chef_server_download_concurrency = 10
-end
+#
+# Copyright:: Copyright (c) 2014-2018 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.
+#
+
+require "cookbook-omnifetch"
+require "chef-dk/shell_out"
+require "chef-dk/cookbook_metadata"
+require "chef-dk/helpers"
+
+require "chef/http/simple"
+
+# Configure CookbookOmnifetch's dependency injection settings to use our classes and config.
+CookbookOmnifetch.configure do |c|
+  c.cache_path = File.expand_path(File.join(ChefDK::Helpers.chefdk_home, "cache"))
+  c.storage_path = Pathname.new(File.expand_path(File.join(ChefDK::Helpers.chefdk_home, "cache", "cookbooks")))
+  c.shell_out_class = ChefDK::ShellOut
+  c.cached_cookbook_class = ChefDK::CookbookMetadata
+  c.chef_server_download_concurrency = 10
+end

data/lib/chef-dk/cookbook_profiler/git.rb

@@ -1,151 +1,152 @@
-#
-# Copyright:: Copyright (c) 2014 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.
-#
-
-require "chef-dk/helpers"
-
-module ChefDK
-  module CookbookProfiler
-    class Git
-
-      include Helpers
-
-      attr_reader :cookbook_path
-
-      def initialize(cookbook_path)
-        @cookbook_path = cookbook_path
-        @unborn_branch = nil
-        @unborn_branch_ref = nil
-      end
-
-      def profile_data
-        {
-          "scm" => "git",
-          # To get this info, you need to do something like:
-          # figure out branch or assume 'master'
-          # git config --get branch.master.remote
-          # git config --get remote.opscode.url
-          "remote" => remote,
-          "revision" => revision,
-          "working_tree_clean" => clean?,
-          "published" => !unpublished_commits?,
-          "synchronized_remote_branches" => synchronized_remotes,
-        }
-      end
-
-      def revision
-        git!("rev-parse HEAD").stdout.strip
-      rescue Mixlib::ShellOut::ShellCommandFailed => e
-        # We may have an "unborn" branch, i.e. one with no commits.
-        if unborn_branch_ref
-          nil
-        else
-          # if we got here, but verify_ref_cmd didn't error, we don't know why
-          # the original git command failed, so re-raise.
-          raise e
-        end
-      end
-
-      def clean?
-        git!("diff-files --quiet", returns: [0, 1]).exitstatus == 0
-      end
-
-      def unpublished_commits?
-        synchronized_remotes.empty?
-      end
-
-      def synchronized_remotes
-        @synchronized_remotes ||= git!("branch -r --contains #{revision}").stdout.lines.map(&:strip)
-      rescue Mixlib::ShellOut::ShellCommandFailed => e
-        # We may have an "unborn" branch, i.e. one with no commits.
-        if unborn_branch_ref
-          []
-        else
-          # if we got here, but verify_ref_cmd didn't error, we don't know why
-          # the original git command failed, so re-raise.
-          raise e
-        end
-      end
-
-      def remote
-        @remote_url ||=
-          if have_remote?
-            git!("config --get remote.#{remote_name}.url").stdout.strip
-          else
-            nil
-          end
-      end
-
-      def remote_name
-        @remote_name ||= git!("config --get branch.#{current_branch}.remote", returns: [0, 1]).stdout.strip
-      end
-
-      def have_remote?
-        !remote_name.empty? && remote_name != "."
-      end
-
-      def current_branch
-        @current_branch ||= detect_current_branch
-      end
-
-      private
-
-      def git!(subcommand, options = {})
-        cmd = git(subcommand, options)
-        cmd.error!
-        cmd
-      end
-
-      def git(subcommand, options = {})
-        options = { cwd: cookbook_path }.merge(options)
-        system_command("git #{subcommand}", options)
-      end
-
-      def detect_current_branch
-        branch = git!("rev-parse --abbrev-ref HEAD").stdout.strip
-        @unborn_branch = false
-        branch
-      rescue Mixlib::ShellOut::ShellCommandFailed => e
-        # We may have an "unborn" branch, i.e. one with no commits.
-        if unborn_branch_ref
-          unborn_branch_ref
-        else
-          # if we got here, but verify_ref_cmd didn't error, we don't know why
-          # the original git command failed, so re-raise.
-          raise e
-        end
-      end
-
-      def unborn_branch_ref
-        @unborn_branch_ref ||=
-          begin
-            strict_branch_ref = git!("symbolic-ref -q HEAD").stdout.strip
-            verify_ref_cmd = git("show-ref --verify #{strict_branch_ref}")
-            if verify_ref_cmd.error?
-              @unborn_branch = true
-              strict_branch_ref
-            else
-              # if we got here, but verify_ref_cmd didn't error, then `git
-              # rev-parse` is probably failing for a reason we haven't anticipated.
-              # Calling code should detect this and re-raise.
-              nil
-            end
-          end
-      end
-
-    end
-  end
-end
+#
+# Copyright:: Copyright (c) 2014-2018 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.
+#
+
+require "chef-dk/helpers"
+
+module ChefDK
+  module CookbookProfiler
+    class Git
+
+      include Helpers
+
+      attr_reader :cookbook_path
+
+      def initialize(cookbook_path)
+        @cookbook_path = cookbook_path
+        @unborn_branch = nil
+        @unborn_branch_ref = nil
+      end
+
+      # @return [Hash] Hashed used for pinning cookbook versions within a Policfile.lock
+      def profile_data
+        {
+          "scm" => "git",
+          # To get this info, you need to do something like:
+          # figure out branch or assume 'master'
+          # git config --get branch.master.remote
+          # git config --get remote.opscode.url
+          "remote" => remote,
+          "revision" => revision,
+          "working_tree_clean" => clean?,
+          "published" => !unpublished_commits?,
+          "synchronized_remote_branches" => synchronized_remotes,
+        }
+      end
+
+      def revision
+        git!("rev-parse HEAD").stdout.strip
+      rescue Mixlib::ShellOut::ShellCommandFailed => e
+        # We may have an "unborn" branch, i.e. one with no commits.
+        if unborn_branch_ref
+          nil
+        else
+          # if we got here, but verify_ref_cmd didn't error, we don't know why
+          # the original git command failed, so re-raise.
+          raise e
+        end
+      end
+
+      def clean?
+        git!("diff-files --quiet", returns: [0, 1]).exitstatus == 0
+      end
+
+      def unpublished_commits?
+        synchronized_remotes.empty?
+      end
+
+      def synchronized_remotes
+        @synchronized_remotes ||= git!("branch -r --contains #{revision}").stdout.lines.map(&:strip)
+      rescue Mixlib::ShellOut::ShellCommandFailed => e
+        # We may have an "unborn" branch, i.e. one with no commits.
+        if unborn_branch_ref
+          []
+        else
+          # if we got here, but verify_ref_cmd didn't error, we don't know why
+          # the original git command failed, so re-raise.
+          raise e
+        end
+      end
+
+      def remote
+        @remote_url ||=
+          if have_remote?
+            git!("config --get remote.#{remote_name}.url").stdout.strip
+          else
+            nil
+          end
+      end
+
+      def remote_name
+        @remote_name ||= git!("config --get branch.#{current_branch}.remote", returns: [0, 1]).stdout.strip
+      end
+
+      def have_remote?
+        !remote_name.empty? && remote_name != "."
+      end
+
+      def current_branch
+        @current_branch ||= detect_current_branch
+      end
+
+      private
+
+      def git!(subcommand, options = {})
+        cmd = git(subcommand, options)
+        cmd.error!
+        cmd
+      end
+
+      def git(subcommand, options = {})
+        options = { cwd: cookbook_path }.merge(options)
+        system_command("git #{subcommand}", options)
+      end
+
+      def detect_current_branch
+        branch = git!("rev-parse --abbrev-ref HEAD").stdout.strip
+        @unborn_branch = false
+        branch
+      rescue Mixlib::ShellOut::ShellCommandFailed => e
+        # We may have an "unborn" branch, i.e. one with no commits.
+        if unborn_branch_ref
+          unborn_branch_ref
+        else
+          # if we got here, but verify_ref_cmd didn't error, we don't know why
+          # the original git command failed, so re-raise.
+          raise e
+        end
+      end
+
+      def unborn_branch_ref
+        @unborn_branch_ref ||=
+          begin
+            strict_branch_ref = git!("symbolic-ref -q HEAD").stdout.strip
+            verify_ref_cmd = git("show-ref --verify #{strict_branch_ref}")
+            if verify_ref_cmd.error?
+              @unborn_branch = true
+              strict_branch_ref
+            else
+              # if we got here, but verify_ref_cmd didn't error, then `git
+              # rev-parse` is probably failing for a reason we haven't anticipated.
+              # Calling code should detect this and re-raise.
+              nil
+            end
+          end
+      end
+
+    end
+  end
+end