vagrant-rimu 0.0.2 → 0.0.3

data/lib/vagrant-rimu/actions/setup_sudo.rb

@@ -1,16 +1,18 @@
 require 'log4r'
 
+require 'vagrant-rimu/actions/abstract_action'
+
 module VagrantPlugins
   module Rimu
     module Actions
-      class SetupSudo
+      class SetupSudo < AbstractAction
         def initialize(app, env)
           @app = app
           @machine = env[:machine]
           @logger = Log4r::Logger.new('vagrant::rimu::setup_sudo')
         end
 
-        def call(env)
+        def execute(env)
           # check if setup is enabled
           return @app.call(env) unless @machine.provider_config.setup?
 
@@ -18,10 +20,20 @@ module VagrantPlugins
           user = @machine.config.ssh.username
           @machine.config.ssh.username = 'root'
 
+          # modify the sudoers file
+          modify_sudo(env)
+          
+          # reset ssh username
+          @machine.config.ssh.username = user
+
+          @app.call(env)
+        end
+        
+        def modify_sudo(env)
           # check for guest name available in Vagrant 1.2 first
           guest_name = @machine.guest.name if @machine.guest.respond_to?(:name)
           guest_name ||= @machine.guest.to_s.downcase
-
+          
           case guest_name
           when /redhat/
             env[:ui].info I18n.t('vagrant_rimu.modifying_sudo')
@@ -31,11 +43,6 @@ module VagrantPlugins
               sed -i'.bk' -e 's/\(Defaults\s\+requiretty\)/# \1/' /etc/sudoers
             BASH
           end
-
-          # reset ssh username
-          @machine.config.ssh.username = user
-
-          @app.call(env)
         end
       end
     end

data/lib/vagrant-rimu/actions/setup_user.rb

@@ -1,16 +1,19 @@
 require 'log4r'
 
+require 'vagrant-rimu/actions/abstract_action'
+
 module VagrantPlugins
   module Rimu
     module Actions
-      class SetupUser
+      class SetupUser < AbstractAction
         def initialize(app, env)
           @app = app
           @machine = env[:machine]
           @logger = Log4r::Logger.new('vagrant::rimu::setup_user')
         end
 
-        def call(env)
+        # rubocop:disable Metrics/AbcSize
+        def execute(env)
           # check if setup is enabled
           return @app.call(env) unless @machine.provider_config.setup?
 
@@ -21,30 +24,22 @@ module VagrantPlugins
           user = @machine.config.ssh.username
           @machine.config.ssh.username = 'root'
 
-          env[:ui].info I18n.t('vagrant_rimu.creating_user', {
-            :user => user
-          })
-
           # create user account
-          @machine.communicate.execute(<<-BASH)
-            if ! (grep ^#{user}: /etc/passwd); then
-              useradd -m -s /bin/bash #{user};
-            fi
-          BASH
-
-          # grant user sudo access with no password requirement
-          @machine.communicate.execute(<<-BASH)
-            if ! (grep #{user} /etc/sudoers); then
-              echo "#{user} ALL=(ALL:ALL) NOPASSWD: ALL" >> /etc/sudoers;
-            else
-              sed -i -e "/#{user}/ s/=.*/=(ALL:ALL) NOPASSWD: ALL/" /etc/sudoers;
-            fi
-          BASH
+          create_user(env, user)
 
           # create the .ssh directory in the users home
           @machine.communicate.execute("su #{user} -c 'mkdir -p ~/.ssh'")
 
           # add the specified key to the authorized keys file
+          upload_key(user)
+
+          # reset username
+          @machine.config.ssh.username = user
+
+          @app.call(env)
+        end
+        
+        def upload_key(user)
           path = @machine.config.ssh.private_key_path
           path = path[0] if path.is_a?(Array)
           path = File.expand_path(path, @machine.env.root_path)
@@ -56,11 +51,27 @@ module VagrantPlugins
 
             chown -R #{user} /home/#{user}/.ssh;
           BASH
+        end
+        
+        def create_user(env, user)
+          env[:ui].info I18n.t('vagrant_rimu.creating_user', {
+            :user => user
+          })
+          
+          @machine.communicate.execute(<<-BASH)
+            if ! (grep ^#{user}: /etc/passwd); then
+              useradd -m -s /bin/bash #{user};
+            fi
+          BASH
 
-          # reset username
-          @machine.config.ssh.username = user
-
-          @app.call(env)
+          # grant user sudo access with no password requirement
+          @machine.communicate.execute(<<-BASH)
+            if ! (grep #{user} /etc/sudoers); then
+              echo "#{user} ALL=(ALL:ALL) NOPASSWD: ALL" >> /etc/sudoers;
+            else
+              sed -i -e "/#{user}/ s/=.*/=(ALL:ALL) NOPASSWD: ALL/" /etc/sudoers;
+            fi
+          BASH
         end
         
         def public_key(private_key_path)

data/lib/vagrant-rimu/actions/start_instance.rb

@@ -1,16 +1,18 @@
 require 'log4r'
 
+require 'vagrant-rimu/actions/abstract_action'
+
 module VagrantPlugins
   module Rimu
     module Actions
-      class StartInstance
+      class StartInstance < AbstractAction
         def initialize(app, env)
           @app = app
           @machine = env[:machine]
           @logger = Log4r::Logger.new("vagrant_rimu::action::start_instance")
         end
 
-        def call(env)
+        def execute(env)
           client = env[:rimu_api]
           env[:ui].info I18n.t('vagrant_rimu.starting')
           begin

data/lib/vagrant-rimu/actions/stop_instance.rb

@@ -1,26 +1,32 @@
 require 'log4r'
 
+require 'vagrant-rimu/actions/abstract_action'
+
 module VagrantPlugins
   module Rimu
     module Actions
       # This stops the running instance.
-      class StopInstance
+      class StopInstance < AbstractAction
         def initialize(app, _env)
           @app    = app
           @logger = Log4r::Logger.new('vagrant_rimu::action::stop_instance')
         end
 
-        def call(env)
+        def execute(env)
           if env[:machine].state.id == :stopped
             env[:ui].info(I18n.t('vagrant_rimu.already_status', :status => env[:machine].state.id))
           else
-            env[:ui].info(I18n.t('vagrant_rimu.stopping'))
-            client = env[:rimu_api]
-            client.servers.shutdown(env[:machine].id.to_i)
+            shutdown(env)
           end
           
           @app.call(env)
         end
+        
+        def shutdown(env)
+          env[:ui].info(I18n.t('vagrant_rimu.stopping'))
+          client = env[:rimu_api]
+          client.servers.shutdown(env[:machine].id.to_i)
+        end
       end
     end
   end

data/lib/vagrant-rimu/actions/terminate_instance.rb

@@ -1,16 +1,18 @@
 require 'log4r'
 
+require 'vagrant-rimu/actions/abstract_action'
+
 module VagrantPlugins
   module Rimu
     module Actions
       # This terminates the running server, if there is one.
-      class TerminateInstance
+      class TerminateInstance < AbstractAction
         def initialize(app, _env)
           @app = app
           @logger = Log4r::Logger.new("vagrant_rimu::action::terminate_instance")
         end
 
-        def call(env)
+        def execute(env)
           if env[:machine].id
             env[:ui].info(I18n.t("vagrant_rimu.terminating"))
             client = env[:rimu_api]

data/lib/vagrant-rimu/actions.rb

@@ -4,6 +4,7 @@ require 'vagrant/action/builder'
 
 module VagrantPlugins
   module Rimu
+    # rubocop:disable Metrics/ModuleLength
     module Actions
       include Vagrant::Action::Builtin
 

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

@@ -0,0 +1,47 @@
+require 'colorize'
+
+module VagrantPlugins
+  module Rimu
+    module Commands
+      class AbstractCommand < Vagrant.plugin('2', :command)
+        def initialize(argv, env)
+          @env = env
+          super(normalize_args(argv), env)
+        end
+
+        def execute(name)
+          env = {}
+          with_target_vms(nil, provider: :rimu) do |machine|
+            env[:machine] = machine
+            env[:ui] = @env.ui
+          end
+
+          before_cmd(name, @argv, env)
+
+          cmd(name, @argv, env)
+          @env.ui.info('')
+        # rubocop:disable Lint/RescueException
+        rescue Errors::ApiError, SystemExit, Interrupt => e
+          raise e
+        rescue Exception => e
+          puts I18n.t('vagrant_rimu.errors.global_error').red unless e.message && e.message.start_with?('Catched Error:')
+          raise e
+        end
+        # rubocop:enable Lint/RescueException
+
+        def normalize_args(args)
+          return args if args.nil?
+          args.pop if args.size > 0 && args.last == '--'
+          args
+        end
+
+        def before_cmd(_name, _argv, _env)
+        end
+
+        def cmd(_name, _argv, _env)
+          fail 'Command not implemented. \'cmd\' method must be overridden in all subclasses'
+        end
+      end
+    end
+  end
+end

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

@@ -1,16 +1,16 @@
+require 'vagrant-rimu/commands/rimu_command'
+
 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
+      class BillingMethods < RimuCommand
+        def self.synopsis
+          I18n.t('vagrant_rimu.commands.billing_methods')
+        end
+
+        def cmd(name, argv, env)
+          fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 0
+          env[:machine].action('billing_methods')
         end
       end
     end

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

@@ -1,16 +1,16 @@
+require 'vagrant-rimu/commands/rimu_command'
+
 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
+      class Distributions < RimuCommand
+        def self.synopsis
+          I18n.t('vagrant_rimu.commands.list_distributions')
+        end
+
+        def cmd(name, argv, env)
+          fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 0
+          env[:machine].action('list_distributions')
         end
       end
     end

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

@@ -1,16 +1,16 @@
+require 'vagrant-rimu/commands/rimu_command'
+
 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
+      class ListServers < RimuCommand
+        def self.synopsis
+          I18n.t('vagrant_rimu.commands.list_servers')
+        end
+
+        def cmd(name, argv, env)
+          fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 0
+          env[:machine].action('list_servers')
         end
       end
     end

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

@@ -1,16 +1,16 @@
+require 'vagrant-rimu/commands/abstract_command'
+
 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
+      class Move < AbstractCommand
+        def self.synopsis
+          I18n.t('vagrant_rimu.commands.move')
+        end
+
+        def cmd(name, argv, env)
+          fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 0
+          env[:machine].action('move')
         end
       end
     end

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

@@ -1,18 +1,17 @@
 require 'optparse'
+require 'vagrant-rimu/commands/abstract_command'
 
 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
+      class Rebuild < AbstractCommand
+        def self.synopsis
+          I18n.t('vagrant_rimu.commands.rebuild')
+        end
+
+        def cmd(name, argv, env)
+          fail Errors::NoArgRequiredForCommand, cmd: name unless argv.size == 0
+          env[:machine].action('rebuild')
         end
       end
     end

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

@@ -0,0 +1,13 @@
+require 'vagrant-rimu/commands/abstract_command'
+
+module VagrantPlugins
+  module Rimu
+    module Commands
+      class RimuCommand < AbstractCommand
+        def before_cmd(_name, _argv, env)
+          VagrantPlugins::Rimu::Actions::ConnectToRimu.new(nil, env).call(env)
+        end
+      end
+    end
+  end
+end

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

@@ -1,65 +1,48 @@
-require 'optparse'
-
 module VagrantPlugins
   module Rimu
     module Commands
+      COMMANDS = [
+        { name: :'billing-methods', file: 'billing_methods', clazz: 'BillingMethods' },
+        { name: :'distributions', file: 'distributions', clazz: 'Distributions' },
+        { name: :'servers', file: 'list_servers', clazz: 'ListServers' },
+        { name: :'move-vps', file: 'move', clazz: 'Move' },
+        { name: :'rebuild', file: 'rebuild', clazz: 'Rebuild' },
+      ]
+
       class Root < Vagrant.plugin('2', :command)
         def self.synopsis
-          'query Rimu for various options'
+          I18n.t('vagrant_rimu.command.root_synopsis')
         end
 
         def initialize(argv, env)
+          @env = env
           @main_args, @sub_command, @sub_args = split_main_and_subcommand(argv)
+          @commands = Vagrant::Registry.new
 
-          @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
+          COMMANDS.each do |cmd|
+            @commands.register(cmd[:name]) do
+              require_relative cmd[:file]
+              Commands.const_get(cmd[:clazz])
+            end
           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
+          command_class = @commands.get(@sub_command.to_sym) if @sub_command
+          return usage unless command_class && @sub_command
+          command_class.new(@sub_args, @env).execute(@sub_command)
         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`'
+        def usage
+          @env.ui.info I18n.t('vagrant_rimu.commands.root_usage')
+          @env.ui.info ''
+          @env.ui.info I18n.t('vagrant_rimu.commands.available_subcommands')
+          @commands.each do |key, value|
+            @env.ui.info "     #{key.to_s.ljust(20)} #{value.synopsis}"
           end
-          @env.ui.info(opts.help, prefix: false)
+          @env.ui.info ''
         end
       end
     end

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

@@ -0,0 +1,22 @@
+require 'terminal-table'
+
+module VagrantPlugins
+  module Rimu
+    module Commands
+      module Utils
+        # def display_item_list(env, items)
+        #   rows = []
+        #   items.each do |item|
+        #     rows << [item.id, item.name]
+        #   end
+        #   display_table(env, %w(ID Name), rows)
+        # end
+
+        def display_table(env, headers, rows)
+          table = Terminal::Table.new headings: headers, rows: rows
+          env[:ui].info("\n#{table}")
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-rimu/config.rb

@@ -137,6 +137,7 @@ module VagrantPlugins
         @data_centre = UNSET_VALUE
       end
 
+      # rubocop:disable Metrics/AbcSize
       def finalize!
         @api_key = ENV['RIMU_API_KEY'] if @api_key == UNSET_VALUE
         @api_url = ENV['RIMU_URL'] if @api_url == UNSET_VALUE

data/lib/vagrant-rimu/errors.rb

@@ -18,6 +18,10 @@ module VagrantPlugins
       class ApiError < RimuError
         error_key(:api_error)
       end
+
+      class NoArgRequiredForCommand < RimuError
+        error_key(:no_args)
+      end
     end
   end
 end

data/lib/vagrant-rimu/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Rimu
-    VERSION = '0.0.2'
+    VERSION = '0.0.3'
   end
 end

data/locales/en.yml

@@ -35,25 +35,6 @@ en:
             private_key: "A valid SSH private key path option: [private_key_path] is required"
             missing_private_key: "SSH private key not found: %{key}"
             public_key: "SSH public key not found: %{key}"
-        errors:
-            api_error: |-
-                The API request failed. Please inspect the error message
-                below for more info.
-
-                Error: %{stderr}
-            public_key: |-
-                There was an issue reading the public key at:
-
-                Path: %{path}
-
-                Please check the file's permissions.
-            rsync: |-
-                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}
         states:
           short_not_created: |-
             not created
@@ -77,3 +58,53 @@ en:
           long_running: |-
             The VPS is running. To stop this machine, you can run
             `vagrant halt`. To destroy the machine, you can run `vagrant destroy`.
+        commands:
+            root_synopsis: |-
+                Rimu provider specific commands
+            root_usage: |-
+                Usage: vagrant rimu <subcommand> [<args>]
+            available_subcommands: |-
+                Available subcommands:
+            billing_methods: |-
+                List billing methods
+            list_distributions: |-
+                List Distributions
+            list_servers: |-
+                List servers
+            move: |-
+                Moves server to different host
+            rebuild: |-
+                Rebuilds the server, retaining the current IP address
+        errors:
+            global_error: |-
+                An unknown error happened in Vagrant Rimu provider
+
+                To easily debug what happened, we recommend to set the environment
+                variable VAGRANT_RIMU_LOG to debug
+
+                  $ export VAGRANT_RIMU_LOG=debug
+
+                If doing this does not help fixing your issue, there may be a bug
+                in the provider. Please submit an issue on Github at
+                https://github.com/akissa/vagrant-rimu
+                with the stracktrace and the logs.
+            no_args: |-
+                Command '%{cmd}' does not required any argument.
+            api_error: |-
+                The API request failed. Please inspect the error message
+                below for more info.
+
+                Error: %{stderr}
+            public_key: |-
+                There was an issue reading the public key at:
+
+                Path: %{path}
+
+                Please check the file permissions.
+            rsync: |-
+                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}