recap 0.1.0 → 0.2.0

data/spec/tasks/deploy_spec.rb

@@ -0,0 +1,209 @@
+require 'spec_helper'
+
+describe Recap::Deploy do
+  let :config do
+    Capistrano::Configuration.new
+  end
+
+  let :namespace do
+    config.deploy
+  end
+
+  before do
+    Recap::Deploy.load_into(config)
+  end
+
+  it 'configures capistrano to use ssh key forwarding' do
+    config.ssh_options[:forward_agent].should be_true
+  end
+
+  it 'configures capistrano to use a pty session when running commands' do
+    config.default_run_options[:pty].should be_true
+  end
+
+  describe 'Settings' do
+    describe '#application' do
+      it 'exits if accessed before being set' do
+        lambda do
+          config.application
+        end.should raise_error(SystemExit)
+      end
+    end
+
+    describe '#repository' do
+      it 'exits if accessed before being set' do
+        lambda do
+          config.repository
+        end.should raise_error(SystemExit)
+      end
+    end
+
+    describe '#application_user' do
+      it 'defaults to the name of the application' do
+        config.set :application, 'rabbitfoot'
+        config.application_user.should eql('rabbitfoot')
+      end
+    end
+
+    describe '#application_group' do
+      it 'defaults to the name of the application user' do
+        config.set :application_user, 'rabbitfoot'
+        config.application_group.should eql('rabbitfoot')
+      end
+    end
+
+    describe '#branch' do
+      it 'defaults to master' do
+        config.branch.should eql('master')
+      end
+    end
+
+    describe '#deploy_to' do
+      it 'defaults to a folder within the application user home directory' do
+        config.set :application, 'hare'
+        config.set :application_user, 'rabbitfoot'
+        config.deploy_to.should eql('/home/rabbitfoot/apps/hare')
+      end
+    end
+
+    describe '#release_tag' do
+      it 'defaults to the current timestamp' do
+        now = Time.now
+        Time.stubs(:now).returns(now)
+        config.release_tag.should eql(Time.now.utc.strftime("%Y%m%d%H%M%S"))
+      end
+    end
+
+    describe '#latest_tag' do
+      it 'memoizes call to latest_tag_from_repository' do
+        namespace.stubs(:latest_tag_from_repository).returns('abc123').then.returns('something-else')
+        config.latest_tag.should eql('abc123')
+        config.latest_tag.should eql('abc123')
+      end
+    end
+  end
+
+  describe 'Tasks' do
+    let :application do
+      'romulus'
+    end
+
+    let :repository do
+      'git@github.com/example/romulus.git'
+    end
+
+    let :deploy_to do
+      '/path/to/deploy/romulus/into'
+    end
+
+    before do
+      config.set :application, application
+      config.set :repository, repository
+      config.set :deploy_to, deploy_to
+    end
+
+    describe 'deploy:setup' do
+      it 'runs deploy:clone_code task' do
+        namespace.expects(:clone_code)
+        config.find_and_execute_task('deploy:setup')
+      end
+
+      it 'calls deploy:clone_code task within a transaction' do
+        namespace.stubs(:transaction)
+        namespace.expects(:clone_code).never
+        config.find_and_execute_task('deploy:setup')
+      end
+    end
+
+    describe 'deploy:clone_code' do
+      it 'creates deploy_to dir, ensures it\'s group writable, then clones the repository into it' do
+        namespace.expects(:as_app).with('mkdir -p ' + deploy_to, '~').in_sequence
+        namespace.expects(:as_app).with('chmod g+rw ' + deploy_to).in_sequence
+        namespace.expects(:git).with('clone ' + repository + ' .').in_sequence
+        config.find_and_execute_task('deploy:clone_code')
+      end
+    end
+
+    describe 'deploy' do
+      it 'runs deploy:update_code, deploy:tag and then deploy:restart tasks' do
+        namespace.expects(:update_code).in_sequence
+        namespace.expects(:tag).in_sequence
+        namespace.expects(:restart).in_sequence
+        config.find_and_execute_task('deploy')
+      end
+
+      it 'calls deploy:update_code task within a transaction' do
+        namespace.stubs(:transaction)
+        namespace.expects(:update_code).never
+        config.find_and_execute_task('deploy')
+      end
+
+      it 'calls deploy:tag task within a transaction' do
+        namespace.stubs(:transaction)
+        namespace.expects(:tag).never
+        config.find_and_execute_task('deploy')
+      end
+
+      it 'calls restart outside the transaction' do
+        namespace.stubs(:transaction)
+        namespace.expects(:restart)
+        config.find_and_execute_task('deploy')
+      end
+    end
+
+    describe 'deploy:update_code' do
+      it 'fetches latest changes, then resets to repository branch' do
+        config.set :branch, 'release-branch'
+        namespace.expects(:git).with('fetch').in_sequence
+        namespace.expects(:git).with('reset --hard origin/release-branch').in_sequence
+        namespace.find_and_execute_task('deploy:update_code')
+      end
+    end
+
+    describe 'deploy:tag' do
+      before do
+        config.set :release_tag, 'abcd1234'
+        config.set :release_message, 'Released into the wild'
+      end
+
+      it 'tags code with the release tag and release message' do
+        namespace.expects(:git).with('tag abcd1234 -m \'Released into the wild\'')
+        namespace.find_and_execute_task('deploy:tag')
+      end
+    end
+
+    describe 'deploy:rollback' do
+      it 'deletes latest tag, resets to previous tag and restarts' do
+        config.stubs(:latest_tag).returns('release-2')
+        config.stubs(:latest_tag_from_repository).returns('release-1')
+        namespace.expects(:git).with('tag -d release-2').in_sequence
+        namespace.expects(:git).with('reset --hard release-1').in_sequence
+        namespace.expects(:restart).in_sequence
+        namespace.find_and_execute_task('deploy:rollback')
+      end
+
+      it 'aborts if no tag has been deployed' do
+        config.stubs(:latest_tag).returns(nil)
+        lambda do
+          namespace.find_and_execute_task('deploy:rollback')
+        end.should raise_error(SystemExit, 'This app is not currently deployed')
+      end
+    end
+
+    describe 'deploy:restart' do
+      it 'does nothing (but can be overidden by other recipes)' do
+        namespace.expects(:run).never
+        namespace.expects(:sudo).never
+        namespace.find_and_execute_task('deploy:restart')
+      end
+    end
+
+    describe 'deploy:destroy' do
+      it 'removes all files from the deployment folder' do
+        config.set :deploy_to, 'path/to/deploy/app'
+        config.expects(:sudo).with('rm -rf path/to/deploy/app')
+        config.find_and_execute_task('deploy:destroy')
+      end
+    end
+  end
+end

data/spec/tasks/env_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Recap::Env do
+  let :config do
+    Capistrano::Configuration.new
+  end
+
+  let :namespace do
+    config.env
+  end
+
+  before do
+    Recap::Env.load_into(config)
+  end
+
+  describe 'Settings' do
+    describe '#environment_file' do
+      it 'defaults to /home/ + application_user + /.env' do
+        config.set :application_user, 'marigold'
+        config.environment_file.should eql('/home/marigold/.env')
+      end
+    end
+  end
+
+  describe 'Tasks' do
+    describe 'env' do
+      pending 'Tests not written'
+    end
+
+    describe 'env:set' do
+      pending 'Tests not written'
+    end
+
+    describe 'env:edit' do
+      pending 'Tests not written'
+    end
+  end
+end

data/spec/tasks/foreman_spec.rb

@@ -0,0 +1,154 @@
+require 'spec_helper'
+
+describe Recap::Foreman do
+  let :config do
+    Capistrano::Configuration.new
+  end
+
+  let :namespace do
+    config.foreman
+  end
+
+  let :deploy_to do
+    'path/to/deploy/to'
+  end
+
+  before do
+    config.set :application, 'example-app'
+    config.set :application_user, 'example-app-user'
+    config.set :deploy_to, deploy_to
+    Recap::Foreman.load_into(config)
+  end
+
+  describe 'Settings' do
+    describe '#procfile' do
+      it 'defaults to deploy_to + /Procfile' do
+        config.procfile.should eql(deploy_to + '/Procfile')
+      end
+    end
+
+    describe '#foreman_export_format' do
+      it 'defaults to upstart' do
+        config.foreman_export_format.should eql('upstart')
+      end
+    end
+
+    describe '#foreman_export_location' do
+      it 'defaults to /etc/init' do
+        config.foreman_export_location.should eql('/etc/init')
+      end
+    end
+
+    describe '#foreman_tmp_location' do
+      it 'defaults to deploy_to + /tmp/foreman' do
+        config.foreman_tmp_location.should eql(deploy_to + '/tmp/foreman')
+      end
+    end
+
+    describe '#foreman_export_command' do
+      before :each do
+        config.set :foreman_export_format, '<export-format>'
+        config.set :foreman_tmp_location, '<tmp-location>'
+      end
+
+      it 'starts by exporting to the tmp location in the export format' do
+        config.foreman_export_command.index('./bin/foreman export <export-format> <tmp-location>').should eql(0)
+      end
+
+      it 'includes --procfile option pointing to procfile' do
+        config.set :procfile, '/custom/procfile/location'
+        config.foreman_export_command.index("--procfile /custom/procfile/location").should_not be_nil
+      end
+
+      it 'includes --app option naming application' do
+        config.set :application, 'my-application'
+        config.foreman_export_command.index("--app my-application").should_not be_nil
+      end
+
+      it 'includes --user option pointing to procfile' do
+        config.set :application_user, 'my-application-user'
+        config.foreman_export_command.index("--user my-application-user").should_not be_nil
+      end
+
+      it 'includes --log option pointing to log location' do
+        config.set :deploy_to, '/custom/deploy/location'
+        config.foreman_export_command.index("--log /custom/deploy/location/log").should_not be_nil
+      end
+    end
+  end
+
+  describe 'Tasks' do
+    describe 'foreman:export:if_changed' do
+      it 'calls foreman:export if the Procfile has changed' do
+        namespace.stubs(:deployed_file_changed?).with(config.procfile).returns(true)
+        namespace.export.expects(:default)
+        config.find_and_execute_task('foreman:export:if_changed')
+      end
+
+      it 'skips foreman:export if the Procfile has not changed' do
+        namespace.stubs(:deployed_file_changed?).with(config.procfile).returns(false)
+        namespace.export.expects(:default).never
+        config.find_and_execute_task('foreman:export:if_changed')
+      end
+    end
+
+    describe 'foreman:export' do
+      it 'runs the foreman export command, then moves the exported files to the export location' do
+        namespace.stubs(:deployed_file_exists?).with(config.procfile).returns(true)
+        namespace.expects(:as_app).with(config.foreman_export_command).in_sequence
+        namespace.expects(:sudo).with("rm -f #{config.foreman_export_location}/#{config.application}*").in_sequence
+        namespace.expects(:sudo).with("cp #{config.foreman_tmp_location}/* #{config.foreman_export_location}").in_sequence
+        config.find_and_execute_task('foreman:export')
+      end
+
+      it 'does nothing if no Procfile exists' do
+        namespace.stubs(:deployed_file_exists?).with(config.procfile).returns(false)
+        namespace.expects(:as_app).never
+        namespace.expects(:sudo).never
+        config.find_and_execute_task('foreman:export')
+      end
+    end
+
+    describe 'foreman:start' do
+      it 'starts the application' do
+        namespace.stubs(:deployed_file_exists?).with(config.procfile).returns(true)
+        namespace.expects(:sudo).with('start example-app')
+        config.find_and_execute_task('foreman:start')
+      end
+
+      it 'does nothing if no Procfile exists' do
+        namespace.stubs(:deployed_file_exists?).with(config.procfile).returns(false)
+        namespace.expects(:sudo).never
+        config.find_and_execute_task('foreman:start')
+      end
+    end
+
+    describe 'foreman:stop' do
+      it 'starts the application' do
+        namespace.stubs(:deployed_file_exists?).with(config.procfile).returns(true)
+        namespace.expects(:sudo).with('stop example-app')
+        config.find_and_execute_task('foreman:stop')
+      end
+
+      it 'does nothing if no Procfile exists' do
+        namespace.stubs(:deployed_file_exists?).with(config.procfile).returns(false)
+        namespace.expects(:sudo).never
+        config.find_and_execute_task('foreman:stop')
+      end
+    end
+
+    describe 'foreman:restart' do
+      it 'restart or starts the application' do
+        namespace.stubs(:deployed_file_exists?).with(config.procfile).returns(true)
+        namespace.expects(:sudo).with('restart example-app || sudo start example-app')
+        config.find_and_execute_task('foreman:restart')
+      end
+
+      it 'does nothing if no Procfile exists' do
+        namespace.stubs(:deployed_file_exists?).with(config.procfile).returns(false)
+        namespace.expects(:sudo).never
+        config.find_and_execute_task('foreman:restart')
+      end
+    end
+  end
+end

data/test-vm/manifests/base.pp

@@ -0,0 +1,17 @@
+group { 'puppet':
+  ensure => 'present'
+}
+
+package { ['git-core', 'curl']:
+  ensure => present
+}
+
+package { 'bundler':
+  provider => gem,
+  ensure => '1.1.rc.7'
+}
+
+package { 'foreman':
+  provider => gem,
+  ensure => present
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: recap
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-24 00:00:00.000000000Z
+date: 2012-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capistrano
-  requirement: &70207555688740 !ruby/object:Gem::Requirement
+  requirement: &70142953253620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.9.0
   type: :runtime
   prerelease: false
-  version_requirements: *70207555688740
+  version_requirements: *70142953253620
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70207555688320 !ruby/object:Gem::Requirement
+  requirement: &70142953251580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70207555688320
+  version_requirements: *70142953251580
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70207555687780 !ruby/object:Gem::Requirement
+  requirement: &70142953246460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70207555687780
+  version_requirements: *70142953246460
 - !ruby/object:Gem::Dependency
   name: rocco
-  requirement: &70207555687280 !ruby/object:Gem::Requirement
+  requirement: &70142953244940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,22 +54,92 @@ dependencies:
         version: 0.8.1
   type: :development
   prerelease: false
-  version_requirements: *70207555687280
+  version_requirements: *70142953244940
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70142953242500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *70142953242500
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70142953241400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: *70142953241400
+- !ruby/object:Gem::Dependency
+  name: vagrant
+  requirement: &70142953239580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+  type: :development
+  prerelease: false
+  version_requirements: *70142953239580
+- !ruby/object:Gem::Dependency
+  name: sahara
+  requirement: &70142953235920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+  type: :development
+  prerelease: false
+  version_requirements: *70142953235920
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &70142953235380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :development
+  prerelease: false
+  version_requirements: *70142953235380
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: &70142953234480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.1
+  type: :development
+  prerelease: false
+  version_requirements: *70142953234480
 description: GIT based deployment recipes for Capistrano
 email:
 - tom@popdog.net
 executables:
-- tomafro-deploy
+- recap
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- bin/tomafro-deploy
+- Vagrantfile
+- bin/recap
 - doc/index.html
+- doc/lib/recap.html
+- doc/lib/recap/bootstrap.html
 - doc/lib/recap/bundler.html
 - doc/lib/recap/capistrano_extensions.html
 - doc/lib/recap/cli.html
@@ -77,10 +147,26 @@ files:
 - doc/lib/recap/deploy.html
 - doc/lib/recap/env.html
 - doc/lib/recap/foreman.html
+- doc/lib/recap/namespace.html
 - doc/lib/recap/preflight.html
 - doc/lib/recap/rails.html
 - doc/lib/recap/version.html
+- features/bundling-gems.feature
+- features/deploying-projects.feature
+- features/managing-processes.feature
+- features/setting-environment-variables.feature
+- features/steps/capistrano_steps.rb
+- features/support/project.rb
+- features/support/server.rb
+- features/templates/gem/binary.erb
+- features/templates/gem/gemspec.erb
+- features/templates/project/Capfile
+- features/templates/project/Capfile.erb
+- features/templates/project/Gemfile.erb
+- features/templates/project/Procfile.erb
 - index.rb
+- lib/recap.rb
+- lib/recap/bootstrap.rb
 - lib/recap/bundler.rb
 - lib/recap/capistrano_extensions.rb
 - lib/recap/cli.rb
@@ -88,12 +174,25 @@ files:
 - lib/recap/deploy.rb
 - lib/recap/deploy/templates/Capfile.erb
 - lib/recap/env.rb
+- lib/recap/environment.rb
 - lib/recap/foreman.rb
+- lib/recap/namespace.rb
 - lib/recap/preflight.rb
 - lib/recap/rails.rb
+- lib/recap/ruby.rb
+- lib/recap/static.rb
 - lib/recap/version.rb
 - recap.gemspec
-homepage: https://github.com/freerange/recap
+- spec/models/environment_spec.rb
+- spec/spec_helper.rb
+- spec/tasks/bootstrap_spec.rb
+- spec/tasks/bundler_spec.rb
+- spec/tasks/deploy_spec.rb
+- spec/tasks/env_spec.rb
+- spec/tasks/foreman_spec.rb
+- test-vm/manifests/base.pp
+- test-vm/share/.gitkeep
+homepage: http://code.gofreerange.com/recap
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -107,7 +206,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3210950917994093421
+      hash: 52580034852729211
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -116,11 +215,31 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3210950917994093421
+      hash: 52580034852729211
 requirements: []
-rubyforge_project: recap
-rubygems_version: 1.8.7
+rubyforge_project: 
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: GIT based deployment recipes for Capistrano
-test_files: []
+test_files:
+- features/bundling-gems.feature
+- features/deploying-projects.feature
+- features/managing-processes.feature
+- features/setting-environment-variables.feature
+- features/steps/capistrano_steps.rb
+- features/support/project.rb
+- features/support/server.rb
+- features/templates/gem/binary.erb
+- features/templates/gem/gemspec.erb
+- features/templates/project/Capfile
+- features/templates/project/Capfile.erb
+- features/templates/project/Gemfile.erb
+- features/templates/project/Procfile.erb
+- spec/models/environment_spec.rb
+- spec/spec_helper.rb
+- spec/tasks/bootstrap_spec.rb
+- spec/tasks/bundler_spec.rb
+- spec/tasks/deploy_spec.rb
+- spec/tasks/env_spec.rb
+- spec/tasks/foreman_spec.rb