Class: Berkshelf::Downloader

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/berkshelf/downloader.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(berksfile) ⇒ Downloader

Returns a new instance of Downloader.

Parameters:



15
16
17
 
# File 'lib/berkshelf/downloader.rb', line 15

def initialize(berksfile)
  @berksfile = berksfile
end

Instance Attribute Details

#berksfile ⇒ Object (readonly)

Returns the value of attribute berksfile.



10
11
12
 
# File 'lib/berkshelf/downloader.rb', line 10

def berksfile
  @berksfile
end

Instance Method Details

#download(*args, &block) ⇒ String

Download the given Berkshelf::Dependency. If the optional block is given, the temporary path to the cookbook is yielded and automatically deleted when the block returns. If no block is given, it is the responsibility of the caller to remove the tmpdir.

Parameters:

  • name (String)
  • version (String)
  • options (Hash) —

    a customizable set of options

Returns:

Raises:



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/berkshelf/downloader.rb', line 36

def download(*args, &block)
  # options are ignored
  # options = args.last.is_a?(Hash) ? args.pop : Hash.new
  dependency, version = args

  sources.each do |source|
    if ( result = try_download(source, dependency, version) )
      if block_given?
        value = yield result
        FileUtils.rm_rf(result)
        return value
      end

      return result
    end
  end

  raise CookbookNotFound.new(dependency, version, "in any of the sources")
end

#ssl_policy ⇒ Object 



19
20
21
 
# File 'lib/berkshelf/downloader.rb', line 19

def ssl_policy
  @ssl_policy ||= SSLPolicy.new
end

#try_download(source, name, version) ⇒ String

Parameters:

Returns:



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# 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"

    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
    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