orca 0.1.0

data/lib/orca/resolver.rb

@@ -0,0 +1,37 @@
+class Orca::Resolver
+  attr_reader :packages, :tree
+  def initialize(package)
+    @package = package
+    @last_seen = package
+    @tree = [@package]
+    @packages = []
+  end
+
+  def resolve
+    dependancies = @package.dependancies.reverse.map { |d| Orca::PackageIndex.default.get(d) }
+    begin
+      @tree += dependancies.map {|d| Orca::Resolver.new(d).resolve.tree }
+    rescue SystemStackError
+      raise CircularDependancyError.new
+    end
+    @packages = @tree.flatten
+    @packages.reverse!
+    @packages.uniq!
+    add_children
+    self
+  end
+
+  def add_children
+    @packages = @packages.reduce([]) do |arr, package|
+      arr << package
+      package.children.each do |child_name|
+        child = Orca::PackageIndex.default.get(child_name)
+        arr << child unless arr.include?(child)
+      end
+      arr
+    end
+  end
+
+  class CircularDependancyError < StandardError
+  end
+end

data/lib/orca/runner.rb

@@ -0,0 +1,81 @@
+class Orca::Runner
+  def initialize(node, package)
+    @node = node
+    @package = package
+    @perform = true
+  end
+
+  def packages
+    resolver = Orca::Resolver.new(@package)
+    resolver.resolve
+    resolver.packages
+  end
+
+  def execute(command_name)
+    @node.log command_name, packages.map(&:name).join(', ').yellow
+    packages.each do |pkg|
+      send(:"execute_#{command_name}", pkg)
+    end
+  end
+
+  def execute_apply(pkg)
+    return unless should_run?(pkg, :apply)
+    exec(pkg, :apply)
+    validate!(pkg)
+  end
+
+  def execute_remove(pkg)
+    return unless should_run?(pkg, :remove)
+    exec(pkg, :remove)
+  end
+
+  def execute_validate(pkg)
+    validate!(pkg)
+  end
+
+  def should_run?(pkg, command_name)
+    return false unless pkg.provides_command?(command_name)
+    return true unless @perform
+    return true unless command_name == :apply || command_name == :remove
+    return true unless pkg.provides_command?(:validate)
+    is_present = is_valid?(pkg)
+    return !is_present if command_name == :apply
+    return is_present
+  end
+
+  def validate!(pkg)
+    return true unless @perform
+    return unless pkg.provides_command?(:validate)
+    return if is_valid?(pkg)
+    raise ValidationFailureError.new(@node, pkg)
+  end
+
+  def is_valid?(pkg)
+    results = exec(pkg, :validate)
+    results.all?
+  end
+
+  def demonstrate(command_name)
+    @perform = false
+    execute(command_name)
+    @perform = true
+  end
+
+  def exec(pkg, command_name)
+    @node.log pkg.name, command_name.to_s.yellow
+    context = @perform ? Orca::ExecutionContext.new(@node) : Orca::MockExecutionContext.new(@node)
+    cmds = pkg.command(command_name)
+    cmds.map {|cmd| context.apply(cmd) }
+  end
+
+  class ValidationFailureError < StandardError
+    def initialize(node, package)
+      @node = node
+      @package = package
+    end
+
+    def message
+      "Package #{@package.name} failed validation on #{@node.to_s}"
+    end
+  end
+end

data/lib/orca/suite.rb

@@ -0,0 +1,18 @@
+class Orca::Suite
+
+  def load_file(file)
+    Orca::DSL.module_eval(File.read(file))
+  end
+
+  def execute(node_name, pkg_name, command)
+    node = Orca::Node.find(node_name)
+    pkg = Orca::PackageIndex.default.get(pkg_name)
+    Orca::Runner.new(node, pkg).execute(command)
+  end
+
+  def demonstrate(node_name, pkg_name, command)
+    node = Orca::Node.find(node_name)
+    pkg = Orca::PackageIndex.default.get(pkg_name)
+    Orca::Runner.new(node, pkg).demonstrate(command)
+  end
+end

data/orca.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andy Kent"]
+  gem.email         = ["andy.kent@me.com"]
+  gem.description   = %q{Orca is a super simple way to build and configure servers}
+  gem.summary       = %q{Simplified Machine Building}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "orca"
+  gem.require_paths = ["lib"]
+  gem.version       = '0.1.0'
+  gem.add_dependency('colored')
+  gem.add_dependency('net-ssh')
+  gem.add_dependency('net-sftp')
+  gem.add_dependency('thor')
+end

data/test/dsl_test.rb

@@ -0,0 +1,35 @@
+require_relative 'test_helper'
+
+describe Orca::DSL do
+  describe "'package' command" do
+    after :each do
+      reset_package_index!
+    end
+
+    it "adds a package to the index" do
+      Orca::DSL.package('my-package') { nil }
+      Orca::PackageIndex.default.get('my-package').must_be_instance_of Orca::Package
+    end
+
+    it "creates a new package based on the supplied name" do
+      Orca::DSL.package('my-package') { nil }
+      package = Orca::PackageIndex.default.get('my-package')
+      package.name.must_equal 'my-package'
+    end
+
+    it "executes the given definition block in the package context" do
+      Orca::DSL.package('my-package') { depends_on 'other-package' }
+      package = Orca::PackageIndex.default.get('my-package')
+      package.dependancies.must_equal ['other-package']
+    end
+  end
+
+  describe "'node' command" do
+    it "creates a node and adds it to the index" do
+      Orca::DSL.node('node-name', 'node-host')
+      node = Orca::Node.find('node-name')
+      node.name.must_equal 'node-name'
+      node.host.must_equal 'node-host'
+    end
+  end
+end

data/test/fixtures/example.txt

@@ -0,0 +1 @@
+example

data/test/local_file_test.rb

@@ -0,0 +1,59 @@
+require_relative 'test_helper'
+
+describe Orca::LocalFile do
+  before :each do
+    @local_file_path = File.join(File.dirname(__FILE__), 'fixtures', 'example.txt')
+    @local_file = Orca::LocalFile.new(@local_file_path)
+  end
+
+  describe 'path' do
+    it "returns the absolute path of a local file" do
+      @local_file.path.must_equal @local_file_path
+    end
+  end
+
+  describe 'hash' do
+    it "returns the sha1 of a local file" do
+      @local_file.hash.must_equal 'c3499c2729730a7f807efb8676a92dcb6f8a3f8f'
+    end
+  end
+
+  describe 'matches' do
+    it "returns true if the passed file has a matching hash" do
+      @local_file.matches?(@local_file).must_equal true
+    end
+  end
+
+  describe 'exists?' do
+    it "checks if a file exists" do
+      @local_file.exists?.must_equal true
+    end
+  end
+
+  describe 'copy_to' do
+    before(:each) { @destination = Orca::LocalFile.new("/tmp/example-#{Time.now.to_i}.txt") }
+    after(:each)  { @destination.delete! }
+
+    it "copies a file to another local location" do
+      @destination.exists?.must_equal false
+      @local_file.copy_to(@destination).must_equal @destination
+      @destination.exists?.must_equal true
+    end
+
+    it "copies a file to a remote location by uploading it" do
+      @remote_destination_context = mock()
+      @remote_destination = Orca::RemoteFile.new(@remote_destination_context, "/tmp/example-dest.txt")
+      @remote_destination_context.expects(:upload).with(@local_file.path, @remote_destination.path)
+      @local_file.copy_to(@remote_destination).must_equal @remote_destination
+    end
+  end
+
+  describe 'set_permissions' do
+    it "sets permissions on the file based on a mask" do
+      @local_file.set_permissions(0664).must_equal @local_file
+      @local_file.permissions.must_equal 0664
+      @local_file.set_permissions(0644).must_equal @local_file
+      @local_file.permissions.must_equal 0644
+    end
+  end
+end

data/test/package_index_test.rb

@@ -0,0 +1,48 @@
+require_relative 'test_helper'
+
+describe Orca::PackageIndex do
+  before :each do
+    @package = Orca::Package.new('my-package')
+    @default = Orca::PackageIndex.default
+  end
+
+  after :each do
+    reset_package_index!
+  end
+
+  describe "default" do
+    it "returns a package index singleton named default" do
+      Orca::PackageIndex.default.index_name.must_equal 'default'
+    end
+
+    it "allways returns the same package index" do
+      Orca::PackageIndex.default.must_equal Orca::PackageIndex.default
+    end
+  end
+
+  describe "add" do
+    it "adds a package to the index" do
+      @default.add(@package)
+      @default.get(@package.name).must_equal @package
+    end
+  end
+
+  describe 'get' do
+    it "fetches a package by name" do
+      @default.add(@package)
+      @default.get(@package.name).must_equal @package
+    end
+
+    it "throws an execption if the package doesn't exist" do
+      assert_raises(Orca::PackageIndex::MissingPackageError) { @default.get(@package.name) }
+    end
+  end
+
+  describe "clear!" do
+    it "wipes the index clean of packages" do
+      @default.add(@package)
+      @default.clear!
+      assert_raises(Orca::PackageIndex::MissingPackageError) { @default.get(@package.name) }
+    end
+  end
+end

data/test/package_test.rb

@@ -0,0 +1,51 @@
+require_relative 'test_helper'
+
+describe Orca::Package do
+  before :each do
+    @package = Orca::Package.new('my-package')
+  end
+
+  describe "depends_on" do
+    it "adds a dependancy" do
+      @package.dependancies.must_equal []
+      @package.depends_on('other-package')
+      @package.dependancies.must_equal ['other-package']
+    end
+
+    it "adds multiple dependancies at once" do
+      @package.dependancies.must_equal []
+      @package.depends_on('other-package', 'third-package')
+      @package.dependancies.must_equal ['other-package', 'third-package']
+    end
+  end
+
+  describe "action" do
+    it "allows defining actions with a name and a block" do
+      @package.action('my-action') { 'foo' }
+      @package.actions['my-action'].call.must_equal 'foo'
+    end
+  end
+
+  describe "commands" do
+    it "can add an 'apply' command" do
+      @package.apply { 'my-apply' }
+      @package.command(:apply).first.call.must_equal 'my-apply'
+    end
+
+    it "can add an 'remove' command" do
+      @package.remove { 'my-remove' }
+      @package.command(:remove).first.call.must_equal 'my-remove'
+    end
+
+    it "can add an 'validate' command" do
+      @package.validate { 'my-validate' }
+      @package.command(:validate).first.call.must_equal 'my-validate'
+    end
+
+    it 'knows if a command is provided' do
+      @package.provides_command?(:apply).must_equal false
+      @package.apply { 'my-apply' }
+      @package.provides_command?(:apply).must_equal true
+    end
+  end
+end

data/test/remote_file_test.rb

@@ -0,0 +1,91 @@
+require_relative 'test_helper'
+
+describe Orca::RemoteFile do
+  before :each do
+    @local_file_path = File.join(File.dirname(__FILE__), 'fixtures', 'example.txt')
+    @local_file = Orca::LocalFile.new(@local_file_path)
+    @remote_file_path = '/tmp/example.txt'
+    @context = mock()
+    @remote_file = Orca::RemoteFile.new(@context, @remote_file_path)
+  end
+
+  describe 'path' do
+    it "returns the absolute path of a local file" do
+      @remote_file.path.must_equal @remote_file_path
+    end
+  end
+
+  describe 'hash' do
+    it "returns the sha1 of a remote file" do
+      @context.expects(:run)
+              .with(%[if [ -f #{@remote_file_path} ]; then echo "true"; else echo "false"; fi])
+              .returns("true\n")
+      @context.expects(:run)
+              .with("sha1sum #{@remote_file_path}")
+              .returns("c3499c2729730a7f807efb8676a92dcb6f8a3f8f #{@remote_file_path}")
+      @remote_file.hash.must_equal 'c3499c2729730a7f807efb8676a92dcb6f8a3f8f'
+    end
+  end
+
+  describe 'matches' do
+    it "returns true if the passed file has a matching hash" do
+      @context.expects(:run)
+              .with(%[if [ -f #{@remote_file_path} ]; then echo "true"; else echo "false"; fi])
+              .returns("true\n")
+      @context.expects(:run)
+              .with("sha1sum #{@remote_file_path}")
+              .returns("c3499c2729730a7f807efb8676a92dcb6f8a3f8f #{@remote_file_path}")
+      @remote_file.matches?(@remote_file).must_equal true
+    end
+  end
+
+  describe 'exists?' do
+    it "checks if a file exists" do
+      @context.expects(:run)
+              .with(%[if [ -f #{@remote_file_path} ]; then echo "true"; else echo "false"; fi])
+              .returns("true\n")
+      @remote_file.exists?.must_equal true
+    end
+
+    it "checks if a missing file exists" do
+      @context.expects(:run)
+              .with(%[if [ -f #{@remote_file_path} ]; then echo "true"; else echo "false"; fi])
+              .returns("false\n")
+      @remote_file.exists?.must_equal false
+    end
+  end
+
+  describe 'copy_to' do
+    it "copies a file to another remote location" do
+      @remote_destination_context = mock()
+      @remote_destination = Orca::RemoteFile.new(@remote_destination_context, "/tmp/example-dest.txt")
+      @context.expects(:sudo)
+              .with(%[cp #{@remote_file.path} #{@remote_destination.path}])
+              .returns("true\n")
+      @remote_file.copy_to(@remote_destination).must_equal @remote_destination
+    end
+
+    it "copies a file to local location by downlaoding it" do
+      @local_destination = Orca::LocalFile.new("/tmp/example-#{Time.now.to_i}.txt")
+      @context.expects(:download)
+              .with(@remote_file_path, @local_destination.path)
+      @remote_file.copy_to(@local_destination).must_equal @local_destination
+    end
+  end
+
+  describe 'delete!' do
+    it "removes the file from the remote server" do
+      @context.expects(:remove).with(@remote_file.path)
+      @remote_file.delete!
+    end
+  end
+
+  describe 'set_permissions' do
+    it "sets permissions on the file based on a mask" do
+      @context.expects(:sudo).with('chmod -R 644 /tmp/example.txt')
+      @context.expects(:run).with("stat --format=%a /tmp/example.txt").returns("644\n")
+      @remote_file.set_permissions(0644).must_equal @remote_file
+      @remote_file.permissions.must_equal 0644
+    end
+  end
+end