lucidimagination-warbler 1.3.2.dev

data/spec/sample_war/public/robots.txt

@@ -0,0 +1,5 @@
+# See http://www.robotstxt.org/wc/norobots.html for documentation on how to use the robots.txt file
+#
+# To ban all spiders from the entire site uncomment the next two lines:
+# User-Agent: *
+# Disallow: /

data/spec/spec_helper.rb

@@ -0,0 +1,112 @@
+#--
+# Copyright (c) 2010-2011 Engine Yard, Inc.
+# Copyright (c) 2007-2009 Sun Microsystems, Inc.
+# This source code is available under the MIT license.
+# See the file LICENSE.txt for 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
+
+module Spec::Example::ExampleGroupMethods
+  def run_in_directory(dir)
+    before :each do
+      (@pwd ||= []) << Dir.getwd
+      Dir.chdir(@pwd.first) # let directory always be relative to project root
+      mkdir_p(dir, :verbose => false)
+      Dir.chdir(dir)
+    end
+
+    after :each do
+      Dir.chdir(@pwd.pop)
+    end
+  end
+
+  def use_fresh_rake_application
+    before :each do
+      @rake = Rake::Application.new
+      Rake.application = @rake
+      verbose(false)
+    end
+  end
+
+  def use_fresh_environment
+    before(:each) do
+      @env_save = {}
+      (ENV.keys.grep(/BUNDLE/) + ["RUBYOPT"]).each {|k| @env_save[k] = ENV[k]; ENV.delete(k)}
+    end
+
+    after(:each) do
+      @env_save.keys.each {|k| ENV[k] = @env_save[k]}
+    end
+  end
+
+  def cleanup_temp_files
+    after(:each) do
+      rm_rf FileList["log", ".bundle", "tmp/war"]
+      rm_f FileList["*.war", "*.foobar", "**/config.ru", "*web.xml*", "config/web.xml*", "config/warble.rb",
+                    "file.txt", 'manifest', '*Gemfile*', 'MANIFEST.MF*', 'init.rb*', '**/*.class']
+    end
+  end
+
+  def run_out_of_process_with_drb
+    before :all do
+      require 'drb'
+      DRb.start_service
+      @orig_dir = Dir.pwd
+    end
+
+    let(:drbclient) do
+      drb
+      DRbObject.new(nil, 'druby://127.0.0.1:7890').tap do |drbclient|
+        loop { (drbclient.alive? && break) rescue nil }
+      end
+    end
+
+    let(:drb) do
+      Thread.new do
+        ruby "-I#{Warbler::WARBLER_HOME}/lib", File.join(@orig_dir, 'spec/drb_helper.rb')
+      end
+    end
+
+    after :each do
+      drbclient.stop
+      drb.join
+    end
+  end
+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/application_spec.rb

@@ -0,0 +1,95 @@
+#--
+# Copyright (c) 2010-2011 Engine Yard, Inc.
+# Copyright (c) 2007-2009 Sun Microsystems, Inc.
+# This source code is available under the MIT license.
+# See the file LICENSE.txt for details.
+#++
+
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Warbler::Application do
+  run_in_directory "spec/sample_war"
+
+  before :each do
+    verbose(false)
+    @argv = ARGV.dup
+    ARGV.clear
+    @app = Rake.application
+    rm_f "config/warble.rb"
+    @detection = Warbler.framework_detection
+    Warbler.framework_detection = false
+  end
+
+  after :each do
+    Rake.application = @app
+    Warbler.project_application = nil
+    Warbler.application = nil
+    Warbler.framework_detection = @detection
+    @argv.reverse.each {|a| ARGV.unshift a}
+    rm_rf FileList['vendor/plugins/warbler']
+  end
+
+  it "should be able to list its tasks" do
+    ARGV.unshift "-T"
+    output = capture do
+      Warbler::Application.new.run
+    end
+    output.should =~ /warble war\s/
+    output.should =~ /warble war:clean/
+    output.should =~ /warble war:debug/
+  end
+
+  it "should display the version" do
+    ARGV.unshift "version"
+    capture { Warbler::Application.new.run }.should =~ /#{Warbler::VERSION}/
+  end
+
+  it "should copy a fresh config file into place" do
+    File.exists?("config/warble.rb").should_not be_true
+    ARGV.unshift "config"
+    silence { Warbler::Application.new.run }
+    File.exists?("config/warble.rb").should be_true
+  end
+
+  it "should refuse to copy over an existing config file" do
+    touch "config/warble.rb"
+    ARGV.unshift "config"
+    capture { Warbler::Application.new.run }.should =~ /already exists/
+  end
+
+  it "should complain if the config directory is missing" do
+    begin
+      mv "config", "config-tmp"
+      ARGV.unshift "config"
+      capture { Warbler::Application.new.run }.should =~ /missing/
+    ensure
+      mv "config-tmp", "config"
+    end
+  end
+
+  it "should refuse to pluginize if the vendor/plugins/warbler directory exists" do
+    mkdir_p "vendor/plugins/warbler"
+    ARGV.unshift "pluginize"
+    silence { Warbler::Application.new.run }
+    File.exist?("vendor/plugins/warbler/tasks/warbler.rake").should_not be_true
+  end
+
+  it "should define a pluginize task for adding the tasks to a Rails application" do
+    ARGV.unshift "pluginize"
+    Warbler::Application.new.run
+    File.exist?("vendor/plugins/warbler/tasks/warbler.rake").should be_true
+  end
+
+  it "should provide a means to load the project Rakefile" do
+    Warbler::Application.new.load_project_rakefile
+  end
+end
+
+describe Warbler::Application do
+  it "should report Warbler version with --version" do
+    ruby = File.join Config::CONFIG['bindir'], 'ruby'
+    output = `#{ruby} -rubygems -Ilib -S bin/warble --version`.chomp
+    output.should =~ /warbler/i
+    output.should =~ /#{Warbler::VERSION}/
+  end
+end

data/spec/warbler/bundler_spec.rb

@@ -0,0 +1,136 @@
+#--
+# Copyright (c) 2010-2011 Engine Yard, Inc.
+# Copyright (c) 2007-2009 Sun Microsystems, Inc.
+# This source code is available under the MIT license.
+# See the file LICENSE.txt for details.
+#++
+
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Warbler::Jar, "with Bundler" do
+  use_fresh_rake_application
+  use_fresh_environment
+  run_out_of_process_with_drb
+
+  def file_list(regex)
+    jar.files.keys.select {|f| f =~ regex }
+  end
+
+  def use_config(&block)
+    @extra_config = block
+  end
+
+  let(:config) { drbclient.config(@extra_config) }
+  let(:jar) { drbclient.jar }
+
+  context "in a war project" do
+    run_in_directory "spec/sample_war"
+    cleanup_temp_files
+
+    before :each do
+      File.open("Gemfile", "w") {|f| f << "gem 'rspec'"}
+    end
+
+    it "detects a Bundler trait" do
+      config.traits.should include(Warbler::Traits::Bundler)
+    end
+
+    it "detects a Gemfile and process only its gems" do
+      use_config do |config|
+        config.gems << "rake"
+      end
+      jar.apply(config)
+      file_list(%r{WEB-INF/Gemfile}).should_not be_empty
+      file_list(%r{WEB-INF/gems/specifications/rspec}).should_not be_empty
+      file_list(%r{WEB-INF/gems/specifications/rake}).should be_empty
+    end
+
+    it "copies Gemfiles into the war" do
+      File.open("Gemfile.lock", "w") {|f| f << "GEM"}
+      jar.apply(config)
+      file_list(%r{WEB-INF/Gemfile}).should_not be_empty
+      file_list(%r{WEB-INF/Gemfile.lock}).should_not be_empty
+    end
+
+    it "allows overriding of the gem path when using Bundler" do
+      use_config do |config|
+        config.gem_path = '/WEB-INF/jewels'
+      end
+      jar.apply(config)
+      file_list(%r{WEB-INF/jewels/specifications/rspec}).should_not be_empty
+    end
+
+    it "works with :git entries in Gemfiles" do
+      File.open("Gemfile", "w") {|f| f << "gem 'warbler', :git => '#{Warbler::WARBLER_HOME}'\n"}
+      silence { ruby "-S", "bundle", "install", "--local" }
+      jar.apply(config)
+      file_list(%r{WEB-INF/gems/bundler/gems/warbler[^/]*/lib/warbler/version\.rb}).should_not be_empty
+      file_list(%r{WEB-INF/gems/bundler/gems/warbler[^/]*/warbler.gemspec}).should_not be_empty
+    end
+
+    it "does not work with :path entries in Gemfiles" do
+      File.open("Gemfile", "w") {|f| f << "gem 'warbler', :path => '#{Warbler::WARBLER_HOME}'\n"}
+      silence do
+        ruby "-S", "bundle", "install", "--local"
+        jar.apply(config)
+      end
+      file_list(%r{warbler}).should be_empty
+    end
+
+    it "does not bundle dependencies in the test group by default" do
+      File.open("Gemfile", "w") {|f| f << "gem 'rake'\ngroup :test do\ngem 'rspec'\nend\n"}
+      jar.apply(config)
+      file_list(%r{WEB-INF/gems/gems/rake[^/]*/}).should_not be_empty
+      file_list(%r{WEB-INF/gems/gems/rspec[^/]*/}).should be_empty
+      file_list(%r{WEB-INF/gems/specifications/rake}).should_not be_empty
+      file_list(%r{WEB-INF/gems/specifications/rspec}).should be_empty
+    end
+
+    it "adds BUNDLE_WITHOUT to init.rb" do
+      jar.add_init_file(config)
+      contents = jar.contents('META-INF/init.rb')
+      contents.should =~ /ENV\['BUNDLE_WITHOUT'\]/
+      contents.should =~ /'development:test'/
+    end
+
+    it "uses ENV['BUNDLE_GEMFILE'] if set" do
+      mv "Gemfile", "Special-Gemfile"
+      ENV['BUNDLE_GEMFILE'] = "Special-Gemfile"
+      config.traits.should include(Warbler::Traits::Bundler)
+    end
+  end
+
+  context "in a jar project" do
+    run_in_directory "spec/sample_jar"
+    cleanup_temp_files
+
+    it "works with :git entries in Gemfiles" do
+      File.open("Gemfile", "w") {|f| f << "gem 'warbler', :git => '#{Warbler::WARBLER_HOME}'\n"}
+      silence { ruby "-S", "bundle", "install", "--local" }
+      jar.apply(config)
+      file_list(%r{^bundler/gems/warbler[^/]*/lib/warbler/version\.rb}).should_not be_empty
+      file_list(%r{^bundler/gems/warbler[^/]*/warbler.gemspec}).should_not be_empty
+    end
+  end
+
+  context "when frozen" do
+    run_in_directory "spec/sample_bundler"
+
+    it "includes the bundler gem" do
+      jar.apply(config)
+      config.gems.detect{|k,v| k.name == 'bundler'}.should_not be_nil
+      file_list(/bundler-/).should_not be_empty
+    end
+
+    it "does not include the bundler cache directory" do
+      jar.apply(config)
+      file_list(%r{vendor/bundle}).should be_empty
+    end
+
+    it "includes ENV['BUNDLE_FROZEN'] in init.rb" do
+      jar.apply(config)
+      contents = jar.contents('META-INF/init.rb')
+      contents.split("\n").grep(/ENV\['BUNDLE_FROZEN'\] = '1'/).should_not be_empty
+    end
+  end
+end

data/spec/warbler/config_spec.rb

@@ -0,0 +1,130 @@
+#--
+# Copyright (c) 2010-2011 Engine Yard, Inc.
+# Copyright (c) 2007-2009 Sun Microsystems, Inc.
+# This source code is available under the MIT license.
+# See the file LICENSE.txt for details.
+#++
+
+require File.expand_path('../../spec_helper', __FILE__)
+
+describe Warbler::Config do
+  before :each do
+    verbose(false)
+  end
+
+  context "in an unknown application" do
+    run_in_directory 'spec/sample_war/tmp'
+
+    it "has suitable default values" do
+      config = Warbler::Config.new
+      config.includes.should be_empty
+      config.jar_name.size.should > 0
+    end
+  end
+
+  context "in a web application" do
+    run_in_directory 'spec/sample_war'
+
+    after :each do
+      rm_f "vendor/test.log"
+    end
+
+    it "should have suitable default values" do
+      config = Warbler::Config.new
+      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.jar_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.jar_name = "mywar"
+      end
+      config.jar_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
+end