ansibler 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff6735bf081815a1f5b2b48734b1990e504ca203
-  data.tar.gz: 900163d141fe1d783807bfb5646d300256d6f87f
+  metadata.gz: 95e7c9a2379c008caf95e317891315d9ebc67971
+  data.tar.gz: f01f321426e0223a86cc0af1ffa88ef3ac281f1e
 SHA512:
-  metadata.gz: a46e5a87a00359a28fed84eccd3962ea6dd3e98a320775d95e2b9938ed3db72b26e0cbb69b4cba7d5764fae6c95f880c620705dbe6fc6b3fc5757f75e46de7e7
-  data.tar.gz: 16758599fb76a1b1322fd008ffc40b33762e87c406840699ba131a9e96268346b8ce1d6a812b816d487c551b4cecec97db91f7e077c04a3501c6f791190d2423
+  metadata.gz: c907bed830f960cb561411749c7dbc466c3193a64bf2fc53457136013edf6b761ade574dbee1cf253e7e4fa47e9bea550d78285de45ca4aac850f8c56618b351
+  data.tar.gz: 0a096596765d08339431d1720163e15dd84b08ed8cffcf7c5f6c50a23a3baaaf507c8da51f520c878f30895ce7b5c799972ce2cbd6efb9be8909b5dad18f537d

data/Gemfile

@@ -9,8 +9,10 @@ group :development do
   gem 'jeweler', '~> 2.0.1'
 
   # Use cucumber & rspec for tests
-  gem 'cucumber', '~> 2.0'
   gem 'rspec', '~> 3.2'
+  gem 'cucumber', '~> 2.0'
+  # https://github.com/cucumber/aruba
+  gem 'aruba', '0.6.2'
 
   # Code coverage using simplecov
   gem 'simplecov', '>= 0'
@@ -20,7 +22,7 @@ group :development do
 
   # Documentation
   gem 'rdoc', '~> 4.2.0'
-  gem 'yard', '~> 0.8.7'
+  gem 'yard', '~> 0.8.7', require: false
   gem 'redcarpet'
 
 end

data/Gemfile.lock

@@ -8,10 +8,16 @@ GEM
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
     addressable (2.3.8)
+    aruba (0.6.2)
+      childprocess (>= 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
     ast (2.0.0)
     astrolabe (1.3.0)
       parser (>= 2.2.0.pre.3, < 3.0)
     builder (3.2.2)
+    childprocess (0.5.6)
+      ffi (~> 1.0, >= 1.0.11)
     cucumber (2.0.0)
       builder (>= 2.1.2)
       cucumber-core (~> 1.1.3)
@@ -27,6 +33,7 @@ GEM
     docile (1.1.5)
     faraday (0.9.1)
       multipart-post (>= 1.2, < 3)
+    ffi (1.9.8)
     gherkin (2.12.2)
       multi_json (~> 1.3)
     git (1.2.9.1)
@@ -109,6 +116,7 @@ PLATFORMS
 
 DEPENDENCIES
   activesupport (= 4.2.1)
+  aruba (= 0.6.2)
   bundler (~> 1.0)
   cucumber (~> 2.0)
   jeweler (~> 2.0.1)

data/README.md

@@ -27,6 +27,10 @@ inventory.groups.first.name # => "mysql"
 inventory.groups.first.hosts.first.vars['ansible_ssh_user'] # => "ubuntu"
 ```
 
+## Documentation
+
+Full documentation is available [here](https://www.relishapp.com/aisrael/ansibler/docs).
+
 ## Contributing to ansibler
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/Rakefile

@@ -21,14 +21,18 @@ Jeweler::Tasks.new do |gem|
   gem.description = 'ansibler is a Ruby gem that provides utility classes for modeling, reading and writing Ansible inventory and playbook files.'
   gem.email = 'aisrael@gmail.com'
   gem.authors = ['Alistair A. Israel']
+
   # dependencies defined in Gemfile
+
+  gem.files             = `git ls-files`.split("\n").delete_if {|f| f.start_with?('.')}
+  gem.test_files        = `git ls-files -- {test,spec,features}/*`.split("\n")
 end
 Jeweler::RubygemsDotOrgTasks.new
 
 require 'cucumber'
 require 'cucumber/rake/task'
 Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = %w(features/*.features --format pretty)
+  t.cucumber_opts = %w(features/*.feature --format pretty)
 end
 
 desc 'Code coverage detail'
@@ -37,7 +41,7 @@ task :simplecov do
   Rake::Task['test'].execute
 end
 
-task :default => :test
+task :default => :features
 
 require 'yard'
 YARD::Rake::YardocTask.new do |t|

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/ansibler.gemspec

@@ -0,0 +1,85 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: ansibler 0.2.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "ansibler"
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Alistair A. Israel"]
+  s.date = "2015-05-20"
+  s.description = "ansibler is a Ruby gem that provides utility classes for modeling, reading and writing Ansible inventory and playbook files."
+  s.email = "aisrael@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "ansibler.gemspec",
+    "features/.nav",
+    "features/README.md",
+    "features/inventory.feature",
+    "features/step_definitions/inventory_steps.rb",
+    "features/support/env.rb",
+    "lib/ansible/inventory.rb",
+    "lib/ansibler.rb"
+  ]
+  s.homepage = "http://github.com/aisrael/ansibler"
+  s.licenses = ["MIT"]
+  s.rubygems_version = "2.4.6"
+  s.summary = "Ruby gem for reading and writing Ansible files"
+  s.test_files = ["features/README.md", "features/inventory.feature", "features/step_definitions/inventory_steps.rb", "features/support/env.rb"]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, ["= 4.2.1"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_development_dependency(%q<rspec>, ["~> 3.2"])
+      s.add_development_dependency(%q<cucumber>, ["~> 2.0"])
+      s.add_development_dependency(%q<aruba>, ["= 0.6.2"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<rubocop>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 4.2.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.8.7"])
+      s.add_development_dependency(%q<redcarpet>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, ["= 4.2.1"])
+      s.add_dependency(%q<bundler>, ["~> 1.0"])
+      s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+      s.add_dependency(%q<rspec>, ["~> 3.2"])
+      s.add_dependency(%q<cucumber>, ["~> 2.0"])
+      s.add_dependency(%q<aruba>, ["= 0.6.2"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<rubocop>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 4.2.0"])
+      s.add_dependency(%q<yard>, ["~> 0.8.7"])
+      s.add_dependency(%q<redcarpet>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, ["= 4.2.1"])
+    s.add_dependency(%q<bundler>, ["~> 1.0"])
+    s.add_dependency(%q<jeweler>, ["~> 2.0.1"])
+    s.add_dependency(%q<rspec>, ["~> 3.2"])
+    s.add_dependency(%q<cucumber>, ["~> 2.0"])
+    s.add_dependency(%q<aruba>, ["= 0.6.2"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<rubocop>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 4.2.0"])
+    s.add_dependency(%q<yard>, ["~> 0.8.7"])
+    s.add_dependency(%q<redcarpet>, [">= 0"])
+  end
+end
+

data/features/.nav

@@ -0,0 +1 @@
+- inventory.feature

data/features/README.md

@@ -0,0 +1,35 @@
+ansibler is a Ruby gem for reading and writing Ansible files.
+
+## tl;dr
+
+Given an `inventory_file` that contains:
+
+```
+ip-172-31-6-85
+ip-172-31-3-134 ansible_ssh_host=172.31.3.134 ansible_ssh_user=ubuntu
+
+[mysql]
+ip-172-31-3-134
+```
+
+Then
+
+```ruby
+inventory = Ansible::Inventory.read_file('inventory_file')
+inventory.hosts.count # => 2
+inventory.hosts.first.name # => "ip-172-31-6-85"
+inventory.hosts.last.vars.count # => 2
+inventory.hosts.last.vars['ansible_ssh_host'] # => "172.31.3.134"
+inventory.groups.count # => 1
+inventory.groups.first.name # => "mysql"
+inventory.groups.first.hosts.first.vars['ansible_ssh_user'] # => "ubuntu"
+```
+
+## Use the source
+
+https://github.com/aisrael/ansibler
+
+## Copyright
+
+Copyright (c) 2015 Alistair A. Israel. See LICENSE.txt for
+further details.

data/features/inventory.feature

@@ -0,0 +1,81 @@
+Feature: Inventory
+  In order to read and write Ansible inventory files
+
+  Scenario: read a simple inventory file
+    Given an Ansible inventory file containing:
+      """
+      ip-172-31-6-85
+      ip-172-31-3-134
+      """
+    When we read the Ansible inventory file using Ansible::Inventory.read_file
+    Then `hosts.count` should be 2
+    And `hosts.first.name` should be "ip-172-31-6-85"
+    And `hosts.last.name` should be "ip-172-31-3-134"
+
+  Scenario: read an inventory file with host variables
+    Given an Ansible inventory file containing:
+      """
+      ip-172-31-6-85 ansible_ssh_host=172.31.6.85 ansible_ssh_user=ubuntu ansible_ssh_private_key_file=aws_private_key.pem
+      ip-172-31-3-134 ansible_ssh_host=172.31.3.134 ansible_ssh_user=ubuntu ansible_ssh_private_key_file=aws_private_key.pem
+      """
+    When we read the Ansible inventory file using Ansible::Inventory.read_file
+    And `hosts.first.name` should be "ip-172-31-6-85"
+    And `hosts.first.vars['ansible_ssh_private_key_file']` should be "aws_private_key.pem"
+    And `hosts.last.vars['ansible_ssh_user']` should be "ubuntu"
+
+  Scenario: read an inventory file with hosts and groups
+    Given an Ansible inventory file containing:
+      """
+      ip-172-31-6-85
+      ip-172-31-3-134 ansible_ssh_host=172.31.3.134 ansible_ssh_user=ubuntu ansible_ssh_private_key_file=aws_private_key.pem
+
+      [mysql]
+      ip-172-31-3-134
+      """
+    When we read the Ansible inventory file using Ansible::Inventory.read_file
+    Then `groups.count` should be 1
+    And the first group's name should be "mysql"
+    And the first group should have 1 host
+    And `groups.first.hosts.first.name` should be "ip-172-31-3-134"
+    And `groups.first.hosts.first.vars['ansible_ssh_user']` should be "ubuntu"
+
+  Scenario: read an inventory file with group variables
+    Given an Ansible inventory file containing:
+      """
+      ip-172-31-6-85
+
+      [mysql]
+      ip-172-31-6-85
+
+      [mysql:vars]
+      mysql_root_password=secret
+      mysql_user_name=mysql
+      mysql_user_password=mysql
+      """
+    When we read the Ansible inventory file using Ansible::Inventory.read_file
+    Then `groups.count` should be 1
+    And the first group's name should be "mysql"
+    And the first group should have 3 vars
+    And `groups.first.vars.keys.first` should be "mysql_root_password"
+    And `groups.first.vars['mysql_user_name']` should be "mysql"
+
+  Scenario: write an inventory file using Ansible::Inventory methods
+    Given the following code snippet:
+      """
+      inventory = Ansible::Inventory.new
+      host = inventory.hosts.add 'ip-172-31-3-134', ansible_ssh_host: '172.31.3.134'
+      mysql_group = inventory.groups.add 'mysql'
+      mysql_group.hosts.add host
+      mysql_group.vars['mysql_root_password'] = 'secret'
+      inventory.write_file('ansible_inventory')
+      """
+    Then the file "ansible_inventory" should contain:
+      """
+      ip-172-31-3-134 ansible_ssh_host=172.31.3.134
+
+      [mysql]
+      ip-172-31-3-134
+
+      [mysql:vars]
+      mysql_root_password=secret
+      """

data/features/step_definitions/inventory_steps.rb

@@ -1,12 +1,11 @@
-Given /^an Ansible inventory file containing$/ do |body|
-  @ansible_inventory_file = Tempfile.open('ansibler-') do |f|
-    f.write body
-    f
-  end
+WORKING_DIR = File.join %w(tmp aruba)
+
+Given /^an Ansible inventory file containing:$/ do |contents|
+  step 'a file named "ansible_inventory" with:', contents
 end
 
-When(/^we read the file using Ansible::Inventory\.read_file$/) do
-  @ansible_inventory = Ansible::Inventory.read_file(@ansible_inventory_file.path)
+When(/^we read the Ansible inventory file using Ansible::Inventory\.read_file$/) do
+  @ansible_inventory = Ansible::Inventory.read_file(File.join WORKING_DIR, 'ansible_inventory')
 end
 
 Then(/^`(\S+)` should be (\d+)$/) do |something, value|
@@ -30,6 +29,22 @@ end
 
 Then(/^the (first|last) (\S+) should have (\d+) (\S+)$/) do |first_or_last, collection, n, sub_collection|
   steps %Q{
-    Then `#{collection}s.#{first_or_last}.#{sub_collection}s.count` should be #{n}
+    Then `#{collection}s.#{first_or_last}.#{sub_collection.pluralize}.count` should be #{n}
   }
-end
+end
+
+def in_dir(dir, &block)
+  pwd = Dir.pwd
+  begin
+    Dir.chdir dir
+    block.call
+  ensure
+    Dir.chdir pwd
+  end
+end
+
+Given(/^the following code snippet:$/) do |snippet|
+  in_dir WORKING_DIR do
+    eval snippet
+  end
+end

data/features/support/env.rb

@@ -2,3 +2,6 @@
 $: << File.expand_path(File.join('..', '..', '..', 'lib'), __FILE__)
 
 require 'ansibler'
+
+require 'active_support/all'
+require 'aruba/cucumber'

data/lib/ansible/inventory.rb

@@ -6,35 +6,73 @@ module Ansible
       def read_file(file)
         inventory = Inventory.new
         last_group = nil
+        in_vars = false
         File.foreach(file) do |line|
           case
           when line =~ /^\[\S+\]$/
             group_name = line[/^\[(\S+)\]$/, 1]
-            last_group = Group.new group_name
-            inventory.groups << last_group
+            in_vars = group_name.end_with?(':vars')
+            if in_vars
+              actual_group_name = group_name[0, group_name.index(':')]
+              last_group = inventory.groups.find { |g| g.name == actual_group_name }
+              last_group ||= inventory.groups.add(actual_group_name)
+            else
+              last_group = inventory.groups.add(group_name)
+            end
           when line =~ /^\s*[^\[]\S+\s*(\S+=\S+\s*)*$/
             host_name, *rest = line.split
-            vars = Hash[rest.map {|s| s.split('=')}]
-            if last_group
-              host = inventory.hosts.find {|h| h.name == host_name} || Host.new(host_name, vars)
-              last_group.hosts << host
+            if in_vars && host_name.index('=') && rest.empty?
+              k, v = host_name.split('=')
+              last_group.vars[k] = v
             else
-              host = Host.new host_name, vars
-              inventory.hosts << host
+              vars = Hash[rest.map {|s| s.split('=')}]
+              if last_group
+                host = inventory.hosts.find {|h| h.name == host_name} || Host.new(host_name, vars)
+                last_group.hosts << host
+              else
+                inventory.hosts.add host_name, vars
+              end
             end
-
+          else
+            puts line
           end
         end
         inventory
       end
     end
 
+    def write_file(file)
+      File.open(file, 'w') do |f|
+        hosts.each {|host|
+          f.puts ([host.name] + host.vars.map {|k, v| "#{k}=#{v}"}).join(' ')
+        }
+        groups.each {|group|
+          f.puts
+          f.puts "[#{group.name}]"
+          group.hosts.each {|host|
+            if hosts.find {|h| h == host }
+              f.puts host.name
+            else
+              f.puts ([host.name] + host.vars.map {|k, v| "#{k}=#{v}"}).join(' ')
+            end
+          }
+          unless group.vars.empty?
+            f.puts
+            f.puts "[#{group.name}:vars]"
+            group.vars.each {|k, v|
+              f.puts "#{k}=#{v}"
+            }
+          end
+        }
+      end
+    end
+
     attr_reader :hosts
     attr_reader :groups
 
     def initialize
-      @hosts = []
-      @groups = []
+      @hosts = Host::Collection.new
+      @groups = Group::Collection.new
     end
 
     class Host < Struct.new :name, :vars
@@ -42,14 +80,31 @@ module Ansible
         super
         self.vars = {} unless vars
       end
+      class Collection < Array
+        def add(*args)
+          host = if args.first.is_a?(Host)
+            args.first
+          else
+            Host.new(*args)
+          end
+          self << host
+          host
+        end
+      end
     end
 
     class Group < Struct.new :name, :hosts, :vars
       def initialize(*args)
         super
-        self.hosts = [] unless hosts
+        self.hosts = Host::Collection.new unless hosts
         self.vars = {} unless vars
       end
+      class Collection < Array
+        def add(*args)
+          self << group = Group.new(*args)
+          group
+        end
+      end
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ansibler
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alistair A. Israel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-19 00:00:00.000000000 Z
+date: 2015-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -67,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 0.6.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: 0.6.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -159,16 +173,16 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- ".ruby-gemset"
-- ".ruby-version"
-- ".yardopts"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - VERSION
-- features/inventory.features
+- ansibler.gemspec
+- features/.nav
+- features/README.md
+- features/inventory.feature
 - features/step_definitions/inventory_steps.rb
 - features/support/env.rb
 - lib/ansible/inventory.rb
@@ -197,5 +211,8 @@ rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Ruby gem for reading and writing Ansible files
-test_files: []
-has_rdoc: 
+test_files:
+- features/README.md
+- features/inventory.feature
+- features/step_definitions/inventory_steps.rb
+- features/support/env.rb

data/.ruby-gemset

@@ -1 +0,0 @@
-ansibler

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.2.2

data/.yardopts

@@ -1 +0,0 @@
---markup markdown

data/features/inventory.features

@@ -1,40 +0,0 @@
-Feature: Inventory
-  In order to read and write Ansible inventory files
-
-  Scenario: read a simple inventory file
-    Given an Ansible inventory file containing
-      """
-      ip-172-31-6-85
-      ip-172-31-3-134
-      """
-    When we read the file using Ansible::Inventory.read_file
-    Then `hosts.count` should be 2
-    And `hosts.first.name` should be "ip-172-31-6-85"
-    And `hosts.last.name` should be "ip-172-31-3-134"
-
-  Scenario: read an inventory file with host variables
-    Given an Ansible inventory file containing
-      """
-      ip-172-31-6-85 ansible_ssh_host=172.31.6.85 ansible_ssh_user=ubuntu ansible_ssh_private_key_file=aws_private_key.pem
-      ip-172-31-3-134 ansible_ssh_host=172.31.3.134 ansible_ssh_user=ubuntu ansible_ssh_private_key_file=aws_private_key.pem
-      """
-    When we read the file using Ansible::Inventory.read_file
-    And `hosts.first.name` should be "ip-172-31-6-85"
-    And `hosts.first.vars['ansible_ssh_private_key_file']` should be "aws_private_key.pem"
-    And `hosts.last.vars['ansible_ssh_user']` should be "ubuntu"
-
-  Scenario: read an inventory file with hosts and groups
-    Given an Ansible inventory file containing
-      """
-      ip-172-31-6-85
-      ip-172-31-3-134 ansible_ssh_host=172.31.3.134 ansible_ssh_user=ubuntu ansible_ssh_private_key_file=aws_private_key.pem
-
-      [mysql]
-      ip-172-31-3-134
-      """
-    When we read the file using Ansible::Inventory.read_file
-    Then `groups.count` should be 1
-    And the first group's name should be "mysql"
-    And the first group should have 1 host
-    And `groups.first.hosts.first.name` should be "ip-172-31-3-134"
-    And `groups.first.hosts.first.vars['ansible_ssh_user']` should be "ubuntu"