orca 0.1.0

data/.gitignore

@@ -0,0 +1,2 @@
+
+pkg/*.gem

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake'
+gem 'mocha', :require => false

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    orca (0.1.0)
+      colored
+      net-sftp
+      net-ssh
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    colored (1.2)
+    metaclass (0.0.1)
+    mocha (0.13.1)
+      metaclass (~> 0.0.1)
+    net-sftp (2.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.6.7)
+    rake (10.0.4)
+    thor (0.18.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  mocha
+  orca!
+  rake

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Andrew Kent
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,109 @@
+Orca
+====
+
+**Because building servers shouldn't be a PITA.**
+
+Orca is a super simple way to build and configure servers.
+
+If you've found yourself stuck in the gap between deployment tools like Capistrano and full blown infrastructure tools like Puppet and Chef then Orca is probably for you.
+
+
+What problem does Orca try to solve?
+------------------------------------
+
+All too often you need to get a new server up and running to a known state so that you can get an app deployed. Before Orca there were boardly 4 options...
+
+1. Start from scratch and hand install all the packages, files, permissions, etc. Yourself via trial and error over SSH.
+2. Use a deployment tool like Capistrano to codeify your shell scripts into semi-reusable steps.
+3. Use Puppet or Chef in single machine mode.
+4. Use Full blown Puppet or Chef, this requires a server.
+
+Orca fills the rather large gap between (2) and (3). It's a bigger gap then you think as both Puppet and Chef require...
+
+- bootstrapping a machine to a point where you are able to run them
+- Creating a seperate repository describing the configuration you require
+- learning their complex syntaxes and structures
+- hiding the differences of different host OSes
+
+Orca fixes these problems by...
+
+- working directly over SSH, all you need is a box tht you can connect to
+- package definitions can all go in a single file and most servers can be configured in ~50 lines
+- packages are defined in a ruby based DSL that consists of only 5 very basic commands to learn
+- Orca makes no assumptions about the underlying OS accept to assume it supports SSH
+- Orca is extensible and adding platform specific features like package manger support can be achieved in a dozen or so lines.
+
+
+What problems is Orca avoiding?
+-------------------------------
+
+Orca intentionally skirts around some important thengs that may or may not matter to you. If they do then you are probably better using more robust tools such as Puppet or Chef.
+
+Orca doesn't...
+
+- try to scale beyond a smallish number of nodes
+- have any algorithyms that attempt to run periodically and converge divergent configurations
+- abstract the differences of different host OSes
+- provide a server to supervise infrastructure configuration
+
+
+Installation
+------------
+
+To install orca you will need to be running Ruby 1.9 or 2.0 and then install the orca gem from this repository...
+
+    gem 'orca', :git => 'git@github.com:andykent/orca.git'
+
+
+Command Line Usage
+------------------
+
+To get started from within your projct you can run...
+
+    bundle exec orca init .
+
+This will create a config/orca.rb file for you to get started with.
+
+To ship run a command the syntax is as follows...
+
+    orca [command] [package] [node]
+
+So here are some examples (assuming you have a package called "app" and a node called "server" defined in your orca.rb)...
+
+    orca apply app server
+    orca remove app server
+    orca demonstrate app server
+
+
+The Orca DSL
+------------
+
+Orca packages are written in a Ruby based DSL. It's really simple to learn in less than 5 mins. Here's an example orca.rb file with all you'll need to know to get started...
+
+    # define a new pacage called 'gem' that provides some actions for managing rubygems
+    package 'gem' do
+      depends_on 'ruby-1.9.3'                           # this package depends on another package called ruby-1.9.3
+      action 'exists' do |gem_name|                     # define an action that other packages can trigger called 'exists'
+        run("gem list -i #{gem_name}") =~ /true/        # execute the command, get the output and check it contains 'true'
+      end
+      action 'install' do |gem_name|
+        run "gem install #{gem_name} --no-ri --no-rdoc"
+      end
+      action 'uninstall' do |gem_name|
+        run "gem uninstall #{gem_name} -x -a"
+      end
+    end
+
+    # define a package called 'bundler' that can be used to manage the gem by the same name
+    package 'bundler' do
+      depends_on 'gem'
+      apply do                                # apply gets called whenever this package or a package that depends on it is applied
+        trigger('gem:install', 'bundler')     # trigger triggers defined actions, in this case the action 'instal' on 'gem'
+      end
+      remove do                               # remove gets called whenever this package or a package that depends on it is removed
+        trigger('gem:remove', 'bundler')
+      end
+      validate do                             # validate is used internally to check if the package is applied correctly or not
+        trigger('gem:exists', 'bundler')
+      end
+    end

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test

data/bin/orca

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'fileutils'
+
+require_relative "../lib/orca"
+
+Orca::Cli.start(ARGV)

data/config/template/orca.rb

@@ -0,0 +1,28 @@
+# This is an example Orca configuration file
+# You will need to edit or define for youself at
+# least one node and one package for orca to work.
+
+
+# Define at least one or more nodes where you want
+# package to be applied, nodes are usually
+# physical or virtual machines.
+
+node 'server', 'my.server.address'
+
+
+# packages get applied to servers from the command line
+# Most simple projects will have an 'app' package which
+# defines all the projects dependancies.
+
+package 'app' do
+  depends_on 'my-package'
+end
+
+
+# Define the other packages that you will need...
+
+package 'my-package' do
+  apply do
+    # your logic here
+  end
+end

data/lib/orca.rb

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'colored'
+require 'thor'
+
+module Orca
+  def root
+    File.dirname(ENV['ORCA_FILE'])
+  end
+  module_function :root
+
+  def add_package(name)
+    package = Orca::Package.new(name)
+    yield(package) if block_given?
+    Orca::PackageIndex.default.add(package)
+    package
+  end
+  module_function :add_package
+
+  def extension(name, &blk)
+    Orca::DSL.class_eval(&blk)
+  end
+  module_function :extension
+
+  class MissingExtensionError < StandardError
+    def initialize(extension_name)
+      @extension_name = extension_name
+    end
+
+    def message
+      "The extension '#{@extension_name}' is not available."
+    end
+  end
+end
+
+require_relative "./orca/package"
+require_relative "./orca/package_index"
+require_relative "./orca/node"
+require_relative "./orca/runner"
+require_relative "./orca/resolver"
+require_relative "./orca/execution_context"
+require_relative "./orca/local_file"
+require_relative "./orca/remote_file"
+require_relative "./orca/dsl"
+require_relative "./orca/suite"
+require_relative "./orca/cli"
+
+require_relative "./orca/extensions/apt"
+require_relative "./orca/extensions/file_sync"

data/lib/orca/cli.rb

@@ -0,0 +1,53 @@
+class Orca::Cli < Thor
+  include Thor::Actions
+
+  source_root File.join(File.dirname(__FILE__), *%w[.. .. config])
+
+  class_option :demonstrate, :type => :boolean, :desc => "Don't actually run any commands on the node, just pretend."
+  class_option :file,        :banner => 'ORCA_FILE', :desc => "path to the orca.rb file to load, defaults to ./orca/orca.rb"
+  class_option :throw,       :type => :boolean, :desc => "Don't pretty print errors, raise with a stack trace."
+
+  desc "apply PACKAGE_NAME NODE_NAME", "apply the given package onto the given named node"
+  def apply(package, node)
+    run_command(package, node, :apply)
+  end
+
+  desc "remove PACKAGE_NAME NODE_NAME", "remove the given package onto the given named node"
+  def remove(package, node)
+    run_command(package, node, :remove)
+  end
+
+  desc "validate PACKAGE_NAME NODE_NAME", "run validation steps on the given named node"
+  def validate(package, node)
+    run_command(package, node, :validate)
+  end
+
+  desc "init", "initialize the current directory with a orca/orca.rb"
+  def init
+    directory('template', 'orca')
+  end
+
+  private
+
+  def run_command(package, node, cmd)
+    begin
+      suite = Orca::Suite.new
+      suite.load_file(orca_file)
+      if options[:demonstrate]
+        suite.demonstrate(node, package, cmd)
+      else
+        suite.execute(node, package, cmd)
+      end
+    rescue => e
+      if options[:throw]
+        raise e
+      else
+        puts "!!! ERROR !!! [#{e.class.name}] #{e.message}".red.bold
+      end
+    end
+  end
+
+  def orca_file
+    ENV['ORCA_FILE'] ||= (options[:file] || File.join(Dir.pwd, 'orca', 'orca.rb'))
+  end
+end

data/lib/orca/dsl.rb

@@ -0,0 +1,18 @@
+module Orca
+  module DSL
+    module_function
+    def package(name, &definition)
+      Orca.add_package(name) do |pkg|
+        pkg.instance_eval(&definition)
+      end
+    end
+
+    def load_extension(name)
+      Orca.load_extension(name)
+    end
+
+    def node(name, host, options={})
+      Orca::Node.new(name, host, options)
+    end
+  end
+end

data/lib/orca/execution_context.rb

@@ -0,0 +1,89 @@
+class Orca::ExecutionContext
+  def initialize(node)
+    @node = node
+  end
+
+  def apply(blk)
+    instance_eval(&blk)
+  end
+
+  def run(cmd)
+    @node.execute(cmd)
+  end
+
+  def sudo(cmd)
+    @node.sudo(cmd)
+  end
+
+  def upload(from, to)
+    @node.upload(from, to)
+  end
+
+  def download(from, to)
+    @node.download(from, to)
+  end
+
+  def local(path)
+    Orca::LocalFile.new(path)
+  end
+
+  def remove(path)
+    @node.remove(path)
+  end
+
+  def stat(path)
+    @node.stat(path)
+  end
+
+  def setstat(path, opts)
+    @node.setstat(path, opts)
+  end
+
+  def remote(path)
+    Orca::RemoteFile.new(self, path)
+  end
+
+  def trigger(action_ref, *args)
+    pkg_name, action_name = *action_ref.split(':', 2)
+    pkg = Orca::PackageIndex.default.get(pkg_name)
+    action = pkg.actions[action_name]
+    raise "Action #{action_ref} could not be found." unless action
+    instance_exec(*args, &action)
+  end
+
+  def binary_exists?(binary)
+    run("which #{binary}") =~ /\/#{binary}/
+  end
+end
+
+class Orca::MockExecutionContext < Orca::ExecutionContext
+  def run(cmd)
+    @node.log 'mock-execute', cmd
+    ''
+  end
+
+  def sudo(cmd)
+    @node.log 'mock-execute', "sudo #{cmd}"
+    ''
+  end
+
+  def upload(from, to)
+    @node.log('mock-sftp', "UPLOAD: #{from} => #{to}")
+  end
+
+  def download(from, to)
+    @node.log('mock-sftp', "DOWLOAD: #{from} => #{to}")
+  end
+
+  def remove(path)
+    @node.log('mock-sftp', "REMOVE: #{path}")
+  end
+
+  def stat(path)
+    @node.log('mock-sftp', "STAT: #{path}")
+  end
+
+  def setstat(path, opts)
+    @node.log('mock-sftp', "SET: #{path} - #{opts.inspect}")
+  end
+end

data/lib/orca/extensions/apt.rb

@@ -0,0 +1,54 @@
+Orca.extension :apt do
+  module_function
+  def apt_package(pkg_name, apt_name=pkg_name, &blk)
+    package pkg_name do
+      depends_on 'apt'
+      validate { trigger 'apt:exists', apt_name  }
+      apply    do
+        trigger 'apt:update'
+        trigger 'apt:install', apt_name
+      end
+      remove   { trigger 'apt:remove', apt_name  }
+      instance_eval(&blk) if blk
+    end
+  end
+
+  package 'apt' do
+    action 'install' do |package_name|
+      sudo "DEBIAN_FRONTEND=noninteractive apt-get install -y -qq #{package_name}"
+    end
+
+    action 'remove' do |package_name|
+      sudo "DEBIAN_FRONTEND=noninteractive apt-get remove -y -qq #{package_name}"
+    end
+
+    action 'ppa' do |repo|
+      sudo "DEBIAN_FRONTEND=noninteractive add-apt-repository #{repo} -y"
+    end
+
+    action 'update' do
+      sudo "DEBIAN_FRONTEND=noninteractive apt-get update -y -qq"
+    end
+
+    action 'exists' do |package_name|
+      run("dpkg -s #{package_name} 2>&1 | grep Status") =~ /Status: install ok installed/
+    end
+
+    validate do
+      trigger('apt:exists', 'python-software-properties') &&
+      trigger('apt:exists', 'software-properties-common')
+    end
+
+    apply do
+      trigger 'apt:update'
+      trigger 'apt:install', 'python-software-properties'
+      trigger 'apt:install', 'software-properties-common'
+    end
+
+    remove do
+      trigger 'apt:remove', 'python-software-properties'
+      trigger 'apt:remove', 'software-properties-common'
+    end
+  end
+
+end