chef-dk 0.14.25 → 0.15.9

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

@@ -0,0 +1,309 @@
+#
+# 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 'spec_helper'
+require 'shared/custom_generator_cookbook'
+require 'chef-dk/command/generator_commands/build_cookbook'
+
+describe ChefDK::Command::GeneratorCommands::BuildCookbook do
+
+  let(:argv) { %w[delivery_project] }
+
+  let(:stdout_io) { StringIO.new }
+  let(:stderr_io) { StringIO.new }
+
+  let(:expected_cookbook_file_relpaths) do
+    %w[
+      .kitchen.yml
+      data_bags
+      data_bags/keys
+      data_bags/keys/delivery_builder_keys.json
+      test
+      test/fixtures
+      test/fixtures/cookbooks
+      test/fixtures/cookbooks/test
+      test/fixtures/cookbooks/test/metadata.rb
+      test/fixtures/cookbooks/test/recipes
+      test/fixtures/cookbooks/test/recipes/default.rb
+      Berksfile
+      chefignore
+      metadata.rb
+      README.md
+      LICENSE
+      recipes
+      recipes/default.rb
+      recipes/deploy.rb
+      recipes/functional.rb
+      recipes/lint.rb
+      recipes/provision.rb
+      recipes/publish.rb
+      recipes/quality.rb
+      recipes/security.rb
+      recipes/smoke.rb
+      recipes/syntax.rb
+      recipes/unit.rb
+      secrets
+      secrets/fakey-mcfakerton
+    ]
+  end
+
+  let(:expected_cookbook_files) do
+    expected_cookbook_file_relpaths.map do |relpath|
+      File.join(tempdir, "delivery_project", ".delivery", "build-cookbook", relpath)
+    end
+  end
+
+  subject(:cookbook_generator) do
+    described_class.new(argv)
+  end
+
+  def generator_context
+    ChefDK::Generator.context
+  end
+
+  before do
+    ChefDK::Generator.reset
+  end
+
+  it "configures the chef runner" do
+    expect(cookbook_generator.chef_runner).to be_a(ChefDK::ChefRunner)
+    expect(cookbook_generator.chef_runner.cookbook_path).to eq(File.expand_path('lib/chef-dk/skeletons', project_root))
+  end
+
+  context "when given invalid/incomplete arguments" do
+
+    let(:expected_help_message) do
+      "Usage: chef generate build-cookbook NAME [options]\n"
+    end
+
+
+    def with_argv(argv)
+      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
+
+    it "prints usage when args are empty" do
+      with_argv([]).run
+      expect(stderr_io.string).to include(expected_help_message)
+    end
+
+  end
+
+  context "when given the name of the delivery project" do
+
+    let(:argv) { %w[delivery_project] }
+
+    let(:project_dir) { File.join(tempdir, "delivery_project") }
+
+    before do
+      reset_tempdir
+      Dir.mkdir(project_dir)
+    end
+
+    it "configures the generator context" do
+      cookbook_generator.read_and_validate_params
+      cookbook_generator.setup_context
+      expect(generator_context.delivery_project_dir).to eq(File.join(Dir.pwd, "delivery_project"))
+    end
+
+    it "creates a build cookbook" do
+      Dir.chdir(tempdir) do
+        allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+        cookbook_generator.run
+      end
+      generated_files = Dir.glob("#{tempdir}/delivery_project/**/*", File::FNM_DOTMATCH)
+      expected_cookbook_files.each do |expected_file|
+        expect(generated_files).to include(expected_file)
+      end
+    end
+
+    shared_examples_for "a generated file" do |context_var|
+      before do
+        Dir.chdir(tempdir) do
+          allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+          cookbook_generator.run
+        end
+      end
+
+      it "should contain #{context_var} from the generator context" do
+        expect(File.read(file)).to include(line)
+      end
+    end
+
+    # This shared example group requires a let binding for
+    # `expected_kitchen_yml_content`
+    shared_examples_for "kitchen_yml_and_integration_tests" do
+
+      describe "Generating Test Kitchen and integration testing files" do
+
+        before do
+          Dir.chdir(tempdir) do
+            allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+            cookbook_generator.run
+          end
+        end
+
+        let(:file) { File.join(tempdir, "delivery_project", ".delivery", "build-cookbook", ".kitchen.yml") }
+
+        it "creates a .kitchen.yml with the expected content" do
+          expect(IO.read(file)).to eq(expected_kitchen_yml_content)
+        end
+
+      end
+    end
+
+    context "when the delivery project is a cookbook" do
+
+      let(:parent_metadata_rb) { File.join(tempdir, "delivery_project", "metadata.rb") }
+
+      before do
+        FileUtils.touch(parent_metadata_rb)
+      end
+
+      it "detects that the parent project is a cookbook" do
+        Dir.chdir(tempdir) do
+          cookbook_generator.read_and_validate_params
+          cookbook_generator.setup_context
+          expect(generator_context.build_cookbook_parent_is_cookbook).to eq(true)
+        end
+      end
+
+      describe "metadata.rb" do
+        let(:file) { File.join(tempdir, "delivery_project", ".delivery", "build-cookbook", "metadata.rb") }
+
+        include_examples "a generated file", :cookbook_name do
+          let(:line) do
+            <<-METADATA
+name 'build-cookbook'
+maintainer 'The Authors'
+maintainer_email 'you@example.com'
+license 'all_rights'
+version '0.1.0'
+
+depends 'delivery-truck'
+METADATA
+          end
+        end
+      end
+
+      describe "delivery phase recipes" do
+
+        before do
+          Dir.chdir(tempdir) do
+            allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+            cookbook_generator.run
+          end
+        end
+
+        it "generates phase recipes which include the corresponding delivery truck recipe" do
+          %w[
+            deploy.rb
+            functional.rb
+            lint.rb
+            provision.rb
+            publish.rb
+            quality.rb
+            security.rb
+            smoke.rb
+            syntax.rb
+            unit.rb
+          ].each do |phase_recipe|
+            recipe_file = File.join(tempdir, "delivery_project", ".delivery", "build-cookbook", "recipes", phase_recipe)
+            phase = File.basename(phase_recipe, ".rb")
+            expected_content = %Q[include_recipe 'delivery-truck::#{phase}']
+            expect(IO.read(recipe_file)).to include(expected_content)
+          end
+        end
+
+      end
+
+    end
+
+    context "when the delivery project is not a cookbook" do
+
+      it "detects that the parent project is not a cookbook" do
+        cookbook_generator.read_and_validate_params
+        cookbook_generator.setup_context
+        expect(generator_context.build_cookbook_parent_is_cookbook).to eq(false)
+      end
+
+      describe "metadata.rb" do
+        let(:file) { File.join(tempdir, "delivery_project", ".delivery", "build-cookbook", "metadata.rb") }
+
+        include_examples "a generated file", :cookbook_name do
+          let(:line) do
+            <<-METADATA
+name 'build-cookbook'
+maintainer 'The Authors'
+maintainer_email 'you@example.com'
+license 'all_rights'
+version '0.1.0'
+METADATA
+          end
+        end
+      end
+
+      describe "delivery phase recipes" do
+
+        before do
+          Dir.chdir(tempdir) do
+            allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+            cookbook_generator.run
+          end
+        end
+
+        it "generates phase recipes that are empty" do
+          %w[
+            deploy.rb
+            functional.rb
+            lint.rb
+            provision.rb
+            publish.rb
+            quality.rb
+            security.rb
+            smoke.rb
+            syntax.rb
+            unit.rb
+          ].each do |phase_recipe|
+            recipe_file = File.join(tempdir, "delivery_project", ".delivery", "build-cookbook", "recipes", phase_recipe)
+            expect(IO.read(recipe_file)).to_not include("include_recipe")
+          end
+        end
+
+      end
+
+    end
+  end
+
+  context "when given a path including the .delivery directory" do
+    let(:argv) { [ File.join(tempdir, "delivery_project", ".delivery", "build-cookbook") ] }
+
+    before do
+      reset_tempdir
+    end
+
+    it "correctly sets the delivery project dir to the parent of the .delivery dir" do
+      cookbook_generator.read_and_validate_params
+      cookbook_generator.setup_context
+      expect(generator_context.delivery_project_dir).to eq(File.join(tempdir, "delivery_project"))
+    end
+
+  end
+
+end

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

@@ -1,32 +1,32 @@
-#
-# 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 'spec_helper'
-require 'shared/a_file_generator'
-require 'chef-dk/command/generator_commands/cookbook_file'
-
-describe ChefDK::Command::GeneratorCommands::CookbookFile do
-
-  include_examples "a file generator" do
-
-    let(:generator_name) { "file" }
-    let(:generated_files) { [ "files/default/new_file.txt" ] }
-    let(:new_file_name) { "new_file.txt" }
-
-  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 'spec_helper'
+require 'shared/a_file_generator'
+require 'chef-dk/command/generator_commands/cookbook_file'
+
+describe ChefDK::Command::GeneratorCommands::CookbookFile do
+
+  include_examples "a file generator" do
+
+    let(:generator_name) { "file" }
+    let(:generated_files) { [ "files/default/new_file.txt" ] }
+    let(:new_file_name) { "new_file.txt" }
+
+  end
+end
+

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

@@ -280,10 +280,11 @@ provisioner:
 # default verifier)
 # verifier:
 #   name: inspec
+#   format: doc
 
 platforms:
-  - name: ubuntu-14.04
-  - name: centos-7.1
+  - name: ubuntu-16.04
+  - name: centos-7.2
 
 suites:
   - name: default
@@ -350,10 +351,11 @@ provisioner:
 # default verifier)
 # verifier:
 #   name: inspec
+#   format: doc
 
 platforms:
-  - name: ubuntu-14.04
-  - name: centos-7.1
+  - name: ubuntu-16.04
+  - name: centos-7.2
 
 suites:
   - name: default
@@ -378,6 +380,98 @@ SPEC_HELPER
 
     end
 
+    context "when configured for delivery" do
+
+      let(:argv) { %w[new_cookbook --delivery] }
+
+      let(:dot_delivery) { File.join(tempdir, "new_cookbook", ".delivery") }
+
+      before do
+        Dir.chdir(tempdir) do
+          allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+          cookbook_generator.run
+        end
+      end
+
+      describe ".delivery/config.json" do
+
+        let(:file) { File.join(tempdir, "new_cookbook", ".delivery", "config.json") }
+
+        let(:expected_content) do
+          <<-CONFIG_DOT_JSON
+{
+  "version": "2",
+  "build_cookbook": {
+    "name": "build-cookbook",
+    "path": ".delivery/build-cookbook"
+  },
+  "skip_phases": [],
+  "build_nodes": {},
+  "dependencies": []
+}
+CONFIG_DOT_JSON
+        end
+
+        it "configures delivery to use a local build cookbook" do
+          expect(IO.read(file)).to eq(expected_content)
+        end
+
+      end
+
+      describe "build cookbook recipes" do
+
+        let(:file) do
+          File.join(dot_delivery, "build-cookbook", "recipes", "publish.rb")
+        end
+
+        let(:expected_content) do
+          <<-CONFIG_DOT_JSON
+include_recipe 'delivery-truck::publish'
+CONFIG_DOT_JSON
+        end
+
+        it "delegates functionality to delivery-truck" do
+          expect(IO.read(file)).to include(expected_content)
+        end
+
+      end
+
+      describe "build cookbook Berksfile" do
+
+        let(:file) do
+          File.join(dot_delivery, "build-cookbook", "Berksfile")
+        end
+
+        let(:expected_content) do
+          <<-CONFIG_DOT_JSON
+source 'https://supermarket.chef.io'
+
+metadata
+
+cookbook 'delivery-truck',
+  git: 'https://github.com/chef-cookbooks/delivery-truck.git',
+  branch: 'master'
+
+# This is so we know where to get delivery-truck's dependency
+cookbook 'delivery-sugar',
+  git: 'https://github.com/chef-cookbooks/delivery-sugar.git',
+  branch: 'master'
+
+group :delivery do
+  cookbook 'delivery_build', git: 'https://github.com/chef-cookbooks/delivery_build'
+  cookbook 'delivery-base', git: 'https://github.com/chef-cookbooks/delivery-base'
+  cookbook 'test', path: './test/fixtures/cookbooks/test'
+end
+CONFIG_DOT_JSON
+        end
+
+        it "sets the sources for delivery library cookbooks to github" do
+          expect(IO.read(file)).to include(expected_content)
+        end
+
+      end
+    end
+
     describe "metadata.rb" do
       let(:file) { File.join(tempdir, "new_cookbook", "metadata.rb") }