app-deployer 0.0.3

data/lib/app-deployer/framework/cakephp/templates/database.php.erb

@@ -0,0 +1,14 @@
+<?php
+class DATABASE_CONFIG {
+    public $default = array(
+        'datasource' => '<%= datasource %>',
+        'persistent' => '<%= persistent %>',
+        'host'       => '<%= host %>',
+        'login'      => '<%= login %>',
+        'password'   => '<%= password %>',
+        'database'   => '<%= database %>',
+        'prefix'     => '<%= prefix %>',
+        'encoding'   => '<%= encoding %>'
+    );
+}
+?>

data/lib/app-deployer/framework/lithium/lithium.rb

@@ -0,0 +1,213 @@
+Capistrano::Configuration.instance(:must_exist).load do
+
+  require 'erb'
+
+  # =========================================================================
+  # Settings
+  # =========================================================================
+
+  _cset :shared_app_dirs, []
+  _cset(:lithium_repo)    { "https://github.com/UnionOfRAD/lithium.git" }
+  _cset(:lithium_branch)  { "master" }
+  _cset :shared_children, %w(libraries tmp)
+  _cset :tmp_children,    %w(cache logs tests)
+  _cset :cache_children,  %w(templates)
+  _cset :logs_files,      %w(debug error)
+  _cset(:database_folder) { File.join(shared_path, "config/bootstrap") }
+  _cset(:database_path)   { File.join("#{database_folder}", "connections.php") }
+  _cset(:tmp_path)        { File.join(shared_path, "tmp") }
+  _cset(:cache_path)      { File.join(tmp_path, "cache") }
+  _cset(:logs_path)       { File.join(tmp_path, "logs") }
+
+  # =========================================================================
+  # Hooks
+  # =========================================================================
+
+    after('deploy:setup', 'lithium:setup')
+    after('deploy:create_symlink', 'lithium:create_symlink')
+
+    ["composer:install", "composer:update"].each do |action|
+      before action do
+        if copy_vendors
+          composer.copy_vendors
+        end
+      end
+    end
+
+    after "deploy:finalize_update" do
+      if use_composer
+        if update_vendors
+          composer.update
+        else
+          composer.install
+        end
+      end
+      if clear_cache
+        lithium.cache.clear
+      end
+    end
+
+  # =========================================================================
+  # Tasks
+  # =========================================================================
+
+  namespace :lithium do
+
+    desc <<-DESC
+    Prepares server for deployment of a lithium application. \
+
+    By default, it will create a shallow clone of the lithium repository \
+    inside #{shared_path}/libraries/lithium and run deploy:lithium:update.
+    DESC
+    task :setup do
+      transaction do
+        unless use_composer
+          run "cd #{shared_path}/libraries && git clone --depth 1 #{lithium_repo} lithium"
+          checkout
+        end
+        connections.setup
+        shared.setup
+      end
+    end
+
+    desc <<-DESC
+    Force lithium installation to checkout a new branch/tag.
+    DESC
+    task :checkout do
+      on_rollback { run "rm -rf #{shared_path}/lithium; true" }
+      stream "cd #{shared_path}/lithium && git checkout -q #{lithium_branch}"
+    end
+
+    desc <<-DESC
+    Update the lithium repository to the latest version.
+    DESC
+    task :update do
+      stream "cd #{shared_path}/libraries/lithium && git pull"
+    end
+
+    desc <<-DESC
+    This is a task that will get called from the deploy:create_symlink task
+    It runs just before the release is symlinked to the current directory
+
+    You should use it to create symlinks to things like your database config \
+    and any shared directories or files that your app uses
+    DESC
+    task :create_symlink do
+      transaction do
+        connections.create_symlink
+        shared.create_symlink
+      end
+    end
+
+    # Framework specific tasks
+
+    # Caching
+    namespace :cache do
+      desc <<-DESC
+      Clears cache and sub-directories.
+
+      Recursively finds all files in :cache_path and runs `rm -f` on each. If a file \
+      is renamed/removed after it was found but before it removes it, no error \
+      will prompt (-ignore_readdir_race). If symlinks are found, they will not be followed
+
+      You will rarely need to call this task directly; instead, use the `deploy' \
+      task (which performs a complete deploy, including `lithium:cache:clear')
+      DESC
+      task :clear, :roles => :web, :except => { :no_release => true } do
+        run "#{try_sudo} find -P #{cache_path} -ignore_readdir_race -type f -name '*' -exec rm -f {} \\;"
+      end
+    end
+
+    # Connections config
+    namespace :connections do
+      desc <<-DESC
+      Generates lithium connections file in #{shared_path}/config/bootstrap/ \
+      and symlinks #{current_path}/config/bootstrap/connections.php to it
+      DESC
+      task :setup, :roles => :web, :except => { :no_release => true } do
+          on_rollback { run "rm -f #{database_path}; true" }
+          puts "Connections setup"
+
+          prompt_with_default(:type, "database|MongoDb|http")
+          case type
+            when 'database'
+              prompt_with_default(:login, user)
+              set :password, Capistrano::CLI.password_prompt("password:")
+              prompt_with_default(:encoding, 'UTF-8')
+          end
+
+          prompt_with_default(:host, "127.0.0.1")
+          prompt_with_default(:database, application)
+
+          template = File.read(File.join(File.dirname(__FILE__), "templates", "connections.php.erb"))
+          result = ERB.new(template).result(binding)
+
+          run "#{try_sudo} mkdir -p #{database_folder}"
+          put(result, "#{database_path}", :mode => 0644, :via => :scp)
+      end
+
+      desc <<-DESC
+      Symlinks the connections file.
+      DESC
+      task :create_symlink, :roles => :web, :except => { :no_release => true } do
+          run "#{try_sudo} ln -s #{database_path} #{current_path}/config/bootstrap/connections.php"
+      end
+    end
+
+    # Shared directories and files
+    namespace :shared do
+      desc <<-DESC
+      Creates shared folders on the server
+      DESC
+      task :setup do
+        dirs = [deploy_to, releases_path, shared_path]
+        dirs += shared_children.map { |d| File.join(shared_path, d) }
+        tmp_dirs = tmp_children.map { |d| File.join(tmp_path, d) }
+        tmp_dirs += cache_children.map { |d| File.join(cache_path, d) }
+        run "echo #{dirs} && #{try_sudo} mkdir -p #{(dirs + tmp_dirs).join(' ')} && #{try_sudo} chmod -R 777 #{tmp_path}" if (!user.empty?)
+
+        if shared_app_dirs
+          shared_app_dirs.each { | link | run "#{try_sudo} mkdir -p #{shared_path}/#{link}" }
+        end
+      end
+
+      desc <<-DESC
+      Symlinks all shared files and folders
+      DESC
+      task :create_symlink do
+        run "ln -s #{shared_path}/tmp #{latest_release}/resources/tmp";
+        if shared_app_dirs
+          shared_app_dirs.each { | link | run "ln -nfs #{shared_path}/#{link} #{current_path}/#{link}" }
+        end
+      end
+    end
+
+    # Logs
+    namespace :log do
+      desc <<-DESC
+      Clears logs and sub-directories
+
+      Recursively finds all files in :logs_path and runs `rm -f` on each. If a file \
+      is renamed/removed after it was found but before it removes it, no error \
+      will prompt (-ignore_readdir_race). If symlinks are found, they will not be followed
+      DESC
+      task :clear, :roles => :web, :except => { :no_release => true } do
+        run "#{try_sudo} find -P #{logs_path} -ignore_readdir_race -type f -name '*' -exec rm -f {} \\;"
+      end
+
+      desc <<-DESC
+      Streams the result of `tail -f` on all :logs_files \
+
+      By default, the files are `debug` and `error`. You can add your own \
+      in config/deploy.rb
+
+      set :logs_files %w(debug error my_log_file)
+      DESC
+      task :tail, :roles => :web, :except => { :no_release => true } do
+        files = logs_files.map { |d| File.join(logs_path, d) }
+        stream "#{try_sudo} tail -f #{files.join(' ')}"
+      end
+    end
+
+  end
+end

data/lib/app-deployer/framework/lithium/templates/connections.php.erb

@@ -0,0 +1,64 @@
+<?php
+/**
+ * Lithium: the most rad php framework
+ *
+ * @copyright     Copyright 2012, Union of RAD (http://union-of-rad.org)
+ * @license       http://opensource.org/licenses/bsd-license.php The BSD License
+ */
+
+/**
+ * ### Configuring backend database connections
+ *
+ * Lithium supports a wide variety relational and non-relational databases, and is designed to allow
+ * and encourage you to take advantage of multiple database technologies, choosing the most optimal
+ * one for each task.
+ *
+ * As with other `Adaptable`-based configurations, each database configuration is defined by a name,
+ * and an array of information detailing what database adapter to use, and how to connect to the
+ * database server. Unlike when configuring other classes, `Connections` uses two keys to determine
+ * which class to select. First is the `'type'` key, which specifies the type of backend to
+ * connect to. For relational databases, the type is set to `'database'`. For HTTP-based backends,
+ * like CouchDB, the type is `'http'`. Some backends have no type grouping, like MongoDB, which is
+ * unique and connects via a custom PECL extension. In this case, the type is set to `'MongoDb'`,
+ * and no `'adapter'` key is specified. In other cases, the `'adapter'` key identifies the unique
+ * adapter of the given type, i.e. `'MySql'` for the `'database'` type, or `'CouchDb'` for the
+ * `'http'` type. Note that while adapters are always specified in CamelCase form, types are
+ * specified either in CamelCase form, or in underscored form, depending on whether an `'adapter'`
+ * key is specified. See the examples below for more details.
+ *
+ * ### Multiple environments
+ *
+ * As with other `Adaptable` classes, `Connections` supports optionally specifying different
+ * configurations per named connection, depending on the current environment. For information on
+ * specifying environment-based configurations, see the `Environment` class.
+ *
+ * @see lithium\core\Adaptable
+ * @see lithium\core\Environment
+ */
+use lithium\data\Connections;
+<% case type
+   when 'database' %>
+Connections::add('default', array(
+    'type'     => 'database',
+    'adapter'  => 'MySql',
+    'host'     => '<%= host %>',
+    'login'    => '<%= login %>',
+    'password' => '<%= password %>',
+    'database' => '<%= database %>',
+    'encoding' => '<%= encoding %>'
+));
+<% when 'http' %>
+Connections::add('default', array(
+  'type'     => 'http',
+  'adapter'  => 'CouchDb',
+  'host'     => '<%= host %>',
+  'database' => '<%= database %>'
+));
+<% else %>
+Connections::add('default', array(
+   'type'     => 'MongoDb',
+   'host'     => '<%= host %>',
+   'database' => '<%= database %>'
+));
+<% end %>
+?>

data/lib/app-deployer/helpers.rb

@@ -0,0 +1,142 @@
+# encoding: utf-8
+Capistrano::Configuration.instance(:must_exist).load do
+  # =========================================================================
+  # These are helper methods that will be available to your recipes.
+  # =========================================================================
+
+  def _cset(name, *args, &block)
+    unless exists?(name)
+      set(name, *args, &block)
+    end
+  end
+
+  # Asks the shell for a response or else uses the default if nothing
+  # is entered
+  def prompt_with_default(var, default, &block)
+    set(var) do
+      Capistrano::CLI.ui.ask("#{var} [#{default}] : ", &block)
+    end
+    set var, default if eval("#{var.to_s}.empty?")
+  end
+
+  # Check to see if a file exists
+  def remote_file_exists?(full_path)
+  	'true' ==  capture("if [ -e #{full_path} ]; then echo 'true'; fi").strip
+  end
+
+  # Auxiliary helper method for the `deploy:check' task. Lets you set up your
+  # own dependencies.
+  def depend(location, type, *args)
+    deps = fetch(:dependencies, {})
+    deps[location] ||= {}
+    deps[location][type] ||= []
+    deps[location][type] << args
+    set :dependencies, deps
+  end
+
+  # Temporarily sets an environment variable, yields to a block, and restores
+  # the value when it is done.
+  def with_env(name, value)
+    saved, ENV[name] = ENV[name], value
+    yield
+  ensure
+    ENV[name] = saved
+  end
+
+  # logs the command then executes it locally.
+  # returns the command output as a string
+  def run_locally(cmd)
+    logger.trace "executing locally: #{cmd.inspect}" if logger
+    output_on_stdout = nil
+    elapsed = Benchmark.realtime do
+      output_on_stdout = `#{cmd}`
+    end
+    if $?.to_i > 0 # $? is command exit code (posix style)
+      raise Capistrano::LocalArgumentError, "Command #{cmd} returned status code #{$?}"
+    end
+    logger.trace "command finished in #{(elapsed * 1000).round}ms" if logger
+    output_on_stdout
+  end
+
+  # If a command is given, this will try to execute the given command, as
+  # described below. Otherwise, it will return a string for use in embedding in
+  # another command, for executing that command as described below.
+  #
+  # If :run_method is :sudo (or :use_sudo is true), this executes the given command
+  # via +sudo+. Otherwise is uses +run+. If :as is given as a key, it will be
+  # passed as the user to sudo as, if using sudo. If the :as key is not given,
+  # it will default to whatever the value of the :admin_runner variable is,
+  # which (by default) is unset.
+  #
+  # THUS, if you want to try to run something via sudo, and what to use the
+  # root user, you'd just to try_sudo('something'). If you wanted to try_sudo as
+  # someone else, you'd just do try_sudo('something', :as => "bob"). If you
+  # always wanted sudo to run as a particular user, you could do
+  # set(:admin_runner, "bob").
+  def try_sudo(*args)
+    options = args.last.is_a?(Hash) ? args.pop : {}
+    command = args.shift
+    raise ArgumentError, "too many arguments" if args.any?
+
+    as = options.fetch(:as, fetch(:admin_runner, nil))
+    via = fetch(:run_method, :sudo)
+    if command
+      invoke_command(command, :via => via, :as => as)
+    elsif via == :sudo
+      sudo(:as => as)
+    else
+      ""
+    end
+  end
+
+  # Same as sudo, but tries sudo with :as set to the value of the :runner
+  # variable (which defaults to "app").
+  def try_runner(*args)
+    options = args.last.is_a?(Hash) ? args.pop : {}
+    args << options.merge(:as => fetch(:runner, "app"))
+    try_sudo(*args)
+  end
+
+
+  def pretty_print(msg)
+    if logger.level == Capistrano::Logger::IMPORTANT
+      pretty_errors
+
+      msg = msg.slice(0, 57)
+      msg << '.' * (60 - msg.size)
+      print msg
+    else
+      puts msg.green
+    end
+  end
+
+  def puts_ok
+    if logger.level == Capistrano::Logger::IMPORTANT && !$error
+      puts '✔'.green
+    end
+
+    $error = false
+  end
+
+  def pretty_errors
+    if !$pretty_errors_defined
+      $pretty_errors_defined = true
+
+      class << $stderr
+        @@firstLine = true
+        alias _write write
+
+        def write(s)
+          if @@firstLine
+            s = '✘' << "\n" << s
+            @@firstLine = false
+          end
+
+          _write(s.red)
+          $error = true
+        end
+      end
+    end
+  end
+
+end

data/lib/app-deployer/mysql/mysql.rb

@@ -0,0 +1,42 @@
+Capistrano::Configuration.instance(:must_exist).load do
+  namespace :mysql do
+    desc <<-DESC
+    Creates MySQL database, database user and grants permissions on DB servers
+    DESC
+    task :create, :roles => :db, :except => { :no_releases => true } do
+    	require 'erb'
+      prompt_with_default(:mysql_admin_user, 'root')
+    	_cset :mysql_admin_password, Capistrano::CLI.password_prompt("password:")
+      prompt_with_default(:mysql_grant_priv_type, 'ALL')
+      prompt_with_default(:mysql_grant_locations, 'localhost')
+      prompt_with_default(:db_login, user)
+    	_cset :db_password, Capistrano::CLI.password_prompt("password:")
+      prompt_with_default(:db_name, application)
+      prompt_with_default(:db_encoding, 'utf8')
+
+    	set :tmp_filename, File.join(shared_path, "config/create_db_#{db_name}.sql") 
+
+    	template = File.read(File.join(File.dirname(__FILE__), "../templates", "create_database.sql.erb"))
+    	result = ERB.new(template).result(binding)
+
+    	put(result, "#{tmp_filename}", :mode => 0644, :via => :scp)
+
+    	run "mysql -u #{mysql_admin_user} -p#{mysql_admin_password} < #{tmp_filename}"
+    	run "#{try_sudo} rm #{tmp_filename}"
+    end
+
+    desc <<-DESC
+    Exports MySQL database and copies it to the shared directory
+    DESC
+    task :export, :roles => :db, :except => { :no_releases => true } do
+      prompt_with_default(:mysql_admin_user, 'root')
+    	_cset :mysql_admin_password, Capistrano::CLI.password_prompt("password:")
+      database = Capistrano::CLI.ui.ask("Which database should we export: ")
+      timestamp = Time.now.utc.strftime("%Y%m%d%H%M%S")
+      run "mysqldump -u #{mysql_admin_user} -p #{mysql_admin_password} > #{database}-#{timestamp}.sql"
+      download "#{database}-#{timestamp}.sql", "~/#{database}-#{timestamp}.sql"
+      logger.info "Database dump has been downloaded to ~/#{database}-#{timestamp}.sql"
+      run "rm #{database}-#{timestamp}.sql"
+    end
+  end    
+end