Rakefile

   1 # -*- coding: utf-8 -*-
   2 # -*- mode: ruby -*-
   3 # vi: set ft=ruby :
   4 #
   5 # Tails: The Amnesic Incognito Live System
   6 # Copyright © 2012 Tails developers <tails@boum.org>
   7 #
   8 # This program is free software: you can redistribute it and/or modify
   9 # it under the terms of the GNU General Public License as published by
  10 # the Free Software Foundation, either version 3 of the License, or
  11 # (at your option) any later version.
  12 #
  13 # This program is distributed in the hope that it will be useful,
  14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 # GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License
  19 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20
  21 require 'date'
  22 require 'libvirt'
  23 require 'open3'
  24 require 'rbconfig'
  25 require 'uri'
  26
  27 require_relative 'vagrant/lib/tails_build_settings'
  28
  29 # Path to the directory which holds our Vagrantfile
  30 VAGRANT_PATH = File.expand_path('../vagrant', __FILE__)
  31
  32 # Branches that are considered 'stable' (used to select SquashFS compression)
  33 STABLE_BRANCH_NAMES = ['stable', 'testing']
  34
  35 EXPORTED_VARIABLES = [
  36   'MKSQUASHFS_OPTIONS',
  37   'APT_SNAPSHOTS_SERIALS',
  38   'TAILS_BUILD_FAILURE_RESCUE',
  39   'TAILS_DATE_OFFSET',
  40   'TAILS_MERGE_BASE_BRANCH',
  41   'TAILS_OFFLINE_MODE',
  42   'TAILS_PROXY',
  43   'TAILS_PROXY_TYPE',
  44   'TAILS_RAM_BUILD',
  45   'GIT_COMMIT',
  46   'GIT_REF',
  47   'BASE_BRANCH_GIT_COMMIT',
  48 ]
  49 ENV['EXPORTED_VARIABLES'] = EXPORTED_VARIABLES.join(' ')
  50
  51 EXTERNAL_HTTP_PROXY = ENV['http_proxy']
  52
  53 # In-VM proxy URL
  54 INTERNAL_HTTP_PROXY = "http://#{VIRTUAL_MACHINE_HOSTNAME}:3142"
  55
  56 ENV['ARTIFACTS'] ||= '.'
  57
  58 ENV['APT_SNAPSHOTS_SERIALS'] ||= ''
  59
  60 class CommandError < StandardError
  61   attr_reader :status, :stderr
  62
  63   def initialize(message = nil, opts = {})
  64     opts[:status] ||= nil
  65     opts[:stderr] ||= nil
  66     @status = opts[:status]
  67     @stderr = opts[:stderr]
  68     super(message % {status: @status, stderr: @stderr})
  69   end
  70 end
  71
  72 def run_command(*args)
  73   Process.wait Kernel.spawn(*args)
  74   if $?.exitstatus != 0
  75     raise CommandError.new("command #{args} failed with exit status " +
  76                            "%{status}", status: $?.exitstatus)
  77   end
  78 end
  79
  80 def capture_command(*args)
  81   stdout, stderr, proc_status = Open3.capture3(*args)
  82   if proc_status.exitstatus != 0
  83     raise CommandError.new("command #{args} failed with exit status " +
  84                            "%{status}: %{stderr}",
  85                            stderr: stderr, status: proc_status.exitstatus)
  86   end
  87   return stdout, stderr
  88 end
  89
  90 def git_helper(*args)
  91   question = args.first.end_with?('?')
  92   args.first.sub!(/\?$/, '')
  93   status = 0
  94   stdout = ''
  95   begin
  96     stdout, _ = capture_command('auto/scripts/utils.sh', *args)
  97   rescue CommandError => e
  98     status = e.status
  99   end
 100   if question
 101     return status == 0
 102   else
 103     return stdout.chomp
 104   end
 105 end
 106
 107 class VagrantCommandError < CommandError
 108 end
 109
 110 # Runs the vagrant command, letting stdout/stderr through. Throws an
 111 # exception unless the vagrant command succeeds.
 112 def run_vagrant(*args)
 113   run_command('vagrant', *args, :chdir => './vagrant')
 114 rescue CommandError => e
 115   raise(VagrantCommandError, "'vagrant #{args}' command failed with exit " +
 116                              "status #{e.status}")
 117 end
 118
 119 # Runs the vagrant command, not letting stdout/stderr through, and
 120 # returns [stdout, stderr, Preocess:Status].
 121 def capture_vagrant(*args)
 122   capture_command('vagrant', *args, :chdir => './vagrant')
 123 rescue CommandError => e
 124   raise(VagrantCommandError, "'vagrant #{args}' command failed with exit " +
 125                              "status #{e.status}: #{e.stderr}")
 126 end
 127
 128 [:run_vagrant, :capture_vagrant].each do |m|
 129   define_method "#{m}_ssh" do |*args|
 130     method(m).call('ssh', '-c', *args, '--', '-q')
 131   end
 132 end
 133
 134 def vagrant_ssh_config(key)
 135   # Cache results
 136   if $vagrant_ssh_config.nil?
 137     $vagrant_ssh_config = capture_vagrant('ssh-config').first.split("\n") \
 138                            .map { |line| line.strip.split(/\s+/, 2) } .to_h
 139     # The path in the ssh-config output is quoted, which is not what
 140     # is expected outside of a shell, so let's get rid of the quotes.
 141     $vagrant_ssh_config['IdentityFile'].gsub!(/^"|"$/, '')
 142   end
 143   $vagrant_ssh_config[key]
 144 end
 145
 146 def current_vm_cpus
 147   capture_vagrant_ssh('grep -c "^processor\s*:" /proc/cpuinfo').first.chomp.to_i
 148 end
 149
 150 def vm_state
 151   out, _ = capture_vagrant('status')
 152   status_line = out.split("\n")[2]
 153   if    status_line['not created']
 154     return :not_created
 155   elsif status_line['shutoff']
 156     return :poweroff
 157   elsif status_line['running']
 158     return :running
 159   else
 160     raise "could not determine VM state"
 161   end
 162 end
 163
 164 def enough_free_host_memory_for_ram_build?
 165   return false unless RbConfig::CONFIG['host_os'] =~ /linux/i
 166
 167   begin
 168     usable_free_mem = `free`.split[12].to_i
 169     usable_free_mem > VM_MEMORY_FOR_RAM_BUILDS * 1024
 170   rescue
 171     false
 172   end
 173 end
 174
 175 def free_vm_memory
 176   capture_vagrant_ssh('free').first.chomp.split[12].to_i
 177 end
 178
 179 def enough_free_vm_memory_for_ram_build?
 180   free_vm_memory > BUILD_SPACE_REQUIREMENT * 1024
 181 end
 182
 183 def enough_free_memory_for_ram_build?
 184   if vm_state == :running
 185     enough_free_vm_memory_for_ram_build?
 186   else
 187     enough_free_host_memory_for_ram_build?
 188   end
 189 end
 190
 191 def is_release?
 192   git_helper('git_on_a_tag?')
 193 end
 194
 195 def system_cpus
 196   return nil unless RbConfig::CONFIG['host_os'] =~ /linux/i
 197
 198   begin
 199     File.read('/proc/cpuinfo').scan(/^processor\s+:/).count
 200   rescue
 201     nil
 202   end
 203 end
 204
 205 task :parse_build_options do
 206   options = []
 207
 208   # Default to in-memory builds if there is enough RAM available
 209   options << 'ram' if enough_free_memory_for_ram_build?
 210
 211   # Default to build using the in-VM proxy
 212   options << 'vmproxy'
 213
 214   # Default to fast compression on development branches
 215   options << 'gzipcomp' unless is_release?
 216
 217   # Default to the number of system CPUs when we can figure it out
 218   cpus = system_cpus
 219   options << "cpus=#{cpus}" if cpus
 220
 221   options += ENV['TAILS_BUILD_OPTIONS'].split if ENV['TAILS_BUILD_OPTIONS']
 222
 223   options.uniq.each do |opt|
 224     case opt
 225     # Memory build settings
 226     when 'ram'
 227       ENV['TAILS_RAM_BUILD'] = '1'
 228     when 'noram'
 229       ENV['TAILS_RAM_BUILD'] = nil
 230     # Bootstrap cache settings
 231     # HTTP proxy settings
 232     when 'extproxy'
 233       abort "No HTTP proxy set, but one is required by TAILS_BUILD_OPTIONS. Aborting." unless EXTERNAL_HTTP_PROXY
 234       ENV['TAILS_PROXY'] = EXTERNAL_HTTP_PROXY
 235       ENV['TAILS_PROXY_TYPE'] = 'extproxy'
 236     when 'vmproxy'
 237       ENV['TAILS_PROXY'] = INTERNAL_HTTP_PROXY
 238       ENV['TAILS_PROXY_TYPE'] = 'vmproxy'
 239     when 'noproxy'
 240       ENV['TAILS_PROXY'] = nil
 241       ENV['TAILS_PROXY_TYPE'] = 'noproxy'
 242     when 'offline'
 243       ENV['TAILS_OFFLINE_MODE'] = '1'
 244     # SquashFS compression settings
 245     when 'gzipcomp'
 246       ENV['MKSQUASHFS_OPTIONS'] = '-comp gzip -Xcompression-level 1'
 247       if is_release?
 248         raise 'We must use the default compression when building releases!'
 249       end
 250     when 'defaultcomp'
 251       ENV['MKSQUASHFS_OPTIONS'] = nil
 252     # Virtual hardware settings
 253     when /machinetype=([a-zA-Z0-9_.-]+)/
 254       ENV['TAILS_BUILD_MACHINE_TYPE'] = $1
 255     when /cpus=(\d+)/
 256       ENV['TAILS_BUILD_CPUS'] = $1
 257     when /cpumodel=([a-zA-Z0-9_-]+)/
 258       ENV['TAILS_BUILD_CPU_MODEL'] = $1
 259     # Git settings
 260     when 'ignorechanges'
 261       ENV['TAILS_BUILD_IGNORE_CHANGES'] = '1'
 262     when /dateoffset=([-+]\d+)/
 263       ENV['TAILS_DATE_OFFSET'] = $1
 264     # Developer convenience features
 265     when 'keeprunning'
 266       $keep_running = true
 267       $force_cleanup = false
 268     when 'forcecleanup'
 269       $force_cleanup = true
 270       $keep_running = false
 271     when 'rescue'
 272       $keep_running = true
 273       ENV['TAILS_BUILD_FAILURE_RESCUE'] = '1'
 274     # Jenkins
 275     when 'mergebasebranch'
 276       ENV['TAILS_MERGE_BASE_BRANCH'] = '1'
 277     else
 278       raise "Unknown Tails build option '#{opt}'"
 279     end
 280   end
 281
 282   if ENV['TAILS_OFFLINE_MODE'] == '1'
 283     if ENV['TAILS_PROXY'].nil?
 284       abort "You must use a caching proxy when building offline"
 285     end
 286   end
 287 end
 288
 289 task :ensure_clean_repository do
 290   git_status = `git status --porcelain`
 291   unless git_status.empty?
 292     if ENV['TAILS_BUILD_IGNORE_CHANGES']
 293       $stderr.puts <<-END_OF_MESSAGE.gsub(/^        /, '')
 294
 295         You have uncommitted changes in the Git repository. They will
 296         be ignored for the upcoming build:
 297         #{git_status}
 298
 299       END_OF_MESSAGE
 300     else
 301       $stderr.puts <<-END_OF_MESSAGE.gsub(/^        /, '')
 302
 303         You have uncommitted changes in the Git repository. Due to limitations
 304         of the build system, you need to commit them before building Tails:
 305         #{git_status}
 306
 307         If you don't care about those changes and want to build Tails nonetheless,
 308         please add `ignorechanges` to the TAILS_BUILD_OPTIONS environment
 309         variable.
 310
 311       END_OF_MESSAGE
 312       abort 'Uncommitted changes. Aborting.'
 313     end
 314   end
 315 end
 316
 317 def list_artifacts
 318   user = vagrant_ssh_config('User')
 319   stdout = capture_vagrant_ssh("find '/home/#{user}/amnesia/' -maxdepth 1 " +
 320                                         "-name 'tails-amd64-*' " +
 321                                         "-o -name tails-build-env.list").first
 322   stdout.split("\n")
 323 rescue VagrantCommandError
 324   return Array.new
 325 end
 326
 327 def remove_artifacts
 328   list_artifacts.each do |artifact|
 329     run_vagrant_ssh("sudo rm -f '#{artifact}'")
 330   end
 331 end
 332
 333 task :ensure_clean_home_directory => ['vm:up'] do
 334   remove_artifacts
 335 end
 336
 337 task :validate_http_proxy do
 338   if ENV['TAILS_PROXY']
 339     proxy_host = URI.parse(ENV['TAILS_PROXY']).host
 340
 341     if proxy_host.nil?
 342       ENV['TAILS_PROXY'] = nil
 343       $stderr.puts "Ignoring invalid HTTP proxy."
 344       return
 345     end
 346
 347     if ['localhost', '[::1]'].include?(proxy_host) || proxy_host.start_with?('127.0.0.')
 348       abort 'Using an HTTP proxy listening on the loopback is doomed to fail. Aborting.'
 349     end
 350
 351     $stderr.puts "Using HTTP proxy: #{ENV['TAILS_PROXY']}"
 352   else
 353     $stderr.puts "No HTTP proxy set."
 354   end
 355 end
 356
 357 task :validate_git_state do
 358   if git_helper('git_in_detached_head?') && not(git_helper('git_on_a_tag?'))
 359     raise 'We are in detached head but the current commit is not tagged'
 360   end
 361 end
 362
 363 task :setup_environment => ['validate_git_state'] do
 364   ENV['GIT_COMMIT'] ||= git_helper('git_current_commit')
 365   ENV['GIT_REF'] ||= git_helper('git_current_head_name')
 366   if on_jenkins?
 367     jenkins_branch = (ENV['GIT_BRANCH'] || '').sub(/^origin\//, '')
 368     if not(is_release?) && jenkins_branch != ENV['GIT_REF']
 369       raise "We expected to build the Git ref '#{ENV['GIT_REF']}', but GIT_REF in the environment says '#{jenkins_branch}'. Aborting!"
 370     end
 371   end
 372
 373   ENV['BASE_BRANCH_GIT_COMMIT'] = git_helper('git_base_branch_head')
 374   ['GIT_COMMIT', 'GIT_REF', 'BASE_BRANCH_GIT_COMMIT'].each do |var|
 375     if ENV[var].empty?
 376       raise "Variable '#{var}' is empty, which should not be possible: " +
 377             "either validate_git_state is buggy or the 'origin' remote " +
 378             "does not point to the official Tails Git repository."
 379     end
 380   end
 381 end
 382
 383 task :maybe_clean_up_builder_vms do
 384   clean_up_builder_vms if $force_cleanup
 385 end
 386
 387 desc 'Build Tails'
 388 task :build => ['parse_build_options', 'ensure_clean_repository', 'maybe_clean_up_builder_vms', 'validate_git_state', 'setup_environment', 'validate_http_proxy', 'vm:up', 'ensure_clean_home_directory'] do
 389
 390   begin
 391     if ENV['TAILS_RAM_BUILD'] && not(enough_free_memory_for_ram_build?)
 392       $stderr.puts <<-END_OF_MESSAGE.gsub(/^        /, '')
 393
 394         The virtual machine is not currently set with enough memory to
 395         perform an in-memory build. Either remove the `ram` option from
 396         the TAILS_BUILD_OPTIONS environment variable, or shut the
 397         virtual machine down using `rake vm:halt` before trying again.
 398
 399       END_OF_MESSAGE
 400       abort 'Not enough memory for the virtual machine to run an in-memory build. Aborting.'
 401     end
 402
 403     if ENV['TAILS_BUILD_CPUS'] && current_vm_cpus != ENV['TAILS_BUILD_CPUS'].to_i
 404       $stderr.puts <<-END_OF_MESSAGE.gsub(/^        /, '')
 405
 406         The virtual machine is currently running with #{current_vm_cpus}
 407         virtual CPU(s). In order to change that number, you need to
 408         stop the VM first, using `rake vm:halt`. Otherwise, please
 409         adjust the `cpus` options accordingly.
 410
 411       END_OF_MESSAGE
 412       abort 'The virtual machine needs to be reloaded to change the number of CPUs. Aborting.'
 413     end
 414
 415     exported_env = EXPORTED_VARIABLES.select { |k| ENV[k] }.
 416                    collect { |k| "#{k}='#{ENV[k]}'" }.join(' ')
 417     run_vagrant_ssh("#{exported_env} build-tails")
 418
 419     artifacts = list_artifacts
 420     raise 'No build artifacts were found!' if artifacts.empty?
 421     user     = vagrant_ssh_config('User')
 422     hostname = vagrant_ssh_config('HostName')
 423     key_file = vagrant_ssh_config('IdentityFile')
 424     $stderr.puts "Retrieving artifacts from Vagrant build box."
 425     run_vagrant_ssh(
 426       "sudo chown #{user} " + artifacts.map { |a| "'#{a}'" } .join(' ')
 427     )
 428     fetch_command = [
 429       'scp',
 430       '-i', key_file,
 431       # We need this since the user will not necessarily have a
 432       # known_hosts entry. It is safe since an attacker must
 433       # compromise libvirt's network config or the user running the
 434       # command to modify the #{hostname} below.
 435       '-o', 'StrictHostKeyChecking=no',
 436       '-o', 'UserKnownHostsFile=/dev/null',
 437     ]
 438     fetch_command += artifacts.map { |a| "#{user}@#{hostname}:#{a}" }
 439     fetch_command << ENV['ARTIFACTS']
 440     run_command(*fetch_command)
 441     clean_up_builder_vms unless $keep_running
 442   ensure
 443     clean_up_builder_vms if $force_cleanup
 444   end
 445 end
 446
 447 def has_box?
 448   not(capture_vagrant('box', 'list').grep(/^#{box_name}\s+\(libvirt,/).empty?)
 449 end
 450
 451 def domain_name
 452   "#{box_name}_default"
 453 end
 454
 455 def clean_up_builder_vms
 456   $virt = Libvirt::open("qemu:///system")
 457
 458   clean_up_domain = Proc.new do |domain|
 459     next if domain.nil?
 460     domain.destroy if domain.active?
 461     domain.undefine
 462     begin
 463       $virt
 464         .lookup_storage_pool_by_name('default')
 465         .lookup_volume_by_name("#{domain.name}.img")
 466         .delete
 467     rescue Libvirt::RetrieveError
 468       # Expected if the pool or disk does not exist
 469     end
 470   end
 471
 472   # Let's ensure that the VM we are about to create is cleaned up ...
 473   previous_domain = $virt.list_all_domains.find { |d| d.name == domain_name }
 474   if previous_domain && previous_domain.active?
 475     begin
 476       run_vagrant_ssh("mountpoint -q /var/cache/apt-cacher-ng")
 477     rescue VagrantCommandError
 478     # Nothing to unmount.
 479     else
 480       run_vagrant_ssh("sudo systemctl stop apt-cacher-ng.service")
 481       run_vagrant_ssh("sudo umount /var/cache/apt-cacher-ng")
 482       run_vagrant_ssh("sudo sync")
 483     end
 484   end
 485   clean_up_domain.call(previous_domain)
 486
 487   # ... and the same for any residual VM based on another box (=>
 488   # another domain name) that Vagrant still keeps track of.
 489   old_domain =
 490     begin
 491       old_domain_uuid =
 492         open('vagrant/.vagrant/machines/default/libvirt/id', 'r') { |f| f.read }
 493         .strip
 494       $virt.lookup_domain_by_uuid(old_domain_uuid)
 495     rescue Errno::ENOENT, Libvirt::RetrieveError
 496       # Expected if we don't have vagrant/.vagrant, or if the VM was
 497       # undefined for other reasons (e.g. manually).
 498       nil
 499     end
 500   clean_up_domain.call(old_domain)
 501
 502   # We could use `vagrant destroy` here but due to vagrant-libvirt's
 503   # upstream issue #746 we then risk losing the apt-cacher-ng data.
 504   # Since we essentially implement `vagrant destroy` without this bug
 505   # above, but in a way so it works even if `vagrant/.vagrant` does
 506   # not exist, let's just do what is safest, i.e. avoiding `vagrant
 507   # destroy`. For details, see the upstream issue:
 508   #   https://github.com/vagrant-libvirt/vagrant-libvirt/issues/746
 509   FileUtils.rm_rf('vagrant/.vagrant')
 510 ensure
 511   $virt.close
 512 end
 513
 514 desc "Remove all libvirt volumes named tails-builder-* (run at your own risk!)"
 515 task :clean_up_libvirt_volumes do
 516   $virt = Libvirt::open("qemu:///system")
 517   begin
 518     pool = $virt.lookup_storage_pool_by_name('default')
 519   rescue Libvirt::RetrieveError
 520     # Expected if the pool does not exist
 521   else
 522     for disk in pool.list_volumes do
 523       if /^tails-builder-/.match(disk)
 524         begin
 525           pool.lookup_volume_by_name(disk).delete
 526         rescue Libvirt::RetrieveError
 527           # Expected if the disk does not exist
 528         end
 529       end
 530     end
 531   ensure
 532     $virt.close
 533   end
 534 end
 535
 536 def on_jenkins?
 537   !!ENV['JENKINS_URL']
 538 end
 539
 540 desc 'Test Tails'
 541 task :test do
 542   args = ARGV.drop_while { |x| x == 'test' || x == '--' }
 543   if on_jenkins?
 544     args += ['--'] unless args.include? '--'
 545     if not(is_release?)
 546       args += ['--tag', '~@fragile']
 547     end
 548     base_branch = git_helper('base_branch')
 549     if git_helper('git_only_doc_changes_since?', "origin/#{base_branch}") then
 550       args += ['--tag', '@doc']
 551     end
 552   end
 553   run_command('./run_test_suite', *args)
 554 end
 555
 556 desc 'Clean up all build related files'
 557 task :clean_all => ['vm:destroy', 'basebox:clean_all']
 558
 559 namespace :vm do
 560   desc 'Start the build virtual machine'
 561   task :up => ['parse_build_options', 'validate_http_proxy', 'setup_environment', 'basebox:create'] do
 562     case vm_state
 563     when :not_created
 564       clean_up_builder_vms
 565     end
 566     begin
 567       run_vagrant('up')
 568     rescue VagrantCommandError => e
 569       clean_up_builder_vms if $force_cleanup
 570       raise e
 571     end
 572   end
 573
 574   desc 'SSH into the builder VM'
 575   task :ssh do
 576     run_vagrant('ssh')
 577   end
 578
 579   desc 'Stop the build virtual machine'
 580   task :halt do
 581     run_vagrant('halt')
 582   end
 583
 584   desc 'Re-run virtual machine setup'
 585   task :provision => ['parse_build_options', 'validate_http_proxy', 'setup_environment'] do
 586     run_vagrant('provision')
 587   end
 588
 589   desc "Destroy build virtual machine (clean up all files except the vmproxy's apt-cacher-ng data)"
 590   task :destroy do
 591     clean_up_builder_vms
 592   end
 593 end
 594
 595 namespace :basebox do
 596
 597   desc 'Create and import the base box unless already done'
 598   task :create do
 599     next if has_box?
 600     $stderr.puts <<-END_OF_MESSAGE.gsub(/^      /, '')
 601
 602       This is the first time we are using this Vagrant base box so we
 603       will have to bootstrap by building it from scratch. This will
 604       take around 20 minutes (depending on your hardware) plus the
 605       time needed for downloading around 250 MiB of Debian packages.
 606
 607     END_OF_MESSAGE
 608     box_dir = VAGRANT_PATH + '/definitions/tails-builder'
 609     run_command("#{box_dir}/generate-tails-builder-box.sh")
 610     # Let's use an absolute path since run_vagrant changes the working
 611     # directory but File.delete doesn't
 612     box_path = "#{box_dir}/#{box_name}.box"
 613     run_vagrant('box', 'add', '--name', box_name, box_path)
 614     File.delete(box_path)
 615     end
 616
 617   def basebox_date(box)
 618     Date.parse(/^tails-builder-[^-]+-[^-]+-(\d{8})/.match(box)[1])
 619   end
 620
 621   def baseboxes
 622     capture_vagrant('box', 'list').first.lines
 623       .grep(/^tails-builder-.*/)
 624       .map { |x| x.chomp.sub(/\s.*$/, '') }
 625   end
 626
 627   def clean_up_basebox(box)
 628     run_vagrant('box', 'remove', '--force', box)
 629     begin
 630       $virt = Libvirt::open("qemu:///system")
 631       $virt
 632         .lookup_storage_pool_by_name('default')
 633         .lookup_volume_by_name("#{box}_vagrant_box_image_0.img")
 634         .delete
 635     rescue Libvirt::RetrieveError
 636       # Expected if the pool or disk does not exist
 637     ensure
 638       $virt.close
 639     end
 640   end
 641
 642   desc 'Remove all base boxes'
 643   task :clean_all do
 644     baseboxes.each { |box| clean_up_basebox(box) }
 645   end
 646
 647   desc 'Remove all base boxes older than six months'
 648   task :clean_old do
 649     boxes = baseboxes
 650     # We always want to keep the newest basebox
 651     boxes.sort! { |a, b| basebox_date(a) <=> basebox_date(b) }
 652     boxes.pop
 653     boxes.each do |box|
 654       if basebox_date(box) < Date.today - 365.0/2.0
 655         clean_up_basebox(box)
 656       end
 657     end
 658   end
 659 end