trinidad_init_services 1.1.6 → 1.2.0

data/LICENSE

@@ -1,6 +1,6 @@
 == Trinidad
 
-Copyright (c) 2009 David Calavera
+Copyright (c) 2012 Team Trinidad and contributors http://github.com/trinidad
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -23,4 +23,5 @@ 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.
+Apache Commons Daemon is licensed under the Apache License, Version 2.0.
+See http://www.apache.org/licenses/LICENSE-2.0 for details.

data/README.md

@@ -1,7 +1,8 @@
 # Trinidad Init Services
 
-Trinidad's init services based on Apache [commons daemon](http://commons.apache.org/daemon/)
-and [jruby-jsvc](https://github.com/nicobrevin/jruby-jsvc). Works on Unix and Windows systems.
+Init services based on Apache [Commons Daemon](http://commons.apache.org/daemon/)
+and [jruby-jsvc](https://github.com/nicobrevin/jruby-jsvc).
+Allows you to run Trinidad as an OS daemon, works on Unix and Windows systems.
 
 ## Installation
 
@@ -12,29 +13,40 @@ 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.
+init.d script if you are on a Unix system or creates the service if you are
+on a Windows box.
 
-You can optionally provide a configuration file to the trinidad_init_service
-command. An example configuration file might look like this:
+You can optionally provide a YAML configuration file with defaults specified 
+for the `trinidad_init_service` command. An example configuration file :
 
-    app_path: "/home/myuser/app"
-    trinidad_options: "-e production"
+    app_path: "/home/trinidad/myapp/current"
+    ruby_compat_version: RUBY1_9
     jruby_home: "/opt/jruby"
-    ruby_compat_version: RUBY1_8
-    trinidad_name: Trinidad
-    jsvc_path: "/usr/bin/jsvc"
     java_home: "/opt/java"
     output_path: "/etc/init.d"
-    pid_file: "/tmp/trinidad.pid"
-    log_file: "/tmp/trinidad.log"
+    pid_file: "/home/trinidad/myapp/shared/pids/trinidad.pid"
+    log_file: "/home/trinidad/myapp/shared/log/trinidad.log"
+    jsvc_path: "/usr/bin/jsvc"
+    trinidad_options: "-e production"
+    trinidad_name: Trinidad
+    trinidad_service_id: Trinidad # on Windows (defaults to :trinidad_name)
+    trinidad_service_desc: Trinidad Service Description # on Windows (optional)
 
 You can then run the installer like so:
 
-    $ jruby -S trinidad_init_service trinidad_init_config.yml
+    $ trinidad_init_service --defaults trinidad_init_defaults.yml
 
 If any of the required options are not provided in the configuration file, then 
-the installer will prompt you for them.
+the installer will prompt you for them. If you're running this as part of an 
+environment initialization script than use the *--no-ask* option or provide 
+only the defaults file path on the command line (make sure all required options
+are there) :
+
+    $ jruby -S trinidad_init_service trinidad_init_defaults.yml
+
+
+**NOTE:** Do not confuse the *defaults.yml* "configuration" file with Trinidad's
+own configuration (*config/trinidad.yml*) file used when setting up the server !
 
 
 ### Unix
@@ -64,11 +76,10 @@ as a different user. The preferred method for doing this is the `run_user:`
 attribute in the configuration YAML (or it's corresponding value at the prompt).  
 For example:
 
-    app_path: "/home/myuser/app"
-    trinidad_options: "-e production"
-    jruby_home: "/opt/jruby"
-    run_user: myuser
-    ...
+    app_path: "/home/trinidad/myapp/current"
+    # ...
+    run_user: trinidad
+    # ...
 
 This causes the the server to run with non-root privileges (it essentially executes 
 as `sudo -u run_user jsvc ...`).
@@ -80,16 +91,29 @@ This can be configured with the `JSVC_ARGS_EXTRA` environment variable, like thi
 
 It not recommended that you mix the `-user` flag with the `run_user` option !
 
+#### Uninstall
+
+Manage as every other rc.d, assuming `update-rc.d -f /etc/init.d/trinidad defaults`
+you can uninstall using :
+
+    $ [sudo] trinidad_init_service --uninstall /etc/init.d/trinidad
+
 
 ### Windows
 
 #### Execution
 
 Open the **Services** panel under **Administrative Tools** and look for a service 
-called **Trinidad**.
+called **Trinidad** (or whatever name you have chosen).
+
+#### Uninstall
+
+To remove the service you're going to need the service id (name), than run :
+
+    $ trinidad_init_service --uninstall Trinidad
 
 
 ## Copyright
 
-Copyright (c) 2011-2012 David Calavera<calavera@apache.org>. 
-See LICENSE for details.
+Copyright (c) 2012 [Team Trinidad](https://github.com/trinidad). 
+See LICENSE (http://en.wikipedia.org/wiki/MIT_License) for details.

data/bin/trinidad_init_service

@@ -1,11 +1,62 @@
 #!/usr/bin/env jruby
 
+begin
+  require 'rubygems'
+rescue LoadError
+end
 require 'trinidad_init_services'
+require 'optparse'
 
-if ARGV.size > 0
+defaults = nil
+configuration = Trinidad::InitServices::Configuration.new
+
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename(__FILE__)} [options] [defaults]"
+  
+  opts.on('-h', '--help', 'print this help') do
+    puts opts
+    exit
+  end
+  
+  opts.on('-v', '--version', 'print version') do
+    begin
+      require 'trinidad'
+      puts("#{Trinidad::InitServices::VERSION} (trinidad-#{Trinidad::VERSION})")
+    rescue LoadError
+      puts("#{Trinidad::InitServices::VERSION} (trinidad not installed)")
+    end
+    exit(0)
+  end
+
+  opts.on('-d', '--defaults YAML_FILE', 'use passed file as defaults') do |config|
+    defaults = config
+  end
+  
+  opts.on('-s', '--silent', 'do not print output on console') do
+    configuration.say = false
+  end
+
+  opts.on('--no-ask', 'disable interactive (console) mode') do
+    configuration.ask = false
+  end
+
+  opts.on('--uninstall NAME', 'remove installed init service') do |name|
+    configuration.uninstall(name)
+    exit(0)
+  end
+  
+end
+
+opts.parse! ARGV
+
+if ARGV.size > 0 # trinidad_init_service /home/trinidad/defaults.yml
+  defaults = ARGV[0]
+  configuration.ask = false
+end
+
+if defaults
   require 'yaml'
-  config = YAML.load File.read(ARGV[0])
-  Trinidad::InitServices::Configuration.new.configure(config)
-else
-  Trinidad::InitServices::Configuration.new.configure
-end
+  defaults = YAML.load File.read(defaults)
+end
+
+defaults ? configuration.configure(defaults) : configuration.configure

data/init.d/trinidad.erb

@@ -32,6 +32,17 @@ TRINIDAD_OPTS="<%= @trinidad_options.join(" ") %>"
 PIDFILE=<%= @pid_file %>
 LOG_FILE=<%= @log_file %>
 
+# Create pidfile directory if missing
+# Todo: Remove PIDFILE_DIR creation once jsvc can be started
+# as root using the -user option without any issues.
+PIDFILE_DIR=$(dirname $PIDFILE)
+if [ ! -d "$PIDFILE_DIR" ] ; then
+  mkdir -p $PIDFILE_DIR
+  if [ ! -z "$RUN_USER" ] ; then
+    chown -R $RUN_USER $PIDFILE_DIR
+  fi
+fi
+
 # Implements the jsvc Daemon interface.
 MAIN_CLASS=com.msp.jsvc.JRubyDaemon
 

data/lib/trinidad_init_services/configuration.rb

@@ -7,11 +7,18 @@ require 'shellwords'
 
 module Trinidad
   module InitServices
-
     class Configuration
+      
+      def self.windows?
+        RbConfig::CONFIG['host_os'] =~ /mswin|mingw/i
+      end
+
+      def self.macosx?
+        RbConfig::CONFIG['host_os'] =~ /darwin/i
+      end
+      
       def initialize(stdin = STDIN, stdout = STDOUT)
-        @stdin = stdin
-        @stdout = stdout
+        @stdin, @stdout = stdin, stdout
       end
 
       def initialize_paths(jruby_home = default_jruby_home)
@@ -22,17 +29,7 @@ module Trinidad
         @classpath << File.join(jruby_home, 'lib', 'jruby.jar')
       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(defaults={})
+      def configure(defaults = {})
         @app_path = defaults["app_path"] || ask_path('Application path?')
         @trinidad_options = ["-d #{@app_path}"]
         options_ask = 'Trinidad options?'
@@ -46,10 +43,20 @@ module Trinidad
         @jruby_opts = configure_jruby_opts
         initialize_paths(@jruby_home)
 
-        windows? ? configure_windows_service : configure_unix_daemon(defaults)
-        puts 'Done.'
+        message = windows? ? configure_windows_service : configure_unix_daemon(defaults)
+        say message if message.is_a?(String)
       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_unix_daemon(defaults)
         @java_home = defaults["java_home"] || ask_path('Java home?', default_java_home)
         unless @jsvc = defaults["jsvc_path"] || detect_jsvc_path
@@ -57,7 +64,7 @@ module Trinidad
           if @jsvc.empty? # unpack and compile :
             jsvc_unpack_dir = defaults["jsvc_unpack_dir"] || ask_path("dir where jsvc dist should be unpacked?", '/usr/local/src')
             @jsvc = compile_jsvc(jsvc_unpack_dir, @java_home)
-            puts "jsvc binary available at: #{@jsvc} " + 
+            say "jsvc binary available at: #{@jsvc} " + 
                  "(consider adding it to $PATH if you plan to re-run trinidad_init_service)"
           end
         end
@@ -81,10 +88,12 @@ module Trinidad
           )
         ).result(binding)
 
-        puts "Moving trinidad to #{@output_path}"
+        say "moving trinidad to #{@output_path}"
         trinidad_file = File.join(@output_path, "trinidad")
         File.open(trinidad_file, 'w') { |file| file.write(daemon) }
         FileUtils.chmod(@run_user == '' ? 0744 : 0755, trinidad_file)
+        
+        "\nNOTE: you might want to: `[sudo] update-rc.d -f #{@output_path} defaults`"
       end
 
       def collect_windows_opts(options_ask, defaults)
@@ -92,24 +101,59 @@ module Trinidad
         name_ask = 'Service name? {Alphanumeric and spaces only}'
         name_default = 'Trinidad'
         @trinidad_name = defaults["trinidad_name"] || ask(name_ask, name_default)
+
+        id_ask = 'Service ID? {Alphanumeric and underscores only}'
+        id_default = @trinidad_name.gsub(/\s+/, '_').gsub(/\W/, '')
+        @trinidad_service_id = defaults["trinidad_service_id"] || ask(id_ask, id_default)
+
+        desc_ask = 'Service description? {Alphanumeric and spaces only}'
+        desc_default = 'Embedded Apache Tomcat running rack and rails applications'
+        @trinidad_service_desc = defaults["trinidad_service_desc"] || ask(desc_ask, desc_default)
       end
       
       def configure_windows_service
         srv_path = detect_prunsrv_path
-        trinidad_service_id = @trinidad_name.gsub(/\W/, '')
 
-        command = %Q{//IS//#{trinidad_service_id} --DisplayName="#{@trinidad_name}" \
+        command = %Q{//IS//#{@trinidad_service_id} --DisplayName="#{@trinidad_name}" \
+--Description="#{@trinidad_service_desc}" \
 --Install=#{srv_path} --Jvm=auto --StartMode=jvm --StopMode=jvm \
 --StartClass=com.msp.procrun.JRubyService --StartMethod=start \
 --StartParams="#{escape_path(@trinidad_daemon_path)};#{format_options(@trinidad_options)}" \
 --StopClass=com.msp.procrun.JRubyService --StopMethod=stop --Classpath="#{format_options(@classpath)}" \
 --StdOutput=auto --StdError=auto \
---LogPrefix="#{trinidad_service_id.downcase}" \
+--LogPrefix="#{@trinidad_service_id.downcase}" \
 ++JvmOptions="#{format_options(@jruby_opts)}"
 }
         system "#{srv_path} #{command}"
+        
+        "\nNOTE: you may use prunsrv to manage your service, try running:\n" +
+        "#{srv_path} help"
+      end
+
+      def uninstall(service)
+        windows? ? uninstall_windows_service(service) : uninstall_unix_daemon(service)
+      end
+      
+      def uninstall_windows_service(service_name)
+        srv_path = detect_prunsrv_path
+        system "#{srv_path} stop #{service_name}"
+        system "#{srv_path} delete #{service_name}"
       end
 
+      def uninstall_unix_daemon(service)
+        name = File.basename(service) # e.g. /etc/init.d/trinidad
+        command = "update-rc.d -f #{name} remove"
+        system command
+      rescue => e
+        say "uninstall failed, try `sudo #{command}`"
+        raise e
+      ensure
+        unless File.exist?(service)
+          service = File.expand_path(service, '/etc/init.d')
+        end
+        FileUtils.rm(service) if File.exist?(service)
+      end
+      
       private
 
       def escape_path(path)
@@ -131,15 +175,15 @@ module Trinidad
       def default_ruby_compat_version
         JRuby.runtime.is1_9 ? "RUBY1_9" : "RUBY1_8"
       end
-
+      
       def windows?
-        RbConfig::CONFIG['host_os'] =~ /mswin|mingw/i
+        self.class.windows?
       end
 
       def macosx?
-        RbConfig::CONFIG['host_os'] =~ /darwin/i
+        self.class.macosx?
       end
-
+      
       def bundled_jsvc_path # only called on *nix
         jsvc = 'jsvc_' + (macosx? ? 'darwin' : 'linux')
         jsvc_path = File.join(@jars_path, jsvc)
@@ -176,19 +220,19 @@ module Trinidad
           jdk_home = java_home # it's still worth trying
         end
         command = "cd #{jsvc_dir} && ./configure --with-java=#{jdk_home}"
-        puts "configuring jsvc ..."
+        say "configuring jsvc ..."
         command_output = `#{command}`
         if $?.exitstatus != 0
-          puts command_output
+          say command_output
           raise "`#{command}` failed with status: #{$?.exitstatus}"
         end
         
         # make
         command = "cd #{jsvc_dir} && make"
-        puts "compiling jsvc ..."
+        say "compiling jsvc ..."
         command_output = `#{command}`
         if $?.exitstatus != 0
-          puts command_output
+          say command_output
           raise "`#{command}` failed with status: #{$?.exitstatus}"
         end
         
@@ -234,7 +278,7 @@ module Trinidad
           FileUtils.mkdir_p dir, :mode => 0775
         rescue Errno::EACCES => e
           raise unless error
-          puts "#{error} (#{e})"
+          say "#{error} (#{e})"
         end
       end
       
@@ -244,30 +288,38 @@ module Trinidad
       end
 
       def ask(question, default = nil)
-        return nil if not @stdin.tty?
+        return default if ! @stdin.tty? || @ask == false
 
-        question << " [#{default}]" if default && !default.empty?
+        question << " [#{default}]" if default && ! default.empty?
 
         result = nil
-
         while result.nil?
-          @stdout.print(question + "  ")
+          @stdout.print("#{question}  ")
           @stdout.flush
 
           result = @stdin.gets
 
           if result
             result.chomp!
-
-            result = case result
+            case result
             when /^$/
-              default
-            else
-              result
+              result = default
             end
           end
         end
-        return result
+        result
+      end
+      
+      def ask=(flag)
+        @ask = !!flag
+      end
+      
+      def say(msg)
+        puts msg unless @say == false
+      end
+      
+      def say=(flag)
+        @say = !!flag
       end
       
     end

data/lib/trinidad_init_services/version.rb

@@ -1,5 +1,5 @@
 module Trinidad
   module InitServices
-    VERSION = '1.1.6'
+    VERSION = '1.2.0'
   end
 end

data/spec/trinidad_init_services/configuration_spec.rb

@@ -132,13 +132,17 @@ describe Trinidad::InitServices::Configuration do
       'app_path' => "C:/MyApp",
       'ruby_compat_version' => "RUBY1_9",
       'trinidad_name' => "Trinidad",
+      'trinidad_service_id' => "TrinidadService",
+      'trinidad_service_desc' => "Trinidad Service Description",
       'trinidad_options' => "-e production -p 4242 ",
       'java_home' => "C:/Program Files (x86)/jdk-1.7.0",
       'jruby_home' => "C:/Program Files/jruby",
     }
     subject.configure(config_options)
     subject.system_command.should_not be nil
+    subject.system_command.should =~ /\/\/IS\/\/TrinidadService/
     subject.system_command.should =~ /--DisplayName="Trinidad"/
+    subject.system_command.should =~ /--Description="Trinidad Service Description"/
     subject.system_command.should =~ /--StartParams=".*?\\daemon.rb;-d;C:\\MyApp;-e;production;-p;4242"/
     subject.system_command.should =~ /--Classpath=\".*?\\jruby-jsvc.jar;.*?\\commons-daemon.jar;.*?\\jruby.jar/
     subject.system_command.should =~ %r{

metadata

@@ -2,7 +2,7 @@
 name: trinidad_init_services
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.1.6
+  version: 1.2.0
 platform: ruby
 authors: 
   - David Calavera
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-18 00:00:00 Z
+date: 2012-09-03 00:00:00 Z
 dependencies: 
   - !ruby/object:Gem::Dependency 
     name: trinidad