beckermj/vaguerent
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Adjust internal layout to allow downgrading

Browse Source 
With the initial layout of `provider/architecture`, after installing a
box with architecture support downgrading Vagrant would result in it
being unable to process the box collection. Swapping the layout to be
`architecture/provider` allows downgrades to still properly process the
box collection.
This commit is contained in:
Chris Roberts 2023-09-25 10:51:36 -07:00
parent 3ea1beca9e
commit c8a7989b88
4 changed files with 91 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
lib/vagrant/action/builtin/box_add.rb
View File

@ -338,7 +338,7 @@ module Vagrant
env,
checksum: metadata_provider.checksum,
checksum_type: metadata_provider.checksum_type,
architecture: architecture,
architecture: metadata_provider.architecture,
)
end
@ -420,7 +420,7 @@ module Vagrant
force: env[:box_force],
metadata_url: md_url,
providers: provider,
architecture: env[:box_architecture]
architecture: opts[:architecture]
)
ensure
# Make sure we delete the temporary file after we add it,

132
lib/vagrant/box_collection.rb
View File

@ -170,28 +170,26 @@ module Vagrant
@logger.debug("Box directory: #{box_dir}")
# This is the final directory we'll move it to
provider_dir = box_dir.join(provider.to_s)
final_dir = provider_dir
@logger.debug("Provider directory: #{provider_dir}")
# If architecture is set, unpack into architecture specific directory
if architecture
arch = architecture
arch = Util::Platform.architecture if architecture == :auto
final_dir = provider_dir.join(arch)
box_dir = box_dir.join(arch)
end
provider_dir = box_dir.join(provider.to_s)
@logger.debug("Provider directory: #{provider_dir}")
if final_dir.exist?
if provider_dir.exist?
@logger.debug("Removing existing provider directory...")
final_dir.rmtree
provider_dir.rmtree
end
# Move to final destination
final_dir.mkpath
provider_dir.mkpath
# Recursively move individual files from the temporary directory
# to the final location. We do this instead of moving the entire
# directory to avoid issues on Windows. [GH-1424]
copy_pairs = [[final_temp_dir, final_dir]]
copy_pairs = [[final_temp_dir, provider_dir]]
while !copy_pairs.empty?
from, to = copy_pairs.shift
from.children(true).each do |f|
@ -248,34 +246,52 @@ module Vagrant
next if versiondir.basename.to_s.start_with?(".")
version = versiondir.basename.to_s
# Ensure version of box is correct before continuing
if !Gem::Version.correct?(version)
ui = Vagrant::UI::Prefixed.new(Vagrant::UI::Colored.new, "vagrant")
ui.warn(I18n.t("vagrant.box_version_malformed",
version: version, box_name: box_name))
@logger.debug("Invalid version #{version} for box #{box_name}")
next
end
versiondir.children(true).each do |provider|
# Ensure version of box is correct before continuing
if !Gem::Version.correct?(version)
ui = Vagrant::UI::Prefixed.new(Vagrant::UI::Colored.new, "vagrant")
ui.warn(I18n.t("vagrant.box_version_malformed",
version: version, box_name: box_name))
@logger.debug("Invalid version #{version} for box #{box_name}")
versiondir.children(true).each do |architecture_or_provider|
# If the entry is not a directory, it is invalid and should be ignored
if !architecture_or_provider.directory?
@logger.debug("Invalid box #{box_name} (v#{version}) - invalid item: #{architecture_or_provider}")
next
end
# Verify this is a potentially valid box. If it looks
# correct enough then include it.
if provider.directory? && provider.join("metadata.json").file?
provider_name = provider.basename.to_s.to_sym
# Now the directory can be assumed to be the architecture
architecture_name = architecture_or_provider.basename.to_s.to_sym
# Cycle through directories to find providers
architecture_or_provider.children(true).each do |provider|
if !provider.directory?
@logger.debug("Invalid box #{box_name} (v#{version}, #{architecture_name}) - invalid item: #{provider}")
next
end
# If the entry contains a metadata file, add it
if provider.join("metadata.json").file?
provider_name = provider.basename.to_s.to_sym
@logger.debug("Box: #{box_name} (#{provider_name} (#{architecture_name}), #{version})")
results << [box_name, version, provider_name, architecture_name]
end
end
# If the base entry contains a metadata file, then it was
# added prior to architecture support and is a provider directory.
# If it contains a metadata file, include it with the results only
# if an entry hasn't already been included for the local system's
# architecture
if architecture_or_provider.join("metadata.json").file?
provider_name = architecture_or_provider.basename.to_s.to_sym
if results.include?([box_name, version, provider_name, Util::Platform.architecture.to_sym])
next
end
@logger.debug("Box: #{box_name} (#{provider_name}, #{version})")
results << [box_name, version, provider_name, nil]
elsif provider.directory?
provider.children(true).each do |architecture|
provider_name = provider.basename.to_s.to_sym
if architecture.directory? && architecture.join("metadata.json").file?
architecture_name = architecture.basename.to_s.to_sym
@logger.debug("Box: #{box_name} (#{provider_name} (#{architecture_name}), #{version})")
results << [box_name, version, provider_name, architecture_name]
end
end
else
@logger.debug("Invalid box #{box_name}, ignoring: #{provider}")
end
end
end
@ -341,25 +357,41 @@ module Vagrant
end
versiondir = box_directory.join(version_dir_map[v.to_s])
providers.each do |provider|
provider_dir = versiondir.join(provider.to_s)
next if !provider_dir.directory?
# If architecture is defined then the box should be within
# a subdirectory. However, if box_architecture value is :auto
# and the box provider directory exists but the architecture
# directory does not, we will use the box provider directory. This
# allows Vagrant to work correctly with boxes which were added
# prior to the addition of architecture support
final_dir = provider_dir
if architecture
arch_dir = provider_dir.join(architecture.to_s)
next if !arch_dir.directory? && box_architecture != :auto
end
final_dir = arch_dir if arch_dir && arch_dir.directory?
# If the final directory does not contain a `metadata.json` file, then
# skip this directory
next if !final_dir.join("metadata.json").exist?
providers.each do |provider|
providerdir = versiondir.join(architecture.to_s).join(provider.to_s)
# If the architecture was automatically set to the host
# architecture, then a match on the architecture subdirectory
# or the provider directory (which is a box install prior to
# architecture support) is valid
if box_architecture == :auto
if !providerdir.directory?
providerdir = versiondir.join(provider.to_s)
end
if providerdir.join("metadata.json").file?
@logger.info("Box found: #{name} (#{provider})")
metadata_url = nil
metadata_url_file = box_directory.join("metadata_url")
metadata_url = metadata_url_file.read if metadata_url_file.file?
if metadata_url && @hook
hook_env = @hook.call(
:authenticate_box_url, box_urls: [metadata_url])
metadata_url = hook_env[:box_urls].first
end
return Box.new(
name, provider, version_dir_map[v.to_s], providerdir,
architecture: architecture, metadata_url: metadata_url, hook: @hook
)
end
end
# If there is no metadata file found, skip
next if !providerdir.join("metadata.json").file?
@logger.info("Box found: #{name} (#{provider})")
@ -374,7 +406,7 @@ module Vagrant
end
return Box.new(
name, provider, version_dir_map[v.to_s], final_dir,
name, provider, version_dir_map[v.to_s], providerdir,
architecture: architecture, metadata_url: metadata_url, hook: @hook
)
end

3
test/unit/support/isolated_environment.rb
View File

@ -100,8 +100,9 @@ module Unit
# @param [String] provider
# @return [Pathname]
def box3(name, version, provider, **opts)
args = [name, version, provider.to_s]
args = [name, version]
args << opts[:architecture].to_s if opts[:architecture]
args << provider.to_s
# Create the directory for the box
box_dir = boxes_dir.join(*args)

9
test/unit/vagrant/action/builtin/box_add_test.rb
View File

@ -1024,7 +1024,7 @@ describe Vagrant::Action::Builtin::BoxAdd, :skip_windows, :bsdtar do
expect(name).to eq("foo/bar")
expect(version).to eq("0.7")
expect(opts[:metadata_url]).to eq("file://#{tf.path}")
expect(opts[:architecture]).to eq(:auto)
expect(opts[:architecture]).to eq("test-arch")
true
}.and_return(box)
@ -1072,7 +1072,7 @@ describe Vagrant::Action::Builtin::BoxAdd, :skip_windows, :bsdtar do
expect(name).to eq("foo/bar")
expect(version).to eq("0.7")
expect(opts[:metadata_url]).to eq("file://#{tf.path}")
expect(opts[:architecture]).to eq(:auto)
expect(opts[:architecture]).to eq("unknown")
true
}.and_return(box)
@ -1130,6 +1130,7 @@ describe Vagrant::Action::Builtin::BoxAdd, :skip_windows, :bsdtar do
end
it "adds the latest version of a box with only one provider and default architecture" do
allow(Vagrant::Util::Platform).to receive(:architecture).and_return("default-arch")
box_path = iso_env.box2_file(:virtualbox)
tf = Tempfile.new(["vagrant-box-latest-version", ".json"]).tap do |f|
f.write(
@ -1145,7 +1146,7 @@ describe Vagrant::Action::Builtin::BoxAdd, :skip_windows, :bsdtar do
{
name: "virtualbox",
url: "#{box_path}",
architecture: "amd64",
architecture: "default-arch",
default_architecture: true,
},
{
@ -1168,7 +1169,7 @@ describe Vagrant::Action::Builtin::BoxAdd, :skip_windows, :bsdtar do
expect(name).to eq("foo/bar")
expect(version).to eq("0.7")
expect(opts[:metadata_url]).to eq("file://#{tf.path}")
expect(opts[:architecture]).to be_nil
expect(opts[:architecture]).to eq("default-arch")
true
}.and_return(box)