vagrant-lxc 0.8.0 → 1.0.0.alpha.1

data/lib/vagrant-lxc/version.rb

@@ -1,5 +1,5 @@
 module Vagrant
   module LXC
-    VERSION = "0.8.0"
+    VERSION = "1.0.0.alpha.1"
   end
 end

data/locales/en.yml

@@ -12,15 +12,16 @@ en:
         Starting container...
       force_shutdown: |-
         Forcing shutdown of container...
-      # TODO: Remove the following keys after we drop support for vagrant < 1.3
-      waiting_for_start: |-
-        Waiting for container to start. This should not take long.
-      container_ready: |-
-        Container started and ready for use!
       warn_networks: |-
         Warning! The LXC provider doesn't support any of the Vagrant public / private
         network configurations (ex: `config.vm.network :private_network, ip: "some-ip"`).
         They will be silently ignored.
+      warn_group: |-
+        Warning! The LXC provider doesn't support the :group parameter for synced
+        folders. It will be silently ignored.
+      warn_owner: |-
+        Warning! The LXC provider doesn't support the :owner parameter for synced
+        folders. It will be silently ignored.
 
   vagrant:
     commands:

data/scripts/lxc-template

@@ -0,0 +1,165 @@
+#!/bin/bash
+
+# This is a modified version of /usr/share/lxc/templates/lxc-download
+# that comes with ubuntu-lxc 1.0.0 stable from ppa changed to suit vagrant-lxc needs
+#
+# Copyright © 2014 Stéphane Graber <stgraber@ubuntu.com>
+# Copyright © 2014 Fábio Rehm <fgrehm@gmail.com>
+#
+#  This library is free software; you can redistribute it and/or
+#  modify it under the terms of the GNU Lesser General Public
+#  License as published by the Free Software Foundation; either
+#  version 2.1 of the License, or (at your option) any later version.
+
+#  This library 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
+#  Lesser General Public License for more details.
+
+#  You should have received a copy of the GNU Lesser General Public
+#  License along with this library; if not, write to the Free Software
+#  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301
+#  USA
+
+set -eu
+
+LXC_HOOK_DIR="/usr/share/lxc/hooks"
+LXC_TEMPLATE_CONFIG="/usr/share/lxc/config"
+
+LXC_MAPPED_GID=
+LXC_MAPPED_UID=
+LXC_NAME=
+LXC_PATH=
+LXC_ROOTFS=
+LXC_TARBALL=
+LXC_CONFIG=
+
+usage() {
+    cat <<EOF
+vagrant-lxc default template
+
+Required arguments:
+[ --tarball <path> ]: The full path of the rootfs tarball
+
+Optional arguments:
+[ --config ]: Configuration file to be used when building the container
+[ -h | --help ]: This help message
+
+LXC internal arguments (do not pass manually!):
+[ --name <name> ]: The container name
+[ --path <path> ]: The path to the container
+[ --rootfs <rootfs> ]: The path to the container's rootfs
+[ --mapped-uid <map> ]: A uid map (user namespaces)
+[ --mapped-gid <map> ]: A gid map (user namespaces)
+EOF
+    return 0
+}
+
+options=$(getopt -o h -l tarball:,config:,help:,name:,path:,rootfs:,mapped-uid:,mapped-gid: -- "$@")SS
+
+if [ $? -ne 0 ]; then
+    usage $(basename $0)
+    exit 1
+fi
+eval set -- "$options"
+
+while true
+do
+    case "$1" in
+        -h|--help)          usage $0 && exit 0;;
+        --config)           LXC_CONFIG=$2; shift 2;;
+        --tarball)          LXC_TARBALL=$2; shift 2;;
+        --name)             LXC_NAME=$2; shift 2;;
+        --path)             LXC_PATH=$2; shift 2;;
+        --rootfs)           LXC_ROOTFS=$2; shift 2;;
+        --mapped-uid)       LXC_MAPPED_UID=$2; shift 2;;
+        --mapped-gid)       LXC_MAPPED_GID=$2; shift 2;;
+        *)                  break;;
+    esac
+done
+
+if [ -z "${LXC_NAME}" ]; then
+    echo "'name' parameter is required"
+    exit 1
+fi
+
+if [ -z "${LXC_TARBALL}" ]; then
+    echo "'tarball' parameter is required"
+    exit 1
+fi
+
+if [ -z "${LXC_ROOTFS}" ]; then
+    echo "'rootfs' parameter is required"
+    exit 1
+fi
+
+if [ -z "${LXC_CONFIG}" ]; then
+    echo "'config' parameter is required"
+    exit 1
+fi
+
+if [ -z "${LXC_PATH}" ]; then
+    echo "'path' parameter is required"
+    exit 1
+fi
+
+# Unpack the rootfs
+echo "Unpacking the rootfs"
+
+mkdir -p /var/lock/subsys
+(
+    flock -x 200
+    if [ $? -ne 0 ]; then
+        echo "Cache repository is busy."
+        exit 1
+    fi
+
+    mkdir -p ${LXC_ROOTFS}
+    (cd ${LXC_ROOTFS} && tar xfz ${LXC_TARBALL} --strip-components=2)
+    if [ $? -ne 0 ]; then
+        echo "Failed to extract rootfs"
+        exit 1
+    fi
+
+) 200>/var/lock/subsys/lxc
+
+mkdir -p ${LXC_ROOTFS}/dev/pts/
+
+## Extract all the network config entries
+sed -i -e "/lxc.network/{w ${LXC_PATH}/config-network" -e "d}" \
+    ${LXC_PATH}/config
+
+## Extract any other config entry
+sed -i -e "/lxc./{w ${LXC_PATH}/config-auto" -e "d}" ${LXC_PATH}/config
+
+## Add the container-specific config
+echo "" >> ${LXC_PATH}/config
+echo "##############################################" >> ${LXC_PATH}/config
+echo "# Container specific configuration (automatically set)" >> ${LXC_PATH}/config
+if [ -e "${LXC_PATH}/config-auto" ]; then
+    cat ${LXC_PATH}/config-auto >> ${LXC_PATH}/config
+    rm ${LXC_PATH}/config-auto
+fi
+echo "lxc.utsname = ${LXC_NAME}" >> ${LXC_PATH}/config
+
+## Re-add the previously removed network config
+if [ -e "${LXC_PATH}/config-network" ]; then
+    echo "" >> ${LXC_PATH}/config
+    echo "##############################################" >> ${LXC_PATH}/config
+    echo "# Network configuration (automatically set)" >> ${LXC_PATH}/config
+    cat ${LXC_PATH}/config-network >> ${LXC_PATH}/config
+    rm ${LXC_PATH}/config-network
+fi
+
+## Append the defaults
+echo "" >> ${LXC_PATH}/config
+echo "##############################################" >> ${LXC_PATH}/config
+echo "# vagrant-lxc base box specific configuration" >> ${LXC_PATH}/config
+cat ${LXC_CONFIG} >> ${LXC_PATH}/config
+
+# Empty section for lxc.customize calls from vagrantfile
+echo "" >> ${LXC_PATH}/config
+echo "##############################################" >> ${LXC_PATH}/config
+echo "# vagrant-lxc container specific configuration" >> ${LXC_PATH}/config
+
+exit 0

data/spec/spec_helper.rb

@@ -10,22 +10,10 @@ require 'bundler/setup'
 
 require 'i18n'
 
-require 'rspec-spies'
+require 'vagrant-lxc'
 
 Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each { |f| require f }
 
-# If we should verify constant names, eager loads
-if ENV['VERIFY_CONSTANT_NAMES']
-  require 'vagrant-lxc/plugin'
-  require 'vagrant-lxc/provider'
-  require 'vagrant-lxc/config'
-end
-
-require 'rspec/fire'
-RSpec::Fire.configure do |config|
-  config.verify_constant_names = ENV['VERIFY_CONSTANT_NAMES'] == '1'
-end
-
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
   config.run_all_when_everything_filtered = true
@@ -36,4 +24,12 @@ RSpec.configure do |config|
   # the seed, which is printed after each run.
   #     --seed 1234
   config.order = 'random'
+
+  config.mock_with :rspec do |c|
+    c.yield_receiver_to_any_instance_implementation_blocks = true
+  end
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+  config.raise_errors_for_deprecations!
 end

data/spec/unit/action/clear_forwarded_ports_spec.rb

@@ -24,12 +24,12 @@ describe Vagrant::LXC::Action::ClearForwardedPorts do
   after { FileUtils.rm_rf data_dir.to_s }
 
   it 'removes all files under pid directory' do
-    Dir[pids_dir.to_s + "/redir_*.pid"].should be_empty
+    expect(Dir[pids_dir.to_s + "/redir_*.pid"]).to be_empty
   end
 
   context 'with a valid redir pid' do
     it 'kills known processes' do
-      subject.should have_received(:system).with("pkill -TERM -P #{pid}")
+      expect(subject).to have_received(:system).with("pkill -TERM -P #{pid}")
     end
   end
 
@@ -37,7 +37,7 @@ describe Vagrant::LXC::Action::ClearForwardedPorts do
     let(:pid_cmd) { 'sudo ls' }
 
     it 'does not kill the process' do
-      subject.should_not have_received(:system).with("pkill -TERM -P #{pid}")
+      expect(subject).not_to have_received(:system).with("pkill -TERM -P #{pid}")
     end
   end
 end

data/spec/unit/action/compress_rootfs_spec.rb

@@ -1,13 +1,15 @@
 require 'unit_helper'
 
+require 'vagrant-lxc/plugin'
+require 'vagrant-lxc/provider'
 require 'vagrant-lxc/action/compress_rootfs'
 
 describe Vagrant::LXC::Action::CompressRootFS do
   let(:app)                    { double(:app, call: true) }
   let(:env)                    { {machine: machine, ui: double(info: true)} }
-  let(:machine)                { instance_double('Vagrant::Machine', provider: provider) }
-  let(:provider)               { instance_double('Vagrant::LXC::Provider', driver: driver) }
-  let(:driver)                 { instance_double('Vagrant::LXC::Driver', compress_rootfs: compressed_rootfs_path) }
+  let(:machine)                { double(Vagrant::Machine, provider: provider) }
+  let(:provider)               { double(Vagrant::LXC::Provider, driver: driver) }
+  let(:driver)                 { double(Vagrant::LXC::Driver, compress_rootfs: compressed_rootfs_path) }
   let(:compressed_rootfs_path) { '/path/to/rootfs.tar.gz' }
 
   subject { described_class.new(app, env) }
@@ -18,10 +20,10 @@ describe Vagrant::LXC::Action::CompressRootFS do
   end
 
   it "asks the driver to compress container's rootfs" do
-    driver.should have_received(:compress_rootfs)
+    expect(driver).to have_received(:compress_rootfs)
   end
 
   it 'sets export.temp_dir on action env' do
-    env['package.rootfs'].should == compressed_rootfs_path
+    expect(env['package.rootfs']).to eq(compressed_rootfs_path)
   end
 end

data/spec/unit/action/forward_ports_spec.rb

@@ -1,7 +1,7 @@
 require 'unit_helper'
 
 require 'tmpdir'
-require 'vagrant-lxc/errors'
+require 'vagrant-lxc/provider'
 require 'vagrant-lxc/action/forward_ports'
 
 describe Vagrant::LXC::Action::ForwardPorts do
@@ -9,7 +9,7 @@ describe Vagrant::LXC::Action::ForwardPorts do
   let(:env)          { {machine: machine, ui: double(info: true)} }
   let(:machine)      { double(:machine) }
   let!(:data_dir)    { Pathname.new(Dir.mktmpdir) }
-  let(:provider)     { instance_double('Vagrant::LXC::Provider', ssh_info: {host: container_ip}) }
+  let(:provider)     { double(Vagrant::LXC::Provider, ssh_info: {host: container_ip}) }
   let(:host_ip)      { '127.0.0.1' }
   let(:host_port)    { 8080 }
   let(:guest_port)   { 80 }
@@ -33,7 +33,7 @@ describe Vagrant::LXC::Action::ForwardPorts do
   it 'forwards ports using redir' do
     subject.stub(system: true)
     subject.call(env)
-    subject.should have_received(:spawn).with(
+    expect(subject).to have_received(:spawn).with(
       "redir --laddr=#{host_ip} --lport=#{host_port} --caddr=#{container_ip} --cport=#{guest_port} 2>/dev/null"
     )
   end
@@ -42,7 +42,7 @@ describe Vagrant::LXC::Action::ForwardPorts do
     forward_conf.delete(:host_ip)
     subject.stub(system: true)
     subject.call(env)
-    subject.should have_received(:spawn).with(
+    expect(subject).to have_received(:spawn).with(
       "redir --lport=#{host_port} --caddr=#{container_ip} --cport=#{guest_port} 2>/dev/null"
     )
   end
@@ -51,7 +51,7 @@ describe Vagrant::LXC::Action::ForwardPorts do
     forward_conf[:host_ip] = ' '
     subject.stub(system: true)
     subject.call(env)
-    subject.should have_received(:spawn).with(
+    expect(subject).to have_received(:spawn).with(
       "redir --lport=#{host_port} --caddr=#{container_ip} --cport=#{guest_port} 2>/dev/null"
     )
   end
@@ -60,18 +60,18 @@ describe Vagrant::LXC::Action::ForwardPorts do
     subject.stub(system: true)
     subject.call(env)
     pid_file = data_dir.join('pids', "redir_#{host_port}.pid").read
-    pid_file.should == pid
+    expect(pid_file).to eq(pid)
   end
 
   it 'allows disabling a previously forwarded port' do
     forward_conf[:disabled] = true
     subject.stub(system: true)
     subject.call(env)
-    subject.should_not have_received(:spawn)
+    expect(subject).not_to have_received(:spawn)
   end
 
   it 'raises RedirNotInstalled error if `redir` is not installed' do
     subject.stub(system: false)
-    lambda { subject.call(env) }.should raise_error(Vagrant::LXC::Errors::RedirNotInstalled)
+    expect { subject.call(env) }.to raise_error(Vagrant::LXC::Errors::RedirNotInstalled)
   end
 end

data/spec/unit/action/handle_box_metadata_spec.rb

@@ -6,7 +6,7 @@ require 'vagrant-lxc/action/handle_box_metadata'
 
 describe Vagrant::LXC::Action::HandleBoxMetadata do
   let(:app)           { double(:app, call: true) }
-  let(:env)           { {machine: machine, ui: double(info: true)} }
+  let(:env)           { {machine: machine, ui: double(info: true, warn: true)} }
   let(:machine)       { double(:machine, box: box) }
   let(:box)           { double(:box, name: 'box-name', metadata: metadata, directory: box_directory) }
   let(:box_directory) { Pathname.new('/path/to/box') }
@@ -16,55 +16,111 @@ describe Vagrant::LXC::Action::HandleBoxMetadata do
 
   subject { described_class.new(app, env) }
 
-  context 'with valid contents' do
+  context 'with 1.0.0 box' do
+    let(:version) { '1.0.0' }
+
     before do
       File.stub(exists?: true)
+      # REFACTOR: This is pretty bad
+      subject.stub_chain(:template_config_file, :exist?).and_return(true)
+      subject.stub_chain(:template_config_file, :to_s).and_return(box_directory.join('lxc-config').to_s)
       subject.call(env)
     end
 
     it 'sets the tarball argument for the template' do
-      env[:lxc_template_opts].should include(
+      expect(env[:lxc_template_opts]).to include(
+        '--tarball' => box_directory.join('rootfs.tar.gz').to_s
+      )
+    end
+
+    it 'sets the template --config parameter' do
+      expect(env[:lxc_template_opts]).to include(
+        '--config' => box_directory.join('lxc-config').to_s
+      )
+    end
+
+    it 'does not set the auth key argument for the template' do
+      expect(env[:lxc_template_opts]).not_to include(
+        '--auth-key' => vagrant_key
+      )
+    end
+
+    it 'sets the template options from metadata on env hash' do
+      expect(env[:lxc_template_opts]).to include(metadata['template-opts'])
+    end
+
+    xit 'sets the template source path on env hash' do
+      expect(env[:lxc_template_src]).to eq(box_directory.join('lxc-template').to_s)
+    end
+
+    it 'does not warn about deprecation' do
+      expect(env[:ui]).not_to have_received(:warn)
+    end
+  end
+
+  context 'with valid pre 1.0.0 box' do
+    before do
+      File.stub(exists?: true)
+      # REFACTOR: This is pretty bad
+      subject.stub_chain(:old_template_config_file, :exist?).and_return(true)
+      subject.stub_chain(:old_template_config_file, :to_s).and_return(box_directory.join('lxc.conf').to_s)
+      subject.call(env)
+    end
+
+    it 'sets the tarball argument for the template' do
+      expect(env[:lxc_template_opts]).to include(
         '--tarball' => box_directory.join('rootfs.tar.gz').to_s
       )
     end
 
     it 'sets the auth key argument for the template' do
-      env[:lxc_template_opts].should include(
+      expect(env[:lxc_template_opts]).to include(
         '--auth-key' => vagrant_key
       )
     end
 
+    it 'sets the lxc config file parameter' do
+      expect(env[:lxc_template_config]).to eq(box_directory.join('lxc.conf').to_s)
+    end
+
     it 'sets the template options from metadata on env hash' do
-      env[:lxc_template_opts].should include(metadata['template-opts'])
+      expect(env[:lxc_template_opts]).to include(metadata['template-opts'])
+    end
+
+    xit 'sets the template source path on env hash' do
+      expect(env[:lxc_template_src]).to eq(box_directory.join('lxc-template').to_s)
     end
 
-    it 'sets the template source path on env hash' do
-      env[:lxc_template_src].should == box_directory.join('lxc-template').to_s
+    it 'warns about deprecation' do
+      expect(env[:ui]).to have_received(:warn)
     end
   end
 
   describe 'with invalid contents' do
     before { File.stub(exists?: true) }
 
-    it 'raises an error if the version is != 2' do
+    it 'validates box versions' do
+      %w( 2 3 1.0.0 ).each do |v|
+        metadata['version'] = v
+        expect { subject.call(env) }.to_not raise_error
+      end
+
       metadata['version'] = '1'
-      expect {
-        subject.call(env)
-      }.to raise_error(Vagrant::LXC::Errors::IncompatibleBox)
+      expect { subject.call(env) }.to raise_error
     end
 
     it 'raises an error if the rootfs tarball cant be found' do
-      File.stub(:exists?).with(box_directory.join('rootfs.tar.gz').to_s).and_return(false)
+      allow(File).to receive(:exists?).with(box_directory.join('rootfs.tar.gz').to_s).and_return(false)
       expect {
         subject.call(env)
       }.to raise_error(Vagrant::LXC::Errors::RootFSTarballMissing)
     end
 
-    it 'raises an error if the lxc-template script cant be found' do
-      File.stub(:exists?).with(box_directory.join('lxc-template').to_s).and_return(false)
+    it 'does not raise an error if the lxc-template script cant be found' do
+      allow(File).to receive(:exists?).with(box_directory.join('lxc-template').to_s).and_return(false)
       expect {
         subject.call(env)
-      }.to raise_error(Vagrant::LXC::Errors::TemplateFileMissing)
+      }.to_not raise_error
     end
   end
 end