chef-dk 0.15.16 → 0.16.28

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

@@ -1,37 +1,37 @@
-#
-# 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/command/generator_commands/cookbook_code_file'
-
-module ChefDK
-  module Command
-    module GeneratorCommands
-      # chef generate attribute [path/to/cookbook_root] NAME
-      class Attribute < CookbookCodeFile
-
-        banner "Usage: chef generate attribute [path/to/cookbook] NAME [options]"
-
-        options.merge!(SharedGeneratorOptions.options)
-
-        def recipe
-          'attribute'
-        end
-      end
-    end
-  end
-end
-
+#
+# 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/command/generator_commands/cookbook_code_file'
+
+module ChefDK
+  module Command
+    module GeneratorCommands
+      # chef generate attribute [path/to/cookbook_root] NAME
+      class Attribute < CookbookCodeFile
+
+        banner "Usage: chef generate attribute [path/to/cookbook] NAME [options]"
+
+        options.merge!(SharedGeneratorOptions.options)
+
+        def recipe
+          'attribute'
+        end
+      end
+    end
+  end
+end
+

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

@@ -18,6 +18,9 @@
 require 'chef-dk/configurable'
 require 'chef-dk/command/generator_commands'
 
+require 'chef-dk/command/generator_commands/chef_exts/recipe_dsl_ext'
+require 'chef-dk/command/generator_commands/chef_exts/generator_desc_resource'
+
 module ChefDK
   module Command
     module GeneratorCommands

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

@@ -75,15 +75,15 @@ module ChefDK
           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
+          #     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`.
+          # `.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
+          # 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`
+          # `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)

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

@@ -0,0 +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

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

@@ -0,0 +1,39 @@
+#
+# 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
+

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

@@ -0,0 +1,40 @@
+#
+# 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/dsl/recipe'
+
+module ChefDK
+
+  # Methods here are mixed in to the Chef recipe DSL to provide extra
+  # functionality for generator cookbooks.
+  module RecipeDSLExt
+
+    # Replaces the current formatter (by default this is the `doc` formatter)
+    # with the null formatter, thus suppressing normal Chef output.
+    def silence_chef_formatter
+      old = run_context.events.subscribers.first
+      out, err = old.output.out, old.output.err
+      run_context.events.subscribers.clear
+      null_formatter = Chef::Formatters.new(:null, out, err)
+      run_context.events.register(null_formatter)
+    end
+
+  end
+end
+
+Chef::DSL::Recipe.send(:include, ChefDK::RecipeDSLExt)
+

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

@@ -52,10 +52,16 @@ module ChefDK
         option :delivery,
           short:        "-d",
           long:         "--delivery",
-          description:  "Generate cookbook with delivery integration",
+          description:  "This option has no effect and exists only for compatibility with past releases",
           boolean:      true,
-          default:      nil
+          default:      true
 
+        option :verbose,
+          short:        "-V",
+          long:         "--verbose",
+          description:  "Show detailed output from the generator",
+          boolean:      true,
+          default:      false
 
         options.merge!(SharedGeneratorOptions.options)
 
@@ -63,7 +69,8 @@ module ChefDK
           @params_valid = true
           @cookbook_name = nil
           @berks_mode = true
-          @enable_delivery = false
+          @enable_delivery = true
+          @verbose = false
           super
         end
 
@@ -71,9 +78,10 @@ module ChefDK
           read_and_validate_params
           if params_valid?
             setup_context
+            msg("Generating cookbook #{cookbook_name}")
             chef_runner.converge
             msg("")
-            msg("Your cookbook is ready. Type `cd #{cookbook_name_or_path}` to start working.")
+            emit_post_create_message
             0
           else
             err(opt_parser)
@@ -84,6 +92,20 @@ module ChefDK
           1
         end
 
+        def emit_post_create_message
+          if have_delivery_config?
+            msg("Your cookbook is ready. To setup the pipeline, type `cd #{cookbook_name_or_path}`, then run `delivery init`")
+          else
+            msg("Your cookbook is ready. Type `cd #{cookbook_name_or_path}` to enter it.")
+            msg("\nThere are several commands you can run to get started locally developing and testing your cookbook.")
+            msg("Type `delivery local --help` to see a full list.")
+            msg("\nWhy not start by writing a test? Tests for the default recipe are stored at:\n")
+            msg("test/recipes/default_test.rb")
+            msg("\nIf you'd prefer to dive right in, the default recipe can be found at:")
+            msg("\nrecipes/default.rb\n")
+          end
+        end
+
         def setup_context
           super
           Generator.add_attr_to_context(:skip_git_init, cookbook_path_in_git_repo?)
@@ -100,6 +122,8 @@ module ChefDK
           Generator.add_attr_to_context(:build_cookbook_parent_is_cookbook, true)
           Generator.add_attr_to_context(:delivery_project_git_initialized, have_git? && !cookbook_path_in_git_repo?)
 
+          Generator.add_attr_to_context(:verbose, verbose?)
+
           Generator.add_attr_to_context(:use_berkshelf, berks_mode?)
         end
 
@@ -139,10 +163,40 @@ module ChefDK
           @enable_delivery
         end
 
+        def verbose?
+          @verbose
+        end
+
+        def have_delivery_config?
+          # delivery-cli's logic is to look recursively upward for
+          # .delivery/cli.toml starting from pwd:
+          # https://github.com/chef/delivery-cli/blob/22cbef3987ebd0aee98405b7e161a100edc87e49/src/delivery/config/mod.rs#L225-L247
+
+          path_to_check = File.expand_path(Dir.pwd)
+          result = false
+
+          Pathname.new(path_to_check).ascend do |path|
+            if contains_delivery_cli_toml?(path)
+              result = true
+              break
+            end
+          end
+
+          result
+        end
+
+        def contains_delivery_cli_toml?(path)
+          delivery_cli_path = path.join(".delivery/cli.toml")
+          delivery_cli_path.exist?
+        end
+
         def read_and_validate_params
           arguments = parse_options(params)
           @cookbook_name_or_path = arguments[0]
-          unless @cookbook_name_or_path
+          if !@cookbook_name_or_path
+            @params_valid = false
+          elsif /-/ =~ File.basename(@cookbook_name_or_path)
+            err("Hyphens are not allowed in cookbook names. Please specify a cookbook name without hyphens.")
             @params_valid = false
           end
 
@@ -155,9 +209,11 @@ module ChefDK
             @berks_mode = false
           end
 
-          if config[:delivery]
-            @enable_delivery = true
+          if config[:verbose]
+            @verbose = true
           end
+
+          true
         end
 
         def params_valid?
@@ -174,4 +230,3 @@ module ChefDK
     end
   end
 end
-

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

@@ -1,100 +1,100 @@
-#
-# 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/command/generator_commands/base'
-
-module ChefDK
-  module Command
-    module GeneratorCommands
-      # ## CookbookCodeFile
-      # A base class for generators that add individual files to existing
-      # cookbooks.
-      class CookbookCodeFile < Base
-
-        attr_reader :errors
-        attr_reader :cookbook_path
-        attr_reader :new_file_basename
-
-        options.merge!(SharedGeneratorOptions.options)
-
-        def initialize(params)
-          @params_valid = true
-          @cookbook_full_path = nil
-          @new_file_basename = nil
-          @errors = []
-          @params = params
-          super
-        end
-
-        def run
-          read_and_validate_params
-          if params_valid?
-            setup_context
-            chef_runner.converge
-          else
-            errors.each {|error| err("Error: #{error}") }
-            parse_options(params)
-            msg(opt_parser)
-            1
-          end
-        end
-
-        def setup_context
-          super
-          Generator.add_attr_to_context(:cookbook_root, cookbook_root)
-          Generator.add_attr_to_context(:cookbook_name, cookbook_name)
-          Generator.add_attr_to_context(:new_file_basename, new_file_basename)
-          Generator.add_attr_to_context(:recipe_name, new_file_basename)
-        end
-
-        def cookbook_root
-          File.dirname(cookbook_path)
-        end
-
-        def cookbook_name
-          File.basename(cookbook_path)
-        end
-
-        def read_and_validate_params
-          arguments = parse_options(params)
-          case arguments.size
-          when 1
-            @new_file_basename = arguments[0]
-            @cookbook_path = Dir.pwd
-            validate_cookbook_path
-          when 2
-            @cookbook_path = arguments[0]
-            @new_file_basename = arguments[1]
-          else
-            @params_valid = false
-          end
-        end
-
-        def validate_cookbook_path
-          unless File.directory?(File.join(cookbook_path, "recipes"))
-            @errors << "Directory #{cookbook_path} is not a cookbook"
-            @params_valid = false
-          end
-        end
-
-        def params_valid?
-          @params_valid
-        end
-      end
-    end
-  end
-end
+#
+# 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/command/generator_commands/base'
+
+module ChefDK
+  module Command
+    module GeneratorCommands
+      # ## CookbookCodeFile
+      # A base class for generators that add individual files to existing
+      # cookbooks.
+      class CookbookCodeFile < Base
+
+        attr_reader :errors
+        attr_reader :cookbook_path
+        attr_reader :new_file_basename
+
+        options.merge!(SharedGeneratorOptions.options)
+
+        def initialize(params)
+          @params_valid = true
+          @cookbook_full_path = nil
+          @new_file_basename = nil
+          @errors = []
+          @params = params
+          super
+        end
+
+        def run
+          read_and_validate_params
+          if params_valid?
+            setup_context
+            chef_runner.converge
+          else
+            errors.each {|error| err("Error: #{error}") }
+            parse_options(params)
+            msg(opt_parser)
+            1
+          end
+        end
+
+        def setup_context
+          super
+          Generator.add_attr_to_context(:cookbook_root, cookbook_root)
+          Generator.add_attr_to_context(:cookbook_name, cookbook_name)
+          Generator.add_attr_to_context(:new_file_basename, new_file_basename)
+          Generator.add_attr_to_context(:recipe_name, new_file_basename)
+        end
+
+        def cookbook_root
+          File.dirname(cookbook_path)
+        end
+
+        def cookbook_name
+          File.basename(cookbook_path)
+        end
+
+        def read_and_validate_params
+          arguments = parse_options(params)
+          case arguments.size
+          when 1
+            @new_file_basename = arguments[0]
+            @cookbook_path = Dir.pwd
+            validate_cookbook_path
+          when 2
+            @cookbook_path = arguments[0]
+            @new_file_basename = arguments[1]
+          else
+            @params_valid = false
+          end
+        end
+
+        def validate_cookbook_path
+          unless File.directory?(File.join(cookbook_path, "recipes"))
+            @errors << "Directory #{cookbook_path} is not a cookbook"
+            @params_valid = false
+          end
+        end
+
+        def params_valid?
+          @params_valid
+        end
+      end
+    end
+  end
+end