ruby-puppetdb 2.0.3 → 2.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YmEzMGI0YWE2YjMyNmE5YmJlZTM0ZTEzNWU5NzVkYTk0MWQ5NjAyZg==
+    YjJmYWQ1NDc2ZDc4MGM4OGU1ZDhiZWFlNjI4NjdhZjJlNDMxNzFlYQ==
   data.tar.gz: !binary |-
-    NWVjOGNiOGM2Y2EzOWFiODRhNDQ2MTliZjBjZDUxNmQ4NTMyNDg5MQ==
+    MGJlNTZhNjVhNDI5OTY4YmMxNWUwNzYwN2VlM2MxYTNlOGFhZDIxZA==
 SHA512:
   metadata.gz: !binary |-
-    YmE1MGQ2N2ZiNDUwODg5ZTJkOTEzMzczYWUzNjg0OTU3NDc2ZjE4MGU3MGMz
-    OGQ0YTY0OTIxYWI4ZWMzMTcwMmIxYTJlZmNjOWIzMzZkMTNmNTFiZWRiYzQ5
-    MTBhNmIxNDg1M2VkMGY2MzQ1YTc5NDQyM2EwNDA2MDExOWNiNGE=
+    NjlmZDlmOWQyNzUyODNkZTdlN2U2MWEzMWQyMzFlYmIxMjY5Y2IwY2MyMzcz
+    ZWZiN2RlNzJjNmUwMzgyZmRiZDI5M2IxNGUzNDZlYzBjZTg5MjRhMTkzMjY5
+    OTdiZmQwNGRhNzRkMzI2MzlmYzZiZTRjZmFlZmZkMjU5MjEyNjQ=
   data.tar.gz: !binary |-
-    ZjE2YmViNDU3NDYyM2FlYzMwNzE3MDlmZDcyYjA3ZTc4NmVhNWEwNDU3YTRm
-    Zjk2NjY1ZjFmYzg3YjYyYzljZGMwYmVmMWQ2Njk0NjgzMzFmY2QxNDg3ZGY1
-    ZjkwZTJkY2U0ZGVlZjg3NWI0OTAwNmQzZjQ1ZWM1MzYzNmQyODU=
+    N2EzMjFkMTU3ZmRlNGQ3YjM0MDJiN2E4YmQ0NmNmZjU3NjE2ZDU4ZTAyNzhh
+    YjNkNDI3ZWM4YzY3M2Y5MmI2ZWFmMzU2NjE3ZmIzYTJiZTM5YTUxMGExMjU4
+    OTJlZTZkMDBkYWJiMTNhNzBlYTgyZTc0YWM4Njc4NjYxMmFlODk=

data/bin/find-nodes

@@ -61,12 +61,12 @@ if options[:print]
   puts query.to_json
 elsif options[:facts]
   query = parser.facts_query(options[:query], options[:facts])
-  parser.facts_hash(puppetdb.query(:facts, query, http)).each_value do |host|
+  parser.facts_hash(puppetdb.query(:facts, query, :extract => [:name, :value, :certname], :http => http)).each_value do |host|
     print options[:facts].collect { |f| host[f] if host.include? f }.join(',') + "\n"
   end
 else
   query = parser.parse(options[:query])
-  results = puppetdb.query(:nodes, query, http)
+  results = puppetdb.query(:nodes, query, :extract => :certname, :http => http)
   hosts = results.collect { |host| host['certname'] }
   hosts.each { |host| print host + "\n" }
 end

data/lib/puppet/application/query.rb

@@ -20,9 +20,9 @@ class Puppet::Application::Query < Puppet::Application::FaceBase
     Puppet.debug(port)
     Puppet.debug("use_ssl=#{use_ssl}")
 
-    { host: host,
-      port: port,
-      use_ssl: use_ssl
+    { :host => host,
+      :port => port,
+      :use_ssl => use_ssl
     }
   end
 end

data/lib/puppet/face/query.rb

@@ -52,7 +52,7 @@ Puppet::Face.define(:query, '1.0.0') do
       else
         factquery = parser.parse(query, :facts)
       end
-      parser.facts_hash(puppetdb.query(:facts, factquery))
+      parser.facts_hash(puppetdb.query(:facts, factquery, :extract => [:certname, :name, :value]))
     end
   end
 
@@ -75,11 +75,13 @@ Puppet::Face.define(:query, '1.0.0') do
     when_invoked do |query, options|
       puppetdb = PuppetDB::Connection.new options[:host], options[:port], !options[:no_ssl]
       parser = PuppetDB::Parser.new
-      nodes = puppetdb.query(:nodes, parser.parse(query, :nodes))
+      query = parser.parse(query, :nodes)
 
       if options[:node_info]
+        nodes = puppetdb.query(:nodes, query)
         Hash[nodes.collect { |node| [node['certname'], node.reject { |k, _v| k == 'certname' }] }]
       else
+        nodes = puppetdb.query(:nodes, query, :extract => :certname)
         nodes.collect { |node| node['certname'] }
       end
     end
@@ -129,8 +131,8 @@ Puppet::Face.define(:query, '1.0.0') do
       puppetdb = PuppetDB::Connection.new options[:host], options[:port], !options[:no_ssl]
       parser = PuppetDB::Parser.new
       nodes = puppetdb.query(:nodes, parser.parse(query, :nodes)).collect { |n| n['certname'] }
-      starttime = Chronic.parse(options[:since], context: :past, guess: false).first.getutc.strftime('%FT%T.000Z')
-      endtime = Chronic.parse(options[:until], context: :past, guess: false).last.getutc.strftime('%FT%T.000Z')
+      starttime = Chronic.parse(options[:since], :context => :past, :guess => false).first.getutc.strftime('%FT%T.000Z')
+      endtime = Chronic.parse(options[:until], :context => :past, :guess => false).last.getutc.strftime('%FT%T.000Z')
 
       events = []
       # Event API doesn't support subqueries at the moment and

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

@@ -1,4 +1,4 @@
-Puppet::Parser::Functions.newfunction(:query_facts, type: :rvalue, arity: 2, doc: <<-EOT
+Puppet::Parser::Functions.newfunction(:query_facts, :type => :rvalue, :arity => 2, :doc => <<-EOT
 
   accepts two arguments, a query used to discover nodes, and a list of facts
   that should be returned from those hosts.
@@ -32,5 +32,5 @@ EOT
   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))
+  parser.facts_hash(puppetdb.query(:facts, query, :extract => [:certname, :name, :value]))
 end

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

@@ -1,4 +1,4 @@
-Puppet::Parser::Functions.newfunction(:query_nodes, type: :rvalue, arity: -2, doc: <<-EOT
+Puppet::Parser::Functions.newfunction(:query_nodes, :type => :rvalue, :arity => -2, :doc => <<-EOT
 
   accepts two arguments, a query used to discover nodes, and a optional
   fact that should be returned.
@@ -29,10 +29,10 @@ EOT
   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).collect { |f| f['value'] }
+    query = parser.facts_query(query, [fact])
+    puppetdb.query(:facts, query, :extract => :value).collect { |f| f['value'] }
   else
-    query = parser.parse query, :nodes if query.is_a? String
-    puppetdb.query(:nodes, query).collect { |n| n['certname'] }
+    query = parser.parse(query, :nodes) if query.is_a? String
+    puppetdb.query(:nodes, query, :extract => :certname).collect { |n| n['certname'] }
   end
 end

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

@@ -1,4 +1,4 @@
-Puppet::Parser::Functions.newfunction(:query_resources, type: :rvalue, arity: -3, doc: <<-EOT
+Puppet::Parser::Functions.newfunction(:query_resources, :type => :rvalue, :arity => -3, :doc => <<-EOT
 
   Accepts two or three arguments: a query used to discover nodes, a
   resource query for the resources that should be returned from
@@ -66,9 +66,7 @@ EOT
   # If grouphosts is true create a nested hash with nodes and resources
   if grouphosts
     results.reduce({}) do |ret, resource|
-      unless ret.key? resource['certname']
-        ret[resource['certname']] = []
-      end
+      ret[resource['certname']] = [] unless ret.key? resource['certname']
       ret[resource['certname']] << resource
     end
   else

data/lib/puppetdb.rb

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

data/lib/puppetdb/connection.rb

@@ -16,33 +16,49 @@ class PuppetDB::Connection
   end
 
   def self.check_version
-    begin
-      require 'puppet/util/puppetdb'
-      unless Puppet::Util::Puppetdb.config.respond_to?('server_urls')
-        Puppet.warning <<-EOT
+    require 'puppet/util/puppetdb'
+    unless Puppet::Util::Puppetdb.config.respond_to?('server_urls')
+      Puppet.warning <<-EOT
 It looks like you are using a PuppetDB version < 3.0.
 This version of puppetdbquery requires at least PuppetDB 3.0 to work.
 Downgrade to puppetdbquery 1.x to use it with PuppetDB 2.x.
 EOT
-      end
-    rescue LoadError
     end
+  rescue LoadError
   end
 
   # Execute a PuppetDB query
   #
   # @param endpoint [Symbol] :resources, :facts or :nodes
   # @param query [Array] query to execute
+  # @param options [Hash] specify extract values or http connection
   # @return [Array] the results of the query
-  def query(endpoint, query = nil, http = nil, version = :v4)
+  def query(endpoint, query = nil, options = {}, version = :v4)
     require 'json'
 
+    default_options = {
+      :http => nil,   # A HTTP object to be used for the connection
+      :extract => nil # An array of fields to extract
+    }
+
+    if options.is_a? Hash
+      options = default_options.merge options
+    else
+      Puppet.deprecation_warning 'Specify http object with :http key instead'
+      options = default_options.merge(:http => options)
+    end
+    http = options[:http]
+
     unless http
       require 'puppet/network/http_pool'
       http = Puppet::Network::HttpPool.http_instance(@host, @port, @use_ssl)
     end
     headers = { 'Accept' => 'application/json' }
 
+    if options[:extract]
+      query = PuppetDB::ParserHelper.extract(*Array(options[:extract]), query)
+    end
+
     uri = "/pdb/query/#{version}/#{endpoint}"
     uri += URI.escape "?query=#{query.to_json}" unless query.nil? || query.empty?
 

data/lib/puppetdb/parser_helper.rb

@@ -45,4 +45,9 @@ module PuppetDB::ParserHelper
       ret
     end
   end
+
+  # Turn a query into one for only certain fields
+  def self.extract(*field, query)
+    ['extract', field.collect(&:to_s), query]
+  end
 end

data/spec/functions/query_facts_spec.rb

@@ -5,9 +5,11 @@ require 'puppetdb/connection'
 
 describe 'query_facts' do
   it do
-    PuppetDB::Connection.any_instance.stubs(:query).returns [
-      { 'certname' => 'apache4.puppetexplorer.io', 'environment' => 'production', 'name' => 'ipaddress', 'value' => '172.31.6.80' }
-    ]
+    PuppetDB::Connection.any_instance.expects(:query)
+      .with(:facts, ['or', ['=', 'name', 'ipaddress']], {:extract => [:certname, :name, :value]})
+      .returns [
+        { 'certname' => 'apache4.puppetexplorer.io', 'environment' => 'production', 'name' => 'ipaddress', 'value' => '172.31.6.80' }
+      ]
     should run.with_params('', ['ipaddress']).and_return('apache4.puppetexplorer.io' => { 'ipaddress' => '172.31.6.80' })
   end
 end

data/spec/functions/query_nodes_spec.rb

@@ -6,22 +6,8 @@ describe 'query_nodes' do
   context 'without fact parameter' do
     it do
       PuppetDB::Connection.any_instance.expects(:query)
-        .with(:nodes, ['in', 'certname', ['extract', 'certname', ['select_fact_contents', ['and', ['=', 'path', ['hostname']], ['=', 'value', 'apache4']]]]])
-        .returns [
-          {
-            'certname' => 'apache4.puppetexplorer.io',
-            'deactivated' => nil,
-            'latest_report_hash' => '4ff9fc5c1344c1c6ce47d923eb139a3409ef530d',
-            'facts_environment' => 'production',
-            'report_environment' => 'production',
-            'catalog_environment' => 'production',
-            'facts_timestamp' => '2015-10-13T05:35:32.511Z',
-            'expired' => nil,
-            'report_timestamp' => '2015-10-13T05:33:17.011Z',
-            'catalog_timestamp' => '2015-10-13T05:35:38.661Z',
-            'latest_report_status' => 'changed'
-          }
-        ]
+        .with(:nodes, ['in', 'certname', ['extract', 'certname', ['select_fact_contents', ['and', ['=', 'path', ['hostname']], ['=', 'value', 'apache4']]]]], :extract => :certname)
+        .returns [ { 'certname' => 'apache4.puppetexplorer.io' } ]
       should run.with_params('hostname="apache4"').and_return(['apache4.puppetexplorer.io'])
     end
   end
@@ -29,15 +15,8 @@ describe 'query_nodes' do
   context 'with a 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', 'ipaddress']]])
-        .returns [
-          {
-            'certname' => 'apache4.puppetexplorer.io',
-            'environment' => 'production',
-            'name' => 'ipaddress',
-            'value' => '172.31.6.80'
-          }
-        ]
+        .with(:facts, ['and', ['in', 'certname', ['extract', 'certname', ['select_fact_contents', ['and', ['=', 'path', ['hostname']], ['=', 'value', 'apache4']]]]], ['or', ['=', 'name', 'ipaddress']]], :extract => :value)
+        .returns [ { 'value' => '172.31.6.80' } ]
       should run.with_params('hostname="apache4"', 'ipaddress').and_return(['172.31.6.80'])
     end
   end

data/spec/unit/puppetdb/parser_spec.rb

@@ -222,4 +222,12 @@ describe PuppetDB::Parser do
       )
     end
   end
+
+  context 'extract' do
+    it 'should create an extract query' do
+      PuppetDB::ParserHelper.extract(:certname, :name, ['=', 'certname', 'foo.example.com']).should eq(
+        ['extract', ['certname', 'name'], ['=', 'certname', 'foo.example.com']]
+      )
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-puppetdb
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - Erik Dalen