visfleet-deprec 2.1.4

data/lib/deprec/recipes/svn.rb

@@ -0,0 +1,171 @@
+# Copyright 2006-2008 by Mike Bailey. All rights reserved.
+require 'fileutils'
+require 'uri'
+
+# http://svnbook.red-bean.com/en/1.4/svn-book.html#svn.serverconfig.choosing.apache
+
+Capistrano::Configuration.instance(:must_exist).load do 
+  namespace :deprec do 
+    namespace :svn do
+  
+      set :scm_group, 'scm'
+  
+      # Extract svn attributes from :repository URL
+      # 
+      # Two examples of :repository entries are:
+      #
+      #   set :repository, 'svn+ssh://scm.deprecated.org/var/svn/deprec/trunk'
+      #   set :repository, 'file:///tmp/svn/deprec/trunk'
+      #
+      # This has only been tested with svn+ssh but file: should work.
+      #
+      set (:svn_scheme) { URI.parse(repository).scheme }  
+      set (:svn_host)   { URI.parse(repository).host }
+      set (:repos_path) { URI.parse(repository).path }
+      set (:repos_root) { 
+        URI.parse(repository).path.sub(/\/(trunk|tags|branches)$/, '') 
+      }
+  
+      # account name to perform actions on (such as granting access to an account)
+      # this is a hack to allow us to optionally pass a variable to tasks 
+      set (:svn_account) do
+        Capistrano::CLI.ui.ask 'account name'
+      end
+  
+      set(:svn_backup_dir) { File.join(backup_dir, 'svn') }
+  
+      desc "Install Subversion"
+      task :install do
+        install_deps
+        # XXX should really check if apache has already been installed
+        # XXX can do that when we move to rake
+        # deprec2.download_src(src_package, src_dir)
+        # deprec2.install_from_src(src_package, src_dir)
+      end
+  
+      desc "install dependencies for Subversion"
+      task :install_deps do
+        apt.install( {:base => %w(subversion)}, :stable )
+        # XXX deprec1 - was building from source to get subversion-1.4.5 onto dapper. Compiled swig bindings for trac
+        # apt.install( {:base => %w(build-essential wget libneon25 libneon25-dev swig python-dev libexpat1-dev)}, :stable )
+      end
+  
+      desc "grant a user access to svn repos"
+      task :grant_user_access, :roles => :scm do
+        # creates account, scm_group and adds account to group
+        deprec2.useradd(svn_account)
+        deprec2.groupadd(scm_group) 
+        deprec2.add_user_to_group(svn_account, scm_group)
+      end
+  
+      desc "Create subversion repository and import project into it"
+      task :setup, :roles => :scm do 
+        create_repos
+        import
+      end
+  
+      desc "Create a subversion repository"
+      task :create_repos, :roles => :scm do
+        set :svn_account, top.user
+        grant_user_access
+        deprec2.mkdir(repos_root, :mode => 02775, :group => scm_group, :via => :sudo)
+        sudo "svnadmin verify #{repos_root} > /dev/null 2>&1 || sudo svnadmin create #{repos_root}"
+        sudo "chmod -R g+w #{repos_root}"
+      end
+  
+      # Adapted from code in Bradley Taylors RailsMachine gem
+      desc "Import project into subversion repository."
+      task :import, :roles => :scm do 
+        new_path = "../#{application}"
+        tags = repository.sub("trunk", "tags")
+        branches = repository.sub("trunk", "branches")
+        puts "Adding branches and tags"
+        system "svn mkdir -m 'Adding tags and branches directories' #{tags} #{branches}"
+        puts "Importing application."
+        system "svn import #{repository} -m 'Import'"
+        cwd = Dir.getwd
+        puts "Moving application to new directory"
+        Dir.chdir '../'
+        system "mv #{cwd} #{cwd}.imported"
+        puts "Checking out application."
+        system "svn co #{repository} #{application}"
+        Dir.chdir application
+        remove_log_and_tmp
+        puts "Your repository is: #{repository}" 
+      end
+  
+      # Lifted from Bradley Taylors RailsMachine gem
+      desc "remove and ignore log files and tmp from subversion"
+      task :remove_log_and_tmp, :roles => :scm  do
+        puts "removing log directory contents from svn"
+        system "svn remove log/*"
+        puts "ignoring log directory"
+        system "svn propset svn:ignore '*.log' log/"
+        system "svn update log/"
+        puts "removing contents of tmp sub-directorys from svn"
+        system "svn remove tmp/cache/*"
+        system "svn remove tmp/pids/*"
+        system "svn remove tmp/sessions/*"
+        system "svn remove tmp/sockets/*"
+        puts "ignoring tmp directory"
+        system "svn propset svn:ignore '*' tmp/cache"
+        system "svn propset svn:ignore '*' tmp/pids"
+        system "svn propset svn:ignore '*' tmp/sessions"
+        system "svn propset svn:ignore '*' tmp/sockets"
+        system "svn update tmp/"
+        puts "committing changes"
+        system "svn commit -m 'Removed and ignored log files and tmp'"
+      end
+  
+      # desc "Cache svn name and password on the server. Useful for http-based repositories."
+      task :cache_credentials do
+        run_with_input "svn list #{repository}"
+      end
+  
+      desc "create backup of trac repository"
+      task :backup, :roles => :scm do
+        # http://svnbook.red-bean.com/nightly/en/svn.reposadmin.maint.html#svn.reposadmin.maint.backup
+        # XXX do we need this? insane!
+        # echo "REPOS_BASE=/var/svn" > ~/.svntoolsrc
+        DATE=`date +%Y%m%d-%a`
+    
+        timestamp = Time.now.strftime("%Y%m%d-%a")
+        deprec2.mkdir(svn_backup_dir, :owner => :root, :group => :deploy, :mode => 0775, :via => :sudo)
+        dest_dir = File.join(svn_backup_dir, "#{application}_#{timestamp}")
+        sudo "svnadmin hotcopy #{repos_root} #{dest_dir}"
+      end
+
+      task :restore, :roles => :scm do
+        # prompt user to select from list of locally stored backups
+        # tracd_stop
+        # copy out backup
+      end
+  
+  
+      # XXX TODO
+      # desc "backup repository" 
+      # task :svn_backup_respository, :roles => :scm do
+      #   puts "read http://svnbook.red-bean.com/nightly/en/svn-book.html#svn.reposadmin.maint.backup"
+      # end
+
+      end 
+  end
+end
+
+# svnserve setup
+# I've previously used ssh exclusively I've decided svnserve is a reasonable choice for collaboration on open source projects.
+# It's easier to setup than apache/ssl webdav access.
+#
+# sudo useradd svn
+# sudo mkdir -p /var/svn/deprec_svnserve_root
+# sudo ln -sf /var/www/apps/deprec/repos /var/svn/deprec_svnserve_root/deprec
+# sudo chown -R svn /var/svn/deprec_svnserve_root/deprec
+
+#
+# XXX put password file into svn and command to push it
+# 
+# # run svnserve
+# sudo -u svn svnserve --daemon --root /var/svn/deprec_svnserve_root
+# 
+# # check it out now
+# svn co svn://scm.deprecated.org/deprec/trunk deprec

data/lib/deprec/recipes/syslog.rb

@@ -0,0 +1,63 @@
+# Copyright 2006-2009 by Mike Bailey. All rights reserved.
+Capistrano::Configuration.instance(:must_exist).load do 
+  namespace :deprec do 
+    namespace :syslog do
+      
+      set(:syslog_server) { Capistrano::CLI.ui.ask 'Enter Syslog server hostname' }
+
+      desc "Install syslog"
+      task :install do
+        install_deps
+      end
+
+      # install dependencies for sysklogd
+      task :install_deps do
+        apt.install( {:base => %w(sysklogd)}, :stable )
+      end
+      
+      SYSTEM_CONFIG_FILES[:syslog] =  [
+        
+       { :template => 'syslog.conf.erb',
+         :path => '/etc/syslog.conf',
+         :mode => 0644,
+         :owner => 'root:root'},
+
+       { :template => 'syslogd.erb',
+         :path => '/etc/default/syslogd',
+         :mode => 0644,
+         :owner => 'root:root'}
+         
+      ]
+           
+      desc "Generate Syslog configs"
+      task :config_gen do
+        SYSTEM_CONFIG_FILES[:syslog].each do |file|
+         deprec2.render_template(:syslog, file)
+        end
+      end
+
+      desc "Push Syslog config files to server"
+      task :config, :roles => :all_hosts, :except => {:syslog_master => true} do
+        deprec2.push_configs(:syslog, SYSTEM_CONFIG_FILES[:syslog])
+        restart
+      end
+
+      desc "Start Syslog"
+      task :start, :roles => :all_hosts, :except => { :syslog_master => true } do
+        run "#{sudo} /etc/init.d/sysklogd start"
+      end
+      
+      desc "Stop Syslog"
+      task :stop, :roles => :all_hosts, :except => { :syslog_master => true } do
+        run "#{sudo} /etc/init.d/sysklogd stop"
+      end
+      
+      desc "Restart Syslog"
+      task :restart, :roles => :all_hosts, :except => { :syslog_master => true } do
+        run "#{sudo} /etc/init.d/sysklogd restart"
+      end
+
+    end 
+    
+  end
+end

data/lib/deprec/recipes/trac.rb

@@ -0,0 +1,277 @@
+# Copyright 2006-2008 by Mike Bailey. All rights reserved.
+Capistrano::Configuration.instance(:must_exist).load do 
+  namespace :deprec do namespace :trac do
+        
+  # Master tracd process for server
+  set :tracd_cmd, '/usr/bin/tracd'
+  set :tracd_port, '9000'
+  set :tracd_pidfile, '/var/run/tracd.pid'
+  
+  # Settings for this projects trac instance
+  set(:tracd_domain_root) { domain.sub(/.*?\./,'') } # strip subdomain from domain
+  set(:tracd_vhost_domain) { "trac-#{application}.#{tracd_domain_root}" } # nginx will proxy this domain to tracd
+  
+  set(:trac_backup_dir) { "#{backup_dir}/trac" }
+  set(:trac_path) { exists?(:deploy_to) ? "#{deploy_to}/trac" : Capistrano::CLI.ui.ask('path to trac config') }
+  set(:tracd_parent_dir) { "/etc/trac.d" }
+  set(:trac_password_file)  { "#{trac_path}/conf/users.htdigest" }
+  set(:trac_account) { Capistrano::CLI.prompt('enter new trac user account name') }
+  set :trac_passwordfile_exists, true # hack - should check on remote system instead
+  set(:trac_header_logo_link) { trac_home_url }
+  # We will symlink each projects trac dir into this dir for tracd to find
+
+  # project
+  set(:trac_domain) { domain.sub(/^.*?\./, 'trac.') }
+  set(:trac_home_url) { "http://#{trac_domain}/" }
+  set(:trac_desc) { application } 
+  
+  # Settings only used for generating trac.ini for this project
+  # - notification
+  set :trac_always_notify_owner, false
+  set :trac_always_notify_reporter, false
+  set :trac_always_notify_updater, true
+  set :trac_smtp_always_bcc, ''
+  set :trac_smtp_always_cc, ''
+  set :trac_smtp_default_domain, ''
+  set :trac_smtp_enabled, true
+  set :trac_smtp_from, 'trac@localhost'
+  set :trac_smtp_password, ''
+  set :trac_smtp_port, 25
+  set :trac_smtp_replyto, 'trac@localhost'
+  set :trac_smtp_server, 'localhost'
+  set :trac_smtp_subject_prefix, '__default__'
+  set :trac_smtp_user, ''
+  set :trac_use_public_cc, false
+  set :trac_use_short_addr, false
+  set :trac_use_tls, false  
+  # - other
+  set(:trac_base_url) { trac_home_url }
+  
+  desc "Install trac on server"
+  task :install, :roles => :scm do
+    install_deps
+    sudo "easy_install Trac==0.11rc1"
+    create_pid_dir
+    create_parent_dir
+    config_gen_system
+    config_system
+    activate_system
+  end
+  
+  task :install_deps do
+    apt.install( {:base => %w(sqlite3 python-setuptools python-subversion)}, :stable )
+  end
+  
+  # The start script has a couple of config values in it.
+  # We may want to extract them into a config file later
+  # and install this script as part of the :install task.
+  SYSTEM_CONFIG_FILES[:trac] = [
+    {:template => 'tracd-init.erb',
+     :path => '/etc/init.d/tracd',
+     :mode => 0755,
+     :owner => 'root:root'}
+  ]
+  
+  PROJECT_CONFIG_FILES[:trac] = [
+    {:template => 'users.htdigest.erb',
+     :path => "conf/users.htdigest",
+     :mode => 0644,
+     :owner => 'root:root'},
+     
+    {:template => 'trac.ini.erb',
+     :path => "conf/trac.ini",
+     :mode => 0644,
+     :owner => 'root:root'},
+     
+    {:template => 'nginx_vhost.conf.erb',
+     :path => "conf/nginx_vhost.conf",
+     :mode => 0644,
+     :owner => 'root:root'}
+  ]
+  
+  desc "Generate config files for trac"
+  task :config_gen do
+    config_gen_system
+    config_gen_project
+  end
+  
+  task :config_gen_system do
+    SYSTEM_CONFIG_FILES[:trac].each do |file|
+      deprec2.render_template(:trac, file)
+    end
+  end
+  
+  task :config_gen_project do
+    PROJECT_CONFIG_FILES[:trac].each do |file|
+      deprec2.render_template(:trac, file)
+    end
+  end
+  
+  desc "Push trac config files to server"
+  task :config, :roles => :scm do
+    config_system
+    config_project
+    restart
+    top.deprec.nginx.restart
+  end
+  
+  task :config_system, :roles => :scm do
+    deprec2.push_configs(:trac, SYSTEM_CONFIG_FILES[:trac])
+  end
+  
+  task :config_project, :roles => :scm do
+    deprec2.push_configs(:trac, PROJECT_CONFIG_FILES[:trac])
+    symlink_nginx_vhost
+  end
+
+  desc "Initialize the trac db for this project"
+  task :setup, :roles => :scm do
+    init
+    config_gen_project
+    config_project
+    activate_project
+    # set_default_permissions  # XXX re-enable this
+    # create trac account for current user 
+    set :trac_account, user
+    set :trac_passwordfile_exists, false # hack - should check on remote system instead
+    # user_add # XXX re-enable
+  end
+  
+  task :init, :roles => :scm do
+    deprec2.mkdir(trac_path, :via => :sudo)
+    sudo "trac-admin #{trac_path} initenv #{application} sqlite:db/trac.db svn #{repos_root}"
+  end
+  
+  task :set_default_permissions, :roles => :scm do
+    anonymous_disable
+    authenticated_enable
+  end
+  
+  task :start, :roles => :scm do
+    sudo "/etc/init.d/tracd start"
+  end
+
+  task :stop, :roles => :scm do
+    sudo "/etc/init.d/tracd stop"
+  end
+  
+  task :restart, :roles => :scm do
+    stop
+    start
+  end
+
+  task :activate, :roles => :scm do
+    activate_system
+    activate_project
+  end
+  
+  task :activate_system, :roles => :scm do
+    sudo "update-rc.d tracd defaults"
+  end
+  
+  task :activate_project, :roles => :scm do
+    symlink_project
+  end
+  
+  task :deactivate, :roles => :scm do
+    deactivate_system
+    deactivate_project
+  end
+  
+  task :deactivate_system, :roles => :scm do
+    sudo "update-rc.d -f tracd remove"
+  end
+  
+  task :deactivate_project, :roles => :scm do
+    unlink_project
+    unlink_nginx_vhost
+    restart
+  end
+  
+  desc "Create backup of trac repository"
+  task :backup, :roles => :web do
+    # http://trac.edgewall.org/wiki/TracBackup
+    timestamp = Time.now.utc.strftime("%Y%m%d%H%M%S")
+    dest_dir = File.join(trac_backup_dir, "trac_#{application}_#{timestamp}")
+    sudo "trac-admin #{trac_path} hotcopy #{dest_dir}"
+  end
+  
+  desc "Restore trac repository from backup"
+  task :restore, :roles => :web do
+    # prompt user to select from list of locally stored backups
+    # tracd_stop
+    # copy out backup
+  end
+  
+  #
+  # Service specific tasks for end users
+  #
+  desc "create a trac user"
+  task :user_add, :roles => :scm do
+    create_file = trac_passwordfile_exists ? '' : ' -c '
+    htdigest = '/usr/local/apache2/bin/htdigest'
+    # XXX check if htdigest file exists and add '-c' option if not
+    # sudo "test -f #{trac_path/conf/users.htdigest}
+    create_file = trac_passwordfile_exists ? '' : ' -c '
+    deprec2.sudo_with_input("#{htdigest} #{create_file} #{trac_path}/conf/users.htdigest #{application} #{trac_account}", /password:/) 
+  end
+  
+  desc "list trac users"
+  task :list_users, :roles => :scm do
+    sudo "cat #{trac_path}/conf/users.htdigest"
+  end
+  
+  # desc "disable anonymous access to everything"
+  task :anonymous_disable, :roles => :scm do
+    sudo "trac-admin #{trac_path} permission remove anonymous '*'"
+  end
+  
+  # desc "enable authenticated users access to everything"
+  task :authenticated_enable, :roles => :scm do
+    sudo "trac-admin #{trac_path} permission add authenticated TRAC_ADMIN"
+  end
+  
+  #
+  # Helper tasks used by other tasks
+  #
+  
+  # Link the trac repos for this project into the master trac repos dir
+  # We do this so we can use trac for multiple projects on the same server
+  task :symlink_project, :roles => :scm do
+    sudo "ln -sf #{trac_path} #{tracd_parent_dir}/#{application}"
+  end
+  
+  task :unlink_project, :roles => :scm do
+    link = "#{tracd_parent_dir}/#{application}"
+    sudo "test -h #{link} && sudo unlink #{link} || true"
+  end
+  
+  task :symlink_nginx_vhost, :roles => :scm do
+    sudo "ln -sf #{deploy_to}/trac/conf/nginx_vhost.conf #{nginx_vhost_dir}/tracd-#{application}.conf"
+  end
+  
+  task :unlink_nginx_vhost, :roles => :scm do
+    link = "#{nginx_vhost_dir}/tracd-#{application}.conf"
+    sudo "test -h #{link} && unlink #{link} || true"
+  end
+  
+  # task :symlink_apache_vhost, :roles => :scm do
+  #   sudo "ln -sf #{deploy_to}/trac/conf/trac_apache_vhost.conf #{apache_vhost_dir}/#{application}-trac.conf"
+  # end
+  # 
+  # task :unlink_apache_vhost, :roles => :scm do
+  #   link = "#{apache_vhost_dir}/#{application}-trac.conf"
+  #   sudo "test -h #{link} && unlink #{link} || true"
+  # end
+  
+  task :create_pid_dir, :roles => :scm do
+    deprec2.mkdir(File.dirname(tracd_pidfile))
+  end
+  
+  task :create_parent_dir, :roles => :scm do
+    deprec2.mkdir(tracd_parent_dir, :via => :sudo)
+  end
+    
+end end
+  
+end