trinidad_init_services 1.0.0

data/History.txt

@@ -0,0 +1,37 @@
+== 1.0.0 (2011-06-11)
+
+* Rebranded gem
+* Fix shutdown compatibility errors with Trinidad 1.2.2 and above
+
+== 0.4.2 (2011-05-17)
+
+* fix several minor bugs
+
+== 0.4.1 (2011-01-18)
+
+* Ensure the unix script is executable by default.
+
+== 0.4.0 (2011-01-13)
+
+* Generate Windows service.
+
+== 0.3.2
+
+* Remove profile.jar from init script since it's no more bundled with JRuby distribution.
+
+== 0.3.1
+
+* Use absolute path for configuration options
+* Start Trinidad from the application path
+
+== 0.3.0
+
+* Remove init script extension
+
+== 0.2.0
+
+* Fix several bugs
+
+== 0.1.0
+
+* Initial release

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 Commons Daemon 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

@@ -0,0 +1,42 @@
+Trinidad init services
+===============
+
+Trinidad's init services library based on Apache Commons Daemon and JRuby-jsvc. Works on Unix and Windows systems.
+
+Installation
+============
+
+$ jruby -S gem install trinidad_init_services
+
+When the gem is installed the user must launch the installation process:
+
+    $ jruby -S trinidad_init_service
+
+This installer guides you through the configuration process and generates a
+init.d script if you are on a unix system or creates the service if you are
+on a windows box.
+
+Unix
+====
+
+  Execution
+  =========
+
+  When the installation process finishes you can use the script trinidad-daemon.sh
+  generated to launch the server as a daemon with the options start|stop|restart,
+  i.e:
+
+      $ /etc/init.d/trinidad restart
+
+Windows
+=======
+
+  Execution
+  =========
+
+  Open the `Services` panel under `Administrative Tools` and look for a
+  service called `Trinidad`.
+
+== Copyright
+
+Copyright (c) 2011 David Calavera<calavera@apache.org>. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,154 @@
+require 'rubygems'
+require 'rake'
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.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
+
+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
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+desc "Generate RCov test coverage and open in your browser"
+task :coverage do
+  require 'rcov'
+  sh "rm -fr coverage"
+  sh "rcov test/test_*.rb"
+  sh "open coverage/index.html"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "#{name} #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc 'Release gem'
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  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 "gem push pkg/#{gem_file}"
+end
+
+desc 'Build gem'
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc 'Install gem'
+task :install => :build do
+  sh "gem install pkg/#{gem_file}"
+end
+
+desc 'Create gemspec'
+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)/ }.
+    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}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

data/bin/trinidad_init_service

@@ -0,0 +1,3 @@
+require 'trinidad_init_services/configuration'
+
+Trinidad::InitServices::Configuration.new.configure

data/init.d/trinidad.erb

@@ -0,0 +1,125 @@
+#! /bin/sh
+# Generic script for running ruby scripts as daemons using
+# jsvc and a java class to control the daemon.
+#
+# Contains common parameters and start/stop
+
+# Things you'll need to set on a per script/daemon basis:
+# SCRIPT_NAME - Path to the ruby script which creates a Daemon
+# object for jsvc to control
+# APP_NAME - Name of your application
+#
+# Things you can set:
+# PROG_OPTS - Arguments to send to the program. A few defaults are appended to this.
+
+JSVC=<%= @jsvc %>
+JAVA_HOME=<%= @java_home %>
+JRUBY_HOME=<%= @jruby_home %>
+APP_PATH=<%= @app_path %>
+RUBY_SCRIPT=<%= @trinidad_daemon_path %>
+
+# Add here the options that Trinidad needs to run your application,
+# but DO NOT delete the -d option, i.e -e production
+TRINIDAD_OPTS="<%= @trinidad_options.join(" ") %>"
+
+PIDFILE=<%= @pid_file %>
+LOG_FILE=<%= @log_file %>
+
+# Implements the jsvc Daemon interface.
+MAIN_CLASS=com.msp.jsvc.JRubyDaemon
+
+CLASSPATH=<%= @classpath.join(":") %>
+
+if [ -z "$JRUBY_OPTS" ] ; then
+  JRUBY_OPTS=""
+fi
+
+# TODO: Allow configuration or detect from the OS
+JAVA_NATIVE_PROPS="-Djna.boot.library.path=$JRUBY_HOME/lib/native/linux-i386:$JRUBY_HOME/lib/native/linux-amd64 \
+  -Djffi.boot.library.path=$JRUBY_HOME/lib/native/i386-Linux:$JRUBY_HOME/lib/native/s390x-Linux:$JRUBY_HOME/lib/native/x86_64-Linux"
+
+JAVA_PROPS="$JAVA_PROPS -Djruby.memory.max=500m \
+  -Djruby.stack.max=1024k \
+  $JAVA_NATIVE_PROPS \
+  -Djruby.shell=/bin/sh \
+  <%= @jruby_opts.join(' ') %> \
+  $JRUBY_OPTS"
+
+JAVA_OPTS="-Xmx500m -Xss1024k -Xbootclasspath/a:$JRUBY_HOME/lib/jruby.jar"
+
+JSVC_ARGS="-home $JAVA_HOME \
+  $JSVC_ARGS_EXTRA \
+  -wait 20 \
+  -pidfile $PIDFILE \
+  -user $USER \
+  -procname jsvc-$SCRIPT_NAME \
+  -jvm server
+  -outfile $LOG_FILE \
+  -errfile &1"
+
+#
+# Stop/Start
+#
+
+STOP_COMMAND="$JSVC $JSVC_ARGS -stop $MAIN_CLASS"
+START_COMMAND="$JSVC $JSVC_ARGS -cp $CLASSPATH $JAVA_PROPS $JAVA_OPTS $MAIN_CLASS $RUBY_SCRIPT $TRINIDAD_OPTS"
+
+cd $APP_PATH || exit 1
+
+case "$1" in
+    start)
+      if [ -e "$PIDFILE" ]; then
+          echo "Pidfile already exists, not starting."
+          exit 1
+      else
+          echo "Starting $SCRIPT_NAME daemon..."
+          $START_COMMAND
+          EXIT_CODE=$?
+          if [ "$EXIT_CODE" != 0 ]; then
+        echo "Daemon exited with status: $EXIT_CODE. Check pidfile and log"
+          fi
+      fi
+      ;;
+    stop)
+      if [ -e "$PIDFILE" ]; then
+          echo "Stopping $SCRIPT_NAME daemon..."
+          $STOP_COMMAND
+      else
+          echo "No pid file, not stopping."
+          exit 1
+      fi
+      ;;
+    restart)
+      if [ -e "$PIDFILE" ]; then
+          echo "Stopping $SCRIPT_NAME daemon..."
+          $STOP_COMMAND
+      fi
+      if [ -e "$PIDFILE" ]; then
+          echo "Pidfile still present, $SCRIPT_NAME hasn't stopped"
+          exit 1
+      else
+          $START_COMMAND
+          EXIT_CODE=$?
+          if [ "$EXIT_CODE" != 0 ]; then
+        echo "Daemon exited with status: $EXIT_CODE. Check pidfile and log"
+          fi
+      fi
+      ;;
+    status)
+      if [ "$PIDFILE" ]; then
+          PID=`cat $PIDFILE`
+          OUTPUT=`ps $PID | egrep "^$PID "`
+          if [ ${#OUTPUT} -gt 0 ]; then
+        echo "Service running with pid: $PID"
+          else
+        echo "Pidfile present, but process not running"
+          fi
+      else
+          echo "No pidfile present"
+      fi
+      ;;
+    *)
+      echo "Unrecognised command. Usage trinidad [ start | stop | restart ]"
+      ;;
+esac
+

data/lib/trinidad_init_services.rb

@@ -0,0 +1,30 @@
+require 'rubygems'
+require 'trinidad'
+
+module Trinidad
+  module Daemon
+    VERSION = '1.0.0'
+
+    def init
+    end
+
+    def setup?
+      true
+    end
+
+    def start
+      opts = Trinidad::CommandLineParser.parse(ARGV)
+      opts[:trap] = false
+      @server = Trinidad::Server.new(opts)
+      @server.start
+    end
+
+    def stop
+      @server.stop
+    end
+
+    extend self
+  end
+end
+
+Trinidad::Daemon.init

data/lib/trinidad_init_services/configuration.rb

@@ -0,0 +1,152 @@
+module Trinidad
+  module InitServices
+    require 'erb'
+    require 'java'
+    require 'rbconfig'
+    require 'fileutils'
+
+    class Configuration
+      def initialize(stdin = STDIN, stdout = STDOUT)
+        @stdin = stdin
+        @stdout = stdout
+      end
+
+      def initialize_paths
+        @trinidad_daemon_path = File.expand_path('../../trinidad_init_services.rb', __FILE__)
+        @jars_path = File.expand_path('../../../trinidad-libs', __FILE__)
+
+        @classpath = ['jruby-jsvc.jar', 'commons-daemon.jar'].map { |jar| File.join(@jars_path, jar) }
+        @classpath << File.join(@jruby_home, 'lib', 'jruby.jar')
+      end
+
+      def collect_windows_opts(options_ask)
+        options_ask << '(separated by `;`)'
+        name_ask = 'Service name? {Alphanumeric and spaces only}'
+        name_default = 'Trinidad'
+        @trinidad_name = ask(name_ask, name_default)
+      end
+
+      def configure_jruby_opts
+        opts = []
+        opts << "-Djruby.home=#{@jruby_home}"
+        opts << "-Djruby.lib=#{File.join(@jruby_home, 'lib')}"
+        opts << "-Djruby.script=jruby"
+        opts << "-Djruby.daemon.module.name=Trinidad"
+        opts << "-Djruby.compat.version=#{@ruby_compat_version}"
+        opts
+      end
+
+      def configure
+        @app_path = ask_path('Application path?')
+        @trinidad_options = ["-d #{@app_path}"]
+        options_ask = 'Trinidad options?'
+        options_default = '-e production'
+        collect_windows_opts(options_ask) if windows?
+
+        @trinidad_options << ask(options_ask, options_default)
+        @jruby_home = ask_path('JRuby home?', default_jruby_home)
+        @ruby_compat_version = ask('Ruby 1.8.x or 1.9.x compatibility?', default_ruby_compat_version)
+        @jruby_opts = configure_jruby_opts
+        initialize_paths
+
+        windows? ? configure_windows_service : configure_unix_daemon
+        puts 'Done.'
+      end
+
+      def configure_unix_daemon
+        @jsvc = jsvc_path
+        @java_home = ask_path('Java home?', default_java_home)
+        @output_path = ask_path('init.d output path?', '/etc/init.d')
+        @pid_file = ask_path('pid file?', '/var/run/trinidad/trinidad.pid')
+        @log_file = ask_path('log file?', '/var/log/trinidad/trinidad.log')
+
+        daemon = ERB.new(
+          File.read(
+            File.expand_path('../../init.d/trinidad.erb', File.dirname(__FILE__))
+          )
+        ).result(binding)
+
+        puts "Moving trinidad to #{@output_path}"
+        tmp_file = "#{@output_path}/trinidad"
+        File.open(tmp_file, 'w') do |file|
+          file.write(daemon)
+        end
+
+        FileUtils.chmod(0744, tmp_file)
+      end
+
+      def configure_windows_service
+        prunsrv = File.join(@jars_path, 'prunsrv.exe')
+
+        command = %Q{//IS//Trinidad --DisplayName="#{@trinidad_name}" \
+--Install="#{prunsrv}" --Jvm=auto --StartMode=jvm --StopMode=jvm \
+--StartClass=com.msp.procrun.JRubyService --StartMethod=start \
+--StartParams="#{@trinidad_daemon_path};#{@trinidad_options.join(";")}" \
+--StopClass=com.msp.procrun.JRubyService --StopMethod=stop --Classpath="#{@classpath.join(";")}" \
+--StdOutput=auto --StdError=auto \
+--LogPrefix="#{@trinidad_name.downcase.gsub(/\W/,'')}" \
+++JvmOptions="#{@jruby_opts.join(";")}"
+}
+        system "#{prunsrv} #{command}"
+      end
+
+      private
+
+      def default_jruby_home
+        Java::JavaLang::System.get_property("jruby.home")
+      end
+
+      def default_java_home
+        Java::JavaLang::System.get_property("java.home")
+      end
+
+      def default_ruby_compat_version
+        "RUBY1_8"
+      end
+
+      def windows?
+        RbConfig::CONFIG['host_os'] =~ /mswin|mingw/i
+      end
+
+      def macosx?
+        RbConfig::CONFIG['host_os'] =~ /darwin/i
+      end
+
+      def jsvc_path
+        jsvc = 'jsvc_' + (macosx? ? 'darwin' : 'linux')
+        File.join(@jars_path, jsvc)
+      end
+
+      def ask_path(question, default = nil)
+        File.expand_path(ask(question, default))
+      end
+
+      def ask(question, default = nil)
+        return nil if not @stdin.tty?
+
+        question << " [#{default}]" if default && !default.empty?
+
+        result = nil
+
+        while result.nil?
+          @stdout.print(question + "  ")
+          @stdout.flush
+
+          result = @stdin.gets
+
+          if result
+            result.chomp!
+
+            result = case result
+            when /^$/
+              default
+            else
+              result
+            end
+          end
+        end
+        return result
+      end
+    end
+  end
+end

data/trinidad_init_services.gemspec

@@ -0,0 +1,88 @@
+## 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
+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_init_services'
+  s.version           = '1.0.0'
+  s.date              = '2011-07-12'
+  s.rubyforge_project = 'trinidad_init_services'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "Trinidad init service scripts based on Apache Commons Daemon"
+  s.description = "Trinidad init service scripts on Apache Commons Daemon and JRuby-jsvc, compatible with Unix and Windows services"
+
+  ## 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'
+
+  ## 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]
+
+  ## If your gem includes any executables, list them here.
+  s.executables = ["trinidad_init_service"]
+  s.default_executable = 'trinidad_daemon_install'
+
+  ## Specify any RDoc options here. You'll want to add your README and
+  ## LICENSE files to the extra_rdoc_files list.
+  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', '>=1.2.2')
+
+  ## 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
+    bin/trinidad_init_service
+    init.d/trinidad.erb
+    lib/trinidad_init_services.rb
+    lib/trinidad_init_services/configuration.rb
+    trinidad-libs/commons-daemon.jar
+    trinidad-libs/jruby-jsvc.jar
+    trinidad-libs/jsvc_darwin
+    trinidad-libs/jsvc_linux
+    trinidad-libs/prunsrv.exe
+    trinidad_init_services.gemspec
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  ## s.test_files = s.files.select { |path| path =~ /^test\/test_.*\.rb/ }
+
+s.post_install_message = <<TEXT
+
+------------------------------------------------------------------------------------
+
+Please now run:
+
+  $ jruby -S trinidad_init_service
+
+to complete the installation.
+
+------------------------------------------------------------------------------------
+
+TEXT
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification 
+name: trinidad_init_services
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+  - David Calavera
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-12 00:00:00 +02:00
+default_executable: trinidad_daemon_install
+dependencies: 
+  - !ruby/object:Gem::Dependency 
+    name: trinidad
+    prerelease: false
+    requirement: &id001 !ruby/object:Gem::Requirement 
+      none: false
+      requirements: 
+        - - ">="
+          - !ruby/object:Gem::Version 
+            version: 1.2.2
+    type: :runtime
+    version_requirements: *id001
+description: Trinidad init service scripts on Apache Commons Daemon and JRuby-jsvc, compatible with Unix and Windows services
+email: calavera@apache.org
+executables: 
+  - trinidad_init_service
+extensions: []
+
+extra_rdoc_files: 
+  - README
+  - LICENSE
+files: 
+  - History.txt
+  - LICENSE
+  - README
+  - Rakefile
+  - bin/trinidad_init_service
+  - init.d/trinidad.erb
+  - lib/trinidad_init_services.rb
+  - lib/trinidad_init_services/configuration.rb
+  - trinidad-libs/commons-daemon.jar
+  - trinidad-libs/jruby-jsvc.jar
+  - trinidad-libs/jsvc_darwin
+  - trinidad-libs/jsvc_linux
+  - trinidad-libs/prunsrv.exe
+  - trinidad_init_services.gemspec
+has_rdoc: true
+homepage: http://github.com/calavera/trinidad_daemon
+licenses: []
+
+post_install_message: |+
+  
+  ------------------------------------------------------------------------------------
+  
+  Please now run:
+  
+    $ jruby -S trinidad_init_service
+  
+  to complete the installation.
+  
+  ------------------------------------------------------------------------------------
+  
+rdoc_options: 
+  - --charset=UTF-8
+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: trinidad_init_services
+rubygems_version: 1.5.1
+signing_key: 
+specification_version: 2
+summary: Trinidad init service scripts based on Apache Commons Daemon
+test_files: []
+