brightbox 0.25 → 2.0.1

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake/gempackagetask'
+require "brightbox-gemspec.rb"
+
+namespace :client do
+  Rake::GemPackageTask.new(@client).define
+
+  task :default => [:reinstall, :clobber_package]
+
+  desc "Reinstall the client gem locally"
+  task :reinstall => [:repackage] do
+    sh %Q{sudo gem uninstall -x -v #{@client.version} #{@client.name} }
+    sh %q{sudo gem install pkg/*.gem}
+  end
+
+end
+
+namespace :server do
+  Rake::GemPackageTask.new(@server).define
+end
+
+task :clobber_package => "client:clobber_package"
+task :package => ["client:package", "server:package"]
+task :repackage => ["client:repackage", "server:package"]

data/bin/brightbox

@@ -1,4 +1,23 @@
 #!/usr/bin/env ruby
+#    Brightbox - Easy Ruby Web Application Deployment
+#    Copyright (C) 2008, Neil Wilson, Brightbox Systems
+#
+#    This file is part of the Brightbox deployment system
+#
+#    Brightbox gem is free software: you can redistribute it and/or modify it
+#    under the terms of the GNU Affero General Public License as published
+#    by the Free Software Foundation, either version 3 of the License,
+#    or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#    Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General
+#    Public License along with this program.  If not, see
+#    <http://www.gnu.org/licenses/>.
+#
 
 begin
   require 'rubygems'
@@ -7,32 +26,284 @@ rescue LoadError
 end
 
 require 'optparse'
+require 'brightbox/version'
 
 @options = {}
+@progname = File.basename($0)
+
+def has_required_options?
+  [@server].all?
+end
+
 OptionParser.new do |opts|
-  opts.banner = "Usage: #{$0} [options] [args]"
-
-  opts.on("-A", "--apply-to DIRECTORY",
-    "Create a minimal set of scripts and recipes",
-    "for use with capistrano to configure servers."
-  ) { |value| @options[:apply_to] = value }
-  opts.on("-n", "--name APPLICATION_NAME",
-    "Name of application."
-  ) { |value| @options[:application] = value }
-  opts.on("-d", "--domain DOMAIN_NAME",
-    "Domain name for application."
-  ) { |value| @options[:domain] = value }
-  opts.on("-i", "--server SERVER_NAME",
-    "Hostname or IP address of your Brightbox virtual server"
-  ) { |value| @options[:server] = value }
+  opts.banner = "Set up your Rails application for deployment\n"
+  opts.banner << "Usage: #{@progname} [options] <directory_name>\n\n"
+
+  opts.on("-n APPLICATION_NAME", "--name APPLICATION_NAME",
+    "Name of application (a short useful",
+    "name for the app such as 'myforum')",
+    "(defaults to the short name of the server)\n"
+  ) { |value| @application = value }
+  
+  opts.on("-d DOMAIN_NAME", "--domain DOMAIN_NAME",
+    "Domain name for application",
+    "(e.g: www.example.com)",
+    "(defaults to the server name)\n"
+  ) { |value| @domain = value }
+  
+  opts.on("-i SERVER_NAME", "--server SERVER_NAME",
+    "Hostname or IP address of your",
+    "Brightbox virtual server",
+    "(e.g: example-001.vm.brightbox.net)\n"
+  ) { |value| @server = value }
+
+  opts.on_tail("-h", "--help", "Displays this help page") do
+    puts opts
+    exit 0
+  end
+  
+  opts.on_tail("-v", "--version", "Displays the version number") do
+    puts "#{@progname}: version #{Brightbox::VERSION}"
+    exit 0
+  end
  
-  if ARGV.empty?
+  begin
+    opts.parse!(ARGV)
+    raise OptionParser::ParseError,
+      "You must supply the server name" unless has_required_options?
+  rescue OptionParser::ParseError => e
+    warn e.message
     puts opts
-      exit
+    exit 1
+  end
+end
+
+
+abort "Please specify the directory containing the Rails app, e.g. '#{@progname} .'" if ARGV.empty?
+abort "Too many arguments; please provide a single directory name." unless ARGV.length == 1
+abort "'#{ARGV.first}' does not exist." unless File.exists?(ARGV.first)
+abort "'#{ARGV.first}' is not a directory." unless File.directory?(ARGV.first)
+
+def unindent(string)
+  indentation = string[/\A\s*/]
+  string.strip.gsub(/^#{indentation}/, "")
+end
+
+@domain ||= @server
+@application ||= @server.gsub(/(-\d{3})?\..*\Z/,'')
+
+files = {
+  "Capfile" => unindent(<<-FILE),
+    # Generated with '#{@progname}' on #{Time.now}
+    load 'deploy' if respond_to?(:namespace) # cap2 differentiator
+    Dir['vendor/plugins/*/recipes/*.rb'].each { |plugin| load(plugin) }
+    load 'config/deploy'
+  FILE
+
+  "lib/tasks/bbgem.rake" => unindent(<<-FILE),
+    # Generated with '#{@progname}' on #{Time.now}
+unless Rake::Task.task_defined?("gems:install") 
+  def install_gems
+    gems={
+      "ferret" => "~> 0.11",
+      "will_paginate" => "> 0"
+    }
+    gems.each_pair do |gem, version|
+      puts "Checking for \#{gem} at \#{version}"
+      system("gem spec \#{gem} --version '\#{version}' 2>/dev/null|egrep -q '^name:' ||
+              sudo gem install -y --no-ri --no-rdoc --version '\#{version}' \#{gem}")
+    end
+  end
+
+  def gems_upgrade_notice
+    puts "This is a dummy task installed by the Brightbox command"
+    puts "If you need gems to make your application work"
+    puts "Uncomment the install command and alter the gems on the list"
+    puts "... or upgrade to Rails >= 2.1 and use the inbuilt facilities"
+  end
+
+  namespace(:gems) do
+    desc "Installs all required gems for this application."
+    task :install do
+      gems_upgrade_notice
+      #install_gems 
+    end
+  end
+end
+
+unless Rake::Task.task_defined?("db:create") 
+
+  namespace(:db) do
+    task :create do
+      puts "This is a dummy task installed by the Brightbox command"
+      puts "Your Rails version is too old to support the db:create task"
+      puts "Either upgrade to Rails >=2.0 to use the inbuilt facilities"
+      puts "Or create the database by hand if you haven't already"
+    end
+  end
+end
+unless Rake::Task.task_defined?("db:check:config") 
+
+  def pe(message)
+    p "\#{RAILS_ENV}: \#{message}"
+  end
+
+  def brightbox_sanity_checks(config)
+    %w(username password database host).each do |entry|
+      pe "\#{entry} entry missing" unless config[entry]
+    end
+    db=config['database']
+    host=config['host']
+    if host && host != 'sqlreadwrite.brightbox.net'
+      pe "using '\#{host}', not the 'sqlreadwrite.brightbox.net' cluster"
+    elsif db && db !~ /\\A\#{config['username']}/
+      pe "database name should start with '\#{config['username']}' if using cluster"
+    end
+  end
+
+  namespace(:db) do
+    namespace(:check) do
+      desc "Check database.yml config"
+      task :config => :environment do
+        p "Checking database mysql configuration..."
+        if config=ActiveRecord::Base.configurations[RAILS_ENV]
+          case config['adapter']
+          when nil
+            pe "adapter entry missing."
+          when 'mysql'
+            brightbox_sanity_checks(config)
+          else
+            pe "using \#{config['adapter']} - halting checks"
+          end
+        else
+          pe "section missing."
+        end
+      end
+    end
+  end
+end
+
+
+  FILE
+
+"config/deploy.rb" => unindent(<<-FILE),
+    ## Generated with '#{@progname}' on #{Time.now}
+    gem 'brightbox', '>=#{Brightbox::VERSION}'
+    require 'brightbox/recipes'
+
+    # The name of your application.  Used for deployment directory and filenames
+    # and Apache configs. Should be unique on the Brightbox
+    set :application, "#{@application}"
+
+    # Primary domain name of your application. Used in the Apache configs
+    set :domain, "#{@domain}"
+
+    ## List of servers
+    server "#{@server}", :app, :web, :db, :primary => true
+
+    # Target directory for the application on the web and app servers.
+    set(:deploy_to) { File.join("", "home", user, application) }
+
+    # URL of your source repository. This is the default one that comes on 
+    # every Brightbox, you can use your own (we'll let you :)
+    set :repository, "."
+    set :scm, :none
+    set :deploy_via, :copy
+
+    ### Other options you can set ##
+    # Comma separated list of additional domains for Apache
+    # set :domain_aliases, "www.example.com,dev.example.com"
+
+    ## Local Shared Area
+    # These are the list of files and directories that you want
+    # to share between all the releases of your application.
+    # So if you have an 'upload' directory in public, add 'public/upload'
+    # to the :local_shared_dirs array.
+    # If you want to share the database.yml add 'config/database.yml'
+    # to the :local_shared_files array.
+    # The shared area is prepared with 'deploy:setup' and all the shared
+    # items are symlinked in when the code is updated.
+    # set :local_shared_dirs, %w(public/upload)
+    # set :local_shared_files, %w(config/database.yml)
+    
+    # SSL Certificates. If you specify an SSL certificate name then
+    # the gem will create an 'https' configuration for this application
+    # TODO: Upload and install the keys on the server
+    # set :ssl_certificate, "/path/to/certificate/for/my_app.crt"
+    # set :ssl_key, "/path/to/key/for/my_app.key
+    # or
+    # set :ssl_certificate, "name_of_installed_certificate"
+
+    # SSH options. The forward agent option is used so that loopback logins
+    # with keys work properly
+    # ssh_options[:forward_agent] = true
+    
+    # Forces a Pty so that svn+ssh repository access will work. You
+    # don't need this if you are using a different SCM system. Note that
+    # ptys stop shell startup scripts from running.
+    default_run_options[:pty] = true
+
+    ## Logrotation
+    # Where the logs are stored. Defaults to <shared_path>/log
+    # set :log_dir, "central/log/path"
+    # The size at which to rotate a log. e.g 1G, 100M, 5M. Defaults to 100M
+    # set :log_max_size, "100M"
+    # How many old compressed logs to keep. Defaults to 10
+    # set :log_keep, "10"
+
+    ## Version Control System
+    # Which version control system. Defaults to subversion if there is
+    # no 'set :scm' command.
+    # set :scm, :git
+    # set :scm_username, "rails"
+    # set :scm_password, "mysecret"
+    # or be explicit
+    # set :scm, :subversion
+
+    ## Mongrel settings
+    # Host where mongrel lives. Defaults to the app server
+    # set :mongrel_host, "127.0.0.1"
+    # Port number where mongrel starts. Defaults to 9200
+    # set :mongrel_port, 9200
+    # Number of mongrel servers to start. Defaults to 2
+    # set :mongrel_servers, 2
+    
+    ## Deployment settings
+    # The brightbox gem deploys as the user 'rails' by default and
+    # into the 'production' environment. You can change these as required.
+    # set :user, "rails"
+    # set :rails_env, :production
+
+    ## Command running settings
+    # use_sudo is switched off by default so that commands are run
+    # directly as 'user' by the run command. If you switch on sudo
+    # make sure you set the :runner variable - which is the user the
+    # capistrano default tasks use to execute commands.
+    # NB. This just affects the default recipes unless you use the
+    # 'try_sudo' command to run your commands.
+    # set :use_sudo, false
+    # set :runner, user
+    
+    ## Dependencies
+    # Set the commands and gems that your application requires. e.g.
+    # depend :remote, :gem, "will_paginate", ">=2.2.2"
+    # depend :remote, :command, "brightbox"
+  FILE
+}
+
+base = ARGV.shift
+files.each do |file, content|
+  file = File.join(base, file)
+  if File.exists?(file)
+    warn "[skip] `#{file}' already exists"
+  elsif File.exists?(file.downcase)
+    warn "[skip] `#{file.downcase}' exists, which could conflict with `#{file}'"
+  elsif !File.exists?(File.dirname(file))
+    warn "[skip] directory `#{File.dirname(file)}' does not exist"
   else
-    opts.parse!(ARGV)
+    puts "[add] writing `#{file}'"
+    File.open(file, "w") { |f| f.write(content) }
   end
 end
 
-require 'brightbox/generators/loader'
-Brightbox::Generators::RailsLoader.load! @options
+puts "[done] ready for deployment!"

data/brightbox-gemspec.rb

@@ -0,0 +1,46 @@
+#    Brightbox - Easy Ruby Web Application Deployment
+#    Copyright (C) 2008, Neil Wilson, Brightbox Systems
+#
+#    This file is part of the Brightbox deployment system
+#
+#    Brightbox gem is free software: you can redistribute it and/or modify it
+#    under the terms of the GNU Affero General Public License as published
+#    by the Free Software Foundation, either version 3 of the License,
+#    or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#    Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General
+#    Public License along with this program.  If not, see
+#    <http://www.gnu.org/licenses/>.
+#
+require File.join(File.dirname(__FILE__),"lib/brightbox/version")
+def add_common(spec)
+  spec.version = Brightbox::VERSION
+  spec.authors = ["John Leach","Neil Wilson"]
+  spec.email = "support@brightbox.co.uk"
+  spec.homepage = "http://wiki.brightbox.co.uk/docs:thebrightboxgem"
+  spec.rubyforge_project = 'brightbox'
+  spec.has_rdoc = false
+end
+
+@server = Gem::Specification.new do |s|
+  add_common(s)
+  s.name = "brightbox-server-tools"
+  s.files = FileList["LICENSE", "Rakefile", "*.rb", "bin/railsapp-*","{lib,spec}/**/*.rb"].exclude(/recipe/).to_a
+  s.summary = "Brightbox Server configuration scripts"
+  s.executables = FileList["bin/railsapp-*"].sub(/bin\//,'')
+end
+
+@client = Gem::Specification.new do |s|
+  add_common(s)
+  s.name = "brightbox"
+  s.files = FileList["LICENSE", "Rakefile", "*.rb", "lib/**/*.rb","bin/brightbox"].exclude("lib/brightbox/webserver-common.rb").to_a
+  s.add_dependency("capistrano", ">= 2.3")
+  s.summary = "Brightbox rails deployment scripts for Capistrano"
+  s.executable = 'brightbox'
+end
+

data/lib/brightbox/recipes.rb

@@ -1,121 +1,22 @@
-require 'mongrel_cluster/recipes'
-require 'yaml'
-
-Capistrano.configuration(:must_exist).load do
-
-desc "Create apache config for this app on your Brightbox web servers"
-task :setup_apache, :roles => :web do
-  sudo "/usr/bin/brightbox-apache -n #{application} -d #{domain} -w #{current_path}/public -h #{mongrel_host} -p #{mongrel_port} -s #{mongrel_servers}"
-  sudo "/usr/sbin/apache2ctl -t"
-end
-
-desc "Reload apache on your Brightbox web servers"
-task :reload_apache, :roles => :web do
-  sudo "/usr/sbin/apache2ctl -t"
-  sudo "/usr/sbin/apache2ctl graceful"
-end
-
-desc "Load the rails db schema on the primary db server"
-task :load_schema, :roles => :db, :primary => true do
-  run "cd #{current_path} && #{rake} RAILS_ENV=#{(rails_env||"production").to_s} db:schema:load"
-end
-
-desc "Configure monit to handle the mongrel servers for this app"
-task :configure_mongrel_cluster, :roles => :app do
-  sudo "/usr/bin/brightbox-monit -n #{application} -r #{current_path} -e #{(rails_env||"production").to_s} -p #{mongrel_port} -s #{mongrel_servers} -h #{mongrel_host}"
-end
-
-desc "Restart the mongrel servers using monit"
-task :restart_mongrel_cluster, :roles => :app do
-  sudo "/usr/sbin/monit -g #{application} restart all"
-end
-
-desc "Start the mongrel servers using monit"
-task :start_mongrel_cluster, :roles => :app do
-  sudo "/usr/sbin/monit -g #{application} start all"
-end
-
-desc "Stop the mongrel servers using monit"
-task :stop_mongrel_cluster, :roles => :app do
-  sudo "/usr/sbin/monit -g #{application} stop all"
-end
-
-desc "Display the monit status for this app"
-task :monit_status, :roles => :app do
-  sudo "/usr/sbin/monit -g #{application} status"
-end
-
-desc "Reload the monit daemon"
-task :monit_reload, :roles => :app do
-  sudo "/usr/sbin/monit reload"
-  sleep 5
-end
-
-desc "Deploy the app to your Brightbox servers for the FIRST TIME.  Sets up apache config starts mongrel."
-task :cold_deploy do
-  transaction do
-    update_code
-    symlink
-  end
-
-  create_mysql_database # Fails if already exist to prevent data loss later
-  load_schema # WARNING: This wipes the tables
-  migrate
-  configure_mongrel_cluster
-  monit_reload
-  start_mongrel_cluster
-  setup_apache
-  reload_apache
-end
-
-desc "Rewrite the Apache and Monit configs and reloads the services"
-task :reconfigure do
-  configure_mongrel_cluster
-  monit_reload
-  restart_mongrel_cluster
-  setup_apache
-  reload_apache
-end
-
-desc "Deploy the app to your Brightbox servers"
-task :deploy do
-  transaction do
-    update_code
-    disable_web
-    stop_mongrel_cluster
-    symlink
-    start_mongrel_cluster
-  end
-
-  enable_web
-end
-
-desc "Create the mysql database named in the database.yml on the primary db server"
-task :create_mysql_database, :roles => :db, :primary => true do
- read_db_config
- if db_adapter == 'mysql'
-   run "mysql -h #{db_host} --user=#{db_user} -p --execute=\"CREATE DATABASE #{db_name}\"" do |channel, stream, data|
-     if data =~ /^Enter password:/
-       logger.info data, "[database on #{channel[:host]} asked for password]"
-       channel.send_data "#{db_password}\n" 
-     end
-   end
- end
-end
-  
-def read_db_config
-    db_config = YAML.load_file('config/database.yml')
-    set :db_adapter, db_config[(rails_env||"production").to_s]["adapter"]
-    set :db_user, db_config[(rails_env||"production").to_s]["username"]
-    set :db_password, db_config[(rails_env||"production").to_s]["password"] 
-    set :db_name, db_config[(rails_env||"production").to_s]["database"]
-    set :db_host, db_config[(rails_env||"production").to_s]["host"]
-    if db_host !~ /^sqlreadwrite/
-      logger.important "WARNING: Database host is not sqlreadwrite as per the Brightbox requirements"
-    end
-    if db_name !~ /^#{db_user}\_/
-      logger.important "WARNING: Database name is not prefixed with MySQL username as per the Brightbox requirements"
-    end
-end
-
+#    Brightbox - Easy Ruby Web Application Deployment
+#    Copyright (C) 2008, Neil Wilson, Brightbox Systems
+#
+#    This file is part of the Brightbox deployment system
+#
+#    Brightbox gem is free software: you can redistribute it and/or modify it
+#    under the terms of the GNU Affero General Public License as published
+#    by the Free Software Foundation, either version 3 of the License,
+#    or (at your option) any later version.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#    Affero General Public License for more details.
+#
+#    You should have received a copy of the GNU Affero General
+#    Public License along with this program.  If not, see
+#    <http://www.gnu.org/licenses/>.
+#
+Dir[File.join(File.dirname(__FILE__), 'recipes', '*.rb')].each do |recipe|
+  Capistrano::Configuration.instance(true).load recipe
 end