qb 0.3.12 → 0.3.13

data/doc/qb_roles/metadata/default_dir.md

@@ -0,0 +1,116 @@
+QB Role `default_dir` Strategies
+==============================================================================
+
+Details on the acceptable values for the `default_dir` metadata key for QB roles, which I'm calling *strategies*.
+
+-   `null` (or missing entirely) - **No strategy, DIRECTORY arg required on CLI**
+    
+    No strategy for figuring out a default directory.
+    
+    A {QB::UserInputError} will be raised by {QB::Role.default_dir}
+    
+-   `false` - **DIRECTORY arg not used**
+    
+    Role does not use a directory argument.
+    
+    Providing one via the command line *should* result in an error (though this is untested), and `qb_dir` will not be set in Ansible.
+
+-   **Strategies with no parameters**
+    
+    Encoded as simple string values.
+
+    -   `'cwd'` - **Current working directory**
+        
+        Use the working directory the `run` command was executed in.
+        
+        This is expected to pretty much always succeed.
+        
+        > **Example**
+        > 
+        >     default_dir: cwd
+        > 
+
+    -   `'git_root'` - **Git repo root**
+        
+        Use the root of the Git repo for the working directory the run command was executed in.
+        
+        Raises an error if that directory is not part of a Git repo.
+        
+        > **Example**
+        > 
+        >     default_dir: git_root
+        > 
+
+-   **Strategies with parameters**
+    
+    Encoded as directories with a single string key denoting the strategy pointing to a value holding the parameters.
+    
+    -   `{exe: <path:string>}` - **Run an executable**
+        
+        Run the executable at `path` and use the output, which should be a single string directory path (we do chomp what we get back).
+        
+        The exe is fed a `JSON` dump of the role options at the time via  `STDIN`, so it can dynamically determine the directory based on those if it wants.
+        
+        If `path` is relative, it's assumed to be relative to the *role directory*, **NOT** the working directory.
+        
+        Raises errors when things go wrong.
+        
+        > **Example** Role-relative executable
+        > 
+        > This will attempt to resolve the default directory by executing the `<role_path>/bin/get_default_dir` file
+        > 
+        >     default_dir:
+        >       exe: bin/get_default_dir
+        > 
+        
+    -   `{find_up: <rel_path:string>}` - **Find a path walking up**
+        
+        Walk up the directory hierarchy from the CLI working directory looking for the first place that `rel_path` exists.
+        
+        This is used to do things like find the `Gemfile`, nearest
+        `.gitignore`, etc:
+        
+        > **Example** Find the nearest `Gemfile` walking up directories
+        > 
+        >     default_dir:
+        >       find_up: Gemfile
+        >
+        
+        > **Example** Find the nearest `.gitignore` walking up directories
+        > 
+        >     default_dir:
+        >       find_up: .gitignore
+        >
+        
+        `rel_path` can be deep too:
+        
+        > **Example** Find the nearest directory walking up for which `<dir>/dev/ref` exists
+        > 
+        >     default_dir:
+        >       find_up: dev/ref
+        >
+
+    -   `{from_role: <role:string}` - **Use value from another role**
+        
+        Use the value from another QB role, which this one presumably includes.
+        
+        `role` can be anything you would normally use to locate a role using `qb run`, etc. (partial or full name or path).
+        
+        > **Example** Use the value for the `qb/ruby/bundler` role
+        > 
+        >     default_dir:
+        >       from_role: qb/ruby/bundler
+        >
+
+-   `Array` - **Multiple strategies (fallbacks)**
+    
+    A list of strategies to try; first to succeed wins.
+    
+    > **Example** Closest `Gemfile` or Git root
+    > 
+    > Walk up directories looking for `Gemfile`, and if one can't be found then use the Git repo root.
+    > 
+    >     default_dir:
+    >     -   find_up: Gemfile
+    >     -   git_root
+    > 

data/exe/qb

@@ -35,30 +35,32 @@ def main args
   
   QB.check_ansible_version
   
-  logger.debug "Switch arg" => args[0]
+  logger.debug "Main switch arg" => args[0]
   
-  status = case args[0]
+  method_name, method_args = case args[0]
   when nil, '-h', '--help', 'help'
-    QB::CLI.help
+    [:help, []]
   when 'play'
-    QB::CLI.play args.rest
+    [:play, args.rest]
   when 'run'
-    QB::CLI.run args.rest
+    [:run, args.rest]
   when 'setup'
-    state_args = args.rest
-    
-    case state_args[0]
-    when nil
-      QB::CLI.setup
-    end
+    [:setup, args.rest]
   else
     # default to `run` on the full args
-    QB::CLI.run args
+    [:run, args]
   end
   
-  logger.debug "Exit status", status
+  logger.debug "Calling QB::CLI.#{ method_name }",
+    method_args: method_args
   
-  # exit status
+  status = begin
+    QB::CLI.public_send method_name, method_args
+  rescue Exception => error
+    raise error
+  end
+  
+  logger.debug "QB::CLI.#{ method_name } returned, exiting.", status: status
   exit status
 end
 

data/lib/qb.rb

@@ -45,32 +45,17 @@ module QB
   include SemanticLogger::Loggable
   
   
+  # Support for the old custom debug logging, now sent to {SemanticLogger}.
+  # 
   def self.debug *args
     if args[0].is_a? String
       logger.debug *args
     else
+      # De-array if there's only one arg
+      args = args[0] if args.length == 1
+      # And send the args to SM as the payload
       logger.debug payload: args
     end
-    
-    # return unless ENV['QB_DEBUG'] && args.length > 0
-    # 
-    # header = 'DEBUG'
-    # 
-    # if args[0].is_a? String
-    #   header += " " + args.shift
-    # end
-    # 
-    # dumpObj = case args.length
-    # when 0
-    #   header
-    # when 1
-    #   {header => args[0]}
-    # else
-    #   {header => args}
-    # end
-    # 
-    # # $stderr.puts("DEBUG " + format(msg, values))
-    # $stderr.puts dumpObj.pretty_inspect
   end
     
 end

data/lib/qb/ansible/cmds/playbook.rb

@@ -26,8 +26,8 @@ class QB::Ansible::Cmds::Playbook < ::Cmds
   # shell path resolution do it's thing.
   DEFAULT_EXE = 'ansible-playbook'
   
-  TEMPLATE = <<-END    
-    <%= exe %>
+  TEMPLATE = <<-END
+    <%== exe %>
     
     <%= cmd_options %>
     
@@ -134,7 +134,7 @@ class QB::Ansible::Cmds::Playbook < ::Cmds
   
   
   # Instance Methods
-  # ======================================================================  
+  # ======================================================================
   
   # @return [Hash<String => Object>]
   #   Hash of CLI options for `ansible-playbook` based off {#role_options}
@@ -241,4 +241,3 @@ class QB::Ansible::Cmds::Playbook < ::Cmds
   # end protected
   
 end # class QB::Ansible::Playbook
-

data/lib/qb/ansible/env.rb

@@ -53,6 +53,16 @@ class QB::Ansible::Env
   attr_reader :lookup_plugins
   
   
+  # `ANSIBLE_CONFIG_<name>=<value>` ENV var values.
+  # 
+  # @see http://docs.ansible.com/ansible/latest/intro_configuration.html
+  # 
+  # @return [Hash<(String | Symbol), String]
+  #     
+  attr_reader :config
+  
+  
+  
   # Constructor
   # ======================================================================
   
@@ -76,6 +86,8 @@ class QB::Ansible::Env
     @lookup_plugins = [
       QB::ROOT.join('plugins', 'lookup_plugins'),
     ]
+    
+    @config = {}
   end # #initialize
   
   
@@ -91,19 +103,27 @@ class QB::Ansible::Env
   #   @todo Document return value.
   # 
   def to_h
-    [
+    hash = [
       :roles_path,
       :library,
       :filter_plugins,
       :lookup_plugins
     ].map { |name|
-      value = self.send(name)
+      value = self.send name
       
       value = value.join(':') if value.is_a?(Array)
       
       [self.class.to_var_name(name), value]
     }.to_h
+    
+    config.each { |name, value|
+      hash[ self.class.to_var_name( "CONFIG_#{ name }" ) ] = value.to_s
+    }
+    
+    hash
   end # #to_h
   
   
 end # class QB::Ansible::Env
+
+require 'qb/ansible/env/devel'

data/lib/qb/ansible/env/devel.rb

@@ -0,0 +1,49 @@
+module QB; end
+module QB::Ansible; end
+
+
+# @todo document QB::Ansible::Env class.
+class QB::Ansible::Env::Devel < QB::Ansible::Env
+  ANSIBLE_HOME = QB::ROOT / 'packages' / 'python' / 'ansible'
+  
+  # Instance Methods
+  # ======================================================================
+  
+  # @todo Document to_h method.
+  #
+  # @param [type] arg_name
+  #   @todo Add name param description.
+  #
+  # @return [return_type]
+  #   @todo Document return value.
+  #
+  def to_h
+    hash = super
+    
+    hash['ANSIBLE_HOME'] = ANSIBLE_HOME.to_s
+    
+    hash['PYTHONPATH'] = [
+      # (QB::ROOT / 'lib' / 'python'),
+      (ANSIBLE_HOME / 'lib'),
+      ENV['PYTHONPATH'],
+    ].
+      compact.
+      map( &:to_s ).
+      join( ':' )
+    
+    path = ENV['PATH'].split ':'
+    
+    path.insert \
+      path.find_index { |p| ! p.start_with?( './' ) },
+      (ANSIBLE_HOME / 'bin').to_s
+    
+    hash['PATH'] = path.join ':'
+    
+    # hash['ANSIBLE_CONNECTION'] = 'local'
+    # hash['ANSIBLE_PYTHON_INTERPRETER'] = '/usr/local/bin/python2'
+    
+    hash
+  end # #to_h
+  
+  
+end # class QB::Ansible::Env

data/lib/qb/cli.rb

@@ -30,6 +30,8 @@ module QB; end
 
 module QB::CLI
   
+  include SemanticLogger::Loggable
+  
   # Eigenclass (Singleton Class)
   # ========================================================================
   # 
@@ -114,7 +116,7 @@ module QB::CLI
       ask name: option.name,
           description: option.description,
           default: default
-          # type: 
+          # type:
     end
     
     

data/lib/qb/cli/help.rb

@@ -24,7 +24,7 @@ module QB::CLI
   #   Error exit status - we don't want `qb ... && ...` to move on to the 
   #   second command when we end up falling back to `help`.
   # 
-  def self.help
+  def self.help args = []
     metadata = if QB.gemspec.metadata && !QB.gemspec.metadata.empty?
       "metadata:\n" + QB.gemspec.metadata.map {|key, value|
         "  #{ key }: #{ value }"

data/lib/qb/cli/list.rb

@@ -0,0 +1,47 @@
+# Requirements
+# =====================================================================
+
+# package
+
+
+# Declarations
+# =======================================================================
+
+module QB; end
+
+
+# Definitions
+# =======================================================================
+
+module QB::CLI
+  
+  # List available roles.
+  # 
+  # @example
+  #   
+  #   qb list --user
+  #   qb list -u
+  #   qb list --local
+  #   qb list -l
+  #   qb list --system
+  #   qb list -s
+  #   qb list --path=:system
+  #   qb list --path=./roles
+  #   qb list -p ./roles
+  #   qb list gem
+  # 
+  # @todo
+  #   We should have more types of help.
+  # 
+  # @return [1]
+  #   Error exit status - we don't want `qb ... && ...` to move on to the
+  #   second command when we end up falling back to `help`.
+  # 
+  def self.list args = []
+    puts QB::Role.available
+    puts
+    
+    return 1
+  end # .help
+  
+end # module QB::CLI

data/lib/qb/cli/run.rb

@@ -14,7 +14,7 @@ module QB; end
 # Definitions
 # =======================================================================
 
-module QB::CLI 
+module QB::CLI
   
   # Run a QB role.
   # 
@@ -22,13 +22,13 @@ module QB::CLI
   #   CLI args to work with.
   # 
   # @return [Fixnum]
-  #   Exit status code from `ansible-playbook` command, unless we invoked 
+  #   Exit status code from `ansible-playbook` command, unless we invoked
   #   help or error'd out in another way before the run (in which case `1`
   #   is returned).
   # 
   def self.run args
     role_arg = args.shift
-    QB.debug "role arg", role_arg
+    QB.debug "role arg" => role_arg
     
     begin
       role = QB::Role.require role_arg
@@ -45,17 +45,17 @@ module QB::CLI
     
     options = QB::Options.new role, args
     
-    QB.debug "role options set on cli", options.role_options.select {|k, o|
-      !o.value.nil?
-    }
+    QB.debug "Role options set on cli",
+      role: options.role_options.reject { |k, o| o.value.nil? }
     
-    QB.debug "qb options", options.qb
+    QB.debug "QB options", options.qb.dup
+    QB.debug "Ansible options", options.ansible.dup
     
     cwd = Dir.getwd
     
     dir = nil
     
-    if role.uses_default_dir?
+    if role.has_dir_arg?
       # get the target dir
       dir = case args.length
       when 0
@@ -198,10 +198,39 @@ module QB::CLI
       ],
       'roles' => [
         'nrser.blockinfile',
-        playbook_role
       ],
     }
     
+    if role.meta['call_role']
+      logger.debug "Calling role through qb/call..."
+      
+      play['tasks'] = [
+        {
+          'include_role' => {
+            'name' => 'qb/call',
+          },
+          'vars' => {
+            'role' => role.name,
+            'args' => set_options.map { |option|
+              [option.var_name, option.value]
+            }.to_h,
+          }
+        }
+      ]
+      
+      env = QB::Ansible::Env::Devel.new
+      exe = [
+        "python2",
+        (QB::Ansible::Env::Devel::ANSIBLE_HOME / 'bin' / 'ansible-playbook')
+      ].join " "
+      
+    else
+      play['roles'] << playbook_role
+      env = QB::Ansible::Env.new
+      exe = "ansible-playbook"
+      
+    end
+    
     if options.qb['user']
       play['become'] = true
       play['become_user'] = options.qb['user']
@@ -209,9 +238,7 @@ module QB::CLI
     
     playbook = [play]
     
-    QB.debug "playbook", playbook
-    
-    env = QB::Ansible::Env.new
+    logger.debug "playbook", playbook
     
     # stick the role path in front to make sure we get **that** role
     env.roles_path.unshift role.path.expand_path.dirname
@@ -220,7 +247,8 @@ module QB::CLI
       env: env,
       playbook: playbook,
       role_options: options,
-      chdir: (File.exists?('./ansible/ansible.cfg') ? './ansible' : nil)
+      chdir: (File.exists?('./ansible/ansible.cfg') ? './ansible' : nil),
+      exe: exe
     
     # print
     # =====
@@ -287,5 +315,3 @@ module QB::CLI
   end # .run
   
 end # module QB::CLI
-
-