qb 0.3.23 → 0.3.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b3a5dfc104a28f159f72ffcfedf5932e2912448
-  data.tar.gz: b68ee826b4d98678abc8adffbe5e54395f0109f3
+  metadata.gz: aca30bc6181a0452746aeb8fa262a1fe8e5b0537
+  data.tar.gz: 6a94b47657b966b02c9b0de3dbb6acbfe4a33c65
 SHA512:
-  metadata.gz: bcf7a62d2b0d4d0089c46e768e0660137a040593ec58b96a1bce6849be7e2d0680595d6f349cfc985efbc6d862dcf5ab11379851e83c7c0dad45836c95d5bd80
-  data.tar.gz: '0797e7ae29fb71602935b9959cf3df432ab0ed7f5098734e3dbf29c38f691a217015f9b0e49c1f69e6bd09366a73aafc515d33e809c3f1df1c1b6d1cb2ea6649'
+  metadata.gz: 80c25333f1c2c26f865bf7ef6879b5dfbd10f203ca1f4df1f37c08a8f5fb26627581e4bb408e94d1e1b99f5b7168f5f73e53cfbba8295fae1b6be9ed6da167f3
+  data.tar.gz: ff848dc6e1f90c134d518f810f30dab66526c811890692fdc84941c88a3248cae042c6fdfe582732fa26318021c32d3e112d94bf4f411eafc0030052133ebe0b

data/README.md

@@ -1,6 +1,12 @@
 QB
 ==============================================================================
 
+[![Gem Version](http://img.shields.io/gem/v/qb.svg)][gem]
+[![Build Status](http://img.shields.io/travis/nrser/qb.svg)][travis]
+
+[gem]: https://rubygems.org/gems/qb
+[travis]: http://travis-ci.org/nrser/qb
+
 QB is all about projects. Named after everyone's favorite projects.
 
 QB works by running [Ansible][] plays. So you can think about it as "quarterback" if you happen to be from the corner of the world where that makes any sense.
@@ -30,14 +36,16 @@ and opening
 Quickies
 ------------------------------------------------------------------------------
 
-1.  Status: **UNSTABLE**
+1.  Status: **UNSTABLE (BUT GETTING BETTER)**
     
     A bit past experimental, but still actively exploring API and features. Any and every thing subject to breaking changes until we hit `1.0`. Generally trying to bump the minor version with larger changes, but not paying a huge amount of attention to it. Being used personally and in projects and organizations I work with.
 
-2.  Compatibility: **OSX/macOS-only**
+2.  Compatibility: **Unix-based, specifically OSX**
+    
+    Developed and used on OSX/macOS, though [Travis tests][travis] tests pass on Linux as well (currently Ubuntu Trusty 14.04, see [Travis Build Env][]).
+    
+    I don't know of any fundamental reason it wouldn't work on other \*nixes, but you will probably have to figure it out yourself.
     
-    Though it would probably run fine on Linux, if not other \*nix as well.
-
 3.  Installation
     
     Head over to {file:doc/getting_started.md Getting Started}.
@@ -49,6 +57,8 @@ Quickies
 
 <!-- References & Further Reading: -->
 
+[Travis Build Env]: https://docs.travis-ci.com/user/reference/overview/#Container-based
+
 [Homebrew]: https://brew.sh/
 
 [Ansible Installation]: http://docs.ansible.com/ansible/latest/intro_installation.html

data/VERSION

@@ -1 +1 @@
-0.3.23
+0.3.24

data/exe/qb

@@ -35,11 +35,13 @@ using NRSER
 # Definitions
 # =======================================================================
 
-def main args
+def main *args
   Thread.current.name = 'main'
   logger = SemanticLogger['qb/exe/qb#main']
   
   QB::CLI.set_debug! args
+  QB::Util::Logging.setup sync: true, dest: $stderr
+  
   logger.debug args: args
   
   QB.check_ansible_version
@@ -79,4 +81,4 @@ end
 # Execution
 # ============================================================================
 
-main(ARGV) # if __FILE__ == $0 # doesn't work with gem stub or something?
+main( *ARGV ) # if __FILE__ == $0 # doesn't work with gem stub or something?

data/lib/qb.rb

@@ -11,6 +11,7 @@ require 'nrser'
 # Project / Package
 # -----------------------------------------------------------------------
 require 'qb/errors'
+require 'qb/python'
 require 'qb/version'
 require 'qb/util'
 require 'qb/path'

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

@@ -206,6 +206,16 @@ class QB::Ansible::Cmds::Playbook < ::Cmds
   end # #before_write
   
   
+  # HACK  To fix test fails on linux... seems you can't end a command there
+  #       with a `\`
+  # 
+  # @todo Move up to Cmds
+  # 
+  def prepare *args, &block
+    prepared = super *args, &block
+    prepared.gsub /[\s\n\\]+\z/, ''
+  end
+  
   protected
   # ========================================================================
     

data/lib/qb/cli.rb

@@ -63,7 +63,7 @@ module QB::CLI
   
   def self.set_debug! args
     if DEBUG_ARGS.any? {|arg| args.include? arg}
-      QB::Util::Logging.setup level: :debug
+      ENV['QB_DEBUG'] = 'true'
       DEBUG_ARGS.each {|arg| args.delete arg}
     end
   end

data/lib/qb/cli/run.rb

@@ -220,7 +220,7 @@ module QB::CLI
       
       env = QB::Ansible::Env::Devel.new
       exe = [
-        "python2",
+        QB::Python.bin,
         (QB::Ansible::Env::Devel::ANSIBLE_HOME / 'bin' / 'ansible-playbook')
       ].join " "
       
@@ -304,6 +304,10 @@ module QB::CLI
       end
     end
     
+    logger.debug "Command prepared, running...",
+      command: cmd,
+      prepared: cmd.prepare
+    
     status = cmd.stream
     
     if status != 0

data/lib/qb/python.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+
+# Definitions
+# =======================================================================
+
+module QB::Python
+  
+  # Switch python bin depending on local dev / Travis CI env
+  # 
+  # @todo
+  #   Probably want more robust way of finding the Python we want and figuring
+  #   out we're in Travis.
+  # 
+  # @return [String]
+  # 
+  def self.bin
+    # if File.exists? '/home/travis'
+    #   'python'
+    # else
+    #   'python2'
+    # end
+    'python'
+  end
+  
+end # module QB::Python

data/lib/qb/util/logging.rb

@@ -3,6 +3,7 @@
 
 # Stdlib
 # -----------------------------------------------------------------------
+require 'forwardable'
 
 # Deps
 # -----------------------------------------------------------------------
@@ -16,11 +17,13 @@ require 'semantic_logger'
 # Refinements
 # =======================================================================
 
+using NRSER
+using NRSER::Types
+
 
 # Declarations
 # =======================================================================
 
-module QB; end
 module QB::Util; end
 
 
@@ -64,6 +67,7 @@ module QB::Util::Logging
         super ap: { multiline: true },
               color_map: SemanticLogger::Formatters::Color::ColorMap.new(
                 debug: SemanticLogger::AnsiColors::MAGENTA,
+                trace: "\e[1;30m", # "Dark Gray"
               ),
               **options
       end # #initialize
@@ -82,10 +86,10 @@ module QB::Util::Logging
       end
       
       
-      # Create the log entry text. Overridden to customize appearance - 
+      # Create the log entry text. Overridden to customize appearance -
       # generally reduce amount of info and put payload on it's own line.
       # 
-      # We need to replace *two* super functions, the first being 
+      # We need to replace *two* super functions, the first being
       # [SemanticLogger::Formatters::Color#call][]:
       # 
       #     def call(log, logger)
@@ -122,8 +126,8 @@ module QB::Util::Logging
       #   
       #   See [SemanticLogger::Logger](https://github.com/rocketjob/semantic_logger/blob/v4.2.0/lib/semantic_logger/logger.rb)
       # 
-      # @return [return_type]
-      #   @todo Document return value.
+      # @return [String]
+      #   The full log string.
       # 
       def call log, logger
         # SemanticLogger::Formatters::Color code
@@ -133,22 +137,18 @@ module QB::Util::Logging
         self.log    = log
         self.logger = logger
         
+        is_info = log.level == :info
+        
         [
-          # time, annoyingly noisy and don't really need for local CLI app
           level,
-          process_info,
           tags,
           named_tags,
           duration,
-          name,
-        ].compact.join( ' ' ) + 
-        "\n" +
-        [
+          (is_info ? nil : name),
           message,
           payload,
           exception,
-        ].compact.join(' ') + 
-        "\n" # I like extra newline to space shit out
+        ].compact.join(' ')
         
       end # #call
       
@@ -158,9 +158,139 @@ module QB::Util::Logging
   end # module Formatters
   
   
+  module Appender
+    # Replacement for {SemanticLogger::Appender::Async} that implements the
+    # same interface but just logs synchronously in the current thread.
+    # 
+    class Sync
+      extend Forwardable
+      
+      # The appender we forward to, which is a {SemanticLogger::Processor}
+      # in practice, since it wouldn't make any sense to wrap a regular
+      # appender in a Sync.
+      # 
+      # @return [SemanticLogger::Processor]
+      #     
+      attr_accessor :appender
+
+      # Forward methods that can be called directly
+      def_delegator :@appender, :name
+      def_delegator :@appender, :should_log?
+      def_delegator :@appender, :filter
+      def_delegator :@appender, :host
+      def_delegator :@appender, :application
+      def_delegator :@appender, :level
+      def_delegator :@appender, :level=
+      def_delegator :@appender, :logger
+      # Added for sync
+      def_delegator :@appender, :log
+      def_delegator :@appender, :on_log
+      def_delegator :@appender, :flush
+      def_delegator :@appender, :close
+      
+      class FakeQueue
+        def self.size
+          0
+        end
+      end
+
+      # Appender proxy to allow an existing appender to run asynchronously in a separate thread.
+      #
+      # Parameters:
+      #   name: [String]
+      #     Name to use for the log thread and the log name when logging any errors from this appender.
+      #
+      #   lag_threshold_s [Float]
+      #     Log a warning when a log message has been on the queue for longer than this period in seconds.
+      #     Default: 30
+      #
+      #   lag_check_interval: [Integer]
+      #     Number of messages to process before checking for slow logging.
+      #     Default: 1,000
+      def initialize(appender:,
+                     name: appender.class.name)
+
+        @appender           = appender
+      end
+      
+      # Needs to be there to support {SemanticLogger::Processor.queue_size},
+      # which gets the queue and returns it's size (which will always be zero
+      # for us).
+      # 
+      # We return {FakeQueue}, which only implements a `size` method that
+      # returns zero.
+      # 
+      # @return [#size]
+      # 
+      def queue; FakeQueue; end
+      
+      def lag_check_interval; -1; end
+      
+      def lag_check_interval= value
+        raise "Can't set `lag_check_interval` on Sync appender"
+      end
+      
+      def lag_threshold_s; -1; end
+      
+      def lag_threshold_s= value
+        raise "Can't set `lag_threshold_s` on Sync appender"
+      end
+      
+      # @return [false] Sync appender is of course not size-capped.
+      def capped?; false; end
+
+      # The {SemanticLogger::Appender::Async} worker thread is exposed via
+      # this method, which creates it if it doesn't exist and returns it, but
+      # it doesn't seem like the returned value is ever used; the method
+      # call is just invoked to start the thread.
+      # 
+      # Hence it seems to make most sense to just return `nil` since we don't
+      # have a thread, and figure out what to do if that causes errors (so far
+      # it seems fine).
+      #
+      # @return [nil]
+      # 
+      def thread; end
+      
+      # @return [true] Sync appender is always active
+      def active?; true; end
+
+    end # class Sync
+  end # module Appenders
+  
+  
   # Module (Class) Methods
   # =====================================================================
   
+  
+  def self.level
+    SemanticLogger.default_level
+  end
+  
+  
+  def self.level= level
+    SemanticLogger.default_level = level
+  end
+  
+  
+  def self.setup?
+    !!@setup
+  end
+  
+  
+  def self.get_env_level
+    if ENV['QB_TRACE'].truthy?
+      return :trace
+    elsif ENV['QB_DEBUG'].truthy?
+      return :debug
+    elsif ENV['QB_LOG_LEVEL']
+      return ENV['QB_LOG_LEVEL'].to_sym
+    end
+    
+    nil
+  end
+  
+  
   # Setup logging.
   # 
   # @param [type] arg_name
@@ -169,34 +299,38 @@ module QB::Util::Logging
   # @return [return_type]
   #   @todo Document return value.
   # 
-  def self.setup level: nil
-    if level.nil?
-      if ENV['QB_LOG_LEVEL']
-        level = ENV['QB_LOG_LEVEL'].to_sym
-      else
-        level = :info
-      end
+  def self.setup level: nil, sync: false, dest: nil
+    if setup?
+      logger.warn "Logging is already setup!"
+      return false
     end
     
-    SemanticLogger.default_level = level
-    
-    @appender ||= SemanticLogger.add_appender(
-      io: $stderr,
-      formatter: Formatters::Color.new,
-    )
-    
-    # Set ENV vars (that Ansible modules will have access to!)
+    SemanticLogger.application = 'qb'
     
-    ENV['QB_LOG_LEVEL'] = level.to_s
+    level = get_env_level if level.nil?
+    self.level = level if level
+    self.appender = dest if dest
     
-    if level == :debug
-      ENV['QB_DEBUG'] = 'true'
-      logger.debug "debug logging is ON"
-    else
-      ENV.delete 'QB_DEBUG'
+    if sync
+      # Hack up SemanticLogger to do sync logging in the main thread
+      
+      # Create a {Locd::Logging::Appender::Sync}, which implements the
+      # {SemanticLogger::Appender::Async} interface but just forwards directly
+      # to it's appender in the same thread, and point it where
+      # {SemanticLogger::Processor.instance} (which is an Async) points.
+      # 
+      sync_appender = Appender::Sync.new \
+        appender: SemanticLogger::Processor.instance.appender
+      
+      # Swap our sync in for the async
+      SemanticLogger::Processor.instance_variable_set \
+        :@processor,
+        sync_appender
     end
     
-    nil
+    @setup = true
+    
+    true
   end # .setup
   
   
@@ -205,4 +339,28 @@ module QB::Util::Logging
   end
   
   
+  def self.appender= value
+    # Save ref to current appender (if any) so we can remove it after adding
+    # the new one.
+    old_appender = @appender
+    
+    @appender = case value
+    when Hash
+      SemanticLogger.add_appender value
+    when String
+      SemanticLogger.add_appender file_name: value
+    else
+      SemanticLogger.add_appender \
+        io: value,
+        formatter: Formatters::Color.new
+    end
+    
+    # Remove the old appender (if there was one). This is done after adding
+    # the new one so that failing won't result with no appenders.
+    SemanticLogger.remove_appender( old_appender ) if old_appender
+    
+    @appender
+  end
+  
+  
 end # module QB::Util::Logging

data/library/git_mkdir.py

@@ -1,4 +1,4 @@
-#!/usr/bin/python
+#!/usr/bin/env python
 
 # import some python modules that we'll use.  These are all
 # available in Python's core
@@ -70,4 +70,4 @@ from ansible.module_utils.basic import *
 from ansible.module_utils.known_hosts import *
 
 if __name__ == '__main__':
-    main()
+    main()

data/library/qb_facts.py

@@ -1,4 +1,4 @@
-#!/usr/bin/python
+#!/usr/bin/env python
 
 import subprocess
 import os
@@ -55,7 +55,7 @@ def main():
         'qb_git_origin_url': ['git', 'remote', 'get-url', 'origin'],
     }
     
-    for key, cmd in cmds.iteritems():        
+    for key, cmd in cmds.iteritems():
         try:
             value = subprocess.check_output(cmd).rstrip()
             facts[key] = value
@@ -114,4 +114,4 @@ from ansible.module_utils.basic import *
 from ansible.module_utils.known_hosts import *
 
 if __name__ == '__main__':
-    main()
+    main()

data/qb.gemspec

@@ -194,9 +194,14 @@ Gem::Specification.new do |spec|
   # Runtime Dependencies
   # ----------------------------------------------------------------------------
   
-  spec.add_dependency "cmds",             '~> 0.2.7'
-  spec.add_dependency "nrser",            '< 0.3', '>= 0.2.0.pre.2'
-  spec.add_dependency "state_mate",       '~> 0.1.1'
+  # My guns
+  spec.add_dependency "nrser",            '< 0.3', '>= 0.2.0.pre.3'
+  
+  # My favorite wrapper
+  spec.add_dependency "cmds",             '~> 0.2.10'
+  
+  # My gem to help manage system state
+  spec.add_dependency "state_mate",       '~> 0.1.3'
   
   # Used to parse `ansible.cfg` files
   spec.add_dependency 'parseconfig',      '~> 1.0', '>= 1.0.8'

data/requirements.txt

@@ -0,0 +1,14 @@
+##
+# Python dependencies
+# 
+# TODO  Consider changing this to
+# 
+#           ansible>=2.4.1.0,<2.5
+#           pathlib2>=2.3.0,<3
+# 
+#       to allow more flexibility?
+#
+##
+
+ansible==2.4.1.0
+pathlib2==2.3.0

data/roles/nrser.blockinfile/library/blockinfile.py

@@ -25,12 +25,7 @@ import tempfile
 from itertools import chain
 
 import pprint
-
-try:
-    from __main__ import display
-except ImportError:
-    from ansible.utils.display import Display
-    display = Display()
+        
 
 DOCUMENTATION = """
 ---
@@ -295,31 +290,31 @@ def main():
     #     removed along with the content.
     # 
     if not present or block == '':
-        display.debug("removing block")
+        module.debug("removing block")
         
         result = different_re.sub('', original)
     
     # 2.  no-op - the exact text is already present
     elif exact_re.search(original):
-        display.debug("block already present")
+        module.debug("block already present")
         
         pass
         
     # 3. replace - the markers are present but the content is different
     elif different_re.search(original):
-        display.debug("block present but different, replacing")
+        module.debug("block present but different, replacing")
         
         result = different_re.sub(replacement, original)
     
-    # 4.  insert - the markers 
+    # 4.  insert - the markers
     else:
-        display.debug("block not present, inserting")
+        module.debug("block not present, inserting")
         
         lines = original.splitlines()
         
         n0 = None
         if insertre is not None:
-            match = insertre.search(original)    
+            match = insertre.search(original)
             for i, line in enumerate(lines):
                 if insertre.search(line):
                     n0 = i

data/roles/nrser.blockinfile/meta/main.yml

@@ -4,7 +4,7 @@ galaxy_info:
   description: Contains blockinfile module
                to insert/update/remove a text block surrounded by marker lines
   license: GPLv3+
-  min_ansible_version: 1.2
+  min_ansible_version: 2.4
   categories:
   - system
 dependencies: []

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qb
 version: !ruby/object:Gem::Version
-  version: 0.3.23
+  version: 0.3.24
 platform: ruby
 authors:
 - nrser
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-28 00:00:00.000000000 Z
+date: 2018-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,20 +114,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.4
-- !ruby/object:Gem::Dependency
-  name: cmds
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.7
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.7
 - !ruby/object:Gem::Dependency
   name: nrser
   requirement: !ruby/object:Gem::Requirement
@@ -137,7 +123,7 @@ dependencies:
         version: '0.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0.pre.2
+        version: 0.2.0.pre.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -147,21 +133,35 @@ dependencies:
         version: '0.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0.pre.2
+        version: 0.2.0.pre.3
+- !ruby/object:Gem::Dependency
+  name: cmds
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.10
 - !ruby/object:Gem::Dependency
   name: state_mate
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.1
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   name: parseconfig
   requirement: !ruby/object:Gem::Requirement
@@ -294,6 +294,7 @@ files:
 - lib/qb/package/version/from.rb
 - lib/qb/package/version/leveled.rb
 - lib/qb/path.rb
+- lib/qb/python.rb
 - lib/qb/repo.rb
 - lib/qb/repo/git.rb
 - lib/qb/repo/git/github.rb
@@ -332,6 +333,7 @@ files:
 - plugins/lookup_plugins/resolve.py
 - plugins/lookup_plugins/version.py
 - qb.gemspec
+- requirements.txt
 - roles/nrser.blockinfile/CONTRIBUTING.md
 - roles/nrser.blockinfile/README.md
 - roles/nrser.blockinfile/library/blockinfile.py