trinidad_daemon_extension 0.2.10 → 0.3.0

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/History.txt

@@ -1,3 +1,10 @@
+== 0.3.0 (2012-03-06)
+
+* Update akuma.jar to latest release 1.7 - fixes init exec issue
+* Update jna.jar to 3.4.0 (no longer included as part of akuma.jar)
+* Replaced the (java) daemonizer implementation org.jruby.trinidad.TrinidadDaemon
+  with a ruby class Trinidad::Extensions::Daemon::TomcatWrapper
+
 == 0.2.10 (2012-01-09)
 
 * Add engine method to the proxy

data/README.md

@@ -0,0 +1,49 @@
+# Trinidad Daemon Extension
+
+Extension to run Trinidad server as a daemon.
+
+## Installation
+
+    jruby -S gem install trinidad_daemon_extension
+
+## Usage
+
+This extension can be enabled from the Trinidad's configuration file or from the 
+command line. It uses a temporal directory to write the pid file but its path 
+can be overridden.
+
+### Configuration file
+
+Configure the daemon in the "extensions" section of the *trinidad.yml* file :
+
+    ---
+      extensions:
+        daemon:
+          # optional by default the pid is written into a temporal directory :
+          pid_file: ./trinidad.pid
+
+The extension also allows tuning JVM arguments to run the daemon with. 
+They just need to be added into the *jvm_args* configuration section:
+
+    ---
+      extensions:
+        daemon:
+          jvm_args: '-XX:MaxPermSize=512m'
+
+**NOTE:** Be aware that *jvm_args* are bare `java` options and not ones 
+accepted by the `jruby` command !
+
+### Command line
+
+To enable the extension from the command line you have to load the extension 
+first and then use it's `--daemonize [PID_FILE]` option :
+
+    $ jruby -S trinidad --load daemon --daemonize ./trinidad.pid
+
+
+You can find further information on how to write your own extension in the wiki: 
+http://wiki.github.com/calavera/trinidad/extensions
+
+## Copyright
+
+Copyright (c) 2010-2012 David Calavera. See LICENSE for details.

data/Rakefile

@@ -13,18 +13,10 @@ def name
 end
 
 def version
-  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line = File.read("lib/#{name}/version.rb")[/^\s*VERSION\s*=\s*.*/]
   line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
 end
 
-def date
-  Date.today.to_s
-end
-
-def rubyforge_project
-  name
-end
-
 def gemspec_file
   "#{name}.gemspec"
 end
@@ -33,10 +25,6 @@ def gem_file
   "#{name}-#{version}.gem"
 end
 
-def replace_header(head, header_name)
-  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
-end
-
 #############################################################################
 #
 # Standard tasks
@@ -45,14 +33,11 @@ end
 
 task :default => :spec
 
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_opts = ['--options', 'spec/spec.opts']
-  spec.spec_files = FileList['spec/**/*_spec.rb']
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ['--color', "--format documentation"]
 end
 
-
 desc "Generate RCov test coverage and open in your browser"
 task :coverage do
   require 'rcov'
@@ -95,12 +80,11 @@ task :release => :build do
   end
   sh "git commit --allow-empty -a -m 'Release #{version}'"
   sh "git tag v#{version}"
-  sh "git push origin master"
-  sh "git push --tags"
+  sh "git push origin master --tags"
   sh "gem push pkg/#{name}-#{version}.gem"
 end
 
-task :build => ['ant:build', 'gemspec'] do
+task :build => :validate do
   sh "mkdir -p pkg"
   sh "gem build #{gemspec_file}"
   sh "mv #{gem_file} pkg"
@@ -109,34 +93,6 @@ end
 task :install => :build do
   sh "gem install pkg/#{name}-#{version}.gem"
 end
-task :gemspec => :validate do
-  # read spec file and split out manifest section
-  spec = File.read(gemspec_file)
-  head, manifest, tail = spec.split("  # = MANIFEST =\n")
-
-  # replace name version and date
-  replace_header(head, :name)
-  replace_header(head, :version)
-  replace_header(head, :date)
-  #comment this out if your rubyforge_project has a different name
-  replace_header(head, :rubyforge_project)
-
-  # determine file list from git ls-files
-  files = `git ls-files`.
-    split("\n").
-    sort.
-    reject { |file| file =~ /^\./ }.
-    reject { |file| file =~ /^(rdoc|pkg|src|git-hooks)/ }.
-    reject { |file| file =~ /tomcat-core.jar/ }.
-    map { |file| "    #{file}" }.
-    join("\n")
-
-  # piece file back together and write
-  manifest = "  s.files = %w[\n#{files}\n  ]\n"
-  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
-  File.open(gemspec_file, 'w') { |io| io.write(spec) }
-  puts "Updated #{gemspec_file}"
-end
 
 task :validate do
   libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]

data/lib/trinidad_daemon_extension/tomcat_wrapper.rb

@@ -0,0 +1,89 @@
+require 'tmpdir'
+
+module Trinidad
+  module Extensions
+    module Daemon
+      class TomcatWrapper
+        
+        attr_reader :pid_file, :jvm_args
+        
+        def initialize(tomcat, pid_file = nil, jvm_args = nil)
+          @tomcat = tomcat
+          # Dir.tmpdir allows overriding /tmp location from ENV
+          pid_file ||= File.join(Dir.tmpdir, 'trinidad.pid')
+          @pid_file = java.io.File.new(pid_file).getAbsolutePath
+          @jvm_args = jvm_args
+        end
+        
+        def server
+          @tomcat.server # getServer()
+        end
+
+        def service
+          @tomcat.service # getService()
+        end
+
+        def engine
+          @tomcat.engine # getEngine()
+        end
+
+        def host
+          @tomcat.host # getHost()
+        end
+        
+        def start
+          daemon = com.sun.akuma.Daemon.new
+          if daemon.isDaemonized
+            pid = com.sun.akuma.CLibrary::LIBC.getpid
+            puts "Starting Trinidad as a daemon"
+            puts "To stop it, kill -s SIGINT #{pid}"
+            daemon.init(pid_file)
+          else
+            daemon.daemonize(configure_jvm_args)
+            java.lang.System.exit(0)
+          end
+          @tomcat.start
+          @tomcat.server.await
+        rescue java.lang.Exception => e
+          java.lang.System.err.println("Error daemonizing Trinidad: " + e.getMessage())
+          e.printStackTrace(java.lang.System.err)
+          java.lang.System.exit(1)
+        end
+        
+        def stop
+          @tomcat.stop
+        end
+        
+        def respond_to?(name)
+          super || @tomcat.respond_to?(name)
+        end
+        
+        def method_missing(name, *args, &block)
+          if @tomcat.respond_to?(name)
+            @tomcat.send(name, *args, &block)
+          else
+            super
+          end
+        end
+        
+        private
+        
+          def configure_jvm_args
+            args = com.sun.akuma.JavaVMArguments.new
+            com.sun.akuma.JavaVMArguments.current.each do |arg|
+              if arg.to_java.startsWith("-Xbootclasspath")
+                # add here the custom arguments, otherwhise are added after
+                # trinidad script and break optionParser
+                jvm_args.each { |custom| args.add(custom) }
+              end
+              # I don't understand this hack but without it the daemon goes off, 
+              # could be others
+              args.add(arg) unless arg.to_java.endsWith("java")
+            end
+            args
+          end
+        
+      end
+    end
+  end
+end

data/lib/trinidad_daemon_extension/version.rb

@@ -0,0 +1,7 @@
+module Trinidad
+  module Extensions
+    module Daemon
+      VERSION = '0.3.0'
+    end
+  end
+end

data/lib/trinidad_daemon_extension.rb

@@ -1,34 +1,41 @@
 require 'rubygems'
-gem 'trinidad_jars'
-require 'trinidad/extensions'
+
+require 'trinidad'
 require 'trinidad/jars'
+require 'trinidad/extensions'
+
+require 'java'
 
 require File.expand_path('../../trinidad-libs/akuma', __FILE__)
-require File.expand_path('../../trinidad-libs/trinidad-daemon-extension', __FILE__)
+require File.expand_path('../../trinidad-libs/jna', __FILE__)
+
+require 'trinidad_daemon_extension/version'
+require 'trinidad_daemon_extension/tomcat_wrapper'
 
 module Trinidad
   module Extensions
-    module Daemon
-      VERSION = '0.2.10'
-    end
-
     class DaemonServerExtension < ServerExtension
       def configure(tomcat)
-        org.jruby.trinidad.TrinidadDaemon.new(tomcat, @options[:pid_file], jvm_args)
+        Trinidad::Extensions::Daemon::TomcatWrapper.new(tomcat, pid_file, jvm_args)
       end
 
       def override_tomcat?; true; end
 
+      def pid_file
+        @options[:pid_file]
+      end
+      
       def jvm_args
-        (@options[:jvm_args] ? @options[:jvm_args].split : []).to_java(:string)
+        @options[:jvm_args] ? @options[:jvm_args].split : []
       end
     end
 
     class DaemonOptionsExtension < OptionsExtension
       def configure(parser, default_options)
-        parser.on('--daemonize', '--daemonize [PID_FILE]', 'run Trinidad as a daemon, pid_file by default is ENV[$TMPDIR]/trinidad.pid') do |pid|
+        message = 'run Trinidad as a daemon, PID_FILE defaults to ENV[TMPDIR]/trinidad.pid'
+        parser.on('--daemonize', '--daemonize [PID_FILE]', message) do |pid|
           extensions = default_options[:extensions] || {}
-          extensions[:daemon] = {:pid_file => pid}
+          extensions[:daemon] = { :pid_file => pid }
           default_options[:extensions] = extensions
         end
       end

data/spec/spec_helper.rb

@@ -1,17 +1,16 @@
 begin
-  require 'spec'
+  require 'rspec'
 rescue LoadError
   require 'rubygems'
   gem 'rspec'
-  require 'spec'
+  require 'rspec'
 end
 
-$:.unshift(File.dirname(__FILE__) + '/../lib')
-
-require 'java'
-require 'trinidad_daemon_extension'
 require 'mocha'
 
-Spec::Runner.configure do |config|
+RSpec.configure do |config|
   config.mock_with :mocha
 end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'trinidad_daemon_extension'

data/spec/trinidad_daemon_extension_spec.rb

@@ -11,7 +11,7 @@ describe Trinidad::Extensions::DaemonServerExtension do
   it "bypass the control to the daemon" do
     daemon = subject.configure(@tomcat)
     daemon.should_not be_nil
-    daemon.should be_instance_of(org.jruby.trinidad.TrinidadDaemon)
+    daemon.should be_instance_of(Trinidad::Extensions::Daemon::TomcatWrapper)
   end
 
   it "uses a temporal directory to write the pid file by default" do
@@ -47,3 +47,84 @@ describe Trinidad::Extensions::DaemonOptionsExtension do
     options[:extensions][:daemon][:pid_file].should == '/tmp/trinidad.pid'
   end
 end
+
+class Java::OrgApacheCatalinaStartup::Tomcat
+  
+  field_reader :basedir # only setBaseDir
+  field_reader :port, :hostname # only setters
+  
+end
+
+describe Trinidad::Extensions::Daemon::TomcatWrapper do
+
+  it "responds to tomcat methods" do
+    tomcat_wrapper.respond_to?(:start).should be true
+    tomcat_wrapper.respond_to?(:stop).should be true
+    
+    tomcat_wrapper.respond_to?(:base_dir=).should be true
+    tomcat_wrapper.respond_to?(:setBaseDir).should be true
+    
+    tomcat_wrapper.respond_to?(:port=).should be true
+    tomcat_wrapper.respond_to?(:setPort).should be true
+  end
+  
+  it "configures a real tomcat" do
+    wrapper = tomcat_wrapper
+    tomcat = wrapper.instance_variable_get(:'@tomcat')
+    
+    wrapper.base_dir = '/base_dir'
+    wrapper.hostname = 'local-host1'
+    wrapper.server.address = 'local-host2'
+    wrapper.port = 42
+    wrapper.host.app_base = '/app-base'
+    wrapper.enable_naming
+    
+    tomcat.basedir.should == '/base_dir'
+    tomcat.hostname.should == 'local-host1'
+    tomcat.server.address.should == 'local-host2'
+    tomcat.port.should == 42
+    tomcat.host.app_base.should == '/app-base'
+  end
+  
+  def tomcat_wrapper
+    Trinidad::Extensions::Daemon::TomcatWrapper.new Trinidad::Tomcat::Tomcat.new
+  end
+  
+  context "mocked" do
+    
+    @@tmpdir = nil
+    before :all do
+      @@tmpdir = ENV['TMPDIR']
+      ENV['TMPDIR'] = File.dirname(__FILE__)
+    end
+    
+    after :all do
+      ENV['TMPDIR'] = @@tmpdir
+    end
+    
+    before :each do
+      @tomcat = mock('tomcat')
+      @tomcat_wrapper = Trinidad::Extensions::Daemon::TomcatWrapper.new(@tomcat)
+    end    
+    
+    it "starts tomcat" do
+      current_pid = $$
+      com.sun.akuma.Daemon.expects(:new).returns daemon = mock("daemon")
+      daemon.expects(:isDaemonized).returns true
+      daemon.expects(:init).with("#{File.dirname(__FILE__)}/trinidad.pid")
+
+      @tomcat.expects(:start)
+      @tomcat.expects(:server).returns server = mock("tomcat.server")
+      server.expects(:await)
+
+      @tomcat_wrapper.start
+    end
+
+    it "stops tomcat" do
+      @tomcat.expects(:stop)
+      @tomcat_wrapper.stop
+    end
+    
+  end
+  
+end

data/trinidad_daemon_extension.gemspec

@@ -1,73 +1,37 @@
-## This is the rakegem gemspec template. Make sure you read and understand
-## all of the comments. Some sections require modification, and others can
-## be deleted if you don't need them. Once you understand the contents of
-## this file, feel free to delete any comments that begin with two hash marks.
-## You can find comprehensive Gem::Specification documentation, at
-## http://docs.rubygems.org/read/chapter/20
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'trinidad_daemon_extension/version'
+
 Gem::Specification.new do |s|
   s.specification_version = 2 if s.respond_to? :specification_version=
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.rubygems_version = '1.3.5'
-
-  ## Leave these as is they will be modified for you by the rake gemspec task.
-  ## If your rubyforge_project name is different, then edit it and comment out
-  ## the sub! line in the Rakefile
+  
   s.name              = 'trinidad_daemon_extension'
-  s.version           = '0.2.10'
-  s.date              = '2012-01-09'
+  s.version           = Trinidad::Extensions::Daemon::VERSION
   s.rubyforge_project = 'trinidad_daemon_extension'
-
-  ## Make sure your summary is short. The description may be as long
-  ## as you like.
+  
   s.summary     = "Trinidad daemon extension"
   s.description = "Trinidad extension to run the Apache Tomcat server as a daemon"
-
-  ## List the primary authors. If there are a bunch of authors, it's probably
-  ## better to set the email to an email list or something. If you don't have
-  ## a custom homepage, consider using your GitHub URL or the like.
+  
   s.authors  = ["David Calavera"]
   s.email    = 'calavera@apache.org'
-  s.homepage = 'http://github.com/calavera/trinidad_daemon_extension'
-
-  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
-  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
-  s.require_paths = %w[lib]
-
-  ## Specify any RDoc options here. You'll want to add your README and
-  ## LICENSE files to the extra_rdoc_files list.
+  s.homepage = 'http://github.com/trinidad/trinidad_daemon_extension'
   s.rdoc_options = ["--charset=UTF-8"]
-  s.extra_rdoc_files = %w[README LICENSE]
-
-  ## List your runtime dependencies here. Runtime dependencies are those
-  ## that are needed for an end user to actually USE your code.
-  s.add_dependency('trinidad_jars', [">= 0.1.1"])
-
-  ## List your development dependencies here. Development dependencies are
-  ## those that are only needed during development
-  s.add_development_dependency('rspec')
-  s.add_development_dependency('mocha')
-
-  ## Leave this section as-is. It will be automatically generated from the
-  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
-  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
-  # = MANIFEST =
-  s.files = %w[
-    History.txt
-    LICENSE
-    README
-    Rakefile
-    lib/trinidad_daemon_extension.rb
-    rakelib/build.rake
-    spec/spec.opts
-    spec/spec_helper.rb
-    spec/trinidad_daemon_extension_spec.rb
-    trinidad-libs/akuma.jar
-    trinidad-libs/trinidad-daemon-extension.jar
-    trinidad_daemon_extension.gemspec
-  ]
-  # = MANIFEST =
-
-  ## Test files will be grabbed from the file list. Make sure the path glob
-  ## matches what you actually use.
+  s.extra_rdoc_files = %w[README.md LICENSE]
+  
+  s.require_paths = %w[lib]
+  
+  s.add_dependency('trinidad_jars', ">= 1.0.0")
+  
+  s.add_development_dependency('rspec', '~> 2.8')
+  s.add_development_dependency('mocha', '>= 0.10.4')
+  
+  s.files = `git ls-files`.split("\n").sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg|src|git-hooks)/ }.
+    reject { |file| file =~ /tomcat-core.jar/ } # only for compiling !
+  
   s.test_files = s.files.select { |path| path =~ /^spec\/.*_spec\.rb/ }
+  
 end

metadata

@@ -2,7 +2,7 @@
 name: trinidad_daemon_extension
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.10
+  version: 0.3.0
 platform: ruby
 authors: 
   - David Calavera
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-09 00:00:00 Z
+date: 2012-03-06 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: trinidad_jars
@@ -20,7 +20,7 @@ dependencies:
       requirements: 
         - - ">="
           - !ruby/object:Gem::Version 
-            version: 0.1.1
+            version: 1.0.0
     type: :runtime
     version_requirements: *id001
   - !ruby/object:Gem::Dependency 
@@ -29,9 +29,9 @@ dependencies:
     requirement: &id002 !ruby/object:Gem::Requirement 
       none: false
       requirements: 
-        - - ">="
+        - - ~>
           - !ruby/object:Gem::Version 
-            version: "0"
+            version: "2.8"
     type: :development
     version_requirements: *id002
   - !ruby/object:Gem::Dependency 
@@ -42,7 +42,7 @@ dependencies:
       requirements: 
         - - ">="
           - !ruby/object:Gem::Version 
-            version: "0"
+            version: 0.10.4
     type: :development
     version_requirements: *id003
 description: Trinidad extension to run the Apache Tomcat server as a daemon
@@ -52,22 +52,23 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-  - README
+  - README.md
   - LICENSE
 files: 
+  - Gemfile
   - History.txt
   - LICENSE
-  - README
+  - README.md
   - Rakefile
   - lib/trinidad_daemon_extension.rb
-  - rakelib/build.rake
-  - spec/spec.opts
+  - lib/trinidad_daemon_extension/tomcat_wrapper.rb
+  - lib/trinidad_daemon_extension/version.rb
   - spec/spec_helper.rb
   - spec/trinidad_daemon_extension_spec.rb
   - trinidad-libs/akuma.jar
-  - trinidad-libs/trinidad-daemon-extension.jar
+  - trinidad-libs/jna.jar
   - trinidad_daemon_extension.gemspec
-homepage: http://github.com/calavera/trinidad_daemon_extension
+homepage: http://github.com/trinidad/trinidad_daemon_extension
 licenses: []
 
 post_install_message: 
@@ -90,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: trinidad_daemon_extension
-rubygems_version: 1.8.9
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 2
 summary: Trinidad daemon extension

data/README

@@ -1,49 +0,0 @@
-Trinidad Daemon Extension
-=======
-
-# DESCRIPTION
-
-Extension to run Trinidad server as a daemon.
-
-[WARNING] This extension only works with Trinidad 0.8.3 or above.
-
-# INSTALLATION
-
-jruby -S gem install trinidad_daemon_extension
-
-# USAGE
-
-This extension can be enabled from the Trinidad's configuration file or from the command line.
-It uses a temporal directory to write the pid file but its route can be overrided.
-
-  * To enable it from the configuration file you have to add a section "extensions" to the root of the file and the section "daemon" to this one. The pid file can be specified there:
-
-    ---
-      extensions:
-        daemon:
-          pid_file: ./trinidad.pid # this is optional by default the extension writes the pid file into a temporal directory.
-
-  * To enable it from the command line you have to load the extension first and then add one of these options:
-
-     --daemonize [PID_FILE]
-
-     for instance:
-
-     $ jruby -S trinidad --load daemon --daemonize ./trinidad.pid
-
-The extension also allows to add new JVM arguments to run the daemon with. They just need to be added into the configuration file:
-
-    ---
-      extensions:
-        daemon:
-          jvm_args: '-XX:MaxPermSize=512m'
-
-You can find further information on how to write your own extension in the wiki: http://wiki.github.com/calavera/trinidad/extensions
-
-# DEVELOPMENT
-
-Copy the hooks into git-hooks directory to .git/hooks to make sure the jar file is updated when the java code is modified.
-
-# Copyright
-
-Copyright (c) 2010-2012 David Calavera. See LICENSE for details.

data/rakelib/build.rake

@@ -1,38 +0,0 @@
-require 'ant'
-require 'fileutils'
-include FileUtils
-
-TARGET_DIR = 'target'
-LIBS_DIR = 'trinidad-libs'
-JAR_NAME = 'trinidad-daemon-extension.jar'
-
-namespace :ant do
-  desc 'Clean the java target directory'
-  task :clean do
-    rm_f TARGET_DIR
-    rm_f "#{LIBS_DIR}/#{JAR_NAME}"
-  end
-
-  desc 'Compile the java classes'
-  task :compile => :clean do
-    opts = {
-      :fork => 'true',
-      :failonerror => 'true',
-      :srcdir => 'src/main/java',
-      :destdir => TARGET_DIR,
-      :classpath => Dir.glob('trinidad-libs/*.jar').join(':')
-    }
-
-    mkdir_p TARGET_DIR
-    ant.javac(opts)
-  end
-
-  desc 'Create the jar file'
-  task :build => :compile do
-    opts = {
-      :destfile => "#{LIBS_DIR}/#{JAR_NAME}",
-      :basedir => TARGET_DIR
-    }
-    ant.jar(opts)
-  end
-end

data/spec/spec.opts

@@ -1,2 +0,0 @@
---colour
---format specdoc