raystool 1.0.2

data/lib/rays/servers/solr.rb

@@ -0,0 +1,111 @@
+=begin
+Copyright (c) 2012 Dmitri Carpov
+
+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.
+=end
+
+module Rays
+  module Server
+
+    class SolrServer < BaseServer
+      attr_reader :solr_instance
+
+      def initialize(name, host, remote, java_home, java_bin, port, url, application_service)
+        super(name, host, remote, java_home, java_bin)
+        @port = port
+        @url = url
+        @solr_instance = RSolr.connect(:url => solr_url)
+        @service = application_service
+      end
+
+      def port
+        raise RaysException.new(missing_environment_option('SOLR server', 'port')) if @port.nil?
+        @port
+      end
+
+      def url
+        raise RaysException.new(missing_environment_option('SOLR server', 'instance')) if @url.nil?
+        @url
+      end
+
+      def service
+        raise RaysException.new(missing_environment_option('SOLR service', 'service')) if @service.nil?
+        @service
+      end
+
+      def alive?
+        begin
+          @solr_instance.get('select', :params => { :q => '*:*', :limit => 1})
+          return true
+        rescue
+          return false
+        end
+      end
+
+      def clean_all
+        solr_transaction do
+          @solr_instance.delete_by_query('*:*')
+        end
+      end
+
+      private
+      def solr_transaction
+        $log.info("Connecting to the solr server ...")
+        unless alive?
+          $log.error("Cannot connect to the solr server.")
+          return
+        end
+        begin
+          log_block("execute solr query") do
+            yield
+            @solr_instance.commit
+          end
+        rescue Errno::ECONNREFUSED => e
+          rollback
+          $log.error("Cannot connect to the solr server. URL: " + solr_url)
+          $log.debug("Cause: #{e.message}.\tBacktrace:\r\n#{e.backtrace.join("\r\n")}")
+        rescue RSolr::Error::Http => e
+          rollback
+          $log.error("Bad solr request. URL: " + solr_url)
+          $log.debug("Cause: #{e.message}.\tBacktrace:\r\n#{e.backtrace.join("\r\n")}")
+        rescue => e
+          rollback
+          $log.error("Unknown solr error.")
+          $log.debug("Cause: #{e.message}.\tBacktrace:\r\n#{e.backtrace.join("\r\n")}")
+        end
+      end
+
+      def solr_url
+        url_string = "http://#{host}"
+        url_string << ":#{port}"
+        url_string << "/#{url}"
+        url_string
+      end
+
+      def rollback
+        begin
+          @solr_instance.rollback
+        rescue
+          # stub
+        end
+      end
+    end
+  end
+end

data/lib/rays/services/application_service.rb

@@ -0,0 +1,116 @@
+=begin
+Copyright (c) 2012 Dmitri Carpov
+
+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.
+=end
+
+module Rays
+  module Service
+    class ApplicationService
+
+      def initialize(name, host, port, start_script, debug_script, stop_script, log_file, remote)
+        @name = name
+        @host = host
+        @port = port
+        @start_script = start_script
+        @debug_script = debug_script
+        @stop_script = stop_script
+        @log_file = log_file
+        @remote = remote
+      end
+
+      def host
+        raise RaysException.new(missing_environment_option('Service', 'host')) if @host.nil?
+        @host
+      end
+
+      def port
+        raise RaysException.new(missing_environment_option('Service', 'port')) if @port.nil?
+        @port
+      end
+
+      # Start service
+      def start
+        unless alive?
+          execute @start_script
+        else
+          raise RaysException.new('service is already running')
+        end
+      end
+
+      # Debug service
+      def debug
+        if @debug_script.nil?
+          $log.warn('debug is disabled for this server')
+          return
+        end
+        unless alive?
+          execute @debug_script
+        else
+          raise RaysException.new('service is already running')
+        end
+      end
+
+      # Stop service
+      def stop
+        if alive?
+          execute @stop_script
+        else
+          raise RaysException.new('service is not running')
+        end
+      end
+
+      # Show logs (live)
+      def log
+        if remote?
+          remote.exec(command)
+        else
+          Thread.new do
+            exec("tail -f #{@log_file}")
+          end
+        end
+        $log.info("Following logs of #{@name} service on #{@host}.\nUse ctrl+c to interrupt.")
+      end
+
+      # Is the service resides on a remote service?
+      # returns true if the service is on a remote server and false if the service is local.
+      def remote?
+        !@remote.nil?
+      end
+
+      # Is the service running?
+      # Returns true is the service is running or false otherwise
+      def alive?
+        Utils::NetworkUtils.port_open?(@host, @port)
+      end
+
+      private
+
+      # Executing command on local or a remote server depending on the service configuration.
+      def execute(command)
+        if remote?
+          remote.exec(command)
+        else
+          rays_exec(command)
+        end
+      end
+    end
+  end
+end

data/lib/rays/services/backup_service.rb

@@ -0,0 +1,94 @@
+=begin
+Copyright (c) 2012 Dmitri Carpov
+
+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.
+=end
+
+module Rays
+  module Service
+    class Backup
+
+      def initialize(environment = $rays_config.environment)
+        @environment = environment
+        @backup_directory = create_backup_directory
+        @dump_file_name = 'db.dump'
+        @package_file = "archive-#{Time.now.to_i.to_s}.tar"
+      end
+
+      def backup
+        package = ''
+
+        service_safe(@environment.backup.stop_server) do
+          database
+          data
+          package = pack
+        end
+
+        package
+      end
+
+      private
+
+      def create_backup_directory
+        base_directory = @environment.backup.directory
+        # remove until multiple backups support
+        execute("rm -rf #{base_directory}")
+        execute("mkdir #{base_directory}")
+        backup_directory = File.join(base_directory, Time.now.to_i.to_s)
+        execute("mkdir #{backup_directory}")
+        backup_directory
+      end
+
+      def execute(command)
+        if @environment.liferay.remote?
+          @environment.liferay.remote.exec(command)
+        else
+          rays_exec(command)
+        end
+      end
+
+      #
+      # Database backup
+      #
+      def database
+        dump_file = File.join(@backup_directory, 'db.dump')
+        task("creating database backup", "done", "failed") do
+          execute(@environment.database.instance.export_command(@environment.database.db_name, dump_file))
+        end
+      end
+
+      #
+      # Data backup
+      #
+      def data
+        task("creating data backup", "done", "failed") do
+          execute("cp -r #{@environment.liferay.data_directory} #{@backup_directory}")
+        end
+      end
+
+      def pack
+        task("creating backup archive", "done", "failed") do
+          execute("cd #{@backup_directory} && tar -cf #{@package_file} * && mv #{@package_file} .. && cd .. && rm -rf #{@backup_directory}")
+        end
+        "#{@environment.backup.directory}/#{@package_file}"
+      end
+    end
+  end
+end

data/lib/rays/services/database.rb

@@ -0,0 +1,59 @@
+=begin
+Copyright (c) 2012 Dmitri Carpov
+
+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.
+=end
+
+module Rays
+  module Database
+    class MySQL
+      def initialize(host, port, username, password, db_name=nil)
+        @host = host
+        @port = port
+        @username = username
+        @password = password
+        @db_name = db_name
+      end
+
+      def export_command(db_name, dump_file)
+        "mysqldump -u#{@username} #{pass_param} -h#{@host} --port=#{@port} #{db_name} > #{dump_file}"
+      end
+
+      def import_command(db_name, dump_file)
+        "mysql -u#{@username} #{pass_param} #{db_name} < #{dump_file}"
+      end
+
+      def create_database_command(db_name)
+        "mysqladmin -u#{@username} #{pass_param} create #{db_name}"
+      end
+
+      def delete_database_command(db_name)
+        "mysqladmin -u#{@username} #{pass_param} -f drop #{db_name}"
+      end
+
+      private
+      def pass_param
+        password = ''
+        password = "-p#{@password}" unless @password.nil? or @password.empty?
+        password
+      end
+    end
+  end
+end

data/lib/rays/services/remote.rb

@@ -0,0 +1,75 @@
+=begin
+Copyright (c) 2012 Dmitri Carpov
+
+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.
+=end
+
+module Rays
+  module Service
+    module Remote
+      class SSH
+
+        def initialize(host, port, user)
+          @host = host
+          @port = port # TODO: not used for now.
+          @user = user
+          defaults
+        end
+
+        def host
+          raise RaysException.new(missing_environment_option('ssh', 'host')) if @host.nil?
+          @host
+        end
+
+        def port
+          raise RaysException.new(missing_environment_option('ssh', 'port')) if @port.nil?
+          @port
+        end
+
+        def user
+          raise RaysException.new(missing_environment_option('ssh', 'user')) if @user.nil?
+          @user
+        end
+
+        def exec(command)
+          response = ""
+          Net::SSH.start("#{host}", "#{user}") do |ssh|
+            response = ssh.exec!(command)
+            $log.debug(response)
+          end
+          response
+        end
+
+        def copy_to(local_file, remote_file)
+          rays_exec("#{$rays_config.scp} #{local_file} #{user}@#{host}:#{remote_file}")
+        end
+
+        def copy_from(remote_file, local_file)
+          rays_exec("#{$rays_config.scp} #{user}@#{host}:#{remote_file} #{local_file}")
+        end
+
+        private
+        def defaults
+          @port ||= 22
+        end
+      end
+    end
+  end
+end

data/lib/rays/services/scm.rb

@@ -0,0 +1,92 @@
+=begin
+Copyright (c) 2012 Dmitri Carpov
+
+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.
+=end
+
+#
+# NOT SUPPORTED
+#
+module Rays
+
+  class SCM
+    def initialize(path, username, password, type)
+      raise RaysException "unknown SCM type." if type.nil?
+      if type.eql? "svn"
+        @instance = SVN.new path, username, password, $rays_config.project_root
+      else
+        @instance = Git.new path, Rays::Utils::FileUtils.project_root
+      end
+    end
+
+    def update
+      @instance.update
+    end
+
+    def checkout
+      @instance.checkout
+    end
+
+    def clean_checkout
+      @instance.checkout "/tmp/#{Project.instance.name}"
+    end
+
+  end
+
+  private
+
+  class Git
+    def initialize path, source_dir
+      @path = path
+      @source_dir = source_dir
+    end
+
+    def checkout dir = nil
+      dir ||= @source_dir
+      rays_exec "git clone #{@path} #{dir}"
+      @source_dir = dir
+    end
+
+    def update
+      in_directory(@source_dir) do
+        rays_exec "git pull origin"
+      end
+    end
+  end
+
+  class SVN
+    def initialize path, username, password, source_dir
+      @path = path
+      @username = username
+      @password = password
+      @source_dir = source_dir
+    end
+
+    def checkout(dir = nil)
+      dir ||= @source_dir
+      rays_exec("svn co #{@path} --username=#{@username} --password=#{@password} #{dir}")
+      @source_dir = dir
+    end
+
+    def update
+      system_exec("cd #{@source_dir} && svn up", $rays_config.debug)
+    end
+  end
+end

data/lib/rays/services/sync.rb

@@ -0,0 +1,90 @@
+=begin
+Copyright (c) 2012 Dmitri Carpov
+
+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.
+=end
+
+module Rays
+  module Service
+    class Sync
+
+      def initialize
+        @import_directory = '/tmp/rays_import'
+        @dump_file_name = 'db.dump'
+        @data_dir_name = 'data'
+        recreate_import_directory
+        @import_package = File.join(@import_directory, 'import_package.tar')
+      end
+
+      def sync(environment = $rays_config.environment)
+        backup = Backup.new(environment)
+        package_location = backup.backup
+        task("copy backup file from #{environment.name}", 'done', 'failed') do
+          environment.liferay.remote.copy_from(package_location, @import_package)
+        end
+        task('unpack backup file', 'done', 'failed') do
+          in_directory(@import_directory) do
+            rays_exec("tar -xf #{@import_package}")
+            File.delete(@import_package)
+          end
+        end
+        task('check backup integrity', 'backup looks OK', 'failed') do
+          in_directory(@import_directory) do
+            raise RaysException.new('Cannot find dump.db') unless File.exists?(@dump_file_name)
+            raise RaysException.new('Cannot find data folder') unless Dir.exists?(@data_dir_name)
+          end
+        end
+
+        in_local_environment do
+          service_safe do
+            # create local backup
+            Backup.new.backup
+            in_directory(@import_directory) do
+              db = $rays_config.environment.database.instance
+              db_name = $rays_config.environment.database.db_name
+              begin
+                rays_exec(db.delete_database_command(db_name))
+              rescue => ex
+                $log.warn("Cannot drop database #{db_name}")
+              end
+              task("re-create database #{db_name}", 'done', 'failed') do
+                rays_exec(db.create_database_command(db_name))
+              end
+              task('import database dump', 'done', 'failed') do
+                rays_exec(db.import_command(db_name, File.join(@import_directory, @dump_file_name)))
+              end
+              task('re-create data folder', 'done', 'failed') do
+                FileUtils.rm_rf($rays_config.environment.liferay.data_directory)
+                FileUtils.cp_r(@data_dir_name, $rays_config.environment.liferay.data_directory)
+              end
+            end
+          end
+        end
+      end
+
+      private
+      def recreate_import_directory
+        FileUtils.rm_rf(@import_directory) if Dir.exist?(@import_directory)
+        FileUtils.mkdir_p(@import_directory)
+      end
+
+    end
+  end
+end