vagrant-lxd 0.4.0 → 0.4.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 37988b3901f0e99417203fbab0b8c532e631f0c4
-  data.tar.gz: c39bdfa2e6e7912cd5dc3cad36600bc6d98ff51d
+SHA256:
+  metadata.gz: be2300b7aa0ba5ccc8ae1d3ed7af2bbc0da4a1ded7aefe64e9896d26a672d905
+  data.tar.gz: c7e73c349e90e91f180e76f1a550d35852b0aa720a406361ef9f94e692eaa68a
 SHA512:
-  metadata.gz: 1c14feb0f9522935357fe750329e288697bb8dc226218aeeebec74baa8e78afc36689a3972db637db9fa0e507e594dcfc9ae8df0c68a25550ee6359e536f6d35
-  data.tar.gz: 68cb1f0440026627051a5754e64857b25a78dc5d7a0d155c798304af8676efff555a5e226e01be3daa6d4d258e0d64856fa6195070c8a8366004df987bade911
+  metadata.gz: 9bff61ace1311df547b7b0aa6ccb3917ec950353ac7a164e78971cf2297881e007d559fb86798913d8ae1c91b0c4d9b7d5a2e565d5fd00689ff04f9a64b71dbb
+  data.tar.gz: cb70de69a9de248887c1b3b116fb807f324783ce1adde52f411dc83a1f7245a3da08b687c14385ee34183a144823eec469f7a0968baafdc6455af2e3ccfd154b

data/.gitignore

@@ -1,5 +1,6 @@
 /.bundle/
+/.tool-versions
 /.vagrant/
-/pkg/
 /Vagrantfile
+/pkg/
 /vendor/

data/Gemfile

@@ -1,6 +1,7 @@
 source 'https://rubygems.org/'
 
 group :development do
+  require 'pp' # avoid superclass mismatch error
   gem 'fakefs'
   gem 'rake'
   gem 'rspec'

data/Gemfile.lock

@@ -1,60 +1,63 @@
 GIT
   remote: https://github.com/mitchellh/vagrant.git
-  revision: c6b42a04cd1ca9f0936714ee6a44b4c7c001fdeb
+  revision: 7df0e62aded9316485e83fd5548bebbacf702ec7
   specs:
-    vagrant (2.2.4.dev)
+    vagrant (2.2.10.dev)
       bcrypt_pbkdf (~> 1.0.0)
-      childprocess (~> 0.6.0)
+      childprocess (~> 3.0.0)
       ed25519 (~> 1.2.4)
       erubis (~> 2.7.0)
       hashicorp-checkpoint (~> 0.1.5)
-      i18n (~> 1.1.1)
+      i18n (~> 1.8)
       listen (~> 3.1.5)
       log4r (~> 1.1.9, < 1.1.11)
+      mime (~> 0.4.4)
       net-scp (~> 1.2.0)
       net-sftp (~> 2.1)
-      net-ssh (~> 5.1.0)
+      net-ssh (~> 5.2.0)
       rb-kqueue (~> 0.2.0)
       rest-client (>= 1.6.0, < 3.0)
       ruby_dep (<= 1.3.1)
-      rubyzip (~> 1.2.2)
-      vagrant_cloud (~> 2.0.2)
+      rubyzip (~> 2.0)
+      vagrant_cloud (~> 2.0.3)
       wdm (~> 0.1.0)
-      winrm (~> 2.1)
-      winrm-elevated (~> 1.1)
-      winrm-fs (~> 1.0)
+      winrm (>= 2.3.4, < 3.0)
+      winrm-elevated (>= 1.2.1, < 2.0)
+      winrm-fs (>= 1.3.4, < 2.0)
 
 PATH
   remote: .
   specs:
-    vagrant-lxd (0.4.0)
+    vagrant-lxd (0.4.5)
+      activesupport (~> 5.2.3)
+      faraday (~> 0.17)
       hyperkit (~> 1.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.2)
+    activesupport (5.2.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
-    bcrypt_pbkdf (1.0.0)
-    builder (3.2.3)
-    childprocess (0.6.3)
-      ffi (~> 1.0, >= 1.0.11)
-    concurrent-ruby (1.1.4)
-    diff-lcs (1.3)
-    domain_name (0.5.20180417)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    bcrypt_pbkdf (1.0.1)
+    builder (3.2.4)
+    childprocess (3.0.0)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
     ed25519 (1.2.4)
+    erubi (1.9.0)
     erubis (2.7.0)
-    fakefs (0.19.1)
-    faraday (0.15.4)
+    fakefs (1.2.2)
+    faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
-    ffi (1.10.0)
-    gssapi (1.2.0)
+    ffi (1.13.1)
+    gssapi (1.3.0)
       ffi (>= 1.0.1)
     gyoku (1.3.1)
       builder (>= 2.1.2)
@@ -65,7 +68,7 @@ GEM
     hyperkit (1.2.0)
       activesupport (>= 4.2.6)
       sawyer
-    i18n (1.1.1)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
     listen (3.1.5)
       rb-fsevent (~> 0.9, >= 0.9.4)
@@ -73,26 +76,27 @@ GEM
       ruby_dep (~> 1.2)
     little-plugger (1.1.4)
     log4r (1.1.10)
-    logging (2.2.2)
+    logging (2.3.0)
       little-plugger (~> 1.1)
-      multi_json (~> 1.10)
-    mime-types (3.2.2)
+      multi_json (~> 1.14)
+    mime (0.4.4)
+    mime-types (3.3.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2018.0812)
-    minitest (5.11.3)
-    multi_json (1.13.1)
-    multipart-post (2.0.0)
+    mime-types-data (3.2020.0512)
+    minitest (5.14.1)
+    multi_json (1.14.1)
+    multipart-post (2.1.1)
     net-scp (1.2.1)
       net-ssh (>= 2.6.5)
     net-sftp (2.1.2)
       net-ssh (>= 2.6.5)
-    net-ssh (5.1.0)
+    net-ssh (5.2.0)
     netrc (0.11.0)
     nori (2.6.0)
-    public_suffix (3.0.3)
-    rake (12.3.2)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.10.0)
+    public_suffix (4.0.5)
+    rake (13.0.1)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
       ffi (~> 1.0)
     rb-kqueue (0.2.5)
       ffi (>= 0.5.0)
@@ -100,53 +104,54 @@ GEM
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-its (1.2.0)
+      rspec-support (~> 3.9.0)
+    rspec-its (1.3.0)
       rspec-core (>= 3.0.0)
       rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.8.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
     ruby_dep (1.3.1)
     rubyntlm (0.6.2)
-    rubyzip (1.2.2)
-    sawyer (0.8.1)
-      addressable (>= 2.3.5, < 2.6)
-      faraday (~> 0.8, < 1.0)
+    rubyzip (2.3.0)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.5)
-    vagrant_cloud (2.0.2)
+    unf_ext (0.0.7.7)
+    vagrant_cloud (2.0.3)
       rest-client (~> 2.0.2)
     wdm (0.1.1)
-    winrm (2.3.1)
+    winrm (2.3.4)
       builder (>= 2.1.2)
-      erubis (~> 2.7)
+      erubi (~> 1.8)
       gssapi (~> 1.2)
       gyoku (~> 1.0)
       httpclient (~> 2.2, >= 2.2.0.2)
       logging (>= 1.6.1, < 3.0)
       nori (~> 2.0)
       rubyntlm (~> 0.6.0, >= 0.6.1)
-    winrm-elevated (1.1.1)
+    winrm-elevated (1.2.1)
+      erubi (~> 1.8)
       winrm (~> 2.0)
       winrm-fs (~> 1.0)
-    winrm-fs (1.3.2)
-      erubis (~> 2.7)
+    winrm-fs (1.3.4)
+      erubi (~> 1.8)
       logging (>= 1.6.1, < 3.0)
-      rubyzip (~> 1.1)
+      rubyzip (~> 2.0)
       winrm (~> 2.0)
 
 PLATFORMS
@@ -162,4 +167,4 @@ DEPENDENCIES
   vagrant-lxd!
 
 BUNDLED WITH
-   2.0.1
+   2.1.4

data/README.md

@@ -13,7 +13,8 @@ The following features are currently supported:
  - VM management (create, suspend, destroy, etc.)
  - IPv4 networking
  - Synced folders
- - Snapshots
+ - Snapshots (via `vagrant snapshot`)
+ - Box Packaging (via `vagrant package`)
 
 The following features are not expected to work yet:
 
@@ -147,7 +148,7 @@ is passed through to LXD. The hash values should all be strings:
       recursive: 'false',
     }
 
-[disk]: https://lxd.readthedocs.io/en/latest/containers/#type-disk
+[disk]: https://lxd.readthedocs.io/en/latest/instances/#type-disk
 
 ### Shared LXD Containers
 
@@ -191,7 +192,7 @@ In order to run Linux containers on an LXD-backed machine, it must be
 created with the `nesting` and `privileged` properties set to `true`.
 These correspond to the `security.nesting` and `security.privileged`
 configuration items for LXD, respectively. Refer to LXD's [container
-configuration documentation][docs] for details.
+configuration documentation][containers] for details.
 
     config.vm.provider 'lxd' do |lxd|
       lxd.nesting = true
@@ -202,7 +203,38 @@ Note that enabling these options will invalidate any user and group ID
 mappings you may have configured for synced folders, since privileged
 containers use the same UID and GID space as the host machine.
 
-[docs]: https://lxd.readthedocs.io/en/latest/containers/
+[containers]: https://lxd.readthedocs.io/en/latest/containers/
+
+### Adding Devices
+
+You can attach arbitrary devices to the container with the `devices`
+setting. This should be a map of device names to configuration hashes,
+where the hash keys and values are valid [device configuration
+settings][device-config].
+
+For example, the following configuration uses a `proxy` device to
+forward local X11 traffic from the container to the host, allowing you
+to run graphical applications transparently from within the guest:
+
+    # e.g. vagrant ssh -c 'DISPLAY=:0 firefox'
+    config.vm.provider 'lxd' do |lxd|
+      lxd.devices = {
+        x11: {
+          type: 'proxy',
+          mode: '0777',
+          bind: 'container',
+          listen: 'unix:/tmp/.X11-unix/X0',
+          connect: 'unix:/tmp/.X11-unix/X0',
+          'security.uid': Process.uid.to_s,
+          'security.gid': Process.gid.to_s,
+        }
+      }
+    end
+
+Note that disk devices should be configured as [synced
+folders](#synced-folders) rather than ad-hoc devices.
+
+[device-config]: https://lxd.readthedocs.io/en/latest/instances/#devices-configuration
 
 ## Hacking
 

data/lib/vagrant-lxd/action.rb

@@ -124,6 +124,20 @@ module VagrantLXD
       end
     end
 
+    class Package
+      def initialize(app, env)
+        @app = app
+        @env = env
+      end
+
+      def call(env)
+        env['package.directory'] = env[:machine_package]
+        @app.call(env)
+      ensure
+        FileUtils.rm_rf(env[:machine_package])
+      end
+    end
+
     #
     # Action definitions.
     #
@@ -227,6 +241,7 @@ module VagrantLXD
               c.use SetHostname
               c.use SyncedFolders
               c.use LXD.action(:resume)
+              c.use LXD.action(:reconnect)
               c.use WaitForCommunicator
             else
               c.use Message, :error, "Machine cannot be resumed while #{env[:machine_state]}."
@@ -334,6 +349,24 @@ module VagrantLXD
         builder { |b| b.use SSHRun }
       end
 
+      def package
+        builder do |b|
+          b.use Call, state do |env, c|
+            case env[:machine_state]
+            when Vagrant::MachineState::NOT_CREATED_ID
+              next
+            when :frozen, :running
+              c.use halt
+            end
+
+            c.use Message, :info, 'Packaging machine...'
+            c.use LXD.action(:package)
+            c.use Package
+            c.use Vagrant::Action::General::Package
+          end
+        end
+      end
+
     private
 
       def builder

data/lib/vagrant-lxd/capability.rb

@@ -29,14 +29,33 @@ module VagrantLXD
     def Capability.synced_folders(env)
       logger = Log4r::Logger.new('vagrant::lxd::capability')
       logger.debug "Checking synced folders support for effective UID/GID #{Process.uid}/#{Process.gid}..."
-      result = %w(uid gid).all? do |type|
+      %w(uid gid).all? do |type|
         begin
-          File.readlines("/etc/sub#{type}").grep(/^root:#{Process.send(type)}:[1-9]/).any?
+          id = Process.send(type)
+          id_map = File.readlines("/etc/sub#{type}")
+          id_in_sub_id?(id, id_map)
         rescue StandardError => e
           logger.warn "Cannot read subordinate permissions file: #{e.message}"
           false
         end
       end
     end
+
+    # Determines whether the given numerical `id` is included in the
+    # subordinate map `id_map`, which should be an array of lines from
+    # the file /etc/subuid or /etc/subgid.
+    #
+    # Invalid lines, and any lines for a user or group other than root,
+    # are ignored. See subuid(5) and subgid(5) for details about these
+    # files, and the expected format of their entries.
+    def Capability.id_in_sub_id?(id, id_map)
+      id_map.any? do |line|
+        if line.match(/^(root|0):(\d+):(\d+)/)
+          range_min = $2.to_i
+          range_max = range_min + $3.to_i
+          id.between?(range_min, range_max)
+        end
+      end
+    end
   end
 end

data/lib/vagrant-lxd/config.rb

@@ -26,6 +26,7 @@ module VagrantLXD
     attr_accessor :name
     attr_accessor :timeout
     attr_accessor :config
+    attr_accessor :devices
     attr_accessor :environment
     attr_accessor :ephemeral
     attr_accessor :nesting
@@ -40,6 +41,7 @@ module VagrantLXD
       @name = UNSET_VALUE
       @timeout = UNSET_VALUE
       @config = UNSET_VALUE
+      @devices = UNSET_VALUE
       @environment = UNSET_VALUE
       @nesting = UNSET_VALUE
       @privileged = UNSET_VALUE
@@ -74,15 +76,27 @@ module VagrantLXD
       if not config.is_a? Hash
         errors << "Invalid `config' (value must be a hash): #{config.inspect}"
       elsif not config.keys.all? { |x| x.is_a? Symbol }
-        errors << "Invalid `config' (hash keys must be symbols): #{config.inspect}"
+        errors << "Invalid `config' (keys must be symbols): #{config.inspect}"
+      end
+
+      if not devices.is_a? Hash
+        errors << "Invalid `devices' (value must be a hash): #{devices.inspect}"
+      elsif not devices.keys.all? { |x| x.is_a? String or x.is_a? Symbol }
+        errors << "Invalid `devices' (keys must be strings or symbols): #{devices.inspect}"
+      elsif devices.keys.any? { |x| x =~ /^(.*([^a-z0-9.\-_]).*)$/ }
+        errors << "Invalid `devices' (device name `#{$1}' contains invalid character '#{$2}'): #{devices.inspect}"
+      elsif not devices.values.all? { |x| x.is_a? Hash }
+        errors << "Invalid `devices' (values must be hashes): #{devices.inspect}"
+      elsif not devices.values.map(&:values).flatten.all? { |x| x.is_a? String }
+        errors << "Invalid `devices' (device value must be strings): #{devices.inspect}"
       end
 
       if not environment.is_a? Hash
         errors << "Invalid `environment' (value must be a hash): #{environment.inspect}"
       elsif not environment.keys.all? { |x| x.is_a? String or x.is_a? Symbol }
-        errors << "Invalid `environment' (hash keys must be strings or symbols): #{environment.inspect}"
+        errors << "Invalid `environment' (keys must be strings or symbols): #{environment.inspect}"
       elsif not environment.values.all? { |x| x.is_a? String }
-        errors << "Invalid `environment' (hash values must be strings): #{environment.inspect}"
+        errors << "Invalid `environment' (values must be strings): #{environment.inspect}"
       end
 
       begin
@@ -151,6 +165,10 @@ module VagrantLXD
         @config = {}
       end
 
+      if devices == UNSET_VALUE
+        @devices = {}
+      end
+
       if environment == UNSET_VALUE
         @environment = {}
       end

data/lib/vagrant-lxd/driver.rb

@@ -18,11 +18,14 @@
 #
 
 require 'active_support/core_ext/object/deep_dup'
+require 'active_support/core_ext/hash/except'
 require 'hyperkit'
+require 'json'
+require 'monitor'
 require 'securerandom'
 require 'tempfile'
 require 'timeout'
-require 'monitor'
+require 'yaml'
 require 'vagrant/machine_state'
 require 'vagrant-lxd/driver/certificate'
 
@@ -68,6 +71,10 @@ module VagrantLXD
       error_key 'lxd_image_creation_failure'
     end
 
+    class ImageExportFailure < Vagrant::Errors::VagrantError
+      error_key 'lxd_image_export_failure'
+    end
+
     class ContainerNotFound < Vagrant::Errors::VagrantError
       error_key 'lxd_container_not_found'
     end
@@ -112,11 +119,21 @@ module VagrantLXD
       end
     end
 
+    module Hyperkit::Client::Containers
+      alias extract_container_options_without_devices extract_container_options
+
+      def extract_container_options(name, options)
+        opts = extract_container_options_without_devices(name, options)
+        options.slice(:devices).merge(opts)
+      end
+    end
+
     NOT_CREATED = Vagrant::MachineState::NOT_CREATED_ID
 
     attr_reader :api_endpoint
     attr_reader :name
     attr_reader :timeout
+    attr_reader :devices
     attr_reader :environment
     attr_reader :ephemeral
     attr_reader :nesting
@@ -131,7 +148,8 @@ module VagrantLXD
       @machine = machine
       @timeout = machine.provider_config.timeout
       @api_endpoint = machine.provider_config.api_endpoint
-      @config = @machine.provider_config.config
+      @config = machine.provider_config.config
+      @devices = machine.provider_config.devices
       @environment = machine.provider_config.environment
       @nesting = machine.provider_config.nesting
       @privileged = machine.provider_config.privileged
@@ -155,8 +173,8 @@ module VagrantLXD
       raw_idmap = container[:config][:'raw.idmap']
       begin
         raw_idmap and
-        raw_idmap =~ /^uid #{Process.uid} #{vagrant_uid}$/ and
-        raw_idmap =~ /^gid #{Process.gid} #{vagrant_gid}$/
+        id_in_map?(Process.uid, 'uid', raw_idmap) and
+        id_in_map?(Process.gid, 'gid', raw_idmap)
       end
     rescue Vagrant::Errors::ProviderNotUsable
       false
@@ -187,9 +205,7 @@ module VagrantLXD
 
     def unmount(name, options)
       container = lxd.container(machine_id)
-      devices = container[:devices].to_hash
-      devices.delete(name.to_sym)
-      container[:devices] = devices
+      container[:devices] = container[:devices].to_hash.except(name.to_sym)
       lxd.update_container(machine_id, container)
     rescue Hyperkit::BadRequest => e
       @machine.ui.error 'Failed to unmount synced folder'
@@ -271,7 +287,7 @@ module VagrantLXD
           end
         end
 
-        container = lxd.create_container(machine_id, ephemeral: ephemeral, fingerprint: fingerprint, config: config, profiles: profiles)
+        container = lxd.create_container(machine_id, devices: devices, ephemeral: ephemeral, fingerprint: fingerprint, config: config, profiles: profiles)
         @logger.debug 'Created container: ' << container.inspect
 
         @machine.id = machine_id
@@ -331,15 +347,53 @@ module VagrantLXD
       end
     end
 
+    def package
+      if in_state? :stopped
+        create_package_directory
+      else
+        @logger.debug "Skipped packaging (#{machine_id} is not stopped)"
+      end
+    end
+
     def configure
       container = lxd.container(machine_id)
       container[:config] = container[:config].to_hash.merge(config)
+      container[:devices] = container[:devices].to_hash.merge(devices)
       lxd.update_container(machine_id, container)
     rescue Hyperkit::Error => e
       @machine.ui.error 'Failed to configure container'
       fail ContainerConfigurationFailure, machine_name: @machine.name, reason: e.reason
     end
 
+    # When a container is restarted, the `forkproxy` processes that manage
+    # its proxy devices will persist but will not reliably recreate
+    # container-side listeners for devices that are configured with
+    # "bind=container". Removing and re-creating the devices forces the
+    # proxy processes to be recreated, ensuring the listeners are as well.
+    def reconnect
+      # select proxy devices
+      container = lxd.container(machine_id)
+      devices = container[:devices].to_hash
+      proxies = devices.select { |_, d| d[:type] == 'proxy' }
+
+      # bail if there's nothing to do
+      return if proxies.empty?
+
+      # TODO move messaging into a dedicated action
+      @machine.ui.info 'Reconnecting proxy devices...'
+
+      # remove proxy devices
+      container[:devices] = devices.except(*proxies.keys)
+      lxd.update_container(machine_id, container)
+
+      # restore all devices (including proxies)
+      container[:devices] = devices.merge(proxies)
+      lxd.update_container(machine_id, container)
+    rescue Hyperkit::Error => e
+      @machine.ui.error 'Failed to connect proxy devices'
+      fail ContainerConfigurationFailure, machine_name: @machine.name, reason: e.reason
+    end
+
     def info
       if in_state? :running, :frozen
         {
@@ -349,7 +403,7 @@ module VagrantLXD
       end
     end
 
-  private
+    private
 
     #
     # The remaining methods are just conveniences, not part of the API
@@ -496,6 +550,24 @@ module VagrantLXD
       config
     end
 
+    # Determines whether the numerical `id` of the specified `type` is
+    # included in the given idmap. These values should follow the format
+    # of the "raw.idmap" property specified here:
+    #
+    #   https://lxd.readthedocs.io/en/latest/userns-idmap/#custom-idmaps
+    #
+    def id_in_map?(id, type, map)
+      range_types = ['both', type]
+      map.each_line.any? do |line|
+        range_type, range_values = line.split
+        range = range_values.split('-')
+        begin
+          range_types.include?(range_type) and
+          id.between?(range.first.to_i, range.last.to_i)
+        end
+      end
+    end
+
     def locate_or_generate_client_certificate
       vagrant_path = @machine.env.data_dir / 'lxd'
       default_path = Certificate.default_path / 'lxc'
@@ -515,11 +587,13 @@ module VagrantLXD
       lxc_dir = @machine.box.directory
       lxc_rootfs = lxc_dir / 'rootfs.tar.gz'
       lxc_fingerprint = Digest::SHA256.file(lxc_rootfs).hexdigest
+      lxc_metadata = JSON.load(File.read(lxc_dir / 'metadata.json'))
 
       lxd_dir = @machine.box.directory / '..' / 'lxd'
       lxd_rootfs = lxd_dir / 'rootfs.tar.gz'
       lxd_metadata = YAML.load(File.read(lxd_dir / 'metadata.yaml')) rescue nil
 
+      # TODO move messaging into a dedicated action
       if lxd_rootfs.exist? and lxd_metadata.is_a? Hash and lxd_metadata['source_fingerprint'] == lxc_fingerprint
         @machine.ui.info 'Importing LXC image...'
       else
@@ -528,6 +602,10 @@ module VagrantLXD
         SafeChdir.safe_chdir(tmpdir) do
           FileUtils.cp(lxc_rootfs, tmpdir)
 
+          File.open('metadata.json', 'w') do |metadata|
+            metadata.puts JSON.pretty_generate(lxc_metadata.merge('provider' => 'lxd'))
+          end
+
           File.open('metadata.yaml', 'w') do |metadata|
             metadata.puts 'architecture: ' << `uname -m`.strip
             metadata.puts 'creation_date: ' << Time.now.strftime('%s')
@@ -541,6 +619,7 @@ module VagrantLXD
           FileUtils.mkdir_p(lxd_dir)
           FileUtils.mv('rootfs.tar.gz', lxd_dir)
           FileUtils.mv('metadata.yaml', lxd_dir)
+          FileUtils.mv('metadata.json', lxd_dir)
         end
       end
 
@@ -553,6 +632,42 @@ module VagrantLXD
       FileUtils.rm_rf(tmpdir)
     end
 
+    # TODO s.a.
+    def create_package_directory
+      package_directory = Dir.mktmpdir
+
+      image = begin
+        lxd.create_image_from_container(machine_id, IMAGE_PROPERTIES)
+      rescue Hyperkit::BadRequest => e
+        if e.reason =~ /The image already exists: (\h{64})/
+          {
+            metadata: { fingerprint: $1 }
+          }
+        else
+          fail ImageExportFailure, machine_name: @machine.name, reason: e.reason
+        end
+      end
+
+      lxd.export_image(image[:metadata][:fingerprint], package_directory, filename: 'rootfs.tar.gz')
+
+      File.open(File.join(package_directory, 'metadata.json'), 'w') do |metadata|
+        metadata.puts JSON.pretty_generate({
+          'provider' => 'lxc',
+          'version'  => '1.0.0',
+          'built-on' => Time.now.strftime("%a %m %d %H:%M:%S %z %Y"),
+        })
+      end
+    rescue Exception => e
+      @machine.ui.error 'Failed to export container image'
+      @logger.error 'Error preparing container image: ' << e.message << "\n" << e.backtrace.join("\n")
+      fail ImageExportFailure, machine_name: @machine.name, reason: e.message
+    else
+      package_directory
+    ensure
+      # If the image was created just for this package, remove it.
+      lxd.delete_image(image[:metadata][:fingerprint]) rescue nil if image.is_a? Sawyer::Resource
+    end
+
     def error(klass)
       klass.new(
         provider: Version::NAME,

data/lib/vagrant-lxd/version.rb

@@ -20,7 +20,7 @@
 module VagrantLXD
   module Version
     NAME = 'vagrant-lxd'
-    VERSION = '0.4.0'
+    VERSION = '0.4.5'
     DESCRIPTION = 'Vagrant LXD provider'
   end
 end

data/templates/locales/en.yml

@@ -134,6 +134,13 @@ en:
         
             https://gitlab.com/catalyst-it/vagrant-lxd/issues
         
+      lxd_image_export_failure: |-
+        The provider was unable to export a container image for '%{machine_name}'.
+        
+        The underlying error message was: %{reason}
+        
+        The LXD logs may contain more information about the cause of this failure.
+        
       lxd_duplicate_attachment_failure: |-
         A machine can only be associated with one container at a time.
         

data/vagrant-lxd.gemspec

@@ -35,5 +35,10 @@ Gem::Specification.new do |spec|
     f.match(%r{^(test|spec|features)/})
   end
 
+  spec.add_runtime_dependency 'activesupport', '~> 5.2.3'
   spec.add_runtime_dependency 'hyperkit', '~> 1.2.0'
+
+  # NOTE fixed to preserve ruby 1.x compatibility, versions after 1.0
+  # use the safe navigation operator and thus need ruby 2.3 or newer
+  spec.add_runtime_dependency 'faraday', '~> 0.17'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-lxd
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.5
 platform: ruby
 authors:
 - Evan Hanson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-29 00:00:00.000000000 Z
+date: 2020-07-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
 - !ruby/object:Gem::Dependency
   name: hyperkit
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
 description: A Vagrant plugin that allows management of containers using LXD.
 email:
 - evanh@catalyst.net.nz
@@ -71,8 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Vagrant LXD provider