omnibus-ctl 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba3442fde147f0b637bb2ce3dfe8f61952c00c5d
-  data.tar.gz: 69b92b796d3f0afbbfe13bc429fcc09cb8ad8043
+  metadata.gz: 7124151190ecb3203434afe79f6f705cc92006ac
+  data.tar.gz: 2054e06087ef69abeb032265e01fd32dfc5db730
 SHA512:
-  metadata.gz: 5d184d6b71831ed278e907ee83d3b73d26876dbcd4d1aae0a0ed5ac6b7e8990629e6a362b31132776878f6cf3ac0964e093c72bc098c385b9a746f100c1c2f34
-  data.tar.gz: e2b700aa51a77c273846a1669ebbbda5c9a5c7bb520e277c1199dbabe66edbe248094b6614bac68a5679d5738e293feb26ea4f1265541b860d1bc782c84d8e46
+  metadata.gz: cd94929d628f632dd24ab41e36e3efba988ce2a0c7193172e1089d48136bbe108a997cc42a5438fd0165a8f3ce469911ddabae3c2965da002561a8084fb581b2
+  data.tar.gz: 3ce02e9da7978e6d40837d7ccf7e141a67b9447b9837e966b7b1db8d0d66a1007c1e36cf9283a383d9ee384ba41bfe8cd9d1026ff5795f9751dfae3d221cef65

data/README.md

@@ -22,7 +22,7 @@ Then run the tests:
 bin/rspec
 ```
 
-## Framework API
+## Command API
 
 There are two main functions you will use in your `*-ctl` project to add commands.
 
@@ -67,6 +67,27 @@ Another Category:
 
 If you only use `add_command_under_category` to add your custom commands, everything will be outputted under a category.
 
+## Pre-hook API
+
+### add_global_pre_hook(string, ruby_block)
+
+This method will add a global pre-hook block that will be executed before any
+*-ctl command is run. If the pre-hook raises an exception it will cause an early
+exit before the command is run.
+
+Input Arguments:
+
+1. Name of the hook
+1. Ruby block of the code to be executed.
+
+### Sample
+
+```ruby
+add_global_pre_hook "ensure that the user is always root" do
+  raise "You must run this command as root" unless Process.uid == 0
+end
+```
+
 ## Releasing
 
 *NOTE: Versions prior to 0.3.6 do not use a "v" prefix for their tags. Current

data/lib/omnibus-ctl.rb

@@ -27,7 +27,7 @@ module Omnibus
 
     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]
 
@@ -56,6 +56,12 @@ module Omnibus
       @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 = { }
@@ -151,6 +157,7 @@ module Omnibus
     def self.to_method_name(name)
       name.gsub(/-/, '_').to_sym
     end
+
     def to_method_name(name)
       Ctl.to_method_name(name)
     end
@@ -185,21 +192,22 @@ module Omnibus
       eval(IO.read(filepath), nil, filepath, 1)
     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)
@@ -481,11 +489,11 @@ EOM
 
     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
@@ -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 << log_path_exclude.map { |path| " -not -path '#{path}'" }.join(' ')
       command << " | grep -E -v '#{log_exclude}' | xargs tail --follow=name --retry"
 
       system(command)
@@ -686,6 +694,12 @@ EOM
 
       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 +735,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 +763,17 @@ EOM
       end
     end
 
+    def run_global_pre_hooks
+      @global_pre_hooks.each do |hook_name, method_name|
+        begin
+          send(method_name)
+        rescue => e
+          $stderr.puts("Global pre-hook '#{hook_name}' failed with: '#{e.message}'")
+          exit(1)
+        end
+      end
+    end
+
     # Below are some basic command hooks that do the right  thing
     # when a service is configured as external via [package][service
 

data/lib/omnibus-ctl/version.rb

@@ -1,5 +1,5 @@
 module Omnibus
   class Ctl
-    VERSION = "0.5.0"
+    VERSION = "0.6.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omnibus-ctl
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
-- Opscode, Inc.
+- Chef Software, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-15 00:00:00.000000000 Z
+date: 2018-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -66,7 +66,8 @@ files:
 - 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: []
@@ -84,7 +85,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Provides command line control for omnibus packages