jerbil 1.2.2 → 1.3.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YjBlMmZlMjU5N2FhNDY2NzIwOTJlYTNlMWUzMzUwZmI0MjIzMjZiOA==
+  data.tar.gz: !binary |-
+    MzBjYmIzY2Q1M2EzMjhjYTZlN2FmMDcxNzMzYjJhOGMyYWMwY2I0MA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    OGIzZjRhY2IxZDdkMGYyNTI1MDE0ZjRjMjc5ZGQ2OTU2ZGU5ZjEyNWQwNDY3
+    ZjdjYmVmMDU5ZDIzOTdkYTc5MjczMGM0MmY3MmVjZWI3YmRjNDI1ZTY4NGE0
+    YzQ1ZDAyNGFjODNiZWNhMzM4MTAzNTNkMGExY2U2OTZiMjYxYjQ=
+  data.tar.gz: !binary |-
+    NDkyYmIxZWNlZDVhM2Y2NzgxOGNkYjQ5M2JkN2Y2ZDE5M2YxMDUyZDk1OTdm
+    YjhiMDM2MzMzZjQ4MmYyNGM2OWI5NmY3NThjMTc3NDMwZTdiNGE4ZWM2Mzg2
+    OGMyY2VkZWQyODJiMTI5OTFmODc5M2EyYWZkYmE2Y2ZmODYxOTk=

data/Bugs.rdoc

@@ -1,66 +1,19 @@
 == Bugs
 
-====31-Jan-2012
+[jerbil-1.3.1 29-Aug-2013]
 
-* a client that does not respond to a verify can hang jerbil! Is it possible
-  put a timeout on?
+  Need to update jerbil command to get rid of thor and improve what it does.
+  Consider Network Dependencies - where a service on one machine does not start
+  without a service on another or when a service is taken down on which others depend
+  then they are notified first, through Jerbil?
 
-10-01-2012
+[jerbil-1.2.3 06-June-2013]
 
-sclient will strip out log options when getting its own! Need to change this or add
-an option in Jellog to not strip them.
+ * If a server attempts to connect to another that is no longer working then the caller hangs.
 
-01-Dec-2011
+[jerbil-1.2.2 22-Nov-2012]
 
-JerbilService::Client should be relaxed about config options!
-
-Nov-2011
-
-Nasty race condition where remote server deletes registering service from its local 
-server, so everyone knows about a service except the local server! (Should be fixed in 0.2.12)
-
-09-Sep-2011
-
-There is no checking that services registered locally have the same hostname as the
-server. Should not be an issue, but did cause problems during testing.
-
-There is no way of directing a client or service to a particular jerbil server. Should
-only be relevant to testing, could add a :jerbil_config key to the options hash when calling
-get_server, which would always return nil if it had not been set anyway. (Addressed)
-
-05-Sep-2011
-
-When a server assumes control of a missing service because the server is not there, it fails
-to delete its own copy! And when the missing server resumes, it cannot delete the un-deleted
-service because it does not have the right key for that service anymore.
-
-Colored success response for jerbl -v would be a big benefit
-
-01-Aug-2011
-
-1. service-missing is not working as expected. Needs to be tested to see what happens 
-when a server is ungracefully removed. May need to change logic from removing services
-to removing servers. - See above
-
-2. Need to add client config file for jerbil to avoid having readable files everywhere.
-
-23-June-2011
-
-jerbil -V reports the number of times a service has been accessed through the local server.
-Would be good to share all counts across all servers somehow?
-
-17-Apr-2011
-
-If you run jerbil -v on a remote server it appears to remove a service but the removal fails.
-This is because it tries to remove the service locally. Also, if a server disappears then
-the other servers still think the service is available. They need to remove the service manually if
-that is the case!
-
-Fixed in 0.1.0
-------
-17-May-2011
-
-Would be good to hide the key check in a private function: check_key(key) rather than
-expose the underlying mechanism
-
-Also change key to pkey for private key parameters
+  * Supervisor#stop does not call stop_callback in the scope of the connected session
+    so the service is not stopped as it should be.
+    
+    Appears to be fixed.

data/Gemfile

@@ -9,4 +9,6 @@ gem 'daemons'
 # jerbil-related utilities
 gem 'jellog', '>=1.0.14' # for logging
 gem 'jeckyl', '>=0.2.7' # for config files
-gem 'jeni', '>=0.2.3' # for installation
+gem 'jeni', '>=0.2.5' # for installation
+
+gem 'optplus', '>=0.0.2'

data/History.txt

@@ -4,6 +4,55 @@
 
 ==History
 
+[jerbil-1.3.3 03-Sep-2013]
+
+  Ensure jerbil methods are called on the server and not the server record.
+
+[jerbil-1.3.2 03-Sep-2013]
+
+  Introduce Optplus version of the bin/jerbil command and add a couple of information
+  methods to the server in support.
+
+[jerbil-1.3.1 29-Aug-2013]
+
+  Fix minor error in runscript (status)
+
+[jerbil-1.3.0 29-Aug-2013]
+
+  First release with properly multiplexed runscript files
+
+[jerbil-1.2.10 28-Aug-2013]
+
+  Add the export of LANG to support encodings
+
+[jerbil-1.2.9 28-Aug-2013]
+
+  further changes to runscripts to not fiddle with PATH etc
+
+[jerbil-1.2.8 28-Aug-2013]
+
+  Various changes to runscripts to cope with /usr/local and to use checkpath
+
+[jerbil-1.2.7 27-Aug-2013]
+
+  Added log entry to record RUBY_VERSION for a service
+
+[jerbil-1.2.6 23-Aug-2013]
+
+  Ensure that Jerbil is 1.9 compliant and ready to go
+
+[jerbil-1.2.5 16-Aug-2013]
+
+  Use /bin/su for all init.d actions (stop and status)
+
+[jerbil-1.2.4 03-Apr-2013]
+
+  Suppress client messages about method strings and symbols
+
+[jerbil-1.2.3 03-Apr-2013]
+
+  Add chmod to creation of /var/run/jerbil in jerbil initscript.
+
 [jerbil-1.2.2 21-Nov-2012]
 
   Add proper home for jerbil user in jerbil-install. Add guidance on logging to READMEs.

data/README.md

@@ -39,6 +39,8 @@ of [Jeni](https://github.com/osburn-sharp/jeni):
 
 This will install various files over and above those installed by the gem, including configuration files,
 runscripts, and sbin wrappers for the jerbil server and for services that use the server.
+By default, Jerbil will install start-up scripts etc into /usr/local/sbin, but this can be
+changed to /usr/sbin by adding the -u option or the -t option.
 Use the -p switch to pretend and see if everything works OK. Jerbil assumes there is a 
 user 'jerbil' that will run the server process etc, so if there is no user 'jerbil' then 
 this script will create one.
@@ -127,15 +129,18 @@ the latter command works on Gentoo at least.
 
 You can also check if the server is working using:
 
-    # /usr/sbin/jerbil-status -V
-    or
     # /etc/init.d/jerbild status
 
 To stop the server:
 
-    # /usr/sbin/jerbil-stop
-    or
     # /etc/init.d/jerbild stop
+    
+If your distro does not support runscripts like this, then you can start, stop and test status
+manually using:
+
+    # /usr/local/sbin/jerbild 
+    # /usr/local/sbin/jerbil-status
+    # /usr/local/sbin/jerbil-stop
 
 Further details of all these commands can be obtained with the -h or --help option
 

data/README_SERVICES.md

@@ -342,49 +342,69 @@ Its convenient to start a service automatically, and Jerbil tries to make this e
 However, what is on offer will probably only work out of the box for Gentoo.
 
 There is only one runscript needed and if you followed the installation instructions
-in {file:README.md the readme file} then this will already be installed as /etc/init.d/jserviced.
+in {file:README.md the readme file} then this will already be installed as /etc/init.d/jerbil
+(not jerbild which is the jerbil server itself). Notice that Jerbil Services can be
+managed using a "multiplexed" runscript. The runscript for each service is a link
+to a common runscript, there is a config file for each service and another common
+file for all services.
+
 To set up a service involves the following:
 
-* create a link to /etc/init.d/jserviced for your service, e.g. /etc/init.d/myserviced
-* create a copy of /etc/conf.d/jserviced for your service, e.g. /etc/conf.d/myserviced.
-  Ensure these two files have the same name.
+* create a link to /etc/init.d/jerbil for your service, e.g. /etc/init.d/jerbil.my_service
+* create a copy of /etc/conf.d/jerbil.service for your service, e.g. /etc/conf.d/jerbil.my_service
+  Ensure these two files (init and conf) have the same name.
 * edit the conf.d file as required.
-* start the service: /etc/init.d/myserviced start
-* add the service to your default runscripts: rc-update add myserviced default
+* start the service: /etc/init.d/jerbil.my_service start
+* add the service to your default runscripts: rc-update add jerbil.my_service default
 
-The variables defined in the conf.d file are:
+The variables defined in the main conf.d file (/etc/conf.d/jerbil) are:
 
 * NO_DAEMON - set to true to run the service in the foreground, usually to debug it.
   Defaults to false.
 * NO_SYSLOG - suppress messages that would normally be sent to syslog, again usually
   for debug purposes. Defaults to false.
 * CONF_FILE - path to the config file for this service. Defaults to whatever the default 
-  location is for Jeckyl (e.g. /etc/jermine/myservice.rb)
+  location is for Jeckyl (e.g. /etc/jerbil/my_service.rb)
 * LOG_DAEMON - log the output from the daemon, which covers the startup process before
   the service starts logging itself. By default this will be logged to a file named
-  after the service with the suffix _sd added, e.g. /var/log/jermine/myservice_sd.log
+  after the service with the suffix _sd added, e.g. /var/log/jerbil/my_service_sd.log
   Defaults to false
 * VERBOSE - output more information during the startup process. This does not affect
   the level of logging for the service itself
-* SERVICE_NAME - by default the service name will be determined from the runscript.
-  But if, like me, you always seem to want a "d" on the end, then use this to ensure
-  the script picks up the right service, e.g. SERVICE_NAME="myservice"
+* SBIN_PATH - the path to the directory where the service is located. This will be set
+  to /usr/local/sbin and can be changed to whatever your default location happens to
+  be.
 * SERVICE_USER - by default, the service user will be a user created when Jerbil was
-  installed (jermine). Change it here if you want someone else. See below for details.
-* USES - enter any services that this service uses. Make sure each service is on a 
-  separate line. e.g. 'USES="logger' on one line and 'net"' on the next. See the example
-  in /etc/conf.d/jserviced.
-* NEEDS - enter any services that this service needs. Make sure this is at least "jerbild".
-  As above, make it one entry per line.
+  installed (jerbil). Change it here if you want someone else. See below for details.
+* Universal runscript dependencies are defined by default using rc_use and rc_need.
+
+For each service it is possible to override the above variables and the following
+  
+* SERVICE_NAME - by default the service name will be determined from the runscript.
+  For example, for my_service the runscript should be called jerbil.my_service.
 * DESCRIPTION - a one line description that will be displayed during start/stop operations.
 
-All services are super-user'd to a given user for safety within the runscript. By default this is jermine
+Note if you need to add a dependency (see 'man runscript' for details) then you will
+need to preserve existing values as well, either explicitly or by adding the variable
+to any new definition:
+
+    rc_use="logger net atd"
+    rc_need="postgres ${rc_need}"
+    
+All services are super-user'd to a given user for safety within the runscript. By default this is jerbil
 but you can set it to another user as above. 
 
-When setting USES and NEEDS remember that services defined as needed will restart this
+When setting use and need dependencies remember that services defined as needed will restart this
 service when they are restarted. Services that are just used do not restart this service
 but will be started before it.
 
+Finally, the generic runscript does not preserve the environment through the su command and
+the path will be very limited (by runscript), which is why SBIN_PATH is required. It
+does set one environment variable on start with is LANG and that is to help ruby 1.9 applications
+that have complex encoding demands. If you need more variables to be set it is suggested
+that you create a bespoke runscript and set them up as part of the su command. Inheriting
+the environment and passing in a wider path may present security risks.
+
 ## Errors and Exceptions
 
 If you define your parameters using Jeckyl and {JerbilService::Config} and check them

data/bin/jerbil

@@ -1,12 +1,13 @@
 #!/usr/bin/env ruby
 #
 #
-# = Jerbil command line utility
 #
-# == control and display jerbil related info
+# = Jerbil command line
+#
+# == useful things to do with Jerbil
 #
 # Author:: Robert Sharp
-# Copyright:: Copyright (c) 2011 Robert Sharp
+# Copyright:: Copyright (c) 2013 Robert Sharp
 # License:: Open Software Licence v3.0
 #
 # This software is licensed for use under the Open Software Licence v. 3.0
@@ -14,49 +15,158 @@
 # and in the file copyright.txt. Under the terms of this licence, all derivative works
 # must themselves be licensed under the Open Software Licence v. 3.0
 #
-# Trial using Thor
+# 
 #
-require 'rubygems'
-require 'thor'
-require 'thor/group'
+
+require 'optplus'
 require 'jerbil'
+require 'jellog/proxy'
 require 'colored'
+require 'socket'
 
+class Jerbs < Optplus::Parser
+  
+  usage "[options] actions"
+  
+  description "Provide information on Jerbil servers and services"
+  
+  def options(opts)
+    
+    opts.on('-a', '--all', 'show all servers or services') do |a|
+      set_option :all, a
+    end
+    
+    opts.on('-H', '--host STRING', String, 'show services on given host') do |h|
+      hostname = resolve_hostname(h)
+      set_option :host, hostname
+    end
+    
+    opts.on('-c', '--config [FILE]', String, 'use the given config file') do |c|
+      if FileTest.exists?(c) then
+        set_option :config, c
+      else
+        message :fatal, "the config file given does not exist"
+      end
+    end
+  
+    opts.on('-v', '--verify', 'verify the connections') do |c|
+      set_option :verify, c
+    end
+  
+    debug_option(opts)
+    
+    verbose_option(opts)
 
-require 'jerbil/thor/server'
-require 'jerbil/thor/service'
-
-
-
-# the main thor handler
-class Jerbs < Thor
-  
-  #class_option :verbose, :default=>false, :aliases=>'-V', :desc=>'print more information'
-  
-  desc "test", "This is just to test things"
-  method_option :debug, :aliases=>'-D', :desc=>'display debug information'
-  def test
-    puts "Hello World"
-    if options[:debug] then
-      puts "Debugging..."
-      puts "  Load Path:"
-      $LOAD_PATH.each do |lpath|
-        puts "    #{lpath.to_s}"
+  end
+  
+  def before_actions
+    @logger = Jellog::ProxyLogger.new("Jerbil")
+    @config = Jerbil.get_config(get_option(:config))
+    @server = Jerbil::Servers.get_local_server(@config[:environment])
+  rescue Jeckyl::ConfigFileMissing
+    puts "Error: No config file #{config_file ? config_file : '/etc/jerbil/jerbil.rb'}".red.bold
+  end
+  
+  describe :status, "show the status of the local server"
+  def status
+    puts "Checking for local Jerbil server running in env: #{@config[:environment]}"
+    jerbs = @server.connect
+    started = jerbs.started
+    puts "  Jerbil server found, version: #{jerbs.version}".green
+    puts "  Server has been up since #{started.strftime('%d %b %Y at %H:%M')}"
+    puts "  and has had #{jerbs.registrations.to_s} registrations"
+  rescue Exception => err
+    puts "Server did not respond: #{err.message}".red.bold
+  end
+  
+  describe :remotes, "list the remote servers on the network"
+  def remotes
+    puts "Checking for remote Jerbil servers running in env: #{@config[:environment]}"
+    begin
+      jerbs = @server.connect
+      remotes = jerbs.remote_servers
+      remotes.each do |remote|
+        if option?(:verify) then
+          begin
+            remote.connect.verify
+            puts "  #{remote.ident}".green
+          rescue
+            puts "  #{remote.ident}".red
+          end
+        else
+          puts "  #{remote.ident}".cyan
+        end #
+        if option? :verbose then
+          begin
+            puts "    Running under Ruby version: #{remote.connect.ruby_version}"
+          rescue
+            puts "    No info on ruby version from this server"
+          end
+        end
       end
+    rescue Exception => err
+      puts "  Server did not respond: #{err.message}".red.bold
     end
   end
   
+  describe :services, "list the services registered with Jerbil"
+  def services
+    jerbs = @server.connect
+    local_host = Socket.gethostname
+    if option?(:all) then
+      services = jerbs.get_all(true)
+    elsif option?(:host) then
+      services = jerbs.find(host: get_option(:host), ignore_access: true)
+    else
+      services = jerbs.find(host: local_host, ignore_access: true)
+    end
+    services.each do |s|
+      puts "  #{s.name}[:#{s.env}]@#{s.host}:#{s.port}".cyan
+      if option? :verbose then
+        puts "    started at: #{s.registered_at.strftime('%d/%m/%y %H:%M')}"
+        puts "    accessed #{s.access_count.to_s} times, last time at: #{s.accessed_at.strftime('%d/%m/%y %H:%M')}"
+      end
+      if option? :verify then
+        if jerbs.service_missing?(s) then
+          puts "  #{s.ident} has failed and should be removed".red
+        else
+          puts "  #{s.ident} responded".green
+        end
+      end
+    end
+      
+  rescue Jerbil::JerbilServerError => err
+    puts "Jerbil Server did not respond: #{err.message}".red.bold
+  end
   
-  register Server, :server, "server", "show information about jerbil servers"
+  describe :secret, "generate a secret key for the Jerbil Servers"
+  def secret
+    puts "Paste the following into the config files for each server"
+    key = Digest::SHA1.hexdigest(Time.now.to_s + rand(12341234).to_s)
+    puts 'secret "' + key + '"'
+  end
   
-
-  register Service, :service, "service", "show information about registered services"
+  describe :readme, 'Display the Jerbil Readme file by whatever means is best'
+  def readme
+    gem_spec = Gem::Specification.find_by_name('jerbil')
+    readme_path = File.join(gem_spec.gem_dir, 'README.md')
+    if FileTest.exists?('/usr/bin/markdown_py') then
+      exec "markdown_py #{readme_path} | lynx -stdin"
+    else
+      exec "less #{readme_path}"
+    end    
+  end
   
-  map "services"=>"service"
-
-  # use separate jeni installer
-  #register Installer, :install, "install", "install jerbil on local machine"
+  def resolve_hostname(host)
+    if host.split('.').length > 1 then
+      return host
+    else
+      myhost = Socket.gethostname.split('.')
+      myhost[0] = host
+      return myhost.join('.')
+    end
+  end
   
 end
 
-Jerbs.start
+Jerbs.run!