orca 0.4.0 → 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5fcffb2207cfa9357796ee92e79328b2268c1c14
+  data.tar.gz: ed2fb3ccc171ea17523d225e3ba18d19588a1d87
+SHA512:
+  metadata.gz: 1552c2835538232aaae979a6eddaa52e448958df9c1499d78016932b3ec05b6ebcd1d26528eef49c47e29de66e49fcd46fb365fc39ee787802b79062d6d7ef4d
+  data.tar.gz: b98462cfca875e9b585d989ccbf035eeb14b329e56846a6913e8f9380714b8178d4946f117be306932d83723aac31dbec426c6cc7f12433030767fa828ae5fa3

data/README.md

@@ -1,3 +1,7 @@
+>### Deprecation Notice
+>This project was an old experiment into alternative immutable sever provisioning methods. Things have since moved on and the introduction of contain based toolchains like Docker have made it's need obsolete.
+>If you still require usage of the orca gem please lock your gem version to `0.4.0` as the `orca` name will shortly be handed over to another gem maintainer.
+
 Orca
 ====
 
@@ -11,7 +15,7 @@ If you've found yourself stuck in the gap between deployment tools like Capistra
 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...
+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 broadly 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.
@@ -64,7 +68,7 @@ Command Line Usage
 
 To get started from within your projct you can run...
 
-    orca init .
+    orca init
 
 This will create a config/orca.rb file for you to get started with.
 
@@ -92,7 +96,7 @@ You can also directly trigger actions from the CLI like so...
 Options, all commands support the following optional parameters...
 
     --demonstrate       | dont actually run the commands on the server just pretend like you are
-    --sequential        | dont attempt to run commands accross multiple nodes in parrallel
+    --sequential        | dont attempt to run commands across multiple nodes in parrallel
     --throw             | throw a stack trace rather than pretty printing errors
     --file              | path to the orca.rb file to load, defaults to ./orca/orca.rb
     --verbose           | print all SSH output, useful for debugging but can be rather long

data/lib/orca/execution_context.rb

@@ -1,7 +1,7 @@
 require "open3"
 
 class Orca::ExecutionContext
-  attr_reader :node
+  attr_reader :node, :log
 
   def initialize(node, log)
     @node = node
@@ -13,6 +13,17 @@ class Orca::ExecutionContext
     instance_eval(&blk)
   end
 
+  def as(user, &blk)
+    for_user(user).apply(blk)
+  end
+
+  def for_user(user)
+    return self if user.nil? || user == node.user
+    new_node = @node.for_user(user)
+    new_log = @log.clone_for_node(new_node)
+    self.class.new(new_node, new_log)
+  end
+
   def run_local(cmd)
     @log.local(cmd)
     stdout, stderr, status = Open3.capture3(cmd)

data/lib/orca/extensions/file_sync.rb

@@ -11,51 +11,56 @@ class Orca::FileSync
     @parent = parent
     @config = config
     @after_apply = blk
-    raise ArgumentError.new('A file :source  or template must be provided') unless local_path or template_path
-    raise ArgumentError.new('A file :destination must be provided') unless remote_path
+    raise ArgumentError.new('A file :source  or template must be provided') unless @config[:source] or @config[:template]
+    raise ArgumentError.new('A file :destination must be provided') unless @config[:destination]
   end
 
-  def local_path
-    @config[:source]
+  def local_path(context)
+    value_for context, @config[:source]
   end
 
-  def template_path
-    @config[:template]
+  def template_path(context)
+    value_for context, @config[:template]
   end
 
-  def local_path_for_node(node)
-    return local_path if local_path
-    Orca::Template.new(node, template_path).render_to_tempfile
+  def local_path_for_node(context)
+    return local_path(context) if @config[:source]
+    Orca::Template.new(context.node, template_path(context)).render_to_tempfile
   end
 
-  def remote_path
-    @config[:destination]
+  def remote_path(context)
+    value_for context, @config[:destination]
   end
 
-  def permissions
-    @config[:permissions]
+  def permissions(context)
+    value_for context, @config[:permissions]
   end
 
-  def user
-    @config[:user]
+  def user(context)
+    value_for context, @config[:user]
   end
 
-  def group
-    @config[:group]
+  def group(context)
+    value_for context, @config[:group]
   end
 
-  def create_dir
-    @config[:create_dir] || @config[:create_dirs]
+  def create_dir(context)
+    value_for context, (@config[:create_dir] || @config[:create_dirs])
   end
 
   def package_name(suffix)
-    "file-#{suffix}[#{remote_path}]"
+    name = @config[:name]
+    if name.nil? && !@config[:destination].is_a?(String)
+      raise ArgumentError.new("You must provide a :name option unless :destination is a String")
+    end
+    name ||= @config[:destination]
+    "file-#{suffix}[#{name}]"
   end
 
   def configure
     fs = self
     add_content_package
-    add_permissions_package unless permissions.nil? and user.nil? and group.nil?
+    add_permissions_package unless @config[:permissions].nil? and @config[:user].nil? and @config[:group].nil?
   end
 
   def run_after_apply(context)
@@ -66,24 +71,24 @@ class Orca::FileSync
     fs = self
     add_package('content') do |package|
       package.command :apply do
-        if fs.create_dir
-          mk_dir = fs.create_dir == true ? File.dirname(fs.remote_path) : fs.create_dir
+        if fs.create_dir(self)
+          mk_dir = fs.create_dir(self) == true ? File.dirname(fs.remote_path(self)) : fs.create_dir(self)
           sudo("mkdir -p #{mk_dir}")
-          sudo("chown #{fs.user}:#{fs.group || fs.user} #{mk_dir}") if fs.user
+          sudo("chown #{fs.user(self)}:#{fs.group(self) || fs.user(self)} #{mk_dir}") if fs.user(self)
         end
-        local_file = local(fs.local_path_for_node(node))
+        local_file = local(fs.local_path_for_node(self))
         tmp_path = "orca-upload-#{local_file.hash}"
         local_file.copy_to(remote(tmp_path))
-        sudo("mv #{tmp_path} #{fs.remote_path}")
+        sudo("mv #{tmp_path} #{fs.remote_path(self)}")
         fs.run_after_apply(self)
       end
 
       package.command :remove do
-        remote(fs.remote_path).delete!
+        remote(fs.remote_path(self)).delete!
       end
 
       package.command :validate do
-        local(fs.local_path_for_node(node)).matches?(remote(fs.remote_path))
+        local(fs.local_path_for_node(self)).matches?(remote(fs.remote_path(self)))
       end
     end
   end
@@ -92,16 +97,16 @@ class Orca::FileSync
     fs = self
     add_package('permissions') do |package|
       package.command :apply do
-        remote(fs.remote_path).set_owner(fs.user, fs.group) unless fs.user.nil? and fs.group.nil?
-        remote(fs.remote_path).set_permissions(fs.permissions) unless fs.permissions.nil?
+        remote(fs.remote_path(self)).set_owner(fs.user(self), fs.group(self)) unless fs.user(self).nil? and fs.group(self).nil?
+        remote(fs.remote_path(self)).set_permissions(fs.permissions(self)) unless fs.permissions(self).nil?
         fs.run_after_apply(self)
       end
 
       package.command :validate do
-        r_file = remote(fs.remote_path)
-        valid = r_file.permissions == fs.permissions
-        valid = valid && r_file.user == fs.user if fs.user
-        valid = valid && r_file.group == fs.group if fs.group
+        r_file = remote(fs.remote_path(self))
+        valid = r_file.permissions == fs.permissions(self)
+        valid = valid && r_file.user == fs.user(self) if fs.user(self)
+        valid = valid && r_file.group == fs.group(self) if fs.group(self)
         valid
       end
     end
@@ -113,4 +118,10 @@ class Orca::FileSync
     @parent.triggers(package.name)
     package
   end
+
+  def value_for(context, option)
+    return nil if option.nil?
+    return context.instance_exec(&option) if option.respond_to?(:call)
+    option
+  end
 end

data/lib/orca/logger.rb

@@ -1,9 +1,17 @@
 class Orca::Logger
+  attr_accessor :node
+
   def initialize(node, package)
     @node = node
     set_package(package)
   end
 
+  def clone_for_node(node)
+    copy = self.dup
+    copy.node = node
+    copy
+  end
+
   def set_package(package)
     @package = package.to_s
   end

data/lib/orca/node.rb

@@ -2,7 +2,7 @@ require 'net/ssh'
 require 'net/sftp'
 
 class Orca::Node
-  attr_reader :name, :host
+  attr_reader :name, :host, :user
 
   def self.find(name)
     return name if name.is_a?(Orca::Node)
@@ -19,8 +19,10 @@ class Orca::Node
     @name = name
     @host = host
     @options = options
+    @user = @options[:user] || 'root'
     @connection = nil
     @history = []
+    @user_nodes = {}
     Orca::Node.register(self)
   end
 
@@ -85,17 +87,35 @@ class Orca::Node
     @log = log
   end
 
+  def for_user(new_user)
+    new_user = new_user.to_s
+    return self if self.user == new_user
+    return @user_nodes[new_user] if @user_nodes[new_user]
+    new_node = self.dup
+    new_node.prepare_connection_for_user!(new_user)
+    @user_nodes[new_user] = new_node
+    new_node
+  end
+
+  def prepare_connection_for_user!(new_user)
+    @user = new_user
+    @connection = nil
+    @user_nodes = {}
+    @history = []
+  end
+
   def connection
-    return @connection if @connection
-    @connection = Net::SSH.start(@host, (@options[:user] || 'root'), options_for_ssh)
+    return @connection if @connection && !@connection.closed?
+    @connection = Net::SSH.start(@host, (@user), options_for_ssh)
   end
 
   def disconnect
     @connection.close if @connection && !@connection.closed?
+    @user_nodes.values.each {|n| n.disconnect }
   end
 
   def to_s
-    "#{name}(#{host})"
+    "#{name}(#{user}@#{host})"
   end
 
   private
@@ -114,6 +134,7 @@ class Orca::Node
   end
 
   def really_execute(cmd, opts={})
+    cmd = prefixed_command(cmd)
     log.execute(cmd.cyan)
     output = ""
     connection.exec! cmd do |channel, stream, data|
@@ -136,4 +157,9 @@ class Orca::Node
     return nil unless results && results.size > 0
     results.last[:output]
   end
+
+  def prefixed_command(cmd)
+    return cmd unless @options[:prefix]
+    @options[:prefix] + cmd
+  end
 end

data/lib/orca/package.rb

@@ -1,8 +1,9 @@
 class Orca::Package
-  attr_reader :name, :dependancies, :actions, :children
+  attr_reader :name, :dependancies, :actions, :children, :user
 
   def initialize(name)
     @name = name
+    @user = nil
     @dependancies = []
     @children = []
     @actions = {}
@@ -34,6 +35,10 @@ class Orca::Package
     command(:remove, &definition)
   end
 
+  def as(user)
+    @user = user
+  end
+
   def action(name, &definition)
     @actions[name] = definition
   end

data/lib/orca/runner.rb

@@ -67,10 +67,11 @@ class Orca::Runner
   end
 
   def exec(pkg, command_name)
-    @log.set_package(pkg)
-    @log.command(command_name)
     context = @perform ? Orca::ExecutionContext.new(@node, @log) : Orca::MockExecutionContext.new(@node, @log)
     cmds = pkg.command(command_name)
+    context = context.for_user(pkg.user) if pkg.user
+    context.log.set_package(pkg)
+    context.log.command(command_name)
     cmds.map {|cmd| context.apply(cmd) }
   end
 

data/orca.gemspec

@@ -10,10 +10,20 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "orca"
   gem.require_paths = ["lib"]
-  gem.version       = '0.4.0'
+  gem.version       = '0.4.1'
   gem.add_dependency('colored')
   gem.add_dependency('net-ssh')
   gem.add_dependency('net-sftp')
   gem.add_dependency('thor')
   gem.add_dependency('tilt')
+  gem.post_install_message = %Q[
+===================================
+The `orca` gem has been deprecated!
+-----------------------------------
+This gem name is likely to be used
+for other purposes, you should lock
+your gemfile to version 0.4.0 for
+continued usage of this gem.
+===================================
+  ]
 end

metadata

@@ -1,94 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: orca
 version: !ruby/object:Gem::Version
-  version: 0.4.0
-  prerelease: 
+  version: 0.4.1
 platform: ruby
 authors:
 - Andy Kent
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-10 00:00:00.000000000 Z
+date: 2015-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colored
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: net-ssh
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: net-sftp
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Orca is a super simple way to build and configure servers
@@ -99,7 +88,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -138,33 +127,29 @@ files:
 - test/test_helper.rb
 homepage: ''
 licenses: []
-post_install_message: 
+metadata: {}
+post_install_message: "\n===================================\nThe `orca` gem has been
+  deprecated!\n-----------------------------------\nThis gem name is likely to be
+  used\nfor other purposes, you should lock\nyour gemfile to version 0.4.0 for\ncontinued
+  usage of this gem.\n===================================\n  "
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -951848962071421734
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -951848962071421734
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simplified Machine Building
 test_files:
 - test/dsl_test.rb