vagrant-bhyve 0.1.0

data/lib/vagrant-bhyve/errors.rb

@@ -0,0 +1,55 @@
+require "vagrant"
+
+module VagrantPlugins
+  module ProviderBhyve
+    module Errors
+      class VagrantBhyveError < Vagrant::Errors::VagrantError
+	error_namespace('vagrant_bhyve.errors')
+      end
+
+      class SystemVersionIsTooLow < VagrantBhyveError
+	error_key(:system_version_too_low)
+      end
+
+      class MissingPopcnt < VagrantBhyveError
+	error_key(:missing_popcnt)
+      end
+
+      class MissingEpt < VagrantBhyveError
+	error_key(:missing_ept)
+      end
+
+      class MissingIommu < VagrantBhyveError
+	error_key(:missing_iommu)
+      end
+
+      class HasNoRootPrivilege < VagrantBhyveError
+	error_key(:has_no_root_privilege)
+      end
+
+      class ExecuteError < VagrantBhyveError
+	error_key(:execute_error)
+      end
+
+      class UnableToLoadModule < VagrantBhyveError
+	error_key(:unable_to_load_module)
+      end
+
+      class UnableToCreateInterface < VagrantBhyveError
+	error_key(:unable_to_create_interface)
+      end
+
+      class GrubBhyveNotinstalled < VagrantBhyveError
+	error_key(:grub_bhyve_not_installed)
+      end
+
+      class RestartServiceFailed < VagrantBhyveError
+	error_key(:restart_service_failed)
+      end
+
+      class NotFoundLeasesInfo < VagrantBhyveError
+	error_key(:not_found_leases_info)
+      end
+    end
+  end
+end

data/lib/vagrant-bhyve/executor.rb

@@ -0,0 +1,38 @@
+require "vagrant/util/busy"
+require "vagrant/util/subprocess"
+
+module VagrantPlugins
+  module ProviderBhyve
+    module Executor
+      # This class is used to execute commands as subprocess.
+      class Exec
+	# When we need the command's exit code we should set parameter 
+	# exit_code to true, otherwise this method will return executed
+	# command's stdout
+	def execute(exit_code, *cmd, **opts, &block)
+	  # Append in the options for subprocess
+	  cmd << { notify: [:stdout, :stderr] }
+	  cmd.unshift('sh', '-c')
+
+	  interrupted = false
+	  # Lambda to change interrupted to true
+	  int_callback = ->{ interrupted = true }
+	  result = ::Vagrant::Util::Busy.busy(int_callback) do
+	    ::Vagrant::Util::Subprocess.execute(*cmd, &block)
+	  end
+
+	  return result.exit_code if exit_code
+
+	  result.stderr.gsub!("\r\n", "\n")
+	  result.stdout.gsub!("\r\n", "\n")
+
+	  if result.exit_code != 0 || interrupted
+	    raise Errors::ExecuteError
+	  end
+
+	  result.stdout[0..-2]
+	end
+      end
+    end
+  end
+end

data/lib/vagrant-bhyve/plugin.rb

@@ -0,0 +1,73 @@
+begin
+  require "vagrant"
+rescue LoadError
+  raise "The Vagrant Bhyve plugin must be run within Vagrant."
+end
+
+#############################################################
+#		TBD	some version check		    #
+#############################################################
+
+module VagrantPlugins
+  module ProviderBhyve
+    class Plugin < Vagrant.plugin('2')
+      name "bhyve"
+      description <<-DESC
+      This plugin allows vagrant to manage VMs in bhyve, the hypervisor
+      provided by FreeBSD's kernel
+      DESC
+
+      config(:bhyve, :provider) do
+	require_relative "config"
+	Config
+      end
+
+      provider(:bhyve) do
+        require_relative "provider"
+	Provider
+      end
+
+      # This initializes the internationalization strings.
+      def self.setup_i18n
+        I18n.load_path << File.expand_path('locales/en.yml',
+                                           ProviderBhyve.source_root)
+        I18n.reload!
+      end
+
+      # This sets up our log level to be whatever VAGRANT_LOG is.
+      def self.setup_logging
+        require 'log4r'
+
+        level = nil
+        begin
+          level = Log4r.const_get(ENV['VAGRANT_LOG'].upcase)
+        rescue NameError
+          # This means that the logging constant wasn't found,
+          # which is fine. We just keep `level` as `nil`. But
+          # we tell the user.
+          level = nil
+        end
+
+        # Some constants, such as "true" resolve to booleans, so the
+        # above error checking doesn't catch it. This will check to make
+        # sure that the log level is an integer, as Log4r requires.
+        level = nil if !level.is_a?(Integer)
+
+        # Set the logging level on all "vagrant" namespaced
+        # logs as long as we have a valid level.
+        if level
+          logger = Log4r::Logger.new('vagrant_bhyve')
+          logger.outputters = Log4r::Outputter.stderr
+          logger.level = level
+          logger = nil
+        end
+      end
+
+      # Setup logging and i18n before any autoloading loads other classes
+      # with logging configured as this prevents inheritance of the log level
+      # from the parent logger.
+      setup_logging
+      setup_i18n
+    end
+  end
+end

data/lib/vagrant-bhyve/provider.rb

@@ -0,0 +1,126 @@
+require "vagrant"
+require "log4r"
+
+module VagrantPlugins
+  module ProviderBhyve
+    autoload :Driver, 'vagrant-bhyve/driver'
+
+    class Provider < Vagrant.plugin('2', :provider)
+
+      def initialize(machine)
+	@logger = Log4r::Logger.new("vagrant::provider::bhyve")
+	@machine = machine
+      end
+
+      def driver
+	return @driver if @driver
+	@driver = Driver.new(@machine)
+      end
+
+      # This should return a hash of information that explains how to SSH
+      # into the machine. If the machine is not at a point where SSH is 
+      # even possiable, then 'nil' should be returned
+      #
+      # The general structure of this returned hash should be the
+      # following:
+      #
+      # 	{
+      # 	 host: "1.2.3.4",
+      # 	 port: "22",
+      # 	 username: "vagrant",
+      # 	 private_key_path: "/path/to/my/key"
+      # 	}
+      def ssh_info
+	# We just return nil if were not able to identify the VM's IP and
+	# let Vagrant core deal with it like docker provider does
+	return nil if state.id != :running
+	tap_device	= driver.get_attr('tap')
+	ip		= driver.get_ip_address(tap_device) unless tap_device.length == 0
+	return nil if !ip
+	ssh_info = {
+	  host: ip,
+	  port: 22,
+	}
+      end
+
+      # This is called early, before a machine is instantiated, to check
+      # if this provider is usable. This should return true or false.
+      #
+      # If raise_error is true, then instead of returning false, this
+      # should raise an error with a helpful message about why this
+      # provider cannot be used.
+      #
+      # @param [Boolean] raise_error If true, raise exception if not usable.
+      # @return [Boolean]
+      def self.usable?(raise_error=false)
+	# Return true by default for backwards compat since this was
+	# introduced long after providers were being written.
+	true
+      end
+
+      # This is called early, before a machine is instantiated, to check
+      # if this provider is installed. This should return true or false.
+      #
+      # If the provider is not installed and Vagrant determines it is
+      # able to install this provider, then it will do so. Installation
+      # is done by calling Environment.install_provider.
+      #
+      # If Environment.can_install_provider? returns false, then an error
+      # will be shown to the user.
+      def self.installed?
+	# By default return true for backwards compat so all providers
+	# continue to work.
+	true
+      end
+
+      # This should return an action callable for the given name.
+      #
+      # @param [Symbol] name Name of the action.
+      # @return [Object] A callable action sequence object, whether it
+      #   is a proc, object, etc.
+      def action(name)
+	# Attrmpt to get the action method from the Action class if it 
+	# exists, otherwise return nil to show that we don't support the
+	# given action
+	action_method = "action_#{name}"
+	return Action.send(action_method) if Action.respond_to?(action_method)
+	nil
+      end
+
+      # This method is called if the underying machine ID changes. Providers
+      # can use this method to load in new data for the actual backing
+      # machine or to realize that the machine is now gone (the ID can
+      # become `nil`). No parameters are given, since the underlying machine
+      # is simply the machine instance given to this object. And no
+      # return value is necessary.
+      def machine_id_changed
+      end
+
+      # This should return the state of the machine within this provider.
+      # The state must be an instance of {MachineState}. Please read the
+      # documentation of that class for more information.
+      #
+      # @return [MachineState]
+      def state
+	state_id = nil
+	if @machine.id
+	  vm_name	= driver.get_attr('vm_name')
+	  if vm_name.nil?
+	    state_id	= :uncreated
+	  else
+	    state_id	= driver.state(vm_name)
+	  end
+	else
+	  state_id 	= :uncreated
+	end
+        short = state_id.to_s.gsub("_", " ")
+        long  = I18n.t("vagrant_bhyve.states.#{state_id}")
+        # If we're not created, then specify the special ID flag
+        state_id = Vagrant::MachineState::NOT_CREATED_ID if state_id == :uncreated
+        # Return the MachineState object
+        Vagrant::MachineState.new(state_id, short, long)
+      end
+
+    end
+  end
+end

data/lib/vagrant-bhyve/version.rb

@@ -0,0 +1,5 @@
+module VagrantPlugins
+  module ProviderBhyve
+    VERSION = "0.1.0"
+  end
+end

data/locales/en.yml

@@ -0,0 +1,90 @@
+en:
+  vagrant_bhyve:
+    commands:
+      common:
+        vm_not_created: |-
+          You are destroying a uncreated instance.
+        vm_not_running: |-
+          You are invokng this action on a box which is not running.
+        vm_already_running: |-
+          Your box has already be booted.
+
+    action:
+      vm:
+        setup_environment: |-
+          Checking if your system supports bhyve and loading kernel modules
+          we need to create bhyve VMs. You will be asked for password for
+          sudo if you are not running vagrant with root user.
+        import_box: |-
+          Copying box files.
+        forward_ports: |-
+          Setup port forwarding(if any).
+        boot:
+          setup_nat: |-
+            Setting up a nat environment using pf and dnsmasq to provide 
+            network for VMs. You will need to have dnsmasq installed on
+            your system.
+          create_tap: |-
+            Creating tap device for VM to use.
+          load_kernel: |-
+            Loading guest OS's kernel into memory.
+          booting: |-
+            Booting VM with bhyve.
+          wait_until_up: |-
+            Please wait for a while until we can ssh into box.
+        halt:
+          shutting_down: |- 
+            Trying to shutdown your VM through ACPI.
+          force_halt: |-
+            We have to force your VM to halt.
+          cleaning_up: |-
+            Cleaning up your environment.
+        reload:
+          reloading: |-
+            Rebooting your box.
+        destroying: |-
+          Deleting copied box files.
+
+    states:
+      uncreated: |-
+        Your instance of this box haven't been created.
+      running: |-
+        Bhyve is running right now.
+      stopped: |-
+        Bhyve is not running right now.
+      uncleaned: |-
+        It seems that the box has been shutdown but there reamains a vmm 
+        device. Maybe you shutdown the box from inside. Run `vagrant halt`
+        to clean.
+      short_not_created: |-
+        environment_not_created
+      long_not_created: |-
+        The environment has not been created yet. Run `vagrant up` to create
+        the environment
+
+    errors:
+      system_version_too_low: |-
+        To use bhyve your FreeBSD's version should be newer then 10.0
+      missing_popcnt: |-    
+        Popcnt is not supported by your CPU.
+      missing_ept: |-
+        EPT is not supported by your CPU.
+      missing_iommu: |-
+        IOMMU is not supported by your CPU.
+      has_no_root_privilege: |-
+        You need root privilege to manage bhyve VMs.
+      execute_error: |-
+        Failed when execute commands
+      unable_to_load_module: |-
+        Failed to load kernel modules we need to run bhyve VMs and provide 
+        them networking.
+      unable_to_create_interface: |-
+        Failed to create network device.
+      grub_bhyve_not_installed: |-
+        Grub2-bhyve is not found on you system. You can install with `pkg 
+        install grub2-bhyve` or install through port(sysutils/grub2-bhyve)
+      restart_service_failed: |-
+        Failed to restart a service on your system.
+      not_found_leases_info: |-
+        Unable to found IP from dnsmasq's leases file, please retry after a
+        few seconds.

data/vagrant-bhyve.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+require File.expand_path('../lib/vagrant-bhyve/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = "vagrant-bhyve"
+  spec.version       = VagrantPlugins::ProviderBhyve::VERSION
+  spec.authors       = ["Tong Li"]
+  spec.email         = ["jesa7955@gmail.com"]
+
+  spec.summary       = %q{Vagrant provider plugin to support bhyve}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/jesa7955/vagrant-bhyve"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_runtime_dependency "ruby_expect"
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: vagrant-bhyve
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tong Li
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby_expect
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Vagrant provider plugin to support bhyve
+email:
+- jesa7955@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- Vagrantfiles/Vagrantfile_CentOS-6
+- Vagrantfiles/Vagrantfile_CentOS-7
+- Vagrantfiles/Vagrantfile_Debian_Ubuntu
+- example_box/README.md
+- example_box/Vagrantfile
+- example_box/metadata.json
+- lib/vagrant-bhyve.rb
+- lib/vagrant-bhyve/action.rb
+- lib/vagrant-bhyve/action/boot.rb
+- lib/vagrant-bhyve/action/cleanup.rb
+- lib/vagrant-bhyve/action/create_bridge.rb
+- lib/vagrant-bhyve/action/create_tap.rb
+- lib/vagrant-bhyve/action/destroy.rb
+- lib/vagrant-bhyve/action/forward_ports.rb
+- lib/vagrant-bhyve/action/import.rb
+- lib/vagrant-bhyve/action/load.rb
+- lib/vagrant-bhyve/action/prepare_nfs_settings.rb
+- lib/vagrant-bhyve/action/prepare_nfs_valid_ids.rb
+- lib/vagrant-bhyve/action/setup.rb
+- lib/vagrant-bhyve/action/shutdown.rb
+- lib/vagrant-bhyve/action/wait_until_up.rb
+- lib/vagrant-bhyve/config.rb
+- lib/vagrant-bhyve/driver.rb
+- lib/vagrant-bhyve/errors.rb
+- lib/vagrant-bhyve/executor.rb
+- lib/vagrant-bhyve/plugin.rb
+- lib/vagrant-bhyve/provider.rb
+- lib/vagrant-bhyve/version.rb
+- locales/en.yml
+- vagrant-bhyve.gemspec
+homepage: https://github.com/jesa7955/vagrant-bhyve
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Vagrant provider plugin to support bhyve
+test_files: []