mongrel_service 0.1 → 0.4.beta1

data/History.txt

@@ -0,0 +1,52 @@
+=== 0.4.beta1 / 2010-01-01
+
+* Enhancements:
+  * Removed win32-service dependency, making mongrel_service more portable
+    between Ruby implementations on Windows (One-Click and RubyInstaller)
+
+  * Now mongrel log files are written to the path specified by --log option.
+    Contribution by Daniel Gies (BigFix). Closes #44.
+
+* Bugfixes:
+  * Wait longer for child process terminate properly (max 20 seconds).
+    Imported tests from RubyServices project. Closes #18.
+
+  * Workaround Windows 2008 process detection issues forcing 'service'
+    initialization parameter. Closes #54. [papillon]
+
+  * Updated ServiceFB to work with FB > 0.18.
+
+=== 0.3.4 / 2008-01-02
+
+  * Strict Gem dependencies for mongrel_service. This version is compatible
+    only with mongrel 1.0.x, 1.1.x and with win32-service 0.5.x.
+
+  * Fixed issues realted to Win32::Service and gem_plugin being registered with
+    different names due win32-service changes.
+
+=== 0.3.3 / 2007-10-26
+
+  * Properly display package/gem version for mongrel_service. Closes #13823.
+
+  * Updated ServiceFB to r80 to solve issue when compiling with FB > 0.17.
+
+=== 0.3.2 / 2007-06-01
+
+* Solved detection of parent process at ServiceFB level
+  (solves the x64 Windows issues).
+
+* Upgraded to ServiceFB 'trunk' (but pistoned it, just in case).
+
+* Fixed problems with ruby installations outside PATH or inside folders with spaces.
+
+* Activate FB pedantic warnings by default (is really useful).
+
+=== 0.3.1 / 2007-01-19
+
+* Single Service (SingleMongrel) object type implemented.
+
+* Updated Rakefile to reflect the new building steps.
+
+* Removed SendSignal, too hackish for my taste, replaced with complete FB solution.
+
+* Added basic Process monitoring and re-spawning.

data/LICENSE.txt

@@ -0,0 +1,55 @@
+Mongrel Web Server (Mongrel) is copyrighted free software by Zed A. Shaw
+<zedshaw at zedshaw dot com> and contributors. You can redistribute it 
+and/or modify it under either the terms of the GPL2 or the conditions below:
+
+1. You may make and give away verbatim copies of the source form of the
+   software without restriction, provided that you duplicate all of the
+   original copyright notices and associated disclaimers.
+
+2. You may modify your copy of the software in any way, provided that
+   you do at least ONE of the following:
+
+     a) place your modifications in the Public Domain or otherwise make them
+     Freely Available, such as by posting said modifications to Usenet or an
+     equivalent medium, or by allowing the author to include your
+     modifications in the software.
+
+     b) use the modified software only within your corporation or
+        organization.
+
+     c) rename any non-standard executables so the names do not conflict with
+     standard executables, which must also be provided.
+
+     d) make other distribution arrangements with the author.
+
+3. You may distribute the software in object code or executable
+   form, provided that you do at least ONE of the following:
+
+     a) distribute the executables and library files of the software,
+     together with instructions (in the manual page or equivalent) on where
+     to get the original distribution.
+
+     b) accompany the distribution with the machine-readable source of the
+     software.
+
+     c) give non-standard executables non-standard names, with
+        instructions on where to get the original software distribution.
+
+     d) make other distribution arrangements with the author.
+
+4. You may modify and include the part of the software into any other
+   software (possibly commercial).  But some files in the distribution
+   are not written by the author, so that they are not under this terms.
+
+5. The scripts and library files supplied as input to or produced as 
+   output from the software do not automatically fall under the
+   copyright of the software, but belong to whomever generated them, 
+   and may be sold commercially, and may be aggregated with this
+   software.
+
+6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+   IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+   PURPOSE.
+
+

data/Manifest.txt

@@ -0,0 +1,32 @@
+History.txt
+lib/mongrel_service/init.rb
+lib/mongrel_service/service_manager.rb
+LICENSE.txt
+Manifest.txt
+Rakefile
+README.txt
+resources/defaults.yaml
+resources/mongrel_service.exe
+src/mongrel_service/_debug.bi
+src/mongrel_service/boolean.bi
+src/mongrel_service/console_process.bas
+src/mongrel_service/console_process.bi
+src/mongrel_service/mongrel_service.bas
+src/mongrel_service/mongrel_service.bi
+src/ServiceFB/_internals.bi
+src/ServiceFB/_utils_internals.bi
+src/ServiceFB/ServiceFB.bas
+src/ServiceFB/ServiceFB.bi
+src/ServiceFB/ServiceFB_Utils.bas
+src/ServiceFB/ServiceFB_Utils.bi
+tasks/gem.rake
+tasks/native_lib.rake
+tasks/native_service.rake
+tasks/tests.rake
+tests/all_tests.bas
+tests/fixtures/mock_process.bas
+tests/test_console_process.bas
+tests/test_helpers.bas
+tests/test_helpers.bi
+TODO.txt
+tools/freebasic.rb

data/README.txt

@@ -0,0 +1,20 @@
+= Mongrel Native Win32 Service Plugin
+
+* http://github.com/fauna/mongrel_service
+
+== DESCRIPTION
+
+This plugin offer native win32 services for rails.
+This replace mongrel_rails_service.
+
+== USAGE
+
+Use the following commands to get more help:
+
+    service::install --help
+    service::remove --help
+    service::update --help
+
+== AUTHOR
+
+Luis Lavena

data/Rakefile

@@ -1,42 +1,8 @@
-require 'rake'
-require 'rake/testtask'
-require 'rake/clean'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
-require 'tools/rakehelp'
-require 'fileutils'
-include FileUtils
-
-setup_tests
-setup_clean ["pkg", "lib/*.bundle", "*.gem", ".config"]
-
-setup_rdoc ['README', 'LICENSE', 'COPYING', 'lib/**/*.rb', 'doc/**/*.rdoc']
-
-desc "Does a full compile, test run"
-task :default => [:test, :package]
-
-version="0.1"
-name="mongrel_service"
-
-setup_gem(name, version) do |spec|
-  spec.summary = "Mongrel Native Win32 Service Plugin for Rails"
-  spec.description = "This plugin offer native win32 services for rails, powered by Mongrel."
-  spec.author="Luis Lavena"
-  
-  # added mongrel_service executable
-  spec.executables = ["mongrel_service"]
-  
-  spec.add_dependency('gem_plugin', '>= 0.2.1')
-  spec.add_dependency('mongrel', '>= 0.3.12.4')
-  spec.files += Dir.glob("resources/**/*")
-end
-
-
-task :install => [:test, :package] do
-  sh %{gem install pkg/#{name}-#{version}.gem}
-end
-
-task :uninstall => [:clean] do
-  sh %{gem uninstall #{name}}
-end
-
+#
+# NOTE: Keep this file clean.
+# Add your customizations inside tasks directory.
+# Thank You.
+#
+
+# load rakefile extensions (tasks)
+Dir['tasks/*.rake'].sort.each { |f| load f }

data/TODO.txt

@@ -0,0 +1,19 @@
+Legend:
+[ ] not done
+[X] done
+[+] in progess
+
+### General
+[ ] Add more documentation about services and requirements
+[ ] Add process monitoring.
+
+### Dependencies
+[+] Remove win32/service extension dependency (instead of relying in the non-official 0.5.0 one).
+  [ ] Add service management (from ServiceFB) to install and remove services.
+    
+### SingleMongrel
+[+] Sanitize SingleMongrel and document the functions.
+
+### ClusterMongrel
+[ ] Parse mongrel_cluster configuration file (yaml) looking for port information
+  [ ] Reimplent SingleMongrel for ClusterMongrel, splitting source files for better organization.

data/lib/mongrel_service/init.rb

@@ -2,8 +2,8 @@ require 'gem_plugin'
 require 'mongrel'
 require 'mongrel/rails'
 require 'rbconfig'
-require 'win32/service'
-
+require 'fileutils'
+require 'mongrel_service/service_manager'
 
 module Service
   class Install < GemPlugin::Plugin "/commands"
@@ -26,7 +26,7 @@ module Service
           ['-B', '--debug', "Enable debugging mode", :@debug, false],
           ['-C', '--config PATH', "Use a config file", :@config_file, nil],
           ['-S', '--script PATH', "Load the given file as an extra config script.", :@config_script, nil],
-          ['-u', '--cpu CPU', "Bind the process to specific cpu, starting from 1.", :@cpu, nil]
+          ['', '--prefix PATH', "URL prefix for Rails app", :@prefix, nil]
         ]
     end
     
@@ -42,13 +42,15 @@ module Service
   
       # start with the premise of app really exist.
       app_exist = true
-      %w{app config db log public}.each do |path|
+      %w{app config log}.each do |path|
         if !File.directory?(File.join(@cwd, path))
           app_exist = false
           break
         end
       end
 
+      valid?(@prefix[0].chr == "/" && @prefix[-1].chr != "/", "Prefix must begin with / and not end in /") if @prefix
+
       valid? app_exist == true, "The path you specified isn't a valid Rails application."
 
       valid_dir? File.dirname(@log_file), "Path to log file not valid: #@log_file"
@@ -57,12 +59,9 @@ module Service
       valid_exists? @mime_map, "MIME mapping file does not exist: #@mime_map" if @mime_map
       valid_exists? @config_file, "Config file not there: #@config_file" if @config_file
 
-      # Validate the number of cpu to bind to.
-      valid? @cpu.to_i > 0, "You must specify a numeric value for cpu. (1..8)" if @cpu
-      
       # We should validate service existance here, right Zed?
       begin
-        valid? !Win32::Service.exists?(@svc_name), "The service already exist, please remove it first."
+        valid? !ServiceManager.exist?(@svc_name), "The service already exist, please remove it first."
       rescue
       end
 
@@ -75,57 +74,82 @@ module Service
     end
     
     def run
+      # check if mongrel_service.exe is in ruby bindir.
+      gem_root = File.join(File.dirname(__FILE__), "..", "..")
+      gem_executable = File.join(gem_root, "resources/mongrel_service.exe")
+      bindir_executable = File.join(Config::CONFIG['bindir'], '/mongrel_service.exe')
+      
+      unless File.exist?(bindir_executable)
+        STDERR.puts "** Copying native mongrel_service executable..."
+        FileUtils.cp gem_executable, bindir_executable rescue nil
+      end
+      
+      unless FileUtils.compare_file(bindir_executable, gem_executable)
+        STDERR.puts "** Updating native mongrel_service executable..."
+        FileUtils.rm_f bindir_executable rescue nil
+        FileUtils.cp gem_executable, bindir_executable rescue nil
+      end
+      
+      # build the command line
+      argv = []
+      
+      # start using the native executable
+      argv << '"' + bindir_executable + '"'
+
+      # force indication of service mode (workaround Windows 2008 psapi issue)
+      argv << "service"
+
+      # use the 'single' service for now
+      argv << "single"
+      
       # command line setting override config file settings
       @options = { :host => @address,  :port => @port, :cwd => @cwd,
         :log_file => @log_file, :pid_file => @pid_file, :environment => @environment,
         :docroot => @docroot, :mime_map => @mime_map,
         :debug => @debug, :includes => ["mongrel"], :config_script => @config_script,
-        :num_procs => @num_procs, :timeout => @timeout, :cpu => @cpu
+        :num_procs => @num_procs, :timeout => @timeout, :cpu => @cpu, :prefix => @prefix
       }
-
+      
+      # if we are using a config file, pass -c and -C to the service instead of each start parameter.
       if @config_file
-        STDERR.puts "** Loading settings from #{@config_file} (command line options override)."
+        STDERR.puts "** Using #{@config_file} instead of command line parameters."
         conf = YAML.load_file(@config_file)
-        @options = conf.merge(@options)
+        
+        # add the root folder (-c)
+        argv << "-c \"#{conf[:cwd]}\""
+        
+        # use the config file
+        argv << "-C \"#{@config_file}\""
+
+      else
+        # use the command line instead
+        # now the options
+        argv << "-e #{@options[:environment]}" if @options[:environment]
+        argv << "-p #{@options[:port]}"
+        argv << "-a #{@options[:host]}"  if @options[:host]
+        argv << "-l \"#{@options[:log_file]}\"" if @options[:log_file]
+        argv << "-P \"#{@options[:pid_file]}\""
+        argv << "-c \"#{@options[:cwd]}\"" if @options[:cwd]
+        argv << "-t #{@options[:timeout]}" if @options[:timeout]
+        argv << "-m \"#{@options[:mime_map]}\"" if @options[:mime_map]
+        argv << "-r \"#{@options[:docroot]}\"" if @options[:docroot]
+        argv << "-n #{@options[:num_procs]}" if @options[:num_procs]
+        argv << "-B" if @options[:debug]
+        argv << "-S \"#{@options[:config_script]}\"" if @options[:config_script]
+        argv << "-u #{@options[:cpu.to_i]}" if @options[:cpu]
+        argv << "--prefix \"#{@options[:prefix]}\"" if @options[:prefix]
       end
 
-      argv = []
-      
-      # ruby.exe instead of rubyw.exe due a exception raised when stoping the service!
-      argv << '"' + Config::CONFIG['bindir'] + '/ruby.exe' + '"'
-      
-      # add service_script, we now use the rubygem powered one
-      argv << '"' + Config::CONFIG['bindir'] + '/mongrel_service' + '"'
-
-      # now the options
-      argv << "-e #{@options[:environment]}" if @options[:environment]
-      argv << "-p #{@options[:port]}"
-      argv << "-a #{@options[:address]}"  if @options[:address]
-      argv << "-l \"#{@options[:log_file]}\"" if @options[:log_file]
-      argv << "-P \"#{@options[:pid_file]}\""
-      argv << "-c \"#{@options[:cwd]}\"" if @options[:cwd]
-      argv << "-t #{@options[:timeout]}" if @options[:timeout]
-      argv << "-m \"#{@options[:mime_map]}\"" if @options[:mime_map]
-      argv << "-r \"#{@options[:docroot]}\"" if @options[:docroot]
-      argv << "-n #{@options[:num_procs]}" if @options[:num_procs]
-      argv << "-B" if @options[:debug]
-      argv << "-S \"#{@options[:config_script]}\"" if @options[:config_script]
-      argv << "-u #{@options[:cpu.to_i]}" if @options[:cpu]
-
-      svc = Win32::Service.new
       begin
-        svc.create_service{ |s|
-          s.service_name     = @svc_name
-          s.display_name     = @svc_display
-          s.binary_path_name = argv.join ' '
-          s.dependencies     = []
-        }
-        puts "Mongrel service '#{@svc_display}' installed as '#{@svc_name}'."
-      rescue Win32::ServiceError => err
+        ServiceManager.create(
+          @svc_name,
+          @svc_display,
+          argv.join(' ')
+        )
+      rescue ServiceManager::CreateError => e
         puts "There was a problem installing the service:"
-        puts err
+        puts e
       end
-      svc.close
     end
   end
 
@@ -138,13 +162,15 @@ module Service
     
     def validate
       valid? @svc_name != nil, "A service name is mandatory."
-      
+
       # Validate that the service exists
-      begin
-        valid? Win32::Service.exists?(@svc_name), "There is no service with that name, cannot proceed."
-      rescue
+      valid? ServiceManager.exist?(@svc_name), "There is no service with that name, cannot proceed."
+      if @valid then
+        ServiceManager.open(@svc_name) do |svc|
+          valid? svc.binary_path_name.include?("mongrel_service"), "The service specified isn't a Mongrel service."
+        end
       end
-      
+
       return @valid
     end
   end
@@ -152,69 +178,24 @@ module Service
   class Remove < GemPlugin::Plugin "/commands"
     include Mongrel::Command::Base
     include ServiceValidation
-    
+
     def run
-      display_name = Win32::Service.getdisplayname(@svc_name)
-      
+      display_name = ServiceManager.getdisplayname(@svc_name)
+
       begin
-        Win32::Service.stop(@svc_name)
-      rescue
+        ServiceManager.stop(@svc_name)
+      rescue ServiceManager::ServiceError => e
       end
-      begin
-        Win32::Service.delete(@svc_name)
-      rescue
-      end
-      puts "#{display_name} service removed."
-    end
-  end
 
-  class Start < GemPlugin::Plugin "/commands"
-    include Mongrel::Command::Base
-    include ServiceValidation
-    
-    def run
-      display_name = Win32::Service.getdisplayname(@svc_name)
-  
       begin
-        Win32::Service.start(@svc_name)
-        started = false
-        while started == false
-          s = Win32::Service.status(@svc_name)
-          started = true if s.current_state == "running"
-          break if started == true
-          puts "One moment, " + s.current_state
-          sleep 1
-        end
-        puts "#{display_name} service started"
-      rescue Win32::ServiceError => err
-        puts "There was a problem starting the service:"
-        puts err
+        ServiceManager.delete(@svc_name)
+      rescue ServiceManager::ServiceError => e
+        puts e
       end
-    end
-  end
 
-  class Stop < GemPlugin::Plugin "/commands"
-    include Mongrel::Command::Base
-    include ServiceValidation
-    
-    def run
-      display_name = Win32::Service.getdisplayname(@svc_name)
-  
-      begin
-        Win32::Service.stop(@svc_name)
-        stopped = false
-        while stopped == false
-          s = Win32::Service.status(@svc_name)
-          stopped = true if s.current_state == "stopped"
-          break if stopped == true
-          puts "One moment, " + s.current_state
-          sleep 1
-        end
-        puts "#{display_name} service stopped"
-      rescue Win32::ServiceError => err
-        puts "There was a problem stopping the service:"
-        puts err
+      unless ServiceManager.exist?(@svc_name) then
+        puts "#{display_name} service removed."
       end
     end
   end
-end
+end