chef-cli 1.0.3

data/lib/chef-cli/skeletons/code_generator/templates/default/resource.rb.erb

@@ -0,0 +1 @@
+# To learn more about Custom Resources, see https://docs.chef.io/custom_resources.html

data/lib/chef-cli/ui.rb

@@ -0,0 +1,57 @@
+#
+# 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.
+#
+
+module ChefCLI
+  class UI
+
+    class NullStream
+
+      def puts(*anything)
+        nil
+      end
+
+      def print(*anything)
+        nil
+      end
+
+    end
+
+    def self.null
+      new(out: NullStream.new, err: NullStream.new)
+    end
+
+    attr_reader :out_stream
+    attr_reader :err_stream
+
+    def initialize(out: nil, err: nil)
+      @out_stream = out || $stdout
+      @err_stream = err || $stderr
+    end
+
+    def err(message)
+      @err_stream.puts(message)
+    end
+
+    def msg(message)
+      @out_stream.puts(message)
+    end
+
+    def print(message)
+      @out_stream.print(message)
+    end
+  end
+end

data/lib/chef-cli/version.rb

@@ -0,0 +1,20 @@
+#
+# 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.
+#
+
+module ChefCLI
+  VERSION = "1.0.3".freeze
+end

data/lib/kitchen/provisioner/policyfile_zero.rb

@@ -0,0 +1,195 @@
+# -*- encoding: utf-8 -*-
+#
+# Author:: Fletcher Nichol (<fnichol@nichol.ca>)
+#
+# Copyright (C) 2013, Fletcher Nichol
+#
+# 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 "kitchen/provisioner/chef_base"
+
+# TODO: chef-cli and kitchen can only co-exist if kitchen and chef-cli agree on
+# the version of mixlib-shellout to use. Kitchen currently locked at 1.4,
+# chef-cli is on 2.x
+require_relative "../../chef-cli/policyfile_services/export_repo"
+
+module Kitchen
+
+  module Provisioner
+
+    class Base
+
+      # PolicyfileZero needs to access the base behavior of creating the
+      # sandbox directory without invoking the behavior of
+      # ChefBase#create_sandbox, because that will trigger the use of
+      # Chef::CommonSandbox, which we need to override.
+      alias_method :create_sandbox_directory, :create_sandbox
+
+    end
+
+    class PolicyfileSandbox < Chef::CommonSandbox
+
+      # Stub #prepare_cookbooks because we have implemented this in the
+      # provisioner, below. If a Berksfile is present, the default
+      # implementation will try to run Berkshelf, which can lead to dependency
+      # issues since berks is not yet using Solve 2.x. See also
+      # PolicyfileZero#load_needed_dependencies! which is stubbed to prevent
+      # berks from loading.
+      def prepare_cookbooks
+      end
+
+    end
+
+    # Policyfile + Chef Zero provisioner.
+    #
+    # @author Daniel DeLeo <dan@chef.io>
+    class PolicyfileZero < ChefBase
+
+      # This provsioner will forcibly set the following config options:
+      # * `use_policyfile`: `true`
+      # * `versioned_cookbooks`: `true`
+      # * `deployment_group`: `POLICY_NAME-local`
+      # Since it makes no sense to modify these, they are hardcoded elsewhere.
+      default_config :client_rb, {}
+      default_config :json_attributes, true
+      default_config :named_run_list, nil
+      default_config :chef_zero_host, nil
+      default_config :chef_zero_port, 8889
+      default_config :policyfile, "Policyfile.rb"
+
+      default_config :chef_client_path do |provisioner|
+        provisioner
+          .remote_path_join(%W{#{provisioner[:chef_omnibus_root]} bin chef-client})
+          .tap { |path| path.concat(".bat") if provisioner.windows_os? }
+      end
+
+      default_config :ruby_bindir do |provisioner|
+        provisioner
+          .remote_path_join(%W{#{provisioner[:chef_omnibus_root]} embedded bin})
+      end
+
+      # (see Base#finalize_config!)
+      def finalize_config!(*args)
+        super
+        banner("Using policyfile mode for chef-client")
+      end
+
+      # (see Base#create_sandbox)
+      def create_sandbox
+        create_sandbox_directory
+        PolicyfileSandbox.new(config, sandbox_path, instance).populate
+        prepare_cookbooks
+        prepare_validation_pem
+        prepare_client_rb
+      end
+
+      # (see Base#run_command)
+      def run_command
+        level = config[:log_level] == :info ? :auto : config[:log_level]
+
+        cmd = "#{sudo(config[:chef_client_path])} --local-mode"
+          .tap { |str| str.insert(0, "& ") if powershell_shell? }
+
+        args = [
+          "--config #{config[:root_path]}/client.rb",
+          "--log_level #{level}",
+          "--force-formatter",
+          "--no-color",
+        ]
+        if config[:chef_zero_port]
+          args << "--chef-zero-port #{config[:chef_zero_port]}"
+        end
+        if config[:log_file]
+          args << "--logfile #{config[:log_file]}"
+        end
+
+        if config[:named_run_list]
+          args << "--named-run-list #{config[:named_run_list]}"
+        end
+
+        wrap_shell_code(
+          [cmd, *args].join(" ")
+          .tap { |str| str.insert(0, reload_ps1_path) if windows_os? }
+        )
+      end
+
+      # We don't want to load Berkshelf or Librarian; Policyfile is managing
+      # dependencies, so these can only cause trouble.
+      def load_needed_dependencies!
+      end
+
+      private
+
+      # Overrides behavior of parent class so that dna.json isn't created; we
+      # don't need it.
+      #
+      # @api private
+      def prepare_json
+      end
+
+      # Copies the policyfile's cookbooks to the sandbox.
+      #
+      # @api private
+      def prepare_cookbooks
+        Kitchen.mutex.synchronize do
+          policy_exporter.run
+        end
+      end
+
+      # An instance of ChefCLI::PolicyfileServices::ExportRepo, configured with
+      # the sandbox path. Calling `#run` on this copies the cookbooks to the
+      # sandbox. Calling `#policy_name` returns the policy's name.
+      #
+      # @api private
+      def policy_exporter
+        # Must force this because TK by default copies the current cookbook to the sandbox
+        # See ChefCLI::PolicyfileServices::ExportRepo#assert_export_dir_clean!
+        @policy_exporter ||= ChefCLI::PolicyfileServices::ExportRepo.new(policyfile: config[:policyfile],
+                                                                        export_dir: sandbox_path,
+                                                                        force: true)
+      end
+
+      # Writes a fake (but valid) validation.pem into the sandbox directory.
+      #
+      # @api private
+      def prepare_validation_pem
+        info("Preparing validation.pem")
+        debug("Using a dummy validation.pem")
+
+        source = File.join(Kitchen.source_root, %w{support dummy-validation.pem})
+        FileUtils.cp(source, File.join(sandbox_path, "validation.pem"))
+      end
+
+      # Writes a client.rb configuration file to the sandbox directory.
+      #
+      # @api private
+      def prepare_client_rb
+        data = default_config_rb.merge(config[:client_rb])
+
+        data["use_policyfile"] = true
+        data["versioned_cookbooks"] = true
+        data["policy_name"] = policy_exporter.policy_name
+        data["policy_group"] = "local"
+        data["policy_document_native_api"] = true
+
+        info("Preparing client.rb")
+        debug("Creating client.rb from #{data.inspect}")
+
+        File.open(File.join(sandbox_path, "client.rb"), "wb") do |file|
+          file.write(format_config_file(data))
+        end
+      end
+
+    end
+  end
+end

data/spec/shared/a_file_generator.rb

@@ -0,0 +1,125 @@
+shared_examples_for "a file generator" do
+
+  let(:stdout_io) { StringIO.new }
+  let(:stderr_io) { StringIO.new }
+
+  def stdout
+    stdout_io.string
+  end
+
+  def stderr
+    stderr_io.string
+  end
+
+  let(:expected_cookbook_root) { tempdir }
+  let(:cookbook_name) { "example_cookbook" }
+
+  let(:cookbook_path) { File.join(tempdir, cookbook_name) }
+
+  subject(:recipe_generator) do
+    generator = described_class.new(argv)
+    allow(generator).to receive(:stdout).and_return(stdout_io)
+    allow(generator).to receive(:stderr).and_return(stderr_io)
+    generator
+  end
+
+  def generator_context
+    ChefCLI::Generator.context
+  end
+
+  before do
+    ChefCLI::Generator.reset
+    reset_tempdir
+  end
+
+  after(:each) do
+    ChefCLI::Generator::Context.reset
+  end
+
+  context "when argv is empty" do
+    let(:argv) { [] }
+
+    it "emits an error message and exits" do
+      expected_stdout = "Usage: chef generate #{generator_name} [path/to/cookbook] NAME [options]"
+
+      expect(recipe_generator.run).to eq(1)
+      expect(stdout).to include(expected_stdout)
+    end
+  end
+
+  context "when CWD is a cookbook" do
+
+    let(:argv) { [ new_file_name ] }
+
+    before do
+      FileUtils.cp_r(File.join(fixtures_path, "example_cookbook"), tempdir)
+    end
+
+    it "configures the generator context" do
+      Dir.chdir(cookbook_path) do
+        recipe_generator.read_and_validate_params
+        recipe_generator.setup_context
+
+        expect(generator_context.cookbook_root).to eq(expected_cookbook_root)
+        expect(generator_context.cookbook_name).to eq(cookbook_name)
+        expect(generator_context.new_file_basename).to eq(new_file_name)
+        expect(generator_context.recipe_name).to eq(new_file_name)
+      end
+    end
+
+    it "creates a new recipe" do
+      Dir.chdir(cookbook_path) do
+        allow(recipe_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+        recipe_generator.run
+      end
+
+      generated_files.each do |expected_file|
+        expect(File).to exist(File.join(cookbook_path, expected_file))
+      end
+    end
+
+  end
+
+  context "when CWD is not a cookbook" do
+    context "and path to the cookbook is not given in the agv" do
+      let(:argv) { [ new_file_name ] }
+
+      it "emits an error message and exits" do
+        expected_stdout = "Usage: chef generate #{generator_name} [path/to/cookbook] NAME [options]"
+        expected_stderr = "Error: Directory #{Dir.pwd} is not a cookbook\n"
+
+        expect(recipe_generator.run).to eq(1)
+        expect(stdout).to include(expected_stdout)
+        expect(stderr).to eq(expected_stderr)
+      end
+    end
+
+    context "and path to the cookbook is given in the argv" do
+      let(:argv) { [cookbook_path, new_file_name ] }
+
+      before do
+        FileUtils.cp_r(File.join(fixtures_path, "example_cookbook"), tempdir)
+      end
+
+      it "configures the generator context" do
+        recipe_generator.read_and_validate_params
+        recipe_generator.setup_context
+
+        expect(generator_context.cookbook_root).to eq(File.dirname(cookbook_path))
+        expect(generator_context.cookbook_name).to eq(cookbook_name)
+        expect(generator_context.new_file_basename).to eq(new_file_name)
+      end
+
+      it "creates a new recipe" do
+        allow(recipe_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+        recipe_generator.run
+
+        generated_files.each do |expected_file|
+          expect(File).to exist(File.join(cookbook_path, expected_file))
+        end
+      end
+
+    end
+  end
+
+end

data/spec/shared/a_generated_file.rb

@@ -0,0 +1,12 @@
+shared_examples_for "a generated file" do |context_var|
+  before do
+    Dir.chdir(tempdir) do
+      allow(generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+      generator.run
+    end
+  end
+
+  it "should contain #{context_var} from the generator context" do
+    expect(File.read(file)).to match line
+  end
+end

data/spec/shared/command_with_ui_object.rb

@@ -0,0 +1,11 @@
+shared_examples_for "a command with a UI object" do
+
+  subject(:command) { described_class.new }
+
+  it "configures a default UI component" do
+    ui = command.ui
+    expect(ui.out_stream).to eq($stdout)
+    expect(ui.err_stream).to eq($stderr)
+  end
+
+end

data/spec/shared/custom_generator_cookbook.rb

@@ -0,0 +1,136 @@
+
+# Required `let` bindings:
+# * `generator_name` in lowercase, e.g., "cookbook", "app"
+# * `generator_arg`: argument to the generator command
+# * `expected_cookbook_files`: a list of files the generator should create
+shared_examples_for "custom generator cookbook" do
+
+  context "when given a generator-cookbook path" do
+
+    let(:default_generator_cookbook_path) { File.expand_path("lib/chef-cli/skeletons/code_generator", project_root) }
+
+    let(:generator_cookbook_path) { File.join(tempdir, "a_generator_cookbook") }
+    let(:generator_copyright_holder) { "Chef" }
+    let(:generator_email) { "mail@chef.io" }
+    let(:generator_license) { "Free as in Beer" }
+
+    let(:argv) { [generator_arg, "--generator-cookbook", generator_cookbook_path] }
+
+    let(:stdout_io) { StringIO.new }
+
+    subject(:code_generator) do
+      described_class.new(argv).tap do |gen|
+        allow(gen).to receive(:stdout).and_return(stdout_io)
+      end
+    end
+
+    before do
+      reset_tempdir
+      code_generator.read_and_validate_params
+      allow(code_generator.config_loader).to receive(:load)
+    end
+
+    it "configures the generator context" do
+      code_generator.setup_context
+      expect(generator_context.cookbook_name).to eq(generator_arg)
+      expect(code_generator.chef_runner.cookbook_path).to eq(tempdir)
+      expect(code_generator.chef_runner.run_list).to eq(["recipe[a_generator_cookbook::#{generator_name}]"])
+    end
+
+    context "when the generator cookbook is configured in a configuration file" do
+
+      let(:argv) { [generator_arg] }
+
+      let(:generator_config) do
+        double("Generator Config Context",
+          license: generator_license,
+          copyright_holder: generator_copyright_holder,
+          email: generator_email)
+      end
+
+      let(:chefcli_config) do
+        double("Mixlib::Config context for ChefCLI",
+          generator_cookbook: generator_cookbook_path,
+          generator: generator_config)
+      end
+
+      before do
+        allow(code_generator).to receive(:chefcli_config).and_return(chefcli_config)
+      end
+
+      it "configures the generator context" do
+        code_generator.setup_context
+        expect(generator_context.cookbook_name).to eq(generator_arg)
+        expect(code_generator.chef_runner.cookbook_path).to eq(tempdir)
+        expect(code_generator.chef_runner.run_list).to eq(["recipe[a_generator_cookbook::#{generator_name}]"])
+      end
+    end
+
+    context "with an invalid generator-cookbook path" do
+
+      it "fails with an informative error" do
+        Dir.chdir(tempdir) do
+          allow(code_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+          allow(code_generator).to receive(:stderr).and_return(stderr_io)
+          expect(code_generator.run).to eq(1)
+        end
+
+        cookbook_path = File.dirname(generator_cookbook_path)
+        expected_msg = %Q{ERROR: Could not find cookbook(s) to satisfy run list ["recipe[a_generator_cookbook::#{generator_name}]"] in #{cookbook_path}}
+
+        expect(stderr_io.string).to include(expected_msg)
+      end
+
+    end
+
+    context "with a generator-cookbook path to a specific cookbook" do
+
+      let(:metadata_file) { File.join(generator_cookbook_path, "metadata.rb") }
+
+      before do
+        FileUtils.cp_r(default_generator_cookbook_path, generator_cookbook_path)
+
+        # have to update metadata with the correct name
+        IO.binwrite(metadata_file, "name 'a_generator_cookbook'")
+      end
+
+      it "creates the new files" do
+        expect(code_generator.chef_runner.cookbook_path).to eq(tempdir)
+        expect(code_generator.chef_runner.run_list).to eq(["recipe[a_generator_cookbook::#{generator_name}]"])
+
+        Dir.chdir(tempdir) do
+          allow(code_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+          code_generator.run
+        end
+      end
+
+    end
+
+    context "with a generator-cookbook path to a directory containing a 'code_generator' cookbook" do
+
+      before do
+        FileUtils.mkdir_p(generator_cookbook_path)
+        FileUtils.cp_r(default_generator_cookbook_path, generator_cookbook_path)
+
+        allow(code_generator).to receive(:stderr).and_return(stderr_io)
+      end
+
+      it "creates the new_files (and warns about deprecated usage)" do
+        allow(code_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+
+        Dir.chdir(tempdir) do
+          code_generator.run
+        end
+        generated_files = Dir.glob("#{tempdir}/#{generator_arg}/**/*", File::FNM_DOTMATCH)
+        expected_cookbook_files.each do |expected_file|
+          expect(generated_files).to include(expected_file)
+        end
+
+        code_generator_path = File.join(generator_cookbook_path, "code_generator")
+        warning_message = "WARN: Please configure the generator cookbook by giving the full path to the desired cookbook (like '#{code_generator_path}')"
+
+        expect(stderr_io.string).to include(warning_message)
+      end
+    end
+  end
+end