Module: Docker::Util

Includes:
Error
Defined in:
lib/docker/util.rb

Overview

This module holds shared logic that doesn't really belong anywhere else in the gem.

Constant Summary collapse

GLOB_WILDCARDS =
/[\?\*\[\{\]\}]/

Class Method Summary collapse

Class Method Details

.add_file_to_tar(tar, name, mode, size, mtime) {|os| ... } ⇒ Object

Yields:

  • (os)

191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
# File 'lib/docker/util.rb', line 191

def add_file_to_tar(tar, name, mode, size, mtime)
  tar.check_closed

  io = tar.instance_variable_get(:@io)

  name, prefix = tar.split_name(name)

  header = Gem::Package::TarHeader.new(:name => name, :mode => mode,
                                       :size => size, :prefix => prefix,
                                       :mtime => mtime).to_s

  io.write header
  os = Gem::Package::TarWriter::BoundedStream.new io, size

  yield os if block_given?

  min_padding = size - os.written
  io.write("\0" * min_padding)

  remainder = (512 - (size % 512)) % 512
  io.write("\0" * remainder)

  tar
end

.attach_for(block, msg_stack, tty = false) ⇒ Object

Attaches to a HTTP stream

Parameters:


18
19
20
21
22
23
24
25
# File 'lib/docker/util.rb', line 18

def attach_for(block, msg_stack, tty = false)
  # If TTY is enabled expect raw data and append to stdout
  if tty
    attach_for_tty(block, msg_stack)
  else
    attach_for_multiplex(block, msg_stack)
  end
end

.attach_for_multiplex(block, msg_stack) ⇒ Object


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

def attach_for_multiplex(block, msg_stack)
  messages = Docker::Messages.new
  lambda do |c,r,t|
    messages = messages.decipher_messages(c)

    unless block.nil?
      messages.stdout_messages.each do |msg|
        block.call(:stdout, msg)
      end
      messages.stderr_messages.each do |msg|
        block.call(:stderr, msg)
      end
    end

    msg_stack.append(messages)
  end
end

.attach_for_tty(block, msg_stack) ⇒ Object


27
28
29
30
31
32
33
34
35
36
# File 'lib/docker/util.rb', line 27

def attach_for_tty(block, msg_stack)
  messages = Docker::Messages.new
  lambda do |c,r,t|
    messages.stdout_messages << c
    messages.all_messages << c
    msg_stack.append(messages)

    block.call c if block
  end
end

.build_auth_header(credentials) ⇒ Object


261
262
263
264
265
266
267
# File 'lib/docker/util.rb', line 261

def build_auth_header(credentials)
  credentials = MultiJson.dump(credentials) if credentials.is_a?(Hash)
  encoded_creds = Base64.urlsafe_encode64(credentials)
  {
    'X-Registry-Auth' => encoded_creds
  }
end

.build_config_header(credentials) ⇒ Object


269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
# File 'lib/docker/util.rb', line 269

def build_config_header(credentials)
  if credentials.is_a?(String)
    credentials = MultiJson.load(credentials, symbolize_keys: true)
  end

  header = MultiJson.dump(
    credentials[:serveraddress].to_s => {
      'username' => credentials[:username].to_s,
      'password' => credentials[:password].to_s,
      'email' => credentials[:email].to_s
    }
  )

  encoded_header = Base64.urlsafe_encode64(header)

  {
    'X-Registry-Config' => encoded_header
  }
end

.close_write(socket) ⇒ Object


96
97
98
99
100
101
102
103
104
# File 'lib/docker/util.rb', line 96

def close_write(socket)
  if socket.respond_to?(:close_write)
    socket.close_write
  elsif socket.respond_to?(:io)
    socket.io.close_write
  else
    raise IOError, 'Cannot close socket'
  end
end

.create_dir_tar(directory) ⇒ Object


138
139
140
141
142
143
144
145
# File 'lib/docker/util.rb', line 138

def create_dir_tar(directory)
  tempfile = create_temp_file
  directory += '/' unless directory.end_with?('/')

  create_relative_dir_tar(directory, tempfile)

  File.new(tempfile.path, 'r')
end

.create_relative_dir_tar(directory, output) ⇒ Object


173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
# File 'lib/docker/util.rb', line 173

def create_relative_dir_tar(directory, output)
  Gem::Package::TarWriter.new(output) do |tar|
    files = docker_context(directory)

    files.each do |prefixed_file_name|
      stat = File.stat(prefixed_file_name)
      next unless stat.file?

      unprefixed_file_name = prefixed_file_name[directory.length..-1]
      add_file_to_tar(
        tar, unprefixed_file_name, stat.mode, stat.size, stat.mtime
      ) do |tar_file|
        IO.copy_stream(File.open(prefixed_file_name, 'rb'), tar_file)
      end
    end
  end
end

.create_tar(hash = {}) ⇒ Object


124
125
126
127
128
129
130
131
132
133
134
135
136
# File 'lib/docker/util.rb', line 124

def create_tar(hash = {})
  output = StringIO.new
  Gem::Package::TarWriter.new(output) do |tar|
    hash.each do |file_name, file_details|
      permissions = file_details.is_a?(Hash) ? file_details[:permissions] : 0640
      tar.add_file(file_name, permissions) do |tar_file|
        content = file_details.is_a?(Hash) ? file_details[:content] : file_details
        tar_file.write(content)
      end
    end
  end
  output.tap(&:rewind).string
end

.create_temp_fileObject


216
217
218
219
# File 'lib/docker/util.rb', line 216

def create_temp_file
  tempfile_name = Dir::Tmpname.create('out') {}
  File.open(tempfile_name, 'wb+')
end

.debug(msg) ⇒ Object


56
57
58
# File 'lib/docker/util.rb', line 56

def debug(msg)
  Docker.logger.debug(msg) if Docker.logger
end

.docker_context(directory) ⇒ Object

return the set of files that form the docker context implement this logic docs.docker.com/engine/reference/builder/#dockerignore-file


150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
# File 'lib/docker/util.rb', line 150

def docker_context(directory)
  all_files = glob_all_files(File.join(directory, "**/*"))
  dockerignore = File.join(directory, '.dockerignore')
  return all_files unless all_files.include?(dockerignore)

  # Iterate over valid lines, starting with the initial glob as working set
  File
    .read(dockerignore)                # https://docs.docker.com/engine/reference/builder/#dockerignore-file
    .each_line                         # "a newline-separated list of patterns"
    .map(&:strip)                      # "A preprocessing step removes leading and trailing whitespace"
    .reject(&:empty?)                  # "Lines that are blank after preprocessing are ignored"
    .reject { |p| p.start_with?('#') } # "if [a line starts with `#`], then this line is considered as a comment"
    .each_with_object(Set.new(all_files)) do |p, working_set|
      # determine the pattern (p) and whether it is to be added or removed from context
      add = p.start_with?("!")
      # strip leading "!" from pattern p, then prepend the base directory
      matches = dockerignore_compatible_glob(File.join(directory, add ? p[1..-1] : p))
      # add or remove the matched items as indicated in the ignore file
      add ? working_set.merge(matches) : working_set.replace(working_set.difference(matches))
    end
  .to_a
end

.dockerignore_compatible_glob(pattern) ⇒ Object

do a directory glob that matches .dockerignore behavior specifically: matched directories are considered a recursive match


291
292
293
294
295
296
297
298
299
300
301
# File 'lib/docker/util.rb', line 291

def dockerignore_compatible_glob(pattern)
  begin
    some_dirs, some_files = glob_all_files(pattern).partition { |f| File.directory?(f) }
    # since all directories will be re-processed with a /**/* glob, we can preemptively
    # eliminate any whose parent directory is already in this set.  This saves significant time.
    some_files + some_dirs.reject { |d| some_dirs.any? { |pd| d.start_with?(pd) && d != pd } }
  end.each_with_object(Set.new) do |f, acc|
    # expand any directories by globbing; flatten results
    acc.merge(File.directory?(f) ? glob_all_files("#{f}/**/*") : [f])
  end
end

.extract_id(body) ⇒ Object


221
222
223
224
225
226
227
228
# File 'lib/docker/util.rb', line 221

def extract_id(body)
  body.lines.reverse_each do |line|
    if (id = line.match(/Successfully built ([a-f0-9]+)/)) && !id[1].empty?
      return id[1]
    end
  end
  raise UnexpectedResponseError, "Couldn't find id: #{body}"
end

.file_hash_from_paths(local_paths) ⇒ Object

Convenience method to get the file hash corresponding to an array of local paths.


232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
# File 'lib/docker/util.rb', line 232

def file_hash_from_paths(local_paths)
  local_paths.each_with_object({}) do |local_path, file_hash|
    unless File.exist?(local_path)
      raise ArgumentError, "#{local_path} does not exist."
    end

    basename = File.basename(local_path)
    if File.directory?(local_path)
      tar = create_dir_tar(local_path)
      file_hash[basename] = {
        content: tar.read,
        permissions: filesystem_permissions(local_path)
      }
      tar.close
      FileUtils.rm(tar.path)
    else
      file_hash[basename] = {
        content: File.read(local_path, mode: 'rb'),
        permissions: filesystem_permissions(local_path)
      }
    end
  end
end

.filesystem_permissions(path) ⇒ Object


256
257
258
259
# File 'lib/docker/util.rb', line 256

def filesystem_permissions(path)
  mode = sprintf("%o", File.stat(path).mode)
  mode[(mode.length - 3)...mode.length].to_i(8)
end

.fix_json(body) ⇒ Object


120
121
122
# File 'lib/docker/util.rb', line 120

def fix_json(body)
  parse_json("[#{body.gsub(/}\s*{/, '},{')}]")
end

.glob_all_files(pattern) ⇒ Object


303
304
305
306
# File 'lib/docker/util.rb', line 303

def glob_all_files(pattern)
  # globs of "a_dir/**/*" can return "a_dir/.", so explicitly reject those
  (Dir.glob(pattern, File::FNM_DOTMATCH) - ['..', '.']).reject { |p| p.end_with?("/.") }
end

.hijack_for(stdin, block, msg_stack, tty) ⇒ Object


60
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
# File 'lib/docker/util.rb', line 60

def hijack_for(stdin, block, msg_stack, tty)
  attach_block = attach_for(block, msg_stack, tty)

  lambda do |socket|
    debug "hijack: hijacking the HTTP socket"
    threads = []

    debug "hijack: starting stdin copy thread"
    threads << Thread.start do
      debug "hijack: copying stdin => socket"
      IO.copy_stream stdin, socket

      debug "hijack: closing write end of hijacked socket"
      close_write(socket)
    end

    debug "hijack: starting hijacked socket read thread"
    threads << Thread.start do
      debug "hijack: reading from hijacked socket"

      begin
        while chunk = socket.readpartial(512)
          debug "hijack: got #{chunk.bytesize} bytes from hijacked socket"
          attach_block.call chunk, nil, nil
        end
      rescue EOFError
      end

      debug "hijack: killing stdin copy thread"
      threads.first.kill
    end

    threads.each(&:join)
  end
end

.parse_json(body) ⇒ Object


106
107
108
109
110
# File 'lib/docker/util.rb', line 106

def parse_json(body)
  MultiJson.load(body) unless body.nil? || body.empty? || (body == 'null')
rescue MultiJson::ParseError => ex
  raise UnexpectedResponseError, ex.message
end

.parse_repo_tag(str) ⇒ Object


112
113
114
115
116
117
118
# File 'lib/docker/util.rb', line 112

def parse_repo_tag(str)
  if match = str.match(/\A(.*):([^:]*)\z/)
    match.captures
  else
    [str, '']
  end
end