chef-cli 1.0.3

data/lib/chef-cli/cookbook_metadata.rb

@@ -0,0 +1,45 @@
+#
+# 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_relative "exceptions"
+require "chef/cookbook/metadata"
+
+module ChefCLI
+
+  # Subclass of Chef's Cookbook::Metadata class that provides the API expected
+  # by CookbookOmnifetch
+  class CookbookMetadata < Chef::Cookbook::Metadata
+
+    def self.from_path(path)
+      metadata_json_path = File.join(path, "metadata.json")
+      metadata_rb_path = File.join(path, "metadata.rb")
+
+      if File.exist?(metadata_json_path)
+        new.tap { |m| m.from_json(File.read(metadata_json_path)) }
+      elsif File.exist?(metadata_rb_path)
+        new.tap { |m| m.from_file(metadata_rb_path) }
+      else
+        raise MalformedCookbook, "Cookbook at #{path} has neither metadata.json or metadata.rb"
+      end
+    end
+
+    def cookbook_name
+      name
+    end
+
+  end
+end

data/lib/chef-cli/cookbook_omnifetch.rb

@@ -0,0 +1,32 @@
+#
+# 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 "cookbook-omnifetch"
+require_relative "shell_out"
+require_relative "cookbook_metadata"
+require_relative "helpers"
+
+require "chef/http/simple"
+
+# Configure CookbookOmnifetch's dependency injection settings to use our classes and config.
+CookbookOmnifetch.configure do |c|
+  c.cache_path = File.expand_path(File.join(ChefCLI::Helpers.package_home, "cache"))
+  c.storage_path = Pathname.new(File.expand_path(File.join(ChefCLI::Helpers.package_home, "cache", "cookbooks")))
+  c.shell_out_class = ChefCLI::ShellOut
+  c.cached_cookbook_class = ChefCLI::CookbookMetadata
+  c.chef_server_download_concurrency = 10
+end

data/lib/chef-cli/cookbook_profiler/git.rb

@@ -0,0 +1,152 @@
+#
+# 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_relative "../helpers"
+
+module ChefCLI
+  module CookbookProfiler
+    class Git
+
+      include Helpers
+
+      attr_reader :cookbook_path
+
+      def initialize(cookbook_path)
+        @cookbook_path = cookbook_path
+        @unborn_branch = nil
+        @unborn_branch_ref = nil
+      end
+
+      # @return [Hash] Hashed used for pinning cookbook versions within a Policfile.lock
+      def profile_data
+        {
+          "scm" => "git",
+          # To get this info, you need to do something like:
+          # figure out branch or assume 'master'
+          # git config --get branch.master.remote
+          # git config --get remote.opscode.url
+          "remote" => remote,
+          "revision" => revision,
+          "working_tree_clean" => clean?,
+          "published" => !unpublished_commits?,
+          "synchronized_remote_branches" => synchronized_remotes,
+        }
+      end
+
+      def revision
+        git!("rev-parse HEAD").stdout.strip
+      rescue Mixlib::ShellOut::ShellCommandFailed => e
+        # We may have an "unborn" branch, i.e. one with no commits.
+        if unborn_branch_ref
+          nil
+        else
+          # if we got here, but verify_ref_cmd didn't error, we don't know why
+          # the original git command failed, so re-raise.
+          raise e
+        end
+      end
+
+      def clean?
+        git!("diff-files --quiet", returns: [0, 1]).exitstatus == 0
+      end
+
+      def unpublished_commits?
+        synchronized_remotes.empty?
+      end
+
+      def synchronized_remotes
+        @synchronized_remotes ||= git!("branch -r --contains #{revision}").stdout.lines.map(&:strip)
+      rescue Mixlib::ShellOut::ShellCommandFailed => e
+        # We may have an "unborn" branch, i.e. one with no commits.
+        if unborn_branch_ref
+          []
+        else
+          # if we got here, but verify_ref_cmd didn't error, we don't know why
+          # the original git command failed, so re-raise.
+          raise e
+        end
+      end
+
+      def remote
+        @remote_url ||=
+          if have_remote?
+            git!("config --get remote.#{remote_name}.url").stdout.strip
+          else
+            nil
+          end
+      end
+
+      def remote_name
+        @remote_name ||= git!("config --get branch.#{current_branch}.remote", returns: [0, 1]).stdout.strip
+      end
+
+      def have_remote?
+        !remote_name.empty? && remote_name != "."
+      end
+
+      def current_branch
+        @current_branch ||= detect_current_branch
+      end
+
+      private
+
+      def git!(subcommand, options = {})
+        cmd = git(subcommand, options)
+        cmd.error!
+        cmd
+      end
+
+      def git(subcommand, options = {})
+        options = { cwd: cookbook_path }.merge(options)
+        system_command("git #{subcommand}", options)
+      end
+
+      def detect_current_branch
+        branch = git!("rev-parse --abbrev-ref HEAD").stdout.strip
+        @unborn_branch = false
+        branch
+      rescue Mixlib::ShellOut::ShellCommandFailed => e
+        # We may have an "unborn" branch, i.e. one with no commits.
+        if unborn_branch_ref
+          unborn_branch_ref
+        else
+          # if we got here, but verify_ref_cmd didn't error, we don't know why
+          # the original git command failed, so re-raise.
+          raise e
+        end
+      end
+
+      def unborn_branch_ref
+        @unborn_branch_ref ||=
+          begin
+            strict_branch_ref = git!("symbolic-ref -q HEAD").stdout.strip
+            verify_ref_cmd = git("show-ref --verify #{strict_branch_ref}")
+            if verify_ref_cmd.error?
+              @unborn_branch = true
+              strict_branch_ref
+            else
+              # if we got here, but verify_ref_cmd didn't error, then `git
+              # rev-parse` is probably failing for a reason we haven't anticipated.
+              # Calling code should detect this and re-raise.
+              nil
+            end
+          end
+      end
+
+    end
+  end
+end

data/lib/chef-cli/cookbook_profiler/identifiers.rb

@@ -0,0 +1,72 @@
+#
+# 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.
+#
+
+# TODO: Chef should require its dependency correctly.
+require "singleton" unless defined?(Singleton)
+require "chef/cookbook/cookbook_version_loader"
+require "digest/sha1"
+
+require "chef/digester"
+
+require_relative "../exceptions"
+
+module ChefCLI
+  module CookbookProfiler
+    class Identifiers
+
+      attr_reader :cookbook_version
+
+      def initialize(cookbook_version)
+        @cookbook_version = cookbook_version
+      end
+
+      def semver_version
+        cookbook_version.version
+      end
+
+      def content_identifier
+        Digest::SHA1.new.hexdigest(fingerprint_text)
+      end
+
+      def dotted_decimal_identifier
+        hex_id = content_identifier
+        major = hex_id[0...14]
+        minor = hex_id[14...28]
+        patch = hex_id[28..40]
+        decimal_integers = [major, minor, patch].map { |hex| hex.to_i(16) }
+        decimal_integers.join(".")
+      end
+
+      def fingerprint_text
+        files_with_checksums.sort_by { |a| a[0] }.inject("") do |fingerprint, file_spec|
+          fingerprint << "#{file_spec[0]}:#{file_spec[1]}\n"
+        end
+      end
+
+      def files_with_checksums
+        cookbook_files.inject([]) do |files_with_checksums, (_name, file_info)|
+          files_with_checksums << [file_info["path"], file_info["checksum"]]
+        end
+      end
+
+      def cookbook_files
+        @files ||= cookbook_version.manifest_records_by_path
+      end
+
+    end
+  end
+end

data/lib/chef-cli/cookbook_profiler/null_scm.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.
+#
+
+module ChefCLI
+  module CookbookProfiler
+    class NullSCM
+
+      def initialize(cookbook_path)
+      end
+
+      def profile_data
+        nil
+      end
+
+    end
+  end
+end

data/lib/chef-cli/dist.rb

@@ -0,0 +1,31 @@
+module ChefCLI
+  class Dist
+    # This class is not fully implemented, depending on it is not recommended!
+
+    # The full marketing name of the product
+    PRODUCT = "Chef Workstation".freeze
+
+    # the name of the overall infra product
+    INFRA_PRODUCT = "Chef Infra".freeze
+
+    # name of the Infra client product
+    INFRA_CLIENT_PRODUCT = "Chef Infra Client".freeze
+
+    # The client's alias (chef-client)
+    INFRA_CLIENT_CLI = "chef-client".freeze
+
+    INSPEC_PRODUCT = "Chef InSpec".freeze
+    INSPEC_CLI = "inspec".freeze
+
+    # The name of the server product
+    SERVER_PRODUCT = "Chef Infra Server".freeze
+
+    WORKFLOW = "Chef Workflow (Delivery)".freeze
+
+    # The chef executable, as in `chef gem install` or `chef generate cookbook`
+    EXEC = "chef".freeze
+
+    # Chef-Zero's product name
+    ZERO_PRODUCT = "Chef Infra Zero".freeze
+  end
+end

data/lib/chef-cli/exceptions.rb

@@ -0,0 +1,153 @@
+#
+# Copyright:: Copyright (c) 2014-2019 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.
+#
+
+module ChefCLI
+
+  class CachedCookbookNotFound < StandardError
+  end
+
+  class LocalCookbookNotFound < StandardError
+  end
+
+  class MalformedCookbook < StandardError
+  end
+
+  class DependencyConflict < StandardError
+  end
+
+  class CookbookNotInWorkingSet < DependencyConflict
+  end
+
+  class InvalidCookbookLockData < StandardError
+  end
+
+  class CachedCookbookModified < StandardError
+  end
+
+  class CookbookDoesNotContainRequiredRecipe < StandardError
+  end
+
+  class InvalidPolicyfileAttribute < StandardError
+  end
+
+  class MissingComponentError < RuntimeError
+    def initialize(component_name, reason)
+      super("Component #{component_name} is missing.\nReason: #{reason}")
+    end
+  end
+
+  class OmnibusInstallNotFound < RuntimeError
+    require_relative "dist"
+
+    def initialize
+      super("Can not find omnibus installation directory for #{ChefCLI::Dist::PRODUCT}.")
+    end
+  end
+
+  class UnsupportedFeature < StandardError
+  end
+
+  class PolicyfileError < StandardError
+  end
+
+  class InvalidPolicyfileSourceURI < StandardError
+    def initialize(url, reason = nil)
+      @url    = url
+      @reason = reason
+      msg     = "'#{@url}' is not a valid Policyfile Source URI"
+      msg << " #{@reason}." unless @reason.nil?
+      super(msg)
+    end
+  end
+
+  class MissingCookbookLockData < StandardError
+  end
+
+  class InvalidLockfile < StandardError
+  end
+
+  class InvalidPolicyfileFilename < StandardError
+  end
+
+  class InvalidUndoRecord < StandardError
+  end
+
+  class CantUndo < StandardError
+  end
+
+  class UndoRecordNotFound < StandardError
+  end
+
+  class MultipleErrors < StandardError
+  end
+
+  class BUG < RuntimeError
+  end
+
+  class IncludePolicyCookbookSourceConflict < StandardError
+  end
+
+  class CookbookSourceConflict < StandardError
+
+    attr_reader :conflicting_cookbooks
+
+    attr_reader :cookbook_sources
+
+    def initialize(conflicting_cookbooks, cookbook_sources)
+      @conflicting_cookbooks = conflicting_cookbooks
+      @cookbook_sources      = cookbook_sources
+      super(compute_message)
+    end
+
+    private
+
+    def compute_message
+      conflicting_cookbook_sets = cookbook_sources.combination(2).map do |source_a, source_b|
+        overlapping_cookbooks = conflicting_cookbooks.select do |cookbook_name|
+          source_a.universe_graph.key?(cookbook_name) && source_b.universe_graph.key?(cookbook_name)
+        end
+        "Source #{source_a.desc} and #{source_b.desc} contain conflicting cookbooks:\n" +
+          overlapping_cookbooks.sort.map { |c| "- #{c}" }.join("\n") + "\n\n" +
+          resolution_message(overlapping_cookbooks)
+      end
+      conflicting_cookbook_sets.join("\n")
+    end
+
+    def resolution_message(overlapping_cookbooks)
+      example_source       = cookbook_sources.first
+      source_key, location = example_source.default_source_args
+      <<~EXAMPLE
+        You can set a preferred source to resolve this issue with code like:
+
+        default_source :#{source_key}, "#{location}" do |s|
+          s.preferred_for "#{overlapping_cookbooks.join('", "')}"
+        end
+      EXAMPLE
+    end
+
+  end
+
+  class PolicyfileLockDownloadError < StandardError
+  end
+
+  class LocalPolicyfileLockNotFound < StandardError
+  end
+
+  class InvalidPolicyfileLocation < StandardError
+  end
+
+end