vagrant-lxd 0.4.2 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9cb6183072655327362dc5ffa996c3e8c47f5c830f42a00137dd54773ffe9a0b
-  data.tar.gz: ccb1553ba6250ca2db4dea858e6423a2c4bb76d0de39c572b00566bc6b042084
+  metadata.gz: 8cb23ce782dbe622c94d34c2e921ef57ddb4851c25196b898061a840efff44e9
+  data.tar.gz: 807dd8fa2ec7b241a434fcba53f9d27a0c01b14ce4eca35ee3db60972e43486f
 SHA512:
-  metadata.gz: 36e71d95e6cad74f4b08b7d434c1bce4517a0b4604d9895dcf18f2fbf07384814c40bfacf4772dc393b3d9ca520606162ef4ab4edb266e04ab0ddb2ade616ee2
-  data.tar.gz: b1c9d6b3af391533368c3a84a1d54e2b63e0d00908810a0acd922ad9ebda4cdd5a4be537b7c6e1998ed1e3d96268b189cec0e82dfdaa4babf14af51cf8591183
+  metadata.gz: '03932c7c4f744a52f48139f43b6e5a88884c4a550e17def2c010dd07540d50f6026e5599408157a4a259cca5aee50459961148c6c22c1c3ddbc4dcd995de5cb6'
+  data.tar.gz: be9c7d029dee32606626f8d27f6f780c42aa9553727ed0ad5ea3c1ed5e28f37869f6c6859db7591b233dc67c9260ad786dcca7bdce581d330e12704b7cdbf363

data/.gitignore

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

data/.gitlab-ci.yml

@@ -1,4 +1,4 @@
-image: "ruby:2.3"
+image: ruby:2.5
 
 before_script:
   - apt-get -y update

data/Gemfile

@@ -1,12 +1,13 @@
 source 'https://rubygems.org/'
 
 group :development do
+  require 'pp' # avoid superclass mismatch error
   gem 'fakefs'
   gem 'rake'
   gem 'rspec'
   gem 'rspec-its'
   gem 'rspec-mocks'
-  gem 'vagrant', :git => 'https://github.com/mitchellh/vagrant.git'
+  gem 'vagrant', git: 'https://github.com/mitchellh/vagrant.git'
 end
 
 group :plugins do

data/Gemfile.lock

@@ -1,59 +1,62 @@
 GIT
   remote: https://github.com/mitchellh/vagrant.git
-  revision: d0115de80e2258c36c2ef451f26217d9ac679808
+  revision: 2063111ab5cfcce0f6b2dbcecd9d24d47b512a96
   specs:
-    vagrant (2.2.5.dev)
+    vagrant (2.2.10.dev)
       bcrypt_pbkdf (~> 1.0.0)
-      childprocess (~> 0.6.0)
+      childprocess (~> 4.0.0)
       ed25519 (~> 1.2.4)
       erubis (~> 2.7.0)
       hashicorp-checkpoint (~> 0.1.5)
-      i18n (~> 1.1.1)
-      listen (~> 3.1.5)
+      i18n (~> 1.8)
+      listen (~> 3.1)
       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-sftp (~> 3.0)
+      net-ssh (~> 6.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.2)
-      hyperkit (~> 1.2.0)
+    vagrant-lxd (0.5.1)
+      activesupport (~> 5.2.3)
+      faraday (~> 0.17)
+      hyperkit (~> 1.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.3)
+    activesupport (5.2.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     bcrypt_pbkdf (1.0.1)
-    builder (3.2.3)
-    childprocess (0.6.3)
-      ffi (~> 1.0, >= 1.0.11)
-    concurrent-ruby (1.1.5)
-    diff-lcs (1.3)
-    domain_name (0.5.20180417)
+    builder (3.2.4)
+    childprocess (4.0.0)
+    concurrent-ruby (1.1.7)
+    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.20.1)
-    faraday (0.15.4)
+    fakefs (1.2.2)
+    faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
-    ffi (1.11.1)
+    ffi (1.13.1)
     gssapi (1.3.0)
       ffi (>= 1.0.1)
     gyoku (1.3.1)
@@ -62,37 +65,37 @@ GEM
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     httpclient (2.8.3)
-    hyperkit (1.2.0)
+    hyperkit (1.3.0)
       activesupport (>= 4.2.6)
       sawyer
-    i18n (1.1.1)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
     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.2019.0331)
-    minitest (5.11.3)
-    multi_json (1.13.1)
+    mime-types-data (3.2020.0512)
+    minitest (5.14.1)
+    multi_json (1.15.0)
     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-sftp (3.0.0)
+      net-ssh (>= 5.0.0, < 7.0.0)
+    net-ssh (6.1.0)
     netrc (0.11.0)
     nori (2.6.0)
-    public_suffix (3.1.1)
-    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 +103,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.3)
+    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-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.3)
+    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.6)
-    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.2)
+    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 +166,4 @@ DEPENDENCIES
   vagrant-lxd!
 
 BUNDLED WITH
-   2.0.2
+   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
 
@@ -233,7 +234,7 @@ to run graphical applications transparently from within the guest:
 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/containers/#device-configuration
+[device-config]: https://lxd.readthedocs.io/en/latest/instances/#devices-configuration
 
 ## Hacking
 

data/doc/setting-up-lxd.md

@@ -37,7 +37,7 @@ automatically generate the certificate for you):
 newgrp lxd
 
 # create and add a client certificate
-lxc config trust add /home/ubuntu/.config/lxc/client.crt
+lxc config trust add ~/.config/lxc/client.crt
 ```
 
 At this point everything should be set up for the plugin to work

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.
     #
@@ -335,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/driver.rb

@@ -71,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
@@ -115,15 +119,6 @@ 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
@@ -169,8 +164,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
@@ -343,6 +338,14 @@ 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)
@@ -391,7 +394,7 @@ module VagrantLXD
       end
     end
 
-  private
+    private
 
     #
     # The remaining methods are just conveniences, not part of the API
@@ -538,11 +541,27 @@ 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'
-
-      search_paths = [vagrant_path, default_path]
+      search_paths = [vagrant_path] + Certificate.default_paths
 
       Certificate.locate(search_paths) or
       Certificate.generate(vagrant_path)
@@ -602,6 +621,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/driver/certificate.rb

@@ -33,8 +33,11 @@ module VagrantLXD
 
       @logger = Log4r::Logger.new('vagrant::lxd::driver::certificate')
 
-      def Certificate.default_path
-        Pathname.new('~/.config').expand_path
+      def Certificate.default_paths
+        [
+          Pathname.new('~/.config/lxc').expand_path,
+          Pathname.new('~/snap/lxd/current/.config/lxc').expand_path,
+        ]
       end
 
       def Certificate.issuer_name

data/lib/vagrant-lxd/version.rb

@@ -20,7 +20,7 @@
 module VagrantLXD
   module Version
     NAME = 'vagrant-lxd'
-    VERSION = '0.4.2'
+    VERSION = '0.5.1'
     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 'hyperkit', '~> 1.2.0'
+  spec.add_runtime_dependency 'activesupport', '~> 5.2.3'
+  spec.add_runtime_dependency 'hyperkit', '~> 1.3.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,29 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-lxd
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.1
 platform: ruby
 authors:
 - Evan Hanson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-11 00:00:00.000000000 Z
+date: 2020-09-14 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
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.3.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: 1.2.0
+        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.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Vagrant LXD provider