trinidad_lifecycle_extension 0.3.0 → 0.4.0

data/README.md

@@ -2,11 +2,14 @@
 
 This extension allows you to add lifecycle listeners (written in ruby) to the 
 [Trinidad](https://github.com/trinidad/trinidad/) server container as well as to
-each deployed web application context running on top of Trinidad.
+deployed web application contexts running on top of it.
 
-This extension also allows to enable the JMX monitoring capabilities of Tomcat.
-The configuration that Tomcat needs can be set as JAVA_OPTS properties or
-through the Trinidad's configuration file.
+This extension no longer bundles the **catalina-jmx-remote.jar** and thus for
+configuring remote JMX monitoring capabilities using the `JmxRemoteLifecycleListener`
+you will need to provide and load the Java class (e.g. by downloading and 
+loading the .jar). Alternatively, there's a separate 
+[trinidad_jmx_remote_extension](http://github.com/kares/trinidad_jmx_remote_extension)
+for enabling JMX with SSH if that's all you're looking for here.
 
 ## Install
 
@@ -31,7 +34,7 @@ the path to the directory where the listener .rb files are located e.g. :
   # ...
   extensions:
     lifecycle:
-      path: 'lib/lifecycle' # defaults to lib/lifecycle
+      listeners_path: "lib/lifecycle" # defaults to lib/lifecycle
 ```
 
 Trinidad will try to require the *.rb files from the lifecycle directory and 
@@ -81,15 +84,32 @@ they will be instantiated and configured as listeners e.g. :
 module Trinidad
   module Lifecycle
     module Server
-      SIMPLE_CLUSTER = org.apache.catalina.ha.tcp.SimpleTcpCluster
+      SECURITY_SETUP = org.apache.catalina.security.SecurityListener
     end
   end
 end
 ```
 
+Of you may sub-class them and perform desired setup when instantiated :
+
+```ruby
+module Trinidad
+  module Lifecycle
+    module Server
+      class UserSecurity < org.apache.catalina.security.SecurityListener
+        def initialize
+          setCheckedOsUsers('root,public,nobody')
+        end
+      end
+    end
+  end
+end
+```
+
+
 ### WebApp Lifecycle Listener
 
-The very same rulez apply as for the Server Listener above except that we add
+The very same rules apply as for the Server listeners above except that we add
 listener classes under the `Trinidad::Lifecycle::WebApp` module e.g. :
 
 ```ruby
@@ -114,20 +134,21 @@ module Trinidad
 end
 ```
 
-Lifecycle listeners might be exported as configured instances as well e.g. :
+Lifecycle listeners might be exported as (configured) instances as well e.g. :
 
 ```ruby
 module Trinidad
   module Lifecycle
-    module Server
+    module WebApp
       
-      def self.configure_cluster
-        cluster = org.apache.catalina.ha.tcp.SimpleTcpCluster.new
-        cluster.setClusterName('Trinidad')
-        cluster
+      def self.configure_jre_memory_leak_prevention_listener
+        listener = org.apache.catalina.core.JreMemoryLeakPreventionListener.new
+        listener.setGcDaemonProtection(true)
+        listener.setUrlCacheProtection(true)
+        listener
       end
 
-      CONFIGURED_CLUSTER = self.configure_cluster
+      MEMORY_LEAK_LISTENER = self.configure_jre_memory_leak_prevention_listener
 
     end
   end

data/lib/trinidad_lifecycle_extension.rb

@@ -14,13 +14,22 @@ module Trinidad
         @@_constants = self.constants.dup
 
         def self.listeners
+          listener_constants.map do |name|
+            const = self.const_get(name)
+            const.is_a?(Class) ? const.new : const
+          end
+        end
+        
+        def self.listener_constants
           listeners = self.constants - @@_constants
           listeners.map! do |name|
             const = self.const_get(name)
             if const.is_a?(Class) && const.included_modules.include?(Listener)
-              const.new
+              name
             elsif const.is_a?(Listener)
-              const
+              name
+            else
+              nil
             end
           end
           listeners.compact
@@ -33,13 +42,29 @@ module Trinidad
   module Extensions
     module Lifecycle
 
+      DEFAULT_LISTENERS_PATH = 'lib/lifecycle'
+      
+      protected
+      
+      def listeners_path(type = nil)
+        options[:listeners_path] || options[:path] || DEFAULT_LISTENERS_PATH
+      end
+      
       private
       
-      def init_listeners(container, path, base_mod)
-        path ||= File.join('lib', 'lifecycle')
-
-        Dir.glob("#{path}/*.rb").each { |rb| require rb }
+      LOAD_METHOD = :load
+      
+      def init_listeners(base_mod, listeners_path, container)
+        # allow listeners_path to be a glob itself :
+        load_files = Dir.glob(listeners_path)
+        if load_files.size == 0 || 
+            ( load_files.size == 1 && File.directory?(load_files[0]) )
+          load_files = Dir.glob(File.join(listeners_path, '*.rb'))
+        end
+        
+        load_files.each { |rb_file| send LOAD_METHOD, rb_file }
 
+        # e.g. Trinidad::Lifecycle::Server.listeners
         base_mod.listeners.each do |listener|
           container.add_lifecycle_listener listener
         end
@@ -51,7 +76,7 @@ module Trinidad
       include Lifecycle
 
       def configure(tomcat)
-        init_listeners(tomcat.server, @options[:path], Trinidad::Lifecycle::Server)
+        init_listeners(Trinidad::Lifecycle::Server, listeners_path(:server), tomcat.server)
       end
       
     end
@@ -59,18 +84,11 @@ module Trinidad
     class LifecycleWebAppExtension < WebAppExtension
       include Lifecycle
 
-      def configure(tomcat, context)
-        init_listeners(context, @options[:path], Trinidad::Lifecycle::WebApp)
+      def configure(context)
+        init_listeners(Trinidad::Lifecycle::WebApp, listeners_path(:webapp), context)
       end
       
     end
-
-    class LifecycleOptionsExtension < OptionsExtension
-      def configure(parser, default_options)
-        default_options[:extensions] ||= {}
-        default_options[:extensions][:lifecycle] = {}
-      end
-    end
     
   end
 end

data/lib/trinidad_lifecycle_extension/version.rb

@@ -1,7 +1,7 @@
 module Trinidad
   module Extensions
     module Lifecycle
-      VERSION = '0.3.0'
+      VERSION = '0.4.0'
     end
   end
 end

data/spec/{fixtures/fake_listeners.rb → lifecycle/fake.rb}

@@ -1,35 +1,22 @@
 module Trinidad
   module Lifecycle
     module Server
-      
-      CONSTANT = 42
-      
+      ANSWER = 42
       class FakeStart < Base
-        
         def start
           put "#{self.inspect} start"
         end
-        
       end
-      
-      USER_CONFIG = org.apache.catalina.startup.UserConfig
-      
     end
     module WebApp
-      
       class HelperClass; end
-      
       class FakeListener
         include Trinidad::Tomcat::LifecycleListener
         
         def lifecycleEvent(event)
           put "#{self.inspect} lifecycle event: #{event}"
         end
-        
       end
-      
-      SECURITY = org.apache.catalina.security.SecurityListener.new
-      
     end
   end
 end

data/spec/lifecycle/more.rb

@@ -0,0 +1,10 @@
+module Trinidad
+  module Lifecycle
+    module Server
+      USER_CONFIG = org.apache.catalina.startup.UserConfig
+    end
+    module WebApp
+      SECURITY = org.apache.catalina.security.SecurityListener.new
+    end
+  end
+end

data/spec/listeners/server_1.rb

@@ -0,0 +1,9 @@
+module Trinidad
+  module Lifecycle
+    module Server
+      Security = org.apache.catalina.security.SecurityListener
+    end
+    module WebApp
+    end
+  end
+end

data/spec/listeners/server_2.rb

@@ -0,0 +1,11 @@
+module Trinidad
+  module Lifecycle
+    module Server
+      class EngineConfig < org.apache.catalina.startup.EngineConfig
+        def initialize
+        end
+      end
+      class Noise; end
+    end
+  end
+end

data/spec/listeners/web_app.rb

@@ -0,0 +1,7 @@
+module Trinidad
+  module Lifecycle
+    module WebApp
+      UserConfig = org.apache.catalina.startup.UserConfig.new
+    end
+  end
+end

data/spec/trinidad_lifecycle_extension_spec.rb

@@ -3,9 +3,18 @@ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 describe 'trinidad lifecycle extension' do
   
   before :all do
-    @options = { :path => File.expand_path('../fixtures', __FILE__) }
+    @options = { :path => File.expand_path('../lifecycle', __FILE__) }
   end
 
+  after do
+    Trinidad::Lifecycle::Server.listener_constants.each do |name|
+      Trinidad::Lifecycle::Server.send :remove_const, name
+    end
+    Trinidad::Lifecycle::WebApp.listener_constants.each do |name|
+      Trinidad::Lifecycle::WebApp.send :remove_const, name
+    end
+  end
+  
   let(:tomcat) { org.apache.catalina.startup.Tomcat.new }
   let(:context) { Trinidad::Tomcat::StandardContext.new }
 
@@ -15,7 +24,16 @@ describe 'trinidad lifecycle extension' do
 
     it "adds the listener to the tomcat's server context" do
       subject.configure(tomcat)
-      tomcat.server.findLifecycleListeners().should have(2).listener
+      tomcat.server.findLifecycleListeners.should have(2).listener
+    end
+
+    it "accepts a glob path" do
+      subject.options.replace :path => 'spec/listeners/ser*.rb'
+      subject.configure(tomcat)
+      tomcat.server.findLifecycleListeners.should have(2).listener
+      listeners = tomcat.server.findLifecycleListeners
+      listeners[0].should be_a org.apache.catalina.security.SecurityListener
+      listeners[1].should be_a org.apache.catalina.startup.EngineConfig
     end
     
   end
@@ -25,8 +43,15 @@ describe 'trinidad lifecycle extension' do
     subject { Trinidad::Extensions::LifecycleWebAppExtension.new(@options.dup) }
 
     it "adds the listener to the application context" do
-      subject.configure(tomcat, context)
-      context.findLifecycleListeners().should have(2).listener
+      subject.configure(context)
+      context.findLifecycleListeners.should have(2).listener
+    end
+
+    it "allows the path to point to a ruby file" do
+      subject.options.replace :listeners_path => 'spec/listeners/web_app.rb'
+      subject.configure(context)
+      context.findLifecycleListeners.should have(1).listener
+      context.findLifecycleListeners[0].should be_a org.apache.catalina.startup.UserConfig
     end
     
   end

data/trinidad_lifecycle_extension.gemspec

@@ -7,8 +7,10 @@ Gem::Specification.new do |s|
   s.version           = Trinidad::Extensions::Lifecycle::VERSION
   s.rubyforge_project = 'trinidad_lifecycle_extension'
 
-  s.summary     = "Add lifecycle listeners to Trinidad"
-  s.description = "Add lifecycle listeners to Trinidad's server or the web applications that run on it."
+  s.summary     = "Lifecycle Listeners for Trinidad"
+  s.description = "This extension allows you to add lifecycle listeners to " + 
+    "Trinidad's server container as well as to deployed web application " + 
+    "contexts running on top of it."
 
   s.authors  = ["David Calavera"]
   s.email    = 'calavera@apache.org'
@@ -21,7 +23,7 @@ Gem::Specification.new do |s|
   s.files = `git ls-files`.split("\n")
   s.test_files = s.files.select { |path| path =~ /^spec\/*_spec\.rb/ }
 
-  s.add_dependency('trinidad', '>= 1.3.5')
+  s.add_dependency('trinidad', '>= 1.4.1')
   s.add_development_dependency('rake')
   s.add_development_dependency('rspec', '>= 2.8.0')
   s.add_development_dependency('mocha')

metadata

@@ -2,7 +2,7 @@
 name: trinidad_lifecycle_extension
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
   - David Calavera
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-08 00:00:00 Z
+date: 2012-10-09 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: trinidad
@@ -20,7 +20,7 @@ dependencies:
       requirements: 
         - - ">="
           - !ruby/object:Gem::Version 
-            version: 1.3.5
+            version: 1.4.1
     type: :runtime
     version_requirements: *id001
   - !ruby/object:Gem::Dependency 
@@ -56,7 +56,7 @@ dependencies:
             version: "0"
     type: :development
     version_requirements: *id004
-description: Add lifecycle listeners to Trinidad's server or the web applications that run on it.
+description: This extension allows you to add lifecycle listeners to Trinidad's server container as well as to deployed web application contexts running on top of it.
 email: calavera@apache.org
 executables: []
 
@@ -68,16 +68,18 @@ extra_rdoc_files:
 files: 
   - .gitignore
   - Gemfile
-  - History.txt
   - LICENSE
   - README.md
   - Rakefile
   - lib/trinidad_lifecycle_extension.rb
   - lib/trinidad_lifecycle_extension/version.rb
-  - spec/fixtures/fake_listeners.rb
+  - spec/lifecycle/fake.rb
+  - spec/lifecycle/more.rb
+  - spec/listeners/server_1.rb
+  - spec/listeners/server_2.rb
+  - spec/listeners/web_app.rb
   - spec/spec_helper.rb
   - spec/trinidad_lifecycle_extension_spec.rb
-  - trinidad-libs/tomcat-catalina-jmx-remote.jar
   - trinidad_lifecycle_extension.gemspec
 homepage: http://github.com/trinidad/trinidad_lifecycle_extension
 licenses: []
@@ -105,6 +107,6 @@ rubyforge_project: trinidad_lifecycle_extension
 rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: Add lifecycle listeners to Trinidad
+summary: Lifecycle Listeners for Trinidad
 test_files: []
 

data/History.txt

@@ -1,5 +0,0 @@
-== 0.2.1 (2011-01-17)
-
-* Remote jmx configuration that doesn't work, just export JVM properties instead.
-* Use lib/lifecycle as default path.
-* Fix error when there arent listeners to load.