ruby-puppetdb 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06d30fe03dc440c05f38f596006a7fe936ae8b21
-  data.tar.gz: 81ce06c2b619e6784d5b9c1aa0f87909bd30f602
+  metadata.gz: 9ed96d47f9a2eae2e54dccea8d9961cd185d0631
+  data.tar.gz: dc1ba65a4259f59d583dda883957b3bc5127df4a
 SHA512:
-  metadata.gz: 2e7675f6543e5a22395b54461f8529ee61b84ffd09cc9146ce83bc2f1d1ef3930a301384b1d5431bf8564244a66adef5e988e80b4674b62d69f8c06eccca4985
-  data.tar.gz: 1cbe4bf2114a646c0a09eee902c0247cf79e76782f24ea9f785011968bb93153fb203700370823e06089bfeb96aedc77be400752f07aaeadc1a168561ae120f0
+  metadata.gz: 15f7ae9d9c39d487f772ea24d46229dfced946265d9fd52e5b7603a319eeb420c335d57ce618ab45344b47cfa10728645ddacf9a79d3b02ab6f6cb39ec961e94
+  data.tar.gz: 79e0500fd751c24e7ca74d5df6342d4eb76b8b2f1721672472d2d99832d6d4a87a654c49cd3c3a375aa327919f535bd3099d926b925171ccf5559d8159b95f85

data/lib/puppet/face/query.rb

@@ -48,11 +48,13 @@ Puppet::Face.define(:query, '1.0.0') do
       puppetdb = PuppetDB::Connection.new options[:host], options[:port], !options[:no_ssl]
       parser = PuppetDB::Parser.new
       if options[:facts] != ''
-        factquery = parser.facts_query(query, options[:facts].split(','))
+        facts = options[:facts].split(',')
+        factquery = parser.facts_query(query, facts)
       else
+        facts = [:all]
         factquery = parser.parse(query, :facts)
       end
-      parser.facts_hash(puppetdb.query(:facts, factquery, :extract => [:certname, :name, :value]))
+      parser.facts_hash(puppetdb.query(:facts, factquery, :extract => [:certname, :name, :value]), facts)
     end
   end
 

data/lib/puppet/parser/functions/query_facts.rb

@@ -15,6 +15,8 @@ Puppet::Parser::Functions.newfunction(:query_facts, :type => :rvalue, :arity =>
 EOT
                                      ) do |args|
   query, facts = args
+  facts = facts.map { |fact| fact.match(/\./) ? fact.split('.') : fact }
+  facts_for_query = facts.map { |fact| fact.is_a?(Array) ? fact.first : fact }
 
   require 'puppet/util/puppetdb'
 
@@ -31,6 +33,6 @@ EOT
   uri = URI(Puppet::Util::Puppetdb.config.server_urls.first)
   puppetdb = PuppetDB::Connection.new(uri.host, uri.port, uri.scheme == 'https')
   parser = PuppetDB::Parser.new
-  query = parser.facts_query query, facts if query.is_a? String
-  parser.facts_hash(puppetdb.query(:facts, query, :extract => [:certname, :name, :value]))
+  query = parser.facts_query query, facts_for_query if query.is_a? String
+  parser.facts_hash(puppetdb.query(:facts, query, :extract => [:certname, :name, :value]), facts)
 end

data/lib/puppet/parser/functions/query_nodes.rb

@@ -1,17 +1,23 @@
 Puppet::Parser::Functions.newfunction(:query_nodes, :type => :rvalue, :arity => -2, :doc => <<-EOT
 
-  accepts two arguments, a query used to discover nodes, and a optional
+  accepts two arguments, a query used to discover nodes, and an optional
   fact that should be returned.
 
   The query specified should conform to the following format:
     (Type[title] and fact_name<operator>fact_value) or ...
     Package["mysql-server"] and cluster_id=my_first_cluster
 
-  The second argument should be single fact (this argument is optional)
+  The second argument should be single fact or series of keys joined on periods
+  (this argument is optional)
 
 EOT
                                      ) do |args|
   query, fact = args
+  fact_for_query = if fact && fact.match(/\./)
+                     fact.split('.').first
+                   else
+                     fact
+                   end
 
   require 'puppet/util/puppetdb'
 
@@ -28,9 +34,15 @@ EOT
   uri = URI(Puppet::Util::Puppetdb.config.server_urls.first)
   puppetdb = PuppetDB::Connection.new(uri.host, uri.port, uri.scheme == 'https')
   parser = PuppetDB::Parser.new
-  if fact
-    query = parser.facts_query(query, [fact])
-    puppetdb.query(:facts, query, :extract => :value).collect { |f| f['value'] }
+  if fact_for_query
+    query = parser.facts_query(query, [fact_for_query])
+    response = puppetdb.query(:facts, query, :extract => :value)
+
+    if fact.split('.').size > 1
+      parser.extract_nested_fact(response, fact.split('.')[1..-1])
+    else
+      response.collect { |f| f['value'] }
+    end
   else
     query = parser.parse(query, :nodes) if query.is_a? String
     puppetdb.query(:nodes, query, :extract => :certname).collect { |n| n['certname'] }

data/lib/puppet/parser/functions/query_resources.rb

@@ -68,6 +68,7 @@ EOT
     results.reduce({}) do |ret, resource|
       ret[resource['certname']] = [] unless ret.key? resource['certname']
       ret[resource['certname']] << resource
+      ret
     end
   else
     results

data/lib/puppetdb.rb

@@ -1,4 +1,4 @@
 module PuppetDB
   # Current version of this module
-  VERSION = [2, 1, 1]
+  VERSION ||= [2, 2, 0]
 end

data/lib/puppetdb/parser_helper.rb

@@ -22,7 +22,13 @@ module PuppetDB::ParserHelper
     if facts.nil?
       nodequery
     else
-      factquery = ['or', *facts.collect { |f| ['=', 'name', f] }]
+      factquery = ['or', *facts.collect { |f|
+         if (f =~ /^\/(.+)\/$/)
+            ['~', 'name', f.scan(/^\/(.+)\/$/).last.first]
+         else
+            ['=', 'name', f]
+         end
+      }]
       if nodequery
         ['and', nodequery, factquery]
       else
@@ -33,19 +39,60 @@ module PuppetDB::ParserHelper
 
   # Turn an array of facts into a hash of nodes containing facts
   #
-  # @param facts [Array] fact values
+  # @param fact_hash [Array] fact values
+  # @param facts [Array] fact names
   # @return [Hash] nodes as keys containing a hash of facts as value
-  def facts_hash(facts)
-    facts.reduce({}) do |ret, fact|
+  def facts_hash(fact_hash, facts)
+    fact_hash.reduce({}) do |ret, fact|
+      # Array#include? only matches on values of the same type, so if we find
+      # a matching string, it's not a nested query.
+      name, value = if facts.include?(fact['name']) || facts == [:all]
+                      [fact['name'], fact['value']]
+                    else
+                      # Find the set of keys where the first value is the fact name
+                      nested_keys = facts.select do |x|
+                        x.is_a?(Array) && x.first == fact['name']
+                      end.flatten
+
+                      # Join all the key names together with an underscore to give
+                      # us a unique name, and then send all the keys but the fact
+                      # name (which was already queried out) to extract_nested_fact
+                      [
+                        nested_keys.join("_"),
+                        extract_nested_fact([fact], nested_keys[1..-1]).first
+                      ]
+                    end
+
       if ret.include? fact['certname']
-        ret[fact['certname']][fact['name']] = fact['value']
+        ret[fact['certname']][name] = value
       else
-        ret[fact['certname']] = { fact['name'] => fact['value'] }
+        ret[fact['certname']] = { name => value }
       end
       ret
     end
   end
 
+  # Take an array of hashes of fact hashes and get a nested value from each
+  # of them.
+  #
+  # @param fact_hashes [Array] an array of hashes of fact hashes
+  # @param keys [Array] an array of keys to dig into the hash
+  # @returt [Array] an array of extracted values
+  def extract_nested_fact(fact_hashes, keys)
+    fact_hashes.map do |fact_hash|
+      hash = fact_hash['value']
+
+      # Traverse the hash, setting `hash` equal to the next level deep each step
+      keys[0..-2].each do |key|
+        hash = hash.fetch(key, {})
+      end
+
+      # Lookup the final key. This will convert to nil if we've been defaulting
+      # to empty hash beforehand.
+      hash[keys.last]
+    end
+  end
+
   # Turn a query into one for only certain fields
   def self.extract(*field, query)
     ['extract', field.collect(&:to_s), query]

data/spec/functions/query_facts_spec.rb

@@ -12,4 +12,43 @@ describe 'query_facts' do
       ]
     should run.with_params('', ['ipaddress']).and_return('apache4.puppetexplorer.io' => { 'ipaddress' => '172.31.6.80' })
   end
+
+  it do
+    PuppetDB::Connection.any_instance.expects(:query)
+      .with(:facts, ['or', ['=', 'name', 'ipaddress'], ['=', 'name', 'network_eth0']], {:extract => [:certname, :name, :value]})
+      .returns [
+        { 'certname' => 'apache4.puppetexplorer.io', 'environment' => 'production', 'name' => 'ipaddress', 'value' => '172.31.6.80' },
+        { 'certname' => 'apache4.puppetexplorer.io', 'environment' => 'production', 'name' => 'network_eth0', 'value' => '172.31.0.0' }
+      ]
+    should run.with_params('', ['ipaddress', 'network_eth0']).and_return('apache4.puppetexplorer.io' => { 'ipaddress' => '172.31.6.80', 'network_eth0' => '172.31.0.0' })
+  end
+
+  context 'with a nested fact parameter' do
+    it do
+      PuppetDB::Connection.any_instance.expects(:query)
+        .with(:facts, ['or', ['=', 'name', 'ipaddress'], ['=', 'name', 'networking']], {:extract => [:certname, :name, :value]})
+        .returns [
+          { 'certname' => 'apache4.puppetexplorer.io', 'environment' => 'production', 'name' => 'ipaddress', 'value' => '172.31.6.80' },
+          {
+            'certname' => 'apache4.puppetexplorer.io',
+            'environment' => 'production',
+            'name' => 'networking',
+            'value' => {
+              'interfaces' => {
+                'eth0' => {
+                  'ip' => '172.31.6.80',
+                  'network' => '172.31.0.0',
+                },
+                'eth1' => {
+                  'ip' => '172.32.6.80',
+                  'network' => '172.32.0.0',
+                },
+                'bond0' => {},
+              }
+            }
+          }
+        ]
+      should run.with_params('', ['ipaddress', 'networking.interfaces.eth0.ip']).and_return('apache4.puppetexplorer.io' => { 'ipaddress' => '172.31.6.80', 'networking_interfaces_eth0_ip' => '172.31.6.80' })
+    end
+  end
 end

data/spec/functions/query_nodes_spec.rb

@@ -1,6 +1,7 @@
 #! /usr/bin/env ruby -S rspec
 
 require 'spec_helper'
+require 'puppetdb/connection'
 
 describe 'query_nodes' do
   context 'without fact parameter' do
@@ -20,4 +21,54 @@ describe 'query_nodes' do
       should run.with_params('hostname="apache4"', 'ipaddress').and_return(['172.31.6.80'])
     end
   end
+
+  context 'with a nested fact parameter' do
+    it do
+      PuppetDB::Connection.any_instance.expects(:query)
+        .with(:facts, ['and', ['in', 'certname', ['extract', 'certname', ['select_fact_contents', ['and', ['=', 'path', ['hostname']], ['=', 'value', 'apache4']]]]], ['or', ['=', 'name', 'networking']]], :extract => :value)
+        .returns [
+          {
+            'value' => {
+              'interfaces' => {
+                'eth0' => {
+                  'ip' => '172.31.6.80',
+                  'network' => '172.31.0.0',
+                },
+                'eth1' => {
+                  'ip' => '172.32.6.80',
+                  'network' => '172.32.0.0',
+                },
+                'bond0' => {},
+              }
+            }
+          }
+        ]
+      should run.with_params('hostname="apache4"', 'networking.interfaces.eth1.ip').and_return(['172.32.6.80'])
+    end
+  end
+
+  context 'with a missing nested fact parameter' do
+    it do
+      PuppetDB::Connection.any_instance.expects(:query)
+        .with(:facts, ['and', ['in', 'certname', ['extract', 'certname', ['select_fact_contents', ['and', ['=', 'path', ['hostname']], ['=', 'value', 'apache4']]]]], ['or', ['=', 'name', 'networking']]], :extract => :value)
+        .returns [
+          {
+            'value' => {
+              'interfaces' => {
+                'eth0' => {
+                  'ip' => '172.31.6.80',
+                  'network' => '172.31.0.0',
+                },
+                'eth1' => {
+                  'ip' => '172.32.6.80',
+                  'network' => '172.32.0.0',
+                },
+                'bond0' => {},
+              }
+            }
+          }
+        ]
+      should run.with_params('hostname="apache4"', 'networking.interfaces.missing_interface.ip').and_return([nil])
+    end
+  end
 end

data/spec/unit/puppetdb/parser_spec.rb

@@ -215,12 +215,24 @@ describe PuppetDB::Parser do
         { 'certname' => 'ip-172-31-45-32.eu-west-1.compute.internal', 'environment' => 'production', 'name' => 'fqdn', 'value' => 'ip-172-31-45-32.eu-west-1.compute.internal' },
         { 'certname' => 'ip-172-31-33-234.eu-west-1.compute.internal', 'environment' => 'production', 'name' => 'fqdn', 'value' => 'ip-172-31-33-234.eu-west-1.compute.internal' },
         { 'certname' => 'ip-172-31-5-147.eu-west-1.compute.internal', 'environment' => 'production', 'name' => 'fqdn', 'value' => 'ip-172-31-5-147.eu-west-1.compute.internal' }
-      ]).should eq(
+      ], ['kernel', 'fqdn']).should eq(
         'ip-172-31-45-32.eu-west-1.compute.internal' => { 'kernel' => 'Linux', 'fqdn' => 'ip-172-31-45-32.eu-west-1.compute.internal' },
         'ip-172-31-33-234.eu-west-1.compute.internal' => { 'kernel' => 'Linux', 'fqdn' => 'ip-172-31-33-234.eu-west-1.compute.internal' },
         'ip-172-31-5-147.eu-west-1.compute.internal' => { 'kernel' => 'Linux', 'fqdn' => 'ip-172-31-5-147.eu-west-1.compute.internal' }
       )
     end
+
+    it 'should handle nested facts' do
+      parser.facts_hash([
+        { 'certname' => 'ip-172-31-45-32.eu-west-1.compute.internal', 'environment' => 'production', 'name' => 'kernel', 'value' => 'Linux' },
+        { 'certname' => 'ip-172-31-33-234.eu-west-1.compute.internal', 'environment' => 'production', 'name' => 'kernel', 'value' => 'Linux' },
+        { 'certname' => 'ip-172-31-45-32.eu-west-1.compute.internal', 'environment' => 'production', 'name' => 'networking', 'value' => { 'interfaces' => { 'eth0' => { 'ip' => '172.31.45.32' } } } },
+        { 'certname' => 'ip-172-31-33-234.eu-west-1.compute.internal', 'environment' => 'production', 'name' => 'networking', 'value' => { 'interfaces' => { 'eth0' => { 'ip' => '172.31.33.234' } } } },
+      ], ['kernel', ['networking', 'interfaces', 'eth0', 'ip']]).should eq(
+        'ip-172-31-45-32.eu-west-1.compute.internal' => { 'kernel' => 'Linux', 'networking_interfaces_eth0_ip' => '172.31.45.32' },
+        'ip-172-31-33-234.eu-west-1.compute.internal' => { 'kernel' => 'Linux', 'networking_interfaces_eth0_ip' => '172.31.33.234' },
+      )
+    end
   end
 
   context 'extract' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-puppetdb
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - Erik Dalen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-14 00:00:00.000000000 Z
+date: 2016-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -44,26 +44,32 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.13'
 - !ruby/object:Gem::Dependency
@@ -129,9 +135,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.4.12
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -139,9 +142,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.4.12
 - !ruby/object:Gem::Dependency
   name: rexical
   requirement: !ruby/object:Gem::Requirement
@@ -222,18 +222,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Query functions for PuppetDB
 test_files:
+- spec/spec_helper.rb
 - spec/functions/query_facts_spec.rb
 - spec/functions/query_nodes_spec.rb
 - spec/functions/query_resources_spec.rb
-- spec/puppet/util/puppetdb.rb
-- spec/spec_helper.rb
 - spec/unit/puppetdb/parser_spec.rb
+- spec/puppet/util/puppetdb.rb
 - examples/nova_functions.pp
 - examples/query_node_examples.pp
 - examples/query_resource_examples.pp
-has_rdoc: