ansible-wrapper 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c5d98c9b1e164d0509c09b64a132bdf51b8a6478
-  data.tar.gz: 4057169e999f9cf5041eaa5bd8d378a8d4187d22
+SHA256:
+  metadata.gz: ee765d2b80572fec0da1ec9ddc043211872330ed9a6f40fc062cb72d65c02c50
+  data.tar.gz: c849698d3def8e27a816ce340154aac9386b2f5d253e568d9560574472d250f9
 SHA512:
-  metadata.gz: b1b58561ab5ca65cefdf80c8f7ba1e131385509db4e58975fa0dc7495af92e56c70b1090e339623c15127e97187648eb81b95280429fdafbb7f493c757a59d33
-  data.tar.gz: bdf1a0f5974b2e1f7ee98dce419cc095a1a4167058931d45e7550f94e5336761c1b5e93dc40b01952f167dfd4a8ee0aa6d6e56a87e88778912b0aac980eded1b
+  metadata.gz: f1e61631280784a6a85d34593206abba2420d978e372a9b44d3fecfef48efdc16df50d603097dc2dfd9d11fcb4a92f31f836eed54fe0d77ee1006273522bdeb1
+  data.tar.gz: a95a9ebaa9019a503011a318a9c28256f2d1613b6a384b6bc2114875db687561dd34be830f9fa49a3f14d48cf0e9750b2e77ce447a13e016cb0d6c6ecd4ef0de

data/.github/workflows/test_via_docker.yml

@@ -0,0 +1,33 @@
+name: Test using different Ansible & Ruby versions
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ansible:
+          - 2.0.2
+          - 2.1.6
+          - 2.2.3
+          - 2.3.3
+          - 2.4.6
+          - 2.5.15
+          - 2.6.19
+          - 2.7.12
+          - 2.8.5
+    steps:
+      - uses: actions/checkout@v1
+      - name: Run tests against Ruby 2.6.4
+        run: RUBY_VERSION=2.6.4 ANSIBLE_VERSION=${{ matrix.ansible }} && docker run --rm -v $PWD:/app pgeraghty/ansible-ruby:$RUBY_VERSION-$ANSIBLE_VERSION /bin/sh -c "cd /app && bundle install --jobs=3 --retry=3 && rake"
+      - name: Run tests against Ruby 2.5.6
+        run: RUBY_VERSION=2.5.6 ANSIBLE_VERSION=${{ matrix.ansible }} && docker run --rm -v $PWD:/app pgeraghty/ansible-ruby:$RUBY_VERSION-$ANSIBLE_VERSION /bin/sh -c "cd /app && bundle install --jobs=3 --retry=3 && rake"
+      - name: Run tests against Ruby 2.4.7
+        run: RUBY_VERSION=2.4.7 ANSIBLE_VERSION=${{ matrix.ansible }} && docker run --rm -v $PWD:/app pgeraghty/ansible-ruby:$RUBY_VERSION-$ANSIBLE_VERSION /bin/sh -c "cd /app && bundle install --jobs=3 --retry=3 && rake"
+      - name: Run tests against Ruby 2.3.7
+        run: RUBY_VERSION=2.3.7 ANSIBLE_VERSION=${{ matrix.ansible }} && docker run --rm -v $PWD:/app pgeraghty/ansible-ruby:$RUBY_VERSION-$ANSIBLE_VERSION /bin/sh -c "cd /app && bundle install --jobs=3 --retry=3 && rake"
+      - name: Run tests against Ruby 2.2.7
+        run: RUBY_VERSION=2.2.7 ANSIBLE_VERSION=${{ matrix.ansible }} && docker run --rm -v $PWD:/app pgeraghty/ansible-ruby:$RUBY_VERSION-$ANSIBLE_VERSION /bin/sh -c "cd /app && bundle install --jobs=3 --retry=3 && rake"
+      - name: Run tests against Ruby 2.1.10
+        run: RUBY_VERSION=2.1.10 ANSIBLE_VERSION=${{ matrix.ansible }} && docker run --rm -v $PWD:/app pgeraghty/ansible-ruby:$RUBY_VERSION-$ANSIBLE_VERSION /bin/sh -c "cd /app && bundle install --jobs=3 --retry=3 && rake"

data/.travis.yml

@@ -1,21 +1,21 @@
-language: ruby
+language: minimal
+services:
+  - docker
 env:
-  - ANSIBLE_VERSION=1.8.4
-  - ANSIBLE_VERSION=1.9.4
-  - ANSIBLE_VERSION=2.0.0.2
-  - ANSIBLE_VERSION=2.1.0.0
-  - ANSIBLE_VERSION=2.2.0.0
-rvm:
-  - 2.1.8
-  - 2.2.4
-  - 2.3.0
-cache: bundler
-before_install:
-  # make sure everything's up to date
-  - sudo apt-get update -qq
-  # install Python
-  - sudo apt-get install python
-  # upgrade pip
-  - sudo pip install --upgrade pip
-  # install Ansible
-  - sudo pip install ansible==$ANSIBLE_VERSION
+  - ANSIBLE_VERSION=2.0.2
+  - ANSIBLE_VERSION=2.1.6
+  - ANSIBLE_VERSION=2.2.3
+  - ANSIBLE_VERSION=2.3.3
+  - ANSIBLE_VERSION=2.4.6
+  - ANSIBLE_VERSION=2.5.15
+  - ANSIBLE_VERSION=2.6.19
+  - ANSIBLE_VERSION=2.7.12
+  - ANSIBLE_VERSION=2.8.5
+  - RUBY_VERSION=2.1.10
+  - RUBY_VERSION=2.2.7
+  - RUBY_VERSION=2.3.7
+  - RUBY_VERSION=2.4.7
+  - RUBY_VERSION=2.5.6
+  - RUBY_VERSION=2.6.4
+script:
+  - docker run --rm -it -v $PWD:/app pgeraghty/ansible-ruby:$RUBY_VERSION-$ANSIBLE_VERSION /bin/sh -c cd /app && bundle install --jobs=3 --retry=3 --deployment && rake

data/README.md

@@ -1,8 +1,8 @@
 # Ansible Wrapper
 
 [![Gem Version](https://badge.fury.io/rb/ansible-wrapper.svg)](http://badge.fury.io/rb/ansible-wrapper)
-[![Build Status](https://travis-ci.org/pgeraghty/ansible-wrapper-ruby.svg?branch=master)](https://travis-ci.org/pgeraghty/ansible-wrapper-ruby)
-[![Coverage Status](https://coveralls.io/repos/pgeraghty/ansible-wrapper-ruby/badge.svg?branch=master&service=github)](https://coveralls.io/github/pgeraghty/ansible-wrapper-ruby?branch=master)
+[![Build Status](https://travis-ci.com/pgeraghty/ansible-wrapper-ruby.svg?branch=master)](https://travis-ci.com/pgeraghty/ansible-wrapper-ruby)
+[![Coverage Status](https://coveralls.io/repos/github/pgeraghty/ansible-wrapper-ruby/badge.svg?branch=master)](https://coveralls.io/github/pgeraghty/ansible-wrapper-ruby?branch=master)
 [![Code Climate](https://codeclimate.com/github/pgeraghty/ansible-wrapper-ruby/badges/gpa.svg)](https://codeclimate.com/github/pgeraghty/ansible-wrapper-ruby)
 
 #### A lightweight Ruby wrapper around Ansible that allows for ad-hoc commands and playbook execution. The primary purpose is to support easy streaming output.

data/ansible-wrapper.gemspec

@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'json', '~> 1.8.4'
 end

data/examples/streaming/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gem 'sinatra'
+gem 'thin'
+
+gem 'ansible-wrapper', path: '../../' #github: 'pgeraghty/ansible-wrapper-ruby'

data/examples/streaming/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: ../..
+  specs:
+    ansible-wrapper (0.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    daemons (1.3.1)
+    eventmachine (1.2.7)
+    mustermann (1.0.3)
+    rack (2.0.7)
+    rack-protection (2.0.7)
+      rack
+    sinatra (2.0.7)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.7)
+      tilt (~> 2.0)
+    thin (1.7.2)
+      daemons (~> 1.0, >= 1.0.9)
+      eventmachine (~> 1.0, >= 1.0.4)
+      rack (>= 1, < 3)
+    tilt (2.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ansible-wrapper!
+  sinatra
+  thin
+
+BUNDLED WITH
+   1.17.3

data/examples/streaming/config.ru

@@ -0,0 +1,4 @@
+require 'rubygems'
+require './run'
+
+run Sinatra::Application

data/examples/streaming/run.rb

@@ -0,0 +1,71 @@
+require 'sinatra'
+
+require 'ansible-wrapper'
+
+set server: 'thin'
+set :environment, :production
+set :bind, '0.0.0.0'
+set :port, 4567
+
+Process.setproctitle 'Ansible Streaming Example'
+
+
+CONSOLE_OUTPUT_START = %{<!doctype html>
+<html>
+<head>
+  <meta charset="utf-8" />
+  <style>
+    body {
+      background-color: #{background ||= 'black'}; color: #{color ||= 'white'};
+    }
+    .bold {
+      font-weight: bold;
+    }
+    .black {
+      color: black;
+    }
+    .red {
+      color: red;
+    }
+    .green {
+      color: green;
+    }
+    .yellow {
+      color: yellow;
+    }
+    .blue {
+      color: blue;
+    }
+    .magenta {
+      color: magenta;
+    }
+    .cyan {
+      color: cyan;
+    }
+    .white {
+      color: white;
+    }
+    .grey {
+      color: grey;
+    }
+  </style>
+</head>
+<body><pre><code>}
+
+CONSOLE_OUTPUT_END = '</code></pre></body></html>'
+
+
+get '/' do
+  "Ansible #{Ansible::Config::VERSION}"
+end
+
+get '/streaming' do
+  #content_type 'text/plain'
+  stream do |out|
+    out << CONSOLE_OUTPUT_START
+    Ansible.stream ['-i', 'localhost,', File.expand_path('../../../spec/mock_playbook.yml', __FILE__)]*' ' do |line|
+      Ansible::Output.to_html line, out
+    end
+    out << CONSOLE_OUTPUT_END
+  end
+end

data/lib/ansible-wrapper.rb

@@ -1,14 +1,15 @@
 require 'ansible/version'
+require 'ansible/config'
 require 'ansible/ad_hoc'
 require 'ansible/playbook'
+require 'ansible/output'
 
 module Ansible
-  extend self
-  ENV = {}
+  include Ansible::Config
+  include Ansible::Methods
+  include Ansible::PlaybookMethods
 
-  def env_string
-    ENV.map { |a| a*'=' }*' '
-  end
+  extend self
 
   def enable_shortcuts!
     require 'ansible/shortcuts'

data/lib/ansible/ad_hoc.rb

@@ -1,11 +1,35 @@
+module Ansible::Methods
+  BIN = 'ansible'
+
+  def one_off cmd
+    `#{config.to_s "#{BIN} #{cmd}"}`
+  end
+  alias :[] :one_off
+
+  # this solution should work for Ansible pre-2.0 as well as 2.0+
+  def list_hosts cmd
+    one_off("#{cmd} --list-hosts").scan(IP_OR_HOSTNAME).map { |ip| ip.first.strip }
+  end
+
+  def parse_host_vars(host, inv_file, filter = 'hostvars[inventory_hostname]')
+    hostvars_filter = filter
+    cmd = "all -m debug -a 'var=#{hostvars_filter}' -i #{inv_file} -l #{host} --one-line"
+    hostvars = JSON.parse(self[cmd].split(/>>|=>/).last)
+
+    if Gem::Version.new(Ansible::Config::VERSION) >= Gem::Version.new('2.0')
+      hostvars[hostvars_filter]
+    else
+      hostvars['var'][hostvars_filter]
+    end
+  end
+end
+
 module Ansible
   module AdHoc
-    extend self
-    BIN = 'ansible'
+    include Ansible::Config
+    include Ansible::Methods
 
-    def run(cmd, _opts={})
-      cmd_line = [Ansible.env_string, BIN, cmd]*' '
-      `#{cmd_line}`
-    end
+    extend self
+    alias :run :one_off
   end
 end

data/lib/ansible/config.rb

@@ -0,0 +1,53 @@
+module Ansible::Config
+  PATH = 'lib/ansible/'
+  IP_OR_HOSTNAME = /((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)(\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)){3})$|^((([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9]))/
+  SKIP_HOSTVARS = %w(ansible_version inventory_dir inventory_file inventory_hostname inventory_hostname_short group_names groups omit playbook_dir)
+  VERSION = `ansible --version`.split("\n").first.split.last rescue nil # nil when Ansible not installed
+
+  DefaultConfig = Struct.new(:env, :extra_vars, :params) do
+    def initialize
+      self.env = {
+        'ANSIBLE_FORCE_COLOR' => 'True',
+        'ANSIBLE_HOST_KEY_CHECKING' => 'False'
+      }
+
+      self.params = {
+        debug: false
+      }
+
+      # options
+      self.extra_vars = {
+        # skip creation of .retry files
+        'retry_files_enabled' => 'False'
+      }
+      # TODO support --ssh-common-args, --ssh-extra-args
+      # e.g. ansible-playbook --ssh-common-args="-o ServerAliveInterval=60" -i inventory install.yml
+    end
+
+    # NB: --extra-vars can also accept JSON string, see http://stackoverflow.com/questions/25617273/pass-array-in-extra-vars-ansible
+    def options
+      x = extra_vars.each_with_object('--extra-vars=\'') { |kv, a| a << "#{kv.first}=\"#{kv.last}\" " }.strip+'\'' if extra_vars unless extra_vars.empty?
+      # can test with configure { |config| config.extra_vars.clear }
+
+      [x, '--ssh-extra-args=\'-o UserKnownHostsFile=/dev/null\'']*' '
+    end
+
+    def to_s(cmd)
+      entire_cmd = [env.each_with_object([]) { |kv, a| a << kv*'=' } * ' ', cmd, options]*' '
+      puts entire_cmd if params[:debug]
+      entire_cmd
+    end
+  end
+
+  def configure
+    @config ||= DefaultConfig.new
+    yield(@config) if block_given?
+
+    # allow chaining if block given
+    block_given? ? self : @config
+  end
+
+  def config
+    @config || configure
+  end
+end

data/lib/ansible/output.rb

@@ -0,0 +1,47 @@
+require 'strscan'
+require 'erb'
+
+module Ansible::Output
+  COLOR = {
+    '1' => 'font-weight: bold',
+    '30' => 'color: black',
+    '31' => 'color: red',
+    '32' => 'color: green',
+    '33' => 'color: yellow',
+    '34' => 'color: blue',
+    '35' => 'color: magenta',
+    '36' => 'color: cyan',
+    '37' => 'color: white',
+    '90' => 'color: grey'
+  }
+
+  def self.to_html(line, stream='')
+    s = StringScanner.new(ERB::Util.h line)
+    while(!s.eos?)
+      if s.scan(/\e\[([0-1]);(3[0-7]|90|1)m/)
+        bold, colour = s.captures
+        styles = []
+
+        styles << COLOR[bold] if bold.to_i == 1
+        styles << COLOR[colour]
+
+        span =
+          if styles.empty?
+            %{<span>}
+          else
+            %{<span style="#{styles*'; '};">}
+          end
+
+        stream << span
+      else
+        if s.scan(/\e\[0m/)
+          stream << %{</span>}
+        else
+          stream << s.scan(/./m)
+        end
+      end
+    end
+
+    stream
+  end
+end

data/lib/ansible/playbook.rb

@@ -1,23 +1,38 @@
 require 'ansible/safe_pty'
 
 module Ansible
-  module Playbook
+  module PlaybookMethods
     BIN = 'ansible-playbook'
-    extend self
-
-    def run(cmd, _opts={})
-      cmd_line =  [Ansible.env_string, 'ANSIBLE_FORCE_COLOR=True', BIN, cmd]*' '
 
-      `#{cmd_line}`
+    def playbook pb
+      `#{config.to_s "#{BIN} #{pb}"}`
     end
+    alias :<< :playbook
 
-    # This method uses PTY because otherwise output is buffered
-    def stream(cmd, _opts={})
-      cmd_line = [Ansible.env_string, 'ANSIBLE_FORCE_COLOR=True', BIN, cmd]*' '
+    def stream pb
+      # Use PTY because otherwise output is buffered
+      SafePty.spawn config.to_s("#{BIN} #{pb}") do |r,w,p| # add -vvvv here for verbose
+        until r.eof? do
+          line = r.gets
+          block_given? ? yield(line) : puts(line)
 
-      SafePty.spawn(cmd_line) do |r,_w,_p|
-        block_given? ? yield(r.gets) : puts(r.gets) until r.eof?
+          raise "FAILED: #{line}" if line.include?('fatal: [')
+          raise Playbook::Exception.new("ERROR: #{line}") if line.include?('ERROR!')
+          # TODO raise if contains FAILED!
+        end
       end
     end
   end
+end
+
+module Ansible
+  module Playbook
+    include Ansible::Config
+    include Ansible::PlaybookMethods
+
+    extend self
+    alias :run :playbook
+
+    class Exception < RuntimeError; end
+  end
 end

data/lib/ansible/safe_pty.rb

@@ -1,6 +1,6 @@
 require 'pty'
 
-module SafePty
+module Ansible::SafePty
   def self.spawn(command)
 
     PTY.spawn(command) do |r,w,p|

data/lib/ansible/version.rb

@@ -1,3 +1,3 @@
 module Ansible
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ansible-wrapper
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Paul Geraghty
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-14 00:00:00.000000000 Z
+date: 2019-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.4
 description: A lightweight Ruby wrapper around Ansible that allows for ad-hoc commands
   and playbook execution.
 email:
@@ -74,6 +88,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test_via_docker.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -81,11 +96,18 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- ansible-wrapper-0.1.2.gem
 - ansible-wrapper.gemspec
 - bin/console
 - bin/setup
+- examples/streaming/Gemfile
+- examples/streaming/Gemfile.lock
+- examples/streaming/config.ru
+- examples/streaming/run.rb
 - lib/ansible-wrapper.rb
 - lib/ansible/ad_hoc.rb
+- lib/ansible/config.rb
+- lib/ansible/output.rb
 - lib/ansible/playbook.rb
 - lib/ansible/safe_pty.rb
 - lib/ansible/shortcuts.rb
@@ -109,8 +131,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper around Ansible