chef-cli 1.0.3

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

@@ -0,0 +1,37 @@
+#
+# Copyright:: Copyright (c) 2014-2019 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_relative "cookbook_code_file"
+require_relative "../../dist"
+
+module ChefCLI
+  module Command
+    module GeneratorCommands
+      # chef generate attribute [path/to/cookbook_root] NAME
+      class Attribute < CookbookCodeFile
+
+        banner "Usage: #{ChefCLI::Dist::EXEC} generate attribute [path/to/cookbook] NAME [options]"
+
+        options.merge!(SharedGeneratorOptions.options)
+
+        def recipe
+          "attribute"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,157 @@
+#
+# 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_relative "../../configurable"
+require_relative "../generator_commands"
+
+require_relative "chef_exts/recipe_dsl_ext"
+require_relative "chef_exts/generator_desc_resource"
+
+module ChefCLI
+  module Command
+    module GeneratorCommands
+      # ## Base
+      #
+      # Base class for `chef generate` subcommands. Contains basic behaviors
+      # for setting up the generator context, detecting git, and launching a
+      # chef converge.
+      #
+      # The behavior of the generators is largely delegated to a chef cookbook.
+      # The default implementation is the `code_generator` cookbook in
+      # chef-cli/skeletons/code_generator.
+      class Base < Command::Base
+
+        include Configurable
+
+        attr_reader :params
+
+        options.merge!(SharedGeneratorOptions.options)
+
+        def initialize(params)
+          super()
+          @params = params
+
+          @generator_cookbook_path = nil
+          @generator_cookbook_name = nil
+        end
+
+        # An instance of ChefRunner. Calling ChefRunner#converge will trigger
+        # convergence and generate the desired code.
+        def chef_runner
+          @chef_runner ||= ChefRunner.new(generator_cookbook_path, ["recipe[#{generator_cookbook_name}::#{recipe}]"])
+        end
+
+        # Path to the directory where the code_generator cookbook is located.
+        def generator_cookbook_path
+          detect_generator_cookbook_name_and_path! unless @generator_cookbook_path
+          @generator_cookbook_path
+        end
+
+        def generator_cookbook_name
+          detect_generator_cookbook_name_and_path! unless @generator_cookbook_name
+          @generator_cookbook_name
+        end
+
+        # Sets git related generator_context values.
+        def setup_context
+          apply_generator_values_from_config
+          Generator.add_attr_to_context(:have_git, have_git?)
+          Generator.add_attr_to_context(:skip_git_init, false)
+          config.each do |k, v|
+            Generator.add_attr_to_context(k, v)
+          end
+          # inject the arbitrary args supplied on cmdline, default = []
+          config[:generator_arg].each do |k, v|
+            Generator.add_attr_to_context(k, v)
+          end
+        end
+
+        # Checks the `PATH` for the presence of a `git` (or `git.exe`, on
+        # windows) executable.
+        def have_git?
+          path = ENV["PATH"] || ""
+          paths = path.split(File::PATH_SEPARATOR)
+          exts = [RbConfig::CONFIG["EXEEXT"]]
+          exts.concat(ENV["PATHEXT"].split(";")) unless ENV["PATHEXT"].nil?
+          paths.any? do |bin_path|
+            exts.any? do |ext|
+              File.exist?(File.join(bin_path, "git#{ext}"))
+            end
+          end
+        end
+
+        private
+
+        # Inspects the `config[:generator_cookbook]` option to determine the
+        # generator_cookbook_name and generator_cookbook_path. There are two
+        # supported ways this can work:
+        #
+        # * `config[:generator_cookbook]` is the full path to the generator
+        # cookbook. In this case, the last path component is the cookbook name,
+        # and the parent directory is the cookbook path
+        # * `config[:generator_cookbook]` is the path to a directory that
+        # contains a cookbook named "code_generator" (DEPRECATED). This is how
+        # the `--generator-cookbook` feature was originally written, so we
+        # support this for backwards compatibility. This way has poor UX and
+        # we'd like to get rid of it, so a warning is printed in this case.
+        def detect_generator_cookbook_name_and_path!
+          given_path = generator_cookbook_option
+          code_generator_subdir = File.join(given_path, "code_generator")
+          if File.directory?(code_generator_subdir)
+            @generator_cookbook_name = "code_generator"
+            @generator_cookbook_path = given_path
+            err("WARN: Please configure the generator cookbook by giving the full path to the desired cookbook (like '#{code_generator_subdir}')")
+          else
+            @generator_cookbook_name = File.basename(given_path)
+            @generator_cookbook_path = File.dirname(given_path)
+          end
+        end
+
+        def generator_cookbook_option
+          config[:generator_cookbook] || chefcli_config.generator_cookbook
+        end
+
+        # Load any values that were not defined via cli switches from Chef
+        # configuration
+        #
+        def apply_generator_values_from_config
+          config[:copyright_holder] ||= coerce_generator_copyright_holder
+          config[:email] ||= coerce_generator_email
+          config[:license] ||= coerce_generator_license
+        end
+
+        def coerce_generator_copyright_holder
+          generator_config.copyright_holder ||
+            knife_config.cookbook_copyright ||
+            "The Authors"
+        end
+
+        def coerce_generator_email
+          generator_config.email ||
+            knife_config.cookbook_email ||
+            "you@example.com"
+        end
+
+        def coerce_generator_license
+          generator_config.license ||
+            knife_config.cookbook_license ||
+            "all_rights"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,126 @@
+#
+# Copyright:: Copyright (c) 2016-2019 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_relative "base"
+require_relative "../../dist"
+
+module ChefCLI
+  module Command
+    module GeneratorCommands
+
+      class BuildCookbook < Base
+
+        banner "Usage: #{ChefCLI::Dist::EXEC} 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 ChefCLI::ChefRunnerError => e
+          err("ERROR: #{e}")
+          1
+        end
+
+        def setup_context
+          super
+          Generator.add_attr_to_context(:workflow_project_dir, workflow_project_dir)
+
+          Generator.add_attr_to_context(:workflow_project_git_initialized, workflow_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(workflow_project_dir, "metadata.json")
+          metadata_rb_path = File.join(workflow_project_dir, "metadata.rb")
+
+          File.exist?(metadata_json_path) || File.exist?(metadata_rb_path)
+        end
+
+        def workflow_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 workflow_project_git_initialized?
+          File.exist?(File.join(workflow_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-cli/command/generator_commands/chef_exts/generator_desc_resource.rb

@@ -0,0 +1,40 @@
+#
+# Copyright:: Copyright (c) 2016-2019 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"
+
+module ChefCLI
+  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
+
+      property :message, String, name_property: true
+
+      # Write the log to Chef's log
+      action :write do
+        run_context.events.subscribers.first.puts_line("- #{new_resource.message}")
+      end
+    end
+  end
+end

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

@@ -0,0 +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 ChefCLI
+
+  # 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(:chefcli_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-cli/command/generator_commands/chef_exts/recipe_dsl_ext.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/dsl/recipe"
+
+module ChefCLI
+
+  # 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, ChefCLI::RecipeDSLExt)

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

@@ -0,0 +1,251 @@
+#
+# Copyright:: Copyright (c) 2014-2019 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_relative "base"
+require_relative "../../dist"
+
+module ChefCLI
+  module Command
+    module GeneratorCommands
+
+      # ## CookbookFile
+      # chef generate cookbook path/to/basename --generator-cookbook=path/to/generator
+      #
+      # Generates a basic cookbook directory structure. Most file types are
+      # omitted, the user is expected to add additional files as needed using
+      # the relevant generators.
+      class Cookbook < Base
+
+        banner "Usage: #{ChefCLI::Dist::EXEC} generate cookbook NAME [options]"
+
+        attr_reader :errors
+
+        attr_reader :cookbook_name_or_path
+
+        option :berks,
+          short:       "-b",
+          long:        "--berks",
+          description: "Generate cookbooks using Berkshelf dependency resolution.",
+          boolean:     true,
+          default:     nil
+
+        option :kitchen,
+          long:        "--kitchen CONFIGURATION",
+          description: "Generate cookbooks with a specific Test Kitchen configuration (dokken|vagrant) - defaults to vagrant",
+          default:     "vagrant"
+
+        option :policy,
+          short:        "-P",
+          long:         "--policy",
+          description:  "Generate a cookbook using Policyfile dependency resolution (default).",
+          boolean:      true,
+          default:      nil
+
+        option :workflow,
+          short:        "-w",
+          long:         "--workflow",
+          description:  "Generate a cookbook with a full #{ChefCLI::Dist::WORKFLOW} build cookbook.",
+          boolean:      true,
+          default:      false
+
+        option :verbose,
+          short:        "-V",
+          long:         "--verbose",
+          description:  "Show detailed output from the generator",
+          boolean:      true,
+          default:      false
+
+        option :pipeline,
+          long:         "--pipeline PIPELINE",
+          description:  "Use PIPELINE to set target branch to something other than master for the #{ChefCLI::Dist::WORKFLOW} build_cookbook",
+          default:      "master"
+
+        options.merge!(SharedGeneratorOptions.options)
+
+        def initialize(params)
+          @params_valid = true
+          @cookbook_name = nil
+          @policy_mode = true
+          @verbose = false
+          super
+        end
+
+        def run
+          read_and_validate_params
+          if params_valid?
+            setup_context
+            msg("Generating cookbook #{cookbook_name}")
+            chef_runner.converge
+            msg("")
+            emit_post_create_message
+            0
+          else
+            err(opt_parser)
+            1
+          end
+        rescue ChefCLI::ChefRunnerError => e
+          err("ERROR: #{e}")
+          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 of local testing commands.")
+            msg("\nWhy not start by writing an InSpec test? Tests for the default recipe are stored at:\n")
+            msg("test/integration/default/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?)
+          Generator.add_attr_to_context(:cookbook_root, cookbook_root)
+          Generator.add_attr_to_context(:cookbook_name, cookbook_name)
+          Generator.add_attr_to_context(:recipe_name, recipe_name)
+          Generator.add_attr_to_context(:include_chef_repo_source, false)
+          Generator.add_attr_to_context(:policy_name, policy_name)
+          Generator.add_attr_to_context(:policy_run_list, policy_run_list)
+          Generator.add_attr_to_context(:policy_local_cookbook, ".")
+
+          Generator.add_attr_to_context(:enable_workflow, enable_workflow?)
+          Generator.add_attr_to_context(:workflow_project_dir, cookbook_full_path)
+          Generator.add_attr_to_context(:build_cookbook_parent_is_cookbook, true)
+          Generator.add_attr_to_context(:workflow_project_git_initialized, have_git? && !cookbook_path_in_git_repo?)
+
+          Generator.add_attr_to_context(:verbose, verbose?)
+
+          Generator.add_attr_to_context(:use_policyfile, policy_mode?)
+          Generator.add_attr_to_context(:pipeline, pipeline)
+          Generator.add_attr_to_context(:kitchen, kitchen)
+        end
+
+        def kitchen
+          config[:kitchen]
+        end
+
+        def pipeline
+          config[:pipeline]
+        end
+
+        def policy_name
+          cookbook_name
+        end
+
+        def policy_run_list
+          "#{cookbook_name}::#{recipe_name}"
+        end
+
+        def recipe
+          "cookbook"
+        end
+
+        def recipe_name
+          "default"
+        end
+
+        def cookbook_name
+          File.basename(cookbook_full_path)
+        end
+
+        def cookbook_root
+          File.dirname(cookbook_full_path)
+        end
+
+        def cookbook_full_path
+          File.expand_path(cookbook_name_or_path, Dir.pwd)
+        end
+
+        def policy_mode?
+          @policy_mode
+        end
+
+        def enable_workflow?
+          config[:workflow]
+        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]
+          if !@cookbook_name_or_path
+            @params_valid = false
+          elsif /-/ =~ File.basename(@cookbook_name_or_path)
+            msg("Hyphens are discouraged in cookbook names as they may cause problems with custom resources. See https://docs.chef.io/ctl_chef.html#chef-generate-cookbook for more information.")
+          end
+
+          if config[:berks] && config[:policy]
+            err("Berkshelf and Policyfiles are mutually exclusive. Please specify only one.")
+            @params_valid = false
+          end
+
+          if config[:berks]
+            @policy_mode = false
+          end
+
+          if config[:verbose]
+            @verbose = true
+          end
+
+          true
+        end
+
+        def params_valid?
+          @params_valid
+        end
+
+        def cookbook_path_in_git_repo?
+          Pathname.new(cookbook_full_path).ascend do |dir|
+            return true if File.directory?(File.join(dir.to_s, ".git"))
+          end
+          false
+        end
+      end
+    end
+  end
+end