qb 0.3.4 → 0.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d0f1763e51cce156edf9e27cd1d09a3dce94e198
-  data.tar.gz: '0875a043b64932a4ae624da6014ac4658229b5b3'
+  metadata.gz: 3cc2ccebba574aaa719a3f5705ac941e114de2a2
+  data.tar.gz: 100bf8785c271ba8b63c1c2214680c9427cb25f7
 SHA512:
-  metadata.gz: 412955a91081d001642b31bb9f904ed48d2d27ff876b34525fe572276283ac23babd8f11604b4a1571ca4bc8668712e8846c83cd788f0c6696e49ccff348d31e
-  data.tar.gz: 3e07786f03ae3d13a9eefb3ae74bd070c22af29dd844d0b807bc2152b1d16f8559d70e1de4d84aa6ab0a1bc8af3532d5aac84a4e1814351b8cf439342670b42e
+  metadata.gz: 1d6c107058949f748322c628a0197929c63aba877810142463e9d59f955a91847985ba53a9cc4d1aece2e0f10fd860372ee15f999d6c36ed466bd352795a414d
+  data.tar.gz: 498ffac648a4c5e7bbe77710b58306f2d9a35744fe9bdfb27de65b819a1a17e4f6c65f7f13cf094a085a7ab9d692816639e18158adf562e93e1e1a7cd54898c6

data/ansible.cfg

@@ -1,5 +1,4 @@
 [defaults]
 
 roles_path = ./dev/scratch
-filter_plugins = ./roles/qb.gem/filter_plugins
 retry_files_enabled = False

data/exe/qb

@@ -13,17 +13,9 @@ require 'qb'
 require 'nrser/refinements'
 using NRSER
 
-require 'nrser/refinements/types'
-using NRSER::Types
-
-
-# constants
-# =========
 
 DEBUG_ARGS = ['-D', '--DEBUG']
 
-# globals
-# =======
 
 def set_debug! args
   if DEBUG_ARGS.any? {|arg| args.include? arg}
@@ -33,31 +25,6 @@ def set_debug! args
   end
 end
 
-def metadata
-  if QB.gemspec.metadata && !QB.gemspec.metadata.empty?
-    "metadata:\n" + QB.gemspec.metadata.map {|key, value|
-      "  #{ key }: #{ value }"
-    }.join("\n") + "\n"
-  end
-end
-
-def help
-  puts <<-END
-version: #{ QB::VERSION }
-#{ metadata }
-syntax:
-
-    qb ROLE [OPTIONS] DIRECTORY
-
-use `qb ROLE -h` for role options.
-  
-available roles:
-
-END
-  puts QB::Role.available
-  puts
-  exit 1
-end
 
 def main args
   set_debug! args
@@ -65,283 +32,32 @@ def main args
   
   QB.check_ansible_version
   
-  role_arg = args.shift
-  QB.debug "role arg" => role_arg
-  
-  help if role_arg.nil? || ['-h', '--help', 'help'].include?(role_arg)
-  
-  return QB::CLI.play(args) if role_arg == 'play'
-  
-  begin
-    role = QB::Role.require role_arg
-  rescue QB::Role::NoMatchesError => e
-    puts "ERROR - #{ e.message }\n\n"
-    # exits with status code 1
-    help
-  rescue QB::Role::MultipleMatchesError => e
-    puts "ERROR - #{ e.message }\n\n"
-    exit 1
-  end
-  
-  QB.check_qb_version role
-  
-  options = QB::Options.new role, args
-  
-  QB.debug "role options set on cli", options.role_options.select {|k, o|
-    !o.value.nil?
-  }
-  
-  QB.debug "qb options", options.qb
-  
-  cwd = Dir.getwd
-  
-  dir = nil
-  
-  unless role.meta['default_dir'] == false
-    # get the target dir
-    dir = case args.length
-    when 0
-      # in this case, a dir has not been provided
-      # 
-      # in some cases (like projects) the dir can be figured out in other ways:
-      # 
-      
-      if options.ask?
-        default = begin
-          role.default_dir cwd, options.role_options
-        rescue QB::UserInputError => e
-          NRSER::NO_ARG
-        end
-        
-        QB::CLI.ask name: "target directory (`qb_dir`)",
-                    type: t.non_empty_str,
-                    default: default
-        
-      else
-        role.default_dir cwd, options.role_options
-      end
-      
-    when 1
-      # there is a single positional arg, which is used as dir
-      args[0]
-      
-    else
-      # there are multiple positional args, which is not allowed
-      raise "can't supply more than one argument: #{ args.inspect }"
-      
-    end
-    
-    QB.debug "input_dir", dir
-    
-    # normalize to expanded path (has no trailing slash)
-    dir = File.expand_path dir
-    
-    QB.debug "normalized_dir", dir
-    
-    # create the dir if it doesn't exist (so don't have to cover this in
-    # every role)
-    if role.mkdir
-      FileUtils.mkdir_p dir unless File.exists? dir
+  QB.debug "Switch arg", args[0]
+  
+  status = case args[0]
+  when nil, '-h', '--help', 'help'
+    QB::CLI.help
+  when 'play'
+    QB::CLI.play args.rest
+  when 'run'
+    QB::CLI.run args.rest
+  when 'setup'
+    state_args = args.rest
+    
+    case state_args[0]
+    when nil
+      QB::CLI.setup
     end
-  
-    saved_options_path = Pathname.new(dir) + '.qb-options.yml'
-    
-    saved_options = if saved_options_path.exist?
-      # convert old _ separated names to - separated
-      YAML.load(saved_options_path.read).map {|role_options_key, role_options|
-        [
-          role_options_key,
-          role_options.map {|name, value|
-            [QB::Options.cli_ize_name(name), value]
-          }.to_h
-        ]
-      }.to_h.tap {|saved_options|
-        QB.debug "found saved options", saved_options
-      }
-    else
-      QB.debug "no saved options"
-      {}
-    end
-    
-    if saved_options.key? role.options_key
-      role_saved_options = saved_options[role.options_key]
-      
-      QB.debug "found saved options for role", role_saved_options
-      
-      role_saved_options.each do |option_cli_name, value|
-        option = options.role_options[option_cli_name]
-        
-        if option.value.nil?
-          QB.debug "setting from saved options", option: option, value: value
-          
-          option.value = value
-        end
-      end
-    end
-  end # unless default_dir == false
-  
-  
-  # Interactive Input
-  # =====================================================================
-  
-  if options.ask?
-    # Incomplete
-    raise "COMING SOON!!!...?"
-    QB::CLI.ask_for_options role: role, options: options
-  end
-  
-  
-  # Validation
-  # =====================================================================
-  # 
-  # Should have already been taken care of if we used interactive input.
-  # 
-  
-  # check that required options are present
-  missing = options.role_options.values.select {|option|
-    option.required? && option.value.nil?
-  }
-  
-  unless missing.empty?
-    puts "ERROR: options #{ missing.map {|o| o.cli_name } } are required."
-    exit 1
+  else
+    # default to `run` on the full args
+    QB::CLI.run args
   end
   
-  set_options = options.role_options.select {|k, o| !o.value.nil?}
+  QB.debug "Exit status", status
   
-  QB.debug "set options", set_options
-  
-  playbook_role = {'role' => role.name}
-  
-  playbook_vars = {
-    'qb_dir' => dir,
-    # depreciated due to mass potential for conflict
-    'dir' => dir,
-    'qb_cwd' => cwd,
-    'qb_user_roles_dir' => QB::USER_ROLES_DIR.to_s,
-  }
-  
-  set_options.values.each do |option|
-    playbook_role[option.var_name] = option.value
-  end
-  
-  play =
-  {
-    'hosts' => options.qb['hosts'],
-    'vars' => playbook_vars,
-    # 'gather_subset' => ['!all'],
-    'gather_facts' => options.qb['facts'],
-    'pre_tasks' => [
-      {
-        'qb_facts' => {
-          'qb_dir' => dir,
-        }
-      },
-    ],
-    'roles' => [
-      'nrser.blockinfile',
-      playbook_role
-    ],
-  }
-  
-  if options.qb['user']
-    play['become'] = true
-    play['become_user'] = options.qb['user']
-  end
-  
-  playbook = [play]
-  
-  QB.debug "playbook", playbook
-  
-  env = QB::Ansible::Env.new
-  
-  # stick the role path in front to make sure we get **that** role
-  env.roles_path.unshift role.path.expand_path.dirname
-  
-  cmd = QB::Ansible::Cmds::Playbook.new \
-    env: env,
-    playbook: playbook,
-    role_options: options,
-    chdir: (File.exists?('./ansible/ansible.cfg') ? './ansible' : nil)
-  
-  # print
-  # =====
-  # 
-  # print useful stuff for debugging / running outside of qb
-  # 
-  
-  if options.qb['print'].include? 'options'
-    puts "SET OPTIONS:\n\n#{ YAML.dump set_options }\n\n"
-  end
-  
-  if options.qb['print'].include? 'env'
-    puts "ENV:\n\n#{ YAML.dump cmd.env.to_h }\n\n"
-  end
-  
-  if options.qb['print'].include? 'cmd'
-    puts "COMMAND:\n\n#{ cmd.prepare }\n\n"
-  end
-  
-  if options.qb['print'].include? 'playbook'
-    puts "PLAYBOOK:\n\n#{ YAML.dump playbook }\n\n"
-  end
-  
-  # stop here if we're not supposed to run
-  exit 0 if !options.qb['run']
-  
-  # run
-  # ===
-  # 
-  # stuff below here does stuff
-  # 
-  
-  # save the options back
-  if (
-    dir &&
-    # we set some options that we can save
-    set_options.values.select {|o| o.save? }.length > 0 &&
-    # the role says to save options
-    role.save_options
-  )
-    saved_options[role.options_key] = set_options.select{|key, option|
-      option.save?
-    }.map {|key, option|
-      [key, option.value]
-    }.to_h
-    
-    unless saved_options_path.dirname.exist?
-      FileUtils.mkdir_p saved_options_path.dirname
-    end
-    
-    saved_options_path.open('w') do |f|
-      f.write YAML.dump(saved_options)
-    end
-  end
-  
-  QB::Util::Bundler.with_clean_env do
-    # boot up stdio out services so that ansible modules can stream to our
-    # stdout and stderr to print stuff (including debug lines) in real-time
-    stdio_out_services = {'out' => $stdout, 'err' => $stderr}.
-      map {|name, dest|
-        QB::Util::STDIO::OutService.new(name, dest).tap { |s| s.open! }
-      }
-    
-    # and an in service so that modules can prompt for user input
-    user_in_service = QB::Util::STDIO::InService.new('in', $stdin).
-      tap { |s| s.open! }
-    
-    status = cmd.stream
-    
-    # close the stdio services
-    stdio_out_services.each {|s| s.close! }
-    user_in_service.close!
-    
-    if status != 0
-      $stderr.puts "ERROR ansible-playbook failed."
-    end
-    
-    exit status
-  end
+  # exit status
+  exit status
 end
 
+
 main(ARGV) # if __FILE__ == $0 # doesn't work with gem stub or something?

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

@@ -7,13 +7,18 @@ require 'yaml'
 # deps
 require 'cmds'
 
+# package
+require 'qb/util/bundler'
+require 'qb/util/stdio'
+
 
 module QB; end
 module QB::Ansible; end
 module QB::Ansible::Cmds; end
 
 
-# @todo document QB::Ansible::Playbook class.
+# A command object that runs a playbook with all the QB specialness.
+# 
 class QB::Ansible::Cmds::Playbook < ::Cmds
   DEFAULT_PLAYBOOK_PATH = '.qb-playbook.yml'
   
@@ -82,19 +87,36 @@ class QB::Ansible::Cmds::Playbook < ::Cmds
   attr_reader :role_options
   
   
+  # Hash of extra variables that will be JSON encoded and passed to
+  # `ansible-playbook` via the `--extra-vars` CLI option.
+  # 
+  # @return [Hash]
+  #     
+  attr_reader :extra_vars
+  
+  
   # Constructor
   # ======================================================================
   
   # Instantiate a new `QB::Ansible::Playbook`.
-  def initialize  playbook_path: DEFAULT_PLAYBOOK_PATH,
-                  playbook: nil,
-                  role_options: nil,
-                  exe: DEFAULT_EXE,
+  # 
+  # @param [Hash] extra_vars:
+  #   Extra variables that will be JSON encoded and passed to
+  #   `ansible-playbook` via the `--extra-vars` option.
+  #   
+  #   Available as the {#extra_vars} attribute.
+  # 
+  def initialize  chdir: nil,
                   env: QB::Ansible::Env.new,
+                  exe: DEFAULT_EXE,
+                  extra_vars: {},
                   format: :pretty,
-                  chdir: nil,
+                  playbook: nil,
+                  playbook_path: DEFAULT_PLAYBOOK_PATH,
+                  role_options: nil,
                   **other_cmds_opts
     @exe = exe.to_s
+    @extra_vars = extra_vars
     @role_options = role_options
     @playbook = playbook
     
@@ -140,6 +162,11 @@ class QB::Ansible::Cmds::Playbook < ::Cmds
       cmd_options['inventory-file'] = play['hosts']
     end
     
+    # Add extra vars if we have any.
+    unless @extra_vars.empty?
+      cmd_options['extra-vars'] = JSON.dump @extra_vars
+    end
+    
     cmd_options
   end # cmd_options
   
@@ -182,10 +209,34 @@ class QB::Ansible::Cmds::Playbook < ::Cmds
   protected
   # ========================================================================
     
+    # @return [Fixnum]
+    #   
     def spawn *args, **kwds, &input_block
       before_spawn
-      super *args, **kwds, &input_block
-    end
+      
+      QB::Util::Bundler.with_clean_env do
+        # boot up stdio out services so that ansible modules can stream to our
+        # stdout and stderr to print stuff (including debug lines) in real-time
+        stdio_out_services = {'out' => $stdout, 'err' => $stderr}.
+          map {|name, dest|
+            QB::Util::STDIO::OutService.new(name, dest).tap { |s| s.open! }
+          }
+        
+        # and an in service so that modules can prompt for user input
+        user_in_service = QB::Util::STDIO::InService.new('in', $stdin).
+          tap { |s| s.open! }
+        
+        status = super *args, **kwds, &input_block
+        
+        # close the stdio services
+        stdio_out_services.each {|s| s.close! }
+        user_in_service.close!
+        
+        # and return the status
+        status
+      end
+      
+    end # #spawn
     
   # end protected