qb 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 44eeebb08ec94a24a8e0066ef1e0e053449c9914
-  data.tar.gz: a9be9d383e50ce60c49d1864382068d05781357c
+  metadata.gz: d0f1763e51cce156edf9e27cd1d09a3dce94e198
+  data.tar.gz: '0875a043b64932a4ae624da6014ac4658229b5b3'
 SHA512:
-  metadata.gz: 3846effe767fe00a5c886959052735b17a437b5efcbf8217ba7e9f03a43c55965ce7f960d1bce3602dbfe462eee6b22e6497e31322ef21a480a3456d376f08a5
-  data.tar.gz: 7d6eab2f1daa7937b2037e1262080b04579cd9d980541bb96a7fb094bb63149bd0e4b7116a2a1b7fa491d71e107803cbc42c989d27b710d1c68ffa0015e81c92
+  metadata.gz: 412955a91081d001642b31bb9f904ed48d2d27ff876b34525fe572276283ac23babd8f11604b4a1571ca4bc8668712e8846c83cd788f0c6696e49ccff348d31e
+  data.tar.gz: 3e07786f03ae3d13a9eefb3ae74bd070c22af29dd844d0b807bc2152b1d16f8559d70e1de4d84aa6ab0a1bc8af3532d5aac84a4e1814351b8cf439342670b42e

data/exe/qb

@@ -253,92 +253,16 @@ def main args
   
   QB.debug "playbook", playbook
   
-  playbook_path = Pathname.new(Dir.getwd) + '.qb-playbook.yml'
-  QB.debug playbook_path: playbook_path.to_s
+  env = QB::Ansible::Env.new
   
-  env = {
-    ANSIBLE_ROLES_PATH: [
-      # stick the role path in front to make sure we get **that** role
-      role.path.expand_path.dirname,
-      
-      # then include the full role search path
-      
-      # NOTE  this includes role paths pulled from a call-site local
-      #       ansible.cfg
-      QB::Role.search_path,
-    ].
-      flatten. # since QB::Role.search_path is an Array
-      select(&:directory?).
-      map(&:realpath). # so uniq works
-      uniq, # drop dups (seems to keep first instance so preserves priority)
-    
-    ANSIBLE_LIBRARY: [
-      QB::ROOT.join('library'),
-    ],
-    
-    ANSIBLE_FILTER_PLUGINS: [
-      QB::ROOT.join('plugins', 'filter_plugins'),
-    ],
-    
-    ANSIBLE_LOOKUP_PLUGINS: [
-      QB::ROOT.join('plugins', 'lookup_plugins'),
-    ],
-  }
-  
-  cmd_options = options.ansible.clone
+  # stick the role path in front to make sure we get **that** role
+  env.roles_path.unshift role.path.expand_path.dirname
   
-  if options.qb['inventory']
-    cmd_options['inventory-file'] = options.qb['inventory']
-    
-  elsif play['hosts'] != ['localhost']
-    cmd_options['inventory-file'] = play['hosts']
-    
-  end
-    
-  if options.qb['tags']
-    cmd_options['tags'] = options.qb['tags']
-  end
-  
-  cmd_template = <<-END    
-    ansible-playbook
-    
-    <%= cmd_options %>
-    
-    <% if verbose %>
-      -<%= 'v' * verbose %>
-    <% end %>
-    
-    <%= playbook_path %>
-  END
-  
-  cmd_options = {
-    env: env.map {|k, v| [k, v.is_a?(Array) ? v.join(':') : v]}.to_h,
-    
-    kwds: {
-      cmd_options: cmd_options,
-      
-      verbose: options.qb['verbose'],
-      
-      playbook_path: playbook_path.to_s,
-    },
-    
-    format: :pretty,
-  }
-  
-  # If ./ansible/ansible.cfg exists chdir into there for the run.
-  # 
-  # We already look for that dir and add the role paths to the role path 
-  # specified to `ansible-playbook`, but though there might be a way to make 
-  # `ansible-playbook` perform as desired while retaining the current directory
-  # (which would be preferable - I don't like switching directories on people)
-  # for the moment it seems like the easiest way to get it to properly use
-  # things like vars and relative paths in `./ansible/ansible.cfg` is to 
-  # change directories into `./ansible`, so that's what we're doing here:
-  if File.exists? './ansible/ansible.cfg'
-    cmd_options[:chdir] = './ansible'
-  end
-  
-  cmd = Cmds.new cmd_template, cmd_options
+  cmd = QB::Ansible::Cmds::Playbook.new \
+    env: env,
+    playbook: playbook,
+    role_options: options,
+    chdir: (File.exists?('./ansible/ansible.cfg') ? './ansible' : nil)
   
   # print
   # =====
@@ -351,8 +275,7 @@ def main args
   end
   
   if options.qb['print'].include? 'env'
-    dump = YAML.dump env.map {|k, v| [k.to_s, v.map {|i| i.to_s}]}.to_h
-    puts "ENV:\n\n#{ dump }\n\n"
+    puts "ENV:\n\n#{ YAML.dump cmd.env.to_h }\n\n"
   end
   
   if options.qb['print'].include? 'cmd'
@@ -372,10 +295,6 @@ def main args
   # stuff below here does stuff
   # 
   
-  playbook_path.open('w') do |f|
-    f.write YAML.dump(playbook)
-  end
-  
   # save the options back
   if (
     dir &&
@@ -418,7 +337,7 @@ def main args
     user_in_service.close!
     
     if status != 0
-      puts "ERROR ansible-playbook failed."
+      $stderr.puts "ERROR ansible-playbook failed."
     end
     
     exit status

data/lib/qb/ansible.rb

@@ -3,3 +3,5 @@ module QB; end
 module QB::Ansible; end
 
 require_relative './ansible/config_file'
+require_relative './ansible/env'
+require_relative './ansible/cmds/playbook'

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

@@ -0,0 +1,193 @@
+# Requirements
+# =====================================================================
+
+# stdlib
+require 'yaml'
+
+# deps
+require 'cmds'
+
+
+module QB; end
+module QB::Ansible; end
+module QB::Ansible::Cmds; end
+
+
+# @todo document QB::Ansible::Playbook class.
+class QB::Ansible::Cmds::Playbook < ::Cmds
+  DEFAULT_PLAYBOOK_PATH = '.qb-playbook.yml'
+  
+  # Default executable to use, just uses a bare `ansible-playbook`, letting
+  # shell path resolution do it's thing.
+  DEFAULT_EXE = 'ansible-playbook'
+  
+  TEMPLATE = <<-END    
+    <%= exe %>
+    
+    <%= cmd_options %>
+    
+    <% if verbose %>
+      -<%= 'v' * verbose %>
+    <% end %>
+    
+    <%= playbook_path %>
+  END
+  
+  # Constants
+  # ======================================================================
+  
+  
+  # Class Methods
+  # ======================================================================
+  
+  
+  # Attributes
+  # ======================================================================
+  
+  # Path to the playbook. If a `playbook:` keyword argument is provided to
+  # the constructor, then this is the path it will be written to before
+  # 
+  # @return [String, Pathname]
+  #     
+  attr_reader :playbook_path
+  
+  
+  # Whatever to use for the `ansible-playbook` executable.
+  # 
+  # @return [String]
+  #     
+  attr_reader :exe
+  
+  
+  # Optional playbook object to write and run.
+  # 
+  # @return [nil]
+  #   If we should expect to find the playbook already at {#playbook_path}.
+  # 
+  # @return [Hash]
+  #   If we will be writing a YAML dump of this object to {#playbook_path}
+  #   before runnning.
+  #     
+  attr_reader :playbook
+  
+  
+  # Optional role options if running a role.
+  # 
+  # @return [nil]
+  #   If we're not running a role.
+  # 
+  # @return [QB::Options]
+  #   If we are running a role.
+  #     
+  attr_reader :role_options
+  
+  
+  # Constructor
+  # ======================================================================
+  
+  # Instantiate a new `QB::Ansible::Playbook`.
+  def initialize  playbook_path: DEFAULT_PLAYBOOK_PATH,
+                  playbook: nil,
+                  role_options: nil,
+                  exe: DEFAULT_EXE,
+                  env: QB::Ansible::Env.new,
+                  format: :pretty,
+                  chdir: nil,
+                  **other_cmds_opts
+    @exe = exe.to_s
+    @role_options = role_options
+    @playbook = playbook
+    
+    # Resolve whatever path we got to an absolute.
+    @playbook_path = QB::Util.resolve playbook_path
+    
+    super TEMPLATE,
+          format: format,
+          chdir: chdir,
+          **other_cmds_opts
+    
+    # Overwrite `@env` because `super` freezes it.
+    @env = env
+  end # #initialize
+  
+  
+  # Instance Methods
+  # ======================================================================  
+  
+  # @return [Hash<String => Object>]
+  #   Hash of CLI options for `ansible-playbook` based off {#role_options}
+  #   and {#playbook}.
+  # 
+  def cmd_options
+    cmd_options = {}
+    
+    if role_options
+      # Merge in any Ansible options collected.
+      cmd_options.merge! role_options.ansible
+      
+      # Add tags if we have them
+      if role_options.qb['tags']
+        cmd_options['tags'] = role_options.qb['tags']
+      end
+    end
+    
+    # Add inventory file if we have it in QB options for the role.
+    if role_options && role_options.qb['inventory']
+      cmd_options['inventory-file'] = role_options.qb['inventory']
+    elsif playbook && playbook[0]['hosts'] != ['localhost']
+      # TODO  I'm not totally sure why this is here, but I copied it over from
+      #       `//exe/qb`...? Get overridden below anyways if
+      cmd_options['inventory-file'] = play['hosts']
+    end
+    
+    cmd_options
+  end # cmd_options
+  
+  
+  # Dynamically form the keywords from instance variables.
+  # 
+  # @return [Hash{Symbol => Object}]
+  # 
+  def kwds
+    {
+      exe: exe,
+      verbose: (role_options && role_options.qb['verbose']),
+      playbook_path: playbook_path.to_s,
+      cmd_options: cmd_options,
+    }
+  end # #kwds
+  
+  
+  # Override so we can call `#to_h` in case `env` is {QB::Ansible::Env}.
+  def env
+    @env.to_h
+  end
+  
+  
+  # Stuff to do before being run, like write {#playbook} to {#path} (unless
+  # {#playbook} is `nil`).
+  # 
+  # @return [nil]
+  # 
+  def before_spawn
+    # Write the playbook to the path first if one was provided.
+    unless playbook.nil?
+      playbook_path.open('w') { |f|
+        f.write YAML.dump(playbook)
+      }
+    end
+  end # #before_write
+  
+  
+  protected
+  # ========================================================================
+    
+    def spawn *args, **kwds, &input_block
+      before_spawn
+      super *args, **kwds, &input_block
+    end
+    
+  # end protected
+  
+end # class QB::Ansible::Playbook
+

data/lib/qb/ansible/config_file.rb

@@ -95,17 +95,22 @@ class QB::Ansible::ConfigFile < ParseConfig
   # =====================================================================
   
   
-  # @todo Document path? method.
+  # Test if a file path *looks* like it points to an Ansible config file -
+  # a file with {FILE_NAME} as the basename.
+  # 
+  # *Explicitly does not check if the file actually exists and is a file.*
+  # This is because we need this test to differentiate role search path 
+  # elements that are meant to point to Ansible config files from those that
+  # aren't in {QB::Role.search_path}.
   # 
   # @param [String, Pathname] file_path
   #   
-  # 
   # @return [Boolean]
-  #   `true` 
+  #   `true` if `path`'s basename is {FILE_NAME}.
   # 
-  def self.file_path? file_path
+  def self.end_with_config_file? file_path
     File.basename(file_path).to_s == FILE_NAME
-  end # .path?
+  end # .end_with_config_file?
   
   
   # Attributes

data/lib/qb/ansible/env.rb

@@ -3,7 +3,7 @@ module QB::Ansible; end
 
 
 # @todo document QB::Ansible::Env class.
-class QB::Ansible::Env < Hash
+class QB::Ansible::Env
   
   # Constants
   # ======================================================================
@@ -24,26 +24,86 @@ class QB::Ansible::Env < Hash
   #   @todo Document return value.
   # 
   def self.to_var_name name
-    "#{ VAR_NAME_PREFIX }_ #{ name.to_s.upcase }"
+    "#{ VAR_NAME_PREFIX }_#{ name.to_s.upcase }"
   end # .to_var_name
   
   
   
-  # Attributes
+  # Instance Attributes
   # ======================================================================
   
   
+  # @!attribute [r] roles_path
+  #   @return [Array<Pathname>]
+  attr_reader :roles_path
+  
+  
+  # @!attribute [r] library
+  #   @return [Array<Pathname>]
+  attr_reader :library
+  
+  
+  # @!attribute [r] filter_plugins
+  #   @return [Array<Pathname>]
+  attr_reader :filter_plugins
+  
+  
+  # @!attribute [r] lookup_plugins
+  #   @return [Array<Pathname>]
+  attr_reader :lookup_plugins
+  
+  
   # Constructor
   # ======================================================================
   
   # Instantiate a new `QB::Ansible::Env`.
   def initialize
+    # NOTE  this includes role paths pulled from a call-site local
+    #       ansible.cfg
+    @roles_path = QB::Role.search_path. # since QB::Role.search_path is an Array
+      select(&:directory?).
+      map(&:realpath). # so uniq works
+      uniq # drop dups (seems to keep first instance so preserves priority)
+    
+    @library = [
+      QB::ROOT.join('library'),
+    ]
     
+    @filter_plugins = [
+      QB::ROOT.join('plugins', 'filter_plugins'),
+    ]
+    
+    @lookup_plugins = [
+      QB::ROOT.join('plugins', 'lookup_plugins'),
+    ]
   end # #initialize
   
   
   # 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
+    [
+      :roles_path,
+      :library,
+      :filter_plugins,
+      :lookup_plugins
+    ].map { |name|
+      value = self.send(name)
+      
+      value = value.join(':') if value.is_a?(Array)
+      
+      [self.class.to_var_name(name), value]
+    }.to_h
+  end # #to_h
+  
   
 end # class QB::Ansible::Env