yaml_inventory 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6f787b5f1fa42d80724b68f864d7c371b2ead3f
-  data.tar.gz: 4b109ce7234214eae8f3fb8c0465dcd38072a030
+  metadata.gz: 3b061deedfb691cd00330e2905ae3875636b1a5a
+  data.tar.gz: 7e124b6af2aa6c64294d15e258e179747bf9efa2
 SHA512:
-  metadata.gz: b6a5da00f79219e8be72f6fc31a7b6ab0f57a354f3c01f2124e559ba7ae717125ea32631aa360a4205f65ad7d0ca84593916fd8942e53db5cf7e4bd00d0322b3
-  data.tar.gz: d48b66e042273ea1b05625f1dc7b1c4df5906b868aa098c1869d902a6d63111de2b58d332ffa3a5ea80428944830059dcb07f302b0d3a87c3ae0ee264b5743a1
+  metadata.gz: 0a3549ee0d3ed75573aee0568c16f2be6f30faa02ff84c190d367259b359f40173748c7e6952fecce2f397017aaf9980542608d1bd5e7ea35f47356ab5d5aaf0
+  data.tar.gz: b4b7a6c6acac3110d9eab4e9a7bcee7d1b1cc02fef71f2edd7c0ed0c1452a7084bbcc21733a7b993b7422a92eebf72d42f752be9d7a91d0943e157f4f6e855c5

data/README.md

@@ -1,30 +1,61 @@
 # Ansible YAML Inventory
 
-Ansible inventory script for defining inventory using YAML files.
+Ansible inventory script for defining inventory using YAML files. YAML is pretty! And readily parseable in a a variety of languages other than Python, unlike the default `.ini` files ansible uses.
+
+It's adapated from the YAML inventory script which used to be part of ansible but isn't anymore.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Install with
 
-    gem 'yaml_inventory'
+    $ gem install yaml_inventory
 
-And then execute:
+## Usage
 
-    $ bundle
+Adds the `yaminv` command.
 
-Or install it yourself as:
+For help:
 
-    $ gem install yaml_inventory
+    $ yaminv --help
 
-## Usage
+### With Ansible
 
-  $ yaminv
+Create a `hosts.yml` file in your current dir, and use it like this
 
-  TODO: talk about usage.
+    $ ansible-playbook -i $(which yaminv) playbook.yml
 
-For help:
+When run with ansible-playbook it will always pick up the hosts.yml file in the current directory.
 
-    $ yaminv --help
+### Hosts File Format
+
+```yaml
+
+# standalone hosts are okay
+- standalonehost1
+- standalonehost2
+
+# host with vars
+- host: hostwithvars
+  vars:
+    - var1: hostvar1
+    - var2: hostvar2
+
+# group with vars and hosts
+- group: group2
+  vars:
+    - groupvar1: groupvar1
+  hosts:
+    - ghost1
+    - ghost2
+  groups:
+    - group1
+
+# subgroup
+- group: group1
+  hosts:
+    - host3
+    - hostwithvars
+```
 
 ## Contributing
 
@@ -33,3 +64,7 @@ For help:
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+### Tests
+
+Run with `rake test`

data/lib/yaml_inventory/parser.rb

@@ -8,13 +8,17 @@ module YAMLInventory
       @groups, @hosts = parse_hosts(inventory)
     end
 
-    def groups
+    def full
       Hash[@groups.map { |g| [g.name, { 
         :hosts => g.get_hosts.map(&:name),
         :vars => g.get_vars,
         :children => g.get_children.map(&:name) }]}]
     end
 
+    def groups
+      Hash[@groups.map { |g| [g.name, g.get_hosts.map(&:name)] }]
+    end
+
     def host(host_name)
       vars = @hosts.get_hosts.find { |h| h.name == host_name }.get_vars
       if @options[:extra]

data/lib/yaml_inventory/version.rb

@@ -1,3 +1,3 @@
 module YAMLInventory
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/fixtures/hosts.yml

@@ -1,37 +1,51 @@
-- standalonehost
-
-- notreallystandalonehost
-
-- myhost3
+# standalone hosts are okay
+- standalonehost1
+- standalonehost2
+- notstandalonehost
 
+# host with vars
 - host: hostwithvars
   vars:
-    - var1: hostvar1
-    - var2: hostvar2
-  groups:
-    - subgroup1
+    - hostvar1: hostvar1v
+    - hostvar2: hostvar2
+    - overriddenh: overriddenbyhost
 
-# - host: notreallystandalonehost
-#   vars:
-#     - var1: var1
-#     - var2: var2
-#   groups:
-#     - group1
-#     - group2
+- host: standalonehostwithvars
+  vars:
+    - hostvar3: hostvar3v
+    - hostvar4: hostvar4
 
-- group: explicitgroup
+# group with vars and hosts
+- group: group1
   vars:
-    - groupvar1: groupvar1
+    - group1var1: group1var1
+    - overriddenh: overridden
+    - overriddenhg: overridden
   hosts:
-    - notreallystandalonehost
-    - myhost2
+    - newhost
+    - hostwithvars
   groups:
-    - subgroup1
+    - exsubgroup
+#   - implicitsubgroup
 
-- group: subgroup1
+# explicit subgroup
+- group: exsubgroup
+  vars:
+    - exsubvar1: exsubvar1
+    - overriddenhg: overriddenbygroup
   hosts:
-    - myhost3
+    - notstandalonehost
 
+# doesn't work
 
-# - group: subgroup1
+# - host: subgrouphost
+#   vars:
+#     - subgrouphostvar1: subgrouphostvar1
+#   groups:
+#     - implicitsubgroup
 
+# doesn't work
+
+# - group: groupwithimpsub
+#   groups:
+#     - implicitsubgroup2

data/spec/yaml_inventory_spec.rb

@@ -3,17 +3,165 @@ require "pry"
 require "pp"
 
 describe YAMLInventory do
-  let(:inventory) do 
+  let(:inventory) do
     YAMLInventory::Parser.new(YAML.load_file("spec/fixtures/hosts.yml"))
   end
 
+  describe "#full" do
+    it "makes the right groups" do
+      groups = %w( group1 exsubgroup ungrouped )
+      inventory.full.keys.sort.must_equal groups.sort
+    end
+
+    describe "vars" do
+      it "supports setting vars" do
+        inventory.full["group1"][:vars]["group1var1"].must_equal "group1var1"
+        inventory.full["exsubgroup"][:vars]["exsubvar1"].must_equal "exsubvar1"
+      end
+
+      it "inherits vars from parent groups" do
+        inventory.full["exsubgroup"][:vars]["group1var1"].must_equal "group1var1"
+      end
+
+      it "overrides vars inherited from parent groups" do
+        inventory.full["group1"][:vars]["overriddenhg"].must_equal "overridden"
+        inventory.full["exsubgroup"][:vars]["overriddenhg"].must_equal "overriddenbygroup"
+      end
+
+      it "does not inherit vars from child groups" do
+        inventory.full["group1"][:vars]["exsubvar1"].must_be_nil
+      end
+
+      it "does not inherit vars from hosts" do
+        inventory.full["group1"][:vars]["hostvar1"].must_be_nil
+        inventory.full["group1"][:vars]["hostvar2"].must_be_nil
+      end
+
+      it "does not inherit vars from hosts" do
+        inventory.full["group1"][:vars]["hostvar1"].must_be_nil
+        inventory.full["group1"][:vars]["hostvar2"].must_be_nil
+      end
+    end
+
+    describe "hosts" do
+      it "supports setting undefined hosts" do
+        inventory.full["group1"][:hosts].must_include "newhost"
+      end
+
+      it "supports setting previously-defined hosts" do
+        inventory.full["group1"][:hosts].must_include "hostwithvars"
+        inventory.full["exsubgroup"][:hosts].must_include "notstandalonehost"
+      end
+
+      it "encompasses hosts from child groups" do
+        inventory.full["group1"][:hosts].must_include "notstandalonehost"
+      end
+
+      it "does not inherit hosts from parent groups" do
+        inventory.full["exsubgroup"][:hosts].wont_include "newhost"
+        inventory.full["exsubgroup"][:hosts].wont_include "hostwithvars"
+      end
+
+      it "allows defining groups within hosts" do
+        skip "Not implemented yet"
+      end
+
+      it "allows defining groups within groups" do
+        skip "Not implemented yet"
+      end
+    end
+
+    describe "groups" do
+      it "sets child groups" do
+        inventory.full["group1"][:children].must_include "exsubgroup"
+      end
+    end
+
+    describe "'ungrouped' group" do
+      subject do
+        inventory.full["ungrouped"]
+      end
+
+      let :standalones do
+        %w(standalonehost1 standalonehost2 standalonehostwithvars).sort
+      end
+
+      it "has hosts" do
+        subject[:hosts].wont_be_nil
+      end
+
+      it "contains only standalone hosts" do
+        subject[:hosts].sort.must_equal standalones
+      end
+
+      it "doesn't contain hosts that have groups" do
+        subject[:hosts].wont_include "notstandalonehost"
+      end
+
+      it "has no vars" do
+        subject[:vars].must_be_empty
+      end
+
+      it "has no children" do
+        subject[:children].must_be_empty
+      end
+    end
+
+  end
+
   describe "#groups" do
-    it "doesn't explode too hard" do
+    subject do
       inventory.groups
     end
+
+    it "puts the ungrouped ones into 'ungrouped'" do
+      subject["ungrouped"].sort.must_equal %w( standalonehost1 standalonehost2 standalonehostwithvars ).sort
+    end
+
+    it "collects subgroup hosts" do
+      subject["group1"].sort.must_equal %w( newhost hostwithvars notstandalonehost ).sort
+    end
+
+    it "doesn't collected supergroup hosts" do
+      subject["exsubgroup"].sort.must_equal %w( notstandalonehost ).sort
+    end
   end
 
   describe "#host" do
+    def host(hostname, var = nil)
+      h = inventory.host(hostname)
+      var ? h[var] : h
+    end
+
+    it "returns vars when they are set on hosts" do
+      host("hostwithvars", "hostvar1").must_equal "hostvar1v"
+      host("standalonehostwithvars", "hostvar3").must_equal "hostvar3v"
+    end
+
+    it "returns no vars for standalone hosts" do
+      host("standalonehost1").must_be_empty
+    end
+
+    it "inherits vars from groups" do
+      host("newhost", "group1var1").must_equal "group1var1"
+    end
+
+    it "inherits vars from parent groups" do
+      host("notstandalonehost", "group1var1").must_equal "group1var1"
+    end
+
+    it "overrides inherited vars with its own" do
+      host("hostwithvars", "overriddenh").must_equal "overriddenbyhost"
+    end
+
+    it "gives precedence to group vars from its most direct parent" do
+      host("notstandalonehost", "overriddenhg").must_equal "overriddenbygroup"
+    end
+
+    it "inherits group vars from ALL its parents" do
+      skip "No example yet"
+    end
+
     it "doesn't explode too hard" do
       inventory.host("hostwithvars")
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yaml_inventory
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Daniel Leavitt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-08 00:00:00.000000000 Z
+date: 2013-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler