Method: Berkshelf::Downloader#try_download

Defined in:

lib/berkshelf/downloader.rb

#try_download(source, name, version) ⇒ String

Parameters:

• source (Berkshelf::Source)
• name (String)
• version (String)

Returns:

• (String)

# File 'lib/berkshelf/downloader.rb', line 61

def try_download(source, name, version)
  unless ( remote_cookbook = source.cookbook(name, version) )
    return nil
  end

  case remote_cookbook.location_type
  when :opscode, :supermarket
    options = { ssl: source.options[:ssl] }
    if source.type == :artifactory
      options[:headers] = { "X-Jfrog-Art-Api" => source.options[:api_key] }
    end

    # Allow Berkshelf install to function if a relative url exists in location_path
    path = URI.parse(remote_cookbook.location_path).absolute? ? remote_cookbook.location_path : "#{source.uri_string}#{remote_cookbook.location_path}"

    CommunityREST.new(path, options).download(name, version)
  when :chef_server
    tmp_dir      = Dir.mktmpdir
    unpack_dir   = Pathname.new(tmp_dir) + "#{name}-#{version}"
    # @todo Dynamically get credentials for remote_cookbook.location_path
    credentials = {
      server_url: remote_cookbook.location_path,
      client_name: source.options[:client_name] || Berkshelf::Config.instance.chef.node_name,
      client_key: source.options[:client_key] || Berkshelf::Config.instance.chef.client_key,
      ssl: source.options[:ssl],
    }
    RidleyCompat.new_client(**credentials) do |conn|
      cookbook = Chef::CookbookVersion.load(name, version)
      manifest = cookbook.cookbook_manifest
      manifest.by_parent_directory.each do |segment, files|
        files.each do |segment_file|
          dest = File.join(unpack_dir, segment_file["path"].gsub("/", File::SEPARATOR))
          FileUtils.mkdir_p(File.dirname(dest))
          tempfile = conn.streaming_request(segment_file["url"])
          FileUtils.mv(tempfile.path, dest)
        end
      end
    end
    unpack_dir
  when :github
    require "octokit"

    tmp_dir      = Dir.mktmpdir
    archive_path = File.join(tmp_dir, "#{name}-#{version}.tar.gz")
    unpack_dir   = File.join(tmp_dir, "#{name}-#{version}")

    # Find the correct github connection options for this specific cookbook.
    cookbook_uri = URI.parse(remote_cookbook.location_path)
    if cookbook_uri.host == "github.com"
      options = Berkshelf::Config.instance.github.detect { |opts| opts["web_endpoint"].nil? }
      options = {} if options.nil?
    else
      options = Berkshelf::Config.instance.github.detect { |opts| opts["web_endpoint"] == "#{cookbook_uri.scheme}://#{cookbook_uri.host}" }
      raise ConfigurationError.new "Missing github endpoint configuration for #{cookbook_uri.scheme}://#{cookbook_uri.host}" if options.nil?
    end

    github_client = Octokit::Client.new(
      access_token: options["access_token"],
      api_endpoint: options["api_endpoint"], web_endpoint: options["web_endpoint"],
      connection_options: { ssl: { verify: options["ssl_verify"].nil? ? true : options["ssl_verify"] } }
    )

    begin
      url = URI(github_client.archive_link(cookbook_uri.path.gsub(%r{^/}, ""), ref: "v#{version}"))
    rescue Octokit::Unauthorized
      return nil
    end

    # We use Net::HTTP.new and then get here, because Net::HTTP.get does not support proxy settings.
    http = Net::HTTP.new(url.host, url.port)
    http.use_ssl = url.scheme == "https"
    http.verify_mode = (options["ssl_verify"].nil? || options["ssl_verify"]) ? OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
    resp = http.get(url.request_uri)
    return nil unless resp.is_a?(Net::HTTPSuccess)

    open(archive_path, "wb") { |file| file.write(resp.body) }

    Mixlib::Archive.new(archive_path).extract(unpack_dir)

    # we need to figure out where the cookbook is located in the archive. This is because the directory name
    # pattern is not cosistant between private and public github repositories
    cookbook_directory = Dir.entries(unpack_dir).select do |f|
      (! f.start_with?(".")) && (Pathname.new(File.join(unpack_dir, f)).cookbook?)
    end[0]

    File.join(unpack_dir, cookbook_directory)
  when :uri
    require "open-uri" unless defined?(OpenURI)

    tmp_dir      = Dir.mktmpdir
    archive_path = Pathname.new(tmp_dir) + "#{name}-#{version}.tar.gz"
    unpack_dir   = Pathname.new(tmp_dir) + "#{name}-#{version}"

    url = remote_cookbook.location_path
    URI.open(url, "rb") do |remote_file|
      archive_path.open("wb") { |local_file| local_file.write remote_file.read }
    end

    Mixlib::Archive.new(archive_path).extract(unpack_dir)

    # The top level directory is inconsistant. So we unpack it and
    # use the only directory created in the unpack_dir.
    cookbook_directory = unpack_dir.entries.select do |filename|
      (! filename.to_s.start_with?(".")) && (unpack_dir + filename).cookbook?
    end.first

    (unpack_dir + cookbook_directory).to_s
  when :gitlab
    tmp_dir      = Dir.mktmpdir
    archive_path = Pathname.new(tmp_dir) + "#{name}-#{version}.tar.gz"
    unpack_dir   = Pathname.new(tmp_dir) + "#{name}-#{version}"

    # Find the correct gitlab connection options for this specific cookbook.
    cookbook_uri = URI.parse(remote_cookbook.location_path)
    if cookbook_uri.host
      options = Berkshelf::Config.instance.gitlab.detect { |opts| opts["web_endpoint"] == "#{cookbook_uri.scheme}://#{cookbook_uri.host}" }
      raise ConfigurationError.new "Missing github endpoint configuration for #{cookbook_uri.scheme}://#{cookbook_uri.host}" if options.nil?
    end

    connection ||= Faraday.new(url: options["web_endpoint"]) do |faraday|
      faraday.headers[:accept] = "application/x-tar"
      faraday.response :logger, @logger unless @logger.nil?
      faraday.adapter  Faraday.default_adapter # make requests with Net::HTTP
    end

    resp = connection.get(cookbook_uri.request_uri + "&private_token=" + options["private_token"])
    return nil unless resp.status == 200

    open(archive_path, "wb") { |file| file.write(resp.body) }

    Mixlib::Archive.new(archive_path).extract(unpack_dir)

    # The top level directory is inconsistant. So we unpack it and
    # use the only directory created in the unpack_dir.
    cookbook_directory = unpack_dir.entries.select do |filename|
      (! filename.to_s.start_with?(".")) && (unpack_dir + filename).cookbook?
    end.first

    (unpack_dir + cookbook_directory).to_s
  when :file_store
    tmp_dir = Dir.mktmpdir
    FileUtils.cp_r(remote_cookbook.location_path, tmp_dir)
    File.join(tmp_dir, name)
  else
    raise "unknown location type #{remote_cookbook.location_type}"
  end
rescue CookbookNotFound
  nil
end