chef-cli 1.0.3

data/spec/unit/command/generator_commands/generator_generator_spec.rb

@@ -0,0 +1,227 @@
+#
+# Copyright:: Copyright (c) 2015 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 "spec_helper"
+require "pathname"
+require "chef-cli/command/generator_commands/generator_generator"
+
+describe ChefCLI::Command::GeneratorCommands::GeneratorGenerator do
+
+  let(:argv) { raise "define let(:argv)" }
+
+  let(:stdout_io) { StringIO.new }
+  let(:stderr_io) { StringIO.new }
+
+  let(:repo_root) { File.expand_path("../../../../..", __FILE__) }
+
+  let(:builtin_generator_path) { File.join(repo_root, "lib/chef-cli/skeletons/code_generator") }
+
+  let(:builtin_generator_full_paths) { Dir["#{builtin_generator_path}/**/*"] }
+
+  let(:expected_files_relpaths) do
+    base = Pathname.new(builtin_generator_path)
+    builtin_generator_full_paths.map { |p| Pathname.new(p).relative_path_from(base).to_s }
+  end
+
+  let(:ui) { TestHelpers::TestUI.new }
+
+  subject(:generator_generator) { described_class.new(argv) }
+
+  before do
+    # This has to be the very first thing we do for any tests
+    reset_tempdir
+
+    generator_generator.ui = ui
+    allow(generator_generator).to receive(:stdout).and_return(stdout_io)
+    allow(generator_generator).to receive(:stderr).and_return(stdout_io)
+  end
+
+  def actual_files(base_path)
+    Dir["#{base_path}/**/*"]
+  end
+
+  context "with no arguments" do
+
+    let(:argv) { [] }
+
+    let(:expected_files_full_paths) do
+      expected_files_relpaths.map { |p| File.join(tempdir, "code_generator", p) }
+    end
+
+    it "creates a copy of code_generator in the CWD" do
+      Dir.chdir(tempdir) do
+        expect(generator_generator.run).to eq(0)
+      end
+      base_path = File.join(tempdir, "code_generator")
+      expect(actual_files(base_path)).to match_array(expected_files_full_paths)
+    end
+
+    it "names the cookbook code_generator" do
+      generator_generator.verify_params!
+      expect(generator_generator.cookbook_name).to eq("code_generator")
+    end
+
+    context "when the generator cookbook is configured in the config file" do
+
+      before do
+        Chef::Config.chefcli.generator_cookbook("/foo/bar/baz")
+      end
+
+      it "copies the default generator" do
+        expect(generator_generator.source).to eq(builtin_generator_path)
+      end
+
+    end
+
+  end
+
+  context "with a path argument" do
+
+    context "when the path is a directory that exists" do
+
+      let(:argv) { [ tempdir ] }
+
+      context "and there is a directory named code_generator in that directory" do
+
+        let(:conflicting_dir) { File.join(tempdir, "code_generator") }
+
+        before do
+          FileUtils.mkdir(conflicting_dir)
+        end
+
+        it "fails" do
+          expect(generator_generator.run).to eq(1)
+          expect(actual_files(tempdir)).to eq([ conflicting_dir ])
+
+          expected_msg = "ERROR: file or directory #{conflicting_dir} exists.\n"
+
+          expect(ui.output).to eq(expected_msg)
+        end
+      end
+
+      context "and there isn't a directory named code_generator in that directory" do
+
+        let(:expected_files_full_paths) do
+          expected_files_relpaths.map { |p| File.join(tempdir, "code_generator", p) }
+        end
+
+        it "names the cookbook code_generator" do
+          generator_generator.verify_params!
+          expect(generator_generator.cookbook_name).to eq("code_generator")
+        end
+
+        it "copies the code_generator to GIVEN_DIR/code_generator" do
+          expect(generator_generator.run).to eq(0)
+
+          base_path = File.join(tempdir, "code_generator")
+          expect(actual_files(base_path)).to match_array(expected_files_full_paths)
+        end
+      end
+
+    end
+
+    context "when the path is a regular file" do
+
+      let(:conflicting_file) { File.join(tempdir, "roadblock") }
+
+      let(:argv) { [ conflicting_file ] }
+
+      before do
+        FileUtils.touch(conflicting_file)
+      end
+
+      it "fails" do
+        expect(generator_generator.run).to eq(1)
+        expect(actual_files(tempdir)).to eq([ conflicting_file ])
+
+        expected_msg = "ERROR: #{conflicting_file} exists and is not a directory.\n"
+
+        expect(ui.output).to eq(expected_msg)
+      end
+
+    end
+
+    context "when the last element of the given path doesn't exist" do
+
+      let(:target_dir) { File.join(tempdir, "my_cool_generator") }
+
+      let(:argv) { [ target_dir ] }
+
+      let(:expected_files_full_paths) do
+        expected_files_relpaths.map { |p| File.join(target_dir, p) }
+      end
+
+      it "copies the code_generator as GIVEN_DIR" do
+        expect(generator_generator.run).to eq(0)
+        expect(actual_files(target_dir)).to match_array(expected_files_full_paths)
+      end
+
+      it "names the cookbook after the directory" do
+        generator_generator.verify_params!
+        expect(generator_generator.cookbook_name).to eq("my_cool_generator")
+      end
+
+      it "updates the metadata.rb with the correct name" do
+        generator_generator.run
+
+        metadata_path = File.join(target_dir, "metadata.rb")
+        metadata_content = IO.read(metadata_path)
+        expected_metadata = <<~METADATA
+          name             'my_cool_generator'
+          description      'Custom code generator cookbook for use with #{ChefCLI::Dist::PRODUCT}'
+          long_description 'Custom code generator cookbook for use with #{ChefCLI::Dist::PRODUCT}'
+          version          '0.1.0'
+
+        METADATA
+        expect(metadata_content).to eq(expected_metadata)
+      end
+    end
+
+    context "when several elements of the given path don't exist" do
+
+      let(:target_dir) { File.join(tempdir, "too", "many", "extra", "dirs") }
+
+      let(:argv) { [ target_dir ] }
+
+      it "fails" do
+        expect(generator_generator.run).to eq(1)
+        expect(actual_files(tempdir)).to eq([ ])
+
+        parent = File.dirname(target_dir)
+        expected_msg = "ERROR: enclosing directory #{parent} does not exist.\n"
+
+        expect(ui.output).to eq(expected_msg)
+      end
+    end
+  end
+
+  context "with too many arguments" do
+
+    let(:argv) { %w{ one extra } }
+
+    it "fails" do
+      expect(generator_generator.run).to eq(1)
+      expect(actual_files(tempdir)).to eq([ ])
+
+      expected_msg = "ERROR: Too many arguments.\n"
+
+      expect(ui.output).to include(expected_msg)
+
+    end
+  end
+
+end

data/spec/unit/command/generator_commands/helpers_spec.rb

@@ -0,0 +1,31 @@
+#
+# 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 "spec_helper"
+require "shared/a_file_generator"
+require "chef-cli/command/generator_commands/helpers"
+
+describe ChefCLI::Command::GeneratorCommands::Helpers do
+
+  include_examples "a file generator" do
+
+    let(:generator_name) { "helpers" }
+    let(:generated_files) { [ "libraries/new_helpers.rb" ] }
+    let(:new_file_name) { "new_helpers" }
+
+  end
+end

data/spec/unit/command/generator_commands/policyfile_spec.rb

@@ -0,0 +1,223 @@
+#
+# 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 "spec_helper"
+require "shared/a_file_generator"
+require "chef-cli/command/generator_commands/policyfile"
+
+describe ChefCLI::Command::GeneratorCommands::Policyfile do
+
+  let(:stdout_io) { StringIO.new }
+  let(:stderr_io) { StringIO.new }
+
+  def stdout
+    stdout_io.string
+  end
+
+  def stderr
+    stderr_io.string
+  end
+
+  subject(: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
+    allow(generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+    ChefCLI::Generator.reset
+    reset_tempdir
+  end
+
+  after(:each) do
+    ChefCLI::Generator::Context.reset
+  end
+
+  shared_examples_for "it creates a Policyfile" do
+
+    it "configures the generator context" do
+      Dir.chdir(tempdir) do
+        generator.read_and_validate_params
+        generator.setup_context
+
+        expect(generator_context.policyfile_dir).to eq(tempdir)
+        expect(generator_context.new_file_basename).to eq(new_file_basename)
+      end
+    end
+
+    it "generates a Policyfile.rb in the CWD" do
+      Dir.chdir(tempdir) do
+        expect(generator.run).to eq(0)
+        expect(File).to exist(File.join(tempdir, expected_file_name))
+      end
+    end
+
+  end
+
+  context "when ARGV is empty" do
+
+    let(:argv) { [] }
+
+    let(:expected_file_name) { "Policyfile.rb" }
+    let(:new_file_basename) { "Policyfile" }
+
+    include_examples "it creates a Policyfile"
+
+  end
+
+  context "when ARGV is a relative path with no `.rb' extension" do
+
+    let(:argv) { ["MyPolicy"] }
+
+    let(:expected_file_name) { "MyPolicy.rb" }
+    let(:new_file_basename) { "MyPolicy" }
+
+    include_examples "it creates a Policyfile"
+
+  end
+
+  context "when ARGV is a relative path with a `.rb' extension" do
+
+    let(:argv) { ["MyApplication.rb"] }
+
+    let(:expected_file_name) { "MyApplication.rb" }
+    let(:new_file_basename) { "MyApplication" }
+
+    include_examples "it creates a Policyfile"
+
+  end
+
+  context "when the current working directory is a chef repo" do
+
+    let(:chef_repo_dot_txt) { File.join(tempdir, ".chef-repo.txt") }
+
+    let(:policies_dir) { File.join(tempdir, "policyfiles") }
+
+    let(:expected_policyfile_content) do
+      <<~POLICYFILE_RB
+        # Policyfile.rb - Describe how you want Chef Infra Client to build your system.
+        #
+        # For more information on the Policyfile feature, visit
+        # https://docs.chef.io/policyfile.html
+
+        # A name that describes what the system you're building with Chef does.
+        name 'my-app-frontend'
+
+        # This lets you source cookbooks from your chef-repo.
+        default_source :chef_repo, '../'
+
+        # Where to find external cookbooks:
+        default_source :supermarket
+
+        # run_list: chef-client will run these recipes in the order specified.
+        run_list 'my-app-frontend::default'
+
+        # Specify a custom source for a single cookbook:
+        # cookbook 'example_cookbook', path: '../cookbooks/example_cookbook'
+      POLICYFILE_RB
+    end
+
+    before do
+      FileUtils.touch(chef_repo_dot_txt)
+      FileUtils.mkdir(policies_dir)
+    end
+
+    context "when ARGV is empty" do
+
+      let(:argv) { [] }
+
+      it "errors and explains a policy name is required when using a chef-repo" do
+        Dir.chdir(tempdir) do
+          expect(generator.run).to eq(1)
+        end
+        expect(File).to_not exist(File.join(tempdir, "Policyfile.rb"))
+        expected_error = "ERROR: You must give a policy name when generating a policy in a chef-repo."
+        expect(stderr).to include(expected_error)
+      end
+
+    end
+
+    context "when ARGV is a single name with no path separators" do
+
+      let(:argv) { ["my-app-frontend"] }
+
+      let(:expected_policyfile_path) { File.join(policies_dir, "my-app-frontend.rb") }
+
+      before do
+        Dir.chdir(tempdir) do
+          expect(generator.run).to eq(0)
+        end
+      end
+
+      it "creates the policy under the policies/ directory" do
+        expect(File).to exist(expected_policyfile_path)
+      end
+
+      it "adds chef_repo as a default source and uses argv for the policy name" do
+        expect(IO.read(expected_policyfile_path)).to eq(expected_policyfile_content)
+      end
+
+    end
+
+    context "when ARGV looks like a path" do
+
+      let(:other_policy_dir) { File.join(tempdir, "other-policies") }
+
+      let(:expected_policyfile_path) { File.join(other_policy_dir, "my-app-frontend.rb") }
+
+      let(:argv) { [ "other-policies/my-app-frontend" ] }
+
+      before do
+        FileUtils.mkdir(other_policy_dir)
+
+        Dir.chdir(tempdir) do
+          expect(generator.run).to eq(0)
+        end
+      end
+
+      it "creates the policy in the specified path" do
+        expect(File).to exist(expected_policyfile_path)
+      end
+
+      it "adds chef_repo as a default source" do
+        expect(IO.read(expected_policyfile_path)).to eq(expected_policyfile_content)
+      end
+
+    end
+
+  end
+
+  context "when ARGV has too many arguments" do
+
+    let(:argv) { %w{ foo bar baz } }
+
+    it "shows usage and exits" do
+      expected_stdout = "Usage: chef generate policyfile [NAME] [options]"
+
+      expect(generator.run).to eq(1)
+      expect(stderr).to include(expected_stdout)
+    end
+
+  end
+
+end