qb 0.3.3 → 0.3.4

data/lib/qb/ansible/module.rb

@@ -0,0 +1,194 @@
+require 'json'
+require 'pp'
+
+
+# Declarations
+# =====================================================================
+
+module QB; end
+module QB::Ansible; end
+
+
+# Definitions
+# =====================================================================
+
+class QB::Ansible::Module
+  
+  # Class Variables
+  # =====================================================================
+  
+  @@arg_types = {}
+  
+  
+  # Class Methods
+  # =====================================================================
+  
+  def self.stringify_keys hash
+    hash.map {|k, v| [k.to_s, v]}.to_h
+  end
+  
+  
+  def self.arg name, type
+    @@arg_types[name.to_sym] = type
+  end
+  
+  
+  # Constructor
+  # =====================================================================
+  
+  def initialize
+    @changed = false
+    @input_file = ARGV[0]
+    @input = File.read @input_file
+    @args = JSON.load @input
+    @facts = {}
+    @warnings = []
+    
+    @qb_stdio_out = nil
+    @qb_stdio_err = nil
+    @qb_stdio_in = nil
+    
+    # debug "HERE!"
+    # debug ENV
+    
+    # if QB_STDIO_ env vars are set send stdout and stderr
+    # to those sockets to print in the parent process
+    
+    if ENV['QB_STDIO_ERR']
+      @qb_stdio_err = $stderr = UNIXSocket.new ENV['QB_STDIO_ERR']
+      
+      debug "Connected to QB stderr stream at #{ ENV['QB_STDIO_ERR'] } #{ @qb_stdio_err.path }."
+    end
+    
+    if ENV['QB_STDIO_OUT']
+      @qb_stdio_out = $stdout = UNIXSocket.new ENV['QB_STDIO_OUT']
+      
+      debug "Connected to QB stdout stream at #{ ENV['QB_STDIO_OUT'] }."
+    end
+    
+    if ENV['QB_STDIO_IN']
+      @qb_stdio_in = UNIXSocket.new ENV['QB_STDIO_IN']
+      
+      debug "Connected to QB stdin stream at #{ ENV['QB_STDIO_IN'] }."
+    end
+    
+    @@arg_types.each {|key, type|
+      var_name = "@#{ key.to_s }"
+      
+      unless instance_variable_get(var_name).nil?
+        raise ArgumentError.new NRSER.squish <<-END
+          an instance variable named #{ var_name } exists
+          with value #{ instance_variable_get(var_name).inspect }
+        END
+      end
+      
+      instance_variable_set var_name,
+                            type.check(@args.fetch(key.to_s))
+    }
+  end
+  
+  
+  
+  # Instance Methods
+  # =====================================================================
+  
+  # Logging
+  # ---------------------------------------------------------------------
+  # 
+  # Logging is a little weird in Ansible modules... Ansible has facilities
+  # for notifying the user about warnings and depreciations, which we will
+  # make accessible, but it doesn't seem to have facilities for notices and
+  # debugging, which I find very useful.
+  # 
+  # When run inside of QB (targeting localhost only at the moment, sadly)
+  # we expose additional IO channels for STDIN, STDOUT and STDERR through
+  # opening unix socket files that the main QB process spawns threads to 
+  # listen to, and we provide those file paths via environment variables
+  # so modules can pick those up and interact with those streams, allowing
+  # them to act like regular scripts inside Ansible-world (see 
+  # QB::Util::STDIO for details and implementation).
+  # 
+  # We use those channels if present to provide logging mechanisms.
+  # 
+  
+  # Forward args to {QB.debug} if we are connected to a QB STDERR stream
+  # (write to STDERR).
+  # 
+  # @param args see QB.debug
+  # 
+  def debug *args
+    if @qb_stdio_err
+      header = "<QB::Ansible::Module #{ self.class.name }>"
+      
+      if args[0].is_a? String
+        header += " " + args.shift
+      end
+      
+      QB.debug header, *args
+    end
+  end
+  
+  def info msg
+    if @qb_stdio_err
+      $stderr.puts msg
+    end
+  end
+  
+  # Append a warning message to @warnings.
+  def warn msg
+    @warnings << msg
+  end
+  
+  
+  def run
+    result = main
+    
+    case result
+    when nil
+      # pass
+    when Hash
+      @facts.merge! result
+    else
+      raise "result of #main should be nil or Hash, found #{ result.inspect }"
+    end
+    
+    done
+  end
+  
+  def changed! facts = {}
+    @changed = true
+    @facts.merge! facts
+    done
+  end
+  
+  def done
+    exit_json changed: @changed,
+              ansible_facts: self.class.stringify_keys(@facts),
+              warnings: @warnings
+  end
+  
+  def exit_json hash
+    # print JSON response to process' actual STDOUT (instead of $stdout,
+    # which may be pointing to the qb parent process)
+    STDOUT.print JSON.dump(self.class.stringify_keys(hash))
+    
+    [
+      [:stdin, @qb_stdio_in],
+      [:stdout, @qb_stdio_out],
+      [:stderr, @qb_stdio_err],
+    ].each do |name, socket|
+      if socket
+        debug "Flushing socket #{ name }."
+        socket.flush
+        debug "Closing #{ name } socket at #{ socket.path.to_s }."
+        socket.close
+      end
+    end
+    
+    exit 0
+  end
+  
+  def fail msg
+    exit_json failed: true, msg: msg, warnings: @warnings
+  end
+end # class QB::Ansible::Module

data/lib/qb/ansible_module.rb

@@ -1,185 +1,5 @@
-require 'json'
-require 'pp'
+require_relative './ansible/module'
 
 module QB
-  class AnsibleModule
-    
-    # Class Variables
-    # =====================================================================
-    
-    @@arg_types = {}
-    
-    
-    # Class Methods
-    # =====================================================================
-    
-    def self.stringify_keys hash
-      hash.map {|k, v| [k.to_s, v]}.to_h
-    end
-    
-    
-    def self.arg name, type
-      @@arg_types[name.to_sym] = type
-    end
-    
-    
-    # Constructor
-    # =====================================================================
-    
-    def initialize
-      @changed = false
-      @input_file = ARGV[0]
-      @input = File.read @input_file
-      @args = JSON.load @input
-      @facts = {}
-      @warnings = []
-      
-      @qb_stdio_out = nil
-      @qb_stdio_err = nil
-      @qb_stdio_in = nil
-      
-      # debug "HERE!"
-      # debug ENV
-      
-      # if QB_STDIO_ env vars are set send stdout and stderr
-      # to those sockets to print in the parent process
-      
-      if ENV['QB_STDIO_ERR']
-        @qb_stdio_err = $stderr = UNIXSocket.new ENV['QB_STDIO_ERR']
-        
-        debug "Connected to QB stderr stream at #{ ENV['QB_STDIO_ERR'] } #{ @qb_stdio_err.path }."
-      end
-      
-      if ENV['QB_STDIO_OUT']
-        @qb_stdio_out = $stdout = UNIXSocket.new ENV['QB_STDIO_OUT']
-        
-        debug "Connected to QB stdout stream at #{ ENV['QB_STDIO_OUT'] }."
-      end
-      
-      if ENV['QB_STDIO_IN']
-        @qb_stdio_in = UNIXSocket.new ENV['QB_STDIO_IN']
-        
-        debug "Connected to QB stdin stream at #{ ENV['QB_STDIO_IN'] }."
-      end
-      
-      @@arg_types.each {|key, type|
-        var_name = "@#{ key.to_s }"
-        
-        unless instance_variable_get(var_name).nil?
-          raise ArgumentError.new NRSER.squish <<-END
-            an instance variable named #{ var_name } exists
-            with value #{ instance_variable_get(var_name).inspect }
-          END
-        end
-        
-        instance_variable_set var_name,
-                              type.check(@args.fetch(key.to_s))
-      }
-    end
-    
-    
-    
-    # Instance Methods
-    # =====================================================================
-    
-    # Logging
-    # ---------------------------------------------------------------------
-    # 
-    # Logging is a little weird in Ansible modules... Ansible has facilities
-    # for notifying the user about warnings and depreciations, which we will
-    # make accessible, but it doesn't seem to have facilities for notices and
-    # debugging, which I find very useful.
-    # 
-    # When run inside of QB (targeting localhost only at the moment, sadly)
-    # we expose additional IO channels for STDIN, STDOUT and STDERR through
-    # opening unix socket files that the main QB process spawns threads to 
-    # listen to, and we provide those file paths via environment variables
-    # so modules can pick those up and interact with those streams, allowing
-    # them to act like regular scripts inside Ansible-world (see 
-    # QB::Util::STDIO for details and implementation).
-    # 
-    # We use those channels if present to provide logging mechanisms.
-    # 
-    
-    # Forward args to {QB.debug} if we are connected to a QB STDERR stream
-    # (write to STDERR).
-    # 
-    # @param args see QB.debug
-    # 
-    def debug *args
-      if @qb_stdio_err
-        header = "<QB::AnsibleModule #{ self.class.name }>"
-        
-        if args[0].is_a? String
-          header += " " + args.shift
-        end
-        
-        QB.debug header, *args
-      end
-    end
-    
-    def info msg
-      if @qb_stdio_err
-        $stderr.puts msg
-      end
-    end
-    
-    # Append a warning message to @warnings.
-    def warn msg
-      @warnings << msg
-    end
-    
-    
-    def run
-      result = main
-      
-      case result
-      when nil
-        # pass
-      when Hash
-        @facts.merge! result
-      else
-        raise "result of #main should be nil or Hash, found #{ result.inspect }"
-      end
-      
-      done
-    end
-    
-    def changed! facts = {}
-      @changed = true
-      @facts.merge! facts
-      done
-    end
-    
-    def done
-      exit_json changed: @changed,
-                ansible_facts: self.class.stringify_keys(@facts),
-                warnings: @warnings
-    end
-    
-    def exit_json hash
-      # print JSON response to process' actual STDOUT (instead of $stdout,
-      # which may be pointing to the qb parent process)
-      STDOUT.print JSON.dump(self.class.stringify_keys(hash))
-      
-      [
-        [:stdin, @qb_stdio_in],
-        [:stdout, @qb_stdio_out],
-        [:stderr, @qb_stdio_err],
-      ].each do |name, socket|
-        if socket
-          debug "Flushing socket #{ name }."
-          socket.flush
-          debug "Closing #{ name } socket at #{ socket.path.to_s }."
-          socket.close
-        end
-      end
-      
-      exit 0
-    end
-    
-    def fail msg
-      exit_json failed: true, msg: msg, warnings: @warnings
-    end
-  end
+  AnsibleModule = QB::Ansible::Module
 end # QB

data/lib/qb/cli/play.rb

@@ -1,3 +1,9 @@
+# Requirements
+# =====================================================================
+
+# package
+require 'qb/ansible/cmds/playbook'
+
 
 module QB; end
 
@@ -18,13 +24,33 @@ module QB::CLI
       raise "Need path to playbook in first arg."
     end
     
-    path = QB::Util.resolve args[0]
+    playbook_path = QB::Util.resolve args[0]
     
-    unless path.file?
+    unless playbook_path.file?
       raise "Can't find Ansible playbook at #{ path.to_s }"
     end
     
+    # By default, we won't change directories to run the command.
+    chdir = nil
+    
+    # See if there is an Ansible config in the parent directories
+    ansible_cfg_path = QB::Util.find_up \
+      QB::Ansible::ConfigFile::FILE_NAME,
+      playbook_path.dirname,
+      raise_on_not_found: false
+    
+    # If we did find an Ansible config, we're going to want to run in that
+    # directory and add it to the role search path so that we merge it's 
+    # values into our env vars (otherwise they would override the config
+    # values).
+    unless ansible_cfg_path.nil?
+      QB::Role::PATH.unshift ansible_cfg_path.dirname
+      chdir = ansible_cfg_path.dirname
+    end
     
+    cmd = QB::Ansible::Cmds::Playbook.new \
+      playbook_path: playbook_path,
+      chdir: chdir
     
   end # .play
   

data/lib/qb/role.rb

@@ -204,7 +204,7 @@ module QB
     def self.search_path
       QB::Role::PATH.
         map { |path|
-          if QB::Ansible::ConfigFile.file_path?(path)
+          if QB::Ansible::ConfigFile.end_with_config_file?(path)
             if File.file?(path)
               QB::Ansible::ConfigFile.new(path).defaults.roles_path
             end

data/lib/qb/util.rb

@@ -95,13 +95,25 @@ module QB
     # @param [Pathname] from (Pathname.pwd)
     #   directory to start from.
     # 
+    # @param [Boolean] raise_on_not_found:
+    #   When `true`, a {QB::FSStateError} will be raised if no file is found
+    #   (default behavior).
+    #   
+    #   This is something of a legacy behavior - I think it would be better 
+    #   to have {find_up} return `nil` in that case and add a `find_up!`
+    #   method that raises on not found. But I'm not going to do it right now.
+    # 
     # @return [Pathname]
     #   Pathname of found file.
     # 
-    # @raise
-    #   if file is not found in `from` or any of it's parent directories.
+    # @return [nil]
+    #   If no file is found and the `raise_on_not_found` option is `false`.
+    # 
+    # @raise [QB::FSStateError]
+    #   If file is not found in `from` or any of it's parent directories
+    #   and the `raise_on_not_found` option is `true` (default behavior).
     # 
-    def self.find_up filename, from = Pathname.pwd
+    def self.find_up filename, from = Pathname.pwd, raise_on_not_found: true
       path = from + filename
       
       return from if path.exist?
@@ -109,10 +121,14 @@ module QB
       parent = from.parent
       
       if from == parent
-        raise "not found in current or any parent directories: #{ filename }"
+        if raise_on_not_found
+          raise "not found in current or any parent directories: #{ filename }"
+        else
+          return nil
+        end
       end
       
-      return find_up filename, parent
+      return find_up filename, parent, raise_on_not_found: raise_on_not_found
     end # .find_up
   end # Util
 end # QB