ansible-powerplay 0.2.4 → 1.0.2

data/RELEASE_NOTES.org

@@ -7,39 +7,48 @@
   major number. Of course, you can read all about it here.
 
 ** Release Notes
-   | Release | Feature / Bug                    | Description                                                                        |       Date |
-   |---------+----------------------------------+------------------------------------------------------------------------------------+------------|
-   | v0.2.3  | --verbose                        | Will display Ansible commands on a --verbosity=1 or higher.                        | 2016-03-17 |
-   | v0.2.2  | --tags, --skip-tags              | Ansible tag support                                                                | 2016-03-07 |
-   | v0.2.1  | --extra-vars                     | A way of passing extra vars to the Ansible playbooks. Please see the documentation | 2016-03-01 |
-   | v0.2.0  | powerplay play (behavior change) | If script is not given, now defaults to 'stack.play' in the current directory.     | 2016-02-29 |
-   | v0.1.3  | --tmux                           | Better handling at distributing the panes.                                         | 2016-02-26 |
-   | v0.1.2  | --tmux. --no-tmux                | Default output now goes to current tty                                             | 2016-02-23 |
-   | v0.1.1  | --book, --group, --play          | Minor bug with the array handling                                                  | 2016-02-22 |
-   | v0.1.0  | --book, --group, --play          | Now each can take multiple specifications                                          | 2016-02-22 |
-   | v0.0.8  | Creation of these Release Notes  | About bloody time. The prior releases were all mostly bug fixes, and so...         | 2016-02-20 |
-   |         | --tmux                           | Now you can optionally specify the window number                                   |            |
-   |         | --tmux                           | Now checks to ensure it does not dump to its own pane                              |            |
-   |         | --book                           | You can select an individual playbook to run                                       |            |
-   |         | --group                          | You can select an individual group to run                                          |            |
-
+   | Release | Feature / Bug                          | Description                                                                                   |       Date |
+   |---------+----------------------------------------+-----------------------------------------------------------------------------------------------+------------|
+   | v1.0.0  | version                                | Prints version                                                                                | 2061-06-04 |
+   |         | powerplay / pp shorthand command       | Play task defaults if you use the shorthand 'pp' on the commandline                           | 2061-06-04 |
+   |         | DSL incompatible changes               | Nestable groups, naked books. older DSL not gauranteed to be compatable.                      |            |
+   |         | Internal rewrite of the execution flow | Logic for execution flow rewritten to allow fine-grained control over what is sync and async. |            |
+   |         | Internal NOOP books                    | We need to demarcate groups executing synchronously that they themselves have async members.  |            |
+   | v0.2.3  | --verbose                              | Will display Ansible commands on a --verbosity=1 or higher.                                   | 2016-03-17 |
+   | v0.2.2  | --tags, --skip-tags                    | Ansible tag support                                                                           | 2016-03-07 |
+   | v0.2.1  | --extra-vars                           | A way of passing extra vars to the Ansible playbooks. Please see the documentation            | 2016-03-01 |
+   | v0.2.0  | powerplay play (behavior change)       | If script is not given, now defaults to 'stack.play' in the current directory.                | 2016-02-29 |
+   | v0.1.3  | --tmux                                 | Better handling at distributing the panes.                                                    | 2016-02-26 |
+   | v0.1.2  | --tmux. --no-tmux                      | Default output now goes to current tty                                                        | 2016-02-23 |
+   | v0.1.1  | --book, --group, --play                | Minor bug with the array handling                                                             | 2016-02-22 |
+   | v0.1.0  | --book, --group, --play                | Now each can take multiple specifications                                                     | 2016-02-22 |
+   | v0.0.8  | Creation of these Release Notes        | About bloody time. The prior releases were all mostly bug fixes, and so...                    | 2016-02-20 |
+   |         | --tmux                                 | Now you can optionally specify the window number                                              |            |
+   |         | --tmux                                 | Now checks to ensure it does not dump to its own pane                                         |            |
+   |         | --book                                 | You can select an individual playbook to run                                                  |            |
+   |         | --group                                | You can select an individual group to run                                                     |            |
 
 ** Known Outstanding Issues
    Bugs and missing features that needs to be addressed. As they are,
    we'll remove them from this list.
    |       Date | Issue                      | Description                                                                                                                                              |
    |------------+----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------|
+   | 2016-06-05 | version                    | Command does not work properly. It hangs.                                                                                                                |
+   | 2016-04-07 | --extra-vars               | Powerplay duplicates keys on extra vars if already specified in the Powerplay.                                                                           |
+   | 2016-03-11 | Grouping                   | Groups executes in parallel instead of serially.                                                                                                         |
+   |            | Core                       | Core process flow needs to be redone.                                                                                                                    |
    | 2016-03-03 | Status dump out of order   | Currently a bit out of order due to the fact that the output are being run in different threads and so the text is being printed nondeterministically.   |
    | 2016-02-20 | Platforms other than Linux | We need to test on Mac OSX and Windows. Should work fine on Macs. I do not plan to support Windows in general, but may accept pull requests to that end. |
 
 ** Wish List
-   Well, we can always wish upon a star...
-   |       Date | Wish                      | Description                                                                                                                                                                   |
-   |------------+---------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-   | 2016-02-20 | Integration with Jenkins  | I have no idea what form this will take                                                                                                                                       |
-   |            | Curses integration        | Basically, the tmux integration is used because it was quick to do. But what I really want to do is full Curses support, similar with what you see with htop and other tools. |
-   | 2016-02-26 | Better and Error handling | When there's a failure in the underlying Ansible playbook, we want to handle that better in Powerplay. This would be a part of the Curses upgrade to come later.              |
-   | 2016-02-29 | Configuration file        | Add a (presumably yaml format) configuration file in a few key locations.                                                                                                     |
-   |            | Name Completion           | Shell integration with name completion features of bash.                                                                                                                      |
-   | 2016-03-03 | DSL subgroup              | We need to subgroup books within a group to make it easier to launch them specifically.                                                                                       |
-   |            |                           |                                                                                                                                                                               |
+   Well, we can always wish upon a star... but it will take
+   my time and dedication to make stars happen. :p
+
+   |       Date | Wish                          | Description                                                                                                                                                                   |   |
+   |------------+-------------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---|
+   | 2016-06-04 | Verbosity to ansible-playbook | Being able to pass in the -v flag to ansible. From pp, a -v2, for example, would be the equivalent of -vv to ansible-playbook.                                                |   |
+   | 2016-02-20 | Integration with Jenkins      | I have no idea what form this will take                                                                                                                                       |   |
+   |            | Curses integration            | Basically, the tmux integration is used because it was quick to do. But what I really want to do is full Curses support, similar with what you see with htop and other tools. |   |
+   | 2016-02-26 | Better and Error handling     | When there's a failure in the underlying Ansible playbook, we want to handle that better in Powerplay. This would be a part of the Curses upgrade to come later.              |   |
+   | 2016-02-29 | Configuration file            | Add a (presumably yaml format) configuration file in a few key locations.                                                                                                     |   |
+   |            | Name Completion               | Shell integration with name completion features of bash.                                                                                                                      |   |

data/SCRATCHPAD.org

@@ -10,3 +10,9 @@
     tmux list-panes -F '#{pane_id} #{pane_tty} #{pane_right} #{pane_left} #{pane_top} #{pane_bottom}'
     #+END_SRC
     
+** PowerPlay command for testing
+   #+BEGIN_SRC bash
+   cd examples/
+   ../bin/powerplay play -p development -v1 -u
+   #+END_SRC
+ 

data/ansible-powerplay.gemspec

@@ -2,19 +2,19 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: ansible-powerplay 0.2.4 ruby lib
+# stub: ansible-powerplay 1.0.2 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ansible-powerplay"
-  s.version = "0.2.4"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Fred Mitchell"]
-  s.date = "2016-03-25"
+  s.date = "2016-06-05"
   s.description = "Ansible Powerplay, by way of its DSL, allows you to\n                       specify your Ansible playbooks and their vars, and common\n                       vars to all, so that you can run your\n                       indeoendent playbooks in full parallel."
   s.email = "fred.mitchell@gmx.de"
-  s.executables = ["powerplay"]
+  s.executables = ["powerplay", "pp"]
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.org"
@@ -33,6 +33,14 @@ Gem::Specification.new do |s|
     "SCRATCHPAD.org",
     "ansible-powerplay.gemspec",
     "bin/powerplay",
+    "bin/pp",
+    "examples/playbooks/dat.yml",
+    "examples/playbooks/elasticseach.yml",
+    "examples/playbooks/first.yml",
+    "examples/playbooks/nat.yml",
+    "examples/playbooks/rabbitmq.yml",
+    "examples/playbooks/rat.yml",
+    "examples/playbooks/second.yml",
     "lib/ansible-powerplay.rb",
     "lib/ansible-powerplay/cli.rb",
     "lib/ansible-powerplay/dsl.rb",
@@ -51,10 +59,11 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<thor>, ["~> 0"])
-      s.add_runtime_dependency(%q<concurrent-ruby>, [">= 0"])
-      s.add_runtime_dependency(%q<term-ansicolor>, [">= 0"])
+      s.add_runtime_dependency(%q<term-ansicolor>, ["~> 1"])
       s.add_runtime_dependency(%q<colorize>, ["~> 0"])
       s.add_runtime_dependency(%q<semver>, ["~> 1"])
+      s.add_runtime_dependency(%q<queue_ding>, ["~> 0"])
+      s.add_runtime_dependency(%q<concurrent-ruby>, ["~> 1"])
       s.add_development_dependency(%q<rspec>, ["~> 2"])
       s.add_development_dependency(%q<yard>, ["~> 0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3"])
@@ -71,10 +80,11 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<pry-stack_explorer>, ["~> 0"])
     else
       s.add_dependency(%q<thor>, ["~> 0"])
-      s.add_dependency(%q<concurrent-ruby>, [">= 0"])
-      s.add_dependency(%q<term-ansicolor>, [">= 0"])
+      s.add_dependency(%q<term-ansicolor>, ["~> 1"])
       s.add_dependency(%q<colorize>, ["~> 0"])
       s.add_dependency(%q<semver>, ["~> 1"])
+      s.add_dependency(%q<queue_ding>, ["~> 0"])
+      s.add_dependency(%q<concurrent-ruby>, ["~> 1"])
       s.add_dependency(%q<rspec>, ["~> 2"])
       s.add_dependency(%q<yard>, ["~> 0"])
       s.add_dependency(%q<rdoc>, ["~> 3"])
@@ -92,10 +102,11 @@ Gem::Specification.new do |s|
     end
   else
     s.add_dependency(%q<thor>, ["~> 0"])
-    s.add_dependency(%q<concurrent-ruby>, [">= 0"])
-    s.add_dependency(%q<term-ansicolor>, [">= 0"])
+    s.add_dependency(%q<term-ansicolor>, ["~> 1"])
     s.add_dependency(%q<colorize>, ["~> 0"])
     s.add_dependency(%q<semver>, ["~> 1"])
+    s.add_dependency(%q<queue_ding>, ["~> 0"])
+    s.add_dependency(%q<concurrent-ruby>, ["~> 1"])
     s.add_dependency(%q<rspec>, ["~> 2"])
     s.add_dependency(%q<yard>, ["~> 0"])
     s.add_dependency(%q<rdoc>, ["~> 3"])

data/bin/powerplay

@@ -2,6 +2,7 @@
 
 PP_PATH = File.expand_path '..', File.dirname(__FILE__)
 PP_EXECUTABLE = File.expand_path 'bin/powerplay', Dir.pwd
+$PP_BASENAME = File.basename(__FILE__)
 
 $:.unshift File.join([PP_PATH, 'lib'])
 

data/bin/pp

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+PP_PATH = File.expand_path '..', File.dirname(__FILE__)
+PP_EXECUTABLE = File.expand_path 'bin/powerplay', Dir.pwd
+$PP_BASENAME = File.basename(__FILE__)
+
+$:.unshift File.join([PP_PATH, 'lib'])
+
+require 'ansible-powerplay/cli'
+
+Powerplay::Cli::Main.start

data/examples/playbooks/dat.yml

@@ -0,0 +1,15 @@
+---
+- hosts: local
+  connection: local
+  gather_facts: False
+  tasks:
+    - name: setting a fact
+      set_fact:
+        nat:
+          - { 00 : dat, 01 : hello, 02 : world }
+    - name: test fact and passed in variables
+      debug:
+        msg: "DAT test {{nat}} stack {{stack}} AWS instance type {{aws_type}} AWS disk size {{aws_disk_size}}"
+    - name: wait 5 seconds
+      pause:
+        seconds: 5

data/examples/playbooks/elasticseach.yml

@@ -0,0 +1,15 @@
+---
+- hosts: local
+  connection: local
+  gather_facts: False
+  tasks:
+    - name: setting a fact
+      set_fact:
+        nat:
+          - { 00 : elasticsearch, 01 : hello, 02 : world }
+    - name: test fact and passed in variables
+      debug:
+        msg: "elasticsearch test {{nat}} stack {{stack}} AWS instance type {{aws_type}} AWS disk size {{aws_disk_size}}"
+    - name: wait 5 seconds
+      pause:
+        seconds: 5

data/examples/playbooks/first.yml

@@ -0,0 +1,15 @@
+---
+- hosts: local
+  connection: local
+  gather_facts: False
+  tasks:
+    - name: setting a fact
+      set_fact:
+        nat:
+          - { 00 : first, 01 : hello, 02 : world }
+    - name: test fact and passed in variables
+      debug:
+        msg: "first test {{nat}} stack {{stack}} AWS instance type {{aws_type}} AWS disk size {{aws_disk_size}}"
+    - name: wait 5 seconds
+      pause:
+        seconds: 5

data/examples/playbooks/nat.yml

@@ -0,0 +1,15 @@
+---
+- hosts: local
+  connection: local
+  gather_facts: False
+  tasks:
+    - name: setting a fact
+      set_fact:
+        nat:
+          - { 00 : nat, 01 : hello, 02 : world }
+    - name: test fact and passed in variables
+      debug:
+        msg: "NAT test {{nat}} stack {{stack}} AWS instance type {{aws_type}} AWS disk size {{aws_disk_size}}"
+    - name: wait 5 seconds
+      pause:
+        seconds: 5

data/examples/playbooks/rabbitmq.yml

@@ -0,0 +1,15 @@
+---
+- hosts: local
+  connection: local
+  gather_facts: False
+  tasks:
+    - name: setting a fact
+      set_fact:  
+        nat:
+          - { 00 : rabbitmq, 01 : hello, 02 : world }
+    - name: test fact and passed in variables
+      debug:
+        msg: "rabbitmq test {{nat}} stack {{stack}} AWS instance type {{aws_type}} AWS disk size {{aws_disk_size}}"
+    - name: wait 5 seconds
+      pause:
+        seconds: 5

data/examples/playbooks/rat.yml

@@ -0,0 +1,15 @@
+---
+- hosts: local
+  connection: local
+  gather_facts: False
+  tasks:
+    - name: setting a fact
+      set_fact:
+        nat:
+          - { 00 : rat, 01 : hello, 02 : world }
+    - name: test fact and passed in variables
+      debug:
+        msg: "RAT test {{nat}} stack {{stack}} AWS instance type {{aws_type}} AWS disk size {{aws_disk_size}}"
+    - name: wait 5 seconds
+      pause:
+        seconds: 5

data/examples/playbooks/second.yml

@@ -0,0 +1,15 @@
+---
+- hosts: local
+  connection: local
+  gather_facts: False
+  tasks:
+    - name: setting a fact
+      set_fact:
+        nat:
+          - { 00 : second, 01 : hello, 02 : world }
+    - name: test fact and passed in variables
+      debug:
+        msg: "second test {{nat}} stack {{stack}} AWS instance type {{aws_type}} AWS disk size {{aws_disk_size}}"
+    - name: wait 5 seconds
+      pause:
+        seconds: 5

data/lib/ansible-powerplay.rb

@@ -4,5 +4,15 @@ require 'pp'
 require 'open3'
 require 'thread'
 require 'colorize'
+require 'queue_ding'
+
+def s_version
+  SemVer.find.format "v%M.%m.%p%s"
+end
+
+include QueueDing
+
 require_relative 'ansible-powerplay/powerplay'
 require_relative 'ansible-powerplay/dsl'
+require_relative 'ansible-powerplay/cli'
+

data/lib/ansible-powerplay/cli.rb

@@ -23,7 +23,6 @@ module Powerplay
                                                         desc: 'Which PowerPlay playbooks (as opposed to Ansible playbooks) to specifically execute.'
       option :group,     type: :array,   aliases: '-g', banner: "[NAME[ NAME2...]|all]", default: [:all],
                                                         desc: ' Which groups to execute.'
-      option :congroups, type: :boolean, aliases: '-c', desc: "Run the groups themselves concurrently"
       option :book,      type: :array,   aliases: '-b', banner: "[NAME[ NAME2...]|all]", default: [:all],
                                                         desc: 'Which books to execute.'
       option :dryrun,    type: :boolean, aliases: '-u', desc: "Dry run, do not actually execute."
@@ -40,9 +39,44 @@ module Powerplay
         DSL::_global[:options] = massage options
         puts "script %s " % [script] if DSL::_global[:options][:verbose] >= 1
         load script, true
-        pp DSL::_global if DSL::_verbosity >= 3
+
+        if DSL::_verbosity >= 3
+          puts "\n*** PLANNING FIFO QUEUE:".green
+          puts DSL::_planning.map{ |book|
+            [book.type, book.plan, book.yaml, book.family.map{|g| ":#{g}" }.join(' < ')]
+          }.map{ |t,p,y,f|
+            unless t == :noop
+              ":#{t}".light_yellow
+            else
+              ":#{t}".red
+            end +
+              unless p == :async
+                "\t :#{p}".light_cyan
+              else
+                "\t :#{p}".light_red
+              end +
+              "\t #{y}".magenta +
+              "\t #{f}".light_black
+          }
+          puts
+        end
+
+        if DSL::_verbosity >= 4
+          puts "\n**** PARSE TREE & GLOBAL OBJECTS:".green
+          pp DSL::_global
+          
+          puts "\n**** PLANNING FIFO QUEUE DETAILS:".green
+          pp DSL::_planning
+        end
+
         Play::Ansible::power_run
       end
+      default_task :play if $PP_BASENAME == 'pp'
+      
+      desc 'version', 'display the version of this PowerPlay install'
+      def version
+        puts s_version
+      end
       
       desc 'ttys', 'list all the TMUX ptys on the current window.'
       def ttys

data/lib/ansible-powerplay/dsl.rb

@@ -3,16 +3,21 @@ module Powerplay
   module DSL
     @@config_stack = [{}]
     @@global_config = {}
+    @@planning_queue = []
+    
     SPECIAL_PARAMS = [:playbook_directory, :inventory]
 
+    # bump the config stack because we are in a child node context
     def _bump
       @@config_stack.push @@config_stack.last.clone
     end
 
+    # pop the config stack, as we have left the child node context
     def _dip
       @@config_stack.pop
     end
 
+    # Get the current config
     def _config
       @@config_stack.last
     end
@@ -25,6 +30,27 @@ module Powerplay
       _global[:options][:verbose]
     end
 
+    def _enqueue book
+      @@planning_queue << book
+    end
+
+    def _dequeue
+      @@planning_queue.shift
+    end
+
+    def _peek
+      @@planning_queue.first
+    end
+    
+    def _sneak
+      @@planning_queue.last
+    end
+
+    # do NOT modify this directly. use the API above.
+    def _planning
+      @@planning_queue
+    end
+    
     class Dsl
       attr :config, :type, :desc
 
@@ -40,6 +66,11 @@ module Powerplay
         @config[type] = DslConfiguration.new(type, desc, &block).config
       end
 
+      def book(type, yaml, desc: nil, plan: :sync, &block)
+        @books ||= []
+        _enqueue DslBook.new(type, yaml, desc: desc, plan: plan, &block)
+      end
+
       def initialize(type, desc, &ignore)
         @type = type
         @desc = desc
@@ -55,12 +86,15 @@ module Powerplay
       end
     end
 
+    # we do allow for noop books
     class DslBook < Dsl
-      attr :yaml
+      attr :yaml, :plan, :group
 
-      def initialize(type, yaml, desc=nil, &block)
+      def initialize(type, yaml, desc: nil, plan: nil, group: nil, &block)
         super(type, desc, &block)
         @yaml = yaml
+        @plan = plan
+        @group = group
         _bump
         instance_eval(&block) if block_given?
         @config = _dip
@@ -72,30 +106,60 @@ module Powerplay
           "#{k}=#{v.first}" unless DSL::SPECIAL_PARAMS.member?(k)
         }.compact.join(' ')
       end
+
+      def family
+        unless @group.nil?
+          @group.family
+        else
+          []
+        end
+      end
     end
 
     class DslGroup < Dsl
-      attr :books
+      # The entries here may either be books or groups.
+      attr_reader :exec, :parent
 
-      def book(type, yaml, desc=nil, &block)
-        @books ||= []
-        books << DslBook.new(type, yaml, desc, &block)
+      def group name, desc = nil, plan = :async, &block
+        DslGroup.new(name, desc, plan, self, &block)
+        _enqueue DslBook.new(:noop, nil, plan: @exec) unless @exec == :async or _sneak.type == :sync
       end
 
-      def initialize(type, desc, &block)
-        super
+      def book(type, yaml, desc: nil, plan: @exec, &block)
+        raise ":noop is a reserved book type and cannot be used." if type == :noop
+        _enqueue DslBook.new(type, yaml,
+                             desc: desc,
+                             plan: plan,
+                             group: self, &block)
+      end
+
+      def initialize(type, desc, plan, parent=nil, &block)
+        super(type, desc, &block)
+        @exec = plan
+        @parent = parent
         _bump
-        instance_eval &block
+        instance_eval( &block ) 
         @config = _dip
       end
+
+      # return a list including ourselves and our parents
+      def family
+        fam = []
+        g = self
+        while g
+          fam << g.type
+          g = g.parent
+        end
+        fam
+      end
     end
 
     class DslPlaybook < Dsl
       attr :groups
 
-      def group name, desc=nil, &block
+      def group name, desc = nil, plan = :async, &block
         @groups ||= []
-        groups << DslGroup.new(name, desc, &block)
+        groups << DslGroup.new(name, desc, plan, &block)
       end
 
       def initialize (type, desc, &block)