visionbundles 0.2.0 → 0.3.0

data/lib/generators/templates/deploy_single.rb

@@ -0,0 +1,49 @@
+require 'bundler/capistrano'
+require 'rvm/capistrano'
+require 'visionbundles'
+
+# RVM Settings
+set :rvm_ruby_string, '2.1.0'
+set :rvm_type, :user
+$:.unshift(File.expand_path('./lib', ENV['rvm_path']))
+
+# Recipes Included
+# Source: https://github.com/afunction/visionbundles/blob/master/lib/visionbundles/recipes
+include_recipes :nginx, :puma, :db, :dev
+
+# Nginx
+# Source: https://github.com/afunction/visionbundles/blob/master/lib/visionbundles/recipes/nginx.rb
+set :nginx_vhost_domain, 'www.domain.com' # your domain that to nginx.
+set :nginx_upstream_via_sock_file, false
+set :nginx_app_servers, ['127.0.0.1:9290'] # upstream will point to app server.
+
+# Puma
+# Source: https://github.com/afunction/visionbundles/blob/master/lib/visionbundles/recipes/puma.rb
+set :puma_bind_for, :tcp
+set :puma_bind_to, '127.0.0.1'
+set :puma_bind_port, '9290'
+set :puma_thread_min, 32
+set :puma_thread_max, 32
+set :puma_workers, 3
+
+# Role Settings
+server '11.222.33.44', :web, :app, :db, primary: true
+
+# Capistrano Base Setting
+set :application, 'your_project_name'
+set :user, 'rails'
+set :deploy_to, "/home/#{user}/apps/#{application}"
+set :deploy_via, :remote_cache
+set :use_sudo, false
+set :rails_env, :production
+
+# Git Settings
+set :scm, :git
+set :repository, "git@github.com:username/#{application}.git" # your git source, and make sure your server have premission to access your git server
+set :branch, :master # the branch you want to deploy
+
+# Extra settings
+default_run_options[:pty] = true
+ssh_options[:forward_agent] = true
+
+after 'deploy', 'deploy:cleanup' # keep only the last 5 releases

data/lib/visionbundles.rb

@@ -1,2 +1,3 @@
 require "visionbundles/version"
-require "visionbundles/base"
+require "visionbundles/helpers" if defined?(Capistrano)
+require 'visionbundles/rails' if defined?(Rails)

data/lib/visionbundles/asset_sync.rb

@@ -6,5 +6,9 @@ module AssetSync
     def log_silently
       false
     end
+
+    def yml_exists?
+      false
+    end
   end
 end

data/lib/visionbundles/helpers.rb

@@ -0,0 +1,2 @@
+require 'visionbundles/recipes/valid'
+Dir.glob("#{File.dirname(__FILE__)}/helpers/*.rb").each { |file| require file }

data/lib/visionbundles/helpers/configuration.rb

@@ -0,0 +1,41 @@
+require 'yaml'
+module Visionbundles
+  module Helpers
+    module Configuration
+      def load_config_from(file_path, env)
+        config = YAML::load_file("./#{file_path}.yml")[env.to_s]
+        setup_configs(config['config'] || {})
+        setup_servers(config['servers'] || [])
+        setup_preconfig(config['preconfig' || {}])
+      end
+
+      private
+
+      def setup_configs(configs)
+        configs.each do |key, value|
+          send(:set, key, value)
+        end
+      end
+
+      def setup_servers(servers)
+        servers.each do |server|
+          roles = server['roles'].is_a?(Array) ? server['roles'].map(&:to_sym) : [ server['roles'].to_sym ]
+          if server['opts'].is_a?(Hash)
+            options = Hash[server['opts'].map { |k, y| [k.to_sym, y] }]
+            roles.push(options)
+          end
+          send(:server, server['host'], *roles)
+        end
+      end
+
+      def setup_preconfig(preconfig)
+        set :preconfig_dir, preconfig['root'] if preconfig['root'].present?
+        preconfig_mapper = Hash[(preconfig['list'] || []).map { |list|
+          [list['src'], list['dest']]
+        }]
+        preconfig_files Hash[preconfig_mapper] if preconfig_mapper.present?
+      end
+    end
+  end
+end
+include Visionbundles::Helpers::Configuration

data/lib/visionbundles/helpers/git.rb

@@ -0,0 +1,10 @@
+module Visionbundles
+  module Helpers
+    module Git
+      def file_in_source_control?(file_path)
+        `git ls-files #{file_path}` != ''
+      end
+    end
+  end
+end
+include Visionbundles::Helpers::Git

data/lib/visionbundles/helpers/logger.rb

@@ -0,0 +1,27 @@
+require 'colorize'
+module Visionbundles
+  module Helpers
+    module Logger
+      def info(message)
+        puts "#{current_server} -> #{message}".colorize(:light_cyan)
+      end
+
+      def warn(message)
+        puts "#{current_server} -> #{message}".colorize(:red)
+      end
+
+      def valid_pass(topic)
+        puts "\t[Pass] #{topic}".colorize(color: :green, background: :light_white).underline
+      end
+
+      def valid_faild(topic)
+        puts "\t[Faild] #{topic}".colorize(color: :red, background: :light_white).underline
+      end
+
+      def valid_skip(topic)
+        puts "\t[Skip] #{topic}".colorize(color: :yellow, background: :light_white).underline
+      end
+    end
+  end
+end
+include Visionbundles::Helpers::Logger

data/lib/visionbundles/helpers/recipes.rb

@@ -0,0 +1,17 @@
+module Visionbundles
+  module Helpers
+    module Recipes
+      def include_recipes(*recipes)
+        recipes.each do |recipe|
+          require "visionbundles/recipes/#{recipe}.rb"
+        end
+      end
+
+      def set_default(name, *args, &block)
+        set(name, *args, &block) unless exists?(name)
+      end
+    end
+  end
+end
+include Visionbundles::Helpers::Recipes
+include_recipes 'preconfig'

data/lib/visionbundles/helpers/servers.rb

@@ -0,0 +1,32 @@
+module Visionbundles
+  module Helpers
+    module Servers
+      def remote_file_exists?(path)
+        results = []
+
+        invoke_command("if [ -f '#{path}' ]; then echo -n 'true'; fi") do |ch, stream, out|
+          results << (out == 'true')
+        end
+
+        !results.empty?
+      end
+
+      def run_if_file_exists?(path, command)
+        run "if [ -f '#{path}' ]; then #{command}; fi"
+      end
+
+      def run_if_file_not_exists?(path, command)
+        run "if [ ! -f '#{path}' ]; then #{command}; fi"
+      end
+
+      def mkdir(remote_path)
+        run "mkdir -p #{remote_path}"
+      end
+
+      def current_server
+        capture("echo $CAPISTRANO:HOST$").strip
+      end
+    end
+  end
+end
+include Visionbundles::Helpers::Servers

data/lib/visionbundles/helpers/templates.rb

@@ -0,0 +1,19 @@
+require 'erb'
+module Visionbundles
+  module Helpers
+    module Templates
+      def from_template(file)
+        abs_path = File.join(File.dirname(__FILE__), file)
+        template = File.read(abs_path)
+        ERB.new(template).result(binding)
+      end
+
+      def template(erb_source, to_dir, filename)
+        mkdir(to_dir)
+        compiled_file = "#{to_dir}/#{filename}"
+        put from_template(erb_source), compiled_file
+      end
+    end
+  end
+end
+include Visionbundles::Helpers::Templates

data/lib/visionbundles/rails.rb

@@ -0,0 +1,7 @@
+module Visionbundles
+  class Engine < Rails::Engine
+    generators do
+      require "generators/install_generator"
+    end
+  end
+end

data/lib/visionbundles/recipes/db.rb

@@ -1,40 +1,26 @@
 Capistrano::Configuration.instance(:must_exist).load do
-  
-  set_default(:database_template, 'database.production.yml')
+  require 'active_record'
 
-  namespace :db do
-    desc 'copy production database config from local'
-    task :copy_production_config, roles: [:app, :web] do
-      info '[Template] Copy Database Template'
-      copy_production_from_local(database_template, 'database.yml')
-    end
+  preconfig_files('database.yml' => 'config/database.yml')
 
-    desc "setup database configuration for application server"
-    task :setup, roles: [:app, :web] do
-      # It will check if shared database config exists will not over write
-      mkdir("#{shared_path}/config")
-      database_setting_path = "#{shared_path}/config/database.yml"
-      template_database_path = production_config('database.yml')
-      run_if_file_not_exists?(database_setting_path, "cp #{template_database_path} #{database_setting_path}")
-    end
-    after 'deploy:setup', 'db:copy_production_config', 'db:setup'
-
-    desc "setup database symlink for every time deploy"
-    task :symlink_config, roles: [:app, :web] do
-      run "ln -nfs #{shared_path}/config/database.yml #{release_path}/config/database.yml"
-    end
-
-    after "deploy:finalize_update", "db:symlink_config"
-
-    desc "remove database config file"
-    task :remove_config, roles: [:app, :web] do
-      run "rm #{shared_path}/config/database.yml"
-    end
+  namespace :db do
+    desc 'check if each servers can authenticate and connect to database'
+    task :valid do
+      db = YAML::load_file("./#{preconfig_dir}/database.yml")[rails_env.to_s]
 
-    desc 'reset database config file from local'
-    task :reset_config do
-      copy_production_config
-      overwrite_config!('database.yml')
+      find_servers.map.with_index { |server, num|
+        Thread.new {
+          host = server.to_s
+          port = Net::SSH::Gateway.new(host, user).open('127.0.0.1', 3306, 3307 + num)
+          begin
+            ActiveRecord::Base.establish_connection(db.merge(host: '127.0.0.1', port: port)).connection
+            valid_pass "Server: #{host} database authenticate and connection successful."
+          rescue Exception => e
+            valid_faild "Server: #{host} cannot connect to database: #{db['host']}, please check the database.yml or database firewall."
+          end  
+        }
+      }.each { |task| task.join }
     end
   end
-end
+  after 'deploy:valid', 'db:valid'
+end

data/lib/visionbundles/recipes/dev.rb

@@ -14,8 +14,6 @@ Capistrano::Configuration.instance(:must_exist).load do
 
     desc "dev:build task"
     task :build, roles: :db, primary: true do
-      return warn "Not Found Primary Database" unless have_primary_database?
-      
       if dev_sure_danger_command == 'Y'
         ["tmp:clear", "log:clear", "db:drop", "db:create", "db:migrate", "db:seed"].each do |rake_command|
           run "cd #{current_path}; bundle exec rake #{rake_command} RAILS_ENV=#{rails_env}"

data/lib/visionbundles/recipes/fast_assets.rb

@@ -55,7 +55,7 @@ Capistrano::Configuration.instance(:must_exist).load do
             config.manifest_path = run_locally("ls #{assets_dir}/manifest*").strip!
             config.assets_prefix = 'assets'
             config.public_path = './public'
-            
+
             cdn.each do |option, value|
               config.send("#{option}=", value)
             end
@@ -65,9 +65,31 @@ Capistrano::Configuration.instance(:must_exist).load do
         end
       end
     end
-
     before "deploy:assets:symlink", "deploy:assets:remove_manifest"
     after "deploy:assets:precompile", "deploy:assets:sync_manifest_to_app_servers",
       "deploy:assets:sync_assets_files", "deploy:assets:cleanup"
   end
-end
+
+  namespace :fast_assets do
+    desc "check is local git commit same as the branch that deploying."
+    task :valid do
+      local_current_commit = `git rev-parse HEAD`.strip.split(' ').last[0..7]
+      # if setup commit id on branch variable
+      if local_current_commit.include?(branch.to_s)
+        valid_pass "fast_assets need same commit id between local (#{local_current_commit}) and remote (#{branch})"
+      else
+        remote_branch_commit = `git ls-remote #{repository} #{branch}`.strip
+        if remote_branch_commit.blank?
+          valid_faild "Not found remote branch: #{branch}"
+          exit
+        elsif (deploying_commit = (remote_branch_commit.split(' ').first || '')[0..7]) == local_current_commit
+          valid_pass "fast_assets need same commit id between local (#{local_current_commit}) and remote (#{deploying_commit})"
+        else
+          valid_faild "Local HEAD commit is (#{local_current_commit}), please checkout local branch to \"#{branch} (#{deploying_commit})\" same as you deployed."
+          exit
+        end
+      end
+    end
+    before 'deploy:update', 'fast_assets:valid'
+  end
+end

data/lib/visionbundles/recipes/nginx.rb

@@ -6,11 +6,13 @@ Capistrano::Configuration.instance(:must_exist).load do
     nginx_upstream_via_sock_file ? "/tmp/#{application}.sock" : "127.0.0.1:9292"
   }
 
+  set_default(:nginx_config_template) { "../templates/nginx/nginx.conf.erb" }
+
   namespace :nginx do
     desc "setup nginx vhost config"
     task :setup, roles: :web do
       info '[Nginx] Setup vhost configuration files ...'
-      template "templates/nginx/nginx.conf.erb", "#{shared_path}/nginx", "vhost.conf"
+      template nginx_config_template, "#{shared_path}/nginx", "vhost.conf"
       sudo "ln -nfs #{shared_path}/nginx/vhost.conf /etc/nginx/sites-enabled/#{application}"
     end
     after 'deploy:setup', 'nginx:setup'

data/lib/visionbundles/recipes/preconfig.rb

@@ -0,0 +1,69 @@
+require 'visionbundles/recipes/preconfig/helpers'
+
+Capistrano::Configuration.instance(:must_exist).load do
+  set_default(:preconfig_dir) { "./preconfig" }
+  set_default(:preconfig_roles) { [:app, :web, :worker] }
+
+  namespace :preconfig do
+    desc "upload configuration file to shared path"
+    task :upload_config, roles: lambda { preconfig_roles} do
+      preconfig_files_list.each do |source, destination|
+        info "[Preconfig] uploading preconfig/#{source}"
+        upload_preconfig_file(source)
+      end
+    end
+    after 'deploy:setup', 'preconfig:upload_config'
+
+    task :symlink, roles: lambda { preconfig_roles} do
+      preconfig_files_list.each do |source, destination|
+        config_file_path = remote_preconfig_souece(source)
+        info "[Preconfig] symlinking => #{destination}"
+        run "ln -nfs #{config_file_path} #{release_path}/#{destination}"
+      end
+    end
+    after "deploy:finalize_update", "preconfig:symlink"
+
+    desc <<-DESC
+      This task will check preconfig source file exists in local, and destination not in source control.
+      deploy flow will use `ln` command to make a symlink those config file to release folder,
+      however this command will not replace when file exists. so we should make sure those file exists in local
+      and destination not in source control.
+    DESC
+    task :valid do
+      unless File.exists?(preconfig_dir)
+        valid_faild "Not found preconfig folder: #{preconfig_dir}"
+      end
+
+      local_preconfigurations = []
+      destination_preconfigurations = []
+
+      preconfig_files_list.each do |source, destination|
+        local_file_path = "#{preconfig_dir}/#{source}"
+
+        # Make sure precofig source file is exists in local.
+        unless File.exists?(local_file_path)
+          local_preconfigurations.push(local_file_path)
+        end
+
+        # Make sure preconfig destination is out of source control.
+        if file_in_source_control?(destination)
+          destination_preconfigurations.push(destination)
+        end
+      end
+
+      if local_preconfigurations.empty?
+        valid_pass "Preconfig source: #{preconfig_files_list.map(&:first).join(', ')}"
+      else
+        valid_faild "Not found preconfig files: #{local_preconfigurations.join(', ')}"
+      end
+
+      if destination_preconfigurations.empty?
+        valid_pass "Preconfig destination: #{preconfig_files_list.map(&:last).join(', ')}"
+      else
+        valid_faild "Have to remove from source control files: #{destination_preconfigurations.join(', ')}"
+      end
+    end
+
+    after 'deploy:valid', 'preconfig:valid'
+  end
+end

data/lib/visionbundles/recipes/preconfig/helpers.rb

@@ -0,0 +1,28 @@
+module Visionbundles::PreconfigFiles
+  @@preconfig_files = {}
+
+  def self.preconfig_files
+    @@preconfig_files
+  end
+
+  def preconfig_files(src_to_dests)
+    src_to_dests.each do |file, desc|
+      Visionbundles::PreconfigFiles.preconfig_files[file] = desc
+    end
+  end
+
+  def remote_preconfig_souece(file)
+    "#{shared_path}/preconfig/#{file}"
+  end
+
+  def upload_preconfig_file(source)
+    preconfig_path = "#{shared_path}/preconfig"
+    mkdir(preconfig_path)
+    put File.read("#{preconfig_dir}/#{source}"), "#{preconfig_path}/#{source}"
+  end
+
+  def preconfig_files_list
+    Visionbundles::PreconfigFiles.preconfig_files
+  end
+end
+include Visionbundles::PreconfigFiles