vagrant-tun 0.0.1

data/.gitignore

@@ -0,0 +1,10 @@
+.coverage/
+Gemfile.lock
+coverage/
+pkg/
+
+*.swp
+*.swo
+*.swn
+*.swo
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vagrant-tun.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Rick van de Loo
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Makefile

@@ -0,0 +1,16 @@
+.PHONY: all clean
+
+NAME := vagrant-tun
+VERSION := 0.1
+MAINTAINER := Rick van de Loo <rickvandeloo@gmail.com>
+DESCRIPTION := Make sure the tun module is loaded into the kernel
+
+all:
+	rake build
+test:
+	bundle exec rspec spec/
+install:
+	find pkg/ -name '*.gem' | head -n 1 | xargs vagrant plugin install
+clean:
+	git clean -xfd
+

data/README.md

@@ -0,0 +1,59 @@
+# vagrant-tun
+
+## Purpose
+
+This Vagrant plugin makes sure that there is a TUN/TAP device in a usable state.
+
+There are a couple of reasons why `/dev/net/tun` could be unavailable after provisioning. One of them is that it could be that the base image you are using does not have the `tun` module loaded by default. Another is that updating and upgrading the machine during the provisioning stage has installed a new kernel and requires a reboot for the `tun` module to be successfully loaded. This plugin tries to automate all of that.
+
+1. Check if the TUN adapter exists and is in a usable state
+
+2. If not, create it with ```mkdir -p /dev/net && mknod /dev/net/tun c 10 200 && chmod 0666 /dev/net/tun```
+
+3. If it still is not in a usable state, try to load the `tun` module into the kernel and check again
+
+4. If it is still not in a usable state, reboot the machine and check again
+
+
+## Usage
+
+### Install the plugin
+
+```
+$ vagrant plugin install vagrant-tun
+```
+
+Enable the plugin in your Vagrantfile
+```
+Vagrant.configure('2') do |config|
+        config.tun.enabled = true
+```
+
+## Development
+
+### Install the build deps
+
+```
+sudo gem install bundler rake rspec simplecov
+```
+
+### Run the tests
+```
+$ make test
+```
+
+### Create the gemfile (package)
+
+```
+$ make
+rake build
+vagrant-tun 0.0.1 built to pkg/vagrant-tun-0.0.1.gem.
+```
+
+### Install the built gemfile
+```
+$ make install
+find pkg/ -name '*.gem' | head -n 1 | xargs vagrant plugin install
+Installing the 'pkg/vagrant-tun-0.0.1.gem' plugin. This can take a few minutes...
+Installed the plugin 'vagrant-tun (0.0.1)'!
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/example/Vagrantfile

@@ -0,0 +1,10 @@
+Vagrant.configure('2') do |config|
+	config.vm.box = "archlinux_x86_64"
+	config.vm.box_url = "http://cloud.terry.im/vagrant/archlinux-x86_64.box"
+
+        config.tun.enabled = true
+
+        config.vm.provision "shell", inline: "pacman -Rsc virtualbox-guest-dkms --noconfirm"
+        config.vm.provision "shell", inline: "pacman -Syyu --noconfirm"
+end
+

data/lib/vagrant-tun/command.rb

@@ -0,0 +1,90 @@
+module VagrantTun
+  class Command
+
+    def initialize(app, env)
+      @app = app
+      @env = env
+    end
+
+    def call(env)
+      if env[:machine].config.tun.enabled
+        ensure_tun_available(env)
+      end
+      @app.call(env)
+    end
+
+    def try_load_tun_kernel_module(env)
+      load_tun_module_command = "modprobe tun"
+      env[:machine].communicate.sudo(load_tun_module_command, {:error_check => false}) do |type, data|
+        return verify_adapter(env, false)
+      end
+    end
+
+    def try_create_adapter(env)
+      env[:ui].info("Trying to create TUN adapter")
+      result = false
+      create_adapter_command = '(mkdir -p /dev/net && '
+      create_adapter_command << 'mknod /dev/net/tun c 10 200 && '
+      create_adapter_command << 'chmod 0666 /dev/net/tun) 2>/dev/null'
+      env[:machine].communicate.sudo(create_adapter_command, {:error_check => false}) do |type, data|
+        result = verify_adapter(env, false)
+        if ! result
+          result = try_load_tun_kernel_module(env)
+        end
+      end
+      return result
+    end
+
+    def verify_adapter(env, try_create)
+      env[:ui].info("Verifying TUN adapter..")
+      result = false
+      env[:machine].communicate.sudo('cat /dev/net/tun', {:error_check => false}) do |type, data|
+        adapter_state = data.to_s.strip
+        case adapter_state
+        when /\bFile descriptor in bad state\b/
+          env[:ui].info("TUN adapter OK!")
+          result = true
+        when /\bNo such file or directory\b/
+          if try_create
+            env[:ui].info("TUN adapter not OK :(")
+            result = try_create_adapter(env)
+          else
+            result = false
+          end
+        end
+      end
+      return result
+    end
+
+    # Try all strategies to get the TUN adapter in an available state
+    def iter_verify_adapter(env)
+      success = verify_adapter(env, true)
+      if ! success
+        reboot(env)
+        success = verify_adapter(env, true)
+      end
+      return success
+    end
+
+    def log_success_or_fail_message(env, success)
+      if success
+        env[:ui].info("Ensured the TUN module is loaded into the kernel.")
+      else
+        env[:ui].error("Failed to load the TUN/TAP adapter. If you are running a custom kernel make sure you have the tun module enabled.")
+      end
+    end
+
+    def ensure_tun_available(env)
+      success = iter_verify_adapter(env)
+      log_success_or_fail_message(env, success)
+    end
+
+    def reboot(env)
+      env[:ui].info("Rebooting because we couldn't load the tun module. Maybe the kernel was updated?")
+      env[:machine].action(:reload)
+      begin
+        sleep 1
+      end until env[:machine].communicate.ready?
+    end
+  end
+end

data/lib/vagrant-tun/config.rb

@@ -0,0 +1,18 @@
+require 'vagrant'
+  
+module VagrantTun
+  class Config < Vagrant.plugin("2", :config)
+    attr_accessor :enabled
+
+    def initialize
+      super
+      # UNSET_VALUE so that Vagrant can properly automatically merge multiple configurations.
+      # https://www.vagrantup.com/docs/plugins/configuration.html
+      @enabled = UNSET_VALUE
+    end
+
+    def finalize!
+      @enabled = (@enabled != UNSET_VALUE) && (@enabled != false)
+    end
+  end
+end

data/lib/vagrant-tun/version.rb

@@ -0,0 +1,5 @@
+module Vagrant
+  module Tun 
+    VERSION = "0.0.1"
+  end
+end

data/lib/vagrant-tun.rb

@@ -0,0 +1,20 @@
+require "vagrant"
+require "vagrant-tun/command"
+
+module VagrantTun
+  class Plugin < Vagrant.plugin("2")
+    name "tun"
+    description <<-DESC
+    Make sure the tun module is loaded into the kernel
+    DESC
+
+    config 'tun' do
+      require File.expand_path("../vagrant-tun/config", __FILE__)
+      Config
+    end
+
+    action_hook(:VagrantTun, :machine_action_up) do |hook|
+      hook.append(VagrantTun::Command)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'simplecov'

data/spec/unit/command/call_spec.rb

@@ -0,0 +1,71 @@
+# -*- encoding: utf-8 -*-
+# vim: set fileencoding=utf-8
+
+require 'spec_helper'
+require "vagrant-tun/command"
+
+describe VagrantTun::Command do
+  # create a fake app and env to pass into the VagrantTun::Command constructor
+  let(:app) { lambda { |env| } }
+  let(:env) { { :machine => machine,  :ui => ui } }
+
+  # pretend env contains the Vagrant ui element
+  let(:ui) do
+    double('ui').tap do |ui|
+      allow(ui).to receive(:info) { nil }
+    end
+  end
+
+  # pretend env[:machine].config.tun.enabled is false
+  let(:machine) do
+    double('machine').tap do |machine|
+      allow(machine).to receive(:config) { config }
+    end
+  end
+  let(:config) do
+    double('config').tap do |config|
+      allow(config).to receive(:tun) { tun }
+    end
+  end
+  let(:tun) do
+    double('tun').tap do |config|
+      allow(config).to receive(:enabled) { enabled }
+    end
+  end
+  let(:enabled) { false }
+
+
+  # Call the method under test after every 'it'. Similar to setUp in Python TestCase
+  after do
+    subject.call(env)
+  end
+
+  # instantiate class of which a method is to be tested
+  subject { described_class.new(app, env) }
+
+  # the method that we are going to test
+  describe "#call" do
+
+    context "when config tun disabled (default)" do
+      it "does nothing but call the super" do
+        # check ensure_tun_available is not called when plugin is disabled
+        expect(subject).to receive(:ensure_tun_available).never
+        # check super is still called when plugin is disabled
+        expect(app).to receive(:call).with(env)
+      end
+    end
+
+    context "when config tun enabled" do
+      # pretend env[:machine].config.tun.enabled is true
+      let(:enabled) { true }
+
+      it "ensures the tun adapter is available" do
+        # check ensure_tun_available is called when plugin is enabled
+        expect(subject).to receive(:ensure_tun_available).with(env)
+        # check super is also called when plugin is enabled
+        expect(app).to receive(:call).with(env)
+      end
+    end
+  end
+end
+

data/spec/unit/command/ensure_tun_available_spec.rb

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+# vim: set fileencoding=utf-8
+
+require 'spec_helper'
+require "vagrant-tun/command"
+
+describe VagrantTun::Command do
+  # create a fake app and env to pass into the VagrantTun::Command constructor
+  let(:app) { lambda { |env| } }
+  let(:env) { { } }
+
+  # Call the method under test after every 'it'. Similar to setUp in Python TestCase
+  after do
+    subject.ensure_tun_available(env)
+  end
+
+  # instantiate class of which a method is to be tested
+  subject { described_class.new(app, env) }
+
+  # the method that we are going to test
+  describe "#ensure_tun_available" do
+
+    context "when ensuring tun available" do
+      it "tries all the strategies to get the TUN adapter in an available state and can fail" do
+        # check if iter_verify_adapter is called and pretend it returned false
+        expect(subject).to receive(:iter_verify_adapter).with(env).and_return(false)
+        # check log_success_or_fail_message is called
+        expect(subject).to receive(:log_success_or_fail_message).with(env, false)
+      end
+
+      it "tries all the strategies to get the TUN adapter in an available state and can succeed" do
+        # check if iter_verify_adapter is called and pretend it returned true
+        expect(subject).to receive(:iter_verify_adapter).with(env).and_return(true)
+        # check log_success_or_fail_message is called
+        expect(subject).to receive(:log_success_or_fail_message).with(env, true)
+      end
+    end
+  end
+end
+

data/spec/unit/command/iter_verify_adapter_spec.rb

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+# vim: set fileencoding=utf-8
+
+require 'spec_helper'
+require "vagrant-tun/command"
+
+describe VagrantTun::Command do
+  # create a fake app and env to pass into the VagrantTun::Command constructor
+  let(:app) { lambda { |env| } }
+  let(:env) { { } }
+
+  # instantiate class of which a method is to be tested
+  subject { described_class.new(app, env) }
+
+  # the method that we are going to test
+  describe "#iter_verify_adapter" do
+
+    context "iterating over all strategies" do
+      it "verifies the adapter with try create and succeeds" do
+	# check if verify_adapter is called once and pretend it returned true
+        expect(subject).to receive(:verify_adapter).once.with(env, true).and_return(true)
+	# check that the machine is not rebooted
+        expect(subject).to receive(:reboot).never
+	# check if iter_verify_adapter returned true
+	expect( subject.iter_verify_adapter(env) ).to eq(true)
+      end
+
+      it "verifies the adapter with try create and fails the first time" do
+	# check if verify_adapter is called twice and pretend it returned true
+        expect(subject).to receive(:verify_adapter).twice.with(env, true).and_return(false, true)
+	# check that the machine is rebooted
+        expect(subject).to receive(:reboot).once.with(env)
+	# check if iter_verify_adapter returned true
+	expect( subject.iter_verify_adapter(env) ).to eq(true)
+      end
+
+      it "verifies the adapter with try create and fails both times" do
+	# check if verify_adapter is called twice and pretend it returned true
+        expect(subject).to receive(:verify_adapter).twice.with(env, true).and_return(false, false)
+	# check that the machine is rebooted
+        expect(subject).to receive(:reboot).once.with(env)
+	# check if iter_verify_adapter returned false
+	expect( subject.iter_verify_adapter(env) ).to eq(false)
+      end
+    end
+  end
+end

data/vagrant-tun.gemspec

@@ -0,0 +1,22 @@
+require File.expand_path('../lib/vagrant-tun/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-tun"
+  spec.version       = Vagrant::Tun::VERSION
+  spec.authors       = ["Rick van de Loo"]
+  spec.email         = ["rickvandeloo@gmail.com"]
+  spec.description   = %q{Make sure the TUN module is loaded into the kernel}
+  spec.summary       = %q{Make sure the TUN module is loaded into the kernel}
+  spec.homepage      = "https://github.com/vdloo/vagrant-tun"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files`.split("\n")
+  spec.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "simplecov"
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-tun
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rick van de Loo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Make sure the TUN module is loaded into the kernel
+email:
+- rickvandeloo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- example/Vagrantfile
+- lib/vagrant-tun.rb
+- lib/vagrant-tun/command.rb
+- lib/vagrant-tun/config.rb
+- lib/vagrant-tun/version.rb
+- spec/spec_helper.rb
+- spec/unit/command/call_spec.rb
+- spec/unit/command/ensure_tun_available_spec.rb
+- spec/unit/command/iter_verify_adapter_spec.rb
+- vagrant-tun.gemspec
+homepage: https://github.com/vdloo/vagrant-tun
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Make sure the TUN module is loaded into the kernel
+test_files: []