108 lines
3.1 KiB
Ruby
108 lines
3.1 KiB
Ruby
require 'fileutils'
|
|
|
|
require 'archive/tar/minitar'
|
|
require "json"
|
|
require "log4r"
|
|
|
|
require "vagrant/util/platform"
|
|
|
|
module Vagrant
|
|
# Represents a "box," which is a package Vagrant environment that is used
|
|
# as a base image when creating a new guest machine.
|
|
class Box
|
|
include Comparable
|
|
|
|
# The box name. This is the logical name used when adding the box.
|
|
#
|
|
# @return [String]
|
|
attr_reader :name
|
|
|
|
# This is the provider that this box is built for.
|
|
#
|
|
# @return [Symbol]
|
|
attr_reader :provider
|
|
|
|
# This is the directory on disk where this box exists.
|
|
#
|
|
# @return [Pathname]
|
|
attr_reader :directory
|
|
|
|
# This is the metadata for the box. This is read from the "metadata.json"
|
|
# file that all boxes require.
|
|
#
|
|
# @return [Hash]
|
|
attr_reader :metadata
|
|
|
|
# This is used to initialize a box.
|
|
#
|
|
# @param [String] name Logical name of the box.
|
|
# @param [Symbol] provider The provider that this box implements.
|
|
# @param [Pathname] directory The directory where this box exists on
|
|
# disk.
|
|
def initialize(name, provider, directory)
|
|
@name = name
|
|
@provider = provider
|
|
@directory = directory
|
|
@metadata = JSON.parse(directory.join("metadata.json").read)
|
|
|
|
@logger = Log4r::Logger.new("vagrant::box")
|
|
end
|
|
|
|
# This deletes the box. This is NOT undoable.
|
|
def destroy!
|
|
# Delete the directory to delete the box.
|
|
FileUtils.rm_r(@directory)
|
|
|
|
# Just return true always
|
|
true
|
|
rescue Errno::ENOENT
|
|
# This means the directory didn't exist. Not a problem.
|
|
return true
|
|
end
|
|
|
|
# This repackages this box and outputs it to the given path.
|
|
#
|
|
# @param [Pathname] path The full path (filename included) of where
|
|
# to output this box.
|
|
# @return [Boolean] true if this succeeds.
|
|
def repackage(path)
|
|
@logger.debug("Repackaging box '#{@name}' to: #{path}")
|
|
|
|
path.open(Util::Platform.tar_file_options) do |f|
|
|
Archive::Tar::Minitar::Output.open(f) do |output|
|
|
# Store the current working directory since we need to change
|
|
# for the tar library.
|
|
current_dir = FileUtils.pwd
|
|
|
|
begin
|
|
FileUtils.cd(@directory)
|
|
|
|
# Find all the files in our current directory and tar it up!
|
|
Dir.glob(File.join(".", "**", "*")).each do |entry|
|
|
@logger.debug("Packing file: #{entry}")
|
|
Archive::Tar::Minitar.pack_file(entry, output)
|
|
end
|
|
ensure
|
|
# Make sure we always cd back into our previous working
|
|
# directory.
|
|
FileUtils.cd(current_dir)
|
|
end
|
|
end
|
|
end
|
|
|
|
@logger.info("Repackaged box '#{@name}' successfully: #{path}")
|
|
|
|
true
|
|
end
|
|
|
|
# Implemented for comparison with other boxes. Comparison is
|
|
# implemented by comparing names and providers.
|
|
def <=>(other)
|
|
return super if !other.is_a?(self.class)
|
|
|
|
# Comparison is done by composing the name and provider
|
|
"#{@name}-#{@provider}" <=> "#{other.name}-#{other.provider}"
|
|
end
|
|
end
|
|
end
|