webroar 0.5.0 → 0.6.1

data/CHANGELOG

@@ -1,3 +1,41 @@
+v0.6.1 - 19-Sep-2011
+--------------------
+
+New Features
+~~~~~~~~~~~~
+
+* Added Feedback and Report Bug forms in Admin Panel.
+* Support to disable Admin Panel on server startup.
+* Support to disable Analytics feature.
+* Show backtrace and environment details of each exceptions.
+
+Fixes
+~~~~~
+
+* Fixed server crashing issue with Ubuntu 11.04.
+* Fixed file import issue by importing 'serverinternalconfig.yml' file.
+* Now closing session after password change of Admin Panel.
+* Fixed SSL issue in libebb.
+* Changed images used in Admin Panel.
+* Moved Email module to Admin Panel
+* Added current directory in load_path($:) to make the server compatible with Ruby>=1.9.2.
+* Fixed Javascript and Stylesheet loading problem for Rails 3 Application.
+* Added helpers to run Admin Panel with Ruby 1.9.3.
+* Fixed invalid byte sequence issue to run Admin Panel with Ruby 1.9.2.
+* Corrected spec test cases.
+* Fixed condition satement to check Rails version in adapter.
+* Upgraded Admin Panel and Test App to Rails 2.3.9.
+* Upgraded openflashchart_2 plugin.
+* Corrected check condition to start exception tracker.
+* Defined modules for server commands.
+* Corrected default value of min and max workers for application
+* Added link to stop an application from Admin Panel.
+* Improved and cleaned up Analyzer module.
+* Fixed paginate plugin issue by correcting javascript to generate Ajax request.
+* Commented copyright message in Admin Panel's views.
+* Hacked 'environment.rb' to fix 'version_requirements' method issue with RubyGems 1.5.x
+* Fixed code compilation issue with Mac OS.
+
 v0.5.0 - 16-Feb-2011
 --------------------
 

data/README

@@ -32,9 +32,9 @@ Key Features
 Supported Operating Systems
 ---------------------------
 
-WebROaR has been tested on Ubuntu 8.10/9.04/9.10/10.04, Debian 5 (64 Bit),
-Mac OS X (v10.5 & v10.6), Arch Linux 2009.08 and Cent OS 5.2. Basically, it
-should be able to run on any *IX OS.
+WebROaR has been tested on Ubuntu 8.10/9.04/9.10/10.04/10.10/11.04, 
+Debian 5 (64 Bit), Mac OS X (v10.5 & v10.6), Arch Linux 2009.08 and Cent OS 5.2. 
+Basically, it should be able to run on any *IX OS.
 
 Currently it does not support Microsoft(R) Windows.
 
@@ -106,8 +106,3 @@ After restarting the server, admin panel would now also be accessible over SSL.
 *https://<yourservername>:<port>/admin-panel*
 ===============================
 
-Known Issue
------------
-
-WebROaR with SSL build crashes on Ubuntu 10.04 upon execution of 
-'gnutls_handshake' by secure connection.

data/Rakefile

@@ -18,10 +18,11 @@
 
 RUBY_1_9 = RUBY_VERSION =~ /^1\.9/
 SUDO     = "sudo"
+$: << "." if not $:.include? "."
 
 require 'rubygems'
 require 'rake'
 require 'rake/clean'
-require './src/ruby_lib/ruby_interface/version'
+require 'src/ruby_lib/ruby_interface/version'
 
 Dir['tasks/*.rake'].each { |rake| load rake }

data/bin/webroar

@@ -20,14 +20,16 @@
 
 # Ruby script to control WebROaR
 
-WEBROAR_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-WEBROAR_LIB_DIR = File.expand_path(File.join(WEBROAR_ROOT, 'lib'))
+$: << "." if not $:.include? "."
+require File.join(File.dirname(__FILE__), '..', 'lib', 'constant.rb')
 
 $LOAD_PATH.unshift("#{WEBROAR_LIB_DIR}")
+$LOAD_PATH.unshift("#{ADMIN_PANEL_LIB_DIR}")
 
 autoload :YAML, 'yaml'
 require 'digest/md5'
-require 'constant'
+require 'whelper'
+require 'db_connect'
 require 'dependencies'
 require 'control'
 require 'scgi'
@@ -36,4 +38,4 @@ require 'user_interaction'
 require 'installer'
 require 'command_runner'
 
-CommandRunner.new.run
+Webroar::Command::CommandRunner.new.run

data/bin/webroar-analyzer

@@ -19,5 +19,20 @@
 # along with WebROaR.  If not, see <http://www.gnu.org/licenses/>.
 
 require 'rubygems'
-WEBROAR_ROOT =  File.expand_path(File.join(File.dirname(__FILE__), '..')).freeze
-require File.expand_path(File.join(WEBROAR_ROOT, 'src', 'ruby_lib', 'analyzer', 'webroar_analyzer.rb'))
+$: << "." if not $:.include? "."
+require File.join(File.dirname(__FILE__), '..', 'lib', 'constant.rb')
+
+$LOAD_PATH.unshift("#{WEBROAR_LIB_DIR}")
+$LOAD_PATH.unshift("#{ANALYZER_DIR}")
+
+require 'db_connect'
+require 'wlogger'
+require 'process_helper'
+require 'user_defined_exception'
+require 'with_exception_handling'
+require 'message_reader'
+require 'message_analyzer'
+require 'resources_analyzer'
+require 'webroar_analyzer'
+
+Webroar::Analyzer::ScriptRunner.run

data/conf/{server_internal_config.yml → server_internal_config.example.yml}

@@ -7,13 +7,17 @@ starling:
   exception_queue_name: exception_queue # Queue to read/write exceptions
   pid_queue_name: pid_queue # Queue to dispatch worker process id
   max_queue_items: 30000 # Maximum number of unprocessed messages in queue. One message is approximately 1 Kb
+  
+webroar:
+  analyzer: on     # Flag to set server analytics on/off
+  admin_panel: on  # Flag to start Admin Panel with server
 
 webroar_analyzer_script:
   pid_file: /var/run/webroar_analyzer.pid   # File to store pid of analyzer
-  daemonize: true # true or false
-  log_file: /var/log/webroar/analyzer.log
-  sampling_rate: 1 # Sampling time (in mins)
-  environment: production # to choose the database specific to environment
+  daemonize: true                           # true or false
+  log_file: /var/log/webroar/analyzer.log   # Log file
+  sampling_rate: 1                          # Sampling time (in mins)
+  environment: production                   # to choose the database specific to environment
 
 ## Application Configuration ##
 Application:

data/doc/user-guide.html

@@ -630,9 +630,9 @@ SSL support.
 </div>
 <h2 id="_supported_operating_systems">2. Supported Operating Systems</h2>
 <div class="sectionbody">
-<div class="paragraph"><p>WebROaR has been tested on Ubuntu 8.10/9.04/9.10/10.04, Debian 5 (64 Bit),
-Mac OS X (v10.5 &amp; v10.6), Arch Linux 2009.08 and Cent OS 5.2. Basically, it
-should be able to run on any *IX OS.</p></div>
+<div class="paragraph"><p>WebROaR has been tested on Ubuntu 8.10/9.04/9.10/10.04/10.10/11.04,
+Debian 5 (64 Bit), Mac OS X (v10.5 &amp; v10.6), Arch Linux 2009.08 and Cent OS 5.2.
+Basically, it should be able to run on any *IX OS.</p></div>
 <div class="paragraph"><p>Currently it does not support Microsoft&#174; Windows.</p></div>
 </div>
 <h2 id="_install">3. Install</h2>
@@ -898,7 +898,7 @@ rubygems version or any other reason), you can install the following dependent
 </p>
 <div class="literalblock">
 <div class="content">
-<pre><tt>calendar_date_select, rack, rake, rspec, sqlite3-ruby, starling, will_paginate</tt></pre>
+<pre><tt>rails-2.3.9, calendar_date_select, rake, rspec, sqlite3, starling, will_paginate</tt></pre>
 </div></div>
 </li>
 <li>
@@ -916,16 +916,7 @@ dump file would be created in /tmp if <em>gcore</em> is available on that machin
 </p>
 </li>
 </ul></div>
-<h3 id="_know_issue">3.4. Know Issue</h3><div style="clear:left"></div>
-<div class="ulist"><ul>
-<li>
-<p>
-WebROaR with SSL build crashes on Ubuntu 10.04 upon execution of
-<strong>gnutls_handshake</strong> by secure connection.
-</p>
-</li>
-</ul></div>
-<h3 id="_setting_up_database_for_server_admin_panel">3.5. Setting up database for server admin panel</h3><div style="clear:left"></div>
+<h3 id="_setting_up_database_for_server_admin_panel">3.4. Setting up database for server admin panel</h3><div style="clear:left"></div>
 <div class="paragraph"><p>The server&#8217;s admin panel itself is a Ruby on Rails&#8482; web application, and by
 default uses sqlite as it&#8217;s database. You can edit
 <strong>admin_panel/config/database.yml</strong> to setup a database of your liking and
@@ -1301,70 +1292,65 @@ Build Tests
 <h3 id="_webroar_help">10.1. webroar help</h3><div style="clear:left"></div>
 <div class="listingblock">
 <div class="content">
-<pre><tt>  WebROaR - Ruby Application Server
-
-    Usage:
-      webroar -h/--help
-      webroar -v/--version
-      webroar command [argument] [options...]
-
-    Examples:
-      webroar install
-      webroar help
-
-    Further help:
-      webroar help commands      list all 'webroar' commands
-      webroar help &lt;COMMAND&gt;     show help on COMMAND</tt></pre>
-</div></div>
-<h3 id="_webroar_help_commands">10.2. webroar help commands</h3><div style="clear:left"></div>
-<div class="listingblock">
-<div class="content">
-<pre><tt>    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
+<pre><tt>  Usage:
+    webroar [-v | --version] [-h | --help] COMMAND [ARGS]
+
+  The available webroar commands are:
+    install       Install the server
+    uninstall     Uninstall the server
+    start         Start the server or an application
+    stop          Stop the server or an application
+    restart       Restart the server or an application
+    add           Deploy an application on the server
+    remove        Remove an application from the server
+    test          Run the test suite
 
   For help on a particular command, use 'webroar help COMMAND'.</tt></pre>
 </div></div>
-<h3 id="_webroar_install">10.3. webroar install</h3><div style="clear:left"></div>
+<h3 id="_webroar_install">10.2. webroar install</h3><div style="clear:left"></div>
 <div class="listingblock">
 <div class="content">
 <pre><tt>  Usage:
-    webroar install [options]
+    webroar install [-s] [ -L&lt;library path&gt;] [ -I&lt;include path&gt;] [-d] [ -i |
+                    [ --no-import] [ -P&lt;port&gt;] [ -u&lt;user&gt;] [-p&lt;password&gt;] ]
 
   Options:
-    -L                     Additional library paths to be used for linking of
-                           the server
-    -I                     Additional include paths to be used for compiling 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
+    -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
+    -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</tt></pre>
 </div></div>
-<h3 id="_webroar_uninstall">10.4. webroar uninstall</h3><div style="clear:left"></div>
+<h3 id="_webroar_uninstall">10.3. webroar uninstall</h3><div style="clear:left"></div>
 <div class="listingblock">
 <div class="content">
 <pre><tt>  Usage:
@@ -1373,14 +1359,15 @@ Build Tests
   Summary:
     Uninstall the server</tt></pre>
 </div></div>
-<h3 id="_webroar_start">10.5. webroar start</h3><div style="clear:left"></div>
+<h3 id="_webroar_start">10.4. webroar start</h3><div style="clear:left"></div>
 <div class="listingblock">
 <div class="content">
 <pre><tt>  Usage:
-    webroar start [APPNAME ...]
+    webroar start [&lt;app(s)&gt;]
 
   Arguments:
-    APPNAME        Name of the application
+    &lt;app(s)&gt;
+        Name of the application(s)
 
   Summary:
     Start the server or an application
@@ -1389,120 +1376,150 @@ Build Tests
     'start' command without any arguments starts the server. One can start
     multiple applications together by passing multiple names.</tt></pre>
 </div></div>
-<h3 id="_webroar_stop">10.6. webroar stop</h3><div style="clear:left"></div>
+<h3 id="_webroar_stop">10.5. webroar stop</h3><div style="clear:left"></div>
 <div class="listingblock">
 <div class="content">
 <pre><tt>  Usage:
-    webroar stop [APPNAME ...]
+    webroar stop [&lt;app(s)&gt;]
 
   Arguments:
-    APPNAME        Name of the application
+    &lt;app(s)&gt;
+        Name of the application(s)
 
   Summary:
     Stop the server or an application
 
   Description:
-    'stop' command without any arguments stops the server. One can stop multiple
-    applications together by passing multiple names.</tt></pre>
+    'stop' command without any arguments stops the server. One can stop
+    multiple applications together by passing multiple names.</tt></pre>
 </div></div>
-<h3 id="_webroar_restart">10.7. webroar restart</h3><div style="clear:left"></div>
+<h3 id="_webroar_restart">10.6. webroar restart</h3><div style="clear:left"></div>
 <div class="listingblock">
 <div class="content">
 <pre><tt>  Usage:
-    webroar restart [APPNAME ...]
+    webroar restart [&lt;app(s)&gt;]
 
   Arguments:
-    APPNAME        Name of the application
+    &lt;app(s)&gt;
+        Name of the application(s)
 
   Summary:
     Restart the server or an application
 
   Description:
-    'restart' command without any arguments restarts the server. One can restart
-    multiple applications together by passing multiple names.</tt></pre>
+    'restart' command without any arguments restarts the server. One can
+    restart multiple applications together by passing multiple names.</tt></pre>
 </div></div>
-<h3 id="_webroar_add">10.8. webroar add</h3><div style="clear:left"></div>
+<h3 id="_webroar_add">10.7. webroar add</h3><div style="clear:left"></div>
 <div class="listingblock">
 <div class="content">
 <pre><tt>  Usage:
-    webroar add APPNAME -R ... -D ... -U ... [options]
+    webroar add [&lt;app&gt;] [ -R] [ -D] [ -U] [ -T] [ -E] [ -A] [ -N] [ -X]
 
   Arguments:
-    APPNAME       Name of the application
+    &lt;app&gt;
+        Name of the application
 
   Options:
+    The following parameters are mandatory, if the current directory would not
+    be the Rails or Rack root directory
+
     -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.*
+        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/.
+        (default: /&lt;app&gt;)
+
+        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
+        Complete path for your application root directory: e.g. /home/someuser/webapps/app1
+        (default: current directory)
+
     -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)
+        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)
+        (default: Owner of 'config/environment.rb' or 'config.ru' file)
 
-  The following parameters are optional
+    The following parameters are optional
 
     -T, --type
-          Type of the application either rack or rails (default: rails)
+        Type of the application either rack or rails (default: rails)
+
     -E, --environment
-          Environment in which you want to run the application
-          (default: production)
+        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
+        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)
+        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)
+        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.</tt></pre>
+    Deploy (and start) a new application on the server.
+
+  Description:
+    If application name is not passed, it would look for 'config/environment.rb'
+    or 'config.ru' file in the current directory. If any one of the files found,
+    it passes name of the current directory as an application name.</tt></pre>
 </div></div>
-<h3 id="_webroar_remove">10.9. webroar remove</h3><div style="clear:left"></div>
+<h3 id="_webroar_remove">10.8. webroar remove</h3><div style="clear:left"></div>
 <div class="listingblock">
 <div class="content">
 <pre><tt>  Usage:
-    webroar remove APPNAME
+    webroar remove [&lt;app&gt;]
 
   Arguments:
-    APPNAME        Name of the application
+    &lt;app&gt;
+        Name of the application
 
   Summary:
-    Remove the specified application from the server.</tt></pre>
+    Remove the specified application from the server.
+
+  Description:
+    If application name is not passed, it would look for 'config/environment.rb'
+    or 'config.ru' file in the current directory. If any one of the files found,
+    it passes name of the current directory as an application name.</tt></pre>
 </div></div>
-<h3 id="_webroar_test">10.10. webroar test</h3><div style="clear:left"></div>
+<h3 id="_webroar_test">10.9. webroar test</h3><div style="clear:left"></div>
 <div class="listingblock">
 <div class="content">
 <pre><tt>  Usage:
-    webroar test [options]
+    webroar test [ -r&lt;report dir&gt;] [ -d] [ -l]
 
   Options:
-    -r, --report-dir DIR    Report directory
-    -d, --debug-build       Compile the server as a debug build to output
-    extremely verbose logs
-    -l, --load-test         Also run the load tests
+    -r, --report-dir
+        Report directory
+
+    -d, --debug-build
+        Compile the server as a debug build to output extremely verbose logs
+
+    -l, --load-test
+        Also run the load tests
 
   Summary:
     Run the test suite</tt></pre>
@@ -1512,7 +1529,7 @@ Build Tests
 <div id="footnotes"><hr /></div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2010-08-09 16:58:48 IST
+Last updated 2011-09-16 12:44:06 IST
 </div>
 </div>
 </body>