chef-dk 3.9.0 → 3.10.1

data/lib/chef-dk/command/generator_commands/build_cookbook.rb

@@ -1,125 +1,125 @@
-#
-# Copyright:: Copyright (c) 2016 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/command/generator_commands/base"
-
-module ChefDK
-  module Command
-    module GeneratorCommands
-
-      class BuildCookbook < Base
-
-        banner "Usage: chef generate build-cookbook NAME [options]"
-
-        attr_reader :errors
-
-        attr_reader :cookbook_name_or_path
-
-        option :pipeline,
-          long: "--pipeline PIPELINE",
-          description: "Use PIPELINE to set target branch to something other than master for the build_cookbook",
-          default: "master"
-
-        options.merge!(SharedGeneratorOptions.options)
-
-        def initialize(params)
-          @params_valid = true
-          @cookbook_name = nil
-          super
-        end
-
-        def run
-          read_and_validate_params
-          if params_valid?
-            setup_context
-            chef_runner.converge
-            0
-          else
-            err(opt_parser)
-            1
-          end
-        rescue ChefDK::ChefRunnerError => e
-          err("ERROR: #{e}")
-          1
-        end
-
-        def setup_context
-          super
-          Generator.add_attr_to_context(:delivery_project_dir, delivery_project_dir)
-
-          Generator.add_attr_to_context(:delivery_project_git_initialized, delivery_project_git_initialized?)
-          Generator.add_attr_to_context(:build_cookbook_parent_is_cookbook, build_cookbook_parent_is_cookbook?)
-
-          Generator.add_attr_to_context(:pipeline, pipeline)
-        end
-
-        def pipeline
-          config[:pipeline]
-        end
-
-        def recipe
-          "build_cookbook"
-        end
-
-        def build_cookbook_parent_is_cookbook?
-          metadata_json_path = File.join(delivery_project_dir, "metadata.json")
-          metadata_rb_path = File.join(delivery_project_dir, "metadata.rb")
-
-          File.exist?(metadata_json_path) || File.exist?(metadata_rb_path)
-        end
-
-        def delivery_project_dir
-          project_dir = File.expand_path(cookbook_name_or_path, Dir.pwd)
-          # Detect if we were invoked with arguments like
-          #
-          #     chef generate build-cookbook project/.delivery/build_cookbook
-          #
-          # If so, normalize paths so we don't make a directory structure like
-          # `.delivery/.delivery/build_cookbook`.
-          #
-          # Note that we don't check the name of the build cookbook the user
-          # asked for and we hard-code to naming it "build_cookbook". We also
-          # don't catch the case that the user requested something like
-          # `project/.delivery/build_cookbook/extra-thing-that-shouldn't-be-here`
-          Pathname.new(project_dir).ascend do |dir|
-            if File.basename(dir) == ".delivery"
-              project_dir = File.dirname(dir)
-            end
-          end
-          project_dir
-        end
-
-        def delivery_project_git_initialized?
-          File.exist?(File.join(delivery_project_dir, ".git"))
-        end
-
-        def read_and_validate_params
-          arguments = parse_options(params)
-          @cookbook_name_or_path = arguments[0]
-          unless @cookbook_name_or_path
-            @params_valid = false
-          end
-        end
-
-        def params_valid?
-          @params_valid
-        end
-
-      end
-    end
-  end
-end
+#
+# Copyright:: Copyright (c) 2016 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/command/generator_commands/base"
+
+module ChefDK
+  module Command
+    module GeneratorCommands
+
+      class BuildCookbook < Base
+
+        banner "Usage: chef generate build-cookbook NAME [options]"
+
+        attr_reader :errors
+
+        attr_reader :cookbook_name_or_path
+
+        option :pipeline,
+          long: "--pipeline PIPELINE",
+          description: "Use PIPELINE to set target branch to something other than master for the build_cookbook",
+          default: "master"
+
+        options.merge!(SharedGeneratorOptions.options)
+
+        def initialize(params)
+          @params_valid = true
+          @cookbook_name = nil
+          super
+        end
+
+        def run
+          read_and_validate_params
+          if params_valid?
+            setup_context
+            chef_runner.converge
+            0
+          else
+            err(opt_parser)
+            1
+          end
+        rescue ChefDK::ChefRunnerError => e
+          err("ERROR: #{e}")
+          1
+        end
+
+        def setup_context
+          super
+          Generator.add_attr_to_context(:delivery_project_dir, delivery_project_dir)
+
+          Generator.add_attr_to_context(:delivery_project_git_initialized, delivery_project_git_initialized?)
+          Generator.add_attr_to_context(:build_cookbook_parent_is_cookbook, build_cookbook_parent_is_cookbook?)
+
+          Generator.add_attr_to_context(:pipeline, pipeline)
+        end
+
+        def pipeline
+          config[:pipeline]
+        end
+
+        def recipe
+          "build_cookbook"
+        end
+
+        def build_cookbook_parent_is_cookbook?
+          metadata_json_path = File.join(delivery_project_dir, "metadata.json")
+          metadata_rb_path = File.join(delivery_project_dir, "metadata.rb")
+
+          File.exist?(metadata_json_path) || File.exist?(metadata_rb_path)
+        end
+
+        def delivery_project_dir
+          project_dir = File.expand_path(cookbook_name_or_path, Dir.pwd)
+          # Detect if we were invoked with arguments like
+          #
+          #     chef generate build-cookbook project/.delivery/build_cookbook
+          #
+          # If so, normalize paths so we don't make a directory structure like
+          # `.delivery/.delivery/build_cookbook`.
+          #
+          # Note that we don't check the name of the build cookbook the user
+          # asked for and we hard-code to naming it "build_cookbook". We also
+          # don't catch the case that the user requested something like
+          # `project/.delivery/build_cookbook/extra-thing-that-shouldn't-be-here`
+          Pathname.new(project_dir).ascend do |dir|
+            if File.basename(dir) == ".delivery"
+              project_dir = File.dirname(dir)
+            end
+          end
+          project_dir
+        end
+
+        def delivery_project_git_initialized?
+          File.exist?(File.join(delivery_project_dir, ".git"))
+        end
+
+        def read_and_validate_params
+          arguments = parse_options(params)
+          @cookbook_name_or_path = arguments[0]
+          unless @cookbook_name_or_path
+            @params_valid = false
+          end
+        end
+
+        def params_valid?
+          @params_valid
+        end
+
+      end
+    end
+  end
+end

data/lib/chef-dk/command/generator_commands/chef_exts/generator_desc_resource.rb

@@ -1,85 +1,85 @@
-#
-# Copyright:: Copyright (c) 2016 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/resource"
-require "chef/provider"
-
-module ChefDK
-  module ChefResource
-
-    # GeneratorDesc is similar to Chef's built-in log resource, but instead of
-    # sending output through the logger, it sends output through the output
-    # formatter, which avoids the extra formatting that the logger would add.
-    #
-    # As the name implies, it is used to describe the steps that the generator
-    # takes to create a cookbook.
-    class GeneratorDesc < Chef::Resource
-
-      resource_name(:generator_desc)
-
-      identity_attr(:message)
-
-      default_action(:write)
-
-      def initialize(name, run_context = nil)
-        super
-        @message = name
-      end
-
-      def message(arg = nil)
-        set_or_return(
-          :message,
-          arg,
-          kind_of: String
-        )
-      end
-
-    end
-  end
-
-  module ChefProvider
-
-    # Chef log provider, allows logging to chef's logs from recipes
-    class GeneratorDesc < Chef::Provider
-
-      provides :generator_desc
-
-      def whyrun_supported?
-        true
-      end
-
-      # No concept of a 'current' resource for logs, this is a no-op
-      #
-      # === Return
-      # true:: Always return true
-      def load_current_resource
-        true
-      end
-
-      # Write the log to Chef's log
-      #
-      # === Return
-      # true:: Always return true
-      def action_write
-        run_context.events.subscribers.first.puts_line("- #{new_resource.message}")
-        new_resource.updated_by_last_action(true)
-      end
-
-    end
-
-  end
-end
+#
+# Copyright:: Copyright (c) 2016 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/resource"
+require "chef/provider"
+
+module ChefDK
+  module ChefResource
+
+    # GeneratorDesc is similar to Chef's built-in log resource, but instead of
+    # sending output through the logger, it sends output through the output
+    # formatter, which avoids the extra formatting that the logger would add.
+    #
+    # As the name implies, it is used to describe the steps that the generator
+    # takes to create a cookbook.
+    class GeneratorDesc < Chef::Resource
+
+      resource_name(:generator_desc)
+
+      identity_attr(:message)
+
+      default_action(:write)
+
+      def initialize(name, run_context = nil)
+        super
+        @message = name
+      end
+
+      def message(arg = nil)
+        set_or_return(
+          :message,
+          arg,
+          kind_of: String
+        )
+      end
+
+    end
+  end
+
+  module ChefProvider
+
+    # Chef log provider, allows logging to chef's logs from recipes
+    class GeneratorDesc < Chef::Provider
+
+      provides :generator_desc
+
+      def whyrun_supported?
+        true
+      end
+
+      # No concept of a 'current' resource for logs, this is a no-op
+      #
+      # === Return
+      # true:: Always return true
+      def load_current_resource
+        true
+      end
+
+      # Write the log to Chef's log
+      #
+      # === Return
+      # true:: Always return true
+      def action_write
+        run_context.events.subscribers.first.puts_line("- #{new_resource.message}")
+        new_resource.updated_by_last_action(true)
+      end
+
+    end
+
+  end
+end

data/lib/chef-dk/command/generator_commands/chef_exts/quieter_doc_formatter.rb

@@ -1,38 +1,38 @@
-#
-# Copyright:: Copyright (c) 2016 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/formatters/doc"
-
-module ChefDK
-
-  # Subclass of Chef's standard 'doc' formatter that mutes messages that occur
-  # prior to convergence. This gives us cleaner output in general, but is
-  # especially noticeable when the standard formatter is disabled by the
-  # generator cookbook.
-  class QuieterDocFormatter < Chef::Formatters::Doc
-
-    cli_name(:chefdk_doc)
-
-    # Called when starting to collect gems from the cookbooks
-    def cookbook_gem_start(gems)
-    end
-
-    # Called when cookbook loading starts.
-    def library_load_start(file_count)
-    end
-  end
-end
+#
+# Copyright:: Copyright (c) 2016 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/formatters/doc"
+
+module ChefDK
+
+  # Subclass of Chef's standard 'doc' formatter that mutes messages that occur
+  # prior to convergence. This gives us cleaner output in general, but is
+  # especially noticeable when the standard formatter is disabled by the
+  # generator cookbook.
+  class QuieterDocFormatter < Chef::Formatters::Doc
+
+    cli_name(:chefdk_doc)
+
+    # Called when starting to collect gems from the cookbooks
+    def cookbook_gem_start(gems)
+    end
+
+    # Called when cookbook loading starts.
+    def library_load_start(file_count)
+    end
+  end
+end