lastobelus-vlad 1.4.0

data/.autotest

@@ -0,0 +1,24 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+
+Autotest.add_hook :initialize do |at|
+  at.testlib = "minitest/autorun"
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception 'vendor'
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/History.txt

@@ -0,0 +1,162 @@
+=== 1.4.0 / 2009-06-23
+
+* 1 major enhancement:
+
+  * Switched to passenger as default app server.
+
+* 11 minor enhancements:
+
+  * #rsync now takes ANY number of arguments and expects to you add "host:".
+  * Added Rake::RemoteTask#get.
+  * Added doco for why we don't ship a deploy task
+  * Added links to example maintenance recipes
+  * Added multi-env doco to getting_started.txt
+  * Added svn-over-ssh faq item. gah.
+  * Flipped tests to minitest
+  * Merged global #role and Rake::RemoteTask::role.
+  * Moved all global methods to Rake::RemoteTask and wrote #external to clean up.
+  * Moved rake extensions to hoe so everyone can enjoy the fun.
+  * put names the tempfile based on the remote path to ease debugging
+
+* 2 bug fixes:
+
+  * passenger:start_app wasn't using the latest_release path
+  * set/fetch wasn't dealing with a default of false well. (Seth Falcon)
+
+=== 1.3.2 / 2009-03-16
+
+* 3 minor enhancements:
+
+  * Added 'Deploying Merb with Vlad' by Graham Ashton.
+  * Added 'Deploying Sinatra with Vlad' by Graham Ashton.
+  * Core update task calls update with the actual revision once again
+
+* 1 bug fix:
+
+  * Fix Git checkout/export methods. (Wilson)
+
+=== 1.3.1 / 2009-03-06
+
+* 4 minor enhancements:
+
+  * Added faq on how to clear/replace tasks. (mikehale)
+  * Added sudo_prompt variable.
+  * Added top level sudo method to compliment run. (woahdae)
+  * Set sudo_flags to default to ['-p Password:']. (mly)
+
+* 3 bug fixes:
+
+  * Fixed prompts during rollback. (goodieboy)
+  * deploy_via went AWOL in subversion module.
+  * vlad:migrate ignored migrate_target directory. (tomklaasen)
+
+=== 1.3.0 / 2009-03-04
+
+* 9 major enhancements:
+
+  * Added darcs support. (Brian Palmer)
+  * Added git support. (Garry Dolley)
+  * Added lighttpd support.
+  * Added merb support. (Jamie Macey)
+  * Added passenger support. (Alan Harper)
+  * Added/merged god, nginx, thin, and maintenance tasks. (github clusterfuck)
+  * Allow set to specify that a proc value is :per_thread.
+  * Apply Mercurial SCM support patch. Closes ticket 13475
+  * remote_task now supports args and supplies task (by Daniel P. Kionka).
+
+* 19 minor enhancements:
+
+  * Add role toplevel method similar to namespace.
+  * Added #put method that wraps up Tempfile/rsync pattern.
+  * Added #role toplevel method, similar to #namespace.
+  * Added FAQ for using vlad through a gateway.
+  * Added Phil Hagelburg's one-line multi-stage deployment patch
+  * Added rake tracing for rsync command.
+  * Added umask variable.
+  * Adds specific order to loading. Should fix a number of bugs.
+  * Extended vladdemo.sh to allow for N simulated hosts (mostly for testing)
+  * Fixed tempfile dependency in #put if you don't load lighttpd or perforce (yipstar)
+  * Mercurial now automatically initializes the repository. (Jamie Macey)
+  * Moved everything over to put.
+  * Now requires rake 0.8.1+.
+  * Parameterized 'head' into 'revision' variable (with head as default).
+  * Split shared symlink creation to a separate task. (Steve Purcell)
+  * Support rake 0.8.
+  * Switched to ThreadGroup for Action#execute
+  * Updated rakefile for new hoe abilities
+  * remote_task :role now allows an empty list of hosts.
+
+* 11 bug fixes:
+
+	* Fixed vladdemo.rb, now uses my checkout for further stress testing.
+	* Moved core recipe to front. Was breaking mongrel setup.
+  * Added automatic client setup for perforce.
+  * Fix mercurial support.
+  * Fixed 'too many files' error.
+  * Fixed a lame warning in the tests.
+  * Fixed cleanup to actually properly clean up.
+  * Fixed rake var doco
+  * Moved generic app setup to core from mongrel.
+  * SSH flags are now an Array for proper inclusion in the command. (Guillaume Pierronnet)
+  * git archive now specifically specifies tar format. (knaveofdiamonds)
+
+=== 1.1.1 / 2008-01-14
+
+* 5 major enhancements:
+
+  * Support for Rake 0.8. Should still work for Rake 0.7.
+  * Added git support (contributed by Garry Dolley).
+    * Reviewed for accuracy by Evan Phoenix.
+  * Added lighttpd.rb
+  * Added automatic client setup for perforce.
+  * Added mercurial SCM support patch. Closes ticket 13475.
+
+* 6 minor enhancements:
+
+  * Added #put method that wraps up Tempfile/rsync pattern.
+  * Added automatic p4 client setup for perforce.
+  * Added vladdemo.sh
+  * Moved everything over to put.
+  * Moved generic app setup to core from mongrel.
+  * Parameterized 'head' into 'revision' variable (with head as default).
+
+* 1 bug fix
+
+  * Fixed cleanup to actually properly clean up.
+
+=== 1.1.0 / 2007-09-12
+
+* 3 major enhancements:
+
+  * Vlad.load now takes a hash of recipe overrides, eg: Vlad.load :web => :nginx.
+    See rdoc for defaults.
+  * Removed vlad_tasks.rb and split into vlad/apache.rb, vlad/mongrel.rb,
+    and vlad/core.rb.
+  * The flog ratio between capistrano+deps / vlad+deps is pi (or, damn close)!
+
+* 12 minor enhancements:
+
+  * Added $TRACE to make it more available and cleaner to read.
+  * Added :svn_cmd variable.
+  * Added Rake.clear_tasks *str_or_regexp
+  * Added debug and mana_from_heaven tasks to Rakefile.
+  * Added more documentation.
+  * Added :rsync_cmd and :rsync_flags.
+  * Added :ssh_cmd and :ssh_flags.
+  * Added variable expansion to vlad:debug task.
+  * Removed :scm variable. Now a Vlad.load component/flavor/need-a-word-here.
+  * Removed :application var. Use it if you want it. We don't require it.
+  * Renamed :p4cmd to :p4_cmd.
+  * Renamed :rake var to :rake_cmd.
+
+* 2 (important) bug fixes:
+
+  * HUGE: Fixed sudo hang bug #13072. Fix suggested by Chris Van Pelt.
+  * HUGE: Vlad.load calls user config last, allowing variable overrides.
+    ACK! Sorry!
+
+=== 1.0.0 / 2007-08-04
+
+* 1 major enhancement
+
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,38 @@
+.autotest
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+considerations.txt
+doco/deploying-merb-with-vlad.txt
+doco/deploying-sinatra-with-vlad.txt
+doco/faq.txt
+doco/getting_started.txt
+doco/migration.txt
+doco/perforce.txt
+doco/variables.txt
+lib/rake_remote_task.rb
+lib/vlad.rb
+lib/vlad/apache.rb
+lib/vlad/core.rb
+lib/vlad/darcs.rb
+lib/vlad/git.rb
+lib/vlad/god.rb
+lib/vlad/lighttpd.rb
+lib/vlad/maintenance.rb
+lib/vlad/merb.rb
+lib/vlad/mercurial.rb
+lib/vlad/mongrel.rb
+lib/vlad/nginx.rb
+lib/vlad/passenger.rb
+lib/vlad/perforce.rb
+lib/vlad/subversion.rb
+lib/vlad/thin.rb
+test/test_rake_remote_task.rb
+test/test_vlad.rb
+test/test_vlad_git.rb
+test/test_vlad_mercurial.rb
+test/test_vlad_perforce.rb
+test/test_vlad_subversion.rb
+test/vlad_test_case.rb
+vladdemo.sh

data/README.txt

@@ -0,0 +1,78 @@
+= Vlad the Deployer by the Ruby Hit Squad
+
+* http://rubyhitsquad.com/
+* http://rubyforge.org/projects/hitsquad/
+
+== DESCRIPTION
+
+Vlad the Deployer is pragmatic application deployment automation,
+without mercy. Much like Capistrano, but with 1/10th the
+complexity. Vlad integrates seamlessly with Rake, and uses familiar
+and standard tools like ssh and rsync.
+
+Impale your application on the heartless spike of the Deployer.
+
+== FEATURES/PROBLEMS
+
+* Full deployment automation stack.
+* Turnkey deployment for mongrel+apache+svn.
+* Supports single server deployment with just 3 variables defined.
+* Built on rake. Easy. Engine is small.
+* Very few dependencies. All simple.
+* Uses ssh with your ssh settings already in place.
+* Uses rsync for efficient transfers.
+* Run remote commands on one or more servers.
+* Mix and match local and remote tasks.
+* Compatible with all of your tab completion shell script rake-tastic goodness.
+* Ships with tests that actually pass in 0.028 seconds!
+* Does NOT support Windows right now (we think). Coming soon in 1.2.
+
+== SYNOPSIS
+
+    % rake vlad:setup   # first time only
+    % rake vlad:update
+    % rake vlad:migrate # optional
+    % rake vlad:start
+
+== REQUIREMENTS
+
+* Rake
+* Hoe
+* Rubyforge
+* open4
+
+== INSTALL
+
+* sudo gem install vlad
+
+== SPECIAL THANKS
+
+* First, of course, to Capistrano. For coming up with the idea and
+  providing a lot of meat for the recipes.
+* Scott Baron for coming up with one of the best project names evar.
+* Bradley Taylor for giving us permission to use RailsMachine recipes sans-LGPL.
+
+== LICENSE
+
+(The MIT License)
+
+Copyright (c) 2007-2009 Ryan Davis and the rest of the Ruby Hit Squad
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,44 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+
+Hoe.plugin :seattlerb
+
+Hoe.spec 'vlad' do
+  self.rubyforge_name = 'hitsquad'
+
+  developer 'Ryan Davis',       'ryand-ruby@zenspider.com'
+  developer 'Eric Hodel',       'drbrain@segment7.net'
+  developer 'Wilson Bilkovich', 'wilson@supremetyrant.com'
+
+  extra_deps << ['rake', '>= 0.8.1']
+  extra_deps << 'open4'
+
+  multiruby_skip << "1.9" << "rubinius"
+end
+
+desc "quick little hack to see what the state of the nation looks like"
+task :debug do
+  Vlad.load :config => "lib/vlad/subversion.rb"
+  set :repository, "repository path"
+  set :deploy_to,  "deploy path"
+  set :domain,     "server domain"
+
+  Rake::Task['vlad:debug'].invoke
+end
+
+task :mana_from_heaven do
+  # vlad = vlad + rake + open4
+  # rake sans-contrib = 2035.98356718206
+  vlad  = `flog -s lib`.to_f + 2350.30744806517 + 502.363818023761
+  cap   = 11480.3919695285
+  ratio = cap / vlad
+  target = cap / Math::PI
+
+  puts "%14.8f = %s" % [vlad, "vlad"]
+  puts "%14.8f = %s" % [ratio, "ratio"]
+  puts "%14.8f = %s" % [target - vlad, "needed delta"]
+end
+
+# vim: syntax=ruby

data/considerations.txt

@@ -0,0 +1,91 @@
+* might we want per connection values?
+
+* :except => {:no_release => true}
+
+  It is common to configure tasks to 'announce' deployments in IRC, Campfire,
+  etc.  If you have 6 app servers, you don't want to see 6 announcements.  In
+  Capistrano, this is handled via the :no_release => true flag.  Various tasks
+  only execute on the 'release' servers.
+
+  An easier way to meet this would be to introduce a :release role in the
+  default setup
+
+    role :release, "app1.example.com"
+    
+    remote_task :announce_in_irc, :roles => :release ...
+
+  Drawback: Yet another thing to change when you migrate a project from cap to
+  vlad
+
+* 'dynamic deployments'
+
+    role :app, "app1.example.com"
+    role :app, "app2.example.com"
+
+  Let's say that app1 and app2 need slightly different monit configurations.
+
+  In Capistrano, you might approach this by making two additional roles, and 
+  splitting your 'push a monit config' task into two. This sucks.
+
+  Vlad makes the 'execution context' of a task available. In Vlad, you would:
+
+    remote_task :update_monit, :roles => :app
+      rsync "templates/#{target_host}.monitrc", "/etc/monitrc"
+    end
+
+* fine-grained tasks
+
+    remote_task :update
+    remote_task :symlink
+    remote_task :migrate
+    remote_task :deploy => [:update, :symlink, :migrate, :restart]
+
+  Let's assume that this is a multi-server config with shared deploy path.
+  The user wants to do only a single checkout. If we make "update" be one big
+  task body that includes the update, symlink, and migrate steps,
+  it is difficult for the user to override the roles for the particular steps
+  they need to change.
+
+  If we break these into separate tasks, they can say:
+
+    Rake::Task["migrate"].options[:roles] = :master_db
+
+  and the migrations will only run on the master db
+
+* sudo / via how? and if we call it via I will stab ppl. "user" is sufficient.
+
+* handling 'use_sudo'
+
+  1. Check for this inside the 'run' command, and preface the command
+     with 'sudo' if necessary
+
+  2. Default this to 'false' in the reset method, and check for it
+     in the default tasks that we provide:
+       if use_sudo then
+         sudo "blah"
+       else
+         run "blah"
+       end
+
+  Option 2 has fewer moving parts, but clutters up the tasks that care about
+  this.
+
+* Dependencies
+
+  Task dependencies aren't settable when creating a Rake::RemoteTask.
+
+* Apache configuration
+
+  Pull in railsmachine/rails/recipes/apache.rb's apache configuration.  Needs
+  erb to work.
+
+* I really like tasks with naming <cmd>_<role> (eg setup_app,
+  start_web). We could easily make the front end remote_task command
+  look for such a convention and apply the :role => x automatically.
+
+* from bousquet: get a couple of server environment recipes that prepare your
+  machine that would be the golden ticket:
+
+    rake vlad:prepare TYPE=accelerator | ubuntu | osx | osxserver | site5 | ...
+
+  and have people maintaining those setups who depend on them

data/doco/deploying-merb-with-vlad.txt

@@ -0,0 +1,155 @@
+# Deploying Merb with Vlad
+
+This tutorial has been adapted from [Deploying Merb with Vlad](http://effectif.com/articles/deploying-merb-with-vlad) by [Graham Ashton](http://effectif.com "Effectif Development").
+
+You've built your Merb app, and you want to get it running on your web server. You could use Capistrano, but if you prefer the simple things in life you might find that [Vlad](http://rubyhitsquad.com/Vlad_the_Deployer.html "Vlad the Deployer") is a better fit.
+
+This is a Merb version of the [Deploying Sinatra with Vlad](deploying-sinatra-with-vlad "Deploying Sinatra with Vlad") article that I wrote yesterday. There are big similarities to that article, but in this one we also look at how to restart Merb automatically after the code has been deployed.
+
+## Creating a sample application
+
+Let's start by making ourselves a test app:
+
+    $ merb-gen flat hi
+    $ cd hi
+
+We can check that the app works locally by running it...
+
+    $ merb
+
+...and then opening [http://localhost:4000](http://localhost:4000) in a web browser.
+
+We need to create a `public` directory too (because this is a flat app I don't already have one), as Vlad assumes that we have a `public` directory for our static assets. I'm also going to make an empty CSS file so that the directory doesn't get ignored by Git:
+
+    $ mkdir public
+    $ touch public/master.css
+
+We'll deploy our application from version control. I'm using Git, but you can use any system that Vlad supports; just check your files into a repository that will be accessible from your web server.
+
+## Configuring Vlad
+
+Okay, we're ready for Vlad. It's a Ruby gem, so it's very easy to install:
+
+    $ sudo gem install vlad
+    Successfully installed vlad-1.2.0
+    1 gem installed
+    Installing ri documentation for vlad-1.2.0...
+    Installing RDoc documentation for vlad-1.2.0...
+
+There's no need to install Vlad on your server, just your workstation.
+
+You access Vlad's functionality through Rake tasks. Add the following code to a file called `lib/tasks/vlad.rake` (you may have to make the directory first, but Merb will automatically find it):
+
+    begin
+      $TESTING = true # workaround a conflict between DataMapper and Vlad
+      require "vlad"
+      Vlad.load(:app => nil, :scm => "git")
+    rescue LoadError
+      # do nothing
+    end
+
+Note that we've told Vlad that we intend to use Git (subversion is the default). We've set `:app` to `nil` as Vlad assumes that we'll run our application with `mongrel_rails` (it seems to think everybody who uses Mongrel is using Rails). Merb has support for clusters built in, so we'll setup some simple replacements later.
+
+If you run `rake -T` now you should see a bunch of vlad tasks that are available to you. You can't run them yet; you need to configure Vlad. Create a `config/deploy.rb` file in your editor and set the following variables in it:
+
+    set :application, "hi"
+    set :repository, "ssh://your.git.server/path/to/project/hi.git"
+    set :domain, "your.web.server"
+    set :deploy_to, "/var/apps/#{application}"
+
+Make sure that `:repository` correctly references your source control system, and that `:domain` is set to the hostname of your server.
+
+I won't be able to create any directories under the `/var/apps` directory (I'm going to run vlad using my own username in this example), so I need to login to my server and make sure that I can create files in the `hi` directory:
+
+    $ ssh your.web.server
+    $ sudo mkdir -p /var/apps/hi
+    $ sudo chown yourusername /var/apps/hi
+
+Now you can try running Vlad, to create all the directories necessary to serve your project. Back on your workstation, type:
+
+    $ rake vlad:setup
+
+You should find that some directories have been created within `/var/apps/hi` on your server.
+
+Let's trying deploying some code:
+
+    $ rake vlad:update
+    (in /Users/graham/data/effectif/projects/hi)
+    Initialized empty Git repository in /var/apps/hi/scm/repo/.git/
+    Switched to a new branch "deployed-HEAD"
+
+You should now find that if you ssh into your server that you can run the application:
+
+    $ ssh your.web.server
+    $ cd /var/apps/hi/current
+    $ merb
+
+Try making a change to your source, committing it to your repository, then run `vlad:update` again. Your code will be updated. If you restart Merb in the new directory you'll see your changes in the browser.
+
+If you're following along with these commands, be careful that you're running `merb` in the freshly deployed directory. `current` is a symlink to a specific release directory, so you'll need to leave the directory and return to it to see the new source code (i.e. symlinks don't get updated under your shell's feet). This should do it:
+
+    $ cd ~ && cd -
+    $ merb
+
+Okay, we're nearly there. All we need to do now is to automatically restart Merb when we deploy a new copy of the code with the `vlad:update` task. Add the following code to the bottom of your `config/deploy.rb` file:
+
+    Rake.clear_tasks("vlad:stop", "vlad:start")
+
+    namespace :vlad do
+      def stop
+        run "merb -m #{deploy_to}/current -K all"
+      end
+  
+      def start
+        run "merb -m #{deploy_to}/current -e production -c 2"
+      end
+  
+      remote_task :start, :roles => :app do
+        stop
+        start
+      end
+  
+      remote_task :stop, :roles => :app do
+        stop
+      end
+  
+      remote_task :update do
+        Rake::Task["vlad:start"].invoke
+      end
+    end
+
+Note that in this example we've started a two process cluster with the `-c` option in the `start` method.
+
+You'll find (with the `vlad:start` command I've shown above) that Merb is running on port 4000. If you want to run Merb on port 80 then I would recommend running these Merb processes behind Nginx, but I'll leave configuring Nginx as an exercise for the reader (Google will help you out there).
+
+Let's just make sure that it's working. Run `rake vlad:update` a couple of times and check that Merb is getting stopped and started properly (it fails to stop Merb on the first run below simply because this was the first time I'd started it):
+
+    $ rake vlad:update
+    (in /Users/graham/data/effectif/projects/hi)
+    Loading init file from /Users/graham/data/effectif/projects/hi/config/init.rb
+    Initialized empty Git repository in /var/apps/hi/scm/repo/.git/
+    Switched to a new branch "deployed-HEAD"
+     ~ Could not find a PID file at /var/apps/hi/current/log/merb.main.pid. Most likely the process is no longer running and the pid file was not cleaned up.
+     ~ In 7643
+    $ rake vlad:update
+    (in /Users/graham/data/effectif/projects/hi)
+    Loading init file from /Users/graham/data/effectif/projects/hi/config/init.rb
+    Initialized empty Git repository in /var/apps/hi/scm/repo/.git/
+    Switched to a new branch "deployed-HEAD"
+     ~ Killing pid 7643 with INT
+     ~ In 7840
+
+Now point your browser at port 4000 of your server – your application should be running!
+
+## Deploying from a Git branch
+
+If you want to deploy from a specific Git branch (`master` is the default) you can set the `:revision` variable in `deploy.rb`:
+
+    set :revision, "origin/mybranch"
+
+## Deploying as a different user
+
+It's not a great idea to deploy and run applications as your own login name (it's better practice to run web applications as users that don't have many privileges). I've not really addressed users in this article in order to focus on the basics of Vlad, but if you're interested you can deploy as a different user with these settings in `deploy.rb`:
+
+    set :user, "deploy"
+    set :domain, "#{user}@domain.com"