trinidad_init_services 1.1.2 → 1.1.3

data/History.txt

@@ -1,3 +1,7 @@
+== 1.1.3 (2012-02-20)
+
+* Do not ask for a path with $RUN_USER.
+
 == 1.1.2 (2012-01-17)
 
 * Revert previous fix.

data/init.d/trinidad.erb

@@ -10,11 +10,22 @@
 # Things you can set:
 # PROG_OPTS - Arguments to send to the program. A few defaults are appended to this.
 
+# Path to the jsvc binary, if you're having issues with the pre-compiled binary
+# try installing it (e.g. apt-get install jsvc) or compiling it yourself :
+# https://github.com/trinidad/trinidad_init_services/wiki/Installing-JSVC
 JSVC=<%= @jsvc %>
 JAVA_HOME=<%= @java_home %>
 JRUBY_HOME=<%= @jruby_home %>
 APP_PATH=<%= @app_path %>
 RUBY_SCRIPT=<%= @trinidad_daemon_path %>
+# The user rights for the running daemon, if you don't bind directly to 80 than
+# it's always a good idea to run trinidad with non-root user rights.
+# Make sure this user has rights on PIDFILE and LOG_FILE paths.
+# Leaving this empty will cause the daemon to always run as whichever user calls
+# the script (which during init is equivalent to running it as root).
+RUN_USER="<%= @run_user %>"
+# Set this to "1" to echo commands before running them (for troubleshooting) :
+ECHO_COMMAND=""
 
 # Add here the options that Trinidad needs to run your application,
 # but DO NOT delete the -d option, i.e -e production
@@ -50,16 +61,19 @@ JSVC_ARGS="-home $JAVA_HOME \
   $JSVC_ARGS_EXTRA \
   -wait 20 \
   -pidfile $PIDFILE \
-  -user $USER \
   -procname jsvc-$PROC_NAME \
   -jvm server
   -outfile $LOG_FILE \
   -errfile &1"
-
+  
 #
 # Stop/Start
 #
 
+if [[ -n "$RUN_USER" && $EUID -eq 0 ]]; then
+  JSVC="sudo -u $RUN_USER $JSVC"
+fi
+
 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"
 
@@ -72,6 +86,7 @@ case "$1" in
           exit 1
       else
           echo "Starting $PROC_NAME daemon..."
+          if [ -n "$ECHO_COMMAND" ]; then echo $START_COMMAND; fi
           $START_COMMAND
           EXIT_CODE=$?
           if [ "$EXIT_CODE" != 0 ]; then
@@ -82,6 +97,7 @@ case "$1" in
     stop)
       if [ -e "$PIDFILE" ]; then
           echo "Stopping $PROC_NAME daemon..."
+          if [ -n "$ECHO_COMMAND" ]; then echo $STOP_COMMAND; fi
           $STOP_COMMAND
       else
           echo "No pid file, not stopping."
@@ -91,12 +107,14 @@ case "$1" in
     restart)
       if [ -e "$PIDFILE" ]; then
           echo "Stopping $PROC_NAME daemon..."
+          if [ -n "$ECHO_COMMAND" ]; then echo $STOP_COMMAND; fi
           $STOP_COMMAND
       fi
       if [ -e "$PIDFILE" ]; then
           echo "Pidfile still present, $PROC_NAME hasn't stopped"
           exit 1
       else
+          if [ -n "$ECHO_COMMAND" ]; then echo $START_COMMAND; fi
           $START_COMMAND
           EXIT_CODE=$?
           if [ "$EXIT_CODE" != 0 ]; then

data/lib/trinidad_init_services.rb

@@ -3,7 +3,7 @@ require 'trinidad'
 
 module Trinidad
   module Daemon
-    VERSION = '1.1.2'
+    VERSION = '1.1.3'
 
     def init
     end
@@ -12,10 +12,10 @@ module Trinidad
       true
     end
 
-    def start
-      opts = Trinidad::CommandLineParser.parse(ARGV)
-      opts[:trap] = false
-      @server = Trinidad::Server.new(opts)
+    def start(args = ARGV)
+      Trinidad::CommandLineParser.parse(args)
+      Trinidad.configuration.trap = false
+      @server = Trinidad::Server.new
       @server.start
     end
 

data/lib/trinidad_init_services/configuration.rb

@@ -59,7 +59,15 @@ module Trinidad
         @output_path = defaults["output_path"] || ask_path('init.d output path?', '/etc/init.d')
         @pid_file = defaults["pid_file"] || ask_path('pid file?', '/var/run/trinidad/trinidad.pid')
         @log_file = defaults["log_file"] || ask_path('log file?', '/var/log/trinidad/trinidad.log')
-
+        @run_user = defaults["run_user"] || ask('run daemon as user (enter a non-root username or leave blank)?', '')
+        
+        if @run_user != '' && `id -u #{@run_user}` == ''
+          raise ArgumentError, "user '#{@run_user}' does not exist (leave blank if you're planning to `useradd' later)"
+        end
+        
+        make_path_dir(@pid_file, "could not create dir for '#{@pid_file}', make sure dir exists before running daemon")
+        make_path_dir(@log_file, "could not create dir for '#{@log_file}', make sure dir exists before running daemon")
+        
         daemon = ERB.new(
           File.read(
             File.expand_path('../../init.d/trinidad.erb', File.dirname(__FILE__))
@@ -67,12 +75,9 @@ module Trinidad
         ).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)
+        trinidad_file = File.join(@output_path, "trinidad")
+        File.open(trinidad_file, 'w') { |file| file.write(daemon) }
+        FileUtils.chmod(@run_user == '' ? 0744 : 0755, trinidad_file)
       end
 
       def configure_windows_service
@@ -135,6 +140,17 @@ module Trinidad
         File.join(@jars_path, prunsrv)
       end
 
+      def make_path_dir(path, error = nil)
+        dir = File.dirname(path)
+        return if File.exist?(dir)
+        begin
+          FileUtils.mkdir_p dir, :mode => 0775
+        rescue Errno::EACCES => e
+          raise unless error
+          puts "#{error} (#{e})"
+        end
+      end
+      
       def ask_path(question, default = nil)
         File.expand_path(ask(question, default))
       end

data/spec/stubs/trinidad.rb

@@ -0,0 +1,6 @@
+Trinidad.configure do |config|
+  config.port = 3002
+  config.address = '127.0.0.1'
+  config.jruby_min_runtimes = 1
+  config.jruby_max_runtimes = 2
+end

data/spec/stubs/trinidad.yml

@@ -0,0 +1,5 @@
+---
+  port: 3001
+  context_path: "/foo"
+  jruby_min_runtimes: 1
+  jruby_max_runtimes: 1

data/spec/trinidad_daemon_spec.rb

@@ -0,0 +1,69 @@
+require File.expand_path('spec_helper', File.dirname(__FILE__))
+require 'trinidad_init_services'
+
+Trinidad::Daemon.module_eval do
+  def server; @server; end
+end
+
+describe Trinidad::Daemon do
+
+  after :each do
+    Trinidad.configuration = nil
+  end
+  
+  it "starts a configured server" do
+    Trinidad::Server.any_instance.expects(:start)
+    Trinidad::Daemon.start([])
+    Trinidad::Daemon.server.should be_a(Trinidad::Server)
+    Trinidad::Daemon.server.config.should be_a(Trinidad::Configuration)
+  end
+
+  context "started with a yaml config" do
+    
+    before :each do
+      Trinidad::Server.any_instance.stubs(:start)
+      config = File.expand_path('stubs/trinidad.yml', File.dirname(__FILE__))
+      Trinidad::Daemon.start([ '--config', config ])
+      @config = Trinidad::Daemon.server.config
+    end
+    
+    it "is configured without signal trap" do
+      @config[:trap].should == false
+    end
+
+    it "is configured according to .yml" do
+      @config[:port].should == 3001
+      @config[:context_path].should == '/foo'
+      @config[:jruby_min_runtimes].should == 1
+      @config[:jruby_max_runtimes].should == 1
+      
+      @config[:address].should == 'localhost'
+    end
+    
+  end
+
+  context "started with a ruby config" do
+    
+    before :each do
+      Trinidad::Server.any_instance.stubs(:start)
+      config = File.expand_path('stubs/trinidad.rb', File.dirname(__FILE__))
+      Trinidad::Daemon.start([ '--config', config ])
+      @config = Trinidad::Daemon.server.config
+    end
+    
+    it "is configured without signal trap" do
+      @config[:trap].should == false
+    end
+
+    it "is configured according to .rb" do
+      @config[:port].should == 3002
+      @config[:address].should == '127.0.0.1'
+      @config[:jruby_min_runtimes].should == 1
+      @config[:jruby_max_runtimes].should == 2
+      
+      @config[:context_path].should == '/'
+    end
+    
+  end
+  
+end

data/spec/trinidad_init_services/configuration_spec.rb

@@ -1,37 +1,22 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.expand_path('spec_helper', File.join(File.dirname(__FILE__), '..'))
 require 'yaml'
+require 'rbconfig'
 
 describe Trinidad::InitServices::Configuration do
-
-  before do
+  
+  before :each do
     Dir.mkdir(tmp_dir) unless File.exist?(tmp_dir)
-    Dir.mkdir(init_dir) 
-    
-    config = <<YAML
-app_path: "tmp/app"
-trinidad_options: "-e production"
-jruby_home: "tmp/jruby"
-ruby_compat_version: RUBY1_8
-trinidad_name: Trinidad
-jsvc_path: "tmp/jsvc"
-java_home: "tmp/java"
-output_path: "tmp/etc_init.d"
-pid_file: "tmp/trinidad.pid"
-log_file: "tmp/trinidad.log"
-YAML
-
-    defaults = YAML::load(config)
-
-    subject.configure(defaults)
+    Dir.mkdir(init_dir)
   end
 
-  after do
-    File.delete(init_file)
-    Dir.rmdir(init_dir)
-    Dir.rmdir(tmp_dir)
+  after :each do
+    FileUtils.rm_r init_dir
+    Dir.rmdir(tmp_dir) if Dir.entries(tmp_dir) == [ '.', '..' ]
   end
 
-	it "is creates the init.d file" do
+	it "creates the init.d file" do
+    subject.configure(config_defaults)
+    
 		File.exist?(init_file).should be_true
 
     init_file_content = File.read(init_file)
@@ -41,21 +26,86 @@ YAML
     init_file_content.match(/JRUBY_HOME=tmp\/jruby/).should be_true
     init_file_content.match(/APP_PATH=tmp\/app/).should be_true
     init_file_content.match(/TRINIDAD_OPTS="-d tmp\/app -e production"/).should be_true
+    
+    init_file_content.match(/RUN_USER=""/).should be_true
   end
 
-  def init_file
-    "#{init_dir}/trinidad"
-  end
+  it "makes pid_file and log_file dirs" do
+    pids_dir = File.join(tmp_dir, "pids")
+    logs_dir = File.join(tmp_dir, "logs")
+    begin
+      subject.configure(
+        config_defaults.merge 'pid_file' => "tmp/pids/trinidad.pid", 'log_file' => "tmp/logs/trinidad.log"
+      )
+      
+      File.exist?(pids_dir).should be_true
+      File.directory?(pids_dir).should be_true
+      Dir.entries(pids_dir).should == ['.', '..']
 
-  def init_dir
-    "#{tmp_dir}/etc_init.d/"
+      File.exist?(logs_dir).should be_true
+      File.directory?(logs_dir).should be_true
+      Dir.entries(logs_dir).should == ['.', '..']
+    ensure
+      Dir.rmdir(pids_dir) if File.exist?(pids_dir)
+      Dir.rmdir(logs_dir) if File.exist?(logs_dir)
+    end
   end
+  
+  if RbConfig::CONFIG['host_os'] !~ /mswin|mingw/i
 
-  def tmp_dir
-    "#{root_dir}/tmp"
-  end
+    it "fails for non-existing run user" do
+      username = random_username
+      lambda { 
+        subject.configure(config_defaults.merge 'run_user' => username) 
+      }.should raise_error(ArgumentError)
+    end
+    
+    it "sets valid run user" do
+      username = `whoami`.chomp
+      subject.configure(config_defaults.merge 'run_user' => username)
 
-  def root_dir
-    File.dirname(__FILE__) + "/../../"
+      init_file_content = File.read(init_file) rescue ''
+      init_file_content.match(/RUN_USER="#{username}"/).should be_true
+    end
+    
   end
+  
+  private
+  
+    def config_defaults
+      YAML::load %Q{
+app_path: "tmp/app"
+trinidad_options: "-e production"
+jruby_home: "tmp/jruby"
+ruby_compat_version: RUBY1_8
+trinidad_name: Trinidad
+jsvc_path: "tmp/jsvc"
+java_home: "tmp/java"
+output_path: "tmp/etc_init.d"
+pid_file: "tmp/trinidad.pid"
+log_file: "tmp/trinidad.log"
+run_user: ""
+}
+    end
+  
+    def init_file
+      File.join init_dir, 'trinidad'
+    end
+
+    def init_dir
+      File.join tmp_dir, 'etc_init.d'
+    end
+
+    def tmp_dir
+      File.join root_dir, 'tmp'
+    end
+
+    def root_dir
+      File.join File.dirname(__FILE__), "/../../"
+    end
+    
+    def random_username(len = 8)
+      (0...len).map{ ( 65 + rand(25) ).chr }.join.downcase
+    end
+    
 end

data/trinidad_init_services.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## 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.1.2'
-  s.date              = '2012-01-17'
+  s.version           = '1.1.3'
+  s.date              = '2012-02-20'
   s.rubyforge_project = 'trinidad_init_services'
 
   ## Make sure your summary is short. The description may be as long
@@ -44,8 +44,11 @@ Gem::Specification.new do |s|
 
   ## 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')
+  s.add_dependency('trinidad', '>= 1.3.2')
 
+  s.add_development_dependency('rspec', '>= 2.7.1')
+  s.add_development_dependency('mocha', '>= 0.10')
+  
   ## 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.
@@ -60,6 +63,9 @@ Gem::Specification.new do |s|
     lib/trinidad_init_services.rb
     lib/trinidad_init_services/configuration.rb
     spec/spec_helper.rb
+    spec/stubs/trinidad.rb
+    spec/stubs/trinidad.yml
+    spec/trinidad_daemon_spec.rb
     spec/trinidad_init_services/configuration_spec.rb
     trinidad-libs/commons-daemon.jar
     trinidad-libs/jruby-jsvc.jar

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trinidad_init_services
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,19 +9,41 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-17 00:00:00.000000000 Z
+date: 2012-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: trinidad
-  requirement: &2153350240 !ruby/object:Gem::Requirement
+  requirement: &2162638580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.2.2
+        version: 1.3.2
   type: :runtime
   prerelease: false
-  version_requirements: *2153350240
+  version_requirements: *2162638580
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2162638100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.7.1
+  type: :development
+  prerelease: false
+  version_requirements: *2162638100
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &2162637580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: *2162637580
 description: Trinidad init service scripts on Apache Commons Daemon and JRuby-jsvc,
   compatible with Unix and Windows services
 email: calavera@apache.org
@@ -41,6 +63,9 @@ files:
 - lib/trinidad_init_services.rb
 - lib/trinidad_init_services/configuration.rb
 - spec/spec_helper.rb
+- spec/stubs/trinidad.rb
+- spec/stubs/trinidad.yml
+- spec/trinidad_daemon_spec.rb
 - spec/trinidad_init_services/configuration_spec.rb
 - trinidad-libs/commons-daemon.jar
 - trinidad-libs/jruby-jsvc.jar