omnibus-ctl 0.3.5 → 0.6.4

data/lib/omnibus-ctl.rb

@@ -1,5 +1,4 @@
-#
-# Copyright:: Copyright (c) 2012 Opscode, Inc.
+#  Copyright (c) 2012-2015 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,127 +15,156 @@
 #
 
 require "omnibus-ctl/version"
-require 'json'
-require 'fileutils'
+require "json" unless defined?(JSON)
+require "fileutils" unless defined?(FileUtils)
+
+# For license checks
+require "io/console"
+require "io/wait"
 
 module Omnibus
   class Ctl
 
-    File::umask(022)
+    File.umask(022)
 
-    SV_COMMAND_NAMES = %w[status up down once pause cont hup alarm interrupt quit
+    SV_COMMAND_NAMES = %w{status up down once pause cont hup alarm int quit
                       term kill start stop restart shutdown force-stop
-                      force-reload force-restart force-shutdown check]
+                      force-reload force-restart force-shutdown check usr1 usr2}.freeze
 
     attr_accessor :name, :display_name, :log_exclude, :base_path, :sv_path,
     :service_path, :etc_path, :data_path, :log_path, :command_map, :category_command_map,
     :fh_output, :kill_users, :verbose, :log_path_exclude
 
-    def initialize(name, service_commands=true)
+    attr_reader :backup_dir, :exe_name
+
+    def initialize(name, merge_service_commands = true, disp_name = nil)
       @name = name
-      @service_commands = service_commands
-      @display_name = name
+      @service_commands = merge_service_commands
+      @display_name = disp_name || name
       @base_path = "/opt/#{name}"
       @sv_path = File.join(@base_path, "sv")
       @service_path = File.join(@base_path, "service")
       @log_path = "/var/log/#{name}"
       @data_path = "/var/opt/#{name}"
       @etc_path = "/etc/#{name}"
-      @log_exclude = '(config|lock|@|gzip|tgz|gz)'
-      @log_path_exclude = ['*/sasl/*']
+      @log_exclude = "(config|lock|@|bz2|gz|gzip|tbz2|tgz|txz|xz|zip)"
+      @log_path_exclude = ["*/sasl/*"]
       @fh_output = STDOUT
       @kill_users = []
       @verbose = false
+      @quiet = false
+      @exe_name = File.basename($0)
+      @force_exit = false
+      @global_pre_hooks = {}
+
+      # TODO(ssd) 2017-03-28: Set SVDIR explicitly. Once we fix a bug
+      # in our debian support, where we rely on system-installed
+      # runit, we can likely change this back to ENV.delete("SVDIR")
+      ENV["SVDIR"] = service_path
+
       # backwards compat command map that does not have categories
-      @command_map = { }
+      @command_map = {}
 
       # categoired commands that we want by default
       @category_command_map = {
         "general" => {
           "show-config" => {
-            :desc => "Show the configuration that would be generated by reconfigure.",
-            :arity => 1
+            desc: "Show the configuration that would be generated by reconfigure.",
+            arity: 1,
           },
           "reconfigure" => {
-            :desc => "Reconfigure the application.",
-            :arity => 1
+            desc: "Reconfigure the application.",
+            arity: 2,
           },
           "cleanse" => {
-            :desc => "Delete *all* #{display_name} data, and start from scratch.",
-            :arity => 2
+            desc: "Delete *all* #{display_name} data, and start from scratch.",
+            arity: 2,
           },
           "uninstall" => {
-            :arity => 1,
-            :desc => "Kill all processes and uninstall the process supervisor (data will be preserved)."
+            arity: 1,
+            desc: "Kill all processes and uninstall the process supervisor (data will be preserved).",
           },
           "help" => {
-            :arity => 1,
-            :desc => "Print this help message."
-          }
-        }
+            arity: 1,
+            desc: "Print this help message.",
+          },
+        },
       }
       service_command_map = {
         "service-management" => {
           "service-list" => {
-            :arity => 1,
-            :desc => "List all the services (enabled services appear with a *.)"
+            arity: 1,
+            desc: "List all the services (enabled services appear with a *.)",
           },
           "status" => {
-            :desc => "Show the status of all the services.",
-            :arity => 2
+            desc: "Show the status of all the services.",
+            arity: 2,
           },
           "tail" => {
-            :desc => "Watch the service logs of all enabled services.",
-            :arity => 2
+            desc: "Watch the service logs of all enabled services.",
+            arity: 2,
           },
           "start" => {
-            :desc => "Start services if they are down, and restart them if they stop.",
-            :arity => 2
+            desc: "Start services if they are down, and restart them if they stop.",
+            arity: 2,
           },
           "stop" => {
-            :desc => "Stop the services, and do not restart them.",
-            :arity => 2
+            desc: "Stop the services, and do not restart them.",
+            arity: 2,
           },
           "restart" => {
-            :desc => "Stop the services if they are running, then start them again.",
-            :arity => 2
+            desc: "Stop the services if they are running, then start them again.",
+            arity: 2,
           },
           "once" => {
-            :desc => "Start the services if they are down. Do not restart them if they stop.",
-            :arity => 2
+            desc: "Start the services if they are down. Do not restart them if they stop.",
+            arity: 2,
           },
           "hup" => {
-            :desc => "Send the services a HUP.",
-            :arity => 2
+            desc: "Send the services a HUP.",
+            arity: 2,
           },
           "term" => {
-            :desc => "Send the services a TERM.",
-            :arity => 2
+            desc: "Send the services a TERM.",
+            arity: 2,
           },
           "int" => {
-            :desc => "Send the services an INT.",
-            :arity => 2
+            desc: "Send the services an INT.",
+            arity: 2,
           },
           "kill" => {
-            :desc => "Send the services a KILL.",
-            :arity => 2
+            desc: "Send the services a KILL.",
+            arity: 2,
           },
           "graceful-kill" => {
-            :desc => "Attempt a graceful stop, then SIGKILL the entire process group.",
-            :arity => 2
-          }
-        }
+            desc: "Attempt a graceful stop, then SIGKILL the entire process group.",
+            arity: 2,
+          },
+          "usr1" => {
+            desc: "Send the services a USR1.",
+            arity: 2,
+          },
+          "usr2" => {
+            desc: "Send the services a USR2.",
+            arity: 2,
+          },
+        },
       }
       @category_command_map.merge!(service_command_map) if service_commands?
     end
 
+    def self.to_method_name(name)
+      name.gsub(/-/, "_").to_sym
+    end
+
+    def to_method_name(name)
+      Ctl.to_method_name(name)
+    end
+
     SV_COMMAND_NAMES.each do |sv_cmd|
-      method_name = sv_cmd.gsub(/-/, "_")
-      Omnibus::Ctl.class_eval <<-EOH
-      def #{method_name}(*args)
+      define_method to_method_name(sv_cmd) do |*args|
         run_sv_command(*args)
       end
-      EOH
     end
 
     # merges category_command_map and command_map,
@@ -160,29 +188,30 @@ module Omnibus
     end
 
     def load_file(filepath)
-      eval(IO.read(filepath))
+      eval(IO.read(filepath), nil, filepath, 1) # rubocop: disable Security/Eval
     end
 
-    def add_command(name, description, arity=1, &block)
-      @command_map[name] = { :desc => description, :arity => arity }
-      metaclass = class << self; self; end
-      # Ruby does not like dashes in method names
-      method_name = name.gsub(/-/, "_")
-      metaclass.send(:define_method, method_name.to_sym) { |*args| block.call(*args) }
+    def add_command(name, description, arity = 1, &block)
+      @command_map[name] = { desc: description, arity: arity }
+      self.class.send(:define_method, to_method_name(name).to_sym) { |*args| block.call(*args) }
     end
 
-    def add_command_under_category(name, category, description, arity=1, &block)
+    def add_command_under_category(name, category, description, arity = 1, &block)
       # add new category if it doesn't exist
-      @category_command_map[category] = {} unless @category_command_map.has_key?(category)
-      @category_command_map[category][name] = { :desc => description, :arity => arity }
-      metaclass = class << self; self; end
-      # Ruby does not like dashes in method names
-      method_name = name.gsub(/-/, "_")
-      metaclass.send(:define_method, method_name.to_sym) { |*args| block.call(*args) }
+      @category_command_map[category] ||= {}
+      @category_command_map[category][name] = { desc: description, arity: arity }
+      self.class.send(:define_method, to_method_name(name).to_sym) { |*args| block.call(*args) }
     end
 
-    def exit!(error_code)
-      exit error_code
+    def add_global_pre_hook(name, &block)
+      method_name = to_method_name("#{name}_global_pre_hook").to_sym
+      @global_pre_hooks[name] = method_name
+      self.class.send(:define_method, method_name, block)
+    end
+
+    def exit!(code)
+      @force_exit = true
+      code
     end
 
     def log(msg)
@@ -190,17 +219,17 @@ module Omnibus
     end
 
     def get_pgrp_from_pid(pid)
-      ps=`which ps`.chomp
+      ps = `which ps`.chomp
       `#{ps} -p #{pid} -o pgrp=`.chomp
     end
 
     def get_pids_from_pgrp(pgrp)
-      pgrep=`which pgrep`.chomp
+      pgrep = `which pgrep`.chomp
       `#{pgrep} -g #{pgrp}`.split(/\n/).join(" ")
     end
 
     def sigkill_pgrp(pgrp)
-      pkill=`which pkill`.chomp
+      pkill = `which pkill`.chomp
       run_command("#{pkill} -9 -g #{pgrp}")
     end
 
@@ -218,40 +247,34 @@ module Omnibus
       exit! 0
     end
 
-    def cleanup_procs_and_nuke(filestr)
-      begin
-        run_sv_command("stop")
-      rescue SystemExit
-      end
+    def cleanup_procs_and_nuke(filestr, calling_method = nil)
+      run_sv_command("stop")
 
-      FileUtils.rm_f("/etc/init/#{name}-runsvdir.conf") if File.exists?("/etc/init/#{name}-runsvdir.conf")
-      run_command("egrep -v '#{base_path}/embedded/bin/runsvdir-start' /etc/inittab > /etc/inittab.new && mv /etc/inittab.new /etc/inittab") if File.exists?("/etc/inittab")
+      FileUtils.rm_f("/etc/init/#{name}-runsvdir.conf") if File.exist?("/etc/init/#{name}-runsvdir.conf")
+      run_command("egrep -v '#{base_path}/embedded/bin/runsvdir-start' /etc/inittab > /etc/inittab.new && mv /etc/inittab.new /etc/inittab") if File.exist?("/etc/inittab")
       run_command("kill -1 1")
 
-      backup_dir = Time.now.strftime("/root/#{name}-cleanse-%FT%R")
-      FileUtils.mkdir_p("/root") unless File.exists?("/root")
+      @backup_dir = Time.now.strftime("/root/#{name}-cleanse-%FT%R")
+
+      FileUtils.mkdir_p("/root") unless File.exist?("/root")
       FileUtils.rm_rf(backup_dir)
-      FileUtils.cp_r(etc_path, backup_dir) if File.exists?(etc_path)
+      FileUtils.cp_r(etc_path, backup_dir) if File.exist?(etc_path)
       run_command("rm -rf #{filestr}")
+      graceful_kill
 
-      begin
-        graceful_kill
-      rescue SystemExit
-      end
-
-      run_command("pkill -HUP -u #{kill_users.join(',')}") if kill_users.length > 0
+      log "Terminating processes running under application users. This will take a few seconds."
+      run_command("pkill -HUP -u #{kill_users.join(",")}") if kill_users.length > 0
       run_command("pkill -HUP -f 'runsvdir -P #{service_path}'")
       sleep 3
-      run_command("pkill -TERM -u #{kill_users.join(',')}") if kill_users.length > 0
+      run_command("pkill -TERM -u #{kill_users.join(",")}") if kill_users.length > 0
       run_command("pkill -TERM -f 'runsvdir -P #{service_path}'")
       sleep 3
-      run_command("pkill -KILL -u #{kill_users.join(',')}") if kill_users.length > 0
+      run_command("pkill -KILL -u #{kill_users.join(",")}") if kill_users.length > 0
       run_command("pkill -KILL -f 'runsvdir -P #{service_path}'")
 
       get_all_services.each do |die_daemon_die|
         run_command("pkill -KILL -f 'runsv #{die_daemon_die}'")
       end
-
       log "Your config files have been backed up to #{backup_dir}."
       exit! 0
     end
@@ -260,16 +283,56 @@ module Omnibus
       cleanup_procs_and_nuke("/tmp/opt")
     end
 
-    def cleanse(*args)
-      log "This will delete *all* configuration, log, and variable data associated with this application.\n\n*** You have 60 seconds to hit CTRL-C ***\n\n"
-      unless args[1] == "yes"
-        sleep 60
+    def scary_cleanse_warning(*args)
+      just_do_it = args.include?("yes")
+      with_external = ARGV.include?("--with-external")
+      log <<EOM
+    *******************************************************************
+    * * * * * * * * * * *       STOP AND READ       * * * * * * * * * *
+    *******************************************************************
+    This command will delete *all* local configuration, log, and
+    variable data associated with #{display_name}.
+EOM
+      if with_external
+        log <<EOM
+    This will also delete externally hosted #{display_name} data.
+    This means that any service you have configured as 'external'
+    will have any #{display_name} permanently deleted.
+EOM
+      elsif not external_services.empty?
+        log <<EOM
+
+    Important note: If you also wish to delete externally hosted #{display_name}
+    data, please hit CTRL+C now and run '#{exe_name} cleanse --with-external'
+EOM
+      end
+
+      unless just_do_it
+        data = with_external ? "local, and remote data" : "and local data"
+        log <<EOM
+
+    You have 60 seconds to hit CTRL-C before configuration,
+    logs, #{data} for this application are permanently
+    deleted.
+    *******************************************************************
+
+EOM
+        begin
+          sleep 60
+        rescue Interrupt
+          log ""
+          exit 0
+        end
       end
-      cleanup_procs_and_nuke("#{service_path}/* /tmp/opt #{data_path} #{etc_path} #{log_path}")
+    end
+
+    def cleanse(*args)
+      scary_cleanse_warning(*args)
+      cleanup_procs_and_nuke("#{service_path}/* /tmp/opt #{data_path} #{etc_path} #{log_path}", "cleanse")
     end
 
     def get_all_services_files
-      Dir[File.join(sv_path, '*')]
+      Dir[File.join(sv_path, "*")]
     end
 
     def get_all_services
@@ -280,8 +343,10 @@ module Omnibus
       File.symlink?("#{service_path}/#{service_name}")
     end
 
-    def run_sv_command(sv_cmd, service=nil)
+    def run_sv_command(sv_cmd, service = nil)
       exit_status = 0
+      sv_cmd = "1" if sv_cmd == "usr1"
+      sv_cmd = "2" if sv_cmd == "usr2"
       if service
         exit_status += run_sv_command_for_service(sv_cmd, service)
       else
@@ -296,10 +361,10 @@ module Omnibus
     def run_sv_command_for_service(sv_cmd, service_name)
       if service_enabled?(service_name)
         status = run_command("#{base_path}/init/#{service_name} #{sv_cmd}")
-        return status.exitstatus
+        status.exitstatus
       else
         log "#{service_name} disabled" if sv_cmd == "status" && verbose
-        return 0
+        0
       end
     end
 
@@ -331,7 +396,7 @@ module Omnibus
       end
 
       # All other services respond normally to p-c-c * commands
-      return true
+      true
     end
 
     # removed services are configured via the attributes file in
@@ -341,12 +406,7 @@ module Omnibus
       # not exist), we know that this will be a new server, and we don't
       # have to worry about pre-upgrade services hanging around. We can safely
       # return an empty array when running_config is nil
-      if (cfg = running_config)
-        key = package_name.gsub(/-/, '_')
-        cfg[key]["removed_services"] || []
-      else
-        []
-      end
+      running_package_config["removed_services"] || []
     end
 
     # hidden services are configured via the attributes file in
@@ -359,12 +419,7 @@ module Omnibus
       # not exist), we don't want to return nil, just return an empty array.
       # worse result with doing that is services that we don't want to show up in
       # c-s-c status will show up.
-      if (cfg = running_config)
-        key = package_name.gsub(/-/, '_')
-        cfg[key]["hidden_services"] || []
-      else
-        []
-      end
+      running_package_config["hidden_services"] || []
     end
 
     # translate the name from the config to the package name.
@@ -382,54 +437,146 @@ module Omnibus
 
     # returns nil when chef-server-running.json does not exist
     def running_config
-      @running_config ||= begin
-        if File.exists?("#{etc_path}/chef-server-running.json")
-          JSON.parse(File.read("#{etc_path}/chef-server-running.json"))
-        end
+      @running_config ||= if File.exist?("#{etc_path}/chef-server-running.json")
+                            JSON.parse(File.read("#{etc_path}/chef-server-running.json"))
+                          end
+    end
+
+    # Helper function that returns the hash of config hashes that have the key 'external' : true
+    # in the running config. If none exist it will return an empty hash.
+    def external_services
+      @external_services ||= running_package_config.select { |k, v| v.class == Hash and v["external"] == true }
+    end
+
+    # Helper function that returns true if an external service entry exists for
+    # the named service
+    def service_external?(service)
+      return false if service.nil?
+
+      external_services.key? service
+    end
+
+    # Gives package config from the running_config.
+    # If there is no running config or if package_name doens't
+    # reference a valid key, this will return an empty hash
+    def running_package_config
+      if (cfg = running_config)
+        cfg[package_name.gsub(/-/, "_")] || {}
+      else
+        {}
       end
     end
 
+    # This returns running_config[package][service].
+    #
+    # If there is no running_config or is no matching key
+    # it will return nil.
+    def running_service_config(service)
+      running_package_config[service]
+    end
+
     def remove_old_node_state
       node_cache_path = "#{base_path}/embedded/nodes/"
       status = run_command("rm -rf #{node_cache_path}")
-      if ! status.success?
+      unless status.success?
         log "Could not remove cached node state!"
-        exit! 1
+        exit 1
       end
     end
 
-    def run_chef(attr_location, args='')
+    def run_chef(attr_location, args = "")
+      if @verbose
+        log_level = "-l debug"
+      elsif @quiet
+        # null formatter is awfully quiet, so let them know we're doing something.
+        log "Reconfiguring #{display_name}."
+        log_level = "-l fatal -F null"
+      else
+        log_level = ""
+      end
       remove_old_node_state
-      cmd = "#{base_path}/embedded/bin/chef-client -z -c #{base_path}/embedded/cookbooks/solo.rb -j #{attr_location}"
+      cmd = "#{base_path}/embedded/bin/chef-client #{log_level} -z -c #{base_path}/embedded/cookbooks/solo.rb -j #{attr_location}"
       cmd += " #{args}" unless args.empty?
       run_command(cmd)
     end
 
     def show_config(*args)
-      status = run_chef("#{base_path}/embedded/cookbooks/show-config.json", "-l fatal")
-      if status.success?
-        exit! 0
-      else
-        exit! 1
-      end
+      status = run_chef("#{base_path}/embedded/cookbooks/show-config.json", "-l fatal -F null")
+      exit! status.success? ? 0 : 1
     end
 
-    def reconfigure(exit_on_success=true)
+    def reconfigure(*args)
+      # args being passed to this command does not include the ones that are
+      # starting with "-". See #is_option? method. If it is starting with "-"
+      # then it is treated as a option and we need to look for them in ARGV.
+      check_license_acceptance(ARGV.include?("--accept-license"))
+
       status = run_chef("#{base_path}/embedded/cookbooks/dna.json")
       if status.success?
         log "#{display_name} Reconfigured!"
-        exit! 0 if exit_on_success
+        exit! 0
       else
         exit! 1
       end
     end
 
+    def check_license_acceptance(override_accept = false)
+      license_guard_file_path = File.join(data_path, ".license.accepted")
+
+      # If the project does not have a license we do not have
+      # any license to accept.
+      return unless File.exist?(project_license_path)
+
+      unless File.exist?(license_guard_file_path)
+        if override_accept || ask_license_acceptance
+          FileUtils.mkdir_p(data_path)
+          FileUtils.touch(license_guard_file_path)
+        else
+          log "Please accept the software license agreement to continue."
+          exit(1)
+        end
+      end
+    end
+
+    def ask_license_acceptance
+      log "To use this software, you must agree to the terms of the software license agreement."
+
+      unless STDIN.tty?
+        log "Please view and accept the software license agreement, or pass --accept-license."
+        exit(1)
+      end
+
+      log "Press any key to continue."
+      user_input = STDIN.getch
+      user_input << STDIN.getch while STDIN.ready?
+      # No need to check for user input
+
+      system("less #{project_license_path}")
+
+      loop do
+        log "Type 'yes' to accept the software license agreement, or anything else to cancel."
+
+        user_input = STDIN.gets.chomp.downcase
+        case user_input
+        when "yes"
+          return true
+        else
+          log "You have not accepted the software license agreement."
+          return false
+        end
+      end
+    end
+
+    def project_license_path
+      File.join(base_path, "LICENSE")
+    end
+
     def tail(*args)
       # find /var/log -type f -not -path '*/sasl/*' | grep -E -v '(lock|@|tgz|gzip)' | xargs tail --follow=name --retry
-      command = "find #{log_path}"
+      command = "find -L #{log_path}"
       command << "/#{args[1]}" if args[1]
-      command << ' -type f'
-      command << log_path_exclude.map { |path| " -not -path #{path}" }.join(' ')
+      command << " -type f"
+      command << log_path_exclude.map { |path| " -not -path '#{path}'" }.join(" ")
       command << " | grep -E -v '#{log_exclude}' | xargs tail --follow=name --retry"
 
       system(command)
@@ -444,16 +591,17 @@ module Omnibus
       exit_status = 0
       get_all_services.each do |service_name|
         next if !service.nil? && service_name != service
+
         if service_enabled?(service_name)
-          pidfile="#{sv_path}/#{service_name}/supervise/pid"
-          pid=File.read(pidfile).chomp if File.exists?(pidfile)
+          pidfile = "#{sv_path}/#{service_name}/supervise/pid"
+          pid = File.read(pidfile).chomp if File.exist?(pidfile)
           if pid.nil? || !is_integer?(pid)
             log "could not find #{service_name} runit pidfile (service already stopped?), cannot attempt SIGKILL..."
             status = run_command("#{base_path}/init/#{service_name} stop")
             exit_status = status.exitstatus if exit_status == 0 && !status.success?
             next
           end
-          pgrp=get_pgrp_from_pid(pid)
+          pgrp = get_pgrp_from_pid(pid)
           if pgrp.nil? || !is_integer?(pgrp)
             log "could not find pgrp of pid #{pid} (not running?), cannot attempt SIGKILL..."
             status = run_command("#{base_path}/init/#{service_name} stop")
@@ -461,8 +609,8 @@ module Omnibus
             next
           end
           run_command("#{base_path}/init/#{service_name} stop")
-          pids=get_pids_from_pgrp(pgrp)
-          if !pids.empty?
+          pids = get_pids_from_pgrp(pgrp)
+          unless pids.empty?
             log "found stuck pids still running in process group: #{pids}, sending SIGKILL" unless pids.empty?
             sigkill_pgrp(pgrp)
           end
@@ -475,14 +623,14 @@ module Omnibus
     end
 
     def help(*args)
-      log "#{$0}: command (subcommand)\n"
+      log "#{exe_name}: command (subcommand)\n"
       command_map.keys.sort.each do |command|
         log command
         log "  #{command_map[command][:desc]}"
       end
       category_command_map.each do |category, commands|
         # Remove "-" and replace with spaces in category and capalize for output
-        category_string = category.gsub("-", " ").split.map(&:capitalize).join(' ')
+        category_string = category.gsub("-", " ").split.map(&:capitalize).join(" ")
         log "#{category_string} Commands:\n"
 
         # Print each command in this category
@@ -491,49 +639,65 @@ module Omnibus
           log "    #{commands[command][:desc]}"
         end
       end
-      exit! 1
+      # Help is not an error so exit with 0.  In cases where we display help as a result of an error
+      # the framework will handle setting proper exit code.
+      exit! 0
     end
 
-    # Set options. Silently ignore bad options.
-    # This allows the test subcommand to pass on pedant options
-    def parse_options!(args)
-      args.each do |option|
+    # Set global options and remove them from the args list we pass
+    # into commands.
+    def parse_options(args)
+      args.select do |option|
         case option
+        when "--quiet", "-q"
+          @quiet = true
+          false
         when "--verbose", "-v"
           @verbose = true
+          false
         end
       end
     end
 
     # If it begins with a '-', it is an option.
     def is_option?(arg)
-      arg && arg[0] == '-'
+      arg && arg[0] == "-"
     end
 
     # retrieves the commmand from either the command_map
     # or the category_command_map, if the command is not found
     # return nil
     def retrieve_command(command_to_run)
-      if command_map.has_key?(command_to_run)
+      if command_map.key?(command_to_run)
         command_map[command_to_run]
       else
         command = nil
         category_command_map.each do |category, commands|
-          command = commands[command_to_run] if commands.has_key?(command_to_run)
+          command = commands[command_to_run] if commands.key?(command_to_run)
         end
         # return the command, or nil if it wasn't found
         command
       end
     end
 
+    # Previously this would exit immediately with the provided
+    # exit code; however this would prevent post-run hooks from continuing
+    # Instead, we'll just track whether a an exit was requested and use that
+    # to determine how we exit from 'run'
     def run(args)
       # Ensure Omnibus related binaries are in the PATH
       ENV["PATH"] = [File.join(base_path, "bin"),
-                     File.join(base_path, "embedded","bin"),
-                     ENV['PATH']].join(":")
+                     File.join(base_path, "embedded", "bin"),
+                     ENV["PATH"]].join(":")
 
       command_to_run = args[0]
 
+      ## when --help is run as the command itself, we need to strip off the
+      ## `--` to ensure the command maps correctly.
+      if command_to_run == "--help"
+        command_to_run = "help"
+      end
+
       # This piece of code checks if the argument is an option. If it is,
       # then it sets service to nil and adds the argument into the options
       # argument. This is ugly. A better solution is having a proper parser.
@@ -549,31 +713,208 @@ module Omnibus
         service = args[1]
       end
 
-      # returns either hash content of comamnd or nil
+      # returns either hash content of command or nil
       command = retrieve_command(command_to_run)
-
       if command.nil?
         log "I don't know that command."
         if args.length == 2
-          log "Did you mean: #{$0} #{service} #{command_to_run}?"
+          log "Did you mean: #{exe_name} #{service} #{command_to_run}?"
         end
         help
+        Kernel.exit 1
       end
 
       if args.length > 1 && command[:arity] != 2
         log "The command #{command_to_run} does not accept any arguments"
-        exit! 2
+        Kernel.exit 2
       end
 
-      parse_options! options
+      parse_options options
+      @force_exit = false
+      exit_code = 0
+
+      run_global_pre_hooks
 
-      method_to_call = command_to_run.gsub(/-/, '_')
       # Filter args to just command and service. If you are loading
       # custom commands and need access to the command line argument,
       # use ARGV directly.
       actual_args = [command_to_run, service].reject(&:nil?)
-      self.send(method_to_call.to_sym, *actual_args)
+      if command_pre_hook(*actual_args)
+        method_to_call = to_method_name(command_to_run)
+        begin
+          ret = send(method_to_call, *actual_args)
+        rescue SystemExit => e
+          @force_exit = true
+          ret = e.status
+        end
+        command_post_hook(*actual_args)
+        exit_code = ret unless ret.nil?
+      else
+        exit_code = 8
+        @force_exit = true
+      end
+
+      if @force_exit
+        Kernel.exit exit_code
+      else
+        exit_code
+      end
+    end
+
+    def run_global_pre_hooks
+      @global_pre_hooks.each do |hook_name, method_name|
+
+        send(method_name)
+      rescue => e
+        $stderr.puts("Global pre-hook '#{hook_name}' failed with: '#{e.message}'")
+        exit(1)
+
+      end
     end
 
+    # Below are some basic command hooks that do the right  thing
+    # when a service is configured as external via [package][service
+
+    # If a command has a pre-hook defined we will run it.
+    # Otherwise, if it is a run-sv command and the service it refers to
+    # is an external service, we will show an error since we
+    # can't control external services from here.
+    #
+    # If any pre-hook returns false, it will prevent execution of the command
+    # and exit the command with exit code 8.
+    def command_pre_hook(*args)
+      command = args.shift
+      method = to_method_name("#{command}_pre_hook")
+      if respond_to?(method)
+        send(method, *args)
+      else
+        return true if args.empty?
+
+        if SV_COMMAND_NAMES.include? command
+          if service_external? args[0]
+            log error_external_service(command, args[0])
+            return false
+          end
+        end
+        true
+      end
+    end
+
+    # Executes after successful completion of a command
+    # If a post-hook provides a numeric return code, it will
+    # replace the return/exit of the original command
+    def command_post_hook(*args)
+      command = args.shift
+      method = to_method_name("#{command}_post_hook")
+      if respond_to?(method)
+        send(method, *args)
+      end
+    end
+
+    # If we're listing status for all services and have external
+    # services to show, we'll include an output header to show that
+    # we're reporting internal services
+    def status_pre_hook(service = nil)
+      log_internal_service_header if service.nil?
+      true
+    end
+
+    # Status gets its own hook because each externalized service will
+    # have its own things to do in order to report status.
+    # As above, we may also include an output header to show that we're
+    # reporting on external services.
+    #
+    # Your callback for this function should be in the form
+    # 'external_status_#{service_name}(detail_level)
+    # where detail_level is :sparse|:verbose
+    # :sparse is used when it's a summary service status list, eg
+    # "$appname-ctl status"
+    # :verbose is used when the specific service has been named, eg
+    # "$appname-ctl status postgresql"
+    def status_post_hook(service = nil)
+      if service.nil?
+        log_external_service_header
+        external_services.each_key do |service_name|
+          status = send(to_method_name("external_status_#{service_name}"), :sparse)
+          log status
+        end
+      else
+        # Request verbose status if the service is asked for by name.
+        if service_external?(service)
+          status = send(to_method_name("external_status_#{service}"), :verbose)
+          log status
+        end
+      end
+    end
+
+    # Data cleanup requirements for external services aren't met by the standard
+    # 'nuke /var/opt' behavior - this hook allows each service to perform its own
+    # 'cleanse' operations.
+    #
+    # Your callback for this function should be in the
+    # form 'external_cleanup_#{service_name}(do_clean)
+    # where do_cliean is true if the delete should actually be
+    # performed, and false if it's expected to inform the user how to
+    # perform the data cleanup without doing any cleanup itself.
+    def cleanse_post_hook(*args)
+      external_services.each_key do |service_name|
+        perform_delete = ARGV.include?("--with-external")
+        if perform_delete
+          log "Deleting data from external service: #{service_name}"
+        end
+        send(to_method_name("external_cleanse_#{service_name}"), perform_delete)
+      end
+    end
+
+    # Add some output headers if we have external services enabled
+    def service_list_pre_hook
+      log_internal_service_header
+      true
+    end
+
+    # Capture external services in the output list as well.
+    def service_list_post_hook
+      log_external_service_header
+      external_services.each  do |name, settings|
+        log " >  #{name} on #{settings["vip"]}"
+      end
+    end
+
+    def error_external_service(command, service)
+      <<EOM
+-------------------------------------------------------------------
+The service #{service} is running externally and cannot be managed
+vi chef-server-ctl.  Please log into #{external_services[service]["vip"]}
+to manage it directly.
+-------------------------------------------------------------------
+EOM
+    end
+
+    def format_multiline_message(indent, message)
+      if message.class == String
+        message = message.split("\n")
+      end
+      spaces = " " * indent
+      message.map! { |line| "#{spaces}#{line.strip}" }
+      message.join("\n")
+    end
+
+    def log_internal_service_header
+      # Don't decorate output unless we have
+      # external services to report on.
+      return if external_services.empty?
+
+      log "-------------------"
+      log " Internal Services "
+      log "-------------------"
+    end
+
+    def log_external_service_header
+      return if external_services.empty?
+
+      log "-------------------"
+      log " External Services "
+      log "-------------------"
+    end
   end
 end