chef-cli 1.0.3

data/spec/unit/configurable_spec.rb

@@ -0,0 +1,68 @@
+#
+# 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/configurable"
+require "unit/fixtures/configurable/test_configurable"
+
+describe ChefCLI::Configurable do
+
+  let(:includer) { TestConfigurable.new }
+
+  before { includer.reset_config! }
+
+  it "provides chef_config" do
+    expect(includer.chef_config).to eq Chef::Config
+  end
+
+  it "provides chefcli_config" do
+    expect(includer.chefcli_config).to eq Chef::Config.chefcli
+  end
+
+  it "provides knife_config" do
+    expect(includer.knife_config).to eq Chef::Config.knife
+  end
+
+  it "provides generator_config" do
+    expect(includer.generator_config).to eq Chef::Config.chefcli.generator
+  end
+
+  describe "loading Chef Config" do
+
+    let(:url) { "https://chef.example/organizations/myorg" }
+
+    let(:key_path) { "/path/to/my/key.pem" }
+
+    let(:username) { "my-username" }
+
+    before do
+      Chef::Config.chef_server_url(url)
+      Chef::Config.client_key(key_path)
+      Chef::Config.node_name(username)
+      includer.chef_config
+    end
+
+    it "creates a default chef server HTTP client for Omnifetch" do
+      client = CookbookOmnifetch.default_chef_server_http_client
+      expect(client).to be_a_kind_of(ChefCLI::ChefServerAPIMulti)
+      expect(client.url).to eq(url)
+      expect(client.opts[:signing_key_filename]).to eq(key_path)
+      expect(client.opts[:client_name]).to eq(username)
+    end
+
+  end
+end

data/spec/unit/cookbook_metadata_spec.rb

@@ -0,0 +1,96 @@
+#
+# 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/cookbook_metadata"
+
+describe ChefCLI::CookbookMetadata do
+
+  describe "providing the API required by CookbookOmnifetch" do
+
+    let(:metadata) { ChefCLI::CookbookMetadata.new }
+
+    it "provides a `from_path` class method" do
+      expect(described_class).to respond_to(:from_path)
+    end
+
+    it "responds to #cookbook_name" do
+      expect(metadata).to respond_to(:cookbook_name)
+    end
+
+    it "responds to #version" do
+      expect(metadata).to respond_to(:version)
+    end
+
+  end
+
+  describe "when a cookbook is loaded" do
+
+    let(:cookbook) { described_class.from_path(cookbook_root) }
+
+    context "and the cookbook has only a metadata.rb" do
+
+      let(:cookbook_root) { File.join(fixtures_path, "example_cookbook") }
+
+      it "has a name" do
+        expect(cookbook.name).to eq("example_cookbook")
+        expect(cookbook.cookbook_name).to eq("example_cookbook")
+      end
+
+      it "has a version" do
+        expect(cookbook.version).to eq("0.1.0")
+      end
+
+      it "has a map of dependencies" do
+        expect(cookbook.dependencies).to eq({})
+      end
+
+    end
+
+    context "and the cookbook has only a metadata.json" do
+
+      let(:cookbook_root) { File.join(fixtures_path, "example_cookbook_metadata_json_only") }
+
+      it "has a name" do
+        expect(cookbook.name).to eq("example_cookbook")
+        expect(cookbook.cookbook_name).to eq("example_cookbook")
+      end
+
+      it "has a version" do
+        expect(cookbook.version).to eq("0.1.0")
+      end
+
+      it "has a map of dependencies" do
+        expect(cookbook.dependencies).to eq({})
+      end
+
+    end
+
+    context "and the cookbook has no metadata" do
+
+      let(:cookbook_root) { File.join(fixtures_path, "example_cookbook_no_metadata") }
+
+      it "raises a MalformedCookbook error" do
+        msg = "Cookbook at #{cookbook_root} has neither metadata.json or metadata.rb"
+
+        expect { cookbook }.to raise_error(ChefCLI::MalformedCookbook, msg)
+      end
+
+    end
+
+  end
+end

data/spec/unit/cookbook_profiler/git_spec.rb

@@ -0,0 +1,176 @@
+#
+# 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/setup_git_cookbooks"
+require "fileutils"
+require "chef-cli/helpers"
+require "chef-cli/cookbook_profiler/git"
+
+describe ChefCLI::CookbookProfiler::Git do
+
+  include ChefCLI::Helpers
+
+  let(:git_profiler) do
+    ChefCLI::CookbookProfiler::Git.new(cookbook_path)
+  end
+
+  context "with cookbooks in a valid git repo" do
+
+    include_context "setup git cookbooks"
+
+    def edit_repo
+      with_file(File.join(cookbook_path, "README.md"), "ab+") { |f| f.puts "some unpublished changes" }
+    end
+
+    context "given a clean repo with no remotes" do
+
+      it "reports that the repo has no remotes" do
+        expect(git_profiler.remote).to be_nil
+      end
+
+      it "determines the rev of the repo" do
+        expect(git_profiler.revision).to eq(current_rev)
+      end
+
+      it "reports that the repo is clean" do
+        expect(git_profiler.clean?).to be true
+      end
+
+      it "reports that the commits are unpublished" do
+        expect(git_profiler.unpublished_commits?).to be true
+      end
+
+      it "reports that no remotes have the commits" do
+        expect(git_profiler.synchronized_remotes).to eq([])
+      end
+
+    end
+
+    context "when the remote is a local branch" do
+
+      before do
+        allow(git_profiler).to receive(:remote_name).and_return(".")
+      end
+
+      it "reports that the repo doesn't have a remote" do
+        expect(git_profiler.have_remote?).to be(false)
+      end
+
+    end
+
+    context "with a remote configured" do
+
+      include_context "setup git cookbook remote"
+
+      context "given a clean repo with all commits published to the remote" do
+
+        it "determines the remote for the repo" do
+          expect(git_profiler.remote).to eq(remote_url)
+        end
+
+        it "determines the rev of the repo" do
+          expect(git_profiler.revision).to eq(current_rev)
+        end
+
+        it "reports that the repo is clean" do
+          expect(git_profiler.clean?).to be true
+        end
+
+        it "reports that all commits are published to the upstream" do
+          expect(git_profiler.unpublished_commits?).to be false
+        end
+
+        it "lists the remotes that commits are published to" do
+          expect(git_profiler.synchronized_remotes).to eq(%w{origin/master})
+        end
+
+      end
+
+      context "given a clean repo with unpublished changes" do
+
+        before do
+          edit_repo
+          system_command('git config --local user.name "Alice"', cwd: cookbook_path).error!
+          system_command('git config --local user.email "alice@example.com"', cwd: cookbook_path).error!
+          system_command('git config --local commit.gpgsign "false"', cwd: cookbook_path).error!
+          system_command('git commit -a -m "update readme" --author "Alice <alice@example.com>"', cwd: cookbook_path).error!
+        end
+
+        it "reports that the repo is clean" do
+          expect(git_profiler.clean?).to be true
+        end
+
+        it "reports that there are unpublished changes" do
+          expect(git_profiler.unpublished_commits?).to be true
+        end
+
+        it "reports that no remotes have the commits" do
+          expect(git_profiler.synchronized_remotes).to eq([])
+        end
+
+      end
+    end
+
+    context "given a dirty repo" do
+
+      before do
+        edit_repo
+      end
+
+      it "reports that the repo is dirty" do
+        expect(git_profiler.clean?).to be false
+      end
+
+    end
+
+  end
+
+  context "given a repo on an unborn master branch" do
+
+    let(:cookbook_path) { File.join(tempdir, "unborn") }
+
+    let(:profile_data) { git_profiler.profile_data }
+
+    before do
+      reset_tempdir
+      FileUtils.mkdir_p(cookbook_path)
+      system_command("git init .", cwd: cookbook_path).error!
+    end
+
+    it "does not error when profiling the cookbook" do
+      expect { git_profiler.profile_data }.to_not raise_error
+    end
+
+    it "has a nil revision" do
+      expect(profile_data["revision"]).to be_nil
+    end
+
+    it "has no remote" do
+      expect(profile_data["remote"]).to be_nil
+    end
+
+    it "has no synchronized remote branches" do
+      expect(profile_data["synchronized_remote_branches"]).to eq([])
+    end
+
+    it "is not published" do
+      expect(profile_data["published"]).to be(false)
+    end
+  end
+
+end

data/spec/unit/cookbook_profiler/identifiers_spec.rb

@@ -0,0 +1,81 @@
+#
+# 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/cookbook_profiler/identifiers"
+require "chef-cli/policyfile/read_cookbook_for_compat_mode_upload"
+
+describe ChefCLI::CookbookProfiler::Identifiers do
+
+  let(:cache_path) do
+    File.expand_path("spec/unit/fixtures/cookbook_cache", project_root)
+  end
+
+  let(:foo_cookbook_path) do
+    File.join(cache_path, "foo-1.0.0")
+  end
+
+  let(:cookbook_version) do
+    chefignore = Chef::Cookbook::Chefignore.new(File.join(foo_cookbook_path, "chefignore"))
+    cbvl = Chef::Cookbook::CookbookVersionLoader.new(foo_cookbook_path, chefignore)
+    cbvl.load!
+    cbvl.cookbook_version
+  end
+
+  let(:identifiers) do
+    ChefCLI::CookbookProfiler::Identifiers.new(cookbook_version)
+  end
+
+  let(:cookbook_files_with_cksums) do
+    # Entries must be sorted lexically.
+    {
+      "README.md" => "0f15038071e5a131bef176cbe2a956d1",
+      "chefignore" => "03485640b005eb1083c76518764053dd",
+      "kitchen.yml" => "85ba09a085dab072722cb197e04fa805",
+      "metadata.rb" => "4879d0004b177546cfbcfb2fd26df7c8",
+      "recipes/default.rb" => "9a0f27d741deaca21461073f7452474f",
+    }
+  end
+
+  it "has the cookbook's semver version" do
+    expect(identifiers.semver_version).to eq("1.0.0")
+  end
+
+  it "lists the cookbook's files" do
+    cookbook_files_with_cksums.each do |path, cksum|
+      expect(identifiers.cookbook_files).to have_key(path)
+      expect(identifiers.cookbook_files[path]["checksum"]).to eq(cksum)
+    end
+  end
+
+  it "generates a sorted list of the cookbook's files with checksums" do
+    # Verify that the keys are sorted in our expected data, otherwise our test
+    # is wrong.
+    expect(cookbook_files_with_cksums.keys).to eq(cookbook_files_with_cksums.keys.sort)
+    expected = cookbook_files_with_cksums.map { |path, cksum| "#{path}:#{cksum}\n" }.join("")
+    expect(identifiers.fingerprint_text).to eq(expected)
+  end
+
+  it "generates a Hash of the cookbook's content" do
+    expect(identifiers.content_identifier).to eq("f24326bbf81d67fcab6a5615c75092d1c6da81cc")
+  end
+
+  it "generates a dotted decimal representation of the content hash" do
+    expect(identifiers.dotted_decimal_identifier).to eq("68190778005396839.71120167330236240.161429682029004")
+  end
+
+end

data/spec/unit/fixtures/chef-runner-cookbooks/test_cookbook/recipes/recipe_one.rb

@@ -0,0 +1,9 @@
+TestHelpers.test_state[:loaded_recipes] ||= []
+TestHelpers.test_state[:loaded_recipes] << "recipe_one"
+
+ruby_block "record_test_result_one" do
+  block do
+    TestHelpers.test_state[:converged_recipes] ||= []
+    TestHelpers.test_state[:converged_recipes] << "recipe_one"
+  end
+end

data/spec/unit/fixtures/chef-runner-cookbooks/test_cookbook/recipes/recipe_two.rb

@@ -0,0 +1,9 @@
+TestHelpers.test_state[:loaded_recipes] ||= []
+TestHelpers.test_state[:loaded_recipes] << "recipe_two"
+
+ruby_block "record_test_result_two" do
+  block do
+    TestHelpers.test_state[:converged_recipes] ||= []
+    TestHelpers.test_state[:converged_recipes] << "recipe_two"
+  end
+end

data/spec/unit/fixtures/command/cli_test_command.rb

@@ -0,0 +1,26 @@
+require "chef-cli/command/base"
+
+module ChefCLI
+  module Command
+    class TestCommand < ChefCLI::Command::Base
+
+      def self.reset!
+        @test_result = nil
+      end
+
+      def self.test_result
+        @test_result
+      end
+
+      def self.test_result=(result)
+        @test_result = result
+      end
+
+      def run(params)
+        self.class.test_result = { status: :success, params: params }
+        23
+      end
+
+    end
+  end
+end