trinidad 1.1.1 → 1.2.0

data/History.txt

@@ -1,3 +1,9 @@
+== Trinidad 1.2.0 (2011-05-24)
+
+* Zero downtime hot deploy
+* Autodetect framework and threadsafe environment
+* Upgrade jruby-rack dependency to 1.0.9
+
 == Trinidad 1.1.1 (2011-03-27)
 
 * Remove shared runtime initialization

data/README.rdoc

@@ -3,37 +3,17 @@
 Trinidad allows you to run a rails or rackup applications within an embedded Apache Tomcat container.
 
 * Mail list: http://groups.google.com/group/rails-trinidad
-* Bug tracker: http://github.com/calavera/trinidad/issues
+* Bug tracker: http://github.com/trinidad/trinidad/issues
 * Irc channel on Freenode: #trinidad
 
 == INSTALL:
 
-  jgem install trinidad
+  $ jruby -S gem install trinidad
 
 == USAGE:
 
-Rails applications:
-
-    $ cd myrailsapp
-    $ jruby -S trinidad
-
-Rack applications:
-
-    $ cd myrackapplication
-
-    $ jruby -S trinidad -r path_to_rackup/rackup_file
-
-    or if the name of the file is config.ru
-
-    $ jruby -S trinidad -r path_to_rackup
-
-    or if config.ru is in the base directory
-
-    $ jruby -S trinidad -r
-
-    or if config.ru is under the directory WEB-INF
-
-    $ jruby -S trinidad
+  $ cd myapp
+  $ jruby -S trinidad
 
 == CONFIGURATION:
 
@@ -47,7 +27,7 @@ Trinidad allows you to configure some parameters when the server is started from
   * -r, --rackup [RACKUP_FILE]  =>  run a provided rackup file instead of a rails application, by default it's config.ru.
   * --public PUBLIC_DIR         =>  specify the public directory for your application, by default it's 'public'.
   * -t, --threadsafe            =>  shortcut to work in threadsafe mode. Setting jruby_min_runtimes and jruby_max_runtimes to 1 in the configuration file the server behaves as the same way.
-  * -l, --load EXTENSION_NAME   =>  load an extension to use its command line options.
+  * -l, --load EXTENSION_NAMES  =>  load extensions to use their command line options.
   * --address HOST              =>  set the server host.
   * -g, --log LEVEL             =>  set the log level, default INFO.
   * --apps APPS_BASE_DIRECTORY  =>  set the applications base directory.
@@ -58,7 +38,7 @@ The server can also be configured from a yaml file. By default, if a file is not
 
 You can also specify a default web.xml to config your web application. By default the server tries to load the file <em>config/web.xml</em> but you can modify this path adding the option <em>default_web_xml</em> within your configuration file. 
 
-Other advanced options can be found in the wiki: http://wiki.github.com/calavera/trinidad/advanced-configuration
+Other advanced options can be found in the wiki: http://wiki.github.com/trinidad/trinidad/advanced-configuration
 
 == HOT DEPLOYMENT:
 
@@ -70,16 +50,16 @@ modified with the option `:monitor`.
 
 From the version 0.8.0 Trinidad allows to extend the server with more Tomcat features, here there is a list with the current available extensions:
 
-* Database connection pooling: http://github.com/calavera/trinidad-dbpool
+* Database connection pooling: http://github.com/trinidad/trinidad-dbpool
 * Daemons:
-    ** Daemon based on Akuma (ala GF gem): http://github.com/calavera/trinidad_daemon_extension
-    ** Daemon based on Apache Commons Daemon (supports Unix and Windows systems): http://github.com/calavera/trinidad_daemon
-* Hot deploy, do hot deploys monitorizing a temporal file, ala Passenger: http://github.com/calavera/trinidad_hotdeploy_extension
-* Sandbox, management console and REST api: http://github.com/calavera/trinidad_sandbox_extension
-* Logging, enhance the Trinidad's logging system: http://github.com/calavera/trinidad_logging_extension
-* Lifecycle, application and server lifecycle management: http://github.com/calavera/trinidad_lifecycle_extension
-
-You can find further information on how to write your own extension in the wiki: http://wiki.github.com/calavera/trinidad/extensions
+    ** Daemon based on Akuma (ala GF gem): http://github.com/trinidad/trinidad_daemon_extension
+    ** Daemon based on Apache Commons Daemon (supports Unix and Windows systems): http://github.com/trinidad/trinidad_daemon
+* Sandbox, management console and REST api: http://github.com/trinidad/trinidad_sandbox_extension
+* Logging, enhance the Trinidad's logging system: http://github.com/trinidad/trinidad_logging_extension
+* Lifecycle, application and server lifecycle management: http://github.com/trinidad/trinidad_lifecycle_extension
+* Scheduler, based on Quartz: http://github.com/trinidad/trinidad_scheduler_extension
+
+You can find further information on how to write your own extension in the wiki: http://wiki.github.com/trinidad/trinidad/extensions
 
 == Copyright
 

data/lib/trinidad.rb

@@ -11,6 +11,7 @@ require 'trinidad/extensions'
 require 'trinidad/command_line_parser'
 require 'trinidad/jars'
 require 'trinidad/server'
+require 'trinidad/lifecycle/takeover'
 require 'trinidad/lifecycle/lifecycle_listener_host'
 require 'trinidad/lifecycle/lifecycle_listener_base'
 require 'trinidad/lifecycle/lifecycle_listener_default'
@@ -21,5 +22,5 @@ require 'trinidad/rackup_web_app'
 require 'trinidad/war_web_app'
 
 module Trinidad
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
 end

data/lib/trinidad/command_line_parser.rb

@@ -121,8 +121,10 @@ module Trinidad
           exit
         end
 
-        opts.on('-l', '--load EXTENSION_NAME', 'load options for a given extension') do |name|
-          Trinidad::Extensions.configure_options_extensions({name => {}}, opts, default_options)
+        opts.on('-l', '--load EXTENSION_NAMES', Array, 'load options for extensions') do |ext_names|
+          ext_names.each do |ext|
+            Trinidad::Extensions.configure_options_extensions({ext => {}}, opts, default_options)
+          end
         end
 
         opts.on('--apps', '--apps APPS_BASE_DIR', 'applications base directory') do |path|

data/lib/trinidad/lifecycle/lifecycle_listener_default.rb

@@ -14,12 +14,17 @@ module Trinidad
 
       def configure_deployment_descriptor(context)
         if descriptor = @webapp.default_deployment_descriptor
-          context.setDefaultWebXml(descriptor)
-
-          context_config = Trinidad::Tomcat::ContextConfig.new
+          listeners = context.findLifecycleListeners
+          context_config = listeners && listeners.find do |listener|
+            listener.is_a?(Trinidad::Tomcat::ContextConfig)
+          end
+          
+          unless context_config
+            context_config = Trinidad::Tomcat::ContextConfig.new
+            context.addLifecycleListener(context_config)
+          end
+          
           context_config.setDefaultWebXml(descriptor)
-
-          context.addLifecycleListener(context_config)
         end
         descriptor
       end

data/lib/trinidad/lifecycle/lifecycle_listener_host.rb

@@ -1,16 +1,19 @@
 module Trinidad
   module Lifecycle
+
     class Host
       include Trinidad::Tomcat::LifecycleListener
 
       attr_reader :contexts
 
-      def initialize(*contexts)
+      def initialize(tomcat, *contexts)
+        @tomcat = tomcat
         @contexts = contexts
       end
 
       def lifecycleEvent(event)
         host = event.lifecycle
+
         case event.type
         when Trinidad::Tomcat::Lifecycle::BEFORE_START_EVENT
           init_monitors
@@ -27,6 +30,7 @@ module Trinidad
           unless File.exist?(dir = File.dirname(monitor))
             Dir.mkdir dir
           end
+
           file = File.new(monitor, opts)
           c[:mtime] = file.mtime
         end
@@ -38,12 +42,39 @@ module Trinidad
           sleep(0.5) unless File.exist?(c[:monitor])
           next unless File.exist?(c[:monitor])
 
-          if (mtime = File.mtime(c[:monitor])) > c[:mtime]
+          if (mtime = File.mtime(c[:monitor])) > c[:mtime] && !c[:lock]
+            c[:lock] = true
             c[:mtime] = mtime
-            c[:context].reload
+            c[:context] = create_takeover(c)
+            Thread.new { c[:context].start }
           end
         end
       end
+
+      def create_takeover(c)
+        web_app = c[:app]
+        old_context = c[:context]
+
+        context = Trinidad::Tomcat::StandardContext.new
+        context.name = rand.to_s
+        context.path = old_context.path
+        context.doc_base = web_app.web_app_dir
+
+        context.add_lifecycle_listener Trinidad::Tomcat::Tomcat::DefaultWebXmlListener.new
+
+        config = Trinidad::Tomcat::ContextConfig.new
+        config.default_web_xml = 'org/apache/catalin/startup/NO_DEFAULT_XML'
+        context.add_lifecycle_listener config
+
+        Trinidad::Extensions.configure_webapp_extensions(web_app.extensions, @tomcat, context)
+
+        context.add_lifecycle_listener(web_app.define_lifecycle)
+        context.add_lifecycle_listener(Trinidad::Lifecycle::Takeover.new(c))
+
+        old_context.parent.add_child context
+
+        context
+      end
     end
   end
 end

data/lib/trinidad/lifecycle/lifecycle_listener_war.rb

@@ -1,6 +1,17 @@
 module Trinidad
   module Lifecycle
     class War < Base
+      def lifecycleEvent(event)
+        case event.type
+        when Trinidad::Tomcat::Lifecycle::AFTER_STOP_EVENT
+          destroy_expanded_app
+        when Trinidad::Tomcat::Lifecycle::BEFORE_START_EVENT
+          expand_app(event.lifecycle)
+        end
+
+        super
+      end
+
       def configure_defaults(context)
         super
         configure_class_loader(context)
@@ -11,6 +22,22 @@ module Trinidad
         loader.container = context
         context.loader = loader
       end
+
+      def destroy_expanded_app
+        require 'fileutils'
+        FileUtils.rm_rf @webapp.web_app_dir.gsub(/\.war$/, '')
+      end
+
+      def expand_app(context)
+        if !File.exist?(context.doc_base)
+          host = context.parent
+          war_file = java.io.File.new(@webapp.web_app_dir)
+          war = java.net.URL.new("jar:" + war_file.toURI.toURL.to_s + "!/")
+          path_name = File.basename(context.doc_base)
+
+          Trinidad::Tomcat::ExpandWar.expand(host, war, path_name)
+        end
+      end
     end
   end
 end

data/lib/trinidad/lifecycle/takeover.rb

@@ -0,0 +1,25 @@
+module Trinidad
+  module Lifecycle
+    class Takeover
+      include Trinidad::Tomcat::LifecycleListener
+      def initialize(old)
+        @old = old
+      end
+
+      def lifecycleEvent(event)
+        if event.type == Trinidad::Tomcat::Lifecycle::AFTER_START_EVENT
+          begin
+            name = @old[:context].name
+
+            @old[:context].stop
+            @old[:context].destroy
+
+            event.lifecycle.name = name
+          ensure
+            @old.delete(:lock)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/trinidad/server.rb

@@ -55,7 +55,7 @@ module Trinidad
     end
 
     def load_host_monitor(apps)
-      @tomcat.host.add_lifecycle_listener(Trinidad::Lifecycle::Host.new(*apps))
+      @tomcat.host.add_lifecycle_listener(Trinidad::Lifecycle::Host.new(@tomcat, *apps))
     end
 
     def create_from_web_apps
@@ -83,9 +83,6 @@ module Trinidad
               :context_path => (name == 'default' ? '' : "/#{name.to_s}"),
               :web_app_dir => File.expand_path(path)
             }
-            if File.directory?(path) && File.exist?(File.expand_path('config.ru', path))
-              app_config[:rackup] = 'config.ru'
-            end
 
             create_web_app(app_config)
           end
@@ -100,10 +97,9 @@ module Trinidad
 
       Trinidad::Extensions.configure_webapp_extensions(web_app.extensions, @tomcat, app_context)
 
-      lifecycle = web_app.war? ? Lifecycle::War.new(web_app) : Lifecycle::Default.new(web_app)
-      app_context.add_lifecycle_listener(lifecycle)
+      app_context.add_lifecycle_listener(web_app.define_lifecycle)
 
-      {:context => app_context, :monitor => web_app.monitor}
+      {:context => app_context, :app => web_app, :monitor => web_app.monitor}
     end
 
     def add_service_connector(options, protocol = nil)
@@ -194,6 +190,8 @@ module Trinidad
     end
 
     def start
+      trap_signals(@tomcat)
+
       @tomcat.start
       @tomcat.server.await
     end
@@ -212,5 +210,10 @@ module Trinidad
         config[:web_apps] = { :default => default_app }
       end
     end
+
+    def trap_signals(tomcat)
+      trap('INT') { tomcat.stop }
+      trap('TERM') { tomcat.stop }
+    end
   end
 end

data/lib/trinidad/war_web_app.rb

@@ -11,5 +11,9 @@ module Trinidad
     def monitor
       File.expand_path(web_app_dir)
     end
+
+    def define_lifecycle
+      Trinidad::Lifecycle::War.new(self)
+    end
   end
 end

data/lib/trinidad/web_app.rb

@@ -3,6 +3,8 @@ module Trinidad
     attr_reader :config, :app_config, :class_loader, :servlet
 
     def self.create(config, app_config)
+      autodetect_configuration(config, app_config)
+
       war?(app_config) ? WarWebApp.new(config, app_config) :
         rackup?(app_config) ? RackupWebApp.new(config, app_config) : RailsWebApp.new(config, app_config)
     end
@@ -96,6 +98,10 @@ module Trinidad
       File.expand_path(m_file, work_dir)
     end
 
+    def define_lifecycle
+      Trinidad::Lifecycle::Default.new(self)
+    end
+
     protected
     def add_parameter_unless_exist(param_name, param_value)
       @params[param_name] = param_value unless web_context_param(param_name)
@@ -129,5 +135,30 @@ module Trinidad
       end
       @servlet = {:class => servlet_class, :name => servlet_name}
     end
+
+    def self.autodetect_configuration(config, app_config)
+      # Check for Rails threadsafe mode
+      environment = app_config[:environment] || config[:environment]
+      if threadsafe_instance?(app_config[:web_app_dir], environment)
+        app_config[:jruby_min_runtimes] = 1
+        app_config[:jruby_max_runtimes] = 1
+      end
+
+      # Check for rackup (but still use config/environment.rb for Rails 3)
+      if !app_config[:rackup] && !config[:rackup] &&
+          File.exists?("#{app_config[:web_app_dir]}/config.ru") &&
+          !File.exists?("#{app_config[:web_app_dir]}/config/environment.rb")
+        app_config[:rackup] = 'config.ru'
+      end
+    end
+
+    def self.threadsafe_instance?(app_base, environment)
+      threadsafe_match?("#{app_base}/config/environments/#{environment}.rb") ||
+        threadsafe_match?("#{app_base}/config/environment.rb")
+    end
+
+    def self.threadsafe_match?(file)
+      File.exist?(file) && File.readlines(file).any? { |l| l =~ /^[^#]*threadsafe!/ }
+    end
   end
 end

metadata

@@ -2,7 +2,7 @@
 name: trinidad
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors: 
   - David Calavera
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-27 00:00:00 -07:00
+date: 2011-05-24 00:00:00 -07:00
 default_executable: trinidad
 dependencies: 
   - !ruby/object:Gem::Dependency 
@@ -21,7 +21,7 @@ dependencies:
       requirements: 
         - - ">="
           - !ruby/object:Gem::Version 
-            version: 1.0.0
+            version: 1.0.1
     type: :runtime
     version_requirements: *id001
   - !ruby/object:Gem::Dependency 
@@ -32,7 +32,7 @@ dependencies:
       requirements: 
         - - ">="
           - !ruby/object:Gem::Version 
-            version: 1.0.6
+            version: 1.0.9
     type: :runtime
     version_requirements: *id002
   - !ruby/object:Gem::Dependency 
@@ -95,6 +95,7 @@ files:
   - lib/trinidad/lifecycle/lifecycle_listener_default.rb
   - lib/trinidad/lifecycle/lifecycle_listener_host.rb
   - lib/trinidad/lifecycle/lifecycle_listener_war.rb
+  - lib/trinidad/lifecycle/takeover.rb
 has_rdoc: true
 homepage: http://github.com/calavera/trinidad
 licenses: []