cluster_management 0.5.1 → 0.5.2

data/Rakefile

@@ -2,7 +2,7 @@ require 'rake_ext'
 
 project(
   name: "cluster_management",
-  version: "0.5.1",
+  version: "0.5.2",
   summary: "Simple cluster management tools",
 
   author: "Alexey Petrushin",

data/lib/cluster_management/config.rb

@@ -0,0 +1,21 @@
+module ClusterManagement
+  class Config < SafeHash
+    def merge_config! file_path      
+      raise("config file must have .yml extension (#{file_path})!") unless file_path.end_with? '.yml'
+      data = ::YAML.load_file file_path
+      if data
+        data.must_be.a ::Hash
+        self.deep_merge! data            
+      end
+    end
+  end
+
+  def self.load_config file    
+    @config = Config.new
+    @config.merge_config! file
+  end
+
+  def self.config    
+    @config || raise("config nod defined (use ClusterManagement.load_config to use config)!")
+  end
+end

data/lib/cluster_management/gems.rb

@@ -0,0 +1,6 @@
+gem 'tilt'
+
+if respond_to? :fake_gem
+  fake_gem 'ruby_ext'
+  fake_gem 'vos'
+end

data/lib/cluster_management/integration/vfs.rb

@@ -0,0 +1,8 @@
+module Vfs
+  class File
+    def render *args
+      args.unshift Object.new if args.size == 1 and args.first.is_a?(Hash)
+      Tilt::ERBTemplate.new(path).render *args
+    end
+  end
+end

data/lib/cluster_management/integration/vos.rb

@@ -1,4 +1,38 @@
-ClusterManagement.integration = {
-  has_mark?: -> box, mark {box.has_mark? mark},
-  mark: -> box, mark {box.mark mark}
-}
+module Vos
+  class ServicesHelper < BasicObject
+    def initialize box, class_namespace
+      @box, @class_namespace = box, class_namespace
+    end
+    
+    class ServiceCallback < BasicObject
+      def initialize box, class_namespace, class_name
+        @box, @class_namespace, @class_name = box, class_namespace, class_name
+      end
+      
+      protected
+        def method_missing m, *a, &b
+          klass = "::#{@class_namespace.to_s.camelize}::#{@class_name.to_s.camelize}".constantize
+          klass.new(@box).send m, *a, &b
+        end
+    end
+    
+    protected
+      def method_missing class_name
+        ServiceCallback.new(@box, @class_namespace, class_name)
+      end
+  end
+  
+  class Box
+    def self.define_service_namespace class_namespace
+      define_method class_namespace do
+        ServicesHelper.new self, class_namespace
+      end
+    end
+    define_service_namespace :services
+    define_service_namespace :projects
+    
+    def already_required_services
+      @already_required_services ||= Set.new
+    end
+  end
+end

data/lib/cluster_management/logger.rb

@@ -0,0 +1,26 @@
+require 'logger'
+
+module ClusterManagement
+  class CustomLogger < Logger
+    def info msg
+      super "#{msg}\n"
+    end
+    
+    def warn msg
+      super "#{msg}\n"
+    end
+    
+    def error msg
+      super "#{msg}\n"
+    end
+  end
+  
+  attr_writer :logger
+  def self.logger
+    unless @logger
+      @logger = CustomLogger.new STDOUT
+      @logger.formatter = -> severity, datetime, progname, msg {msg}
+    end
+    @logger      
+  end
+end

data/lib/cluster_management/service.rb

@@ -0,0 +1,67 @@
+module ClusterManagement
+  class Service
+    attr_reader :box
+    
+    # 
+    # Helpers
+    # 
+    def logger; ClusterManagement.logger end    
+    def config; ClusterManagement.config end
+    
+    
+    # 
+    # Business Logic
+    # 
+    def initialize box
+      @box = box
+    end
+  
+    def mark! extra_mark = nil
+      box.mark! self.class.marker(extra_mark)
+    end
+  
+    def has_mark? extra_mark = nil
+      box.has_mark? self.class.marker(extra_mark)
+    end
+  
+    def apply_once extra_mark = nil, &block
+      unless has_mark? extra_mark
+        block.call
+        mark! extra_mark
+      end
+    end
+  
+    def require *args
+      if args.size == 1 and args.first.is_a?(Hash)
+        services = args.first
+      elsif args.size == 2 and args.first.is_a?(Array)
+        services = {}
+        args.first.each{|klass| services[klass] = args.last}
+      else
+        raise 'invalid arguments'
+      end
+      
+      services.each do |klass, method|
+        key = "#{klass}.#{method}"
+        unless box.already_required_services.include? key
+          klass.new(box).send method if klass.method_defined? method
+          box.already_required_services << key
+        end
+      end
+    end
+  
+    class << self
+      def version version = nil
+        if version
+          @version = version
+        else
+          @version ||= 1
+        end
+      end
+
+      def marker extra_mark = nil
+        %(#{name}:#{version}#{":#{extra_mark}" if extra_mark})
+      end
+    end
+  end
+end

data/lib/cluster_management.rb

@@ -1,7 +1,12 @@
-%w(
-  support
-  package
-  cluster_management  
-).each{|f| require "cluster_management/#{f}"}
+require 'ruby_ext'
+require 'vos'
+require 'yaml'
+require 'tilt'
 
-require 'cluster_management/integration/vos' unless $cluster_management_dont_include_integration
+%w(
+  config
+  logger
+  service
+  integration/vfs
+  integration/vos
+).each{|f| require "cluster_management/#{f}"}

data/readme.md

@@ -1,31 +1,70 @@
 # Simple cluster management tools
 
 It may be **usefull if Your claster has about 1-10 boxes**, and tools like Chef, Puppet, Capistrano are too complex and proprietary for your needs.
-**It's extremely easy**, there are only 3 methods.
+**It's extremely easy**, there are only 3 methods. 
 
-## Package management
+You probably already familiar with Rake and have it in Your project, and because ClusterManagement is just a small Rake 
+addon it should be easy to add and get started with it.
+
+It's ssh-agnostic and has no extra dependencies. You can use whatever ssh-tool you like (even pure Net::SSH / Net::SFTP), 
+samples below are done by using [Virtual Operating System][vos] and [Virtual File System][vfs] tools.
+
+## BoxTask Management
 
 Define your packages, they are just rake tasks, so you probably know how to work with them:
 
+    desc 'ruby 1.9.2'
+    package ruby: :system_tools do        
+      apply_once do
+        installation_dir = '/usr/local/ruby'
+        ruby_name = "ruby-1.9.2-p136"
+
+        box.tmp do |tmp|
+          tmp.bash "wget ftp://ftp.ruby-lang.org//pub/ruby/1.9/#{ruby_name}.tar.gz"
+          tmp.bash "tar -xvzf #{ruby_name}.tar.gz"
+
+          src_dir = tmp[ruby_name]
+          src_dir.bash "./configure --prefix=#{installation_dir}"
+          src_dir.bash 'make && make install'
+        end
+
+        box.home('.gemrc').write! "gem: --no-ri --no-rdoc\n"
+
+        bindir = "#{installation_dir}/bin"
+        unless box.env_file.content =~ /PATH.*#{bindir}/
+          box.env_file.append %(\nexport PATH="$PATH:#{bindir}"\n)
+          box.reload_env
+        end
+      end    
+      verify{box.bash('ruby -v') =~ /ruby 1.9.2/}
+    end
+      
+Or you can use a little more explicit notation with custom :applied? logic (:apply_once is a shortcut for :applied? & :after_applying):
+
     package :ruby do
       applied?{box.has_mark? :ruby}
       apply do
-        box.bash 'apt-get install ruby'          
+        ...
       end
       after_applying{box.mark :ruby}
     end
-      
-or you can use a little shorter notation (it's equivalent to the previous):
-
+    
+Let's define another package:
+    
     package rails: :ruby, version: 3 do
       apply_once do
         box.bash 'gem install rails'
       end
     end
     
-And it's understands dependencies, so the :rails package will apply :ruby before applying itself. 
-It also support iterative development, so you don't need to write all the config at once, do it by small steps, adding one package after another. 
-And you can use versioning to update already installed packages - if you change version of some package it will be reapplied next run.
+It's understands dependencies, so the :rails package will apply :ruby before applying itself. 
+
+It checks if the package already has been applied to box, so you can evolve your configuration and apply it multiple times, 
+it will apply only missing packages (or drop the applied? clause and it will be applied every run). It allows you
+to use **iterative development**, you don't need to write all the config at once, do it by small steps, adding one package after another. 
+
+You can also use versioning to update already installed packages - if You change version it will be reapplied next run.
+And by the way, the box.mark ... is just an example check, you can use anything there.
     
 And, last step - define (I intentionally leave implementation of this method to You, it's very specific to Your environment) 
 to what machines it should be applied:
@@ -47,7 +86,7 @@ Now, you can press the enter:
 
     $ rake os:rails host=myapp.com
     
-and packager will do all the job of installing and configuring your cluster boxes, and prints you something like that 
+and box_task will do all the job of installing and configuring your cluster boxes, and prints you something like that 
 (it's a sample output of some of my own box, you can see config details here [my_cluster][my_cluster]):
     
     $ rake app_server host=universal.xxx.com
@@ -80,7 +119,7 @@ You can also use standard Rake -T command to see docs (it's also from my config,
     rake db                       # db
     rake db:mongodb               # MongoDB
 
-## Runtime services
+## Service Management
 
 [add details here]
     
@@ -89,10 +128,7 @@ You can also use standard Rake -T command to see docs (it's also from my config,
 [add more details here]
     
 **You can use it also for deployment**, exactly the same way, configure it the way you like, it's just rake 
-tasks. And by the way, the *box.mark ...* is just an example check, you can use anything there.
-
-It checks if the package already has been applied to box, so you can evolve your configuration and apply 
-it multiple times, it will apply only missing packages (or drop the *applied?* clause and it will be applied every run).
+tasks.
 
 # Temporarry stuff, don't bother to read it
 
@@ -100,4 +136,6 @@ it multiple times, it will apply only missing packages (or drop the *applied?* c
 - uses well known tools (rake and anytingh ssh-enabled)
 - support iterative development
 
-[my_cluster]: https://github.com/alexeypetrushin/my_cluster/tree/master/lib/packages
+[my_cluster]: http://github.com/alexeypetrushin/my_cluster/tree/master/lib/packages
+[vos]: http://github.com/alexeypetrushin/vos
+[vfs]: http://github.com/alexeypetrushin/vfs

metadata

@@ -1,12 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: cluster_management
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 5
-  - 1
-  version: 0.5.1
+  prerelease: 
+  version: 0.5.2
 platform: ruby
 authors: 
 - Alexey Petrushin
@@ -14,10 +10,42 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-09 00:00:00 +03:00
+date: 2011-02-16 00:00:00 +03:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: tilt
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ruby_ext
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: vos
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
 description: 
 email: 
 executables: []
@@ -29,13 +57,13 @@ extra_rdoc_files: []
 files: 
 - Rakefile
 - readme.md
-- lib/cluster_management/cluster_management.rb
+- lib/cluster_management/config.rb
+- lib/cluster_management/gems.rb
+- lib/cluster_management/integration/vfs.rb
 - lib/cluster_management/integration/vos.rb
-- lib/cluster_management/package.rb
-- lib/cluster_management/support.rb
+- lib/cluster_management/logger.rb
+- lib/cluster_management/service.rb
 - lib/cluster_management.rb
-- spec/package_spec.rb
-- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/alexeypetrushin/cluster_management
 licenses: []
@@ -50,21 +78,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.5.1
 signing_key: 
 specification_version: 3
 summary: Simple cluster management tools

data/lib/cluster_management/cluster_management.rb

@@ -1,39 +0,0 @@
-module ClusterManagement
-  class << self
-    # 
-    # use :integration attribute to provide integration with your tool (use integration/rsh as a sample).
-    # 
-    attr_writer :integration
-    def integration
-      unless @integration
-        not_supported = -> *args {raise "you must provide your own implementation!"}
-        @integration = {
-          has_mark?: not_supported,
-          mark: not_supported
-        }
-      end
-      @integration
-    end
-    
-    
-    #
-    # you must override this method to provide your own implementation
-    #
-    attr_writer :boxes
-    def boxes
-      unless @boxes
-        warn('you must override :boxes method to provide your own behaviour')
-        return []
-      end
-      @boxes
-    end
-    
-    
-    # 
-    # Rake integration
-    # 
-    def rake_task *args, &block
-      task *args, &block
-    end        
-  end  
-end

data/lib/cluster_management/package.rb

@@ -1,75 +0,0 @@
-module ClusterManagement
-  class Package < Hash
-    class Dsl
-      attr_reader :package, :box
-
-      def initialize package, box
-        @package, @box = package, box
-      end
-
-      def version; package.version end    
-        
-      def applied? &b; package.applied = b end
-      def apply &b; package.apply = b end    
-      def verify &b; package.verify = b end
-      def after_applying &b; package.after_applying = b end    
-      
-      def apply_once &b      
-        mark = package.version ? "#{package.name}:#{package.version}" : package.name.to_s
-        applied?{ClusterManagement.integration[:has_mark?].call box, mark}
-        apply &b
-        after_applying{ClusterManagement.integration[:mark].call box, mark}
-      end
-    end
-    
-    attr_accessor :applied, :apply, :verify, :after_applying, :name, :version
-    
-    def initialize name, version
-      @name, @version = name, version
-    end
-    
-    def configure box, &b
-      dsl = Dsl.new self, box
-      dsl.instance_eval &b
-
-      if applied
-        package_applied = applied.call box
-        # ensure_boolean! package_applied, :applied?
-      else
-        package_applied = false
-      end
-      
-      if apply and !package_applied
-        ClusterManagement.logger.info %(applying '#{name}#{version ? ":#{version}" : ''}' to '#{box}'\n)
-        apply.call box
-      end
-      
-      if verify
-        verified = verify.call box
-        # ensure_boolean! verified, 'verify'
-        raise "invalid '#{name}' package for '#{box}'!" unless verified
-      end
-      after_applying && after_applying.call(box)
-      # print "done\n" if apply and !package_applied
-    end
-    
-    protected
-      def ensure_boolean! value, method
-        unless value.eql?(true) or value.eql?(false)
-          raise "invalid return value in '#{name}.#{method}' (only true/false allowed)!"
-        end
-      end
-  end  
-end
-
-def package name_or_options, version = nil, &block
-  version ||= name_or_options.delete :version if name_or_options.is_a? Hash
-  ClusterManagement.rake_task name_or_options do |task, *args|
-    if block
-      ClusterManagement.boxes.each do |box|
-        package = ClusterManagement::Package.new task.name, version
-        package.configure box, &block
-      end
-    end
-  end  
-end

data/lib/cluster_management/support.rb

@@ -1,17 +0,0 @@
-require 'logger'
-
-module ClusterManagement
-  class << self
-    # 
-    # Logger
-    # 
-    attr_writer :logger
-    def logger
-      unless @logger
-        @logger = Logger.new STDOUT
-        @logger.formatter = -> severity, datetime, progname, msg {msg}
-      end
-      @logger      
-    end
-  end  
-end

data/spec/package_spec.rb

@@ -1,136 +0,0 @@
-require 'spec_helper'
-require 'cluster_management/package'
-
-describe 'Package' do
-  before :each do
-    ClusterManagement.box = :box
-  end
-  
-  it 'should allow empty declaration' do
-    package :tools
-    ClusterManagement.last_task.should_not be_nil
-    
-    ClusterManagement.last_task = nil
-    package(:tools){}
-    ClusterManagement.last_task.should_not be_nil
-  end
-  
-  it "basic" do
-    check = mock()
-    check.should_receive(:applied?).ordered.and_return(false)
-    check.should_receive(:apply).ordered
-    check.should_receive(:verify).ordered.and_return(true)
-    check.should_receive(:after_applying).ordered
-    
-    the_package, the_box = nil, nil
-    package :tools, 1 do
-      package.is_a?(ClusterManagement::Package).should == true
-      version.should == 1
-      box.should == :box
-      
-      
-      applied?{check.applied?(box)}
-      apply{check.apply(box)}
-      verify{check.verify(box)}
-      after_applying{check.after_applying(box)}
-    end
-  end
-  
-  it "should not reapply package but always verify it" do
-    check = mock()
-    check.should_not_receive(:apply)
-    check.should_receive(:verify).and_return(true)
-    
-    package :tools do
-      applied?{true}
-      apply{check.apply}
-      verify{check.verify}
-    end
-  end
-  
-  it "should verify packages" do
-    -> {
-      package :tools do
-        verify{false}
-      end
-    }.should raise_error(/invalid.*tools/)
-  end
-  
-  it "should apply to all boxes" do
-    boxes = [:a, :b]
-    ClusterManagement.stub(:boxes).and_return(boxes)
-    
-    check = []
-    package :tools do
-      apply{check << box}
-    end
-    check.should == boxes
-  end
-  
-  it 'should support version attribute' do
-    package :tools, 2 do
-      version.should == 2
-    end
-    
-    package tools: :os, version: 2 do
-      version.should == 2
-    end
-  end
-  
-  describe "apply_once" do
-    def build_box_for key, has_mark
-      box = mock()    
-      box.should_receive(:has_mark?).ordered.with(key).and_return(has_mark)
-      box.should_receive(:mark).ordered.with(key)
-      ClusterManagement.box = box
-      box
-    end
-    
-    it "should apply if not applied" do    
-      box = build_box_for('tools', false)
-    
-      check = mock()
-      check.should_receive(:apply_once).with(box)
-    
-      package :tools do
-        apply_once{check.apply_once(box)}
-      end
-    end
-    
-    it "should not apply if applied" do    
-      box = build_box_for('tools', true)
-    
-      check = mock()
-      check.should_not_receive(:apply_once)
-    
-      package :tools do
-        apply_once{check.apply_once}
-      end
-    end
-    
-    it "should support versioning" do
-      box = build_box_for('tools:2', false)
-    
-      check = mock()
-      check.should_receive(:apply_once)
-    
-      package :tools, 2 do
-        apply_once{check.apply_once}
-      end
-    end
-  end
-end
-
-
-# def version version; package.version = version end    
-# def applied? &b; package.applied = b end
-# def apply &b; package.apply = b end    
-# def verify &b; package.verify = b end
-# def after_applying &b; package.after_applying = b end    
-# 
-# def apply_once &b      
-#   mark = package.version ? "#{package.name}:#{package.version}" : package.name
-#   applied?{INTEGRATION[:has_mark?].call box, mark}
-#   apply &b
-#   after_applying{INTEGRATION[:mark].call box, mark}
-# end

data/spec/spec_helper.rb

@@ -1,67 +0,0 @@
-require 'rspec_ext'
-
-require 'cluster_management/support'
-require 'cluster_management/cluster_management'
-
-
-# 
-# Boxes stub
-# 
-module ClusterManagement
-  class << self
-    attr_accessor :box
-    
-    def boxes
-      [box]
-    end
-  end
-end
-
-
-# 
-# Integration stub
-# 
-ClusterManagement.integration = {
-  has_mark?: -> box, mark {box.has_mark? mark},
-  mark: -> box, mark {box.mark mark}
-}
-
-
-# 
-# Task stub
-# 
-module ClusterManagement  
-  class Task
-    attr_accessor :name
-    def initialize name
-      @name = name
-    end
-  end
-  
-  class << self
-    attr_accessor :last_task
-  
-    def rake_task name_or_options, &block
-      name = if name_or_options.is_a? Hash
-        name_or_options.first.first
-      else
-        name_or_options
-      end
-      task = Task.new name      
-      block.call task if block
-      self.last_task = task
-    end
-  end
-end
-
-
-# 
-# Logger stub
-# 
-module ClusterManagement
-  class << self
-    def logger
-      @logger ||= Logger.new nil
-    end
-  end
-end