ansibler 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 95e7c9a2379c008caf95e317891315d9ebc67971
-  data.tar.gz: f01f321426e0223a86cc0af1ffa88ef3ac281f1e
+  metadata.gz: 482625d6227526cbebcd9444ef8293fe7ce71bd6
+  data.tar.gz: 93d2b3aa918400c7488bf59f09d34fb3d9f202f9
 SHA512:
-  metadata.gz: c907bed830f960cb561411749c7dbc466c3193a64bf2fc53457136013edf6b761ade574dbee1cf253e7e4fa47e9bea550d78285de45ca4aac850f8c56618b351
-  data.tar.gz: 0a096596765d08339431d1720163e15dd84b08ed8cffcf7c5f6c50a23a3baaaf507c8da51f520c878f30895ce7b5c799972ce2cbd6efb9be8909b5dad18f537d
+  metadata.gz: fac162d7e116d451d2c9270c32fe5a51352e2e307a465ac1e7dff50991c1ea22b43feab5d6eba21fcee3da596568fc41406a416cf0abf72d29c9c22c6b34cff4
+  data.tar.gz: 03ae7b896d9b3c7555e76d9f0d66c0d8f9e44489678797b09a1c9e8b2023b157f3f75e4b163b4311a27d230d1aafbaa32d31048f8ea8f8655e962e7396abc76e

data/Gemfile

@@ -15,7 +15,7 @@ group :development do
   gem 'aruba', '0.6.2'
 
   # Code coverage using simplecov
-  gem 'simplecov', '>= 0'
+  gem 'simplecov', '>= 0', require: false
 
   # Code style checking
   gem 'rubocop'

data/README.md

@@ -7,11 +7,11 @@ ansibler is a Ruby gem for reading and writing Ansible files.
 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
+host1
+host2 ansible_ssh_host=172.31.3.134 ansible_ssh_user=ubuntu
 
 [mysql]
-ip-172-31-3-134
+host2
 ```
 
 Then
@@ -19,7 +19,7 @@ Then
 ```ruby
 inventory = Ansible::Inventory.read_file('inventory_file')
 inventory.hosts.count # => 2
-inventory.hosts.first.name # => "ip-172-31-6-85"
+inventory.hosts.first.name # => "host1"
 inventory.hosts.last.vars.count # => 2
 inventory.hosts.last.vars['ansible_ssh_host'] # => "172.31.3.134"
 inventory.groups.count # => 1

data/Rakefile

@@ -32,13 +32,13 @@ Jeweler::RubygemsDotOrgTasks.new
 require 'cucumber'
 require 'cucumber/rake/task'
 Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = %w(features/*.feature --format pretty)
+  t.cucumber_opts = '--format pretty'
 end
 
 desc 'Code coverage detail'
 task :simplecov do
   ENV['COVERAGE'] = 'true'
-  Rake::Task['test'].execute
+  Rake::Task['features'].execute
 end
 
 task :default => :features

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/ansibler.gemspec

@@ -2,16 +2,16 @@
 # 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
+# stub: ansibler 0.2.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "ansibler"
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   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.date = "2015-05-22"
   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 = [
@@ -28,8 +28,9 @@ Gem::Specification.new do |s|
     "ansibler.gemspec",
     "features/.nav",
     "features/README.md",
-    "features/inventory.feature",
-    "features/step_definitions/inventory_steps.rb",
+    "features/inventory/reading.feature",
+    "features/inventory/writing.feature",
+    "features/step_definitions/common_steps.rb",
     "features/support/env.rb",
     "lib/ansible/inventory.rb",
     "lib/ansibler.rb"
@@ -38,7 +39,7 @@ Gem::Specification.new do |s|
   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"]
+  s.test_files = ["features/README.md", "features/inventory/reading.feature", "features/inventory/writing.feature", "features/step_definitions/common_steps.rb", "features/support/env.rb"]
 
   if s.respond_to? :specification_version then
     s.specification_version = 4

data/features/.nav

@@ -1 +1,3 @@
-- inventory.feature
+- inventory:
+  - reading.feature
+  - writing.feature

data/features/README.md

@@ -5,11 +5,11 @@ ansibler is a Ruby gem for reading and writing Ansible files.
 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
+host1
+host2 ansible_ssh_host=172.31.3.134 ansible_ssh_user=ubuntu
 
 [mysql]
-ip-172-31-3-134
+host2
 ```
 
 Then
@@ -17,7 +17,7 @@ Then
 ```ruby
 inventory = Ansible::Inventory.read_file('inventory_file')
 inventory.hosts.count # => 2
-inventory.hosts.first.name # => "ip-172-31-6-85"
+inventory.hosts.first.name # => "host1"
 inventory.hosts.last.vars.count # => 2
 inventory.hosts.last.vars['ansible_ssh_host'] # => "172.31.3.134"
 inventory.groups.count # => 1

data/features/inventory/reading.feature

@@ -0,0 +1,79 @@
+Feature: Inventory Reading
+  In order to read Ansible inventory files
+
+  Scenario: read a simple inventory file
+    Given an Ansible inventory file containing:
+      """ini
+      # comments are ignored
+      host1
+      host2
+      """
+    When we read the Ansible inventory file using Ansible::Inventory.read_file
+    Then there should be 2 hosts
+    And the first host's name should be `"host1"`
+    And the last host's name should be `"host2"`
+
+  Scenario: read an inventory file with host variables
+    Given an Ansible inventory file containing:
+      """ini
+      host1 ansible_ssh_user=ubuntu ansible_ssh_private_key_file=private_key.pem
+      host2 ansible_ssh_user=ubuntu ansible_ssh_private_key_file=private_key.pem
+      """
+    When we read the Ansible inventory file using Ansible::Inventory.read_file
+    And the first host's name should be `"host1"`
+    And `hosts.first.vars['ansible_ssh_private_key_file']` should be `"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:
+      """ini
+      host1
+      host2 ansible_ssh_user=ubuntu ansible_ssh_private_key_file=private_key.pem
+
+      [mysql]
+      host2
+      """
+    When we read the Ansible inventory file using Ansible::Inventory.read_file
+    Then there should be 1 group
+    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 `"host2"`
+    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:
+      """ini
+      host1
+
+      [mysql]
+      host1
+
+      [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 there should be 1 group
+    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: read an inventory file with group children
+    Given an Ansible inventory file containing:
+      """ini
+      host1
+
+      [mysql]
+      host1
+
+      [databases:children]
+      mysql
+      """
+    When we read the Ansible inventory file using Ansible::Inventory.read_file
+    Then there should be 2 groups
+    And the first group's name should be `"mysql"`
+    And the last group's name should be `"databases"`
+    And `groups['databases'].children.count` should be 1
+    And `groups['databases'].children.first` should be `"mysql"`

data/features/inventory/writing.feature

@@ -0,0 +1,29 @@
+Feature: Inventory Writing
+  In order to write Ansible inventory files
+
+  Scenario: write an inventory file using Ansible::Inventory methods
+    Given the following code snippet:
+      """ruby
+      inventory = Ansible::Inventory.new
+      host = inventory.hosts.add 'host1', ansible_ssh_host: '172.31.3.134'
+      mysql_group = inventory.groups.add 'mysql'
+      mysql_group.hosts.add host
+      mysql_group.hosts.add 'host2', ansible_ssh_host: '172.31.3.16'
+      mysql_group.vars['mysql_root_password'] = 'secret'
+      inventory.groups.add('databases').children << 'mysql'
+      inventory.write_file('ansible_inventory')
+      """
+    Then the file "ansible_inventory" should contain:
+      """ini
+      host1 ansible_ssh_host=172.31.3.134
+
+      [mysql]
+      host1
+      host2 ansible_ssh_host=172.31.3.16
+
+      [mysql:vars]
+      mysql_root_password=secret
+
+      [databases:children]
+      mysql
+      """

data/features/step_definitions/{inventory_steps.rb → common_steps.rb}

@@ -15,15 +15,19 @@ Then(/^`(\S+)` should be (\d+)$/) do |something, value|
   expect(actual).to eq(expected)
 end
 
-Then(/^`(\S+)` should be "(\S+)"$/) do |something, expected|
+Then(/^there should be (\d+) (\S+)$/) do |value, something|
+  step "`#{something.pluralize}.count` should be #{value}"
+end
+
+Then(/^`(\S+)` should be `"(\S+)"`$/) do |something, expected|
   # Yes, eval.
   actual = eval("@ansible_inventory.#{something}")
   expect(actual).to eq(expected)
 end
 
-Then(/^the (first|last) (\S+)'s (\S+) should be "([^"]*)"$/) do |first_or_last, collection, attribute, expected|
+Then(/^the (first|last) (\S+)'s (\S+) should be `"([^"]*)"`$/) do |first_or_last, collection, attribute, expected|
   steps %Q{
-    Then `#{collection}s.#{first_or_last}.#{attribute}` should be \"#{expected}\"
+    Then `#{collection}s.#{first_or_last}.#{attribute}` should be `\"#{expected}\"`
   }
 end
 

data/features/support/env.rb

@@ -1,3 +1,8 @@
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start
+end
+
 # Add this gem's lib path to the $LOAD_PATH
 $: << File.expand_path(File.join('..', '..', '..', 'lib'), __FILE__)
 

data/lib/ansible/inventory.rb

@@ -7,21 +7,27 @@ module Ansible
         inventory = Inventory.new
         last_group = nil
         in_vars = false
+        in_children = false
         File.foreach(file) do |line|
           case
-          when line =~ /^\[\S+\]$/
+          when line =~ /^\s*#/
+            next
+          # [group:vars] or [group:chidren]
+          when line =~ /^\[\S+:(vars|children)\]$/
+            group_name, vars_or_children = line[/^\[(\S+)\]$/, 1].split(':')
+            in_vars = vars_or_children == 'vars'
+            in_children = vars_or_children == 'children'
+            last_group = inventory.groups[group_name] || inventory.groups.add(group_name)
+          # [group]
+          when line =~ /^\[[^:]+\]$/
             group_name = line[/^\[(\S+)\]$/, 1]
-            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
+            last_group = inventory.groups.add(group_name)
           when line =~ /^\s*[^\[]\S+\s*(\S+=\S+\s*)*$/
             host_name, *rest = line.split
-            if in_vars && host_name.index('=') && rest.empty?
+            if in_children && rest.empty?
+              child_group = inventory.groups[host_name] || inventory.groups.add(host_name)
+              last_group.children << child_group.name
+            elsif in_vars && host_name.index('=') && rest.empty?
               k, v = host_name.split('=')
               last_group.vars[k] = v
             else
@@ -47,15 +53,17 @@ module Ansible
           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.hosts.empty?
+            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
+            }
+          end
           unless group.vars.empty?
             f.puts
             f.puts "[#{group.name}:vars]"
@@ -63,6 +71,11 @@ module Ansible
               f.puts "#{k}=#{v}"
             }
           end
+          unless group.children.empty?
+            f.puts
+            f.puts "[#{group.name}:children]"
+            group.children.each {|s| f.puts s}
+          end
         }
       end
     end
@@ -93,17 +106,21 @@ module Ansible
       end
     end
 
-    class Group < Struct.new :name, :hosts, :vars
+    class Group < Struct.new :name, :hosts, :vars, :children
       def initialize(*args)
         super
         self.hosts = Host::Collection.new unless hosts
         self.vars = {} unless vars
+        self.children = []
       end
       class Collection < Array
         def add(*args)
           self << group = Group.new(*args)
           group
         end
+        def [](name)
+          find {|group| group.name == name}
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ansibler
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Alistair A. Israel
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-20 00:00:00.000000000 Z
+date: 2015-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -182,8 +182,9 @@ files:
 - ansibler.gemspec
 - features/.nav
 - features/README.md
-- features/inventory.feature
-- features/step_definitions/inventory_steps.rb
+- features/inventory/reading.feature
+- features/inventory/writing.feature
+- features/step_definitions/common_steps.rb
 - features/support/env.rb
 - lib/ansible/inventory.rb
 - lib/ansibler.rb
@@ -213,6 +214,7 @@ specification_version: 4
 summary: Ruby gem for reading and writing Ansible files
 test_files:
 - features/README.md
-- features/inventory.feature
-- features/step_definitions/inventory_steps.rb
+- features/inventory/reading.feature
+- features/inventory/writing.feature
+- features/step_definitions/common_steps.rb
 - features/support/env.rb

data/features/inventory.feature

@@ -1,81 +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 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
-      """