vagrant-proxmox 0.0.2

data/lib/vagrant-proxmox/action.rb

@@ -0,0 +1,159 @@
+require 'vagrant/action/builder'
+require 'pathname'
+
+module VagrantPlugins
+	module Proxmox
+		module Action
+
+			include Vagrant::Action::Builtin
+
+			def self.action_read_state
+				Vagrant::Action::Builder.new.tap do |b|
+					b.use ConfigValidate
+					b.use ConnectProxmox
+					b.use ReadState
+				end
+			end
+
+			def self.action_up
+				Vagrant::Action::Builder.new.tap do |b|
+					b.use ConfigValidate
+					b.use ConnectProxmox
+					b.use Call, IsCreated do |env1, b1|
+						if env1[:result]
+							b1.use Call, IsStopped do |env2, b2|
+								if env2[:result]
+									b2.use Provision
+									b2.use StartVm
+									b2.use SyncFolders
+								else
+									b2.use MessageAlreadyRunning
+								end
+							end
+						else
+							b1.use GetNodeList
+							b1.use Provision
+							b1.use CreateVm
+							b1.use StartVm
+							b1.use SyncFolders
+						end
+					end
+				end
+			end
+
+			def self.action_provision
+				Vagrant::Action::Builder.new.tap do |b|
+					b.use ConfigValidate
+					b.use Call, IsCreated do |env, b2|
+						if env[:result]
+							b2.use Provision
+							b2.use SyncFolders
+						else
+							b2.use MessageNotCreated
+						end
+					end
+				end
+			end
+
+			def self.action_halt
+				Vagrant::Action::Builder.new.tap do |b|
+					b.use ConfigValidate
+					b.use Call, IsCreated do |env1, b1|
+						if env1[:result]
+							b1.use Call, IsStopped do |env2, b2|
+								if env2[:result]
+									b2.use MessageAlreadyStopped
+								else
+									b2.use ConnectProxmox
+									b2.use ShutdownVm
+								end
+							end
+						else
+							b1.use MessageNotCreated
+						end
+					end
+				end
+			end
+
+			# This action is called to destroy the remote machine.
+			def self.action_destroy
+				Vagrant::Action::Builder.new.tap do |b|
+					b.use ConfigValidate
+					b.use ConnectProxmox
+					b.use Call, IsCreated do |env1, b1|
+						if env1[:result]
+							b1.use Call, ::Vagrant::Action::Builtin::DestroyConfirm do |env2, b2|
+								if env2[:result]
+									b2.use Call, IsStopped do |env3, b3|
+										b3.use ShutdownVm unless env3[:result]
+										b3.use DestroyVm
+										b3.use ::Vagrant::Action::Builtin::ProvisionerCleanup
+										b3.use CleanupAfterDestroy
+									end
+								else
+									b2.use ::VagrantPlugins::ProviderVirtualBox::Action::MessageWillNotDestroy
+								end
+							end
+						else
+							b1.use MessageNotCreated
+						end
+					end
+				end
+			end
+
+			def self.action_read_ssh_info
+				Vagrant::Action::Builder.new.tap do |b|
+					b.use ConfigValidate
+					b.use ConnectProxmox
+					b.use ReadSSHInfo
+				end
+			end
+
+			def self.action_ssh
+				Vagrant::Action::Builder.new.tap do |b|
+					b.use ConfigValidate
+					b.use Call, IsCreated do |env, b2|
+						if env[:result]
+							b2.use SSHExec
+						else
+							b2.use MessageNotCreated
+						end
+					end
+				end
+			end
+
+			def self.action_ssh_run
+				Vagrant::Action::Builder.new.tap do |b|
+					b.use ConfigValidate
+					b.use Call, IsCreated do |env, b2|
+						if env[:result]
+							b2.use SSHRun
+						else
+							b2.use MessageNotCreated
+						end
+					end
+				end
+			end
+
+			action_root = Pathname.new(File.expand_path '../action', __FILE__)
+			autoload :ProxmoxAction, action_root.join('proxmox_action')
+			autoload :ConnectProxmox, action_root.join('connect_proxmox')
+			autoload :GetNodeList, action_root.join('get_node_list')
+			autoload :ReadState, action_root.join('read_state')
+			autoload :IsCreated, action_root.join('is_created')
+			autoload :IsStopped, action_root.join('is_stopped')
+			autoload :MessageAlreadyRunning, action_root.join('message_already_running')
+			autoload :MessageAlreadyStopped, action_root.join('message_already_stopped')
+			autoload :MessageNotCreated, action_root.join('message_not_created')
+			autoload :CreateVm, action_root.join('create_vm')
+			autoload :StartVm, action_root.join('start_vm')
+			autoload :StopVm, action_root.join('stop_vm')
+			autoload :ShutdownVm, action_root.join('shutdown_vm')
+			autoload :DestroyVm, action_root.join('destroy_vm')
+			autoload :CleanupAfterDestroy, action_root.join('cleanup_after_destroy')
+			autoload :ReadSSHInfo, action_root.join('read_ssh_info')
+			autoload :SyncFolders, action_root.join('sync_folders')
+
+		end
+	end
+end

data/lib/vagrant-proxmox/config.rb

@@ -0,0 +1,81 @@
+module VagrantPlugins
+	module Proxmox
+		class Config < Vagrant.plugin('2', :config)
+
+			# The Proxmox REST API endpoint
+			#
+			# @return [String]
+			attr_accessor :endpoint
+
+			# The Proxmox user name
+			#
+			# @return [String]
+			attr_accessor :user_name
+
+			# The Proxmox password
+			#
+			# @return [String]
+			attr_accessor :password
+
+			# The openvz os template to use for the virtual machines
+			#
+			# @return [String]
+			attr_accessor :os_template
+
+			# The id range to use for the virtual machines
+			#
+			# @return [Range]
+			attr_accessor :vm_id_range
+
+			# The prefix for the virtual machine name
+			#
+			# @return [String]
+			attr_accessor :vm_name_prefix
+
+			# Amount of RAM for the virtual machine in MB
+			#
+			# @return [Integer]
+			attr_accessor :vm_memory
+
+			# The maximum timeout for a proxmox server task (in seconds)
+			#
+			# @return [Integer]
+			attr_accessor :task_timeout
+
+			# The interval between two proxmox task status retrievals (in seconds)
+			#
+			# @return [Integer, Proc]
+			attr_accessor :task_status_check_interval
+
+			def initialize
+				@endpoint = UNSET_VALUE
+				@user_name = UNSET_VALUE
+				@password = UNSET_VALUE
+				@os_template = UNSET_VALUE
+				@vm_id_range = 900..999
+				@vm_name_prefix = 'vagrant_'
+				@vm_memory = 512
+				@task_timeout = 60
+				@task_status_check_interval = 2
+			end
+
+			# This is the hook that is called to finalize the object before it is put into use.
+			def finalize!
+				@endpoint = nil if @endpoint == UNSET_VALUE
+				@user_name = nil if @user_name == UNSET_VALUE
+				@password = nil if @password == UNSET_VALUE
+				@os_template = nil if @os_template == UNSET_VALUE
+			end
+
+			def validate machine
+				errors = []
+				errors << I18n.t('vagrant_proxmox.errors.no_endpoint_specified') unless @endpoint
+				errors << I18n.t('vagrant_proxmox.errors.no_user_name_specified') unless @user_name
+				errors << I18n.t('vagrant_proxmox.errors.no_password_specified') unless @password
+				errors << I18n.t('vagrant_proxmox.errors.no_os_template_specified') unless @os_template
+				{'Proxmox Provider' => errors}
+			end
+
+		end
+	end
+end

data/lib/vagrant-proxmox/errors.rb

@@ -0,0 +1,39 @@
+module VagrantPlugins
+	module Proxmox
+
+		class ProxmoxTaskNotFinished < Exception
+		end
+
+		module Errors
+
+			class VagrantProxmoxError < Vagrant::Errors::VagrantError
+				error_namespace 'vagrant_proxmox.errors'
+			end
+
+			class ProxmoxTaskFailed < VagrantProxmoxError
+				error_key :proxmox_task_failed
+			end
+
+			class CommunicationError < VagrantProxmoxError
+				error_key :communication_error
+			end
+
+			class Timeout < VagrantProxmoxError
+				error_key :timeout
+			end
+
+			class NoVmIdAvailable < VagrantProxmoxError
+				error_key :no_vm_id_available
+			end
+
+			class VMCreationError < VagrantProxmoxError
+				error_key :vm_creation_error
+			end
+
+			class RsyncError < VagrantProxmoxError
+				error_key :rsync_error
+			end
+
+		end
+	end
+end

data/lib/vagrant-proxmox/plugin.rb

@@ -0,0 +1,75 @@
+# Fix wrong header unescaping in RestClient library.
+module RestClient
+	class Request
+		def make_headers user_headers
+			unless @cookies.empty?
+				user_headers[:cookie] = @cookies.map { |(key, val)| "#{key.to_s}=#{val}" }.sort.join('; ')
+			end
+			headers = stringify_headers(default_headers).merge(stringify_headers(user_headers))
+			headers.merge!(@payload.headers) if @payload
+			headers
+		end
+	end
+end
+
+module VagrantPlugins
+	module Proxmox
+		class Plugin < Vagrant.plugin ('2')
+
+			name 'Proxmox'
+			description <<-DESC
+      This plugin installs a provider that allows Vagrant to manage
+      machines on Proxmox.
+			DESC
+
+			config(:proxmox, :provider) do
+				require_relative 'config'
+				Config
+			end
+
+			provider(:proxmox, parallel: true) do
+				# Setup logging and i18n
+				setup_logging
+				setup_i18n
+
+				# Return the provider
+				require_relative 'provider'
+				Provider
+			end
+
+			# This initializes the internationalization strings.
+			def self.setup_i18n
+				I18n.load_path << File.expand_path('locales/en.yml', Proxmox.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_proxmox'
+					logger.outputters = Log4r::Outputter.stderr
+					logger.level = level
+				end
+			end
+		end
+	end
+end

data/lib/vagrant-proxmox/provider.rb

@@ -0,0 +1,51 @@
+module VagrantPlugins
+	module Proxmox
+
+		class Provider < Vagrant.plugin('2', :provider)
+
+			def initialize machine
+				@machine = machine
+			end
+
+			def action name
+				# Attempt 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
+
+			def state
+				# Run a custom action we define called "read_state" which does
+				# what it says. It puts the state in the `:machine_state_id`
+				# key in the environment.
+				env = @machine.action 'read_state'
+
+				state_id = env[:machine_state_id]
+
+				# Get the short and long description
+				short = I18n.t "vagrant_proxmox.states.short_#{state_id}"
+				long = I18n.t "vagrant_proxmox.states.long_#{state_id}"
+
+				# Return the MachineState object
+				Vagrant::MachineState.new state_id, short, long
+			end
+
+			def ssh_info
+				# Run a custom action called "read_ssh_info" which does what it
+				# says and puts the resulting SSH info into the `:machine_ssh_info`
+				# key in the environment.
+				env = @machine.action 'read_ssh_info'
+				env[:machine_ssh_info]
+			end
+
+			def to_s
+				id = @machine.id.nil? ? 'new' : @machine.id
+				"Proxmox (#{id})"
+			end
+
+		end
+
+	end
+end

data/lib/vagrant-proxmox/version.rb

@@ -0,0 +1,7 @@
+module VagrantPlugins
+	module Proxmox
+
+		VERSION = '0.0.2'
+
+	end
+end

data/lib/vagrant-proxmox.rb

@@ -0,0 +1,22 @@
+require 'pathname'
+require 'log4r'
+require 'rest-client'
+require 'retryable'
+require 'active_support/core_ext/object/try'
+
+require 'sanity_checks'
+require 'vagrant-proxmox/plugin'
+require 'vagrant-proxmox/errors'
+
+
+module VagrantPlugins
+	module Proxmox
+		lib_path = Pathname.new(File.expand_path '../vagrant-proxmox', __FILE__)
+		autoload :Action, lib_path.join('action')
+		autoload :Errors, lib_path.join('errors')
+
+		def self.source_root
+			@source_root ||= Pathname.new(File.expand_path '../../', __FILE__)
+		end
+	end
+end

data/locales/en.yml

@@ -0,0 +1,66 @@
+en:
+  vagrant_proxmox:
+    already_running: 'The virtual machine is already up and running'
+    already_stopped: "The virtual machine is already stopped"
+    creating_vm: 'Creating the virtual machine...'
+    destroying_vm: 'Destroying the virtual machine...'
+    done: "Done!"
+    errors:
+      create_vm_timeout: |-
+        Creating the vm on the proxmox server timed out.
+      communication_error: |-
+        Unable to communicate with proxmox server:
+
+        %{error_msg}
+      destroy_vm_timeout: |-
+        Destroying the vm on the proxmox server timed out.
+      no_endpoint_specified: 'No endpoint specified.'
+      no_os_template_specified: 'No os_template specified.'
+      no_password_specified: 'No password specified.'
+      no_user_name_specified: 'No user_name specified.'
+      no_vm_id_available: |-
+        Unable to create a new virtual machine on the proxmox server.
+        None of the configured vm_ids is available.
+      proxmox_task_failed: |-
+        A task on the proxmox server failed.
+        It returned the following exit status:
+
+        %{proxmox_exit_status}
+      rsync_error: |-
+        There was an error when attemping to rsync a share folder.
+        Please inspect the error message below for more info.
+
+        Host path: %{hostpath}
+        Guest path: %{guestpath}
+        Error: %{stderr}
+      shutdown_vm_timeout: |-
+        Stopping the vm on the proxmox server timed out.
+      start_vm_timeout: |-
+        Starting the vm on the proxmox server timed out.
+      stop_vm_timeout: |-
+        Stopping the vm on the proxmox server timed out.
+      timeout: 'Timeout error'
+      vm_creation_error: |-
+        Unable to create the virtual machine!
+
+        Cause: %{proxmox_exit_status}
+    not_created: 'The virtual machine is not created on the server!'
+    rsync_folder: |-
+          Rsyncing folder: %{hostpath} => %{guestpath}
+    shut_down_vm: 'Shutting down the virtual machine...'
+    starting_vm: 'Starting the virtual machine...'
+    states:
+      long_not_created: |-
+        The server is not created. Run `vagrant up` to create it.
+      long_running: |-
+        The server is up and running. Run `vagrant ssh` to access it.
+      long_stopped: |-
+        The server is stopped.
+      short_not_created: |-
+        not created
+      short_running: |-
+        running
+      short_stopped: |-
+        stopped
+    stopping_vm: 'Stopping the virtual machine...'
+    waiting_for_ssh_connection: 'Waiting for SSH connection...'

data/spec/actions/cleanup_after_destroy_action_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'actions/proxmox_action_shared'
+
+describe VagrantPlugins::Proxmox::Action::CleanupAfterDestroy do
+
+	let(:environment) { Vagrant::Environment.new vagrantfile_name: 'dummy_box/Vagrantfile' }
+	let(:env) { {machine: environment.machine(environment.primary_machine_name, :proxmox)} }
+	let(:ui) { double('ui').as_null_object }
+
+	subject { described_class.new(-> (_) {}, environment) }
+
+	it_behaves_like 'a proxmox action call'
+
+	describe '#call', :need_box do
+		it 'should delete the directory `.vagrant/[:machine].name`' do
+			expect do
+				subject.call env
+			end.to change{File.exists?(".vagrant/machines/#{env[:machine].name}/proxmox")}.to false
+		end
+	end
+
+end

data/spec/actions/connect_proxmox_action_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+require 'actions/proxmox_action_shared'
+
+module VagrantPlugins::Proxmox
+
+	describe Action::ConnectProxmox do
+
+		let(:environment) { Vagrant::Environment.new vagrantfile_name: 'dummy_box/Vagrantfile' }
+		let(:env) { {machine: environment.machine(environment.primary_machine_name, :proxmox)} }
+
+		subject { described_class.new(-> (_) {}, environment) }
+
+		before { VagrantPlugins::Proxmox::Plugin.setup_i18n }
+
+		describe '#call' do
+
+			before do
+				allow(RestClient).to receive(:post).and_return({data: {ticket: 'valid_ticket', CSRFPreventionToken: 'valid_token'}}.to_json)
+			end
+
+			it_behaves_like 'a proxmox action call'
+
+			it 'should call the REST API access/ticket' do
+				RestClient.should_receive(:post).with('https://your.proxmox.server/api2/json/access/ticket', {username: 'vagrant', password: 'password'})
+				subject.call env
+			end
+
+			it 'should store the access ticket in env[:proxmox_ticket]' do
+				subject.call env
+				env[:proxmox_ticket].should == 'valid_ticket'
+			end
+
+			it 'should store the access ticket in env[:proxmox_csrf_prevention_token]' do
+				subject.call env
+				env[:proxmox_csrf_prevention_token].should == 'valid_token'
+			end
+
+			describe 'when the server communication fails' do
+				before { RestClient.stub(:post).and_return nil }
+				specify do
+					expect { subject.call env }.to raise_error Errors::CommunicationError
+				end
+			end
+
+		end
+
+	end
+
+end