derelict_m 0.6.2a

data/lib/derelict/instance/command_failed.rb

@@ -0,0 +1,30 @@
+module Derelict
+  class Instance
+    # Represents an invalid instance, which can't be used with Derelict
+    class CommandFailed < Derelict::Exception
+      # Initializes a new instance of this exception, for a command
+      #
+      #   * command: The name of the command which failed (optional,
+      #              provides extra detail in the message)
+      #   * result:  The result (Derelict::Executer) for the command
+      #              which failed (optional, provides extra detail in
+      #              the message)
+      def initialize(command = nil, result = nil)
+        super [default_message, describe(command, result)].join
+      end
+
+      private
+        # Retrieves the default error message
+        def default_message
+          "Error executing Vagrant command"
+        end
+
+        def describe(command = nil, result = nil)
+          [
+            command.nil? ? "" : " '#{command}'",
+            result.nil? ? "" : ", STDERR output:\n#{result.stderr}",
+          ].join
+        end
+    end
+  end
+end

data/lib/derelict/instance/invalid.rb

@@ -0,0 +1,14 @@
+module Derelict
+  class Instance
+    # Represents an invalid instance, which can't be used with Derelict
+    class Invalid < Derelict::Exception
+      include Derelict::Exception::OptionalReason
+
+      private
+        # Retrieves the default error message
+        def default_message
+          "Invalid Derelict instance"
+        end
+    end
+  end
+end

data/lib/derelict/instance/missing_binary.rb

@@ -0,0 +1,13 @@
+module Derelict
+  class Instance
+    # The "vagrant" binary was missing from the instance
+    class MissingBinary < Invalid
+      # Initializes a new instance of this exception for a given file
+      #
+      #   * file: The expected location of the binary
+      def initialize(file)
+        super "'vagrant' binary not found at #{file}"
+      end
+    end
+  end
+end

data/lib/derelict/instance/non_directory.rb

@@ -0,0 +1,13 @@
+module Derelict
+  class Instance
+    # The path used for the instance was a file, not a directory
+    class NonDirectory < Invalid
+      # Initializes a new instance of this exception for a given path
+      #
+      #   * path: The requested path of the instance
+      def initialize(path)
+        super "expected directory, found file: #{path}"
+      end
+    end
+  end
+end

data/lib/derelict/instance/not_found.rb

@@ -0,0 +1,13 @@
+module Derelict
+  class Instance
+    # The path used for the instance was not found
+    class NotFound < Invalid
+      # Initializes a new instance of this exception for a given path
+      #
+      #   * path: The requested path of the instance
+      def initialize(path)
+        super "directory doesn't exist: #{path}"
+      end
+    end
+  end
+end

data/lib/derelict/parser.rb

@@ -0,0 +1,27 @@
+module Derelict
+  # Base class for parsers, which extract data from command output
+  class Parser
+    autoload :BoxList,    "derelict/parser/box_list"
+    autoload :PluginList, "derelict/parser/plugin_list"
+    autoload :Status,     "derelict/parser/status"
+    autoload :Version,    "derelict/parser/version"
+
+    # Include "logger" method to get a logger for this class
+    include Utils::Logger
+
+    attr_reader :output
+
+    # Initializes the parser with the output it will be parsing
+    def initialize(output)
+      @output = output
+      logger.debug "Successfully initialized #{description}"
+    end
+
+    # Provides a description of this Parser
+    #
+    # Mainly used for log messages.
+    def description
+      "Derelict::Parser (unknown type)"
+    end
+  end
+end

data/lib/derelict/parser/box_list.rb

@@ -0,0 +1,53 @@
+module Derelict
+  # Parses the output of "vagrant box list"
+  class Parser::BoxList < Parser
+    autoload :InvalidFormat, "derelict/parser/box_list/invalid_format"
+
+    # Include "memoize" class method to memoize methods
+    extend Memoist
+
+    # Output from "vagrant box list" if there are no boxes installed
+    NO_BOXES = <<-END.gsub(/^ {6}/, '')
+      There are no installed boxes! Use `vagrant box add` to add some.
+    END
+
+    # Regexp to parse a box line into a box name and provider
+    #
+    # Capture groups:
+    #
+    #   1. Box name, as listed in the output
+    #   2. Name of the provider for that box
+    PARSE_BOX = %r[
+      ^(.*?)   # Box name starts at the start of the line
+      \ +\(    # Provider is separated by spaces and open-parenthesis
+        (\w+)  # Provider name
+      (:?,.+)? # Version, ignored
+      \)$      # Ends with close-parenthesis and end-of-line
+    ]x         # Ignore whitespace to allow these comments
+
+    # Retrieves a Set containing all the boxes from the output
+    def boxes
+      box_lines.map {|l| parse_line l.match(PARSE_BOX) }.to_set
+    end
+
+    # Provides a description of this Parser
+    #
+    # Mainly used for log messages.
+    def description
+      "Derelict::Parser::BoxList instance"
+    end
+
+    private
+      # Retrieves an array of the box lines in the output
+      def box_lines
+        return [] if output.match NO_BOXES
+        output.lines
+      end
+
+      # Parses a single line of the output into a Box object
+      def parse_line(match)
+        raise InvalidFormat.new "Couldn't parse box list" if match.nil?
+        Derelict::Box.new *match.captures[0..1]
+      end
+  end
+end

data/lib/derelict/parser/box_list/invalid_format.rb

@@ -0,0 +1,16 @@
+module Derelict
+  class Parser
+    class BoxList
+      # The box list wasn't in the expected format, can't be parsed
+      class InvalidFormat < Derelict::Exception
+        include Derelict::Exception::OptionalReason
+
+        private
+          # Retrieves the default error message
+          def default_message
+            "Output from 'vagrant box list' was in an unexpected format"
+          end
+      end
+    end
+  end
+end

data/lib/derelict/parser/plugin_list.rb

@@ -0,0 +1,63 @@
+module Derelict
+  # Parses the output of "vagrant plugin list"
+  class Parser::PluginList < Parser
+    autoload :InvalidFormat, "derelict/parser/plugin_list/invalid_format"
+    autoload :NeedsReinstall, "derelict/parser/plugin_list/needs_reinstall"
+
+    # Include "memoize" class method to memoize methods
+    extend Memoist
+
+    # Regexp to parse a plugin line into a plugin name and version
+    #
+    # Capture groups:
+    #
+    #   1. Plugin name, as listed in the output
+    #   2. Currently installed version (without surrounding brackets)
+    PARSE_PLUGIN = %r[
+      ^([A-Za-z0-9\-_.]+) # Plugin name starts at the start of the line.
+      \                   # Version is separated by a space character,
+      \(                  # surrounded by brackets,
+        ([0-9\-_.]+)      # consists of numbers, hyphens, underscore, dot,
+        (, .*)?           # optionally followed by a comma space and word
+      \)
+      $                   # at the end of the line.
+    ]x                    # Ignore whitespace to allow these comments.
+
+    # Regexp to determine whether plugins need to be reinstalled
+    NEEDS_REINSTALL = %r[
+      ^The\splugins\sbelow\swill\snot\sbe\sloaded\suntil\sthey're\s
+      uninstalled\sand\sreinstalled:$
+    ]x
+
+    # Retrieves a Set containing all the plugins from the output
+    def plugins
+      raise NeedsReinstall, output if needs_reinstall?
+      plugin_lines.map {|l| parse_line l.match(PARSE_PLUGIN) }.to_set
+    end
+
+    # Determines if old plugins need to be reinstalled
+    def needs_reinstall?
+      output =~ NEEDS_REINSTALL
+    end
+
+    # Provides a description of this Parser
+    #
+    # Mainly used for log messages.
+    def description
+      "Derelict::Parser::PluginList instance"
+    end
+
+    private
+      # Retrieves an array of the plugin lines in the output
+      def plugin_lines
+        return [] if output.match /no plugins installed/i
+        output.lines.grep(/^\w/)
+      end
+
+      # Parses a single line of the output into a Plugin object
+      def parse_line(match)
+        raise InvalidFormat.new "Couldn't parse plugin" if match.nil?
+        Derelict::Plugin.new *match.captures[0..1]
+      end
+  end
+end

data/lib/derelict/parser/plugin_list/invalid_format.rb

@@ -0,0 +1,16 @@
+module Derelict
+  class Parser
+    class PluginList
+      # The plugin list wasn't in the expected format, can't be parsed
+      class InvalidFormat < Derelict::Exception
+        include Derelict::Exception::OptionalReason
+
+        private
+          # Retrieves the default error message
+          def default_message
+            "Output from 'vagrant plugin list' was in an unexpected format"
+          end
+      end
+    end
+  end
+end

data/lib/derelict/parser/plugin_list/needs_reinstall.rb

@@ -0,0 +1,22 @@
+module Derelict
+  class Parser
+    class PluginList
+      # Vagrant plugins need to be uninstalled and re-installed
+      class NeedsReinstall < Derelict::Exception
+        # Retrieves the output from Vagrant
+        attr_reader :output
+
+        # Initializes a new instance, for a particular box name/provider
+        #
+        #   * output: The output from Vagrant
+        def initialize(output)
+          @output = output
+          super <<-END.gsub(/\s+/, ' ').strip
+            Vagrant plugins installed before upgrading to version 1.4.x
+            need to be uninstalled and re-installed.
+          END
+        end
+      end
+    end
+  end
+end

data/lib/derelict/parser/status.rb

@@ -0,0 +1,90 @@
+module Derelict
+  # Parses the output of "vagrant status"
+  class Parser::Status < Parser
+    autoload :InvalidFormat, "derelict/parser/status/invalid_format"
+
+    # Include "memoize" class method to memoize methods
+    extend Memoist
+
+    # Regexp to extract the VM list from the "vagrant status" output
+    PARSE_LIST_FROM_OUTPUT = /Current machine states:\n\n((?:.*\n)+)\n/i
+
+    # Regexp to extract the state from a line in the VM list
+    PARSE_STATE_FROM_LIST_ITEM = %r[
+      ^(.*?) # VM name starts at the start of the line,
+      \s{2,} # to the first instance of 2 or more spaces.
+      (.*?)  # VM state starts after the whitespace,
+      \s+\(  # continuing until whitespace and open bracket.
+        (.*) # The provider name starts after the bracket,
+      \)$    # and ends at a closing bracket at line end.
+      ]x     # Ignore whitespace to allow these comments
+
+    # Retrieves the names of all virtual machines in the output
+    #
+    # The names are returned as a Set of symbols.
+    def vm_names
+      Set[*states.keys]
+    end
+
+    # Determines if a particular virtual machine exists in the output
+    #
+    #   * vm_name: The name of the virtual machine to look for
+    def exists?(vm_name = nil)
+      return (vm_names.count > 0) if vm_name.nil?
+      vm_names.include? vm_name.to_sym
+    end
+
+    # Determines the state of a particular virtual machine
+    #
+    # The state is returned as a symbol, e.g. :running.
+    #
+    #   * vm_name: The name of the virtual machine to retrieve state
+    def state(vm_name)
+      unless states.include? vm_name.to_sym
+        raise Derelict::VirtualMachine::NotFound.new vm_name
+      end
+
+      states[vm_name.to_sym]
+    end
+
+    # Provides a description of this Parser
+    #
+    # Mainly used for log messages.
+    def description
+      "Derelict::Parser::Status instance"
+    end
+
+    private
+      # Retrieves the virtual machine list section of the output
+      def vm_lines
+        output.match(PARSE_LIST_FROM_OUTPUT).tap {|list|
+          logger.debug "Parsing VM list from output using #{description}"
+          raise InvalidFormat.new "Couldn't find VM list" if list.nil?
+        }.captures[0].lines
+      end
+      memoize :vm_lines
+
+      # Retrieves the state data for all virtual machines in the output
+      #
+      # The state is returned as a Hash, mapping virtual machine names
+      # (as symbols) to their state (also as a symbol). Both of these
+      # symbols have spaces converted to underscores (for convenience
+      # when writing literals in other code).
+      def states
+        logger.debug "Parsing states from VM list using #{description}"
+        vm_lines.inject Hash.new do |hash, line|
+          hash.merge! parse_line(line.match PARSE_STATE_FROM_LIST_ITEM)
+        end
+      end
+      memoize :states
+
+      def parse_line(match)
+        raise InvalidFormat.new "Couldn't parse VM list" if match.nil?
+        Hash[*match.captures[0..1].map {|value| sanitize value }]
+      end
+
+      def sanitize(value)
+        value.to_s.gsub(/\s+/, "_").downcase.to_sym
+      end
+  end
+end

data/lib/derelict/parser/status/invalid_format.rb

@@ -0,0 +1,16 @@
+module Derelict
+  class Parser
+    class Status
+      # The status wasn't in the expected format and couldn't be parsed
+      class InvalidFormat < Derelict::Exception
+        include Derelict::Exception::OptionalReason
+
+        private
+          # Retrieves the default error message
+          def default_message
+            "Output from 'vagrant status' was in an unexpected format"
+          end
+      end
+    end
+  end
+end

data/lib/derelict/parser/version.rb

@@ -0,0 +1,28 @@
+module Derelict
+  # Parses the output of "vagrant --version"
+  class Parser::Version < Parser
+    autoload :InvalidFormat, "derelict/parser/version/invalid_format"
+
+    # Include "memoize" class method to memoize methods
+    extend Memoist
+
+    # Regexp to extract the version from the "vagrant --version" output
+    PARSE_VERSION_FROM_OUTPUT = /^Vagrant (?:v(?:ersion )?)?(.*)?$/
+
+    # Determines the version of Vagrant based on the output
+    def version
+      logger.debug "Parsing version from output using #{description}"
+      matches = output.match PARSE_VERSION_FROM_OUTPUT
+      raise InvalidFormat.new output if matches.nil?
+      matches.captures[0]
+    end
+    memoize :version
+
+    # Provides a description of this Parser
+    #
+    # Mainly used for log messages.
+    def description
+      "Derelict::Parser::Version instance"
+    end
+  end
+end

data/lib/derelict/parser/version/invalid_format.rb

@@ -0,0 +1,16 @@
+module Derelict
+  class Parser
+    class Version
+      # The version wasn't in the expected format and couldn't be parsed
+      class InvalidFormat < Derelict::Exception
+        include Derelict::Exception::OptionalReason
+
+        private
+          # Retrieves the default error message
+          def default_message
+            "Output from 'vagrant --version' was in an unexpected format"
+          end
+      end
+    end
+  end
+end