crafterm-sprinkle 0.1.0

data/spec/sprinkle/installers/source_spec.rb

@@ -0,0 +1,315 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Sprinkle::Installers::Source do
+  include Sprinkle::Deployment
+
+  before do
+    @source = 'ftp://ftp.ruby-lang.org/pub/ruby/1.8/ruby-1.8.6-p111.tar.gz'
+
+    @deployment = deployment do
+      delivery :capistrano
+      source do
+        prefix   '/usr'
+        archives '/usr/archives'
+        builds   '/usr/builds'
+      end
+    end
+
+    @installer = create_source @source do
+      prefix   '/usr/local'
+      archives '/usr/local/archives'
+      builds   '/usr/local/builds'
+
+      enable %w( headers ssl deflate so )
+      disable %w( cache proxy rewrite )
+
+      with %w( debug extras )
+      without %w( fancyisms )
+    end
+
+    @installer.defaults(@deployment)
+  end
+
+  def create_source(source, version = nil, &block)
+    @package = mock(Sprinkle::Package, :name => 'package', :version => version)
+    Sprinkle::Installers::Source.new(@package, source, &block)
+  end
+
+  describe 'when created' do
+
+    it 'should accept a source archive name to install' do
+      @installer.source.should == @source
+    end
+
+  end
+
+  describe 'before installation' do
+
+    before do
+      @settings = { :prefix => '/usr/local', :archives => '/usr/local/tmp', :builds => '/usr/local/stage' }
+    end
+
+    it 'should fail if no installation area has been specified' do
+      @settings.delete(:prefix)
+    end
+
+    it 'should fail if no build area has been specified' do
+      @settings.delete(:builds)
+    end
+
+    it 'should fail if no source download area has been specified' do
+      @settings.delete(:archives)
+    end
+
+    after do
+      @settings.each { |k, v| @installer.send k, v }
+      lambda { @installer.install_sequence }.should raise_error
+    end
+
+  end
+
+  describe  'customized configuration' do
+
+    it 'should support specification of "enable" options' do
+      @installer.enable.should == %w( headers ssl deflate so )
+    end
+
+    it 'should support specification of "disable" options' do
+      @installer.disable.should == %w( cache proxy rewrite )
+    end
+
+    it 'should support specification of "with" options' do
+      @installer.with.should == %w( debug extras )
+    end
+
+    it 'should support specification of "without" options' do
+      @installer.without.should == %w( fancyisms )
+    end
+
+    it 'should support customized build area' do
+      @installer.prefix.should == '/usr/local'
+    end
+
+    it 'should support customized source area' do
+      @installer.archives.should == '/usr/local/archives'
+    end
+
+    it 'should support customized install area' do
+      @installer.builds.should == '/usr/local/builds'
+    end
+
+  end
+
+  describe 'during gnu source archive style installation' do
+
+    it 'should prepare the build, installation and source archives area' do
+      @installer.should_receive(:prepare).and_return(
+        [
+         'mkdir -p /usr/local',
+         'mkdir -p /usr/local/builds',
+         'mkdir -p /usr/local/archives'
+        ]
+      )
+
+    end
+
+    it 'should download the source archive' do
+      @installer.should_receive(:download).and_return(
+        [
+         "wget -cq --directory-prefix='/usr/local/archives' #{@source}"
+        ]
+      )
+    end
+
+    it 'should extract the source archive' do
+      @installer.should_receive(:extract).and_return(
+        [
+         "bash -c 'cd /usr/local/builds && tar xzf /usr/local/archives/ruby-1.8.6-p111.tar.gz"
+        ]
+      )
+    end
+
+    it 'should configure the source' do
+      enable  = %w( headers ssl deflate so ).inject([]) { |m, value| m << "--enable-#{value}"; m }
+      disable = %w( cache proxy rewrite ).inject([]) { |m, value| m << "--disable-#{value}"; m }
+
+      with    = %w( debug extras ).inject([]) { |m, value| m << "--with-#{value}"; m }
+      without = %w( fancyisms ).inject([]) { |m, value| m << "--without-#{value}"; m }
+
+      options = "#{enable.join(' ')} #{disable.join(' ')} #{with.join(' ')} #{without.join(' ')}"
+
+      @installer.should_receive(:build).and_return(
+        [
+         "bash -c 'cd /usr/local/builds && ./configure --silent --prefix /usr/local #{options} > #{@package.name}-configure.log 2>&1'"
+        ]
+      )
+    end
+
+    it 'should build the source' do
+      @installer.should_receive(:build).and_return(
+        [
+         "bash -c 'cd /usr/local/builds && make > #{@package.name}-build.log 2>&1'"
+        ]
+      )
+    end
+
+    it 'should install the source' do
+      @installer.should_receive(:install).and_return(
+        [
+         "bash -c 'cd /usr/local/builds && make install > #{@package.name}-install.log 2>&1'"
+        ]
+      )
+    end
+
+    describe 'during a customized install' do
+
+      before do
+        @installer = create_source @source do
+          custom_install 'ruby setup.rb'
+        end
+
+        @installer.defaults(@deployment)
+      end
+
+      it 'should store the custom insatll commands' do
+        @installer.options[:custom_install].should == 'ruby setup.rb'
+      end
+
+      it 'should identify as having a custom install command' do
+        @installer.should be_custom_install
+      end
+
+      it 'should not configure the source automatically' do
+        @installer.should_receive(:configure).and_return([])
+      end
+
+      it 'should not build the source automatically' do
+        @installer.should_receive(:build).and_return([])
+      end
+
+      it 'should install the source using a custom installation command' do
+        @installer.send(:custom_install_commands).should == [ "bash -c 'cd /usr/builds/ruby-1.8.6-p111 && ruby setup.rb >> package-install.log 2>&1'" ]
+      end
+
+      it 'should be run relative to the source build area' do
+        @installer.send(:custom_install_commands).first.should =~ %r{cd /usr/builds/ruby-1.8.6-p111}
+      end
+
+    end
+
+    after do
+      @installer.send :install_sequence
+    end
+
+  end
+
+  describe 'pre stage commands' do
+
+    before do
+      @commands = {
+        :prepare   => %w( prepare1 prepare2 ),
+        :download  => %w( down1 down2 ),
+        :extract   => %w( ex1 ex2 ),
+        :configure => %w( conf1 conf2 ),
+        :build     => %w( build1 build2 ),
+        :install   => %w( install1 install2 )
+      }
+
+      @installer = create_source @source
+      @commands.each { |k, v| @installer.pre k, *v }
+      @installer.defaults(@deployment)
+    end
+
+    it 'should run all pre-prepare commands' do
+      @commands.each { |k, v| @installer.should_receive(:pre_commands).with(k).and_return(v) }
+    end
+
+    it 'should be run relative to the source build area' do
+      @commands.each { |stage, command| @installer.send(:pre_commands, stage).first.should =~ %r{cd /usr/builds/ruby-1.8.6-p111} }
+    end
+
+    after do
+      @installer.send :install_sequence
+    end
+
+  end
+
+  describe 'post stage commands' do
+
+    before do
+      @commands = {
+        :prepare   => %w( prepare1 prepare2 ),
+        :download  => %w( down1 down2 ),
+        :extract   => %w( ex1 ex2 ),
+        :configure => %w( conf1 conf2 ),
+        :build     => %w( build1 build2 ),
+        :install   => %w( install1 install2 )
+      }
+
+      @installer = create_source @source
+      @commands.each { |k, v| @installer.post k, *v }
+      @installer.defaults(@deployment)
+    end
+
+    it 'should run all post-prepare commands' do
+      @commands.each { |k, v| @installer.should_receive(:post_commands).with(k).and_return(v) }
+    end
+
+    it 'should be run relative to the source build area' do
+      @commands.each { |stage, command| @installer.send(:post_commands, stage).first.should =~ %r{cd /usr/builds/ruby-1.8.6-p111} }
+    end
+
+    after do
+      @installer.send :install_sequence
+    end
+
+  end
+
+  describe 'install sequence' do
+
+    it 'should prepare, then download, then extract, then configure, then build, then install' do
+      %w( prepare download extract configure build install ).each do |stage|
+        @installer.should_receive(stage).ordered.and_return([])
+      end
+    end
+
+    after do
+      @installer.send :install_sequence
+    end
+
+  end
+
+  describe 'source extraction' do
+
+    it 'should support tgz archives' do
+      @installer.source = 'blah.tgz'
+      @extraction = 'tar xzf'
+    end
+
+    it 'should support tar.gz archives' do
+      @installer.source = 'blah.tgz'
+      @extraction = 'tar xzf'
+    end
+
+    it 'should support tar.bz2 archives' do
+      @installer.source = 'blah.tar.bz2'
+      @extraction = 'tar xjf'
+    end
+
+    it 'should support tb2 archives' do
+      @installer.source = 'blah.tb2'
+      @extraction = 'tar xjf'
+    end
+
+    it 'should support zip archives' do
+      @installer.source = 'blah.zip'
+      @extraction = 'unzip'
+    end
+
+    after do
+      @installer.send(:extract_command).should == @extraction
+    end
+
+  end
+
+end

data/spec/sprinkle/package_spec.rb

@@ -0,0 +1,203 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Sprinkle::Package do
+  include Sprinkle::Package
+
+  before do 
+    @name = :package_name
+    @empty = Proc.new { }
+    @opts = { }
+  end
+  
+  describe Sprinkle::Package, 'when created' do
+    
+    it 'should be invalid without a block descriptor' do 
+      lambda { package @name }.should raise_error
+    end
+    
+    it 'should be invalid without a name' do
+      lambda { package nil, &@empty }.should raise_error
+      lambda { package @name, &@empty }.should_not raise_error
+    end
+    
+    it 'should optionally accept a description' do
+      pkg = package @name do
+        description 'my package description'
+      end
+      pkg.description.should == 'my package description'
+    end
+    
+    it 'should optionally accept a version' do
+      pkg = package @name do
+        version '2.0.2'
+      end
+      pkg.version.should == '2.0.2'
+    end
+    
+    it 'should optionally accept an installer' do 
+      pkg = package @name do
+        gem 'rails'
+      end
+      pkg.installer.should_not be_nil
+    end
+    
+    it 'should optionally accept dependencies' do 
+      pkg = package @name do
+        requires :webserver, :database
+      end
+      pkg.dependencies.should == [:webserver, :database]
+    end
+    
+    it 'should optionally define a virtual package implementation' do 
+      pkg = package @name, :provides => :database do; end
+      pkg.provides.should == :database
+    end
+    
+    it 'should be able to represent itself as a string' do 
+      pkg = package @name do; end
+      pkg.to_s.should == @name
+    end
+
+  end
+
+  describe Sprinkle::Package, 'helper method' do 
+    
+    it 'should added new packages to the global package hash' do 
+      pkg = package @name do; end
+      Sprinkle::Package::PACKAGES[@name].should == pkg
+    end
+    
+    it 'should add the new package to the provides list if specified' do 
+      pkg = package @name, :provides => :database do; end
+      Sprinkle::Package::PACKAGES[:database].last.should == pkg
+    end
+    
+  end
+
+  describe Sprinkle::Package, 'installer configuration' do
+    
+    it 'should optionally accept an apt installer' do 
+      pkg = package @name do
+        apt %w( deb1 deb2 )
+      end
+      pkg.should respond_to(:apt)
+      pkg.installer.class.should == Sprinkle::Installers::Apt
+    end
+    
+    it 'should optionally accept a gem installer' do 
+      pkg = package @name do
+        gem 'gem'
+      end
+      pkg.should respond_to(:gem)
+      pkg.installer.class.should == Sprinkle::Installers::Gem
+    end
+    
+    it 'should optionally accept a source installer' do 
+      pkg = package @name do
+        source 'archive'
+      end
+      pkg.should respond_to(:source)
+      pkg.installer.class.should == Sprinkle::Installers::Source
+    end
+    
+  end
+
+  describe Sprinkle::Package, 'with a source installer' do
+    
+    it 'should optionally accept a block containing customisations' do 
+      pkg = package @name do
+        source 'archive' do; end
+      end
+      pkg.should respond_to(:source)
+      pkg.installer.class.should == Sprinkle::Installers::Source
+    end
+    
+    it 'should automatically add a build essential dependency' do 
+      pkg = package @name do
+        source 'archive'
+      end
+      pkg.dependencies.should include(:build_essential)
+    end
+    
+  end
+
+  describe Sprinkle::Package, 'with an gem installer' do
+    
+    it 'should automatically add a rubygems dependency' do 
+      pkg = package @name do
+        gem 'gem'
+      end
+      pkg.dependencies.should include(:rubygems)
+    end
+    
+  end
+
+  describe Sprinkle::Package, 'when processing' do
+    
+    before do 
+      @deployment = mock(Sprinkle::Deployment)
+      @roles = [ :app, :db ]
+      @installer = mock(Sprinkle::Installers::Installer, :defaults => true, :process => true)
+      @package = package @name do; end
+    end
+    
+    describe Sprinkle::Package, 'with an installer' do 
+      
+      before do 
+        @package.installer = @installer
+      end
+
+      it 'should configure itself against the deployment context' do 
+        @installer.should_receive(:defaults).with(@deployment).and_return
+      end
+      
+      it 'should request the installer to process itself' do 
+        @installer.should_receive(:process).with(@roles).and_return
+      end
+      
+      after do 
+        @package.process(@deployment, @roles)
+      end
+    end
+    
+    describe Sprinkle::Package, 'without an installer' do 
+      
+      it 'should not request the installer to process if the package is a metapackage' do 
+        @installer.should_not_receive(:process)
+        @package.process(@deployment, @roles)
+      end
+      
+    end
+    
+  end
+
+  describe Sprinkle::Package, 'hierarchies' do
+    
+    before do 
+      @a = package :a do; requires :b; end
+      @b = package :b do; requires :c; end
+      @c = package :c do; end
+    end
+    
+    it 'should be able to return a dependency hierarchy tree' do 
+      @a.tree.flatten.should == [ @c, @b, @a ]
+      @b.tree.flatten.should == [ @c, @b ]
+      @c.tree.flatten.should == [ @c ]
+    end
+    
+    it 'should optionally accept a block to call upon item in the tree during hierarchy traversal' do 
+      @count = 0
+      @a.tree do
+        @count += 1
+      end
+      @count.should == 2
+    end
+    
+    it 'should maintain a depth count of how deep the hierarchy is' do 
+      @b.should_receive(:tree).with(2).and_return([@b])
+      @a.tree do; end
+    end
+    
+  end
+
+end

data/spec/sprinkle/policy_spec.rb

@@ -0,0 +1,110 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Sprinkle::Policy do
+  include Sprinkle::Policy
+
+  before do
+    @name = 'a policy'
+  end
+
+  describe 'when created' do
+
+    it 'should be invalid without a name' do
+      lambda { policy nil }.should raise_error
+    end
+
+    it 'should be invalid without role definitions' do
+      lambda { policy @name do; end }.should raise_error
+      lambda { policy @name, :roles => :app do; end }.should_not raise_error
+    end
+
+    it 'should optionally accept package dependencies' do
+      p = policy @name, :roles => :app do; end
+      p.should respond_to(:requires)
+      p.requires :appserver
+      p.packages.should == [ :appserver ]
+    end
+
+    it 'should optionally accept package dependencies with versions' do
+      p = policy @name, :roles => :app do; end
+      p.requires :appserver, :version => 2
+      p.packages.should == [ :appserver ]
+      pending 'requires version checking implementation'
+    end
+
+    it 'should add itself to the global policy list' do
+      sz = Sprinkle::Policy::POLICIES.size
+      p = policy @name, :roles => :app do; end
+      Sprinkle::Policy::POLICIES.size.should == sz + 1
+      Sprinkle::Policy::POLICIES.last.should == p
+    end
+
+  end
+
+  describe 'with packages' do
+    include Sprinkle::Package
+
+    before do
+      @deployment = mock(Sprinkle::Deployment)
+      Sprinkle::Package::PACKAGES.clear # reset full package list before each spec is run
+
+      @a = package :a do; requires :b; requires :c; end
+      @b = package :b, :provides => :xyz do; end
+      @c = package :c, :provides => :abc do; end
+      @d = package :d, :provides => :abc do; end
+
+      @policy = policy :test, :roles => :app do; requires :a; end
+      $terminal.stub!(:choose).and_return(:c) # stub out highline asking questions
+    end
+
+    describe 'when applying' do
+      include Sprinkle::Package
+
+      it 'should determine the packages to install via the hierarchy dependency tree of each package in the policy' do
+        @a.should_receive(:process).and_return
+        @b.should_receive(:process).and_return
+        @c.should_receive(:process).and_return
+        @d.should_not_receive(:process)
+      end
+
+      it 'should normalize (ie remove duplicates from) the installation order of all packages including dependencies' do
+        @e = package :e do; requires :b; end
+        @policy.requires :e
+
+        @a.should_receive(:process).once.and_return
+        @b.should_receive(:process).once.and_return
+        @c.should_receive(:process).once.and_return
+        @d.should_not_receive(:process)
+        @e.should_receive(:process).once.and_return
+      end
+    end
+
+    describe 'containing package dependencies with versions' do
+
+      it 'should be invalid if the specified package does not exist'
+      it 'should ignore any packages of the same name that have other versions'
+      it 'should select the correct package version when applying'
+
+    end
+
+    describe 'containing virtual packages' do
+
+      it 'should automatically select a concrete package implementation for a virtual one when there exists only one possible selection' do
+        @policy = policy :virtual, :roles => :app do; requires :xyz; end
+        Sprinkle::Package::PACKAGES[:xyz].should == [ @b ]
+      end
+
+      it 'should ask the user for the concrete package implementation to use for a virtual one when more than one possible choice exists' do
+        @policy = policy :virtual, :roles => :app do; requires :abc; end
+        Sprinkle::Package::PACKAGES[:abc].should include(@c)
+        Sprinkle::Package::PACKAGES[:abc].should include(@d)
+        $terminal.should_receive(:choose).and_return(:c)
+      end
+
+    end
+
+    after do
+      @policy.process(@deployment)
+    end
+  end
+end

data/spec/sprinkle/script_spec.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Sprinkle::Script, 'class' do
+  
+  it 'should define a entry point into the system' do
+    Sprinkle::Script.should respond_to(:sprinkle)
+  end
+  
+end
+
+describe Sprinkle::Script, 'when given a script' do
+  
+  before do
+    @script = 'script'
+    @filename = 'filename'
+    
+    @sprinkle = Sprinkle::Script.new
+    Sprinkle::Script.stub!(:new).and_return(@sprinkle)
+  end
+
+  it 'should create a new sprinkle instance' do
+    Sprinkle::Script.should_receive(:new).and_return(@sprinkle)
+    Sprinkle::Script.sprinkle @script
+  end
+  
+  it 'should evaulate the sprinkle script against the instance' do
+    @sprinkle.should_receive(:instance_eval).and_return
+    Sprinkle::Script.sprinkle @script
+  end
+  
+  it 'should specify the filename if given for line number errors' do 
+    @sprinkle.should_receive(:instance_eval).with(@script, @filename).and_return
+    Sprinkle::Script.sprinkle @script, @filename
+  end
+  
+  it 'should specify a filename of __SCRIPT__ by default if none is provided' do 
+    @sprinkle.should_receive(:instance_eval).with(@script, '__SCRIPT__').and_return
+    Sprinkle::Script.sprinkle @script
+  end
+  
+  it 'should automatically run in production mode by default' do
+    @sprinkle.should_receive(:instance_eval).with(@script, '__SCRIPT__').and_return
+    Sprinkle::Script.sprinkle @script
+  end
+  
+  it 'should ask the Sprinkle instance to process the data from the script' do
+    @sprinkle.should_receive(:sprinkle)
+    Sprinkle::Script.sprinkle @script
+  end
+  
+end

data/spec/sprinkle/sprinkle_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Sprinkle do
+
+  it 'should automatically extend Object to support package, policy and deployment DSL keywords' do
+    %w( package policy deployment ).each do |keyword|
+      Object.should respond_to(keyword.to_sym)
+    end
+  end
+
+  it 'should default to production mode' do
+    Sprinkle::OPTIONS[:testing].should be_false
+  end
+
+  it 'should automatically create a logger object on Kernel' do
+    Object.should respond_to(:logger)
+    logger.should_not be_nil
+    logger.class.should == ActiveSupport::BufferedLogger
+  end
+
+  it 'should create a logger of level INFO' do
+    logger.level.should == ActiveSupport::BufferedLogger::Severity::INFO
+  end
+
+end