crafterm-sprinkle 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (56) hide show
  1. data/CREDITS +11 -0
  2. data/History.txt +4 -0
  3. data/MIT-LICENSE +20 -0
  4. data/Manifest.txt +55 -0
  5. data/README.txt +218 -0
  6. data/Rakefile +4 -0
  7. data/bin/sprinkle +79 -0
  8. data/config/hoe.rb +70 -0
  9. data/config/requirements.rb +17 -0
  10. data/examples/merb/deploy.rb +5 -0
  11. data/examples/rails/README +15 -0
  12. data/examples/rails/deploy.rb +2 -0
  13. data/examples/rails/packages/database.rb +9 -0
  14. data/examples/rails/packages/essential.rb +6 -0
  15. data/examples/rails/packages/rails.rb +28 -0
  16. data/examples/rails/packages/search.rb +11 -0
  17. data/examples/rails/packages/server.rb +28 -0
  18. data/examples/rails/rails.rb +71 -0
  19. data/lib/sprinkle/actors/capistrano.rb +80 -0
  20. data/lib/sprinkle/deployment.rb +33 -0
  21. data/lib/sprinkle/extensions/arbitrary_options.rb +10 -0
  22. data/lib/sprinkle/extensions/array.rb +7 -0
  23. data/lib/sprinkle/extensions/blank_slate.rb +5 -0
  24. data/lib/sprinkle/extensions/dsl_accessor.rb +15 -0
  25. data/lib/sprinkle/extensions/string.rb +10 -0
  26. data/lib/sprinkle/extensions/symbol.rb +7 -0
  27. data/lib/sprinkle/installers/apt.rb +20 -0
  28. data/lib/sprinkle/installers/gem.rb +31 -0
  29. data/lib/sprinkle/installers/installer.rb +47 -0
  30. data/lib/sprinkle/installers/rake.rb +16 -0
  31. data/lib/sprinkle/installers/source.rb +137 -0
  32. data/lib/sprinkle/package.rb +76 -0
  33. data/lib/sprinkle/policy.rb +84 -0
  34. data/lib/sprinkle/script.rb +13 -0
  35. data/lib/sprinkle/version.rb +9 -0
  36. data/lib/sprinkle.rb +29 -0
  37. data/script/destroy +14 -0
  38. data/script/generate +14 -0
  39. data/spec/spec.opts +1 -0
  40. data/spec/spec_helper.rb +17 -0
  41. data/spec/sprinkle/actors/capistrano_spec.rb +150 -0
  42. data/spec/sprinkle/deployment_spec.rb +80 -0
  43. data/spec/sprinkle/extensions/array_spec.rb +19 -0
  44. data/spec/sprinkle/extensions/string_spec.rb +21 -0
  45. data/spec/sprinkle/installers/apt_spec.rb +46 -0
  46. data/spec/sprinkle/installers/gem_spec.rb +64 -0
  47. data/spec/sprinkle/installers/installer_spec.rb +125 -0
  48. data/spec/sprinkle/installers/source_spec.rb +315 -0
  49. data/spec/sprinkle/package_spec.rb +203 -0
  50. data/spec/sprinkle/policy_spec.rb +110 -0
  51. data/spec/sprinkle/script_spec.rb +51 -0
  52. data/spec/sprinkle/sprinkle_spec.rb +25 -0
  53. data/tasks/deployment.rake +34 -0
  54. data/tasks/environment.rake +7 -0
  55. data/tasks/rspec.rake +21 -0
  56. metadata +137 -0
@@ -0,0 +1,17 @@
1
+ begin
2
+ require 'spec'
3
+ rescue LoadError
4
+ require 'rubygems'
5
+ gem 'rspec'
6
+ require 'spec'
7
+ end
8
+
9
+ $:.unshift(File.dirname(__FILE__) + '/../lib')
10
+ require 'sprinkle'
11
+
12
+ module Kernel
13
+ def logger
14
+ @@__log_file__ ||= StringIO.new
15
+ @@__log__ = ActiveSupport::BufferedLogger.new @@__log_file__
16
+ end
17
+ end
@@ -0,0 +1,150 @@
1
+ require File.dirname(__FILE__) + '/../../spec_helper'
2
+
3
+ describe Sprinkle::Actors::Capistrano do
4
+
5
+ before do
6
+ @recipes = 'deploy'
7
+ @cap = ::Capistrano::Configuration.new
8
+ ::Capistrano::Configuration.stub!(:new).and_return(@cap)
9
+ @cap.stub!(:load).and_return
10
+ end
11
+
12
+ def create_cap(&block)
13
+ Sprinkle::Actors::Capistrano.new &block
14
+ end
15
+
16
+ describe 'when created' do
17
+
18
+ it 'should create a new capistrano object' do
19
+ ::Capistrano::Configuration.should_receive(:new).and_return(@cap)
20
+ create_cap
21
+ end
22
+
23
+ describe 'when verbose' do
24
+
25
+ before do
26
+ Sprinkle::OPTIONS[:verbose] = true
27
+ end
28
+
29
+ it 'should set verbose logging on the capistrano object' do
30
+ @cap = create_cap
31
+ @cap.config.logger.level.should == ::Capistrano::Logger::INFO
32
+ end
33
+
34
+ end
35
+
36
+ describe 'when not verbose' do
37
+
38
+ before do
39
+ Sprinkle::OPTIONS[:verbose] = false
40
+ end
41
+
42
+ it 'should set quiet logging on the capistrano object' do
43
+ @cap = create_cap
44
+ @cap.config.logger.level.should == ::Capistrano::Logger::IMPORTANT
45
+ end
46
+
47
+ end
48
+
49
+ describe 'with a block' do
50
+
51
+ before do
52
+ @actor = create_cap do
53
+ recipes 'cool gear' # default is deploy
54
+ end
55
+ end
56
+
57
+ it 'should evaluate the block against the actor instance' do
58
+ @actor.loaded_recipes.should include('cool gear')
59
+ end
60
+
61
+ end
62
+
63
+ describe 'without a block' do
64
+
65
+ it 'should automatically load the default capistrano configuration' do
66
+ @cap.should_receive(:load).with('deploy').and_return
67
+ end
68
+
69
+ after do
70
+ @actor = create_cap
71
+ end
72
+
73
+ end
74
+
75
+ end
76
+
77
+ describe 'recipes' do
78
+
79
+ it 'should add the recipe location to an internal store' do
80
+ @cap = create_cap do
81
+ recipes 'deploy'
82
+ end
83
+ @cap.loaded_recipes.should == [ @recipes ]
84
+ end
85
+
86
+ it 'should load the given recipe' do
87
+ @cap.should_receive(:load).with(@recipes).and_return
88
+ create_cap
89
+ end
90
+
91
+ end
92
+
93
+ describe 'processing commands' do
94
+
95
+ before do
96
+ @commands = %w( op1 op2 )
97
+ @roles = %w( app )
98
+ @name = 'name'
99
+
100
+ @cap = create_cap do; recipes 'deploy'; end
101
+ @cap.stub!(:run).and_return
102
+ end
103
+
104
+ it 'should dynamically create a capistrano task containing the commands' do
105
+ @cap.config.should_receive(:task).and_return
106
+ end
107
+
108
+ it 'should invoke capistrano task after creation' do
109
+ @cap.should_receive(:run).with(@name).and_return
110
+ end
111
+
112
+ after do
113
+ @cap.process @name, @commands, @roles
114
+ end
115
+
116
+ end
117
+
118
+ describe 'generated task' do
119
+
120
+ before do
121
+ @commands = %w( op1 op2 )
122
+ @roles = %w( app )
123
+ @name = 'name'
124
+
125
+ @cap = create_cap do; recipes 'deploy'; end
126
+ @cap.config.stub!(:fetch).and_return(:sudo)
127
+ @cap.config.stub!(:invoke_command).and_return
128
+ end
129
+
130
+ it 'should use sudo to invoke commands when so configured' do
131
+ @cap.config.should_receive(:fetch).with(:run_method, :sudo).and_return(:sudo)
132
+ end
133
+
134
+ it 'should run the supplied commands' do
135
+ @cap.config.should_receive(:invoke_command).with('op1', :via => :sudo).ordered.and_return
136
+ @cap.config.should_receive(:invoke_command).with('op2', :via => :sudo).ordered.and_return
137
+ end
138
+
139
+ it 'should be applicable for the supplied roles' do
140
+ @cap.stub!(:run).and_return
141
+ @cap.config.should_receive(:task).with(:install_name, :roles => @roles).and_return
142
+ end
143
+
144
+ after do
145
+ @cap.process @name, @commands, @roles
146
+ end
147
+
148
+ end
149
+
150
+ end
@@ -0,0 +1,80 @@
1
+ require File.dirname(__FILE__) + '/../spec_helper'
2
+
3
+ describe Sprinkle::Deployment do
4
+ include Sprinkle::Deployment
5
+
6
+ def create_deployment(&block)
7
+ deployment do
8
+ delivery :capistrano, &block
9
+
10
+ source do
11
+ prefix '/usr/local'
12
+ end
13
+ end
14
+ end
15
+
16
+ describe 'when created' do
17
+
18
+ it 'should be invalid without a block descriptor' do
19
+ lambda { deployment }.should raise_error
20
+ end
21
+
22
+ it 'should be invalid without a delivery method' do
23
+ lambda { @deployment = deployment do; end }.should raise_error
24
+ end
25
+
26
+ it 'should optionally accept installer defaults' do
27
+ @deployment = create_deployment
28
+ @deployment.should respond_to(:source)
29
+ end
30
+
31
+ it 'should provide installer defaults as a proc when requested' do
32
+ @deployment = create_deployment
33
+ @deployment.defaults[:source].class.should == Proc
34
+ end
35
+
36
+ end
37
+
38
+ describe 'delivery specification' do
39
+
40
+ before do
41
+ @actor = mock(Sprinkle::Actors::Capistrano)
42
+ Sprinkle::Actors::Capistrano.stub!(:new).and_return(@actor)
43
+ end
44
+
45
+ it 'should automatically instantiate the delivery type' do
46
+ @deployment = create_deployment
47
+ @deployment.style.should == @actor
48
+ end
49
+
50
+ it 'should optionally accept a block to pass to the actor' do
51
+ lambda { @deployment = create_deployment }.should_not raise_error
52
+ end
53
+
54
+ describe 'with a block' do
55
+
56
+ it 'should pass the block to the actor for configuration' do
57
+ @deployment = create_deployment do; recipes 'deploy'; end
58
+ end
59
+
60
+ end
61
+ end
62
+
63
+ describe 'when processing policies' do
64
+
65
+ before do
66
+ @policy = mock(Policy, :process => true)
67
+ POLICIES = [ @policy ]
68
+ @deployment = create_deployment
69
+ end
70
+
71
+ it 'should apply all policies, passing itself as the deployment context' do
72
+ @policy.should_receive(:process).with(@deployment).and_return
73
+ end
74
+
75
+ after do
76
+ @deployment.process
77
+ end
78
+ end
79
+
80
+ end
@@ -0,0 +1,19 @@
1
+ require File.dirname(__FILE__) + '/../../spec_helper'
2
+
3
+ describe Array, 'task name conversions' do
4
+
5
+ it 'should be able to deliver a task name' do
6
+ ['build_essential'].to_task_name.should == 'build_essential'
7
+ end
8
+
9
+ it 'should join multiple elements together with a _ char' do
10
+ ['gdb', 'gcc', 'g++'].to_task_name.should == 'gdb_gcc_g++'
11
+ end
12
+
13
+ it 'should use the task name of the underlying array element' do
14
+ string = 'build-essential'
15
+ string.should_receive(:to_task_name).and_return('build_essential')
16
+ [string].to_task_name.should == 'build_essential'
17
+ end
18
+
19
+ end
@@ -0,0 +1,21 @@
1
+ require File.dirname(__FILE__) + '/../../spec_helper'
2
+
3
+ describe String, 'task name conversions' do
4
+
5
+ it 'should be able to deliver a task name' do
6
+ 'build_essential'.to_task_name.should == 'build_essential'
7
+ end
8
+
9
+ it 'should convert all - chars to _ in the task name' do
10
+ 'build-essential'.to_task_name.should == 'build_essential'
11
+ end
12
+
13
+ it 'should convert multiple - chars to _ chars in the task name' do
14
+ 'build--essential'.to_task_name.should == 'build__essential'
15
+ end
16
+
17
+ it 'should lowercase the task name' do
18
+ 'BUILD-ESSENTIAL'.to_task_name.should == 'build_essential'
19
+ end
20
+
21
+ end
@@ -0,0 +1,46 @@
1
+ require File.dirname(__FILE__) + '/../../spec_helper'
2
+
3
+ describe Sprinkle::Installers::Apt do
4
+
5
+ before do
6
+ @package = mock(Sprinkle::Package, :name => 'package')
7
+ end
8
+
9
+ def create_apt(debs, &block)
10
+ Sprinkle::Installers::Apt.new(@package, debs, &block)
11
+ end
12
+
13
+ describe 'when created' do
14
+
15
+ it 'should accept a single package to install' do
16
+ @installer = create_apt 'ruby'
17
+ @installer.packages.should == [ 'ruby' ]
18
+ end
19
+
20
+ it 'should accept an array of packages to install' do
21
+ @installer = create_apt %w( gcc gdb g++ )
22
+ @installer.packages.should == ['gcc', 'gdb', 'g++']
23
+ end
24
+
25
+ end
26
+
27
+ describe 'during installation' do
28
+
29
+ before do
30
+ @installer = create_apt 'ruby'
31
+ @install_sequence = @installer.send :install_sequence
32
+ end
33
+
34
+ it 'should invoke the apt installer for all specified packages' do
35
+ @install_sequence.should =~ /apt-get -qyu install ruby/
36
+ end
37
+
38
+ it 'should specify a non interactive mode to the apt installer' do
39
+ @install_sequence.should =~ /DEBIAN_FRONTEND=noninteractive/
40
+ end
41
+
42
+ it 'should install a specific version if defined'
43
+
44
+ end
45
+
46
+ end
@@ -0,0 +1,64 @@
1
+ require File.dirname(__FILE__) + '/../../spec_helper'
2
+
3
+ describe Sprinkle::Installers::Gem do
4
+
5
+ before do
6
+ @gem = 'rails'
7
+ @version = '2.0.2'
8
+ @options = { :source => 'http://gems.github.com/' }
9
+ end
10
+
11
+ def create_gem(gem, version = nil, options = {}, &block)
12
+ @package = mock(Sprinkle::Package, :name => gem, :version => version, :source => nil)
13
+ Sprinkle::Installers::Gem.new(@package, gem, options, &block)
14
+ end
15
+
16
+ describe 'when created' do
17
+
18
+ before do
19
+ @installer = create_gem @gem, @version, @options
20
+ end
21
+
22
+ it 'should accept a single package to install' do
23
+ @installer.gem.should == @gem
24
+ end
25
+
26
+ it 'should optionally store a version of the gem to install' do
27
+ @installer.version.should == '2.0.2'
28
+ end
29
+
30
+ it 'should optionally store a source location of the gem to install' do
31
+ @installer.source.should == 'http://gems.github.com/'
32
+ end
33
+
34
+ end
35
+
36
+ describe 'during installation' do
37
+
38
+ describe 'without a version' do
39
+
40
+ before do
41
+ @installer = create_gem @gem
42
+ end
43
+
44
+ it 'should invoke the gem installer for all specified package' do
45
+ @installer.send(:install_sequence).should == "gem install #{@gem}"
46
+ end
47
+
48
+ end
49
+
50
+ describe 'with a specific version' do
51
+
52
+ before do
53
+ @installer = create_gem @gem, @version
54
+ end
55
+
56
+ it 'should install a specific version if defined' do
57
+ @installer.send(:install_sequence).should == "gem install #{@gem} --version '#{@version}'"
58
+ end
59
+
60
+ end
61
+
62
+ end
63
+
64
+ end
@@ -0,0 +1,125 @@
1
+ require File.dirname(__FILE__) + '/../../spec_helper'
2
+
3
+ describe Sprinkle::Installers::Installer do
4
+ include Sprinkle::Deployment
5
+
6
+ before do
7
+ @package = mock(Sprinkle::Package, :name => 'package')
8
+ @empty = Proc.new { }
9
+ @sequence = ['op1', 'op2']
10
+ @delivery = mock(Sprinkle::Deployment, :process => true)
11
+ @installer = create_installer
12
+ @installer.delivery = @delivery
13
+ @roles = []
14
+ @deployment = deployment do
15
+ delivery :capistrano
16
+ installer do; prefix '/usr/bin'; end
17
+ end
18
+ end
19
+
20
+ def create_installer(&block)
21
+ installer = Sprinkle::Installers::Installer.new @package, &block
22
+ installer.stub!(:puts).and_return
23
+
24
+ # this is actually an abstract class so we'll insert a few fake install sequences
25
+ class << installer
26
+ def install_sequence
27
+ ['op1', 'op2']
28
+ end
29
+ end
30
+
31
+ installer
32
+ end
33
+
34
+ describe 'when created' do
35
+
36
+ it 'should belong to a package' do
37
+ @installer.package.should == @package
38
+ end
39
+
40
+ describe 'with a block to customize installer defaults' do
41
+
42
+ it 'should accept an optional block to customize installers defaults' do
43
+ @installer = create_installer do; prefix '/usr/local'; end
44
+ @installer.prefix.should == '/usr/local'
45
+ end
46
+
47
+ it 'should override any deployment level defaults' do
48
+ @installer = create_installer do; prefix '/usr/local'; end
49
+ @installer.defaults(@deployment)
50
+ @installer.prefix.should == '/usr/local'
51
+ end
52
+ end
53
+ end
54
+
55
+ describe 'during configuration' do
56
+
57
+ before do
58
+ @default = Proc.new { }
59
+ @defaults = { :installer => @default }
60
+ @deployment.stub!(:defaults).and_return(@defaults)
61
+ end
62
+
63
+ it 'should be configurable via external defaults' do
64
+ @installer.should respond_to(:defaults)
65
+ end
66
+
67
+ it 'should select the defaults for the particular concrete installer class' do
68
+ @deployment.should_receive(:defaults).and_return(@defaults)
69
+ @defaults.should_receive(:[]).with(:installer).and_return(@default)
70
+ end
71
+
72
+ it 'should configure the installer delivery mechansim' do
73
+ @installer.should_receive(:instance_eval)
74
+ end
75
+
76
+ it 'should maintain an options hash set arbitrarily via method missing' do
77
+ @installer.instance_eval do
78
+ hsv 'gts'
79
+ end
80
+ @installer.hsv.should == 'gts'
81
+ end
82
+
83
+ after do
84
+ @installer.defaults(@deployment)
85
+ end
86
+
87
+ end
88
+
89
+ describe Sprinkle::Installers::Installer, 'during installation' do
90
+
91
+ it 'should request the install sequence from the concrete class' do
92
+ @installer.should_receive(:install_sequence).and_return(@sequence)
93
+ end
94
+
95
+ describe 'when testing' do
96
+
97
+ before do
98
+ Sprinkle::OPTIONS[:testing] = true
99
+ @logger = mock(ActiveSupport::BufferedLogger, :debug => true, :debug? => true)
100
+ end
101
+
102
+ it 'should not invoke the delivery mechanism with the install sequence' do
103
+ @delivery.should_not_receive(:process)
104
+ end
105
+
106
+ it 'should print the install sequence to the console' do
107
+ @installer.should_receive(:logger).twice.and_return(@logger)
108
+ end
109
+
110
+ end
111
+
112
+ describe 'when in production' do
113
+ it 'should invoke the delivery mechanism to process the install sequence' do
114
+ @delivery.should_receive(:process).with(@package.name, @sequence, @roles)
115
+ end
116
+ end
117
+
118
+ after do
119
+ @installer.process(@roles)
120
+ Sprinkle::OPTIONS[:testing] = false
121
+ end
122
+
123
+ end
124
+
125
+ end