omnibus-ctl 0.5.0 → 0.6.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ba3442fde147f0b637bb2ce3dfe8f61952c00c5d
-  data.tar.gz: 69b92b796d3f0afbbfe13bc429fcc09cb8ad8043
+SHA256:
+  metadata.gz: d5a9e7ad1cc7b71b4a63de91b45c0defc0e980a6ec79848339041eecf414493f
+  data.tar.gz: b0f98055e5f34965c6d61719f15c0c6231d43345b87b3ed3e65ede350103728f
 SHA512:
-  metadata.gz: 5d184d6b71831ed278e907ee83d3b73d26876dbcd4d1aae0a0ed5ac6b7e8990629e6a362b31132776878f6cf3ac0964e093c72bc098c385b9a746f100c1c2f34
-  data.tar.gz: e2b700aa51a77c273846a1669ebbbda5c9a5c7bb520e277c1199dbabe66edbe248094b6614bac68a5679d5738e293feb26ea4f1265541b860d1bc782c84d8e46
+  metadata.gz: 44b9168f26f927b61a68d8a8d9145c6a18d4b6dad0a48e69515544c107dceb6061b2483580ac9582be750b8fd0d893bc5d77d58bd698c35de220240a28db1913
+  data.tar.gz: a2035e53d04247a5b8a6cfa5e777d974ec4747960de47e473c92a438e044c91a86c5d000be4db50d4bce2ba8a0f1726633e8740b9e8138c066ab254bde6a0198

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/bin/omnibus-ctl

@@ -7,9 +7,9 @@
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
-# 
+#
 #     http://www.apache.org/licenses/LICENSE-2.0
-# 
+#
 # Unless required by applicable law or agreed to in writing, software
 # distributed under the License is distributed on an "AS IS" BASIS,
 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@@ -17,7 +17,7 @@
 # limitations under the License.
 #
 
-require 'omnibus-ctl'
+require "omnibus-ctl"
 
 # service name: ARGV[0]
 # additional modules: ARGV[1]

data/lib/omnibus-ctl/version.rb

@@ -1,5 +1,5 @@
 module Omnibus
   class Ctl
-    VERSION = "0.5.0"
+    VERSION = "0.6.10".freeze
   end
 end

data/lib/omnibus-ctl.rb

@@ -15,21 +15,22 @@
 #
 
 require "omnibus-ctl/version"
-require 'json'
-require 'fileutils'
+require "chef-utils/dist" unless defined?(ChefUtils)
+require "json" unless defined?(JSON)
+require "fileutils" unless defined?(FileUtils)
 
 # For license checks
-require 'io/console'
-require 'io/wait'
+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 usr1 usr2]
+                      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,
@@ -37,8 +38,7 @@ module Omnibus
 
     attr_reader :backup_dir, :exe_name
 
-
-    def initialize(name, merge_service_commands=true, disp_name = nil)
+    def initialize(name, merge_service_commands = true, disp_name = nil)
       @name = name
       @service_commands = merge_service_commands
       @display_name = disp_name || name
@@ -48,109 +48,116 @@ module Omnibus
       @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 => 2
+            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
+            desc: "Send the services a USR1.",
+            arity: 2,
           },
           "usr2" => {
-            :desc => "Send the services a USR2.",
-            :arity => 2
-          }
-        }
+            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
+      name.gsub(/-/, "_").to_sym
     end
+
     def to_method_name(name)
       Ctl.to_method_name(name)
     end
@@ -182,24 +189,25 @@ module Omnibus
     end
 
     def load_file(filepath)
-      eval(IO.read(filepath), nil, filepath, 1)
+      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 = to_method_name(name).to_sym
-      metaclass.send(:define_method, method_name) { |*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
-      method_name = to_method_name(name).to_sym
-      metaclass.send(:define_method, method_name) { |*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 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)
@@ -212,17 +220,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
 
@@ -243,26 +251,26 @@ module Omnibus
     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")
+      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
 
       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 -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|
@@ -286,13 +294,13 @@ module Omnibus
     This command will delete *all* local configuration, log, and
     variable data associated with #{display_name}.
 EOM
-      if (with_external)
+      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?)
+      elsif not external_services.empty?
         log <<EOM
 
     Important note: If you also wish to delete externally hosted #{display_name}
@@ -324,9 +332,8 @@ EOM
       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
@@ -337,7 +344,7 @@ EOM
       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"
@@ -390,7 +397,7 @@ EOM
       end
 
       # All other services respond normally to p-c-c * commands
-      return true
+      true
     end
 
     # removed services are configured via the attributes file in
@@ -422,7 +429,8 @@ EOM
     # 'opscode', not 'private-chef'
     def package_name
       case @name
-      when "opscode"
+      # The "opscode" in /opt/opscode
+      when ::ChefUtils::Dist::Org::LEGACY_CONF_DIR
         "private-chef"
       else
         @name
@@ -431,24 +439,24 @@ EOM
 
     # 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
-      end
+      fname = "#{etc_path}/#{::ChefUtils::Dist::Server::SERVER}-running.json"
+      @running_config ||= if File.exist?(fname)
+                            JSON.parse(File.read(fname))
+                          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 }
+      @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?
-      return external_services.has_key? service
+
+      external_services.key? service
     end
 
     # Gives package config from the running_config.
@@ -456,7 +464,7 @@ EOM
     # reference a valid key, this will return an empty hash
     def running_package_config
       if (cfg = running_config)
-        cfg[package_name.gsub(/-/, '_')] || {}
+        cfg[package_name.gsub(/-/, "_")] || {}
       else
         {}
       end
@@ -473,19 +481,19 @@ EOM
     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
       end
     end
 
-    def run_chef(attr_location, args='')
+    def run_chef(attr_location, args = "")
       if @verbose
-        log_level = "-L debug"
+        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"
+        log_level = "-l fatal -F null"
       else
         log_level = ""
       end
@@ -522,7 +530,7 @@ EOM
       # any license to accept.
       return unless File.exist?(project_license_path)
 
-      if !File.exist?(license_guard_file_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)
@@ -536,7 +544,7 @@ EOM
     def ask_license_acceptance
       log "To use this software, you must agree to the terms of the software license agreement."
 
-      if !STDIN.tty?
+      unless STDIN.tty?
         log "Please view and accept the software license agreement, or pass --accept-license."
         exit(1)
       end
@@ -568,10 +576,10 @@ EOM
 
     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)
@@ -586,16 +594,17 @@ EOM
       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")
@@ -603,14 +612,14 @@ EOM
             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
         else
           log "#{service_name} disabled, not stopping"
-          exit_status =1
+          exit_status = 1
         end
       end
       exit! exit_status
@@ -624,7 +633,7 @@ EOM
       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
@@ -655,19 +664,19 @@ EOM
 
     # 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
@@ -681,11 +690,17 @@ EOM
     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.
@@ -721,6 +736,8 @@ EOM
       @force_exit = false
       exit_code = 0
 
+      run_global_pre_hooks
+
       # Filter args to just command and service. If you are loading
       # custom commands and need access to the command line argument,
       # use ARGV directly.
@@ -747,6 +764,17 @@ EOM
       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
 
@@ -764,10 +792,11 @@ EOM
         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;
+            return false
           end
         end
         true
@@ -792,6 +821,7 @@ EOM
       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
@@ -842,22 +872,22 @@ EOM
     # Add some output headers if we have external services enabled
     def service_list_pre_hook
       log_internal_service_header
-      return true
+      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']}"
+        log " >  #{name} on #{settings["vip"]}"
       end
     end
 
     def error_external_service(command, service)
-  <<EOM
+      <<EOM
 -------------------------------------------------------------------
 The service #{service} is running externally and cannot be managed
-vi chef-server-ctl.  Please log into #{external_services[service]['vip'] }
+vi chef-server-ctl.  Please log into #{external_services[service]["vip"]}
 to manage it directly.
 -------------------------------------------------------------------
 EOM
@@ -867,8 +897,8 @@ EOM
       if message.class == String
         message = message.split("\n")
       end
-      spaces = " "*indent
-      message.map!{|line| "#{spaces}#{line.strip}"}
+      spaces = " " * indent
+      message.map! { |line| "#{spaces}#{line.strip}" }
       message.join("\n")
     end
 
@@ -876,6 +906,7 @@ EOM
       # Don't decorate output unless we have
       # external services to report on.
       return if external_services.empty?
+
       log "-------------------"
       log " Internal Services "
       log "-------------------"
@@ -883,6 +914,7 @@ EOM
 
     def log_external_service_header
       return if external_services.empty?
+
       log "-------------------"
       log " External Services "
       log "-------------------"

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: omnibus-ctl
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.10
 platform: ruby
 authors:
-- Opscode, Inc.
+- Chef Software, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-15 00:00:00.000000000 Z
+date: 2022-02-15 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef-utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 16.5.54
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 16.5.54
+- !ruby/object:Gem::Dependency
+  name: chefstyle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -61,12 +89,13 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
+- LICENSE
 - bin/omnibus-ctl
 - lib/omnibus-ctl.rb
 - lib/omnibus-ctl/version.rb
 homepage: http://github.com/chef/omnibus-ctl
-licenses: []
+licenses:
+- Apache-2.0
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -76,15 +105,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Provides command line control for omnibus packages

data/README.md

@@ -1,100 +0,0 @@
-# omnibus-ctl
-
-[![Build Status Master](https://travis-ci.org/chef/omnibus-ctl.svg?branch=master)](https://travis-ci.org/chef/omnibus-ctl)
-
-omnibus-ctl provides service control and configuration for omnibus packages.
-
-For an introduction, please see this blog post [Omnibus-ctl: What is it and what can it do for you?](https://www.chef.io/blog/2015/05/26/omnibus-ctl-what-is-it-and-what-can-it-do-for-you/).
-
-## Run the Tests!
-
-There are tests in this repo that should be run before merging to master in the `spec` directory.
-
-To run them, first install rspec via bundler:
-
-```
-bundle install
-```
-
-Then run the tests:
-
-```
-bin/rspec
-```
-
-## Framework API
-
-There are two main functions you will use in your `*-ctl` project to add commands.
-
-### add_command_under_category(string, string, string, int, ruby_block)
-
-This method will add a new command to your ctl under a category, useful for grouping similar commands together logically in help output.
-
-Input arguments:
-
-1. Name of the command.
-2. Category of the command. It should be string consisting of only characters and "-". If the category does not exist, it will be added. Default categories are "general" and "service-management" (if the latter is enabled).
-3. Description. This will be outputted below the command name when the help command is run.
-4. Arity. TODO: Due to current bug, this must be 2, I believe. We should fix this.
-5. Ruby block. Ruby code to be executed when your command is run (arguments to that command will be passed into the block).
-
-### add_command(string, string, int, ruby_block)
-
-This method will add a new command to your ctl without a category. It will be displayed above all categories when the help command is called.
-
-Input arguments are the same as `add_command_under_category` except 2 doesn't exist.
-
-### Sample Output
-
-```
-# sample-ctl help
-/opt/opscode/embedded/bin/sample-ctl: command (subcommand)
-command-without-category
-  Here is an insightful description for the above command, added via add_command.
-another-command-without-category
-  Yet another description.
-Some Category Of Commands:
-  command-with-category
-    Exciting description of command added via add_command_under_category.
-  better-command-with-category
-    You get the idea.
-Another Category:
-  command-with-better-category
-    I'm not just going to copy-pasta above example descriptions.
-  better-command-with-better-category
-    I'm running out of ideas.
-```
-
-If you only use `add_command_under_category` to add your custom commands, everything will be outputted under a category.
-
-## Releasing
-
-*NOTE: Versions prior to 0.3.6 do not use a "v" prefix for their tags. Current
-versions do.*
-
-* Update the version in lib/omnibus-ctl/version.rb.
-* Update the [Change log](CHANGELOG.md).
-* Commit those changes.
-* Make sure you are an owner of the
-  [omnibus-ctl gem on RubyGems.org](https://rubygems.org/gems/omnibus-ctl). If
-  you aren't, contact one of the owners to be added.
-* `rake release`. This will tag the version, push it to GitHub and RubyGems.
-
-## License
-
-See the LICENSE file for details.
-
-Copyright: Copyright (c) 2012-2015 Chef Software, Inc.
-License: Apache License, Version 2.0
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.