chef-cli 1.0.3

data/spec/shared/fixture_cookbook_checksums.rb

@@ -0,0 +1,46 @@
+#
+# 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 "chef-cli/helpers"
+
+RSpec.shared_context "fixture cookbooks checksums" do
+
+  def id_to_dotted(sha1_id)
+    major = sha1_id[0...14]
+    minor = sha1_id[14...28]
+    patch = sha1_id[28..40]
+    decimal_integers = [major, minor, patch].map { |hex| hex.to_i(16) }
+    decimal_integers.join(".")
+  end
+
+  let(:cookbook_foo_cksum) { "f24326bbf81d67fcab6a5615c75092d1c6da81cc" }
+
+  let(:cookbook_foo_cksum_dotted) { id_to_dotted(cookbook_foo_cksum) }
+
+  let(:cookbook_bar_cksum) { "4c538def500b75e744a3af05df66afd04dc3b3c5" }
+
+  let(:cookbook_bar_cksum_dotted) { id_to_dotted(cookbook_bar_cksum) }
+
+  let(:cookbook_baz_cksum) { "5c9063efbc5b5d8acc37024d7383f7dd010ae728" }
+
+  let(:cookbook_baz_cksum_dotted) { id_to_dotted(cookbook_baz_cksum) }
+
+  let(:cookbook_dep_of_bar_cksum) { "a4a6a5e4c6d95a580d291f6415d55b010669feac" }
+
+  let(:cookbook_dep_of_bar_cksum_dotted) { id_to_dotted(cookbook_dep_of_bar_cksum) }
+
+end

data/spec/shared/setup_git_committer_config.rb

@@ -0,0 +1,54 @@
+#
+# Copyright:: Copyright (c) 2016 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 "mixlib/shellout"
+
+RSpec.shared_context("setup_git_committer_config") do
+
+  def _have_git_config_key?(key)
+    cmd = Mixlib::ShellOut.new("git config --global #{key}", returns: [0, 1])
+    cmd.run_command
+    cmd.error!
+    cmd.status.success?
+  end
+
+  def _git_config(subcommand_args)
+    cmd = Mixlib::ShellOut.new("git config --global #{subcommand_args}")
+    cmd.run_command
+    cmd.error!
+    cmd
+  end
+
+  before(:all) do
+    unless _have_git_config_key?("user.name")
+      _git_config("user.name \"chefcli_rspec_user\"")
+    end
+    unless _have_git_config_key?("user.email")
+      _git_config("user.email \"chefcli_rspec_user@example.com\"")
+    end
+  end
+
+  after(:all) do
+    if _git_config("user.name").stdout.include?("chefcli_rspec_user")
+      _git_config("--unset user.name")
+    end
+    if _git_config("user.email").stdout.include?("chefcli_rspec_user")
+      _git_config("--unset user.email")
+    end
+  end
+
+end

data/spec/shared/setup_git_cookbooks.rb

@@ -0,0 +1,53 @@
+#
+# 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 "chef-cli/helpers"
+
+RSpec.shared_context "setup git cookbooks" do
+
+  include ChefCLI::Helpers
+
+  let(:cookbook_pristine_path) do
+    File.expand_path("spec/unit/fixtures/dev_cookbooks/bar-cookbook.gitbundle", project_root)
+  end
+
+  let(:cookbook_path) { File.join(tempdir, "bar") }
+
+  let(:current_rev) { "dfc68070c47cbf4267be14ea87f80680cb5dafb3" }
+
+  before do
+    reset_tempdir
+    system_command("git clone #{cookbook_pristine_path} #{cookbook_path}").error!
+    system_command("git reset --hard #{current_rev}", cwd: cookbook_path).error!
+    system_command("git remote remove origin", cwd: cookbook_path).error!
+  end
+
+  after do
+    clear_tempdir
+  end
+
+end
+
+RSpec.shared_context "setup git cookbook remote" do
+  let(:remote_url) { "file://#{tempdir}/bar-cookbook.git" }
+
+  before do
+    system_command("git init --bare #{tempdir}/bar-cookbook.git").error!
+    system_command("git remote add origin #{remote_url}", cwd: cookbook_path).error!
+    system_command("git push -u origin master", cwd: cookbook_path).error!
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,51 @@
+#
+# 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 "rubygems"
+require "rspec/mocks"
+require "test_helpers"
+
+# needed since we stub it for every test
+require "chef/workstation_config_loader"
+require "chef/config"
+
+RSpec.configure do |c|
+  running_on_windows = (RUBY_PLATFORM =~ /mswin|mingw|windows/)
+
+  c.include ChefCLI
+  c.include TestHelpers
+
+  # Avoid loading config.rb/knife.rb unintentionally
+  c.before(:each) do
+    Chef::Config.reset
+    Chef::Config.treat_deprecation_warnings_as_errors(true)
+    allow_any_instance_of(Chef::WorkstationConfigLoader).to receive(:load)
+  end
+
+  c.after(:all) { clear_tempdir }
+
+  c.filter_run focus: true
+  c.run_all_when_everything_filtered = true
+  # Tests that randomly fail, but may have value.
+  c.filter_run_excluding volatile: true
+  c.filter_run_excluding skip_on_windows: true if running_on_windows
+
+  c.mock_with(:rspec) do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+end

data/spec/test_helpers.rb

@@ -0,0 +1,84 @@
+#
+# 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 "fileutils"
+require "tmpdir"
+
+module TestHelpers
+
+  # A globally accessible place where we can put some state to verify that a
+  # test performed a certain operation.
+  def self.test_state
+    @test_state ||= {}
+  end
+
+  def self.reset!
+    @test_state = nil
+  end
+
+  def test_state
+    TestHelpers.test_state
+  end
+
+  def fixtures_path
+    File.expand_path(File.dirname(__FILE__) + "/unit/fixtures/")
+  end
+
+  def project_root
+    File.expand_path("../..", __FILE__)
+  end
+
+  def reset_tempdir
+    clear_tempdir
+    FileUtils.mkdir_p(tempdir)
+  end
+
+  def clear_tempdir
+    FileUtils.rm_rf(tempdir)
+    @tmpdir = nil
+  end
+
+  def tempdir
+    @tmpdir ||= Dir.mktmpdir("chef-cli")
+    File.realpath(@tmpdir)
+  end
+
+  class TestUI
+
+    attr_reader :output_stream
+
+    def initialize
+      @output_stream = StringIO.new
+    end
+
+    def err(message)
+      @output_stream.puts(message)
+    end
+
+    def msg(message)
+      @output_stream.puts(message)
+    end
+
+    def print(message)
+      @output_stream.print(message)
+    end
+
+    def output
+      @output_stream.string
+    end
+  end
+end

data/spec/unit/chef_runner_spec.rb

@@ -0,0 +1,139 @@
+#
+# 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/chef_runner"
+
+describe ChefCLI::ChefRunner do
+
+  let(:stdout_io) { StringIO.new }
+
+  let(:stderr_io) { StringIO.new }
+
+  let(:default_cookbook_path) do
+    File.expand_path("chef-runner-cookbooks", fixtures_path)
+  end
+
+  let(:run_list) { [ "recipe[test_cookbook::recipe_one]", "recipe[test_cookbook::recipe_two]" ] }
+
+  subject(:chef_runner) do
+    r = ChefCLI::ChefRunner.new(default_cookbook_path, run_list)
+    allow(r).to receive(:stdout).and_return(stdout_io)
+    allow(r).to receive(:stderr).and_return(stderr_io)
+    r
+  end
+
+  it "sets up Chef::Config" do
+    chef_runner.configure
+    expect(Chef::Config.solo_legacy_mode).to be true
+    expect(Chef::Config.cookbook_path).to eq(default_cookbook_path)
+    expect(Chef::Config.color).to be true
+    expect(Chef::Config.diff_disabled).to be true
+    expect(Chef::Config.file_staging_uses_destdir).to be true
+  end
+
+  it "disables atomic file updates on Windows" do
+    allow(Chef::Platform).to receive(:windows?) { true }
+    chef_runner.configure
+    expect(Chef::Config.file_atomic_update).to be false
+  end
+
+  it "configures a formatter for the chef run" do
+    expect(chef_runner.event_dispatcher).to be_a(Chef::EventDispatch::Dispatcher)
+
+    subscribers = chef_runner.event_dispatcher.subscribers
+
+    expect(subscribers.size).to eq(1)
+    expect(subscribers.first).to be_a(ChefCLI::QuieterDocFormatter)
+  end
+
+  it "extends the recipe DSL with ChefCLI's extensions" do
+    expect(Chef::DSL::Recipe.included_modules).to include(ChefCLI::RecipeDSLExt)
+  end
+
+  it "detects the platform with ohai" do
+    expect(chef_runner.ohai).to be_a(Ohai::System)
+    expect(chef_runner.ohai.data["platform"]).to_not be_nil
+    expect(chef_runner.ohai.data["platform_version"]).to_not be_nil
+  end
+
+  it "sets up chef policy" do
+    chef_runner.configure
+    expect(chef_runner.policy.node.run_list).to eq(run_list)
+  end
+
+  it "runs a chef converge" do
+    chef_runner.converge
+    expect(test_state[:loaded_recipes]).to eq(%w{recipe_one recipe_two})
+    expect(test_state[:converged_recipes]).to eq(%w{recipe_one recipe_two})
+  end
+
+  context "when policyfile options are set in the workstation config" do
+
+    before do
+      Chef::Config.use_policyfile true
+      Chef::Config.policy_name "workstation"
+      Chef::Config.policy_group "test"
+
+      # chef-client ignores `deployment_group` unless
+      # `policy_document_native_api` is set to false
+      Chef::Config.deployment_group "workstation-test"
+      Chef::Config.policy_document_native_api false
+    end
+
+    it "unsets the options" do
+      chef_runner.configure
+
+      expect(Chef::Config.use_policyfile).to be(false)
+      expect(Chef::Config.policy_name).to be_nil
+      expect(Chef::Config.policy_group).to be_nil
+      expect(Chef::Config.deployment_group).to be_nil
+    end
+
+    it "converges successfully" do
+      expect { chef_runner.converge }.to_not raise_error
+    end
+
+  end
+
+  context "when the embedded chef run fails" do
+
+    let(:embedded_runner) { instance_double("Chef::Runner") }
+
+    before do
+      allow(Chef::Runner).to receive(:new).and_return(embedded_runner)
+      allow(embedded_runner).to receive(:converge).and_raise("oops")
+    end
+
+    it "wraps the exception in a ChefConvergeError" do
+      expect { chef_runner.converge }.to raise_error(ChefCLI::ChefConvergeError)
+    end
+
+  end
+
+  context "when cookbook_path is relative" do
+
+    let(:default_cookbook_path) { "~/heres_some_cookbooks" }
+
+    it "expands the path" do
+      expect(chef_runner.cookbook_path).to eq(File.expand_path(default_cookbook_path))
+    end
+
+  end
+
+end

data/spec/unit/chef_server_api_multi_spec.rb

@@ -0,0 +1,120 @@
+#
+# Copyright:: Copyright (c) 2017 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/chef_server_api_multi"
+
+describe ChefCLI::ChefServerAPIMulti do
+
+  let(:url) { "https://chef.example/organizations/myorg" }
+
+  let(:opts) do
+    {
+      signing_key_filename: "/path/to/key.pem",
+      client_name: "example-user",
+    }
+  end
+
+  let(:expected_server_api_opts) do
+    {
+      signing_key_filename: "/path/to/key.pem",
+      client_name: "example-user",
+      keepalives: true,
+    }
+  end
+
+  let(:chef_server_api) { instance_double("Chef::ServerAPI") }
+
+  subject(:server_api_multi) { described_class.new(url, opts) }
+
+  before do
+    # clean out thread local storage or else `chef_server_api` instance double
+    # will get re-used across test examples and rspec will complain:
+    Thread.current[:chef_server_api_multi] = nil
+    allow(Chef::ServerAPI).to receive(:new).with(url, expected_server_api_opts).and_return(chef_server_api)
+  end
+
+  it "has a url" do
+    expect(server_api_multi.url).to eq(url)
+  end
+
+  it "has an options hash for Chef::ServerAPI, with `keepalives: true` added" do
+    expect(server_api_multi.opts).to eq(expected_server_api_opts)
+  end
+
+  it "creates a thread-local Chef::ServerAPI object for requests" do
+    server_api_multi.client_for_thread # force `||=` to run
+    expect(server_api_multi.client_for_thread).to eq(Thread.current[:chef_server_api_multi])
+  end
+
+  describe "when keepalives are disabled" do
+
+    let(:opts) do
+      {
+        signing_key_filename: "/path/to/key.pem",
+        client_name: "example-user",
+        keepalives: false,
+      }
+    end
+
+    it "does not override disabling them" do
+      expect(server_api_multi.opts[:keepalives]).to be(false)
+    end
+
+  end
+
+  describe "delegating request methods to thread-local ServerAPI object" do
+
+    it "delegates #head" do
+      expect(chef_server_api).to receive(:head).with("/foo")
+      server_api_multi.head("/foo")
+    end
+
+    it "delegates #get" do
+      expect(chef_server_api).to receive(:get).with("/foo")
+      server_api_multi.get("/foo")
+    end
+
+    it "delegates #put" do
+      expect(chef_server_api).to receive(:put).with("/foo", "data")
+      server_api_multi.put("/foo", "data")
+    end
+
+    it "delegates #post" do
+      expect(chef_server_api).to receive(:post).with("/foo", "data")
+      server_api_multi.post("/foo", "data")
+    end
+
+    it "delegates #delete" do
+      expect(chef_server_api).to receive(:delete).with("/foo")
+      server_api_multi.delete("/foo")
+    end
+
+    it "delegates #streaming_request" do
+      expect(chef_server_api).to receive(:streaming_request).with("/foo")
+      server_api_multi.streaming_request("/foo")
+    end
+
+    it "passes a block argument to #streaming_request" do
+      expect(chef_server_api).to receive(:streaming_request).with("/foo").and_yield
+      x = 0
+      server_api_multi.streaming_request("/foo") { x = 5 }
+      expect(x).to eq(5)
+    end
+
+  end
+end