chef-dk 0.8.0 → 0.9.0

data/spec/shared/a_file_generator.rb

@@ -1,125 +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
-    ChefDK::Generator.context
-  end
-
-  before do
-    ChefDK::Generator.reset
-    reset_tempdir
-  end
-
-  after(:each) do
-    ChefDK::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
+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
+    ChefDK::Generator.context
+  end
+
+  before do
+    ChefDK::Generator.reset
+    reset_tempdir
+  end
+
+  after(:each) do
+    ChefDK::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

@@ -1,12 +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
+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

@@ -1,11 +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
+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

@@ -1,117 +1,117 @@
-
-# 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-dk/skeletons/code_generator', project_root) }
-
-    let(:generator_cookbook_path) { File.join(tempdir, 'a_generator_cookbook') }
-
-    let(:argv) { [generator_arg, "--generator-cookbook", generator_cookbook_path] }
-
-    subject(:code_generator) { described_class.new(argv) }
-
-    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(:chefdk_config) { double("Mixlib::Config context for ChefDK", generator_cookbook: generator_cookbook_path) }
-
-      before do
-        allow(code_generator).to receive(:chefdk_config).and_return(chefdk_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
-
+
+# 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-dk/skeletons/code_generator', project_root) }
+
+    let(:generator_cookbook_path) { File.join(tempdir, 'a_generator_cookbook') }
+
+    let(:argv) { [generator_arg, "--generator-cookbook", generator_cookbook_path] }
+
+    subject(:code_generator) { described_class.new(argv) }
+
+    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(:chefdk_config) { double("Mixlib::Config context for ChefDK", generator_cookbook: generator_cookbook_path) }
+
+      before do
+        allow(code_generator).to receive(:chefdk_config).and_return(chefdk_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
+