buildr-tomcat 0.0.1

data/COPYING.LESSER

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,34 @@
+buildr-tomcat
+=============
+
+buildr-tomcat provides a plugin for Buildr that allows you to run a war-packaged project in an embedded Tomcat.
+
+It is largely based on the Jetty plugin, but is somewhat simplified.
+
+Installation:
+
+	git clone https://github.com/technophobia/buildr-tomcat.git
+	cd buildr-tomcat
+	./build.sh
+
+Example:
+
+	require 'tomcat'
+
+	define "my-webapp" do
+		compile.with # some dependencies here
+		package(:war)
+
+		task('tomcat') do |task|
+			name = 'my-webapp'
+			Buildr::Tomcat::explode(self)
+			Buildr::Tomcat.new(name, "http://localhost:8084/#{name}", "#{name}/target/#{name}-#{VERSION_NUMBER}").run
+
+			trap 'SIGINT' do
+				puts "Stopping Tomcat"
+				tomcat.stop
+			end
+			Thread.stop
+		end
+	end
+

data/Rakefile

@@ -0,0 +1,47 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+# To work-around a bug with gemcutter: http://stackoverflow.com/questions/4932881/gemcutter-rake-build-now-throws-undefined-method-write-for-syckemitter
+require 'psych' if RUBY_VERSION >= '1.9.2' && !RUBY_PLATFORM[/java/]
+
+# We need JAVA_HOME for most things (setup, spec, etc).
+unless ENV['JAVA_HOME']
+  if RUBY_PLATFORM[/java/]
+    ENV['JAVA_HOME'] = Java.java.lang.System.getProperty('java.home')
+  elsif RUBY_PLATFORM[/darwin/]
+    ENV['JAVA_HOME'] = '/System/Library/Frameworks/JavaVM.framework/Home'
+  else
+    fail "Please set JAVA_HOME first (set JAVA_HOME=... or env JAVA_HOME=... rake ...)"
+  end
+end
+
+
+# Load the Gem specification for the current platform (Ruby or JRuby).
+def spec(platform = RUBY_PLATFORM[/java/] || 'ruby')
+  @specs ||= ['ruby', 'java', 'x86-mswin32'].inject({}) { |hash, spec_platform|
+    $platform = spec_platform
+    hash.update(spec_platform=>Gem::Specification.load('buildr-tomcat.gemspec'))
+  }
+  @specs[platform]
+end
+
+# Tell us if we need sudo for various commands.
+def sudo_needed?
+  RbConfig::CONFIG['host_os'] !~ /windows|cygwin|bccwin|cygwin|djgpp|mingw|mswin|wince/i && !ENV['GEM_HOME']
+end
+
+
+desc 'Clean up all temporary directories used for running tests, creating documentation, packaging, etc.'
+task :clobber

data/lib/tomcat.rb

@@ -0,0 +1,202 @@
+require 'thread'
+
+module Buildr
+  
+class Tomcat
+
+    # Which version of Tomcat we're using by default (change with options.tomcat.version).
+    VERSION = "6.1.3"
+    SLF4J_VERSION = "1.4.3"
+
+    TOMCAT_VERSION = '7.0.21'
+    TOMCAT = [ "org.apache.tomcat.embed:tomcat-embed-jasper:jar:#{TOMCAT_VERSION}", "org.apache.tomcat:tomcat-catalina:jar:#{TOMCAT_VERSION}", "org.apache.tomcat:tomcat-jasper:jar:#{TOMCAT_VERSION}", "org.apache.tomcat:tomcat-servlet-api:jar:#{TOMCAT_VERSION}", "org.apache.tomcat.embed:tomcat-embed-core:jar:#{TOMCAT_VERSION}", "org.apache.tomcat.embed:tomcat-embed-logging-log4j:jar:#{TOMCAT_VERSION}" ]
+    TOMCAT << 'buildr-tomcat:buildr-tomcat:jar:1.0.0'
+
+    Java.classpath << File.dirname(__FILE__)
+    Java.classpath << TOMCAT
+
+
+
+    # Default URL fort  (change with options.tomcat.url).
+    URL = "http://localhost:8080"
+
+    class << self
+
+      # :call-seq:
+      #   instance() => Tomcat
+      #
+      # Returns an instance of Tomcat.
+      def instance()
+        @instance ||= Tomcat.new("", URL)
+      end
+
+      #
+      # Explode a war-file into the target directory.
+      #
+      #
+      def explode(project)
+        name = project.name.split(':').last
+        dirname = "#{name}/target/#{name}-#{VERSION_NUMBER}"
+
+        if !File.exists? dirname
+          system("unzip -q #{name}/target/#{name}-#{VERSION_NUMBER}.war -d #{dirname}")
+        end
+      end
+    end
+
+    def initialize(name, url, webAppLocation) #:nodoc:
+      @webAppLocation = webAppLocation
+      @url = url
+      namespace name do
+        @setup = task("setup")
+        @teardown = task("teardown")
+        @use = task("use") { fire }
+      end
+    end
+
+    # The URL for the Tomcat server. Leave as is if you want to use the default server
+    # (http://localhost:8080).
+    attr_accessor :url
+
+    # :call-seq:
+    #    start(pipe?)
+    #
+    # Starts Tomcat. This method does not return, it keeps the thread running until
+    # Tomcat is stopped. If you want to run Tomcat parallel with other tasks in the build,
+    # invoke the #use task instead.
+    def start(sync = nil)
+      begin
+        puts "classpath #{Java.classpath.inspect}"
+        port = URI.parse(url).port
+        puts "***** Starting Tomcat at http://localhost:#{port}"
+        Java.load
+	tomcat = Java.com.technophobia.buildr.tomcat.TomcatWrapper.new(port, URI.parse(url).path, @webAppLocation)
+	
+	puts "***** Tomcat has started up *****"
+        sync << "Started" if sync
+        sleep # Forever
+      rescue Interrupt # Stopped from console
+	puts "Interrupted"
+      rescue Exception=>error
+        puts "#{error.class}: #{error.message}"
+      end
+      exit! # No at_exit
+    end
+
+    def run() 
+        puts "***** RUNNING IN THE BACKGROUND *****"
+	use.invoke
+    end
+
+    # :call-seq:
+    #    stop()
+    #
+    # Stops Tomcat. Stops a server running in a separate process.
+    def stop()
+      puts "***** STOPPING TOMCAT *****"
+      uri = URI.parse(url)
+      begin
+        Net::HTTP.start(uri.host, uri.port) do |http|
+          http.request_post "/buildr/stop", ""
+        end
+      rescue Errno::ECONNREFUSED
+        # Expected if Tomcat server not running.
+      rescue EOFError
+        # We get EOFError because Tomcat is brutally killed.
+      end
+      puts "***** Told tomcat server to stop"
+    end
+
+
+    # :call-seq:
+    #   running?() => boolean
+    #
+    # Returns true if it finds a running Tomcat server that supports the Buildr
+    # requests for deploying, stopping, etc.
+    def running?()
+      puts "Checking if already running..."
+      uri = URI.parse(url)
+      begin
+        Net::HTTP.start(uri.host, uri.port) do |http|
+          response = http.request_get("/buildr/")
+          response.is_a?(Net::HTTPSuccess) && response.body =~ /Alive/
+        end
+      rescue Errno::ECONNREFUSED, Errno::EBADF
+        false
+      end
+    end
+
+
+    # :call-seq:
+    #   setup(*prereqs) => task
+    #   setup(*prereqs) { |task| .. } => task
+    #
+    # This task executes when Tomcat is first used in the build. You can use it to
+    # deploy artifacts into Tomcat.
+    def setup(*prereqs, &block)
+      @setup.enhance prereqs, &block
+    end
+
+    # :call-seq:
+    #   teardown(*prereqs) => task
+    #   teardown(*prereqs) { |task| .. } => task
+    #
+    # This task executes when the build is done. You can use it to undeploy artifacts
+    # previously deployed into Tomcat.
+    def teardown(*prereqs, &block)
+      @teardown.enhance prereqs, &block
+    end
+
+    # :call-seq:
+    #   use(*prereqs) => task
+    #   use(*prereqs) { |task| .. } => task
+    #
+    # If you intend to use Tomcat, invoke this task. It will start a new instance of
+    # Tomcat and close it when the build is done. However, if you already have a server
+    # running in the background (e.g. tomcat:start), it will use that server and will
+    # not close it down.
+    def use(*prereqs, &block)
+      @use.enhance prereqs, &block
+    end
+
+
+
+  protected
+
+    # If you want to start Tomcat inside the build, call this method instead of #start.
+    # It will spawn a separate process that will run Tomcat, and will stop Tomcat when
+    # the build ends. However, if you already started Tomcat from the console (with
+    # take tomcat:start), it will use the existing instance without shutting it down.
+    def fire()
+      puts "***** Firing up Tomcat *****"
+      unless running?
+        sync = Queue.new
+        Thread.new { start sync }
+        # Wait for Tomcat to Fire up before doing anything else.
+        sync.pop == "Started" or fail "Tomcat not started"
+        puts "***** Tomcat fired up *****"
+        at_exit { stop }
+      end
+      @setup.invoke
+      at_exit { @teardown.invoke }
+    end
+  end
+
+
+  namespace "tomcat" do
+    desc "Start an instance of Tomcat running in the background"
+    task("start") { Tomcat.instance.start }
+    desc "Stop an instance of Tomcat running in the background"
+    task("stop") { Tomcat.instance.stop }
+  end
+
+  # :call-seq:
+  #   tomcat() => Tomcat
+  #
+  # Returns a Tomcat object. You can use this to discover the Tomcat#use task,
+  # configure the Tomcat#setup and Tomcat#teardown tasks, deploy and undeploy to Tomcat.
+  def tomcat()
+    @tomcat ||= Tomcat.instance
+  end
+
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: buildr-tomcat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rory Gibson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-26 00:00:00.000000000 Z
+dependencies: []
+description: ! "  Provides the ability to run a war-packaged artifact using an embedded
+  Tomcat. \n"
+email: rgibson@technophobia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- COPYING.LESSER
+- lib/tomcat.rb
+- lib/com/technophobia/buildr/tomcat/TomcatWrapper$2.class
+- lib/com/technophobia/buildr/tomcat/TomcatWrapper.class
+- lib/com/technophobia/buildr/tomcat/TomcatWrapper$1.class
+homepage: http://github.com/technophobia/buildr-tomcat
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Tomcat plugin for Buildr
+test_files: []