deploify 0.2.5

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in deploify.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    deploify (0.2.0)
+      bundler (>= 1.0.21)
+      capistrano (~> 2.13.5)
+      rvm-capistrano (~> 1.2.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    capistrano (2.13.5)
+      highline
+      net-scp (>= 1.0.0)
+      net-sftp (>= 2.0.0)
+      net-ssh (>= 2.0.14)
+      net-ssh-gateway (>= 1.1.0)
+    highline (1.6.15)
+    net-scp (1.0.4)
+      net-ssh (>= 1.99.1)
+    net-sftp (2.0.5)
+      net-ssh (>= 2.0.9)
+    net-ssh (2.6.2)
+    net-ssh-gateway (1.1.0)
+      net-ssh (>= 1.99.1)
+    rvm-capistrano (1.2.7)
+      capistrano (>= 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (>= 1.0.21)
+  capistrano (~> 2.13.5)
+  deploify!
+  rvm-capistrano (~> 1.2.7)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Richard Říman
+
+MIT License
+
+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/README.md

@@ -0,0 +1,2 @@
+deploify - capistrano based and deprec inspired deploy gem
+================================================================================

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/deploify.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'deploify/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "deploify"
+  gem.version       = Deploify::VERSION
+  gem.authors       = ["Richard R\314\214i\314\201man"]
+  gem.email         = ["riman.richard@gmail.com"]
+  gem.description   = "deploify - capistrano based and deprec inspired deploy solution served as a gem"
+  gem.summary       = "capistrano based and deprec inspired deploy gem"
+  gem.homepage      = "https://github.com/richardriman/deploify"
+
+  gem.required_ruby_version = ">= 1.8.7"
+
+  gem.add_development_dependency "bundler", ">= 1.0.21"
+  gem.add_development_dependency "capistrano", "~> 2.13.5"
+  gem.add_development_dependency "rvm-capistrano", "~> 1.2.7"
+
+  gem.add_dependency "bundler", ">= 1.0.21"
+  gem.add_dependency "capistrano", "~> 2.13.5"
+  gem.add_dependency "rvm-capistrano", "~> 1.2.7"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+end

data/lib/deploify/capistrano_extensions.rb

@@ -0,0 +1,189 @@
+require "capistrano"
+
+module Deploify
+
+  DEPLOIFY_TEMPLATES_BASE = File.join(File.dirname(__FILE__), "templates")
+
+  # Render template (usually a config file)
+  #
+  # Usually we render it to a file on the local filesystem.
+  # This way, we keep a copy of the config file under source control.
+  # We can make manual changes if required and push to new hosts.
+  #
+  # If the options hash contains :path then it's written to that path.
+  # If it contains :remote => true, the file will instead be written to remote targets
+  # If options[:path] and options[:remote] are missing, it just returns the rendered
+  # template as a string (good for debugging).
+  #
+  # XXX I would like to get rid of :render_template_to_file
+  # XXX Perhaps pass an option to this function to write to remote
+  #
+  def render_template(app, options={})
+    template = options[:template]
+    path = options[:path] || nil
+    remote = options[:remote] || false
+    mode = options[:mode] || 0755
+    owner = options[:owner] || nil
+    stage = exists?(:stage) ? fetch(:stage).to_s : ''
+    # replace this with a check for the file
+    unless template
+      puts "render_template() requires a value for the template!"
+      return false
+    end
+
+    # If local copies of deploifyy templates exist they will be used
+    # If you don't specify the location with the local_template_dir option
+    # it defaults to config/templates.
+    # e.g. config/templates/nginx/nginx.conf.erb
+    local_template = File.join(local_template_dir, app.to_s, template)
+    if File.exists?(local_template)
+      puts
+      puts "Using local template (#{local_template})"
+      template = ERB.new(IO.read(local_template), nil, '-')
+    else
+      template = ERB.new(IO.read(File.join(DEPLOIFY_TEMPLATES_BASE, app.to_s, template)), nil, '-')
+    end
+    rendered_template = template.result(binding)
+
+    if remote
+      # render to remote machine
+      puts 'You need to specify a path to render the template to!' unless path
+      exit unless path
+      sudo "test -d #{File.dirname(path)} || #{sudo} mkdir -p #{File.dirname(path)}"
+      std.su_put rendered_template, path, '/tmp/', :mode => mode
+      sudo "chown #{owner} #{path}" if defined?(owner)
+    elsif path
+      # render to local file
+      full_path = File.join('config', stage, app.to_s, path)
+      path_dir = File.dirname(File.expand_path(full_path))
+      if File.exists?(full_path)
+        if IO.read(full_path) == rendered_template
+          puts "[skip] Identical file exists (#{full_path})."
+          return false
+        elsif overwrite?(full_path, rendered_template)
+          File.delete(full_path)
+        else
+          puts "[skip] Not overwriting #{full_path}"
+          return false
+        end
+      end
+      FileUtils.mkdir_p "#{path_dir}" unless File.directory?(path_dir)
+      # added line above to make windows compatible
+      # system "mkdir -p #{path_dir}" if ! File.directory?(path_dir)
+      File.open(File.expand_path(full_path), 'w') { |f| f.write rendered_template }
+      puts "[done] #{full_path} written"
+    else
+      # render to string
+      return rendered_template
+    end
+  end
+
+  # Copy configs to server(s). Note there is no :pull task. No changes should
+  # be made to configs on the servers so why would you need to pull them back?
+  def push_configs(app, files)
+    app = app.to_s
+    stage = exists?(:stage) ? fetch(:stage).to_s : ''
+
+    files.each do |file|
+      full_local_path = File.join('config', stage, app, file[:path])
+      if File.exists?(full_local_path)
+        # If the file path is relative we will prepend a path to this projects
+        # own config directory for this service.
+        if file[:path][0, 1] != '/'
+          full_remote_path = File.join(deploy_to, app, file[:path])
+        else
+          full_remote_path = file[:path]
+        end
+        sudo "test -d #{File.dirname(full_remote_path)} || #{sudo} mkdir -p #{File.dirname(full_remote_path)}"
+        std.su_put File.read(full_local_path), full_remote_path, '/tmp/', :mode => file[:mode]
+        sudo "chown #{file[:owner]} #{full_remote_path}"
+      else
+        # Render directly to remote host.
+        render_template(app, file.merge(:remote => true))
+      end
+    end
+  end
+
+  def overwrite?(full_path, rendered_template)
+    if defined?(overwrite_all)
+      return overwrite_all ? true : false
+    end
+
+    puts
+    response = Capistrano::CLI.ui.ask "File exists (#{full_path}).
+    Overwrite? ([y]es, [n]o, [d]iff)" do |q|
+      q.default = 'n'
+    end
+
+    case response
+      when 'y'
+        return true
+      when 'n'
+        return false
+      when 'd'
+        require 'tempfile'
+        tf = Tempfile.new("deprec_diff")
+        tf.puts(rendered_template)
+        tf.close
+        puts
+        puts "Running diff -u current_file new_file_if_you_overwrite"
+        puts
+        system "diff -u #{full_path} #{tf.path} | less"
+        puts
+        overwrite?(full_path, rendered_template)
+    end
+  end
+
+  # create new user account on target system
+  def useradd(user, options={})
+    options[:shell] ||= "/bin/bash" # new accounts on ubuntu have been getting /bin/sh
+    switches = ''
+    switches += " --shell=#{options[:shell]} " if options[:shell]
+    unless options[:homedir] == false
+      switches += " --create-home "
+      switches += " --home #{options[:homedir]} " if options[:homedir]
+    end
+    switches += " --gid #{options[:group]} " unless options[:group].nil?
+    invoke_command "#{sudo} mkdir -p #{File.dirname(options[:homedir])}" if options[:homedir]
+    invoke_command "grep '^#{user}:' /etc/passwd || #{sudo} /usr/sbin/useradd #{switches} #{user}", :via => run_method
+  end
+
+  # create a new group on target system
+  def groupadd(group, options={})
+    via = options.delete(:via) || run_method
+    invoke_command "grep '#{group}:' /etc/group || #{sudo} /usr/sbin/groupadd #{group}", :via => via
+  end
+
+  # add group to the list of groups this user belongs to
+  def add_user_to_group(user, group)
+    invoke_command "groups #{user} | grep ' #{group} ' || #{sudo} /usr/sbin/usermod -G #{group} -a #{user}", :via => run_method
+  end
+
+  # create directory if it doesn't already exist
+  # set permissions and ownership
+  # XXX move mode, path and
+  def mkdir(path, options={})
+    via = options.delete(:via) || :run
+    # XXX need to make sudo commands wrap the whole command (sh -c ?)
+    # XXX removed the extra 'sudo' from after the '||' - need something else
+    invoke_command "test -d #{path} || #{sudo if via == :sudo} mkdir -p #{path}"
+    invoke_command "chmod #{sprintf("%3o",options[:mode] || 0755)} #{path}", :via => via if options[:mode]
+    invoke_command "chown -R #{options[:owner]} #{path}", :via => via if options[:owner]
+    groupadd(options[:group], :via => via) if options[:group]
+    invoke_command "chgrp -R #{options[:group]} #{path}", :via => via if options[:group]
+  end
+
+  def install_deps(packages=[])
+    apt.install({:base => Array(packages)}, :stable)
+  end
+
+  def teardown_connections
+    sessions.keys.each do |server|
+      sessions[server].close
+      sessions.delete(server)
+    end
+  end
+
+end
+
+Capistrano.plugin :_deploify, Deploify

data/lib/deploify/recipes/deploify.rb

@@ -0,0 +1,171 @@
+# Copyright 2012 by Richard Riman. All rights reserved.
+
+require "bundler/capistrano"
+require "rvm/capistrano"
+
+Capistrano::Configuration.instance(:must_exist).load do
+
+  # Set the value if not already set
+  # This method is accessible to all recipe files
+  # Defined and used by capistrano/deploy tasks
+  def _cset(name, *args, &block)
+    unless exists?(name)
+      set(name, *args, &block)
+    end
+  end
+
+  alias :default :_cset
+
+  # we allways use bundler, so change rake call
+  _cset :rake, lambda { "#{fetch(:bundle_cmd, "bundle")} exec rake" }
+
+  default_run_options[:pty] = true
+
+  set :local_template_dir, File.join("config", "templates")
+
+  # The following two Constants contain details of the configuration
+  # files used by each service. They're used when generating config
+  # files from templates and when configs files are pushed out to servers.
+  #
+  # They are populated by the recipe file for each service
+  #
+  SYSTEM_CONFIG_FILES  = {} # e.g. httpd.conf
+  PROJECT_CONFIG_FILES = {} # e.g. projectname-httpd-vhost.conf
+
+  # deploify defines some generic recipes for common services
+  # including web, app and database servers
+  #
+  # They default to my current favourites which you can override
+  #
+  # Service options
+  CHOICES_WEBSERVER = [:nginx]
+  CHOICES_APPSERVER = [:passenger, :thin] # :puma, :unicorn
+  CHOICES_DATABASE  = [:mysql] # :mongodb
+  #
+  # Service defaults
+  set :web_server_type, :nginx
+  set :app_server_type, :passenger
+  set :db_server_type,  :mysql
+
+  # we always use RMV, but we must set :system, because RVM default is :user
+  set :rvm_type, :system
+  set(:rvm_ruby_string) do
+    Capistrano::CLI.ui.choose do |menu|
+      menu.prompt = "Please choose RVM Ruby version for this application"
+      menu.choices("1.8.6", "1.8.7", "ree", "1.9.2", "1.9.3")
+    end
+  end
+
+  set :use_monit, true
+
+  # Prompt user for missing values if not supplied
+  set(:application) do
+    Capistrano::CLI.ui.ask "Enter name of project (no spaces)" do |q|
+      q.validate = /^[0-9a-z_]*$/
+    end
+  end
+
+  set(:domain) do
+    Capistrano::CLI.ui.ask "Enter domain name for project" do |q|
+      q.validate = /^[0-9a-z_\-\.]*$/
+    end
+  end
+
+  # some tasks run commands requiring special user privileges on remote servers
+  # these tasks will run the commands with:
+  #   :invoke_command "command", :via => run_method
+  # override this value if sudo is not an option
+  # in that case, your use will need the correct privileges
+  set :run_method, :sudo
+
+  # deploy from TAG stuff
+
+  set :deployable_without_tag, false              # only used WITHOUT multi-staging
+  set :stages, %w(production staging)             # default stages (only used WITH multi-staging)
+  set :stages_deployable_without_tag, %w(staging) # only used WITH multi-staging
+
+  set(:branch) do
+    unless exists?(:stage)
+      # single stage configuration
+      if deployable_without_tag
+        tag = `git branch | grep '*' | awk '{ print $2 }'`.split[0]
+      else
+        tag = Capistrano::CLI.ui.ask("TAG to deploy (make sure to push the tag first): ")
+      end
+    else
+      # multi-staging configuration
+      if stages_deployable_without_tag.include?(fetch(:stage).to_s)
+        tag = `git branch | grep '*' | awk '{ print $2 }'`.split[0]
+      else
+        tag = Capistrano::CLI.ui.ask("TAG from which we deploy on stage '#{fetch(:stage)}' (make sure to push the tag first): ")
+      end
+    end
+  end
+
+  # rails deploy stuff
+  set :apps_root,     "/var/www" # parent dir for apps
+  set(:deploy_to)     { File.join(apps_root, application) } # dir for current app
+  set(:current_path)  { File.join(deploy_to, "current") }
+  set(:shared_path)   { File.join(deploy_to, "shared") }
+
+  # more rails deploy stuff
+  set :user,  "deploy"  # user who is deploying
+  set :group, "deploy"  # deployment group
+  set(:web_server_aliases) { domain.match(/^www/) ? [] : ["www.#{domain}"] }
+
+  # rails deploy GIT stuff
+  set :scm, :git
+  set :deploy_via, :remote_cache
+  set :copy_exclude, ['.git', '.rvmrc']
+  set(:repository) do
+    Capistrano::CLI.ui.ask "Enter repository URL for project"
+  end
+
+  # webserver stuff
+  set :force_domain_with_www, false
+
+  on :load, "deploify:connect_canonical_tasks"
+
+  namespace :deploify do
+
+    task :connect_canonical_tasks do
+      # link application specific recipes into canonical task names
+      # e.g. deprec:web:restart => deprec:nginx:restart
+      namespaces_to_connect = {
+        :web  => :web_server_type,
+        :app  => :app_server_type,
+        :db   => :db_server_type
+      }
+      metaclass = class << self; self; end
+      namespaces_to_connect.each do |server, choice|
+        server_type = send(choice).to_sym
+        if server_type != :none
+          metaclass.send(:define_method, server) { namespaces[server] }
+          namespaces[server] = deploify.send(server_type)
+        end
+      end
+    end
+
+  end # namespace :deploify
+
+  namespace :deploy do
+
+    task :start, :roles => :app, :except => { :no_release => true } do
+      run "#{sudo} service #{app_server_type}-#{application} start"
+    end
+
+    task :stop, :roles => :app, :except => { :no_release => true } do
+      run "#{sudo} service #{app_server_type}-#{application} stop"
+    end
+
+    task :restart, :roles => :app, :except => { :no_release => true } do
+      run "#{sudo} service #{app_server_type}-#{application} graceful"
+    end
+
+    task :force_restart, :roles => :app, :except => { :no_release => true } do
+      run "#{sudo} service #{app_server_type}-#{application} restart"
+    end
+
+  end # namespace :deploy
+
+end

data/lib/deploify/recipes/mongodb.rb

@@ -0,0 +1,15 @@
+# Copyright 2012 by Richard Riman. All rights reserved.
+
+Capistrano::Configuration.instance(:must_exist).load do
+
+  namespace :deploify do
+
+    namespace :mongodb do
+
+
+
+    end # namespace :mongodb
+
+  end # namespace :deploify
+
+end

data/lib/deploify/recipes/monit.rb

@@ -0,0 +1,84 @@
+# Copyright 2012 by Richard Riman. All rights reserved.
+
+Capistrano::Configuration.instance(:must_exist).load do
+
+  # we use monit primary to control passenger processes so the tasks
+  # are restricted to :app. You may use it for other processes.
+  # In this case, specify HOSTS=hostname on the command line or use:
+  #   for_roles(:role_name) { top.deploify.monit.task_name }
+  # in your recipes.
+
+  set :monit_timeout_interval, 120
+  set :monit_conf_dir, "/etc/monit/conf.d"
+  # TODO
+  # set :monit_alert_recipients, %w(monitoring@example.com)
+  # set :monit_timeout_recipients, %w(monitoring@example.com)
+
+  namespace :deploify do
+
+    namespace :monit do
+
+      PROJECT_CONFIG_FILES[:monit] = [
+        { :template => "monit.conf.erb",
+          :path => "monit.conf",
+          :mode => 0644,
+          :owner => "root:root" }
+        ]
+
+      desc <<-DESC
+        Generate monit application config from template. Note that this does not
+        push the config to the server, it merely generates required
+        configuration files. These should be kept under source control.
+      DESC
+      task :config_gen_project do
+        PROJECT_CONFIG_FILES[:monit].each do |file|
+          _deploify.render_template(:monit, file)
+        end
+      end
+
+      desc "Push application monit config files to server"
+      task :config_project, :roles => :app do
+        _deploify.push_configs(:monit, PROJECT_CONFIG_FILES[:monit])
+      end
+
+      desc "Start Monit"
+      task :start, :roles => :app do
+        send(run_method, "service monit start")
+      end
+
+      task :activate do
+        top.deploify.monit.activate_project
+      end
+
+      desc "Activate application monit config and reload monit"
+      task :activate_project, :roles => :app do
+        run "#{sudo} ln -sf #{deploy_to}/monit/monit.conf #{monit_conf_dir}/#{application}"
+        top.deploify.monit.reload
+      end
+
+      desc "Dectivate application monit config and reload monit"
+      task :deactivate_project, :roles => :app do
+        run "#{sudo} rm -f #{monit_conf_dir}/#{application}; exit 0"
+        top.deploify.monit.reload
+      end
+
+      desc "Stop Monit"
+      task :stop, :roles => :app  do
+        send(run_method, "service monit stop")
+      end
+
+      desc "Restart Monit"
+      task :restart, :roles => :app  do
+        send(run_method, "service monit restart")
+      end
+
+      desc "Reload Monit"
+      task :reload, :roles => :app  do
+        send(run_method, "service monit restart")
+      end
+
+    end # namespace :monit
+
+  end # namespace :deploify
+
+end

data/lib/deploify/recipes/mysql.rb

@@ -0,0 +1,85 @@
+# Copyright 2006-2008 by Mike Bailey. All rights reserved.
+# Copyright 2012 by Richard Riman. All rights reserved.
+
+Capistrano::Configuration.instance(:must_exist).load do
+
+  set :mysql_admin_user, "deploy"
+  set(:mysql_admin_pass) { Capistrano::CLI.password_prompt "Enter database password for '#{mysql_admin_user}':" }
+
+  namespace :deploify do
+
+    namespace :mysql do
+
+      desc "Start Mysql"
+      task :start, :roles => :db do
+        send(run_method, "service mysql start")
+      end
+
+      desc "Stop Mysql"
+      task :stop, :roles => :db do
+        send(run_method, "service mysql stop")
+      end
+
+      desc "Restart Mysql"
+      task :restart, :roles => :db do
+        send(run_method, "service mysql restart")
+      end
+
+      desc "Reload Mysql"
+      task :reload, :roles => :db do
+        send(run_method, "service mysql reload")
+      end
+
+      desc "Create a database"
+      task :create_database, :roles => :db do
+        cmd = "CREATE DATABASE IF NOT EXISTS #{db_name}"
+        run "mysql -u #{mysql_admin_user} -p -e '#{cmd}'" do |channel, stream, data|
+          if data =~ /^Enter password:/
+             channel.send_data "#{mysql_admin_pass}\n"
+           end
+        end
+      end
+
+      desc "Grant user access to database"
+      task :grant_user_access_to_database, :roles => :db do
+        cmd = "GRANT ALL PRIVILEGES ON #{db_name}.* TO '#{db_user}'@localhost IDENTIFIED BY '#{db_password}';"
+        run "mysql -u #{mysql_admin_user} -p #{db_name} -e \"#{cmd}\"" do |channel, stream, data|
+          if data =~ /^Enter password:/
+             channel.send_data "#{mysql_admin_pass}\n"
+           end
+        end
+      end
+
+    end # namespace :mysql
+
+  end # namespace :deploify
+
+end
+
+#
+# Setup replication
+#
+
+# setup user for repl
+# GRANT REPLICATION SLAVE ON *.* TO 'repl'@'%.yourdomain.com' IDENTIFIED BY 'slavepass';
+
+# get current position of binlog
+# mysql> FLUSH TABLES WITH READ LOCK;
+# Query OK, 0 rows affected (0.00 sec)
+#
+# mysql> SHOW MASTER STATUS;
+# +------------------+----------+--------------+------------------+
+# | File             | Position | Binlog_Do_DB | Binlog_Ignore_DB |
+# +------------------+----------+--------------+------------------+
+# | mysql-bin.000012 |      296 |              |                  |
+# +------------------+----------+--------------+------------------+
+# 1 row in set (0.00 sec)
+#
+# # get current data
+# mysqldump --all-databases --master-data >dbdump.db
+#
+# UNLOCK TABLES;
+
+
+# Replication Features and Issues
+# http://dev.mysql.com/doc/refman/5.0/en/replication-features.html