souffle 0.0.1

data/lib/souffle/node.rb

@@ -0,0 +1,70 @@
+module Souffle
+  class Node; end
+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
+
+    state_machine :state, :initial => :uninitialized do
+    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.
+    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
+    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
+      @children.push(node)
+    end
+
+    # Iterator method for children.
+    # 
+    # @yield [ Souffle::Node,nil ] 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
+
+  end
+end

data/lib/souffle/provider/aws.rb

@@ -0,0 +1,16 @@
+require 'souffle/provider'
+
+# The AWS souffle provider.
+class Souffle::Provider::AWS < Souffle::Provider
+
+  # Setup the internal AWS configuration and object.
+  def setup
+  end
+  
+  # The name of the given provider.
+  def name; "AWS"; end
+
+  # Creates a raid array with the given requirements.
+  def create_raid
+  end
+end

data/lib/souffle/provider/vagrant.rb

@@ -0,0 +1,15 @@
+require 'souffle/provider'
+
+# The Vagrant souffle provider.
+class Souffle::Provider::Vagrant < Souffle::Provider
+
+  # Setup the internal Vagrant configuration and object.
+  def setup
+  end
+
+  # The name of the given provider.
+  def name; "Vagrant"; end
+
+  # Noop.
+  def create_raid; end
+end

data/lib/souffle/provider.rb

@@ -0,0 +1,27 @@
+# The souffle cloud provider class.
+class Souffle::Provider
+  
+  # The setup method for the provider. Intended to be overridden.
+  # 
+  # @raise [Souffle::Exceptions::Provider] This definition must be overridden.
+  def setup
+    error_msg = "#{self.to_s}: you must override setup"
+    raise Souffle::Exceptions::Provider, error_msg
+  end
+
+  # The name of the given provider. Intended to be overridden.
+  # 
+  # @raise [Souffle::Exceptions::Provider] This definition must be overridden.
+  def name
+    error_msg = "#{self.to_s}: you must override name"
+    raise Souffle::Exceptions::Provider, error_msg
+  end
+
+  # Creates a raid array for a given provider. Intended to be overridden.
+  # 
+  # @raise [Souffle::Exceptions::Provider] This definition must be overridden.
+  def create_raid
+    error_msg = "#{self.to_s}: you must override create_raid"
+    raise Souffle::Exceptions::Provider, error_msg
+  end
+end

data/lib/souffle/providers.rb

@@ -0,0 +1,2 @@
+require 'souffle/provider/aws'
+require 'souffle/provider/vagrant'

data/lib/souffle/server.rb

@@ -0,0 +1,14 @@
+module Souffle
+  # The souffle server and management daemon.
+  class Server
+
+    # Creates a new souffle server.
+    def initialize
+    end
+
+    # Runs the server.
+    def run
+    end
+    
+  end
+end

data/lib/souffle/system.rb

@@ -0,0 +1,51 @@
+module Souffle
+  # A system description with nodes and the statemachine to manage them.
+  class System
+    attr_reader :nodes, :root, :provider
+
+    state_machine :state, :initial => :uninitialized do
+      before_transition :uninitialized => any - :uninitialized,
+        :do => :initialize_provider
+
+      around_transition do |system, transition, block|
+        start = Time.now
+        block.call
+        system.time_used += Time.now - start
+      end
+    end
+
+    # Creates a new souffle system, defaulting to using Vagrant as a provider.
+    # 
+    # @param [ String ] provider The provider to use for the given system.
+    def initialize(provider="Vagrant")
+      initialize_provider(provider)
+      super() # NOTE: This is here to initialize state_machine.
+    end
+
+    def initialize_provider(provider)
+      @provider = Souffle::Provider.const_get(provider.to_sym).new
+    rescue
+      raise Souffle::Exceptions::InvalidProvider,
+        "The provider Souffle::Provider::#{provider} does not exist."
+    end
+
+    # Proxy to the provider setup routine.
+    def setup_provider
+      @provider.setup
+    end
+
+    # Adds the root node to the system.
+    # 
+    # @param [ Souffle::Node ] node The node to become to root node.
+    def root=(node)
+      @root = node
+    end
+
+    # Adds a node to the system tree.
+    # 
+    # @param [ Souffle::Node ] node The node to add into the tree.
+    def add(node)
+    end
+
+  end
+end

data/lib/souffle/worker.rb

@@ -0,0 +1,14 @@
+module Souffle
+  # The souffle worker daemon.
+  class Worker
+
+    # Creates a new souffle worker.
+    def initialize
+    end
+
+    # Runs the worker.
+    def run
+    end
+
+  end
+end

data/lib/souffle.rb

@@ -0,0 +1,17 @@
+$:.unshift File.dirname(__FILE__)
+require 'yajl'
+require 'eventmachine'
+require 'state_machine'
+require 'right_aws'
+
+# An orchestrator for setting up isolated chef-managed systems.
+module Souffle
+  VERSION = "0.0.1"
+end
+
+require 'souffle/log'
+require 'souffle/exceptions'
+require 'souffle/config'
+require 'souffle/providers'
+require 'souffle/node'
+require 'souffle/system'

data/spec/config/example.json

@@ -0,0 +1,6 @@
+{
+  "random_something": 1234,
+  "aws_access_key": "test_key",
+  "aws_access_secret": "test_secret"
+}
+

data/spec/config/example.rb

@@ -0,0 +1,4 @@
+random_something 1234
+aws_access_key "test_key"
+aws_access_secret "test_secret"
+

data/spec/config_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Souffle::Config" do
+  it "should be able to read from a ruby config file" do
+    config = File.join(File.dirname(__FILE__), 'config', 'example.rb')
+    Souffle::Config.from_file(config)
+
+    Souffle::Config[:random_something].should == 1234
+    Souffle::Config[:aws_access_key].should == "test_key"
+    Souffle::Config[:aws_access_secret].should == "test_secret"
+  end
+
+  it "should be able to read from a json config stream" do
+    config = File.join(File.dirname(__FILE__), 'config', 'example.json')
+    Souffle::Config.from_stream_json(IO.read(config))
+
+    Souffle::Config[:random_something].should == 1234
+    Souffle::Config[:aws_access_key].should == "test_key"
+    Souffle::Config[:aws_access_secret].should == "test_secret"
+  end
+
+  it "should be able to read from a json config file" do
+    config = File.join(File.dirname(__FILE__), 'config', 'example.json')
+    Souffle::Config.from_file(config, "json")
+
+    Souffle::Config[:random_something].should == 1234
+    Souffle::Config[:aws_access_key].should == "test_key"
+    Souffle::Config[:aws_access_secret].should == "test_secret"
+  end
+end

data/spec/node_spec.rb

@@ -0,0 +1,87 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Souffle::Node" do
+  before(:each) do
+    @node = Souffle::Node.new
+  end
+
+  after(:each) do
+    @node = nil
+  end
+
+  it "should be able to setup dependencies" do
+    @node.dependencies << "recipe[chef_server]"
+    item = @node.dependencies.first
+    item.type.should eql("recipe")
+    item.name.should eql("chef_server")
+  end
+
+  it "should be able to setup the run_list" do
+    @node.run_list << "role[example_role]"
+    item = @node.run_list.first
+    item.type.should eql("role")
+    item.name.should eql("example_role")
+  end
+
+  it "should fail on improper run_list type" do
+    lambda { @node.run_list<<("b0rken[role]") }.should raise_error
+  end
+
+  it "should fail on improper run_list name" do
+    lambda { @node.run_list << "role[GT***]}" }.should raise_error
+  end
+
+  it "should be able to describe a single node" do
+    @node.run_list << "recipe[chef_server::rubygems_install]"
+    @node.run_list << "role[dns_server]"
+  end
+
+  it "should be able to test whether or not a node depends on another" do
+    @node.run_list << "role[dns_server]"
+    node2 = Souffle::Node.new
+    node2.dependencies << "role[dns_server]"
+    node2.depends_on?(@node).should eql(true)
+  end
+
+  it "should not depend on another node when there are no dependencies" do
+    @node.run_list << "role[dns_server]"
+    node2 = Souffle::Node.new
+    node2.depends_on?(@node).should eql(false)
+  end
+
+  it "should be able to add child nodes" do
+    child = Souffle::Node.new
+    lambda { @node.add_child(child) }.should_not raise_error
+    @node.children.should eql([child])
+  end
+
+  it "should raise and error on adding an invalid child" do
+    child = []
+    lambda { node.add_child(child) }.should raise_error
+  end
+
+  it "should be able to iterate across children" do
+    child1 = Souffle::Node.new
+    child2 = Souffle::Node.new
+    @node.add_child(child1)
+    @node.add_child(child2)
+
+    children = [child1, child2]
+    @node.each_child { |c| children.delete(c) }
+    children.should eql([])
+  end
+
+  it "should be able to test node equality" do
+    @node.dependencies << "role[awesome]"
+    @node.run_list << "recipe[the_best]"
+    
+    node2 = Souffle::Node.new
+    node2.dependencies << "role[awesome]"
+    node2.run_list << "recipe[the_best]"
+    @node.should eql(node2)
+  end
+
+  it "should have an initial state of `:uninitialized`" do
+    @node.state_name.should eql(:uninitialized)
+  end
+end

data/spec/runlist_parser_spec.rb

@@ -0,0 +1,83 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Souffle::Node::RunListParser" do
+  it "should be able to check whether a hash name is a valid word" do
+    ex = Hash.new
+    ex["name"] = "AwesomeWord"
+    d = lambda { Souffle::Node::RunListParser.gaurentee_name_is_word(ex) }
+    d.should_not raise_error
+  end
+
+  it "should raise an error when the hash name is spaced" do
+    ex = Hash.new
+    ex["name"] = "AwesomeWord SecondWord"
+    d = lambda { Souffle::Node::RunListParser.gaurentee_name_is_word(ex) }
+    d.should raise_error
+  end
+
+  it "should raise an error when the hash name contains invalid characters" do
+    ex = Hash.new
+    ex["name"] = "AwesomeWord**"
+    d = lambda { Souffle::Node::RunListParser.gaurentee_name_is_word(ex) }
+    d.should raise_error
+  end
+
+  it "should raise an error when the hash is empty" do
+    ex = Hash.new
+    d = lambda { Souffle::Node::RunListParser.gaurentee_valid_keys(ex) }
+    d.should raise_error
+  end
+
+  it "should raise an error when the hash is nil" do
+    ex = nil
+    d = lambda { Souffle::Node::RunListParser.gaurentee_valid_keys(ex) }
+    d.should raise_error
+  end
+
+  it "should raise an error when the name is nil but the type is valid" do
+    ex = Hash.new
+    ex["name"] = nil
+    ex["type"] = "role"
+    d = lambda { Souffle::Node::RunListParser.gaurentee_valid_keys(ex) }
+    d.should raise_error
+  end
+
+  it "should raise an error when the name is empty but the type is valid" do
+    ex = Hash.new
+    ex["name"] = ""
+    ex["type"] = "recipe"
+    d = lambda { Souffle::Node::RunListParser.gaurentee_valid_keys(ex) }
+    d.should raise_error
+  end
+
+  it "should raise an error when the name is valid but the type is nil" do
+    ex = Hash.new
+    ex["name"] = "best_name"
+    ex["type"] = nil
+    d = lambda { Souffle::Node::RunListParser.gaurentee_valid_keys(ex) }
+    d.should raise_error
+  end
+
+  it "should raise an error when the name is valud but the type is empty" do
+    ex = Hash.new
+    ex["name"] = "anotherone"
+    ex["type"] = ""
+    d = lambda { Souffle::Node::RunListParser.gaurentee_valid_keys(ex) }
+    d.should raise_error
+  end
+
+    it "should raise an error when parsing an invalid type" do
+    d = lambda { Souffle::Node::RunListParser.parse("rofsdfsdle[somerole]") }
+    d.should raise_error
+  end
+
+  it "should be able to parse a role" do
+    r = Souffle::Node::RunListParser.parse("role[painfully_long_role]")
+    r.should eql( {"type" => "role", "name" => "painfully_long_role"} )
+  end
+
+  it "should be able to parse a recipe" do
+    r = Souffle::Node::RunListParser.parse("recipe[a_pretty_serious_recipe]")
+    r.should eql( {"type" => "recipe", "name" => "a_pretty_serious_recipe"} )
+  end
+end

data/spec/runlist_spec.rb

@@ -0,0 +1,14 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Souffle::Node::RunList" do
+  it "should be able to add a runlist item onto the runlist" do
+    rl = Souffle::Node::RunList.new
+    rl << "role[dns_server]"
+    rl << "recipe[chef_server::rubygems_install]"
+  end
+
+  it "should raise an error when an invalid runlist item is added" do
+    rl = Souffle::Node::RunList.new
+    lambda { rl << "fsjklfds" }.should raise_error
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+if RUBY_VERSION =~ /^1\.9/
+  require 'simplecov'
+
+  module SimpleCov::Configuration
+    def clean_filters
+      @filters = []
+    end
+  end
+
+  SimpleCov.configure do
+    clean_filters
+    load_adapter 'test_frameworks'
+  end
+
+  ENV["COVERAGE"] && SimpleCov.start do
+    add_filter "/.rvm/"
+  end
+end
+
+require 'rspec'
+require 'souffle'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+
+end

data/spec/system_spec.rb

@@ -0,0 +1,35 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Souffle::System" do
+  before(:each) do
+    @system = Souffle::System.new
+  end
+
+  after(:each) do
+    @system = nil
+  end
+
+  it "should be able to setup a Vagrant provider" do
+    @system.provider.name.should eql("Vagrant")
+  end
+
+  it "should be able to setup an AWS provider" do
+    @system = Souffle::System.new("AWS")
+    @system.provider.name.should eql("AWS")
+  end
+
+  it "should raise an InvalidProvider error when the provider doesn't exist" do
+    d = lambda { @system = Souffle::System.new("UnholyProviderOfBadness") }
+    d.should raise_error
+  end
+
+  it "should be able to add a root node" do
+    node = Souffle::Node.new
+    @system.root = node
+    @system.root.should eql(node)
+  end
+
+  it "should have an initial state of `:uninitialized`" do
+    @system.state_name.should eql(:uninitialized)
+  end
+end