auser-sprinkle 0.1.5

data/spec/sprinkle/policy_spec.rb

@@ -0,0 +1,126 @@
+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
+
+describe Sprinkle::Policy, 'with missing packages' do
+
+  before do
+    @deployment = mock(Sprinkle::Deployment)
+    Sprinkle::Package::PACKAGES.clear # reset full package list before each spec is run
+
+    @policy = policy :test, :roles => :app do; requires :z; end
+    $terminal.stub!(:choose).and_return(:c) # stub out highline asking questions
+  end
+
+  it 'should raise an error if a package is missing' do
+    lambda { @policy.process(@deployment) }.should raise_error
+  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

data/spec/sprinkle/verify_spec.rb

@@ -0,0 +1,137 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Sprinkle::Verify do
+  before do
+    @name = :package
+    @package = package @name do
+      gem 'nonexistent'
+      verify 'moo' do
+        # Check a file exists
+        has_file 'my_file.txt'
+        
+        # Check a directory exists
+        has_directory 'mydir'
+        
+        # Check a symlink exists
+        has_symlink 'mypointer'
+        
+        # Check a symlink points to a certain file
+        has_symlink 'mypointer', 'myfile'
+        
+        # Check if an executable exists
+        has_executable '/usr/bin/ruby'
+        
+        # Check if a global executable exists (in PATH)
+        has_executable 'rails'
+      end
+    end
+    @verification = @package.verifications[0]
+    @delivery = mock(Sprinkle::Deployment, :process => true)
+    @verification.delivery = @delivery
+  end
+  
+  describe 'when created' do
+    it 'should raise error without a block' do
+      lambda { Verify.new(nil, '') }.should raise_error
+    end
+  end
+  
+  describe 'with checks' do
+    it 'should do a "test -f" on the has_file check' do
+      @verification.commands.should include('test -f my_file.txt')
+    end
+    
+    it 'should do a "test -d" on the has_directory check' do
+      @verification.commands.should include('test -d mydir')
+    end
+    
+    it 'should do a "test -L" to check something is a symbolic link' do
+      @verification.commands.should include('test -L mypointer')
+    end
+    
+    it 'should do a test equality to check a symlink points to a specific file' do
+      @verification.commands.should include("test 'myfile' = `readlink mypointer`")
+    end
+    
+    it 'should do a "test -x" to check for an executable' do
+      @verification.commands.should include("test -x /usr/bin/ruby")
+    end
+    
+    it 'should test the "which" command to look for a global executable' do
+      @verification.commands.should include('[ -n "`which rails`"]')
+    end
+  end
+  
+  describe 'with configurations' do
+    # Make sure it includes Sprinkle::Configurable
+    it 'should respond to configurable methods' do
+      @verification.should respond_to(:defaults)
+    end
+    
+    it 'should default padding option to 4' do
+      @verification.padding.should eql(4)
+    end
+  end
+  
+  describe 'with process' do
+    it 'should raise an error when no delivery mechanism is set' do
+      @verification.instance_variable_set(:@delivery, nil)
+      lambda { @verification.process([]) }.should raise_error
+    end
+    
+    describe 'when not testing' do
+      before do
+        # To be explicit
+        Sprinkle::OPTIONS[:testing] = false
+      end
+      
+      it 'should call process on the delivery with the correct parameters' do
+        @delivery.should_receive(:process).with(@name, @verification.commands, [:app], true).once.and_return(true)
+        @verification.process([:app])
+      end
+      
+      it 'should raise Sprinkle::VerificationFailed exception when commands fail' do
+        @delivery.should_receive(:process).once.and_return(false)
+        lambda { @verification.process([:app]) }.should raise_error(Sprinkle::VerificationFailed) do |error|
+          error.package.should eql(@package)
+          error.description.should eql('moo')
+        end
+      end
+    end
+    
+    describe 'when testing' do
+      before do
+        Sprinkle::OPTIONS[:testing] = true
+        @logger = mock(ActiveSupport::BufferedLogger, :debug => true, :debug? => true)
+      end
+      
+      it 'should not call process on the delivery' do
+        @delivery.should_not_receive(:process)
+      end
+
+      it 'should print the install sequence to the console' do
+        @verification.should_receive(:logger).twice.and_return(@logger)
+      end
+      
+      after do
+        @verification.process([:app])
+        Sprinkle::OPTIONS[:testing] = false
+      end
+    end
+  end
+  
+  describe 'with registering new verification modules' do
+    module MyModule
+      def rawr; end
+    end
+    
+    it 'should not respond to rawr initially' do
+      @verification.should_not respond_to(:rawr)
+    end
+    
+    it 'should respond to rawr after registering the module' do
+      Sprinkle::Verify.register(MyModule)
+      @verification.should respond_to(:rawr)
+    end
+  end
+end

data/sprinkle.gemspec

@@ -0,0 +1,43 @@
+Gem::Specification.new do |s|
+  s.name = %q{sprinkle}
+  s.version = "0.1.5"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Marcus Crafter"]
+  s.date = %q{2008-07-16}
+  s.default_executable = %q{sprinkle}
+  s.description = %q{Ruby DSL based software provisioning tool}
+  s.email = ["crafterm@redartisan.com"]
+  s.executables = ["sprinkle"]
+  s.extra_rdoc_files = ["History.txt", "Manifest.txt"]
+  s.files = ["CREDITS", "History.txt", "MIT-LICENSE", "Manifest.txt", "README.rdoc", "Rakefile", "bin/sprinkle", "config/hoe.rb", "config/requirements.rb", "examples/merb/deploy.rb", "examples/rails/README", "examples/rails/deploy.rb", "examples/rails/packages/database.rb", "examples/rails/packages/essential.rb", "examples/rails/packages/rails.rb", "examples/rails/packages/search.rb", "examples/rails/packages/server.rb", "examples/rails/rails.rb", "examples/sprinkle/sprinkle.rb", "lib/sprinkle.rb", "lib/sprinkle/actors/capistrano.rb", "lib/sprinkle/actors/vlad.rb", "lib/sprinkle/configurable.rb", "lib/sprinkle/deployment.rb", "lib/sprinkle/extensions/arbitrary_options.rb", "lib/sprinkle/extensions/array.rb", "lib/sprinkle/extensions/blank_slate.rb", "lib/sprinkle/extensions/dsl_accessor.rb", "lib/sprinkle/extensions/string.rb", "lib/sprinkle/extensions/symbol.rb", "lib/sprinkle/installers/apt.rb", "lib/sprinkle/installers/gem.rb", "lib/sprinkle/installers/installer.rb", "lib/sprinkle/installers/rake.rb", "lib/sprinkle/installers/rpm.rb", "lib/sprinkle/installers/source.rb", "lib/sprinkle/package.rb", "lib/sprinkle/policy.rb", "lib/sprinkle/script.rb", "lib/sprinkle/verifiers/directory.rb", "lib/sprinkle/verifiers/executable.rb", "lib/sprinkle/verifiers/file.rb", "lib/sprinkle/verifiers/symlink.rb", "lib/sprinkle/verify.rb", "lib/sprinkle/version.rb", "script/destroy", "script/generate", "spec/spec.opts", "spec/spec_helper.rb", "spec/sprinkle/actors/capistrano_spec.rb", "spec/sprinkle/configurable_spec.rb", "spec/sprinkle/deployment_spec.rb", "spec/sprinkle/extensions/array_spec.rb", "spec/sprinkle/extensions/string_spec.rb", "spec/sprinkle/installers/apt_spec.rb", "spec/sprinkle/installers/gem_spec.rb", "spec/sprinkle/installers/installer_spec.rb", "spec/sprinkle/installers/rpm_spec.rb", "spec/sprinkle/installers/source_spec.rb", "spec/sprinkle/package_spec.rb", "spec/sprinkle/policy_spec.rb", "spec/sprinkle/script_spec.rb", "spec/sprinkle/sprinkle_spec.rb", "spec/sprinkle/verify_spec.rb", "sprinkle.gemspec", "tasks/deployment.rake", "tasks/environment.rake", "tasks/rspec.rake"]
+  s.has_rdoc = true
+  s.homepage = %q{http://sprinkle.rubyforge.org}
+  s.rdoc_options = ["--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{sprinkle}
+  s.rubygems_version = %q{1.2.0}
+  s.summary = %q{Ruby DSL based software provisioning tool}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if current_version >= 3 then
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.0.2"])
+      s.add_runtime_dependency(%q<highline>, [">= 1.4.0"])
+      s.add_runtime_dependency(%q<capistrano>, [">= 2.2.0"])
+      s.add_development_dependency(%q<hoe>, [">= 1.7.0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 2.0.2"])
+      s.add_dependency(%q<highline>, [">= 1.4.0"])
+      s.add_dependency(%q<capistrano>, [">= 2.2.0"])
+      s.add_dependency(%q<hoe>, [">= 1.7.0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 2.0.2"])
+    s.add_dependency(%q<highline>, [">= 1.4.0"])
+    s.add_dependency(%q<capistrano>, [">= 2.2.0"])
+    s.add_dependency(%q<hoe>, [">= 1.7.0"])
+  end
+end

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end