vagrant-lxc 0.8.0 → 1.0.0.alpha.1

data/development/Vagrantfile

@@ -52,8 +52,6 @@ Vagrant.configure("2") do |config|
   config.vm.synced_folder "../", "/vagrant", id: 'vagrant-root', nfs: true
 
   config.cache.scope = :machine
-  config.cache.auto_detect = true
-  config.cache.enable_nfs = true
 
   ip_suffix = 30
   BOXES.each do |box_name, box_config|

data/lib/vagrant-backports/README.md

@@ -0,0 +1,12 @@
+# vagrant-backports
+
+<!--
+[![Build Status](https://travis-ci.org/fgrehm/vagrant-backports.png?branch=master)](https://travis-ci.org/fgrehm/vagrant-backports) [![Gem Version](https://badge.fury.io/rb/vagrant-backports.png)](http://badge.fury.io/rb/vagrant-backports) [![Code Climate](https://codeclimate.com/github/fgrehm/vagrant-backports.png)](https://codeclimate.com/github/fgrehm/vagrant-backports) [![Coverage Status](https://coveralls.io/repos/fgrehm/vagrant-backports/badge.png?branch=master)](https://coveralls.io/r/fgrehm/vagrant-backports) [![Gittip](http://img.shields.io/gittip/fgrehm.svg)](https://www.gittip.com/fgrehm/)
+-->
+
+A _"hypothetical"_ gem that helps Vagrant plugin developers to stay sane when
+keeping up with Vagrant improvements by backporting parts of its recent versions
+functionality.
+
+More information will be provided if there is enough interest on having this
+extracted as a separate gem.

data/lib/vagrant-backports/action/handle_box.rb

@@ -0,0 +1 @@
+Vagrant::Action::Builtin.const_set :HandleBox, Vagrant::Action::Builtin::HandleBoxUrl

data/lib/vagrant-backports/action/is_state.rb

@@ -0,0 +1,34 @@
+module Vagrant
+  module Backports
+    module Action
+      # This middleware is meant to be used with Call and can check if
+      # a machine is in the given state ID.
+      class IsState
+        # Note: Any of the arguments can be arrays as well.
+        #
+        # @param [Symbol] target_state The target state ID that means that
+        #   the machine was properly shut down.
+        # @param [Symbol] source_state The source state ID that the machine
+        #   must be in to be shut down.
+        def initialize(app, env, check, **opts)
+          @app    = app
+          @logger = Log4r::Logger.new("vagrant::action::builtin::is_state")
+          @check  = check
+          @invert = !!opts[:invert]
+        end
+
+        def call(env)
+          @logger.debug("Checking if machine state is '#{@check}'")
+          state = env[:machine].state.id
+          @logger.debug("-- Machine state: #{state}")
+
+          env[:result] = @check == state
+          env[:result] = !env[:result] if @invert
+          @app.call(env)
+        end
+      end
+    end
+  end
+end
+
+Vagrant::Action::Builtin.const_set :IsState, Vagrant::Backports::Action::IsState

data/lib/vagrant-backports/action/message.rb

@@ -0,0 +1,20 @@
+module Vagrant
+  module Backports
+    module Action
+      # This middleware simply outputs a message to the UI.
+      class Message
+        def initialize(app, env, message, **opts)
+          @app     = app
+          @message = message
+        end
+
+        def call(env)
+          env[:ui].info(@message)
+          @app.call(env)
+        end
+      end
+    end
+  end
+end
+
+Vagrant::Action::Builtin.const_set :Message, Vagrant::Backports::Action::Message

data/lib/{vagrant-lxc → vagrant-backports}/action/wait_for_communicator.rb

@@ -1,12 +1,11 @@
-# This acts like a backport of Vagrant's built in action from 1.3+ for older versions
-# and will probably be deprecated on 0.8+
+# This acts like a backport of Vagrant's built in action from 1.3+ for previous version
 #   https://github.com/mitchellh/vagrant/blob/master/lib/vagrant/action/builtin/wait_for_communicator.rb
 module Vagrant
-  module LXC
+  module Backports
     module Action
       class WaitForCommunicator
         def initialize(app, env)
-          @app    = app
+          @app = app
         end
 
         def call(env)
@@ -21,7 +20,7 @@ module Vagrant
           max_tries = @env[:machine].config.ssh.max_tries.to_i
           max_tries.times do |i|
             if @env[:machine].communicate.ready?
-              @env[:ui].info I18n.t("vagrant_lxc.messages.container_ready")
+              @env[:ui].info 'Machine booted and ready!'
               return true
             end
 
@@ -39,3 +38,5 @@ module Vagrant
     end
   end
 end
+
+Vagrant::Action::Builtin.const_set :WaitForCommunicator, Vagrant::Backports::Action::WaitForCommunicator

data/lib/vagrant-backports/ui.rb

@@ -0,0 +1,12 @@
+module Vagrant
+  module UI
+    class Interface
+      def output(*args)
+        info(*args)
+      end
+      def detail(*args)
+        info(*args)
+      end
+    end
+  end
+end

data/lib/vagrant-backports/utils.rb

@@ -0,0 +1,27 @@
+module Vagrant
+  module Backports
+    class << self
+      def vagrant_1_2_or_later?
+        greater_than?('1.2.0')
+      end
+
+      def vagrant_1_3_or_later?
+        greater_than?('1.3.0')
+      end
+
+      def vagrant_1_4_or_later?
+        greater_than?('1.4.0')
+      end
+
+      def vagrant_1_5_or_later?
+        greater_than?('1.5.0')
+      end
+
+      private
+
+      def greater_than?(version)
+        Gem::Version.new(Vagrant::VERSION) >= Gem::Version.new(version)
+      end
+    end
+  end
+end

data/lib/vagrant-lxc.rb

@@ -1,2 +1,10 @@
 require "vagrant-lxc/version"
 require "vagrant-lxc/plugin"
+
+module Vagrant
+  module LXC
+    def self.source_root
+      @source_root ||= Pathname.new(File.dirname(__FILE__)).join('..').expand_path
+    end
+  end
+end

data/lib/vagrant-lxc/action.rb

@@ -1,28 +1,28 @@
 require 'vagrant-lxc/action/boot'
-require 'vagrant-lxc/action/check_created'
-require 'vagrant-lxc/action/check_running'
 require 'vagrant-lxc/action/clear_forwarded_ports'
 require 'vagrant-lxc/action/create'
-require 'vagrant-lxc/action/created'
 require 'vagrant-lxc/action/destroy'
 require 'vagrant-lxc/action/destroy_confirm'
-require 'vagrant-lxc/action/disconnect'
 require 'vagrant-lxc/action/compress_rootfs'
 require 'vagrant-lxc/action/fetch_ip_with_lxc_attach'
 require 'vagrant-lxc/action/fetch_ip_from_dnsmasq_leases'
 require 'vagrant-lxc/action/forced_halt'
 require 'vagrant-lxc/action/forward_ports'
 require 'vagrant-lxc/action/handle_box_metadata'
-require 'vagrant-lxc/action/is_running'
-require 'vagrant-lxc/action/message'
+require 'vagrant-lxc/action/prepare_nfs_settings'
+require 'vagrant-lxc/action/prepare_nfs_valid_ids'
 require 'vagrant-lxc/action/remove_temporary_files'
 require 'vagrant-lxc/action/setup_package_files'
-require 'vagrant-lxc/action/share_folders'
 require 'vagrant-lxc/action/warn_networks'
 
-unless Vagrant::LXC.vagrant_1_3_or_later
-  require 'vagrant-lxc/action/wait_for_communicator'
-  Vagrant::Action::Builtin.const_set :WaitForCommunicator, Vagrant::LXC::Action::WaitForCommunicator
+unless Vagrant::Backports.vagrant_1_3_or_later?
+  require 'vagrant-backports/action/wait_for_communicator'
+end
+unless Vagrant::Backports.vagrant_1_5_or_later?
+  require 'vagrant-backports/ui'
+  require 'vagrant-backports/action/handle_box'
+  require 'vagrant-backports/action/message'
+  require 'vagrant-backports/action/is_state'
 end
 
 module Vagrant
@@ -37,9 +37,9 @@ module Vagrant
       # machine back up with the new configuration.
       def self.action_reload
         Builder.new.tap do |b|
-          b.use Builtin::Call, Created do |env1, b2|
-            if !env1[:result]
-              b2.use Message, :not_created
+          b.use Builtin::Call, Builtin::IsState, :not_created do |env1, b2|
+            if env1[:result]
+              b2.use Builtin::Message, I18n.t("vagrant_lxc.messages.not_created")
               next
             end
 
@@ -57,7 +57,15 @@ module Vagrant
           b.use Builtin::Provision
           b.use Builtin::EnvSet, :port_collision_repair => true
           b.use Builtin::HandleForwardedPortCollisions
-          b.use ShareFolders
+          if Vagrant::Backports.vagrant_1_4_or_later?
+            b.use PrepareNFSValidIds
+            b.use Builtin::SyncedFolderCleanup
+            b.use Builtin::SyncedFolders
+            b.use PrepareNFSSettings
+          else
+            require 'vagrant-lxc/backports/action/share_folders'
+            b.use ShareFolders
+          end
           b.use Builtin::SetHostname
           b.use WarnNetworks
           b.use ForwardPorts
@@ -70,15 +78,15 @@ module Vagrant
       def self.action_provision
         Builder.new.tap do |b|
           b.use Builtin::ConfigValidate
-          b.use Builtin::Call, Created do |env1, b2|
-            if !env1[:result]
-              b2.use Message, :not_created
+          b.use Builtin::Call, Builtin::IsState, :not_created do |env1, b2|
+            if env1[:result]
+              b2.use Builtin::Message, I18n.t("vagrant_lxc.messages.not_created")
               next
             end
 
-            b2.use Builtin::Call, IsRunning do |env2, b3|
+            b2.use Builtin::Call, Builtin::IsState, :running do |env2, b3|
               if !env2[:result]
-                b3.use Message, :not_running
+                b3.use Builtin::Message, I18n.t("vagrant_lxc.messages.not_running")
                 next
               end
 
@@ -93,7 +101,7 @@ module Vagrant
       def self.action_start
         Builder.new.tap do |b|
           b.use Builtin::ConfigValidate
-          b.use Builtin::Call, IsRunning do |env, b2|
+          b.use Builtin::Call, Builtin::IsState, :running do |env, b2|
             # If the VM is running, then our work here is done, exit
             next if env[:result]
             b2.use action_boot
@@ -106,10 +114,10 @@ module Vagrant
       def self.action_up
         Builder.new.tap do |b|
           b.use Builtin::ConfigValidate
-          b.use Builtin::Call, Created do |env, b2|
+          b.use Builtin::Call, Builtin::IsState, :not_created do |env, b2|
             # If the VM is NOT created yet, then do the setup steps
-            if !env[:result]
-              b2.use Builtin::HandleBoxUrl
+            if env[:result]
+              b2.use Builtin::HandleBox
               b2.use HandleBoxMetadata
               b2.use Create
             end
@@ -122,19 +130,18 @@ module Vagrant
       # the virtual machine, gracefully or by force.
       def self.action_halt
         Builder.new.tap do |b|
-          b.use Builtin::Call, Created do |env, b2|
+          b.use Builtin::Call, Builtin::IsState, :not_created do |env, b2|
             if env[:result]
-              # TODO: Remove once we drop support for vagrant 1.1
-              b2.use Disconnect
-              b2.use ClearForwardedPorts
-              b2.use RemoveTemporaryFiles
-              b2.use Builtin::Call, Builtin::GracefulHalt, :stopped, :running do |env2, b3|
-                if !env2[:result]
-                  b3.use ForcedHalt
-                end
+              b2.use Builtin::Message, I18n.t("vagrant_lxc.messages.not_created")
+              next
+            end
+
+            b2.use ClearForwardedPorts
+            b2.use RemoveTemporaryFiles
+            b2.use Builtin::Call, Builtin::GracefulHalt, :stopped, :running do |env2, b3|
+              if !env2[:result]
+                b3.use ForcedHalt
               end
-            else
-              b2.use Message, :not_created
             end
           end
         end
@@ -144,9 +151,9 @@ module Vagrant
       # freeing the resources of the underlying virtual machine.
       def self.action_destroy
         Builder.new.tap do |b|
-          b.use Builtin::Call, Created do |env1, b2|
-            if !env1[:result]
-              b2.use Message, :not_created
+          b.use Builtin::Call, Builtin::IsState, :not_created do |env1, b2|
+            if env1[:result]
+              b2.use Builtin::Message, I18n.t("vagrant_lxc.messages.not_created")
               next
             end
 
@@ -157,11 +164,11 @@ module Vagrant
                 b3.use Builtin::EnvSet, :force_halt => true
                 b3.use action_halt
                 b3.use Destroy
-                if Vagrant::LXC.vagrant_1_3_or_later
+                if Vagrant::Backports.vagrant_1_3_or_later?
                   b3.use Builtin::ProvisionerCleanup
                 end
               else
-                b3.use Message, :will_not_destroy
+                b3.use Builtin::Message, I18n.t("vagrant_lxc.messages.will_not_destroy")
               end
             end
           end
@@ -171,9 +178,9 @@ module Vagrant
       # This action packages the virtual machine into a single box file.
       def self.action_package
         Builder.new.tap do |b|
-          b.use Builtin::Call, Created do |env1, b2|
-            if !env1[:result]
-              b2.use Message, :not_created
+          b.use Builtin::Call, Builtin::IsState, :not_created do |env1, b2|
+            if env1[:result]
+              b2.use Builtin::Message, I18n.t("vagrant_lxc.messages.not_created")
               next
             end
 
@@ -198,18 +205,44 @@ module Vagrant
       # This is the action that will exec into an SSH shell.
       def self.action_ssh
         Builder.new.tap do |b|
-          b.use CheckCreated
-          b.use CheckRunning
-          b.use Builtin::SSHExec
+          b.use Builtin::ConfigValidate
+          b.use Builtin::Call, Builtin::IsState, :not_created do |env, b2|
+            if env[:result]
+              b2.use Builtin::Message, I18n.t("vagrant_lxc.messages.not_created")
+              next
+            end
+
+            b2.use Builtin::Call, Builtin::IsState, :running do |env1, b3|
+              if !env1[:result]
+                b3.use Builtin::Message, I18n.t("vagrant_lxc.messages.not_running")
+                next
+              end
+
+              b3.use Builtin::SSHExec
+            end
+          end
         end
       end
 
       # This is the action that will run a single SSH command.
       def self.action_ssh_run
         Builder.new.tap do |b|
-          b.use CheckCreated
-          b.use CheckRunning
-          b.use Builtin::SSHRun
+          b.use Builtin::ConfigValidate
+          b.use Builtin::Call, Builtin::IsState, :not_created do |env, b2|
+            if env[:result]
+              b2.use Builtin::Message, I18n.t("vagrant_lxc.messages.not_created")
+              next
+            end
+
+            b2.use Builtin::Call, Builtin::IsState, :running do |env1, b3|
+              if !env1[:result]
+                raise Vagrant::Errors::VMNotRunningError
+                next
+              end
+
+              b3.use Builtin::SSHRun
+            end
+          end
         end
       end
     end

data/lib/vagrant-lxc/action/boot.rb

@@ -11,7 +11,8 @@ module Vagrant
 
           config = env[:machine].provider_config
 
-          config.customize 'utsname', env[:machine].id
+          utsname = env[:machine].config.vm.hostname || env[:machine].id
+          config.customize 'utsname', utsname
 
           env[:ui].info I18n.t("vagrant_lxc.messages.starting")
           env[:machine].provider.driver.start(config.customizations)

data/lib/vagrant-lxc/action/fetch_ip_from_dnsmasq_leases.rb

@@ -35,6 +35,7 @@ module Vagrant
           /var/lib/misc/dnsmasq.leases
           /var/lib/dnsmasq/dnsmasq.leases
           /var/db/dnsmasq.leases
+          /var/lib/libvirt/dnsmasq/*.leases
         )
 
         def read_dnsmasq_leases

data/lib/vagrant-lxc/action/handle_box_metadata.rb

@@ -3,7 +3,8 @@ module Vagrant
     module Action
       # Prepare arguments to be used for lxc-create
       class HandleBoxMetadata
-        SUPPORTED_VERSIONS = [2, 3]
+        SUPPORTED_VERSIONS  = ['1.0.0', '2', '3']
+
         def initialize(app, env)
           @app    = app
           @logger = Log4r::Logger.new("vagrant::lxc::action::handle_box_metadata")
@@ -16,34 +17,51 @@ module Vagrant
           @env[:ui].info I18n.t("vagrant.actions.vm.import.importing",
                                 :name => @env[:machine].box.name)
 
-          @logger.debug 'Validating box contents'
+          @logger.info 'Validating box contents'
           validate_box
 
-          @logger.debug 'Setting box options on environment'
-          @env[:lxc_template_opts] = template_opts
+          @logger.info 'Setting box options on environment'
           @env[:lxc_template_src]  = template_src
+          @env[:lxc_template_opts] = template_opts
+
+          # FIXME: Remove support for pre 1.0.0 boxes
+          if box_version != '1.0.0'
+            @env[:ui].warn "WARNING: You are using a base box that has a format that has been deprecated, please upgrade to a new one."
+            @env[:lxc_template_opts].merge!(
+              '--auth-key' => Vagrant.source_root.join('keys', 'vagrant.pub').expand_path.to_s
+            )
+          end
 
           if template_config_file.exist?
-            @env[:lxc_template_config] = template_config_file.to_s
+            @env[:lxc_template_opts].merge!('--config' => template_config_file.to_s)
+          elsif old_template_config_file.exist?
+            @env[:lxc_template_config] = old_template_config_file.to_s
           end
 
           @app.call env
         end
 
         def template_src
-          @template_src ||= @box.directory.join('lxc-template').to_s
+          @template_src ||=
+            if (box_template = @box.directory.join('lxc-template')).exist?
+              box_template.to_s
+            else
+              Vagrant::LXC.source_root.join('scripts/lxc-template').to_s
+            end
         end
 
         def template_config_file
-          @template_config_file ||= @box.directory.join('lxc.conf')
+          @template_config_file ||= @box.directory.join('lxc-config')
+        end
+
+        # TODO: Remove this once we remove compatibility for < 1.0.0 boxes
+        def old_template_config_file
+          @old_template_config_file ||= @box.directory.join('lxc.conf')
         end
 
         def template_opts
           @template_opts ||= @box.metadata.fetch('template-opts', {}).dup.merge!(
-            '--tarball'  => rootfs_tarball,
-            # TODO: Deprecate this, the rootfs should be ready for vagrant-lxc
-            #       SSH access at this point
-            '--auth-key' => Vagrant.source_root.join('keys', 'vagrant.pub').expand_path.to_s
+            '--tarball'  => rootfs_tarball
           )
         end
 
@@ -52,10 +70,10 @@ module Vagrant
         end
 
         def validate_box
-          unless SUPPORTED_VERSIONS.include? @box.metadata.fetch('version').to_i
+          unless SUPPORTED_VERSIONS.include? box_version
             raise Errors::IncompatibleBox.new name: @box.name,
-                                              found: @box.metadata.fetch('version').to_i,
-                                              supported: SUPPORTED_VERSIONS.join(' and ')
+                                              found: box_version,
+                                              supported: SUPPORTED_VERSIONS.join(', ')
           end
 
           unless File.exists?(template_src)
@@ -66,6 +84,10 @@ module Vagrant
             raise Errors::RootFSTarballMissing.new name: @box.name
           end
         end
+
+        def box_version
+          @box.metadata.fetch('version')
+        end
       end
     end
   end