fjc-warbler 0.9.12

data/lib/warbler/version.rb

@@ -0,0 +1,9 @@
+#--
+# (c) Copyright 2007-2008 Sun Microsystems, Inc.
+# See the file LICENSES.txt included with the distribution for
+# software license details.
+#++
+
+module Warbler
+  VERSION = "0.9.12"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,43 @@
+#--
+# (c) Copyright 2007-2008 Sun Microsystems, Inc.
+# See the file LICENSES.txt included with the distribution for
+# software license details.
+#++
+
+require 'rubygems'
+require 'spec'
+
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+require 'warbler'
+
+raise %{Error: detected running Warbler specs in a Rails app;
+Warbler specs are destructive to application directories.} if File.directory?("app")
+
+def silence(io = nil)
+  require 'stringio'
+  old_stdout = $stdout
+  old_stderr = $stderr
+  $stdout = io || StringIO.new
+  $stderr = io || StringIO.new
+  yield
+ensure
+  $stdout = old_stdout
+  $stderr = old_stderr
+end
+
+def capture(&block)
+  require 'stringio'
+  io = StringIO.new
+  silence(io, &block)
+  io.string
+end
+
+Spec::Runner.configure do |config|
+  config.after(:each) do
+    class << Object
+      public :remove_const
+    end
+    Object.remove_const("Rails") rescue nil
+    rm_rf "vendor"
+  end
+end

data/spec/warbler/config_spec.rb

@@ -0,0 +1,110 @@
+#--
+# (c) Copyright 2007-2008 Sun Microsystems, Inc.
+# See the file LICENSES.txt included with the distribution for
+# software license details.
+#++
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Warbler::Config do
+  it "should have suitable default values" do
+    config = Warbler::Config.new
+    config.staging_dir.should == "tmp/war"
+    config.dirs.should include(*Warbler::Config::TOP_DIRS.select{|d| File.directory?(d)})
+    config.includes.should be_empty
+    config.java_libs.should_not be_empty
+    config.war_name.size.should > 0
+    config.webxml.should be_kind_of(OpenStruct)
+    config.pathmaps.should be_kind_of(OpenStruct)
+    config.pathmaps.public_html.should == ["%{public/,}p"]
+  end
+
+  it "should allow configuration through an initializer block" do
+    config = Warbler::Config.new do |c|
+      c.staging_dir = "/var/tmp"
+      c.war_name = "mywar"
+    end
+    config.staging_dir.should == "/var/tmp"
+    config.war_name.should == "mywar"
+  end
+
+  it "should allow gems to be added/changed with =, +=, -=, <<" do
+    config = Warbler::Config.new do |c|
+      c.gems += ["activerecord-jdbc-adapter"]
+      c.gems -= ["rails"]
+      c.gems << "tzinfo"
+      c.gems = ["camping"]
+    end
+  end
+
+  it "should exclude log files by default" do
+    mkdir_p "vendor"
+    touch "vendor/test.log"
+    config = Warbler::Config.new
+    config.exclude_logs.should == true
+    config.excludes.include?("vendor/test.log").should == true
+  end
+
+  it "should include log files if exclude_logs is false" do
+    mkdir_p "vendor"
+    touch "vendor/test.log"
+    config = Warbler::Config.new {|c| c.exclude_logs = false }
+    config.exclude_logs.should == false
+    config.excludes.include?("vendor/test.log").should == false
+  end
+
+  it "should exclude Warbler itself when run as a plugin" do
+    config = Warbler::Config.new
+    config.excludes.include?("vendor/plugins/warbler").should == false
+    config = Warbler::Config.new File.join(Dir.getwd, "vendor", "plugins", "warbler")
+    config.excludes.include?("vendor/plugins/warbler").should == true
+  end
+
+  it "should generate context parameters from the webxml openstruct" do
+    config = Warbler::Config.new
+    config.webxml.a.b.c = "123"
+    config.webxml.com.example.config = "blah"
+    config.webxml.rails.env = 'staging'
+    config.webxml.jruby.min.runtimes = 2
+    config.webxml.jruby.max.runtimes = 4
+    config.webxml['org']['jruby']['rack'] = "rails"
+    params = config.webxml.context_params
+    params.should have_key('a.b.c')
+    params.should have_key('rails.env')
+    params.should have_key('jruby.min.runtimes')
+    params.should have_key('jruby.max.runtimes')
+    params['a.b.c'].should == "123"
+    params['com.example.config'].should == "blah"
+    params['rails.env'].should == "staging"
+    params['jruby.min.runtimes'].should == "2"
+    params['jruby.max.runtimes'].should == "4"
+    params['org.jruby.rack'].should == "rails"
+  end
+
+  it "should determine the context listener from the webxml.booter parameter" do
+    config = Warbler::Config.new
+    config.webxml.booter = :rack
+    config.webxml.servlet_context_listener.should == "org.jruby.rack.RackServletContextListener"
+    config = Warbler::Config.new
+    config.webxml.booter = :merb
+    config.webxml.servlet_context_listener.should == "org.jruby.rack.merb.MerbServletContextListener"
+    config = Warbler::Config.new
+    config.webxml.servlet_context_listener.should == "org.jruby.rack.rails.RailsServletContextListener"
+  end
+
+  it "should not include ignored webxml keys in the context params hash" do
+    Warbler::Config.new.webxml.context_params.should_not have_key('ignored')
+    Warbler::Config.new.webxml.context_params.should_not have_key('jndi')
+    Warbler::Config.new.webxml.context_params.should_not have_key('booter')
+  end
+
+  it "should have a helpful string representation for an empty key" do
+    Warbler::Config.new.webxml.missing_key.to_s.should =~ /No value for 'missing_key' found/
+  end
+
+  it "should HTML-escape all webxml keys and values" do
+    config = Warbler::Config.new
+    config.webxml.a["b&"].c = "123<hi>456"
+    config.webxml.context_params['a.b&amp;.c'].should == "123&lt;hi&gt;456"
+  end
+end

data/spec/warbler/gems_spec.rb

@@ -0,0 +1,39 @@
+#--
+# (c) Copyright 2007-2008 Sun Microsystems, Inc.
+# See the file LICENSES.txt included with the distribution for
+# software license details.
+#++
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Warbler::Gems do
+  it "should accept a hash for initialization" do
+    gems = Warbler::Gems.new({"actionpack" => "1.2.3"})
+    gems.should have_key("actionpack")
+    gems["actionpack"].should == "1.2.3"
+  end
+
+  it "should accept an array for initialization" do
+    gems = Warbler::Gems.new ["activerecord"]
+    gems.should have_key("activerecord")
+  end
+
+  it "should allow gems with a version" do
+    gems = Warbler::Gems.new
+    gems["actionpack"] = "> 1.2.3"
+    gems["actionpack"].should == "> 1.2.3"
+  end
+
+  it "should allow gems without an explicit version" do
+    gems = Warbler::Gems.new
+    gems << "actionpack"
+    gems.should have_key("actionpack")
+  end
+
+  it "should allow to add gems" do
+    gems = Warbler::Gems.new
+    gems << "rails"
+    gems += ["activerecord-jdbcmysql-adapter", "jdbc-mysql", "jruby-openssl"]
+    ["rails", "activerecord-jdbcmysql-adapter", "jdbc-mysql", "jruby-openssl"].each {|g| gems.should have_key(g)}
+  end
+end

data/spec/warbler/task_spec.rb

@@ -0,0 +1,432 @@
+#--
+# (c) Copyright 2007-2008 Sun Microsystems, Inc.
+# See the file LICENSES.txt included with the distribution for
+# software license details.
+#++
+
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Warbler::Task do
+  before(:each) do
+    @rake = Rake::Application.new
+    Rake.application = @rake
+    verbose(false)
+    @pwd = Dir.getwd
+    Dir.chdir("spec/sample")
+    mkdir_p "log"
+    touch "log/test.log"
+    @config = Warbler::Config.new do |config|
+      config.staging_dir = "tmp/war"
+      config.war_name = "warbler"
+      config.gems = ["rake"]
+      config.webxml.jruby.max.runtimes = 5
+    end
+  end
+
+  after(:each) do
+    define_tasks "clean"
+    Rake::Task["warble:clean"].invoke
+    rm_rf "log"
+    rm_f FileList["config.ru", "*web.xml", "config/web.xml*", "config/warble.rb"]
+    Dir.chdir(@pwd)
+  end
+
+  def define_tasks(*tasks)
+    options = tasks.last.kind_of?(Hash) ? tasks.pop : {}
+    @defined_tasks ||= []
+    tasks.each do |task|
+      unless @defined_tasks.include?(task)
+        Warbler::Task.new "warble", @config, "define_#{task}_task".to_sym do |t|
+          options.each {|k,v| t.send "#{k}=", v }
+        end
+        @defined_tasks << task
+      end
+    end
+  end
+
+  def file_list(regex)
+    FileList["#{@config.staging_dir}/**/*"].select {|f| f =~ regex }
+  end
+
+  it "should define a clean task for removing the staging directory" do
+    define_tasks "clean"
+    mkdir_p @config.staging_dir
+    Rake::Task["warble:clean"].invoke
+    File.exist?(@config.staging_dir).should == false
+  end
+
+  it "should define a public task for copying the public files" do
+    define_tasks "public"
+    Rake::Task["warble:public"].invoke
+    file_list(%r{^#{@config.staging_dir}/index\.html}).should_not be_empty
+  end
+
+  it "should define a gems task for unpacking gems" do
+    @config.gems << "rails"
+    define_tasks "gems"
+    Rake::Task["warble:gems"].invoke
+    file_list(%r{WEB-INF/gems/gems/rake.*/lib/rake.rb}).should_not be_empty
+    file_list(%r{WEB-INF/gems/specifications/rake.*\.gemspec}).should_not be_empty
+  end
+
+  it "should define a app task for copying application files" do
+    define_tasks "app", "gems"
+    Rake::Task["warble:app"].invoke
+    file_list(%r{WEB-INF/log}).should_not be_empty
+    file_list(%r{WEB-INF/log/*.log}).should be_empty
+  end
+
+  def expand_webxml
+    define_tasks "webxml"
+    Rake::Task["warble:webxml"].invoke
+    require 'rexml/document'
+    File.open("#{@config.staging_dir}/WEB-INF/web.xml") do |f|
+      REXML::Document.new(f).root.elements
+    end
+  end
+
+  it "should define a webxml task for creating web.xml" do
+    elements = expand_webxml
+    elements.to_a(
+      "context-param/param-name[text()='jruby.max.runtimes']"
+      ).should_not be_empty
+    elements.to_a(
+      "context-param/param-name[text()='jruby.max.runtimes']/../param-value"
+      ).first.text.should == "5"
+  end
+
+  it "should include custom context parameters" do
+    @config.webxml.some.custom.config = "myconfig"
+    elements = expand_webxml
+    elements.to_a(
+      "context-param/param-name[text()='some.custom.config']"
+      ).should_not be_empty
+    elements.to_a(
+      "context-param/param-name[text()='some.custom.config']/../param-value"
+      ).first.text.should == "myconfig"
+  end
+
+  it "should allow one jndi resource to be included" do
+    @config.webxml.jndi = 'jndi/rails'
+    elements = expand_webxml
+    elements.to_a(
+      "resource-ref/res-ref-name[text()='jndi/rails']"
+      ).should_not be_empty
+  end
+
+  it "should allow multiple jndi resources to be included" do
+    @config.webxml.jndi = ['jndi/rails1', 'jndi/rails2']
+    elements = expand_webxml
+    elements.to_a(
+      "resource-ref/res-ref-name[text()='jndi/rails1']"
+      ).should_not be_empty
+    elements.to_a(
+      "resource-ref/res-ref-name[text()='jndi/rails2']"
+      ).should_not be_empty
+  end
+
+  it "should not include any ignored context parameters" do
+    @config.webxml.foo = "bar"
+    @config.webxml.ignored << "foo"
+    elements = expand_webxml
+    elements.to_a(
+      "context-param/param-name[text()='foo']"
+      ).should be_empty
+    elements.to_a(
+      "context-param/param-name[text()='ignored']"
+      ).should be_empty
+    elements.to_a(
+      "context-param/param-name[text()='jndi']"
+      ).should be_empty
+  end
+
+  it "should use a config/web.xml if it exists" do
+    define_tasks "webxml"
+    mkdir_p "config"
+    File.open("config/web.xml", "w") {|f| f << "Hi there" }
+    Rake::Task["warble:webxml"].invoke
+    files = file_list(%r{WEB-INF/web.xml$})
+    files.should_not be_empty
+    File.open(files.first) {|f| f.read}.should == "Hi there"
+  end
+
+  it "should use a config/web.xml.erb if it exists" do
+    define_tasks "webxml"
+    mkdir_p "config"
+    File.open("config/web.xml.erb", "w") {|f| f << "Hi <%= webxml.public.root %>" }
+    Rake::Task["warble:webxml"].invoke
+    files = file_list(%r{WEB-INF/web.xml$})
+    files.should_not be_empty
+    File.open(files.first) {|f| f.read}.should == "Hi /"
+  end
+
+  it "should define a java_libs task for copying java libraries" do
+    define_tasks "java_libs"
+    Rake::Task["warble:java_libs"].invoke
+    file_list(%r{WEB-INF/lib/jruby-complete.*\.jar$}).should_not be_empty
+  end
+
+  it "should define an app task for copying application files" do
+    gems_ran = false
+    task "warble:gems" do
+      gems_ran = true
+    end
+    define_tasks "app"
+    Rake::Task["warble:app"].invoke
+    file_list(%r{WEB-INF/app$}).should_not be_empty
+    file_list(%r{WEB-INF/config$}).should_not be_empty
+    file_list(%r{WEB-INF/lib$}).should_not be_empty
+    gems_ran.should == true
+  end
+
+  it "should define a jar task for creating the .war" do
+    define_tasks "jar"
+    mkdir_p @config.staging_dir
+    touch "#{@config.staging_dir}/file.txt"
+    Rake::Task["warble:jar"].invoke
+    File.exist?("warbler.war").should == true
+  end
+
+  it "should define an exploded task for creating an exploded Rails app" do
+    @config.java_classes = ["Rakefile"]
+    @config.java_libs = []
+    define_tasks "webxml", "exploded", "java_classes", "gems"
+    Rake::Task['warble:exploded'].invoke
+    File.exist?("web.xml").should == true
+    File.exist?("sun-web.xml").should == true
+    File.symlink?("gems").should == true
+    File.symlink?("public/WEB-INF").should == true
+    Rake::Task['warble:clean:exploded'].invoke
+  end
+
+  it "should accept an autodeploy directory where the war should be created" do
+    define_tasks "jar"
+    require 'tempfile'
+    @config.autodeploy_dir = Dir::tmpdir
+    mkdir_p @config.staging_dir
+    touch "#{@config.staging_dir}/file.txt"
+    Rake::Task["warble:jar"].invoke
+    File.exist?(File.join("#{Dir::tmpdir}","warbler.war")).should == true
+  end
+
+  it "should define a war task for bundling up everything" do
+    app_ran = false; task "warble:app" do; app_ran = true; end
+    public_ran = false; task "warble:public" do; public_ran = true; end
+    jar_ran = false; task "warble:jar" do; jar_ran = true; end
+    webxml_ran = false; task "warble:webxml" do; webxml_ran = true; end
+    define_tasks "main"
+    Rake::Task["warble"].invoke
+    app_ran.should == true
+    public_ran.should == true
+    jar_ran.should == true
+    webxml_ran.should == true
+  end
+
+  it "should be able to exclude files from the .war" do
+    @config.excludes += FileList['lib/tasks/utils.rake']
+    task "warble:gems" do; end
+    define_tasks "app"
+    Rake::Task["warble:app"].invoke
+    file_list(%r{lib/tasks/utils.rake}).should be_empty
+  end
+
+  it "should be able to define all tasks successfully" do
+    Warbler::Task.new "warble", @config
+  end
+
+  it "should read configuration from #{Warbler::Config::FILE}" do
+    mkdir_p "config"
+    File.open(Warbler::Config::FILE, "w") do |dest|
+      contents = 
+        File.open("#{Warbler::WARBLER_HOME}/generators/warble/templates/warble.rb") do |src|
+          src.read
+        end
+      dest << contents.sub(/# config\.war_name/, 'config.war_name'
+        ).sub(/# config.gems << "tzinfo"/, 'config.gems = []')
+    end
+    t = Warbler::Task.new "warble"
+    t.config.war_name.should == "mywar"
+  end
+
+  it "should fail if a gem is requested that is not installed" do
+    @config.gems = ["nonexistent-gem"]
+    lambda {
+      Warbler::Task.new "warble", @config
+    }.should raise_error
+  end
+
+  it "should handle platform-specific gems" do
+    spec = mock "gem spec"
+    spec.stub!(:name).and_return "hpricot"
+    spec.stub!(:version).and_return "0.6.157"
+    spec.stub!(:platform).and_return "java"
+    spec.stub!(:original_platform).and_return "java"
+    spec.stub!(:loaded_from).and_return "hpricot.gemspec"
+    spec.stub!(:dependencies).and_return []
+    Gem.source_index.should_receive(:search).and_return do |gem|
+      gem.name.should == "hpricot"
+      [spec]
+    end
+    File.should_receive(:exist?).with(File.join(Gem.dir, 'cache', "hpricot-0.6.157-java.gem")).and_return true
+    @config.gems = ["hpricot"]
+    define_tasks "gems"
+  end
+
+  it "should allow specification of dependency by Gem::Dependency" do
+    spec = mock "gem spec"
+    spec.stub!(:name).and_return "hpricot"
+    spec.stub!(:version).and_return "0.6.157"
+    spec.stub!(:platform).and_return "java"
+    spec.stub!(:original_platform).and_return "java"
+    spec.stub!(:loaded_from).and_return "hpricot.gemspec"
+    spec.stub!(:dependencies).and_return []
+    Gem.source_index.should_receive(:search).and_return do |gem|
+      gem.name.should == "hpricot"
+      [spec]
+    end
+    File.should_receive(:exist?).with(File.join(Gem.dir, 'cache', "hpricot-0.6.157-java.gem")).and_return true
+    @config.gems = [Gem::Dependency.new("hpricot", "> 0.6")]
+    define_tasks "gems"
+  end
+
+  it "should define a java_classes task for copying loose java classes" do
+    @config.java_classes = FileList["Rakefile"]
+    define_tasks "java_classes"
+    Rake::Task["warble:java_classes"].invoke
+    file_list(%r{WEB-INF/classes/Rakefile$}).should_not be_empty
+  end
+
+  def mock_rails_module
+    rails = Module.new
+    Object.const_set("Rails", rails)
+    version = Module.new
+    rails.const_set("VERSION", version)
+    version.const_set("STRING", "2.1.0")
+    rails
+  end
+
+  it "should auto-detect a Rails application" do
+    task :environment do
+      mock_rails_module
+    end
+    @config = Warbler::Config.new
+    @config.webxml.booter.should == :rails
+    @config.gems["rails"].should == "2.1.0"
+  end
+
+  it "should provide Rails gems by default, unless vendor/rails is present" do
+    rails = nil
+    task :environment do
+      rails = mock_rails_module
+    end
+
+    config = Warbler::Config.new
+    config.gems.should have_key("rails")
+
+    mkdir_p "vendor/rails"
+    config = Warbler::Config.new
+    config.gems.should be_empty
+
+    rm_rf "vendor/rails"
+    rails.stub!(:vendor_rails?).and_return true
+    config = Warbler::Config.new
+    config.gems.should be_empty
+  end
+
+  it "should not try to autodetect frameworks when Warbler.framework_detection is false" do
+    begin
+      Warbler.framework_detection = false
+      task :environment
+      config = Warbler::Config.new
+      config.webxml.booter.should_not == :rails
+      t = Rake::Task['environment']
+      class << t; public :instance_variable_get; end
+      t.instance_variable_get("@already_invoked").should == false
+    ensure
+      Warbler.framework_detection = true
+    end
+  end
+
+  it "should auto-detect a Merb application" do
+    task :merb_env do
+      merb = Module.new
+      Object.const_set("Merb", merb)
+      merb.const_set("VERSION", "0.9.3")
+    end
+    @config = Warbler::Config.new
+    @config.webxml.booter.should == :merb
+    @config.gems["merb-core"].should == "0.9.3"
+    @config.gems.keys.should_not include("rails")
+  end
+
+  it "should auto-detect a Rack application with a config.ru file" do
+    rackup = "run Proc.new {|env| [200, {}, ['Hello World']]}"
+    File.open("config.ru", "w") {|f| f << rackup }
+    @config = Warbler::Config.new
+    @config.webxml.booter.should == :rack
+    @config.webxml.rackup.should == rackup
+  end
+
+  it "should automatically add Rails.configuration.gems to the list of gems" do
+    task :environment do
+      rails = mock_rails_module
+      config = mock "config"
+      rails.stub!(:configuration).and_return(config)
+      gem = mock "gem"
+      gem.stub!(:name).and_return "hpricot"
+      gem.stub!(:version).and_return "=0.6"
+      config.stub!(:gems).and_return [gem]
+    end
+
+    @config = Warbler::Config.new
+    @config.webxml.booter.should == :rails
+    @config.gems["hpricot"].should == "=0.6"
+  end
+
+  it "should set the jruby max runtimes to 1 when MT Rails is detected" do
+    task :environment do
+      rails = mock_rails_module
+      config = mock "config"
+      rails.stub!(:configuration).and_return(config)
+      config.stub!(:threadsafe!)
+    end
+    @config = Warbler::Config.new
+    @config.webxml.booter.should == :rails
+    @config.webxml.jruby.max.runtimes.should == 1
+  end
+end
+
+describe "The warbler.rake file" do
+  it "should be able to list its contents" do
+    output = `#{FileUtils::RUBY} -S rake -f #{Warbler::WARBLER_HOME}/tasks/warbler.rake -T`
+    output.should =~ /war\s/
+    output.should =~ /war:exploded/
+    output.should =~ /war:app/
+    output.should =~ /war:clean/
+    output.should =~ /war:gems/
+    output.should =~ /war:jar/
+    output.should =~ /war:java_libs/
+    output.should =~ /war:java_classes/
+    output.should =~ /war:public/
+  end
+end
+
+describe "Debug targets" do
+  before(:each) do
+    @rake = Rake::Application.new
+    Rake.application = @rake
+    verbose(false)
+    silence { Warbler::Task.new :war, Object.new }
+  end
+
+  it "should print out lists of files" do
+    capture { Rake::Task["war:debug:public"].invoke }.should =~ /public/
+    capture { Rake::Task["war:debug:gems"].invoke }.should =~ /gems/
+    capture { Rake::Task["war:debug:java_libs"].invoke }.should =~ /java_libs/
+    capture { Rake::Task["war:debug:java_classes"].invoke }.should =~ /java_classes/
+    capture { Rake::Task["war:debug:app"].invoke }.should =~ /app/
+    capture { Rake::Task["war:debug:includes"].invoke }.should =~ /include/
+    capture { Rake::Task["war:debug:excludes"].invoke }.should =~ /exclude/
+    capture { Rake::Task["war:debug"].invoke }.should =~ /Config/
+  end
+end