trinidad_jars 0.1.0

data/LICENSE

@@ -0,0 +1,26 @@
+== Trinidad
+
+Copyright (c) 2009 David Calavera
+
+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.
+
+== Additional Bundled Software
+
+Apache Tomcat is licensed according to the terms of Apache License, Version 2.0 (current). See http://www.apache.org/licenses/LICENSE-2.0 for details.

data/README.rdoc

@@ -0,0 +1,48 @@
+= trinidad
+
+Trinidad allows you to run a rails or rackup applications within an embedded Apache Tomcat container.
+
+This project was initially called "Tomcat-rails" but due to legal issues with the ASF and the Tomcat trademark it has been renamed.
+
+== INSTALL:
+
+  jgem install trinidad
+  jgem install calavera-trinidad -s http://gems.github.com
+
+== USAGE:
+
+  cd myrailsapp
+  jruby -S trinidad
+  
+== CONFIGURATION:
+
+Trinidad allows you to configure some parameters when the server is started from the command line, the following is a list of the currently supported options:
+
+  * -p, --port PORT         =>    port to bind to.
+  * -e, --env ENVIRONMENT   =>    rails environment.
+  * -c, --context CONTEXT   =>    application context path.
+  * --lib, --jars LIBS_DIR  =>    directory containing jars.
+  * --classes CLASSES_DIR   =>    directory containing classes.
+  * --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'.
+
+The server can also be configured from a yaml file. If a file is not especified, the server tries to load the file <em>config/tomcat.yml</em>. Within this file you can add other options like jruby.min.runtimes(:jruby_min_runtimes) or jruby.max.runtimes(:jruby_max_runtimes).
+
+  jruby -S trinidad -f
+  jruby -S trinidad --config my_custom_configuration.yml
+
+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
+
+== EXTENSIONS:
+
+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
+
+You can find further information on how to write your onw extension in the wiki: http://wiki.github.com/calavera/trinidad/extensions
+
+== Copyright
+
+Copyright (c) 2010 David Calavera<calavera@apache.org>. See LICENSE for details.

data/bin/trinidad

@@ -0,0 +1,9 @@
+#!/usr/bin/env jruby
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+$:.unshift(File.dirname(__FILE__) + '/../trinidad-libs')
+
+require "trinidad"
+
+opts = Trinidad::CommandLineParser.parse
+Trinidad::Server.new(opts).start

data/lib/trinidad/jars.rb

@@ -0,0 +1,31 @@
+TRINIDAD_LIBS = File.dirname(__FILE__) + "/../../trinidad-libs" unless defined?(TRINIDAD_LIBS)
+$:.unshift(TRINIDAD_LIBS) unless 
+  $:.include?(TRINIDAD_LIBS) || $:.include?(File.expand_path(TRINIDAD_LIBS))
+
+module Trinidad
+  require 'servlet-api-2.5-6.1.14'
+  require 'jsp-api-2.1'
+  require 'jsp-2.1'
+  require 'tomcat-core'
+  require 'jetty-util-6.1.14'
+
+  require 'jruby-rack-0.9.7-SNAPSHOT'
+
+  module Tomcat
+    include_package 'org.apache.catalina'
+    include_package 'org.apache.catalina.startup'
+    include_package 'org.apache.catalina.core'
+    include_package 'org.apache.catalina.deploy'
+    include_package 'org.apache.catalina.loader'
+ 
+    include_package 'org.apache.naming.resources'
+
+    import 'org.apache.catalina.connector.Connector'
+    import 'sun.security.tools.KeyTool'
+  end
+
+  module Rack
+    include_package 'org.jruby.rack'
+    include_package 'org.jruby.rack.rails'
+  end
+end

data/spec/fixtures/foo.rb

@@ -0,0 +1,15 @@
+module Trinidad
+  module Extensions
+  class FooWebAppExtension < WebAppExtension
+    def configure(tomcat, app_context)
+      @options
+    end
+  end
+
+  class FooServerExtension < ServerExtension
+    def configure(tomcat)
+      @options
+    end
+  end
+  end
+end

data/spec/fixtures/trinidad_foo_extension.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + '/foo'

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+$:.unshift(File.dirname(__FILE__) + '/../trinidad-libs')
+$:.unshift(File.dirname(__FILE__) + '/fixtures')
+
+require 'java'
+require 'trinidad'
+require 'mocha'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+
+MOCK_WEB_APP_DIR = File.join(File.dirname(__FILE__), 'web_app_mock')

data/spec/trinidad/command_line_parser_spec.rb

@@ -0,0 +1,85 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Trinidad::CommandLineParser do
+  it "should override classes option" do
+    ARGV = "--classes my_classes".split
+    
+    options = Trinidad::CommandLineParser.parse
+    options[:classes_dir].should == 'my_classes'
+  end
+  
+  it "should override libs option with lib option" do
+    ARGV = "--lib my_libs".split
+    
+    options = Trinidad::CommandLineParser.parse
+    options[:libs_dir].should == 'my_libs'
+  end
+  
+  it "should override libs option with jar option" do
+    ARGV = "--jars my_jars".split
+    
+    options = Trinidad::CommandLineParser.parse
+    options[:libs_dir].should == 'my_jars'
+  end
+  
+  it "should override the config file when it's especified" do
+    ARGV = "-f #{File.join(MOCK_WEB_APP_DIR, 'tomcat.yml')}".split
+    
+    options = Trinidad::CommandLineParser.parse
+    options[:environment].should == 'production'
+  end
+  
+  it "should add default ssl port to options" do
+    ARGV = '--ssl'.split
+    
+    options = Trinidad::CommandLineParser.parse
+    options[:ssl].should == {:port => 8443}
+  end
+  
+  it "should add custom ssl port to options" do
+    ARGV = '--ssl 8843'.split
+    
+    options = Trinidad::CommandLineParser.parse
+    options[:ssl].should == {:port => 8843}
+  end
+  
+  it "should add ajp connection with default port to options" do
+    ARGV = '--ajp'.split
+    
+    options = Trinidad::CommandLineParser.parse
+    options[:ajp].should == {:port => 8009}
+  end
+  
+  it "should add ajp connection with coustom port to options" do
+    ARGV = '--ajp 8099'.split
+    
+    options = Trinidad::CommandLineParser.parse
+    options[:ajp].should == {:port => 8099}
+  end
+  
+  it "should merge ajp options from the config file" do
+    ARGV = "--ajp 8099 -f #{File.join(MOCK_WEB_APP_DIR, 'tomcat.yml')}".split
+    
+    options = Trinidad::CommandLineParser.parse
+    options[:ajp][:port].should == 8099
+    options[:ajp][:secure].should == true
+  end
+  
+  it "uses default rackup file to configure the server" do
+    ARGV = "--rackup".split
+    options = Trinidad::CommandLineParser.parse
+    options[:rackup].should == 'config.ru'
+  end
+
+  it "uses a custom rackup file if it's provided" do
+    ARGV = "--rackup custom_config.ru".split
+    options = Trinidad::CommandLineParser.parse
+    options[:rackup].should == 'custom_config.ru'
+  end
+
+  it "uses a custom public directory" do
+    ARGV = "--public web".split
+    options = Trinidad::CommandLineParser.parse
+    options[:public].should == 'web'
+  end
+end

data/spec/trinidad/extensions_spec.rb

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'optparse'
+
+describe Trinidad::Extensions do
+
+  before(:each) do
+    @extensions = {:foo => {:bar => :bazz}}
+  end
+
+  it "configures the server with new stuff" do
+    lambda {Trinidad::Extensions.configure_server_extensions(@extensions, nil)}.should_not raise_error
+    lambda {Trinidad::Extensions.const_get(:FooServerExtension)}.should_not raise_error
+  end
+
+  it "configures the webapp with new stuff" do
+    lambda {Trinidad::Extensions.configure_webapp_extensions(@extensions, nil, nil)}.should_not raise_error
+    lambda {Trinidad::Extensions.const_get(:FooWebAppExtension)}.should_not raise_error
+  end
+end

data/spec/trinidad/server_spec.rb

@@ -0,0 +1,105 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+JSystem = java.lang.System
+JContext = javax.naming.Context
+
+describe Trinidad::Server do
+
+  it "always uses symbols as configuration keys" do
+    server = Trinidad::Server.new({'port' => 4000})
+    server.config[:port].should == 4000
+  end
+
+  it "enables catalina naming" do
+    Trinidad::Server.new
+    JSystem.getProperty(JContext.URL_PKG_PREFIXES).should  include("org.apache.naming")
+    JSystem.getProperty(JContext.INITIAL_CONTEXT_FACTORY).should == "org.apache.naming.java.javaURLContextFactory"
+    JSystem.getProperty("catalina.useNaming").should == "true"
+  end
+
+  it "should have ssl disabled when config param is nil" do
+    server = Trinidad::Server.new
+    server.ssl_enabled?.should == false
+  end
+
+  it "should have ajp disabled when config param is nil" do
+    server = Trinidad::Server.new
+    server.ajp_enabled?.should == false
+  end
+
+  it "should have ssl enabled when config param is a number" do
+    server = Trinidad::Server.new({:ssl => {:port => 8443},
+      :web_app_dir => MOCK_WEB_APP_DIR})
+
+    server.ssl_enabled?.should == true
+  end
+
+  it "should have ajp enabled when config param is a number" do
+    server = Trinidad::Server.new({:ajp => {:port => 8009}})
+
+    server.ajp_enabled?.should == true
+  end
+
+  it "should have a connector with https scheme" do
+    server = Trinidad::Server.new({:ssl => {:port => 8443},
+      :web_app_dir => MOCK_WEB_APP_DIR})
+
+    server.tomcat.service.findConnectors().should have(1).connectors
+    server.tomcat.service.findConnectors()[0].scheme.should == 'https'
+  end
+
+  it "should have an ajp connector enabled" do
+    server = Trinidad::Server.new({:ajp => {:port => 8009}})
+
+    server.tomcat.service.findConnectors().should have(1).connectors
+    server.tomcat.service.findConnectors()[0].protocol.should == 'AJP/1.3'
+  end
+
+  it "loads one application for each option present into :web_apps" do
+    server = Trinidad::Server.new({
+      :web_apps => {
+        :mock1 => {
+          :context_path => '/mock1',
+          :web_app_dir => MOCK_WEB_APP_DIR
+        },
+        :mock2 => {
+          :web_app_dir => MOCK_WEB_APP_DIR
+        },
+        :default => {
+          :web_app_dir => MOCK_WEB_APP_DIR
+        }
+      }
+    })
+
+    context_loaded = server.tomcat.host.findChildren()
+    context_loaded.should have(3).web_apps
+
+    expected = ['/mock1', '/mock2', '/']
+    context_loaded.each do |context|
+      expected.delete(context.getPath()).should == context.getPath()
+    end
+  end
+
+  it "loads the default application from the current directory if :web_apps is not present" do
+    server = Trinidad::Server.new({:web_app_dir => MOCK_WEB_APP_DIR})
+
+    default_context_should_be_loaded(server.tomcat.host.findChildren())
+  end
+
+  it "loads the default application from the current directory using the rackup file if :web_apps is not present" do
+    server = Trinidad::Server.new({
+      :web_app_dir => MOCK_WEB_APP_DIR,
+      :rackup => 'config.ru'
+    })
+
+    context = default_context_should_be_loaded(server.tomcat.host.findChildren())
+    context.findParameter('rackup').gsub(/\s+/, ' ').should == "require 'rubygems' require 'sinatra'"
+  end
+
+  def default_context_should_be_loaded(children)
+    children.should have(1).web_apps
+    children[0].getDocBase().should == MOCK_WEB_APP_DIR
+    children[0].getPath().should == '/'
+    children[0]
+  end
+end

data/spec/trinidad/web_app_spec.rb

@@ -0,0 +1,112 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Trinidad::WebApp do
+  before do
+    @tomcat = Trinidad::Tomcat::Tomcat.new
+    @tomcat_web_app = @tomcat.addWebapp('/', File.dirname(__FILE__) + '/../../')
+    @app = {
+      :web_app_dir => MOCK_WEB_APP_DIR,
+      :context_path => '/'
+    }
+    @config = {
+      :libs_dir => 'lib',
+      :classes_dir => 'classes',
+      :default_web_xml => 'config/web.xml',
+      :jruby_min_runtimes => 2,
+      :jruby_max_runtimes => 6,
+      :web_apps => {
+        :default => @app
+      }
+    }
+    @web_app = Trinidad::RailsWebApp.new(@tomcat_web_app, @config, @app)
+  end
+  
+  it "creates a RailsWebApp if rackup option is not present" do
+    Trinidad::WebApp.create(@tomcat_web_app, @config, @app).is_a?(Trinidad::RailsWebApp).should be_true
+  end
+
+  it "creates a RackupWebApp if rackup option is present" do
+    rackup_app = {:rackup => 'config.ru'}
+    @config.deep_merge({:web_apps => {:default => rackup_app}})
+    Trinidad::WebApp.create(@tomcat_web_app, @config, rackup_app).is_a?(Trinidad::RackupWebApp).should be_true
+  end
+
+  it "should load custom jars" do 
+    class_loader = org.jruby.util.JRubyClassLoader.new(JRuby.runtime.jruby_class_loader)
+    @web_app.add_application_libs(class_loader)
+
+    resource = class_loader.find_class('org.ho.yaml.Yaml')
+    resource.should_not == nil
+  end
+
+  it "should load custom classes" do
+    class_loader = org.jruby.util.JRubyClassLoader.new(JRuby.runtime.jruby_class_loader)
+    @web_app.add_application_classes(class_loader)
+    
+    resource = class_loader.find_class('HelloTomcat')
+    resource.should_not == nil    
+  end
+
+  it "should start application context without errors" do
+    start_context
+  end
+
+  it "should add a filter from the default web.xml" do
+    start_context_with_web_xml
+    @web_app.context.findFilterDefs().should have(1).filters
+  end
+
+  it "shouldn't duplicate init params" do
+    start_context_with_web_xml
+    lambda { @web_app.add_init_params }.should_not raise_error
+  end
+
+  it "should load init params" do
+    @web_app.add_init_params
+
+    @web_app.context.findParameter('jruby.min.runtimes').should == '2'
+    @web_app.context.findParameter('jruby.max.runtimes').should == '6'
+  end
+
+  it "should configure rack filter" do
+    @web_app.add_rack_filter
+    @web_app.context.findFilterDefs().should have(1).filters
+  end
+
+  it "should configure rack listener" do
+    @web_app.add_rack_context_listener
+    @web_app.context.findApplicationListeners().should have(1).listeners
+  end
+
+  it "should have rack filter already configured" do
+    @web_app.load_default_web_xml
+    @web_app.rack_filter_configured?().should == true
+
+    @web_app.add_rack_filter
+    @web_app.context.findFilterDefs().should have(0).filters
+  end
+
+  it "should have rack listener already configured" do
+    @web_app.load_default_web_xml
+    @web_app.rack_listener_configured?().should == true
+
+    @web_app.add_rack_context_listener
+    @web_app.context.findApplicationListeners().should have(0).listeners
+  end
+
+  def start_context_with_web_xml
+    @web_app.load_default_web_xml
+    start_context
+  end
+
+  def start_context
+    load_tomcat_libs
+    lambda { @web_app.context.start }.should_not raise_error
+  end
+
+  def load_tomcat_libs
+    @web_app.config[:libs_dir] = File.join(File.dirname(__FILE__), '..', '..', 'tomcat-libs')
+    @web_app.add_context_loader
+  end
+  
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: trinidad_jars
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- David Calavera
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-04 00:00:00 +02:00
+default_executable: trinidad
+dependencies: []
+
+description: 
+email: calavera@apache.org
+executables: 
+- trinidad
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- lib/trinidad/jars.rb
+- trinidad-libs/jetty-util-6.1.14.jar
+- trinidad-libs/jruby-rack-0.9.7-SNAPSHOT.jar
+- trinidad-libs/jsp-2.1.jar
+- trinidad-libs/jsp-api-2.1.jar
+- trinidad-libs/servlet-api-2.5-6.1.14.jar
+- trinidad-libs/tomcat-core.jar
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://calavera.github.com/trinidad
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: trinidad_jars
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Common jars for Trinidad
+test_files: 
+- spec/fixtures/foo.rb
+- spec/fixtures/trinidad_foo_extension.rb
+- spec/spec_helper.rb
+- spec/trinidad/command_line_parser_spec.rb
+- spec/trinidad/extensions_spec.rb
+- spec/trinidad/server_spec.rb
+- spec/trinidad/web_app_spec.rb