vagrant-rimu 0.0.1

data/lib/vagrant-rimu/actions.rb

@@ -0,0 +1,237 @@
+require 'pathname'
+
+require 'vagrant/action/builder'
+
+module VagrantPlugins
+  module Rimu
+    module Actions
+      include Vagrant::Action::Builtin
+
+      # This action is called to terminate the remote machine.
+      def self.action_destroy
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Call, DestroyConfirm do |env, b2|
+            if env[:result]
+              b2.use ConfigValidate
+              b.use Call, IsCreated do |env2, b3|
+                if !env2[:result]
+                  b3.use MessageNotCreated
+                  next
+                end
+              end
+              b2.use ConnectToRimu
+              b2.use TerminateInstance
+            else
+              b2.use MessageWillNotDestroy
+            end
+          end
+        end
+      end
+
+      # This action is called to read the SSH info of the machine. The
+      # resulting state is expected to be put into the `:machine_ssh_info`
+      # key.
+      def self.action_read_ssh_info
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectToRimu
+          b.use ReadSSHInfo
+        end
+      end
+
+      # This action is called to read the state of the machine. The
+      # resulting state is expected to be put into the `:machine_state_id`
+      # key.
+      def self.action_read_state
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectToRimu
+          b.use ReadState
+        end
+      end
+
+      # This action is called to SSH into the machine.
+      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 MessageNotCreated
+              next
+            end
+
+            b2.use SSHExec
+          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 MessageNotCreated
+              next
+            end
+
+            b2.use SSHRun
+          end
+        end
+      end
+
+      # This action is called when `vagrant provision` is called.
+      def self.action_provision
+        return Vagrant::Action::Builder.new.tap do |builder|
+          builder.use ConfigValidate
+          builder.use ConnectToRimu
+          builder.use Call, IsCreated do |env, b|
+            case env[:machine_state]
+            when :active
+              b.use Provision
+              b.use ModifyProvisionPath
+              b.use SyncedFolders
+            when :off
+              env[:ui].info I18n.t('vagrant_rimu.off')
+            when :not_created
+              b.use MessageNotCreated
+            end
+          end
+        end
+      end
+
+      def self.action_up
+        return Vagrant::Action::Builder.new.tap do |builder|
+          builder.use ConfigValidate
+          builder.use ConnectToRimu
+          builder.use Call, IsCreated do |env, b|
+            case env[:machine_state]
+            when :active
+              b.use MessageAlreadyCreated
+            when :off
+              b.use StartInstance
+              b.use action_provision
+            when :not_created
+              b.use Create
+              b.use SetupSudo
+              b.use SetupUser
+              b.use action_provision
+            end
+          end
+        end
+      end
+
+      # This action is called to halt the remote machine.
+      def self.action_halt
+        Vagrant::Action::Builder.new.tap do |builder|
+          builder.use ConfigValidate
+          builder.use Call, IsCreated do |env, b1|
+            if env[:result]
+              b1.use Call, IsStopped do |env2, b2|
+                if env2[:result]
+                  b2.use MessageAlreadyOff
+                else
+                  b2.use ConnectToRimu
+                  b2.use PowerOff
+                end
+              end
+            else
+              b1.use MessageNotCreated
+            end
+          end
+        end
+      end
+
+      def self.action_reload
+        return Vagrant::Action::Builder.new.tap do |builder|
+          builder.use ConfigValidate
+          builder.use ConnectToRimu
+          builder.use Call, IsCreated do |env, b|
+            case env[:machine_state]
+            when :active
+              b.use Reload
+              b.use action_provision
+            when :off
+              env[:ui].info I18n.t('vagrant_rimu.off')
+            when :not_created
+              b.use MessageNotCreated
+            end
+          end
+        end
+      end
+
+      def self.action_rebuild
+        return Vagrant::Action::Builder.new.tap do |builder|
+          builder.use ConfigValidate
+          builder.use ConnectToRimu
+          builder.use Call, IsCreated do |env, b|
+            case env[:machine_state]
+            when :active, :off
+              b.use Rebuild
+              b.use SetupSudo
+              b.use SetupUser
+              b.use action_provision
+            when :not_created
+              b.use MessageNotCreated
+            end
+          end
+        end
+      end
+
+      def self.action_list_distributions
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectToRimu
+          b.use ListDistributions
+        end
+      end
+
+      def self.action_list_servers
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectToRimu
+          b.use ListServers
+        end
+      end
+
+      def self.action_billing_methods
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectToRimu
+          b.use BillingMethods
+        end
+      end
+
+      def self.action_move
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use ConnectToRimu
+          b.use Move
+        end
+      end
+
+      action_root = Pathname.new(File.expand_path('../actions', __FILE__))
+      autoload :ConnectToRimu, action_root.join('connect_to_rimu')
+      autoload :StopInstance, action_root.join('stop_instance')
+      autoload :TerminateInstance, action_root.join('terminate_instance')
+      autoload :IsCreated, action_root.join('is_created')
+      autoload :IsStopped, action_root.join('is_stopped')
+      autoload :ReadSSHInfo, action_root.join('read_ssh_info')
+      autoload :ReadState, action_root.join('read_state')
+      autoload :StartInstance, action_root.join('start_instance')
+      autoload :Create, action_root.join('create')
+      autoload :SetupSudo, action_root.join('setup_sudo')
+      autoload :SetupUser, action_root.join('setup_user')
+      autoload :ModifyProvisionPath, action_root.join('modify_provision_path')
+      autoload :Reload, action_root.join('reload')
+      autoload :Rebuild, action_root.join('rebuild')
+      autoload :ListDistributions, action_root.join('list_distributions')
+      autoload :ListServers, action_root.join('list_servers')
+      autoload :BillingMethods, action_root.join('billing_methods')
+      autoload :Move, action_root.join('move')
+      autoload :MessageAlreadyOff, action_root.join('message_already_off')
+      autoload :MessageNotCreated, action_root.join('message_not_created')
+      autoload :MessageWillNotDestroy, action_root.join('message_will_not_destroy')
+      autoload :MessageAlreadyCreated, action_root.join('message_already_created')
+    end
+  end
+end

data/lib/vagrant-rimu/commands/billing_methods.rb

@@ -0,0 +1,18 @@
+module VagrantPlugins
+  module Rimu
+    module Commands
+      class BillingMethods < Vagrant.plugin('2', :command)
+        def execute
+          opts = OptionParser.new do |o|
+            o.banner = 'Usage: vagrant rimu billing_methods [options]'
+          end
+          argv = parse_options(opts)
+          return unless argv
+          with_target_vms(argv, provider: :rimu) do |machine|
+            machine.action('billing_methods')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-rimu/commands/distributions.rb

@@ -0,0 +1,18 @@
+module VagrantPlugins
+  module Rimu
+    module Commands
+      class Distributions < Vagrant.plugin('2', :command)
+        def execute
+          opts = OptionParser.new do |o|
+            o.banner = 'Usage: vagrant rimu distributions [options]'
+          end
+          argv = parse_options(opts)
+          return unless argv
+          with_target_vms(argv, provider: :rimu) do |machine|
+            machine.action('list_distributions')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-rimu/commands/list_servers.rb

@@ -0,0 +1,18 @@
+module VagrantPlugins
+  module Rimu
+    module Commands
+      class ListServers < Vagrant.plugin('2', :command)
+        def execute
+          opts = OptionParser.new do |o|
+            o.banner = 'Usage: vagrant rimu servers [options]'
+          end
+          argv = parse_options(opts)
+          return unless argv
+          with_target_vms(argv, provider: :rimu) do |machine|
+            machine.action('list_servers')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-rimu/commands/move.rb

@@ -0,0 +1,18 @@
+module VagrantPlugins
+  module Rimu
+    module Commands
+      class Move < Vagrant.plugin('2', :command)
+        def execute
+          opts = OptionParser.new do |o|
+            o.banner = 'Usage: vagrant rimu move [options]'
+          end
+          argv = parse_options(opts)
+          return unless argv
+          with_target_vms(argv, provider: :rimu) do |machine|
+            machine.action('move')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-rimu/commands/rebuild.rb

@@ -0,0 +1,20 @@
+require 'optparse'
+
+module VagrantPlugins
+  module Rimu
+    module Commands
+      class Rebuild < Vagrant.plugin('2', :command)
+        def execute
+          opts = OptionParser.new do |o|
+            o.banner = 'Usage: vagrant rebuild [vm-name]'
+          end
+          argv = parse_options(opts)
+          with_target_vms(argv) do |machine|
+            machine.action(:rebuild)
+          end
+          0
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-rimu/commands/root.rb

@@ -0,0 +1,67 @@
+require 'optparse'
+
+module VagrantPlugins
+  module Rimu
+    module Commands
+      class Root < Vagrant.plugin('2', :command)
+        def self.synopsis
+          'query Rimu for various options'
+        end
+
+        def initialize(argv, env)
+          @main_args, @sub_command, @sub_args = split_main_and_subcommand(argv)
+
+          @subcommands = Vagrant::Registry.new
+
+          @subcommands.register(:distributions) do
+            require File.expand_path('../distributions', __FILE__)
+            Distributions
+          end
+
+          @subcommands.register(:move) do
+            require File.expand_path('../move', __FILE__)
+            Move
+          end
+
+          @subcommands.register(:billing_methods) do
+            require File.expand_path('../billing_methods', __FILE__)
+            BillingMethods
+          end
+
+          @subcommands.register(:servers) do
+            require File.expand_path('../list_servers', __FILE__)
+            ListServers
+          end
+
+          super(argv, env)
+        end
+
+        def execute
+          if @main_args.include?('-h') || @main_args.include?('--help')
+            return help
+          end
+          command_class = @subcommands.get(@sub_command.to_sym) if @sub_command
+          return help if !command_class || !@sub_command
+          @logger.debug("Invoking command class: #{command_class} #{@sub_args.inspect}")
+          command_class.new(@sub_args, @env).execute
+        end
+
+        def help
+          opts = OptionParser.new do |o|
+            o.banner = 'Usage: vagrant rimu <subcommand> [<args>]'
+            o.separator ''
+            o.separator 'Available subcommands:'
+            keys = []
+            @subcommands.each { |key, _value| keys << key.to_s }
+            keys.sort.each do |key|
+              o.separator "     #{key}"
+            end
+            o.separator ''
+            o.separator 'For help on any individual subcommand run `vagrant rimu <subcommand> -h`'
+          end
+          @env.ui.info(opts.help, prefix: false)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-rimu/config.rb

@@ -0,0 +1,190 @@
+module VagrantPlugins
+  module Rimu
+    class Config < Vagrant.plugin('2', :config)
+      # The API key for accessing Rimu.
+      #
+      # @return [String]
+      attr_accessor :api_key
+
+      # Rimu api url.
+      #
+      # @return [String]
+      attr_accessor :api_url
+
+      # Rimu distribution to install
+      #
+      # @return [String]
+      attr_accessor :distro_code
+
+      # Rimu data_centre
+      # DCDALLAS | DCLONDON | DCSYDNEY | DCBRISBANE | DCAUCKLAND | DCFRANKFURT
+      #
+      # @return [String]
+      attr_accessor :data_centre
+
+      # File system image size on primary partition in MB
+      #
+      # @return [Fixnum]
+      attr_accessor :disk_space_mb
+
+      # File system image size on secondary partition in MB
+      # Mostly not used.
+      #
+      # @return [Fixnum]
+      attr_accessor :disk_space_2_mb
+
+      # Memory size in MB
+      #
+      # @return [Fixnum]
+      attr_accessor :memory_mb
+
+      # You can specify a vps_type
+      # LOW_CONTENTION | REGULAR | DEDICATED
+      #
+      # @return [String]
+      attr_accessor :vps_type
+
+      # The label you want to give the server.
+      # It will need to be a fully qualified domain name (FQDN).
+      #
+      # @return [String]
+      attr_accessor :host_name
+
+      # The password to use when setting up the server.
+      # If not provided, a random one will be set.
+      #
+      # @return [String]
+      attr_accessor :root_password
+
+      # The control panel to install on the VPS.
+      # Currently only webmin is supported
+      #
+      # @return [String]
+      attr_accessor :control_panel
+
+      # Set this if you want the newly setup VPS to be a clone of another VPS
+      # The clone source VPS will be paused for a few seconds to a few minutes
+      # to take the snapshot.
+      #
+      # @return [Fixnum]
+      attr_accessor :vps_to_clone
+
+      # The reason for requiring more than one IP address.
+      # The number of IP addresses will be limited.
+      #
+      # @return [String]
+      attr_accessor :extra_ip_reason
+
+      # How many IPs you need.  Typically 1.
+      #
+      # @return [Fixnum]
+      attr_accessor :num_ips
+
+      # This option is often used for customers wanting to setup a VPS
+      # with private IPs
+      #
+      # @return [String]
+      attr_accessor :private_ips
+
+      # Set the billing id if you want to control how it is billed.
+      # run `vagrant rimu billing-methods` to find what billing methods/ids
+      # you have setup on your account.
+      #
+      # @return [Fixnum]
+      attr_accessor :billing_id
+
+      # The host server on which to setup the server.
+      # Typically you will want to leave this blank and let the API decide
+      # what is best/available.
+      #
+      # An exception may be if you are a customer with a dedicated server
+      # that is a VPS host.  And in that case you may want to force a VPS
+      # to be setup on a particular server of yours.
+      #
+      # @return [Fixnum]
+      attr_accessor :host_server_id
+
+      # Do minimal setup work.
+      #
+      # @return [bool]
+      attr_accessor :minimal_init
+
+      attr_accessor :setup
+
+      alias_method :setup?, :setup
+
+      def initialize
+        @api_key = UNSET_VALUE
+        @api_url = UNSET_VALUE
+        @distro_code = UNSET_VALUE
+        @setup = UNSET_VALUE
+        @disk_space_mb = UNSET_VALUE
+        @disk_space_2_mb = UNSET_VALUE
+        @memory_mb = UNSET_VALUE
+        @vps_type = UNSET_VALUE
+        @host_name = UNSET_VALUE
+        @root_password = UNSET_VALUE
+        @control_panel = UNSET_VALUE
+        @vps_to_clone = UNSET_VALUE
+        @extra_ip_reason = UNSET_VALUE
+        @num_ips = UNSET_VALUE
+        @private_ips = UNSET_VALUE
+        @billing_id = UNSET_VALUE
+        @host_server_id = UNSET_VALUE
+        @minimal_init = UNSET_VALUE
+        @data_centre = UNSET_VALUE
+      end
+
+      def finalize!
+        @api_key = ENV['RIMU_API_KEY'] if @api_key == UNSET_VALUE
+        @api_url = ENV['RIMU_URL'] if @api_url == UNSET_VALUE
+        @distro_code = "centos6.64" if @distro_code == UNSET_VALUE
+        @disk_space_mb = 20000 if @disk_space_mb == UNSET_VALUE
+        # @disk_space_mb = @disk_space_mb.to_i if @disk_space_mb.kind_of? String
+        @disk_space_2_mb = nil if @disk_space_2_mb == UNSET_VALUE
+        # @disk_space_2_mb = @disk_space_2_mb.to_i if @disk_space_2_mb.kind_of? String
+        @memory_mb = 1024 if @memory_mb == UNSET_VALUE
+        # @memory_mb = @memory_mb.to_i if @memory_mb.kind_of? String
+        @vps_type = nil if @vps_type == UNSET_VALUE
+        @host_name = nil if @host_name == UNSET_VALUE
+        @root_password = nil if @root_password == UNSET_VALUE
+        @control_panel = nil if @control_panel == UNSET_VALUE
+        @vps_to_clone = nil if @vps_to_clone == UNSET_VALUE
+        @extra_ip_reason = nil if @extra_ip_reason == UNSET_VALUE
+        @num_ips = nil if @num_ips == UNSET_VALUE
+        @private_ips = nil if @private_ips == UNSET_VALUE
+        @billing_id = nil if @billing_id == UNSET_VALUE
+        @host_server_id = nil if @host_server_id == UNSET_VALUE
+        @minimal_init = nil if @minimal_init == UNSET_VALUE
+        @data_centre = nil if @data_centre == UNSET_VALUE
+        @setup = true if @setup == UNSET_VALUE
+      end
+
+      def validate(machine)
+        errors = []
+        errors << I18n.t('vagrant_rimu.config.api_key') if !@api_key
+        errors << I18n.t('vagrant_rimu.config.host_name') if !@host_name
+        if @host_name
+          errors << I18n.t('vagrant_rimu.config.invalid_host_name', {:host_name => @host_name}) \
+            unless @host_name.match(/\b((?=[a-z0-9-]{1,63}\.)(xn--)?[a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,63}\b/)
+        end
+
+        key = machine.config.ssh.private_key_path
+        key = key[0] if key.is_a?(Array)
+        if !key
+          errors << I18n.t('vagrant_rimu.config.private_key')
+        else
+          if !File.file?(File.expand_path("#{key}", machine.env.root_path))
+            errors << I18n.t('vagrant_rimu.config.missing_private_key', key: "#{key}")
+          else
+            if !File.file?(File.expand_path("#{key}.pub", machine.env.root_path))
+              errors << I18n.t('vagrant_rimu.config.public_key', key: "#{key}.pub")
+            end
+          end
+        end
+
+        { 'Rimu Provider' => errors }
+      end
+    end
+  end
+end

data/lib/vagrant-rimu/errors.rb

@@ -0,0 +1,21 @@
+module VagrantPlugins
+  module Rimu
+    module Errors
+      class RimuError < Vagrant::Errors::VagrantError
+        error_namespace("vagrant_rimu.errors")
+      end
+
+      class PublicKeyError < RimuError
+        error_key(:public_key)
+      end
+
+      class RsyncError < RimuError
+        error_key(:rsync)
+      end
+
+      class ApiError < RimuError
+        error_key(:api_error)
+      end
+    end
+  end
+end

data/lib/vagrant-rimu/plugin.rb

@@ -0,0 +1,80 @@
+begin
+  require 'vagrant'
+rescue LoadError
+  raise 'The Vagrant Rimu plugin must be run within Vagrant.'
+end
+
+if Vagrant::VERSION < '1.5.0'
+  raise 'The Vagrant Rimu plugin is only compatible with Vagrant 1.5+'
+end
+
+module VagrantPlugins
+  module Rimu
+    class Plugin < Vagrant.plugin('2')
+      name 'Rimu'
+      description <<-DESC
+      This plugin installs a provider that allows Vagrant to manage
+      virtual machines using Rimuhosting's API.
+      DESC
+
+      config(:rimu, :provider) do
+        require_relative "config"
+        Config
+      end
+
+      provider(:rimu, {:box_optional => true, :parallel => true}) do
+        # Setup logging and i18n
+        setup_logging
+        setup_i18n
+        # Return the provider
+        require_relative "provider"
+        Provider
+      end
+
+      command(:rimu) do
+        require_relative "commands/root"
+        Commands::Root
+      end
+
+      command(:rebuild) do
+        require_relative "commands/rebuild"
+        Commands::Rebuild
+      end
+
+      # This initializes the internationalization strings.
+      def self.setup_i18n
+        I18n.load_path << File.expand_path("locales/en.yml", Rimu.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_rimu")
+          logger.outputters = Log4r::Outputter.stderr
+          logger.level = level
+          logger = nil
+        end
+      end
+    end
+  end
+end