souffle 0.0.1 → 0.0.2

data/lib/souffle/exceptions.rb

@@ -1,21 +1,33 @@
-module Souffle
-  # Souffle specific exceptions; intended for debugging purposes.
-  class Exceptions
-    
-    # Application level error.
-    class Application < RuntimeError; end
-    # Provider level error.
-    class Provider < RuntimeError; end
+# Souffle specific exceptions; intended for debugging purposes.
+class Souffle::Exceptions
+  
+  # Application level error.
+  class Application < RuntimeError; end
+  # Provider level error.
+  class Provider < RuntimeError; end
 
-    # Runlist Name cannot be nil or empty and must be a word [A-Za-z0-9_:].
-    class InvalidRunlistName < RuntimeError; end
-    # Runlist Type cannot be nil or empty and must be one of (role|recipe).
-    class InvalidRunlistType < RuntimeError; end
+  # Runlist Name cannot be nil or empty and must be a word [A-Za-z0-9_:].
+  class InvalidRunlistName < RuntimeError; end
+  # Runlist Type cannot be nil or empty and must be one of (role|recipe).
+  class InvalidRunlistType < RuntimeError; end
 
-    # Node children must respond to dependencies and run_list.
-    class InvalidChild < RuntimeError; end
+  # Node children must respond to dependencies and run_list.
+  class InvalidChild < RuntimeError; end
+  # Node parents must respond to dependencies and run_list.
+  class InvalidParent < RuntimeError; end
 
-    # The provider must exist in souffle/providers.
-    class InvalidProvider < RuntimeError; end
-  end
+  # The provider must exist in souffle/providers.
+  class InvalidProvider < RuntimeError; end
+
+  # The system hash must have a nodes key with a list of nodes.
+  class InvalidSystemHash < RuntimeError; end
+
+  # The souffle ssh directory must have writable permissions.
+  class PermissionErrorSshKeys < RuntimeError; end
+
+  # The AWS Instance searched for does not exist.
+  class AwsInstanceDoesNotExist < RuntimeError; end
+
+  # The AWS Keys are invalid.
+  class InvalidAwsKeys < RuntimeError; end
 end

data/lib/souffle/http.rb

@@ -0,0 +1,43 @@
+require 'sinatra/base'
+
+require 'souffle/state'
+
+# The souffle service REST interface.
+class Souffle::Http < Sinatra::Base
+  before { content_type :json }
+
+  # Returns the current version of souffle.
+  get '/' do
+    { :name => 'souffle',
+      :version => Souffle::VERSION }.to_json
+  end
+
+  # Returns the current status of souffle.
+  get '/status' do
+    { :status => Souffle::State.status }.to_json
+  end
+
+  # Returns the id for the created environment or false on failure.
+  put '/create' do
+    begin
+      data = JSON.parse(request.body.read, :symbolize_keys => true)
+    rescue
+      status 415
+      return {  :success => false,
+                :message => "Invalid json in request." }.to_json
+    end
+
+    user = data[:user]
+    msg =  "Http request to create a new system"
+    msg << " for user: #{user}" if user
+    Souffle::Log.debug msg
+    Souffle::Log.debug data.to_s
+
+    provider = Souffle::Provider::AWS.new
+
+    system = Souffle::System.from_hash(data)
+    provider.create_system(system)
+
+    { :success => true }.to_json
+  end
+end

data/lib/souffle/log.rb

@@ -1,22 +1,19 @@
 require 'logger'
 require 'mixlib/log'
 
-module Souffle
-  # Souffle's internal logging facility.
-  # Standardized to provide a consistent log format.
-  class Log
-    extend Mixlib::Log
+# Souffle's internal logging facility.
+# Standardized to provide a consistent log format.
+class Souffle::Log
+  extend Mixlib::Log
 
-    # Force initialization of the primary log device (@logger)
-    init
+  # Force initialization of the primary log device (@logger).
+  init
 
-    # Monkeypatch Formatter to allow local show_time updates.
-    class Formatter
-      # Allow enabling and disabling of time with a singleton.
-      def self.show_time=(*args)
-        Mixlib::Log::Formatter.show_time = *args
-      end
+  # Monkeypatch Formatter to allow local show_time updates.
+  class Formatter
+    # Allow enabling and disabling of time with a singleton.
+    def self.show_time=(*args)
+      Mixlib::Log::Formatter.show_time = *args
     end
-
   end
 end

data/lib/souffle/node.rb

@@ -1,70 +1,108 @@
-module Souffle
-  class Node; end
-end
+# A node object that's part of a given system.
+class Souffle::Node; end
 
 require 'souffle/node/runlist_item'
 require 'souffle/node/runlist'
 
-module Souffle
-  # A node object that's part of a given system.
-  class Node
-    attr_accessor :dependencies, :run_list, :parent
-    attr_reader :children
+# A node object that's part of a given system.
+class Souffle::Node
+  attr_accessor :system, :dependencies, :run_list,
+    :parents, :children, :name, :options, :provisioner
 
-    state_machine :state, :initial => :uninitialized do
-    end
+  # Creates a new souffle node with bare dependencies and run_list.
+  # 
+  # @param [ Fixnum ] parent_multiplier The multiplier for parent nodes.
+  def initialize(parent_multiplier=5)
+    @dependencies = Souffle::Node::RunList.new
+    @run_list = Souffle::Node::RunList.new
+    @parents = []
+    @children = []
+    @options = {
+      :attributes => Hash.new
+    }
+    @parent_multiplier = parent_multiplier
+  end
 
-    # Creates a new souffle node with bare dependencies and run_list.
-    def initialize
-      @dependencies = Souffle::Node::RunList.new
-      @run_list = Souffle::Node::RunList.new
-      @parent = nil
-      @children = []
-      super() # NOTE: This is here to initialize state_machine.
+  # Check whether or not a given node depends on another node.
+  # 
+  # @example
+  # 
+  #   n1 = Souffle::Node.new
+  #   n2 = Souffle::Node.new
+  # 
+  #   n1.run_list     << "role[dns_server]"
+  #   n2.dependencies << "role[dns_server]"
+  #   n2.depends_on?(n1)
+  # 
+  #   > [ true, [role[dns_server]] ]
+  # 
+  # @param [ Souffle::Node ] node Check to see whether this node depends
+  # 
+  # @return [ Array ] The tuple of [depends_on, dependency_list].
+  def depends_on?(node)
+    dependency_list = []
+    @dependencies.each do |d|
+      dependency_list << d if node.run_list.include? d
     end
+    [dependency_list.any?, dependency_list]
+  end
 
-    # Check whether or not a given node depends on another node.
-    # 
-    # @param [ Souffle::Node ] node Check to see whether this node depends
-    # 
-    # @return [ true,false ] Whether or not this node depends on the given.
-    def depends_on?(node)
-      depends = false
-      self.dependencies.each do |d|
-        if node.run_list.include? d
-          depends = true
-        end
-      end
-      depends
+  # Adds a child node to the current node.
+  # 
+  # @param [ Souffle::Node ] node The node to add as a child.
+  # 
+  # @raise [ InvaidChild ] Children must have dependencies and a run_list.
+  def add_child(node)
+    unless node.respond_to?(:dependencies) && node.respond_to?(:run_list)
+      raise Souffle::Exceptions::InvalidChild,
+        "Child must act as a Souffle::Node"
     end
-
-    # Adds a child node to the current node.
-    # 
-    # @param [ Souffle::Node ] node The node to add as a child.
-    # 
-    # @raise [ InvaidChild ] Children must have dependencies and a run_list.
-    def add_child(node)
-      unless node.respond_to?(:dependencies) && node.respond_to?(:run_list)
-        raise Souffle::Exceptions::InvalidChild,
-          "Child must act as a Souffle::Node"
-      end
-      node.parent = self
+    unless @children.include? node
+      node.parents << self
       @children.push(node)
     end
+  end
 
-    # Iterator method for children.
-    # 
-    # @yield [ Souffle::Node,nil ] The child node.
-    def each_child
-      @children.each { |child| yield child }
-    end
+  # Iterator method for children.
+  # 
+  # @yield [ Souffle::Node,NilClass ] The child node.
+  def each_child
+    @children.each { |child| yield child }
+  end
+
+  # Equality comparator for nodes.
+  # 
+  # @param [ Souffle::Node ] other The node to compare against.
+  def eql?(other)
+    @dependencies == other.dependencies && @run_list == other.run_list
+  end
 
-    # Equality comparator for nodes.
-    # 
-    # @param [ Souffle::Node ] other The node to compare against.
-    def eql?(other)
-      @dependencies == other.dependencies && @run_list == other.run_list
+  # The dependency weight of a given node.
+  # 
+  # @return [ Fixnum ] The relative weight of a node used for balancing.
+  def weight
+    @parents.inject(1) { |res, p| res + p.weight * @parent_multiplier }
+  end
+
+  # Tries to fetch an option parameter otherwise it grabs it from config.
+  # 
+  # @param [ Symbol ] opt The option to try and fetch.
+  # 
+  # @return [ String ] The option return value.
+  def try_opt(opt)
+    if system
+      options.fetch(opt, system.try_opt(opt))
+    else
+      options.fetch(opt, Souffle::Config[opt])
     end
+  rescue
+    nil
+  end
 
+  # The logging prefix for the given node.
+  # 
+  # @return [ String ] The logging prefix for the given node.
+  def log_prefix
+    "[#{try_opt(:tag)}: #{name}]"
   end
 end

data/lib/souffle/node/runlist.rb

@@ -1,24 +1,22 @@
 require 'souffle/node/runlist_item'
 
-module Souffle
-  # A specialized Array that handles runlist items appropriately.
-  class Node::RunList < Array
+# A specialized Array that handles runlist items appropriately.
+class Souffle::Node::RunList < Array
 
-    # Pushes another runlist item onto the runlist array.
-    # 
-    # @param [ String ] item The runlist item as a string.
-    def <<(item)
-      item = Souffle::Node::RunListItem.new(item)
-      super(item)
-    end
-
-    # Pushes another item onto the runlist array.
-    # 
-    # @param [ String ] item The runlist item as a string.
-    def push(item)
-      item = Souffle::Node::RunListItem.new(item)
-      super(item)
-    end
+  # Pushes another runlist item onto the runlist array.
+  # 
+  # @param [ String ] item The runlist item as a string.
+  def <<(item)
+    item = Souffle::Node::RunListItem.new(item)
+    super(item)
+  end
 
+  # Pushes another item onto the runlist array.
+  # 
+  # @param [ String ] item The runlist item as a string.
+  def push(item)
+    item = Souffle::Node::RunListItem.new(item)
+    super(item)
   end
+
 end

data/lib/souffle/node/runlist_item.rb

@@ -1,46 +1,53 @@
 require 'souffle/node/runlist_parser'
 
-module Souffle
-  # A single runlist item, most be parsed and either a recipe or role.
-  class Node::RunListItem
+# A single runlist item, most be parsed and either a recipe or role.
+class Souffle::Node::RunListItem
 
-    # Creates a new runlist item from a string.
-    # 
-    # @param [ String ] item The runlist string to turn into an object.
-    # @raise [ InvalidRunlistName, InvalidRunlistType ] Raises exceptions when
-    # the runlist item or type isn't a proper chef role or recipe.
-    def initialize(item=nil)
-      @original_item = item
-      @item = Souffle::Node::RunListParser.parse(item)
-    end
+  # Creates a new runlist item from a string.
+  # 
+  # @param [ String ] item The runlist string to turn into an object.
+  # @raise [ InvalidRunlistName, InvalidRunlistType ] Raises exceptions when
+  # the runlist item or type isn't a proper chef role or recipe.
+  def initialize(item=nil)
+    @original_item = item
+    @item = Souffle::Node::RunListParser.parse(item)
+  end
 
-    # Returns the name of the runlist item.
-    # 
-    # @return [ String ] The name of the runlist item.
-    def name
-      @item["name"]
-    end
+  # Returns the name of the runlist item.
+  # 
+  # @return [ String ] The name of the runlist item.
+  def name
+    @item["name"]
+  end
 
-    # Returns the type of the runlist item.
-    # 
-    # @return [ String ] The type of the runlist item.
-    def type
-      @item["type"]
-    end
+  # Returns the type of the runlist item.
+  # 
+  # @return [ String ] The type of the runlist item.
+  def type
+    @item["type"]
+  end
 
-    # Returns the RunListItem as it's original string.
-    def to_s
-      @original_item
-    end
+  # Returns the RunListItem as it's original string.
+  def to_s
+    @original_item
+  end
 
-    # Overriding the default equality comparator to use string representation.
-    # 
-    # @param [ Souffle::Node::RunListItem ] runlist_item
-    # 
-    # @return [ true,false ] Whether or not the objects are equal.
-    def ==(runlist_item)
-      self.to_s == runlist_item.to_s
-    end
+  # Overriding the default equality comparator to use string representation.
+  # 
+  # @param [ Souffle::Node::RunListItem ] runlist_item
+  # 
+  # @return [ Boolean ] Whether or not the objects are equal.
+  def ==(runlist_item)
+    self.to_s == runlist_item.to_s
+  end
 
+  # Overriding the default equality comparator to use string representation.
+  # 
+  # @param [ Souffle::Node::RunListItem ] runlist_item
+  # 
+  # @return [ Boolean ] Whether or not the objects are equal.
+  def eql?(runlist_item)
+    self.to_s == runlist_item.to_s
   end
+  
 end

data/lib/souffle/node/runlist_parser.rb

@@ -1,73 +1,71 @@
-module Souffle
-  # The runlist parser singleton.
-  class Node::RunListParser
+# The runlist parser singleton.
+class Souffle::Node::RunListParser
 
-    # The runlist match parser
-    PARSER = %r{
-      (?<type> (recipe|role)) {0}   # The runlist item type.
-      (?<name> (.*)) {0}            # The runlist item name.
+  # The runlist match parser
+  PARSER = %r{
+    (?<type> (recipe|role)) {0}   # The runlist item type.
+    (?<name> (.*)) {0}            # The runlist item name.
 
-      \g<type>\[\g<name>\]
-    }x
+    \g<type>\[\g<name>\]
+  }x
 
-    class << self
-      # Checks to see whether the runlist item is a valid recipe or role.
-      # 
-      # @param [ String ] item The runlist item.
-      # 
-      # @return [ Hash ] The runlist item as a hash.
-      def parse(item)
-        runlist_hash = hashify_match(PARSER.match(item))
-        gaurentee_valid_keys(runlist_hash)
-        gaurentee_name_is_word(runlist_hash)
-        runlist_hash
-      end
+  class << self
+    # Checks to see whether the runlist item is a valid recipe or role.
+    # 
+    # @param [ String ] item The runlist item.
+    # 
+    # @return [ Hash ] The runlist item as a hash.
+    def parse(item)
+      runlist_hash = hashify_match(PARSER.match(item))
+      gaurentee_valid_keys(runlist_hash)
+      gaurentee_name_is_word(runlist_hash)
+      runlist_hash
+    end
 
-      # Takes the matches and converts them into a hashed version.
-      # 
-      # @param [ MatchData,nil ] match The MatchData to hashify.
-      # 
-      # @return [ Hash,nil ] The hashified version of the runlist item.
-      def hashify_match(match)
-        return nil if match.nil?
-        Hash[*match.names.zip(match.captures).flatten]
-      end
+    # Takes the matches and converts them into a hashed version.
+    # 
+    # @param [ MatchData,NilClass ] match The MatchData to hashify.
+    # 
+    # @return [ Hash,NilClass ] The hashified version of the runlist item.
+    def hashify_match(match)
+      return nil if match.nil?
+      Hash[*match.names.zip(match.captures).flatten]
+    end
 
-      # Tests whether the runlist_hash name and type are valid.
-      # 
-      # @param [ Hash ] runlist_hash The runlist hash to test.
-      # 
-      # @raise [ InvalidRunlistName, InvalidRunlistType ] Raises exceptions
-      # when the runlist match failed, the type wasn't a recipe or role,
-      # or when the name itself isn't a valid word.
-      def gaurentee_valid_keys(runlist_hash)
-        if runlist_hash.nil?
-          raise Souffle::Exceptions::InvalidRunlistType,
-            "Type must be one of (role|recipe)"
-        end
-        if runlist_hash["name"].nil? or runlist_hash["name"].empty?
-          raise Souffle::Exceptions::InvalidRunlistName,
-            "Name cannot be nil or empty."
-        end
-        if runlist_hash["type"].nil? or runlist_hash["type"].empty?
-          raise Souffle::Exceptions::InvalidRunlistType,
-            "Type cannot be nil or empty and must be one of (role|recipe)"
-        end
+    # Tests whether the runlist_hash name and type are valid.
+    # 
+    # @param [ Hash ] runlist_hash The runlist hash to test.
+    # 
+    # @raise [ InvalidRunlistName, InvalidRunlistType ] Raises exceptions
+    # when the runlist match failed, the type wasn't a recipe or role,
+    # or when the name itself isn't a valid word.
+    def gaurentee_valid_keys(runlist_hash)
+      if runlist_hash.nil?
+        raise Souffle::Exceptions::InvalidRunlistType,
+          "Type must be one of (role|recipe)"
       end
-
-      # Checks whether the runlist_hash is a valid word.
-      # 
-      # @param [ Hash ] runlist_hash The runlist hash to test.
-      # 
-      # @raise [ InvalidRunlistName ] Runlist Name is invalid.
-      def gaurentee_name_is_word(runlist_hash)
-        m = /[A-Za-z0-9_:]+/
-        unless m.match(runlist_hash["name"])[0] == runlist_hash["name"]
-          raise Souffle::Exceptions::InvalidRunlistName,
-            "Name must be [A-Za-z0-9_:]."
-        end
+      if runlist_hash["name"].nil? or runlist_hash["name"].empty?
+        raise Souffle::Exceptions::InvalidRunlistName,
+          "Name cannot be nil or empty."
+      end
+      if runlist_hash["type"].nil? or runlist_hash["type"].empty?
+        raise Souffle::Exceptions::InvalidRunlistType,
+          "Type cannot be nil or empty and must be one of (role|recipe)"
       end
     end
 
+    # Checks whether the runlist_hash is a valid word.
+    # 
+    # @param [ Hash ] runlist_hash The runlist hash to test.
+    # 
+    # @raise [ InvalidRunlistName ] Runlist Name is invalid.
+    def gaurentee_name_is_word(runlist_hash)
+      m = /[A-Za-z0-9_\-:]+/
+      unless m.match(runlist_hash["name"])[0] == runlist_hash["name"]
+        raise Souffle::Exceptions::InvalidRunlistName,
+          "Name must be [A-Za-z0-9_-:]."
+      end
+    end
   end
+
 end