capistrano-exfel 0.0.1

data/lib/capistrano/tasks/app_home.rake

@@ -0,0 +1,127 @@
+namespace :app_home do
+  desc 'Create on server the necessary placeholders for storing the Application'
+  task :create_all do
+    invoke 'app_home:create_deploy_folder'
+    invoke 'app_home:create_shared_folder'
+    invoke 'app_home:create_revisions_file'
+  end
+
+  desc 'Create application deploy folders on server and give it the correct permissions'
+  task :create_deploy_folder do
+    on roles(:app) do
+      sudo_cmd = "echo #{fetch(:password)} | sudo -S"
+
+      debug '#' * 50
+
+      debug "mkdir -p #{fetch(:deploy_to)}"
+      execute "#{sudo_cmd} mkdir -p #{fetch(:deploy_to)}"
+
+      debug "chgrp #{fetch(:app_group_owner)} #{fetch(:deploy_to)}"
+      execute "#{sudo_cmd} chgrp #{fetch(:app_group_owner)} #{fetch(:deploy_to)}"
+
+      debug "chmod g+ws #{fetch(:deploy_to)}"
+      execute "#{sudo_cmd} chmod g+ws #{fetch(:deploy_to)}"
+
+      debug '#' * 50
+    end
+  end
+
+  desc 'Create shared folder on server DEPLOY folder and give it the correct permissions'
+  task :create_shared_folder do
+    on roles(:app) do
+      sudo_cmd = "echo #{fetch(:password)} | sudo -S"
+
+      debug '#' * 50
+
+      debug "mkdir -p #{fetch(:shared_path)}"
+      execute "#{sudo_cmd} mkdir -p #{fetch(:shared_path)}"
+
+      debug "chmod g+ws #{fetch(:shared_path)}"
+      execute "#{sudo_cmd} chmod g+ws #{fetch(:shared_path)}"
+
+      set :shared_config_path, "#{fetch(:shared_path)}/config"
+
+      debug "mkdir -p #{fetch(:shared_config_path)}"
+      execute "#{sudo_cmd} mkdir -p #{fetch(:shared_config_path)}"
+
+      debug "chmod g+ws #{fetch(:shared_config_path)}"
+      execute "#{sudo_cmd} chmod g+ws #{fetch(:shared_config_path)}"
+
+      debug '#' * 50
+    end
+  end
+
+  desc 'create revisions.log file on server DEPLOY folder and give it the correct permissions'
+  task :create_revisions_file do
+    on roles(:app) do
+      debug '#' * 50
+
+      set :revisions_log_file_path, "#{fetch(:deploy_to)}/revisions.log"
+
+      debug "touch #{fetch(:revisions_log_file_path)}"
+      execute :touch, fetch(:revisions_log_file_path)
+
+      debug "chmod g+w #{fetch(:revisions_log_file_path)}"
+      execute "chmod g+w #{fetch(:revisions_log_file_path)}"
+
+      debug '#' * 50
+    end
+  end
+
+  desc 'Correct shared folder permissions'
+  task :correct_shared_permissions do
+    on roles(:app), in: :sequence, wait: 5 do
+      sudo_cmd = "echo #{fetch(:password)} | sudo -S"
+
+      debug '#' * 50
+
+      # Needs access to the folder due to the first write and log rotation
+      debug "chown -R nobody.#{fetch(:app_group_owner)} #{fetch(:shared_path)}/log"
+      execute "#{sudo_cmd} chown -R nobody.#{fetch(:app_group_owner)} #{fetch(:shared_path)}/log"
+
+      # # Only files should be changed
+      # debug "chown nobody.#{fetch(:app_group_owner)} #{fetch(:shared_path)}/config/*"
+      # execute "#{sudo_cmd} chown nobody.#{fetch(:app_group_owner)} #{fetch(:shared_path)}/config/*"
+      #
+      # debug "chmod 440 #{fetch(:shared_path)}/config/*"
+      # execute "#{sudo_cmd} chmod 440 #{fetch(:shared_path)}/config/*"
+
+      # Needs write permissions
+      debug "chown -R nobody.#{fetch(:app_group_owner)} #{fetch(:shared_path)}/tmp/"
+      execute "#{sudo_cmd} chown -R nobody.#{fetch(:app_group_owner)} #{fetch(:shared_path)}/tmp/"
+
+      debug '#' * 50
+    end
+  end
+
+  task :reload_server_cache do
+    on roles(:app), in: :sequence, wait: 5 do
+      debug '#' * 100
+      debug "curl https://in.xfel.eu/#{fetch(:app_name_uri)} -v"
+      execute :curl, "https://in.xfel.eu/#{fetch(:app_name_uri)} -v"
+      debug 'Application visited successfully...'
+      debug '#' * 100
+    end
+  end
+
+  task :deploy_success_msg do
+    on roles(:app), in: :sequence, wait: 5 do
+      info '#' * 100
+      info '#' * 10 + ' => Application Successfully deployed...'
+      info '#' * 100
+      info '#' * 10 + " => visit: https://in.xfel.eu/#{fetch(:app_name_uri)}"
+      info '#' * 100
+    end
+  end
+
+  ###
+  # This task doesn't look to be working:
+  # desc 'Restart application'
+  ###
+  task :restart do
+    on roles(:app), in: :sequence, wait: 5 do
+      info '#' * 10 + ' Touching restart.txt...'
+      execute :touch, release_path.join('tmp/restart.txt')
+    end
+  end
+end

data/lib/capistrano/tasks/application.rake

@@ -0,0 +1,224 @@
+####################################################################################################
+#
+# Capistrano Important Tasks
+#
+#####################################################################################################
+#
+# See all available tasks
+# cap -T
+
+# To deploy a new server with capistrano execute:
+# cap [development|test|production] application:deploy_first_time
+
+# To deploy the application, including assets compilation:
+# cap [development|test|production] application:deploy
+
+# To restart the application, including reloading server cache:
+# cap [development|test|production] application:restart
+
+####################################################################################################
+#
+# Capistrano Internal Tasks
+#
+#####################################################################################################
+#
+# To execute db seed (can only be executed once... to add default roles and users):
+# cap [development|test|production] db:seed
+
+# To restart Apache:
+# cap [development|test|production] deploy:restart_apache
+
+# To execute rake commands:
+# cap [development|test|production] util:runrake task=secret
+
+# XFEL application specific tasks
+namespace :application do
+  # Task 'application:deploy' deploys a new version of the application in the specified server
+  desc 'Re-deploy existent Application in the specified server'
+  task :deploy do
+    on roles(:app, :web) do
+      info '#' * 100
+      info '#' * 10 + ' => Start subsequents times deploy...'
+      info '#' * 100
+
+      # This is advisable to kill users cookies after the upgrade.
+      # The consequence is that users will be logged out automatically from the Application after the upgrade.
+      # This is important to avoid errors with old validity_token in forms
+      invoke 'secrets:update_app_secret'
+
+      invoke :deploy
+      invoke 'application:restart'
+    end
+  end
+
+  # Task 'application:deploy_first_time' deploys an application for the first time in the specified server.
+  # This task besides deploying the application also make all the necessary configurations
+  desc 'Deploy Application for the first time in the specified server'
+  task :deploy_first_time do
+    on roles(:app, :web) do
+      info '#' * 100
+      info '#' * 10 + ' => Start first time deploy...'
+      info '#' * 100
+
+      invoke 'app_home:create_all'
+      invoke 'haproxy:configure_and_start' # This should go to Puppet
+      invoke 'database:configure_mysql'
+      invoke 'secrets:configure'
+      invoke 'apache:configure_and_start'
+      invoke 'apache:check_write_permissions'
+      invoke :deploy
+      invoke 'app_home:correct_shared_permissions'
+      invoke 'application:restart'
+    end
+  end
+
+  desc 'Restarts the application, including reloading server cache'
+  task :restart do
+    # invoke 'app_home:restart'
+    invoke 'apache:restart'
+    invoke 'app_home:reload_server_cache'
+    invoke 'app_home:deploy_success_msg'
+  end
+
+  desc 'Restarts the application, including reloading server cache'
+  task :reconfigure_apache do
+    invoke 'apache:configure'
+    invoke 'application:restart'
+  end
+
+  desc 'Show variables values without deploying'
+  task :show_variables do
+    on roles(:app, :web) do
+      info '#' * 100
+      info "username => #{fetch(:username)}"
+      info 'password => **********'
+      info "rails_env => #{fetch(:rails_env)}"
+      info "app_name => #{fetch(:app_name)}"
+      info "app_domain => #{fetch(:app_domain)}"
+      info "default_app_uri => #{fetch(:default_app_uri)}"
+      info "app_name_uri => #{fetch(:app_name_uri)}"
+      info "app_full_url => #{fetch(:app_full_url)}"
+      info "deploy_to => #{fetch(:deploy_to)}"
+      info "shared_path => #{fetch(:shared_path)}"
+      info "repo_url => #{fetch(:repo_url)}"
+      info "branch => #{fetch(:branch)}"
+      info "scm => #{fetch(:scm)}"
+      info "format => #{fetch(:format)}"
+      info "log_level => #{fetch(:log_level)}"
+      info "pty => #{fetch(:pty)}"
+      info "linked_files => #{fetch(:linked_files)}"
+      info "linked_dirs => #{fetch(:linked_dirs)}"
+      info "keep_releases => #{fetch(:keep_releases)}"
+      info "use_sudo => #{fetch(:use_sudo)}"
+      info "app_group_owner => #{fetch(:app_group_owner)}"
+      info "apache_document_root => #{fetch(:apache_document_root)}"
+      info "apache_deploy_symbolic_link => #{fetch(:apache_deploy_symbolic_link)}"
+      info "tmp_dir => #{fetch(:tmp_dir)}"
+      info '#' * 100
+    end
+  end
+end
+
+namespace :load do
+  task :defaults do
+    # Set username and password
+    ask :username, proc { `whoami`.chomp }.call
+    set :password, -> { ask('password', nil, echo: false) }
+
+    # Application Name
+    set :app_name, -> { ask('Please specify the application name (i.e. my_app)', 'my_app') }
+
+    # Build default application URI
+    set :default_app_uri, -> do
+      case fetch(:rails_env).to_s
+      when 'development'
+        "dev_#{fetch(:app_name)}"
+      when 'test'
+        "test_#{fetch(:app_name)}"
+      else
+        "#{fetch(:app_name)}"
+      end
+    end
+
+    # Set application related information
+    set :app_domain, -> do
+      ask('Please specify the application domain (i.e. https://in.xfel.eu/)', 'https://in.xfel.eu/')
+    end
+
+    set :app_name_uri, -> do
+      ask("Please specify the application URI (i.e. #{fetch(:default_app_uri)})", fetch(:default_app_uri))
+    end
+
+    set :app_full_url, -> { "#{fetch(:app_domain)}#{fetch(:app_name_uri)}" }
+
+    # Default deploy_to directory value is /var/www/
+    set :deploy_to, -> { File.join('/data', fetch(:app_name_uri)) }
+
+    # Shared folder inside deployment directory
+    set :shared_path, -> { File.join(fetch(:deploy_to), 'shared') }
+
+    # Set git repository information
+    set :repo_url, -> { '' }
+
+    # Default branch is :master
+    ask :branch, proc { `git rev-parse --abbrev-ref HEAD`.chomp }.call
+
+    # Default value for :scm is :git
+    set :scm, -> { :git }
+
+    # Default value for :format is :pretty
+    set :format, -> { :pretty }
+
+    # Default value for :log_level is :debug
+    set :log_level, -> { :info }
+
+    # Default value for :pty is false
+    set :pty, -> { true }
+
+    # Default value for :linked_files is []
+    set :linked_files, -> { %w(config/database.yml config/secrets.yml) }
+
+    # Default value for linked_dirs is []
+    set :linked_dirs, -> { %w(bin log tmp/pids tmp/cache tmp/sockets vendor/bundle public/system) }
+
+    # Default value for keep_releases is 5
+    set :keep_releases, -> { 5 }
+
+    # Sudo related information
+    set :use_sudo, -> { true }
+    set :app_group_owner, -> { 'exfl_itdm' }
+
+    # Capistrano::Rails
+    #
+    # Defaults to 'assets' this should match config.assets.prefix in your rails config/application.rb
+    # set :assets_prefix, 'prepackaged-assets'
+    #
+    # set :assets_roles, [:web, :app] # Defaults to [:web]
+    #
+    # If you need to touch public/images, public/javascripts and public/stylesheets on each deploy:
+    # set :normalize_asset_timestamps, %{public/images public/javascripts public/stylesheets}
+
+    # Bundle
+    # set :bundle_flags, '--quiet' # '--deployment --quiet' is the default
+
+    # RVM related information
+    set :rvm_type, -> { :system }
+    # set :rvm_ruby_version, '2.1.2'
+    set :rvm_roles, [:app, :web]
+    # set :rvm_custom_path, '~/.myveryownrvm'  # only needed if not detected
+
+    # Apache related information
+    set :apache_document_root, -> { '/var/www/html/' }
+    set :apache_deploy_symbolic_link, -> { "#{fetch(:apache_document_root)}#{fetch(:app_name_uri)}" }
+
+    # set :tmp_dir, '/home/dh_user_name/tmp'
+    set :tmp_dir, -> { File.join('/tmp', fetch(:username)) }
+
+    # Set umask for remote commands
+    SSHKit.config.umask = '0002'
+
+    # Map commands
+    SSHKit.config.command_map[:rake] = 'bundle exec rake'
+    SSHKit.config.command_map[:rails] = 'bundle exec rails'
+  end
+end

data/lib/capistrano/tasks/database.rake

@@ -0,0 +1,106 @@
+namespace :database do
+  desc 'Seed default data (roles and common users) to the database'
+  task :seed do
+    on roles(:app), in: :sequence, wait: 5 do
+      execute_rake_command('db:seed')
+    end
+  end
+
+  desc 'Create MySQL specific database.yml in the shared path'
+  task :configure_mysql do
+    on roles(:app) do
+      set :database_original_file_name, 'database_mysql.yml'
+      invoke 'database:configure_database_file'
+    end
+  end
+
+  desc 'Create PostgreSQL specific database.yml in the shared path'
+  task :configure_postgresql do
+    on roles(:app) do
+      set :database_original_file_name, 'database_postgresql.yml'
+      invoke 'database:configure_database_file'
+    end
+  end
+
+  desc 'Create SQLite specific database.yml in the shared path'
+  task :configure_sqlite do
+    on roles(:app) do
+      set :database_original_file_name, 'database_sqlite.yml'
+      invoke 'database:configure_database_file'
+    end
+  end
+
+  # desc 'Configure database.yml in the shared path'
+  task :configure_database_file do
+    on roles(:app) do
+      set :database_original_file_path, "config/recipes/config/#{fetch(:database_original_file_name)}"
+      set :database_file_path, "#{fetch(:shared_path)}/config/database.yml"
+
+      invoke 'database:set_permissions_pre_update'
+      invoke 'database:set_database_file'
+      invoke 'database:set_permissions_post_update'
+    end
+  end
+
+  # desc 'Set (create or replace) database.yml in the shared path'
+  task :set_database_file do
+    on roles(:app) do
+      debug '#' * 50
+      debug 'Create and configure database.yml file'
+
+      default_host = '127.0.0.1'
+      default_database = "#{fetch(:app_name)}_dev"
+      default_username = "#{fetch(:app_name)}_dev"
+      default_password = ''
+
+      set :database_host, ask('Database host:', default_host)
+      set :database_name, ask('Database Name:', default_database)
+      set :database_username, ask('Database Username:', default_username)
+      set :database_password, ask('Database Password:', default_password)
+
+      upload! StringIO.new(File.read("#{fetch(:database_original_file_path)}")), "#{fetch(:database_file_path)}"
+
+      execute "sed -i 's/<<database_name>>/#{fetch(:database_name)}/g' #{fetch(:database_file_path)}"
+      execute "sed -i 's/<<database_username>>/#{fetch(:database_username)}/g' #{fetch(:database_file_path)}"
+      execute "sed -i 's/<<database_password>>/#{fetch(:database_password)}/g' #{fetch(:database_file_path)}"
+      execute "sed -i 's/<<database_host>>/#{fetch(:database_host)}/g' #{fetch(:database_file_path)}"
+
+      debug '#' * 50
+    end
+  end
+
+  # desc 'Correct database.yml file permissions before change the file'
+  task :set_permissions_pre_update do
+    on roles(:app) do
+      sudo_cmd = "echo #{fetch(:password)} | sudo -S"
+
+      debug '#' * 50
+
+      chmod_command = "chmod -f 777 #{fetch(:database_file_path)} || true"
+      debug chmod_command
+      execute "#{sudo_cmd} #{chmod_command}"
+
+      debug '#' * 50
+    end
+  end
+
+  # desc 'Correct database.yml file permissions after change the file'
+  task :set_permissions_post_update do
+    on roles(:app) do
+      sudo_cmd = "echo #{fetch(:password)} | sudo -S"
+
+      debug '#' * 50
+
+      # Update database.yml user and group owners
+      chown_command = "chown nobody.#{fetch(:app_group_owner)} #{fetch(:database_file_path)}"
+      debug chown_command
+      execute "#{sudo_cmd} #{chown_command}"
+
+      chmod_command = "chmod 440 #{fetch(:database_file_path)}"
+      debug chmod_command
+      execute "#{sudo_cmd} #{chmod_command}"
+
+      debug '#' * 50
+    end
+  end
+end