vagrant-lxd 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ceae5ec31aecf1934e40466195849ad4f2152b7a
-  data.tar.gz: 6d8ba4edabdfa6bc4007c81eb6c41a12836c2b83
+  metadata.gz: abc3e26c2ce8d3408a4e4469219404dc24a08d50
+  data.tar.gz: 720aac0252d1af7b40a0d15893fa8aeebaa08bcf
 SHA512:
-  metadata.gz: 2bfef2ee6532fd17a6ef5a0816fb5452e128866ac66b5aeced12f4e8781d4ea1f3fae859b49fdae5552362089d645c569d7b3426a68f83f0a5536a6e4d2d583c
-  data.tar.gz: fc765c52de52976c39215bf5fd712c258a62ba07741735b95b7eb43497809337bcf14ba80b273abc4d02bf97b8a4c76f4389406987411bf145cd320a564ff280
+  metadata.gz: 754310e162e9d5716514c9fa0a938b055c53355553433379c7bc5e484933025a22bbc10c3e1a95e4b6f7c2cc524e3178ede1461a20aebe05f572589a23c3d3b7
+  data.tar.gz: 0dd64052ec2514532ca7d73828048674f6753317d9da5f6be0b53fb89c93ba8b9abe634d176b85a36f5935210afc8d9d0611d542aa1b2d4f51a6eecee3cf4315

data/.gitignore

@@ -1,4 +1,5 @@
 /.bundle/
 /.vagrant/
+/pkg/
 /Vagrantfile
-/vendor
+/vendor/

data/Gemfile

@@ -1,6 +1,7 @@
 source 'https://rubygems.org/'
 
 group :development do
+  gem 'fakefs'
   gem 'rake'
   gem 'rspec'
   gem 'rspec-its'

data/Gemfile.lock

@@ -1,8 +1,8 @@
 GIT
   remote: https://github.com/mitchellh/vagrant.git
-  revision: f31a340499a13868e60b2e4649c13a167a0bf387
+  revision: dbba41a7ec3d87830f9b1895266d6a807c1cd2e0
   specs:
-    vagrant (2.0.4.dev)
+    vagrant (2.1.2.dev)
       childprocess (~> 0.6.0)
       erubis (~> 2.7.0)
       hashicorp-checkpoint (~> 0.1.5)
@@ -16,6 +16,8 @@ GIT
       rest-client (>= 1.6.0, < 3.0)
       ruby_dep (<= 1.3.1)
       wdm (~> 0.1.0)
+      win32-file (~> 0.8.1)
+      win32-file-security (~> 1.0.10)
       winrm (~> 2.1)
       winrm-elevated (~> 1.1)
       winrm-fs (~> 1.0)
@@ -23,30 +25,32 @@ GIT
 PATH
   remote: .
   specs:
-    vagrant-lxd (0.2.0)
-      hyperkit (~> 1.1)
+    vagrant-lxd (0.2.1)
+      hyperkit (~> 1.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.0)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
+    activesupport (4.2.10)
+      i18n (~> 0.7)
       minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     addressable (2.5.2)
       public_suffix (>= 2.0.2, < 4.0)
     builder (3.2.3)
     childprocess (0.6.3)
       ffi (~> 1.0, >= 1.0.11)
-    concurrent-ruby (1.0.5)
     diff-lcs (1.3)
-    domain_name (0.5.20170404)
+    domain_name (0.5.20180417)
       unf (>= 0.0.5, < 1.0.0)
     erubis (2.7.0)
-    faraday (0.14.0)
+    fakefs (0.14.1)
+    faraday (0.15.2)
       multipart-post (>= 1.2, < 3)
     ffi (1.9.23)
+    ffi-win32-extensions (1.0.3)
+      ffi
     gssapi (1.2.0)
       ffi (>= 1.0.1)
     gyoku (1.3.1)
@@ -55,8 +59,8 @@ GEM
     http-cookie (1.0.3)
       domain_name (~> 0.5)
     httpclient (2.8.3)
-    hyperkit (1.2.0)
-      activesupport (>= 4.2.6)
+    hyperkit (1.1.0)
+      activesupport (~> 4.2.6)
       sawyer
     i18n (0.8.0)
     listen (3.1.5)
@@ -121,6 +125,16 @@ GEM
       unf_ext
     unf_ext (0.0.7.5)
     wdm (0.1.1)
+    win32-file (0.8.1)
+      ffi
+      ffi-win32-extensions
+      win32-file-stat (>= 1.4.0)
+    win32-file-security (1.0.10)
+      ffi
+      ffi-win32-extensions
+    win32-file-stat (1.5.5)
+      ffi
+      ffi-win32-extensions
     winrm (2.2.3)
       builder (>= 2.1.2)
       erubis (~> 2.7)
@@ -143,6 +157,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  fakefs
   rake
   rspec
   rspec-its

data/Rakefile

@@ -1,3 +1,22 @@
+#
+# Copyright (c) 2017-2018 Catalyst.net Ltd
+#
+# This file is part of vagrant-lxd.
+#
+# vagrant-lxd is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or (at
+# your option) any later version.
+#
+# vagrant-lxd is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+# General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with vagrant-lxd. If not, see <http://www.gnu.org/licenses/>.
+#
+
 require 'rubygems'
 require 'bundler/setup'
 require 'rspec/core/rake_task'

data/lib/vagrant-lxd/action.rb

@@ -95,6 +95,35 @@ module VagrantLXD
       end
     end
 
+    #
+    # Issue a warning when the machine wants synced folders but the host
+    # doesn't support it (according to the relevant shadow files).
+    #
+    class CheckForSyncedFolderSupport
+      def initialize(app, env)
+        @app = app
+        @env = env
+      end
+
+      def call(env)
+        enabled_folders = env[:machine].config.vm.synced_folders.reject do |_, options|
+          next true if options[:disabled]
+          next true unless options[:type].nil? or options[:type] == :lxd
+        end
+
+        if enabled_folders.any? and not env[:host].capability(:synced_folders)
+          env[:ui].error 'The host machine does not support LXD synced folders.'
+          env[:ui].warn ''
+          env[:ui].warn 'To use this feature, you must first configure ID mappings for the'
+          env[:ui].warn 'current user in /etc/subuid and /etc/subgid. For more information,'
+          env[:ui].warn "refer to `#{File.basename($0)} lxd shadow --help`."
+          env[:ui].warn ''
+        end
+
+        @app.call(env)
+      end
+    end
+
     #
     # Action definitions.
     #
@@ -108,6 +137,7 @@ module VagrantLXD
             when Vagrant::MachineState::NOT_CREATED_ID
               c.use Message, :info, 'Machine has not been created yet, starting...'
               c.use HandleBox
+              c.use CheckForSyncedFolderSupport
               c.use LXD.action(:create)
               c.use LXD.action(:resume)
               c.use SetHostname
@@ -191,6 +221,7 @@ module VagrantLXD
               c.use Message, :info, 'Machine is already running.'
             when :frozen, :stopped
               c.use Message, :info, 'Resuming machine...'
+              c.use CheckForSyncedFolderSupport
               c.use LXD.action(:resume)
               c.use SetHostname
               c.use SyncedFolders

data/lib/vagrant-lxd/capability.rb

@@ -17,11 +17,26 @@
 # along with vagrant-lxd. If not, see <http://www.gnu.org/licenses/>.
 #
 
+require 'vagrant-lxd/config'
+
 module VagrantLXD
   class Capability
     def Capability.snapshot_list(machine)
       env = machine.action(:snapshot_list)
       env[:machine_snapshot_list] || []
     end
+
+    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|
+        begin
+          File.readlines("/etc/sub#{type}").grep(/^root:#{Process.send(type)}:[1-9]/).any?
+        rescue StandardError => e
+          logger.warn "Cannot read subordinate permissions file: #{e.message}"
+          false
+        end
+      end
+    end
   end
 end

data/lib/vagrant-lxd/command.rb

@@ -37,6 +37,7 @@ module VagrantLXD
         o.separator 'Commands:'
         o.separator '     attach    associate machine with a running container'
         o.separator '     detach    disassociate machine from a running container'
+        o.separator '     shadow    print user and group ID mapping information'
         o.separator '     version   print current plugin version'
         o.separator ''
         o.separator 'For help on a specific command, run `vagrant lxd <command> -h`'
@@ -52,6 +53,8 @@ module VagrantLXD
         attach(args)
       when 'detach'
         detach(args)
+      when 'shadow'
+        shadow(args)
       when 'version'
         @env.ui.info 'Vagrant LXD Provider'
         @env.ui.info 'Version ' << Version::VERSION
@@ -153,5 +156,19 @@ module VagrantLXD
         yield @env.machine(name, :lxd)
       end
     end
+
+    def shadow(args)
+      opts = OptionParser.new do |o|
+        o.banner = 'Usage: vagrant lxd shadow --help'
+        o.separator ''
+        o.separator 'Displays information about user and group ID mapping.'
+      end
+
+      if args.include?('-h') or args.include?('--help')
+        @env.ui.info I18n.t('vagrant.help.shadow', uid: Process.uid, gid: Process.gid)
+      else
+        fail Vagrant::Errors::CLIInvalidUsage, help: opts.help
+      end
+    end
   end
 end

data/lib/vagrant-lxd/config.rb

@@ -31,6 +31,8 @@ module VagrantLXD
     attr_accessor :privileged
     attr_accessor :profiles
 
+    VAGRANT_UID = 1000 # TODO Make this configurable.
+
     def initialize
       @name = UNSET_VALUE
       @timeout = UNSET_VALUE

data/lib/vagrant-lxd/driver.rb

@@ -23,12 +23,13 @@ require 'securerandom'
 require 'tempfile'
 require 'timeout'
 require 'vagrant/machine_state'
+require 'vagrant-lxd/config'
 
 module VagrantLXD
   class Driver
     include Vagrant::Util
 
-    VAGRANT_UID = 1000 # TODO Make this configurable.
+    USER_AGENT = "#{Version::DESCRIPTION} #{Version::VERSION} (#{Hyperkit::Default.user_agent})"
 
     class OperationTimeout < Vagrant::Errors::VagrantError
       error_key 'lxd_operation_timeout'
@@ -108,8 +109,8 @@ module VagrantLXD
       @ephemeral = machine.provider_config.ephemeral
       @profiles = machine.provider_config.profiles
       @name = machine.provider_config.name
-      @logger = Log4r::Logger.new('vagrant::lxd')
-      @lxd = Hyperkit::Client.new(api_endpoint: api_endpoint.to_s, verify_ssl: false)
+      @logger = Log4r::Logger.new('vagrant::lxd::driver')
+      @lxd = Hyperkit::Client.new(api_endpoint: api_endpoint.to_s, verify_ssl: false, user_agent: USER_AGENT)
     end
 
     def validate!
@@ -119,8 +120,11 @@ module VagrantLXD
 
     def synced_folders_usable?
       # Check whether we've registered an idmap for the current user.
-      if map = container[:config][:'raw.idmap']
-        true if map =~ /^uid #{Process.uid} #{VAGRANT_UID}$/
+      raw_idmap = container[:config][:'raw.idmap']
+      begin
+        raw_idmap and
+        raw_idmap =~ /^uid #{Process.uid} #{Config::VAGRANT_UID}$/ and
+        raw_idmap =~ /^gid #{Process.gid} #{Config::VAGRANT_UID}$/
       end
     rescue Vagrant::Errors::ProviderNotUsable
       false
@@ -396,19 +400,12 @@ module VagrantLXD
       # Set "raw.idmap" if the host's sub{u,g}id configuration allows it.
       # This allows sharing folders via LXD (see synced_folder.rb).
       # If the user has already specified a 'raw.idmap', leave it alone.
-      unless config.include?(:'raw.idmap')
-        begin
-          # Check for root mappings in /etc/sub{uid,gid}.
-          %w(uid gid).each do |type|
-            id = Process.send(type)
-            if File.readlines("/etc/sub#{type}").grep(/^root:#{id}:[1-9]/).any?
-              config[:'raw.idmap'] ||= ''
-              config[:'raw.idmap'] << "#{type} #{id} #{VAGRANT_UID}\n"
-            end
-          end
-        rescue StandardError => e
-          @logger.warn "Cannot read subordinate permissions file: #{e.message}"
-        end
+      if config.include?(:'raw.idmap')
+        # Manually specified, carry on.
+      elsif @machine.env.host.capability(:synced_folders)
+        config[:'raw.idmap'] = ''
+        config[:'raw.idmap'] << "uid #{Process.uid} #{Config::VAGRANT_UID}\n"
+        config[:'raw.idmap'] << "gid #{Process.gid} #{Config::VAGRANT_UID}\n"
       end
 
       @logger.debug 'Resulting configuration: ' << config.inspect

data/lib/vagrant-lxd/plugin.rb

@@ -48,5 +48,10 @@ module VagrantLXD
       require_relative 'capability'
       Capability
     end
+
+    host_capability(:linux, 'synced_folders') do
+      require_relative 'capability'
+      Capability
+    end
   end
 end

data/lib/vagrant-lxd/version.rb

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

data/templates/locales/en.yml

@@ -16,6 +16,20 @@ en:
             The machine has no snapshot named '%{name}'.
           restored: |-
             The machine has been restored to snapshot '%{name}'!
+    help:
+      shadow: |-
+        In order to use shared folders, you must first add the effective user
+        and group ID (which are currently %{uid} and %{gid}) to the host machine's
+        subuid(5) and subgid(5) files:
+        
+            $ echo root:%{uid}:1 | sudo tee -a /etc/subuid
+            $ echo root:%{gid}:1 | sudo tee -a /etc/subgid
+        
+        For more information about these commands, and user/group ID mapping in
+        general, refer to this article:
+        
+            https://insights.ubuntu.com/2017/06/15/custom-user-mappings-in-lxd-containers/
+        
     errors:
       lxd_connection_failure: |-
         The provider was unable to contact the LXD daemon at %{api_endpoint}.

data/vagrant-lxd.gemspec

@@ -35,5 +35,5 @@ Gem::Specification.new do |spec|
     f.match(%r{^(test|spec|features)/})
   end
 
-  spec.add_runtime_dependency 'hyperkit', '~> 1.1'
+  spec.add_runtime_dependency 'hyperkit', '~> 1.1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-lxd
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Evan Hanson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-10 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hyperkit
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 1.1.0
 description: A Vagrant plugin that allows management of containers using LXD.
 email:
 - evanh@catalyst.net.nz