Module: TestLab::Container::IO

Included in:
TestLab::Container
Defined in:
lib/testlab/container/io.rb

Constant Summary collapse

PBZIP2_MEMORY = 
1024
READ_SIZE = 
((64 * 1024) - 1)
TRANSFER_MESSAGE = 
"%s '%s' at %0.2fMB/s -- %0.2fMB of %0.2fMB -- %d%% (%01d:%02dT-%01d:%02d)   \r"

Instance Method Summary collapse

Instance Method Details

#copy(target_name) ⇒ Boolean

Copy the container

Duplicates this container under another container definition.

Returns:

  • (Boolean) —

    True if successful.



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
 
# File 'lib/testlab/container/io.rb', line 180

def copy(target_name)
  @ui.logger.debug { "Container Copy: #{self.id}" }

  target_name.nil? and raise ContainerError, "You must supply a destination container!"

  target_container = self.node.containers.select{ |c| c.id.to_sym == target_name.to_sym }.first
  target_container.nil? and raise ContainerError, "We could not locate the target container!"

  source_state = self.state
  target_state = target_container.state

  target_container.demolish
  target_container.create

  self.down
  please_wait(:ui => @ui, :message => format_object_action(self, 'Copy', :yellow)) do
    self.node.exec(%(sudo rm -rf #{target_container.lxc.fs_root}))
    self.node.exec(%(sudo rsync -a #{self.lxc.fs_root} #{target_container.lxc.container_root}))
    self.node.exec(%(sudo rm -fv #{File.join(self.lxc.fs_root, '.*provision')}))
  end

  # bring the source container back online if it was running before the copy operation
  (source_state == :running) and self.up

  # bring the target container back online if it was running before the copy operation
  (target_state == :running) and target_container.up

  true
end

#export(compression = 9, local_file = nil) ⇒ Boolean

Export the container

Returns:

  • (Boolean) —

    True if successful.



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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/testlab/container/io.rb', line 60

def export(compression=9, local_file=nil)
  @ui.logger.debug { "Container Export: #{self.id} " }

  self.node.alive? or return false

  (self.state == :not_created) and raise ContainerError, 'You must create a container before you can export it!'

  # Throw an exception if we are attempting to export a container in a
  # ephemeral state.
  self.lxc_clone.exists? and raise ContainerError, 'You can not export ephemeral containers!'

  # Run our callbacks
  do_provisioner_callbacks(self, :export, @ui)

  # Ensure the container is stopped before we attempt to export it.
  self.down

  self.lxc.execute(%(/bin/bash -c 'apt-get -qy autoremove'))
  self.lxc.execute(%(/bin/bash -c 'apt-get -qy clean'))

  export_tempfile = Tempfile.new('export')
  remote_filename = File.basename(export_tempfile.path.dup)
  export_tempfile.close!

  remote_file  = File.join("", "tmp", remote_filename)
  local_file ||= File.join(Dir.pwd, "#{self.id}.sc")
  local_file   = File.expand_path(local_file)
  root_fs_path = self.lxc.fs_root.split(File::SEPARATOR).last

  please_wait(:ui => @ui, :message => format_object_action(self, 'Compress', :cyan)) do
    self.node.bootstrap(<<-EOSCRIPT)
      du -sh #{self.lxc.container_root}
      cd #{self.lxc.container_root}
      find #{root_fs_path} -depth -print0 | cpio -o0 | pbzip2 -#{compression} -vfczm#{PBZIP2_MEMORY} > #{remote_file}
      chown ${SUDO_USER}:${SUDO_USER} #{remote_file}
      ls -lah #{remote_file}
    EOSCRIPT
  end

  File.exists?(local_file) and FileUtils.rm_f(local_file)

  @total_size = self.node.ssh.sftp.stat!(remote_file).size

  self.node.download(remote_file, local_file, :on_progress => method(:progress_callback), :read_size => READ_SIZE, :use_scp => true)

  self.node.bootstrap(<<-EOSCRIPT)
    rm -fv #{remote_file}
  EOSCRIPT

  @ui.stdout.puts(format_message("Your shipping container is now exported and available at '#{local_file}'!".green.bold))

  true
end

#import(local_file = nil) ⇒ Boolean

Import the container

Returns:

  • (Boolean) —

    True if successful.



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
 
# File 'lib/testlab/container/io.rb', line 117

def import(local_file=nil)
  @ui.logger.debug { "Container Import: #{self.id}" }

  self.node.alive? or return false

  import_tempfile = Tempfile.new('import')
  remote_filename = File.basename(import_tempfile.path.dup)
  import_tempfile.close!

  remote_file  = File.join("", "tmp", remote_filename)
  local_file ||= File.join(Dir.pwd, "#{self.id}.sc")
  local_file   = File.expand_path(local_file)
  root_fs_path = self.lxc.fs_root.split(File::SEPARATOR).last

  @ui.logger.debug { "Local File: #{local_file.inspect}" }

  if !File.exists?(local_file)
    self.sc_url.nil? and raise ContainerError, "You failed to supply a filename or URL to import from!"

    @ui.stdout.puts(format_message("Downloading shipping container for #{self.id}...".green.bold))

    sc_download(local_file, self.sc_url, 16)
  end

  # Ensure we are not in ephemeral mode.
  self.persistent

  (self.state == :running) and self.down
  self.exists? and self.destroy

  self.create

  self.node.exec(%(sudo rm -fv #{remote_file}), :silence => true, :ignore_exit_status => true)
  self.node.upload(local_file, remote_file, :on_progress => method(:progress_callback), :read_size => READ_SIZE, :use_scp => true)

  please_wait(:ui => @ui, :message => format_object_action(self, 'Expand', :cyan)) do
    self.node.bootstrap(<<-EOF)
ls -lah #{remote_file}
rm -rf #{self.lxc.fs_root}
cd #{self.lxc.container_root}
pbzip2 -vdcm#{PBZIP2_MEMORY} #{remote_file} | cpio -uid && rm -fv #{remote_file}
du -sh #{self.lxc.container_root}
rm -fv #{remote_file}
EOF
  end

  self.up

  # Run our callbacks
  please_wait(:ui => @ui, :message => format_object_action(self, 'import', :cyan)) do
    do_provisioner_callbacks(self, :import, @ui)
  end

  @ui.stdout.puts(format_message("Your shipping container is now imported and available for use!".green.bold))

  true
end

#progress_callback(action, args) ⇒ Object 



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/testlab/container/io.rb', line 33

def progress_callback(action, args)
  @total_size ||= 0

  case action
  when :open then
    @start_time ||= Time.now
    if (@total_size == 0)
      @total_size = args[0].size
    end

  when :get, :put then
    elapsed      = (Time.now - @start_time)
    current_size = (args[1] + args[2].length)
    message      = ((action == :get) ? 'downloading to local host from' : 'uploading from local host to')

    transfer_message(%(#{message} TestLab node #{self.node.id.inspect}:), args[0].local, current_size, @total_size, elapsed)

  when :finish
    @ui.stdout.puts
    @total_size = 0

  end
end

#sc_download(local_file, url, count) ⇒ Boolean

Downloads a given shipping container image

Returns:

  • (Boolean) —

    True if successful.



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/testlab/container/io.rb', line 213

def sc_download(local_file, url, count)
  (count <= 0) and raise ContainerError, "Too many redirects, aborting!"

  uri        = URI(url)
  http       = Net::HTTP.new(uri.host, uri.port)

  if (uri.scheme.downcase == 'https')
    http.use_ssl = true
    http.verify_mode = OpenSSL::SSL::VERIFY_NONE  # lets be really permissive for now
  end

  http.request_get(uri.path) do |response|
    case response
    when Net::HTTPNotFound then
      raise ContainerError, "The supplied sc_url for this container was 404 Not Found!"

    when Net::HTTPClientError then
      raise ContainerError, "Client Error: #{response.inspect}"

    when Net::HTTPRedirection then
      location = response['location']
      @ui.stdout.puts(format_message("REDIRECT: #{url} --> #{location}".white))
      return sc_download(local_file, location, (count - 1))

    when Net::HTTPOK then
      tempfile = Tempfile.new(%(download-#{self.id}))
      tempfile.binmode

      current_size = 0
      total_size   = response['content-length'].to_i
      start_time   = Time.now

      response.read_body do |chunk|
        tempfile << chunk

        elapsed  = (Time.now - start_time)
        current_size += chunk.size

        transfer_message(%(downloading locally:), local_file, current_size, total_size, elapsed)
      end
      @ui.stdout.puts

      tempfile.close

      FileUtils.mkdir_p(File.dirname(local_file))
      File.exists?(local_file) and File.unlink(local_file)
      FileUtils.mv(tempfile.path, local_file, :force => true)

      true
    else
      raise ContainerError, "Unknown HTTP response when attempt to download your shipping container!"
    end
  end

end

#transfer_message(what, filename, current_size, total_size, elapsed) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/testlab/container/io.rb', line 13

def transfer_message(what, filename, current_size, total_size, elapsed)
  total_size_mb   = (total_size.to_f / (1024 * 1024).to_f)
  current_size_mb = (current_size.to_f / (1024 * 1024).to_f)

  speed    = (current_size.to_f / elapsed.to_f)
  speed    = total_size.to_f if (speed == 0.0)
  speed_mb = speed.to_f / (1024 * 1024).to_f

  minutes = elapsed.div(60)
  seconds = elapsed.modulo(60)

  estimated   = ((total_size.to_f - current_size.to_f) / speed.to_f)
  est_minutes = estimated.div(60)
  est_seconds = estimated.modulo(60)

  percentage_done = ((current_size * 100) / total_size)

  @ui.stdout.print(format_message(TRANSFER_MESSAGE.yellow % [what, File.basename(filename), speed_mb, current_size_mb, total_size_mb, percentage_done, minutes, seconds, est_minutes, est_seconds]))
end