command_runner.rb in webroar-0.3.0

- old
+ new

@@ -17,11 +17,11 @@
 # along with WebROaR.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'optparse'
 
 HELP =%{
-  WebROaR is a ruby application server. This is a basic help message.
+  WebROaR - Ruby Application Server
 
     Usage:
       webroar -h/--help
       webroar -v/--version
       webroar command [argument] [options...]
@@ -34,31 +34,44 @@
       webroar help commands      list all 'webroar' commands
       webroar help <COMMAND>     show help on COMMAND
 }
 
 HELP_COMMAND =%{
-  WebROaR commands are:
-
     install            Install the server
     uninstall          Uninstall the server
+
     start [APPNAME]    Start the server or an application
     stop [APPNAME]     Stop the server or an application
     restart [APPNAME]  Restart the server or an application
+
+    add APPNAME        Deploy an application on server
+    remove APPNAME     Remove an application from server
+
     test               Run the test suite
+    
 
   For help on a particular command, use 'webroar help COMMAND'.
   }
 
 HELP_INSTALL =%{
-
   Usage:
-    webroar install [option]
+    webroar install [options]
 
   Options:
+    -L                     Additional library paths to be used for linking of the server 
+    -I                     Additional include paths to be used for linking of the server
     -s, --ssl-support      Install the server with SSL support
     -d, --debug-build      Compile the server as a debug build to output extremely verbose logs 
 
+  The following options would make the install non-interactive by suppressing the questions prompted by the installer
+    
+    -P, --port             Server port number
+    -i, --import           Import configuration, logs and admin panel data from the previous installation
+        --no-import        Do not import configuration, logs and admin panel data from the previous installation
+    -u, --username         Username for the administrator account of server's admin panel
+    -p, --password         Password for the administrator account of server\'s admin panel
+
   Summary:
     Install the server
   }
 
 HELP_UNINSTALL =%{
@@ -83,11 +96,11 @@
 HELP_START =%{
   Usage:
     webroar start [APPNAME ...] 
 
   Arguments:
-    APPNAME        Name of the application to start 
+    APPNAME        Name of the application
 
   Summary:
     Start the server or an application 
 
   Description:
@@ -98,11 +111,11 @@
 HELP_STOP =%{
   Usage:
     webroar stop [APPNAME ...] 
 
   Arguments:
-    APPNAME        Name of the application to stop 
+    APPNAME        Name of the application
 
   Summary:
     Stop the server or an application 
 
   Description:
@@ -113,11 +126,11 @@
 HELP_RESTART =%{
   Usage:
     webroar restart [APPNAME ...] 
 
   Arguments:
-    APPNAME        Name of the application to restart 
+    APPNAME        Name of the application
 
   Summary:
     Restart the server or an application 
 
   Description:
@@ -125,117 +138,211 @@
     multiple applications together by passing multiple names.
   }
 
 HELP_TEST =%{
   Usage:
-    webroar test [options...] 
+    webroar test [options] 
 
   Options:
-    -l, --load-test         Also run the load tests
+    -r, --report-dir DIR    Report directory
     -d, --debug-build       Compile the server as a debug build to output extremely verbose logs
-    -r, --report-dir DIR    Report directory 
+    -l, --load-test         Also run the load tests
 
   Summary:
     Run the test suite
   }
 
+HELP_REMOVE = %{
+  Usage:
+    webroar remove APPNAME
+
+  Arguments:
+    APPNAME        Name of the application
+
+  Summary:
+    Remove the specified application from the server.
+}
+
+HELP_ADD = %{
+  Usage:
+    webroar add APPNAME -R ... -D ... -U ... [options]
+
+  Arguments:
+    APPNAME       Name of the application
+
+  Options:
+    -R, --resolver
+          Resolver to identify the application. Set it to '/' if you would like to run the application on the root domain. e.g. http://yourserver:port/.
+          Else set the relevant base URI with which you would like to access the application, e.g. '/app1' if you want the application to be accessible via http://yourserver:port/app1.
+          If you would like to set a virtual host for your application e.g. www.company1.com, please specify it here. You can also host this application on a particular subdomain e.g. app1.company1.com. Wildcard '*' can also be used in defining the virtual host name, but it should only be used either at the start or the end. Prefix the virtual host name with tilde(~), if a wildcard is used in defining it. e.g. (i) ~*.server.com (ii) ~www.server.* (iii) ~*.server.*
+    -D, --path
+          Complete path for your application root directory: e.g. /home/someuser/webapps/app1
+    -U, --run-as-user
+          Name of the user with whose privileges you would like to run the application (root can be dangerous!). This user should have all the necessary permissions to get your web application working properly (e.g. write access on required files and directories etc)
+
+  The following parameters are optional
+
+    -T, --type
+          Type of the application either rack or rails (default: rails)
+    -E, --environment
+          Environment in which you want to run the application (default: production)
+    -A, --analytics
+          Enable analytics to get detailed numbers about the run time performance of the application. This number gathering adds a very small overhead on your application
+    -N, --min-workers
+          Minimum number of worker processes that should run for this deployed application. Multiple worker instances help in processing a higher number of concurrent user requests simultaneously. The server would always ensure at least these many worker processes run for this application (default: 4)
+    -X, --max-workers
+          Maximum number of worker processes that should run for this deployed application. Multiple worker instances help in processing a higher number of concurrent user requests simultaneously. The server would ensure that maximum only these many worker processes run for this application (default: 8)
+
+  Summary:
+    Deploy (and start) a new application on the server.
+}
+
 class CommandRunner
 
+  def initialize
+    @options = {}
+    @options[:include_paths] = ""
+    @options[:library_paths] = ""
+  end
+
   def run
-    options = {}
+
+    parse_args
+    
+    if ARGV.length == 0
+      puts HELP
+      return
+    end
+
+    cmd = ARGV[0]
+
+    if @options[:help]
+      Help.new.run(cmd)
+      return
+    end
+
+    case cmd
+      when "help"; Help.new.run(ARGV[1])
+      when "install";
+        # When installation is interrupted on administrator account password input, terminal
+        # is set to echo the character
+        begin
+          Installer.new.install(@options)
+        ensure
+          system('stty echo')
+        end
+      when "uninstall"; Installer.new.uninstall
+      when "clear"; WebroarCommand.new.clear
+      when "start", "stop", "restart" ; WebroarCommand.new.operation(ARGV, cmd)
+      when "add" ; WebroarCommand.new.add(@options, ARGV)
+      when "remove" ; WebroarCommand.new.remove(ARGV)
+      when "test"; Installer.new.test(@options)
+    else
+      puts "ERROR:  Invalid command: #{cmd}.  See 'webroar help commands'."
+    end
+  end
+
+  private
+
+  def parse_args
+
     optparse = OptionParser.new do|opts|
 
+    opts.on( '-h', '--help', 'Version information') { @options[:help] = true }
+    opts.on( '-s', '--ssl-support', 'Install with SSL support') { @options[:ssl] = true }
+    opts.on( '-d', '--debug-build', 'Compile with debug mode') { @options[:debug_build] = true }
+    opts.on( '-n', '--no-report', 'Do not generate test report') { @options[:no_report] = true }
+    opts.on( '-l', '--load-test', 'Run load test') { @options[:load_test] = true }
+    opts.on( '-A', '--analytics', 'Enable the application analytics') { @options[:analytics] = 'Enabled' }
+    opts.on( '-i', '--import', 'Import configuration, logs and admin panel data from the previous installation') { @options[:import] = true }
+    opts.on( '--no-import', 'Do not import configuration, logs and admin panel data from the previous installation') { @options[:import] = false }
+
     opts.on( '-v', '--version', 'Version information') do
       Installer.new.version
-      exit
+      return
     end
 
-    opts.on( '-h', '--help', 'Version information') do
-      options[:help] = true
+    opts.on( '-u', '--username USERNAME', 'Username for the administrator account of server\'s admin panel') do |value|
+      @options[:username] = value.lstrip.gsub(/^=/,"")
     end
 
-    opts.on( '-s', '--ssl-support', 'Install with SSL support') do
-      options[:ssl] = true
+    opts.on( '-p', '--password PASSWORD', 'Password for the administrator account of server\'s admin panel') do |value|
+      @options[:password] = value.lstrip.gsub(/^=/,"")
     end
 
-    opts.on( '-d', '--debug-build', 'Compile with debug mode') do
-      options[:debug_build] = true
+    opts.on( '-P', '--port PORT', 'Server port number') do |value|
+      @options[:port] = value.lstrip.gsub(/^=/,"")
     end
 
-    opts.on( '-l', '--load-test', 'Run load test') do
-      options[:load_test] = true
+    opts.on( '-r', '--report-dir [DIR]', 'Report directory') do |value|
+      @options[:report_dir] = value.lstrip.gsub(/^=/,"")
     end
 
-    opts.on( '-n', '--no-report', 'Do not generate test report') do
-      options[:no_report] = true
+    opts.on( '-R', '--resolver RESOLVER', 'Resolver to identify the application') do |value|
+      @options[:resolver] = value.lstrip.gsub(/^=/,"")
     end
 
-    opts.on( '-r', '--report-dir [DIR]', 'Report directory') do |dir|
-      dir.lstrip!
-      dir.gsub!("=","")
-      options[:report_dir] = dir
+    opts.on( '-D', '--path DIR', 'Path for the web application root directory') do |value|
+      @options[:path] = value.lstrip.gsub(/^=/,"")
     end
 
-  end
+    opts.on( '-T', '--type APPTYPE', 'Type of the application either rack or rails') do |value|
+      @options[:type1] = value.lstrip.gsub(/^=/,"").capitalize
+    end
 
-  begin
-    optparse.parse!
-  rescue OptionParser::ParseError => e
-    puts "#{e}. See 'webroar --help'."
-    exit
-  end
+    opts.on( '-E', '--environment ENV', 'Environment in which you want to run the application') do |value|
+      @options[:environment] = value.lstrip.gsub(/^=/,"")
+    end
 
-  if ARGV.length == 0
-    puts HELP
-    exit
-  end
+    opts.on( '-N', '--min-workers WORKER', 'Minimum number of worker processes that should run for the deployed application.') do |value|
+      @options[:min_worker] = value.lstrip.gsub(/^=/,"")
+    end
 
-  if options[:help]
-    ARGV[1] = ARGV[0]
-    Help.new.run(options, ARGV)
-    exit
-  end
+    opts.on( '-X', '--max-workers WORKER', 'Maximum number of worker processes that should run for the deployed application.') do |value|
+      @options[:max_worker] = value.lstrip.gsub(/^=/,"")
+    end
 
-  case ARGV[0]
-    when "help"; Help.new.run(options, ARGV)
-    when "install"; 
-      # When installation is interrupted on administrator account password input, terminal
-      # is set to echo the character 
-      begin
-        Installer.new.install(options, ARGV)
-      rescue Interrupt
-      ensure
-        system('stty echo')
-      end
-    when "uninstall"; Installer.new.uninstall(options, ARGV)
-    when "clear"; WebroarCommand.new.clear(options, ARGV)
-    when "start" ; WebroarCommand.new.start(options, ARGV)
-    when "stop" ; WebroarCommand.new.stop(options, ARGV)
-    when "restart" ; WebroarCommand.new.restart(options, ARGV)
-    when "test"; Installer.new.test(options, ARGV)
-  else
-    puts "ERROR:  Invalid command: #{ARGV[0]}.  See 'webroar help commands'."
-  end
-end
-end   # class Command
+    opts.on( '-U', '--run-as-user USERNAME', 'Name of the user with whose privileges you would like to run the application') do |value|
+      @options[:run_as_user] = value.lstrip.gsub(/^=/,"")
+    end
 
-class Help
+    opts.on( '-L PATH', 'Additional library path') do |value|
+      @options[:library_paths] += " -L'#{value.lstrip.gsub(/^=/,"")}'"
+    end
 
-def run (options, args)
-  case args[1]
-    when nil, "help"; puts HELP
-    when "commands"; puts HELP_COMMAND
-    when "install"; puts HELP_INSTALL
-    when "uninstall"; puts HELP_UNINSTALL
-    when "clear"; puts HELP_CLEAR
-    when "start"; puts HELP_START
-    when "stop"; puts HELP_STOP
-    when "restart"; puts HELP_RESTART
-    when "test"; puts HELP_TEST
-  else puts "WARNING:  Unknown command #{args[1]}. See 'webroar help commands'."
+    opts.on( '-I PATH', 'Additional include path') do |value|
+      @options[:include_paths] += " -I'#{value.lstrip.gsub(/^=/,"")}'"
+    end
+
+    end
+
+    begin
+      optparse.parse!
+    rescue OptionParser::ParseError => err
+      puts "#{err}. See 'webroar --help'."
+      return
+    end
+
   end
 
-end
+end   # class Command
 
+class Help
 
+  def run (cmd)
+    case cmd
+      when nil, "help"; puts HELP
+      when "commands"; puts HELP_COMMAND
+      when "install"; puts HELP_INSTALL
+      when "uninstall"; puts HELP_UNINSTALL
+      when "clear"; puts HELP_CLEAR
+      when "start"; puts HELP_START
+      when "stop"; puts HELP_STOP
+      when "restart"; puts HELP_RESTART
+      when "add"; puts HELP_ADD
+      when "remove"; puts HELP_REMOVE
+      when "test"; puts HELP_TEST
+      else puts "WARNING:  Unknown command #{cmd}. See 'webroar help commands'."
+    end
+  end
 
 end  # class help