qb 0.3.8 → 0.3.9

data/lib/qb/util/stdio.rb

@@ -68,6 +68,8 @@ module QB::Util::STDIO
   # their output to it, which is in turn printed to the console `qb` is running
   # in.
   class Service
+    include SemanticLogger::Loggable
+    
     def initialize name
       @name = name
       @thread = nil
@@ -81,15 +83,25 @@ module QB::Util::STDIO
       
       @path = SOCKET_DIR.join "#{ name }.#{ SecureRandom.uuid }.sock"
       
-      @debug_header = "#{ name }@#{ @path.to_s }"
+      self.logger = SemanticLogger[
+        [
+          "#{ self.class.name } {",
+          "  name: #{ name }",
+          "  path: #{ @path.to_s }",
+          "}"
+        ].join( "\n" )
+      ]
+      
+      logger.trace "Initialized"
     end
     
     def debug *args
-      QB.debug "#{ @debug_header }", *args
+      # logger.debug "#{ @debug_header }", args
+      logger.debug *args
     end
     
     def open!
-      debug "opening..."
+      logger.trace "opening..."
       
       # make sure env var is not already set (basically just prevents you from
       # accidentally opening two instances with the same name)
@@ -100,7 +112,8 @@ module QB::Util::STDIO
       end
       
       @thread = Thread.new do
-        debug "thread started."
+        Thread.current.name = @name
+        logger.trace "thread started."
         
         @server = UNIXServer.new @path.to_s
         
@@ -113,9 +126,9 @@ module QB::Util::STDIO
       
       # set the env key so children can find the socket path
       ENV[@env_key] = @path.to_s
-      debug "set env var #{ @env_key }=#{ ENV[@env_key] }"
+      logger.trace "set env var", @env_key => ENV[@env_key]
       
-      debug "service open."
+      logger.trace "service open."
     end # open
     
     def close!
@@ -123,7 +136,7 @@ module QB::Util::STDIO
       # 
       # TODO not sure how correct this is...
       # 
-      debug "closing..."
+      logger.trace "closing..."
       
       @socket.close unless @socket.nil?
       @socket = nil
@@ -132,7 +145,7 @@ module QB::Util::STDIO
       FileUtils.rm(@path) if @path.exist?
       @thread.kill unless @thread.nil?
       
-      debug "closed."
+      logger.trace "closed."
     end
   end # Service
   
@@ -146,7 +159,10 @@ module QB::Util::STDIO
     
     def work_in_thread
       while (line = @socket.gets) do
-        debug "#{ @name } received: #{ line.inspect }"
+        logger.trace "received line",
+          line: line,
+          dest: @dest
+        
         @dest.puts line
       end
     end

data/lib/qb/version.rb

@@ -4,7 +4,7 @@ module QB
   
   GEM_NAME = 'qb'
   
-  VERSION = "0.3.8"
+  VERSION = "0.3.9"
   
   MIN_ANSIBLE_VERSION = Gem::Version.new '2.1.2'
   
@@ -27,12 +27,11 @@ module QB
   end
   
   
-  # Check that the Ansible version is not less than {QB::MIN_ANSIBLE_VERSION}.
-  # 
-  # @raise [QB::AnsibleVersionError]
-  #   If the version of Ansible found is less than {QB::MIN_ANSIBLE_VERSION}.
+  # @return [Gem::Version]
+  #   the Ansible executable version parsed into a Gem version so we can
+  #   compare it.
   # 
-  def self.check_ansible_version
+  def self.ansible_version
     out = Cmds.out! 'ansible --version'
     version_str = out[/ansible\ ([\d\.]+)/, 1]
     
@@ -44,36 +43,25 @@ module QB
       END
     end
     
-    version = Gem::Version.new version_str
-    
-    if version < QB::MIN_ANSIBLE_VERSION
-      raise QB::AnsibleVersionError, NRSER.squish(
-        <<-END
-          QB #{ QB::VERSION } requires Ansible #{ QB::MIN_ANSIBLE_VERSION },
-          found version #{ version_str } at #{ `which ansible` }
-        END
-      )
-    end
-  end # .check_ansible_version
+    Gem::Version.new version_str
+  end # .ansible_version
   
   
-  # If `role` has a {QB::Role#qb_requirement} raise an error if this version of
-  # QB doesn't satisfy it.
+  # Check that the Ansible version is not less than {QB::MIN_ANSIBLE_VERSION}.
   # 
-  # @raise [QB::QBVersionError]
-  #   If this version of QB doesn't satisfy the role's requirements.
+  # @raise [QB::AnsibleVersionError]
+  #   If the version of Ansible found is less than {QB::MIN_ANSIBLE_VERSION}.
   # 
-  def self.check_qb_version role
-    unless  role.qb_requirement.nil? ||
-            role.qb_requirement.satisfied_by?(QB.gem_version)    
-      raise QB::QBVersionError, NRSER.squish(
+  def self.check_ansible_version
+    if ansible_version < QB::MIN_ANSIBLE_VERSION
+      raise QB::AnsibleVersionError, NRSER.squish(
         <<-END
-          Role #{ role } requires QB #{ role.qb_requirement }, using QB
-          #{ QB.gem_version } from #{ QB::ROOT }.
+          QB #{ QB::VERSION } requires Ansible #{ QB::MIN_ANSIBLE_VERSION },
+          found version #{ version_str } at #{ `which ansible` }
         END
       )
     end
-  end # .check_qb_version
+  end # .check_ansible_version
   
   
 end # module QB

data/library/stream

@@ -30,13 +30,13 @@ class Stream < QB::Ansible::Module
     }
     
     [:format, :env_mode].each { |key|
-      opts[key] = @args[key].to_sym if @args.key?(key.to_s)
+      opts[key] = @args[key.to_s].to_sym if @args.key?(key.to_s)
     }
     
     cmd = Cmds.new(template, **opts)
     
     if @args['log']
-      info "STREAMING #{ cmd.prepare.inspect }"
+      info "STREAMING\n\n#{ cmd.prepare }\n\n"
     end
     
     cmd.stream!

data/plugins/filter_plugins/ruby_interop_plugins.py

@@ -5,46 +5,37 @@ from ansible.errors import AnsibleError
 
 import subprocess
 import yaml
+import os
 from ansible.parsing.yaml.dumper import AnsibleDumper
 
-def qb_send(data, method, *args, **kwds):
+
+QB_ROOT = os.path.realpath(
+    os.path.join(
+        os.path.dirname(os.path.realpath(__file__)), # /plugins/filter_plugins
+        '..', # /plugins
+        '..', # /
+    )
+)
+
+INTEROP_RECEIVE_EXE = os.path.join( QB_ROOT, 'exe', '.qb_interop_receive' )
+
+
+def send_to_interop( payload ):
     '''
-    Load data as an object in ruby and send it a message (call a method).
+    Send a payload to QB Ruby code via a subprocess.
     '''
     
-    payload = {
-        'data': data,
-        'method': method,
-        'args': args,
-        'kwds': kwds,
-    }
-    
-    input = yaml.dump(payload, Dumper=AnsibleDumper)
-    
-    ruby_code = '''
-        # init bundler in dev env
-        if ENV['QB_DEV_ENV']
-            ENV.each {|k, v|
-                if k.start_with? 'QB_DEV_ENV_'
-                    ENV[k.sub('QB_DEV_ENV_', '')] = v
-                end
-            }
-            require 'bundler/setup'
-        end
-        
-        require 'qb'
-        
-        QB::Util::Interop.receive
-    '''
+    input = yaml.dump( payload, Dumper=AnsibleDumper )
     
     process = subprocess.Popen(
-        ['/usr/bin/env', 'ruby', '-e', ruby_code],
+        [ INTEROP_RECEIVE_EXE ],
         stdin=subprocess.PIPE,
         stdout=subprocess.PIPE,
         stderr=subprocess.PIPE,
+        env=os.environ,
     )
     
-    out, err = process.communicate(input)
+    out, err = process.communicate( input )
     
     if process.returncode != 0:
         raise AnsibleError('''
@@ -64,16 +55,43 @@ def qb_send(data, method, *args, **kwds):
         ''' % out)
     
     return result
+
+
+def qb_send( data, method, *args, **kwds ):
+    '''
+    Load data as an object in ruby and send it a message (call a method).
+    '''
     
+    return send_to_interop({
+        'data': data,
+        'method': method,
+        'args': args,
+        'kwds': kwds,
+    })
+
+
+def qb_send_const( name, method, *args, **kwds ):
+    '''
+    Send a message (call a method) to a Ruby constant by name.
+    '''
+    
+    return send_to_interop({
+        'const': name,
+        'method': method,
+        'args': args,
+        'kwds': kwds,
+    })
+
 
-class FilterModule(object):
+class FilterModule( object ):
     '''
     Ruby interop filters.
     '''
 
-    def filters(self):
+    def filters( self ):
         return {
-            'qb_send': qb_send,
+            'qb_send':          qb_send,
+            'qb_send_const':    qb_send_const,
         }
     # filters()
 # FilterModule

data/qb.gemspec

@@ -85,20 +85,32 @@ Gem::Specification.new do |spec|
   end
   
   spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  
+  # All files in //exe that *do not* start with `.`:
+  spec.executables   = spec.files.grep(%r{^exe/[^\.]}) { |f| File.basename(f) }
+  
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "~> 3.7.0"
   spec.add_development_dependency "yard"
   spec.add_development_dependency "pry"
   
-  spec.add_dependency "cmds",'~> 0.0', ">= 0.2.2"
-  spec.add_dependency "nrser",'~> 0.0', ">= 0.0.25"
+  spec.add_dependency "cmds", '~> 0.0', ">= 0.2.2"
+  spec.add_dependency "nrser", '~> 0.0', ">= 0.0.28"
   spec.add_dependency "nrser-extras", '~> 0.0', ">= 0.0.3"
   spec.add_dependency "state_mate", '~> 0.0', ">= 0.0.9"
   spec.add_dependency 'parseconfig', '~> 1.0', '>= 1.0.8'
+  spec.add_dependency "octokit", "~> 4.0"
+  
+  # Much better logging
+  spec.add_dependency 'semantic_logger', '~> 4.2'
+  # With much more awesome printing!
+  spec.add_dependency 'awesome_print', '~> 1.8'
+  
+  # Ruby lib wrapping `git` binary system calls for use in {QB::Repo::Git}
+  spec.add_dependency 'git', '~> 1.3.0'
   
   
   if QB::VERSION.end_with? '.dev'

data/roles/qb.role/defaults/main.yml

@@ -2,8 +2,12 @@
 role_dest: "{{ qb_dir }}"
 role_force: false
 
-# can't be named `role_name` 'cause Ansible sets that?
-role_role_name: "{{ role_dest | basename }}"
+# NOTE can't be named `role_name` 'cause Ansible sets that?
+# 
+# Call `QB::Role.default_role_name role_dest` to get the default name
+# 
+role_role_name: >-
+  {{ 'QB::Role' | qb_send_const( 'default_role_name', role_dest ) }}
 
 role_defaults: true
 role_files: false

data/roles/{qb.bump → qb/pkg/bump}/tasks/main.yml

@@ -1,5 +1,5 @@
 ---
-# tasks file for bump
+# tasks file for qb/pkg/bump
 
 # set up variables...
 

data/roles/qb/test/rspec/spec/issue/defaults/main.yml

@@ -0,0 +1,2 @@
+---
+# defaults file for qb/test/rspec/spec/issue

data/roles/qb/test/rspec/spec/issue/meta/main.yml

@@ -0,0 +1,8 @@
+---
+# meta file for qb/test/rspec/spec/issue
+
+allow_duplicates: yes
+
+dependencies: []
+# - role: role-name
+

data/roles/qb/test/rspec/spec/issue/meta/qb.yml

@@ -0,0 +1,67 @@
+---
+# meta/qb.yml file for qb/test/rspec/spec/issue
+# 
+# qb settings for this role. see README.md for more info.
+#
+
+# description of the role to show in it's help output.
+description: null
+
+# Gemspec-style requirements. Right now only `gems:qb` is used, but plan to
+# generalize in the future.
+requirements:
+  gems:
+    qb: ~> 0.3.0
+
+# prefix for role variables
+var_prefix: null
+
+# how to get a default for `dir` if it's not provided as the only
+# positional argument. if a positional argument is provided it will
+# override the method defined here.
+# 
+# options:
+# 
+# -   null
+#     -   require the value on the command line.
+# -   false
+#     -   don't provide qb_dir (means doesn't load or save options either).
+# -   git_root
+#     -   use the git root of the directory that the `qb` command is invoked
+#         from. useful for 'project-centric' commands so they can be invoked
+#         from anywhere in the repo.
+# -   cwd
+#     -   use the directory the `qb` command is invoked form.
+# -   {exe: PATH}
+#     -   invoke an executable, passing a JSON serialization of the options 
+#         mapping their CLI names to values. path can be relative to role
+#         directory.
+# -   {find_up: FILENAME}
+#     -   starting at the current directory and climbing up to parent 
+#         directories, use the first one that contains FILENAME. error
+#         if none is found.
+default_dir: null
+
+# If `true`, QB will ensure the default dir exists before starting the play.
+# 
+# For legacy reasons, this defaults to `true` if not present, but we want to 
+# default declare it as `false` here so new roles can turn it on only if 
+# they need it.
+# 
+mkdir: false
+
+# default user to become for play
+default_user: null
+
+# set to false to not save options in .qb-options.yml files
+save_options: true
+
+# options to pass to ansible-playbook
+ansible_options: {}
+
+options: []
+# - name: example
+#   description: an example of a variable.
+#   required: false
+#   type: boolean # boolean (default) | string
+#   short: e