chef-cli 1.0.3

data/spec/unit/command/generate_spec.rb

@@ -0,0 +1,142 @@
+#
+# 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 "stringio"
+require "chef-cli/command/generate"
+
+class ChefCLI::Command::GeneratorCommands::Example < ChefCLI::Command::GeneratorCommands::Base
+
+  option :one,
+    long:         "--option-one",
+    description:  "one"
+
+  option :two,
+    long:         "--option-two",
+    description:  "two"
+
+  option :arg,
+    short:        "-a ARG",
+    long:         "--arg ARG",
+    description:  "an option that takes an argument"
+
+  def initialize(argv)
+    super # required by mixlib-cli
+    @argv = argv
+  end
+
+  def run
+    parse_options(@argv)
+    { argv: @argv, ran_cmd: "example" }
+  end
+end
+
+describe ChefCLI::Command::Generate do
+
+  # Use a subclass so we have a clean slate of defined generators
+  let(:generator_class) { Class.new(ChefCLI::Command::Generate) }
+
+  let(:stdout_io) { StringIO.new }
+  let(:stderr_io) { StringIO.new }
+
+  def stdout
+    stdout_io.string
+  end
+
+  def stderr
+    stderr_io.string
+  end
+
+  subject(:generate) do
+    g = generator_class.new
+    allow(g).to receive(:stdout).and_return(stdout_io)
+    allow(g).to receive(:stderr).and_return(stderr_io)
+    g
+  end
+
+  it "has a list of generators" do
+    expect(generator_class.generators).to eq([])
+  end
+
+  context "with a generator defined" do
+    let(:expected_help_message) do
+      <<~E
+        Usage: chef generate GENERATOR [options]
+
+        Available generators:
+          example  this is a test
+      E
+    end
+
+    before do
+      generator_class.generator(:example, :Example, "this is a test")
+    end
+
+    it "includes the generator in the list" do
+      expect(generator_class.generators.size).to eq(1)
+      generator_spec = generator_class.generators.first
+      expect(generator_spec.name).to eq(:example)
+      expect(generator_spec.class_name).to eq(:Example)
+      expect(generator_spec.description).to eq("this is a test")
+    end
+
+    it "includes the generator in the help output" do
+      expect(generator_class.banner).to eq(expected_help_message)
+    end
+
+    it "prints usage when running an unknown generator" do
+      generate.run(%w{ancient-aliens})
+      expect(stdout).to include(expected_help_message)
+    end
+
+    it "runs the generator sub-command" do
+      result = generate.run(%w{example})
+      expect(result[:ran_cmd]).to eq("example")
+    end
+
+    it "removes the subcommand name from argv" do
+      result = generate.run(%w{example})
+      expect(result[:argv]).to eq([])
+    end
+
+    it "passes extra arguments and options to the subcommand" do
+      result = generate.run(%w{example argument_one argument_two --option-one --option-two})
+      expect(result[:argv]).to eq(%w{argument_one argument_two --option-one --option-two})
+    end
+
+    describe "when an invalid option is passed to the subcommand" do
+
+      it "prints usage and returns non-zero" do
+        result = generate.run(%w{example --nope})
+        expect(result).to eq(1)
+        expect(stderr).to eq("ERROR: invalid option: --nope\n\n")
+      end
+
+    end
+
+    describe "when an option requires an argument but none is given" do
+
+      it "prints usage and returns non-zero" do
+        result = generate.run(%w{example --arg})
+        expect(result).to eq(1)
+        expect(stderr).to eq("ERROR: missing argument: --arg\n\n")
+      end
+
+    end
+
+  end
+end

data/spec/unit/command/generator_commands/attribute_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/attribute"
+
+describe ChefCLI::Command::GeneratorCommands::Attribute do
+
+  include_examples "a file generator" do
+
+    let(:generator_name) { "attribute" }
+    let(:generated_files) { [ "attributes/new_attribute_file.rb" ] }
+    let(:new_file_name) { "new_attribute_file" }
+
+  end
+end

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

@@ -0,0 +1,180 @@
+#
+# 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 "chef-cli/command/generator_commands/base"
+
+describe ChefCLI::Command::GeneratorCommands::Base do
+  describe "parsing Chef configuration" do
+    let(:cli_args) do
+      [
+        "-C", "Business Man",
+        "-I", "Serious Business",
+        "-m", "business.man@corporation.com"
+      ]
+    end
+
+    before do
+      Chef::Config.reset
+    end
+
+    context "when generator configuration is defined" do
+      before do
+        Chef::Config.reset
+        Chef::Config.chefcli.generator.copyright_holder = "This Guy"
+        Chef::Config.chefcli.generator.email = "this.guy@twothumbs.net"
+        Chef::Config.chefcli.generator.license = "Two Thumbs License"
+      end
+
+      it "uses the defined values" do
+        cmd = ChefCLI::Command::GeneratorCommands::Base.new([])
+        cmd.parse_options
+        cmd.setup_context
+        cfg = cmd.config
+        expect(cfg[:copyright_holder]).to eq("This Guy")
+        expect(cfg[:email]).to eq("this.guy@twothumbs.net")
+        expect(cfg[:license]).to eq("Two Thumbs License")
+      end
+
+      context "when cli overrides are provided" do
+        before do
+          Chef::Config.reset
+          Chef::Config.chefcli.generator.copyright_holder = "This Guy"
+          Chef::Config.chefcli.generator.email = "this.guy@twothumbs.net"
+          Chef::Config.chefcli.generator.license = "Two Thumbs License"
+        end
+
+        it "uses the cli args" do
+          cmd = ChefCLI::Command::GeneratorCommands::Base.new(cli_args)
+          cmd.parse_options(cli_args)
+          cmd.setup_context
+          cfg = cmd.config
+          expect(cfg[:copyright_holder]).to eq("Business Man")
+          expect(cfg[:email]).to eq("business.man@corporation.com")
+          expect(cfg[:license]).to eq("Serious Business")
+        end
+      end
+
+      context "when knife configuration is also defined" do
+
+        before do
+          Chef::Config.reset
+          Chef::Config.chefcli.generator.copyright_holder = "This Guy"
+          Chef::Config.chefcli.generator.email = "this.guy@twothumbs.net"
+          Chef::Config.chefcli.generator.license = "Two Thumbs License"
+          Chef::Config.knife.cookbook_copyright = "Knife User"
+          Chef::Config.knife.cookbook_email = "knife.user@example.com"
+          Chef::Config.knife.cookbook_license = "GPLv9000"
+        end
+
+        it "uses the generator configuration" do
+          cmd = ChefCLI::Command::GeneratorCommands::Base.new([])
+          cmd.parse_options
+          cmd.setup_context
+          cfg = cmd.config
+          expect(cfg[:copyright_holder]).to eq("This Guy")
+          expect(cfg[:email]).to eq("this.guy@twothumbs.net")
+          expect(cfg[:license]).to eq("Two Thumbs License")
+        end
+      end
+    end
+
+    context "when knife configuration is defined" do
+      before do
+        Chef::Config.reset
+        Chef::Config.knife.cookbook_copyright = "Knife User"
+        Chef::Config.knife.cookbook_email = "knife.user@example.com"
+        Chef::Config.knife.cookbook_license = "GPLv9000"
+      end
+
+      it "uses the defined values" do
+        cmd = ChefCLI::Command::GeneratorCommands::Base.new([])
+        cmd.parse_options
+        cmd.setup_context
+        cfg = cmd.config
+        expect(cfg[:copyright_holder]).to eq("Knife User")
+        expect(cfg[:email]).to eq("knife.user@example.com")
+        expect(cfg[:license]).to eq("GPLv9000")
+      end
+
+      context "when cli overrides are provided" do
+
+        before do
+          Chef::Config.reset
+          Chef::Config.knife.cookbook_copyright = "Knife User"
+          Chef::Config.knife.cookbook_email = "knife.user@example.com"
+          Chef::Config.knife.cookbook_license = "GPLv9000"
+        end
+
+        it "uses the cli args" do
+          cmd = ChefCLI::Command::GeneratorCommands::Base.new(cli_args)
+          cmd.parse_options(cli_args)
+          cmd.setup_context
+          cfg = cmd.config
+          expect(cfg[:copyright_holder]).to eq("Business Man")
+          expect(cfg[:email]).to eq("business.man@corporation.com")
+          expect(cfg[:license]).to eq("Serious Business")
+        end
+      end
+    end
+  end
+
+  describe "#have_git?" do
+    let(:cmd) { described_class.new([]) }
+    let(:path) { "bin_path" }
+
+    before do
+      allow(File).to receive(:exist?)
+      allow(ENV).to receive(:[]).with("PATH").and_return(path)
+      allow(ENV).to receive(:[]).with("PATHEXT").and_return(nil)
+      allow(RbConfig::CONFIG).to receive(:[]).with("EXEEXT").and_return("")
+    end
+
+    describe "when git executable exists" do
+      it "returns true" do
+        allow(File).to receive(:exist?).and_return(true)
+        expect(cmd.have_git?).to eq(true)
+      end
+    end
+
+    describe "when git executable does not exist" do
+      it "returns false" do
+        allow(File).to receive(:exist?).and_return(false)
+        expect(cmd.have_git?).to eq(false)
+      end
+    end
+
+    it "checks PATH for git executable" do
+      expect(File).to receive(:exist?).with(File.join(path, "git"))
+      cmd.have_git?
+    end
+
+    describe "when on Windows" do
+      before do
+        allow(ENV).to receive(:[]).with("PATHEXT").and_return(".com;.exe;.bat")
+        allow(RbConfig::CONFIG).to receive(:[]).with("EXEEXT").and_return(".exe")
+      end
+
+      it "checks PATH for git executable with an extension found in PATHEXT" do
+        expect(File).to receive(:exist?).with(File.join(path, "git.com"))
+        expect(File).to receive(:exist?).with(File.join(path, "git.exe"))
+        expect(File).to receive(:exist?).with(File.join(path, "git.bat"))
+        cmd.have_git?
+      end
+    end
+  end
+end

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

@@ -0,0 +1,377 @@
+#
+# 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/custom_generator_cookbook"
+require "shared/setup_git_committer_config"
+require "chef-cli/command/generator_commands/build_cookbook"
+require "mixlib/shellout"
+
+describe ChefCLI::Command::GeneratorCommands::BuildCookbook do
+
+  include_context("setup_git_committer_config")
+
+  let(:argv) { %w{workflow_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, "workflow_project", ".delivery", "build_cookbook", relpath)
+    end
+  end
+
+  subject(:cookbook_generator) do
+    described_class.new(argv)
+  end
+
+  def generator_context
+    ChefCLI::Generator.context
+  end
+
+  before do
+    ChefCLI::Generator.reset
+  end
+
+  it "configures the chef runner" do
+    expect(cookbook_generator.chef_runner).to be_a(ChefCLI::ChefRunner)
+    expect(cookbook_generator.chef_runner.cookbook_path).to eq(File.expand_path("lib/chef-cli/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{workflow_project} }
+
+    let(:project_dir) { File.join(tempdir, "workflow_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.workflow_project_dir).to eq(File.join(Dir.pwd, "workflow_project"))
+    end
+
+    it "creates a build cookbook" do
+      Dir.chdir(tempdir) do
+        allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+        expect(cookbook_generator.run).to eq(0)
+      end
+      generated_files = Dir.glob("#{tempdir}/workflow_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)
+          expect(cookbook_generator.run).to eq(0)
+        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)
+            expect(cookbook_generator.run).to eq(0)
+          end
+        end
+
+        let(:file) { File.join(tempdir, "workflow_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, "workflow_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, "workflow_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'
+              chef_version '>= 14.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)
+            expect(cookbook_generator.run).to eq(0)
+          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, "workflow_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, "workflow_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)
+            expect(cookbook_generator.run).to eq(0)
+          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, "workflow_project", ".delivery", "build_cookbook", "recipes", phase_recipe)
+            expect(IO.read(recipe_file)).to_not include("include_recipe")
+          end
+        end
+
+      end
+
+    end
+
+    context "when the delivery project is a git repo" do
+
+      let(:readme) { File.join(project_dir, "README.md") }
+
+      def git!(cmd)
+        Mixlib::ShellOut.new("git #{cmd}", cwd: project_dir).tap do |c|
+          c.run_command
+          c.error!
+        end
+      end
+
+      before do
+        FileUtils.touch(readme)
+
+        git!("init .")
+        git!("add .")
+        git!("commit --no-gpg-sign -m \"initial commit\"")
+
+        Dir.chdir(tempdir) do
+          allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+          expect(cookbook_generator.run).to eq(0)
+        end
+      end
+
+      it "creates delivery config in a feature branch and merges it" do
+        expect(git!("log").stdout).to include("Merge branch 'add-delivery-configuration'")
+      end
+
+    end
+
+    context "when the delivery project has already a config.json and project.toml" do
+
+      let(:dot_delivery) { File.join(project_dir, ".delivery") }
+      let(:config_json) { File.join(dot_delivery, "config.json") }
+      let(:project_toml) { File.join(dot_delivery, "project.toml") }
+
+      def git!(cmd)
+        Mixlib::ShellOut.new("git #{cmd}", cwd: project_dir).tap do |c|
+          c.run_command
+          c.error!
+        end
+      end
+
+      before do
+        FileUtils.mkdir_p(dot_delivery)
+        FileUtils.touch(config_json)
+        FileUtils.touch(project_toml)
+
+        git!("init .")
+        git!("add .")
+        git!("commit --no-gpg-sign -m \"initial commit\"")
+
+        Dir.chdir(tempdir) do
+          allow(cookbook_generator.chef_runner).to receive(:stdout).and_return(stdout_io)
+          expect(cookbook_generator.run).to eq(0)
+        end
+      end
+
+      it "does not overwrite the delivery config" do
+        expect(git!("log").stdout).to_not include("Add generated delivery configuration")
+      end
+
+    end
+  end
+
+  context "when given a path including the .delivery directory" do
+    let(:argv) { [ File.join(tempdir, "workflow_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.workflow_project_dir).to eq(File.join(tempdir, "workflow_project"))
+    end
+
+  end
+
+end