Class: Bolt::PuppetDB::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/bolt/puppetdb/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ Client

Returns a new instance of Client.



11
12
13
14
15
16
 
# File 'lib/bolt/puppetdb/client.rb', line 11

def initialize(config)
  @config = config
  @bad_urls = []
  @current_url = nil
  @logger = Bolt::Logger.logger(self)
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



9
10
11
 
# File 'lib/bolt/puppetdb/client.rb', line 9

def config
  @config
end

Instance Method Details

#fact_values(certnames = [], facts = []) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/bolt/puppetdb/client.rb', line 44

def fact_values(certnames = [], facts = [])
  return {} if certnames.empty? || facts.empty?

  certnames.uniq!
  name_query = certnames.map { |c| ["=", "certname", c] }
  name_query.insert(0, "or")

  facts_query = facts.map { |f| ["=", "path", f] }
  facts_query.insert(0, "or")

  query = ['and', name_query, facts_query]
  result = make_query(query, 'fact-contents')
  result.map! { |h| h.delete_if { |k, _v| %w[environment name].include?(k) } }
  result.group_by { |c| c['certname'] }
end

#facts_for_node(certnames) ⇒ Object

This method expects an array of certnames to get facts for



31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/bolt/puppetdb/client.rb', line 31

def facts_for_node(certnames)
  return {} if certnames.empty? || certnames.nil?

  certnames.uniq!
  name_query = certnames.map { |c| ["=", "certname", c] }
  name_query.insert(0, "or")
  result = make_query(name_query, 'inventory')

  result&.each_with_object({}) do |node, coll|
    coll[node['certname']] = node['facts']
  end
end

#headers ⇒ Object 



123
124
125
126
127
 
# File 'lib/bolt/puppetdb/client.rb', line 123

def headers
  headers = { 'Content-Type' => 'application/json' }
  headers['X-Authentication'] = @config.token if @config.token
  headers
end

#http_client ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/bolt/puppetdb/client.rb', line 91

def http_client
  return @http if @http
  # lazy-load expensive gem code
  require 'httpclient'
  @http = HTTPClient.new
  @http.ssl_config.set_client_cert_file(@config.cert, @config.key) if @config.cert
  @http.ssl_config.add_trust_ca(@config.cacert)
  @http.connect_timeout = @config.connect_timeout if @config.connect_timeout
  @http.receive_timeout = @config.read_timeout if @config.read_timeout

  @http
end

#make_query(query, path = nil) ⇒ Object 



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/bolt/puppetdb/client.rb', line 60

def make_query(query, path = nil)
  body = JSON.generate(query: query)
  url = "#{uri}/pdb/query/v4"
  url += "/#{path}" if path

  begin
    response = http_client.post(url, body: body, header: headers)
  rescue StandardError => e
    raise Bolt::PuppetDBFailoverError, "Failed to query PuppetDB: #{e}"
  end

  if response.code != 200
    msg = "Failed to query PuppetDB: #{response.body}"
    if response.code == 400
      raise Bolt::PuppetDBError, msg
    else
      raise Bolt::PuppetDBFailoverError, msg
    end
  end

  begin
    JSON.parse(response.body)
  rescue JSON::ParserError
    raise Bolt::PuppetDBError, "Unable to parse response as JSON: #{response.body}"
  end
rescue Bolt::PuppetDBFailoverError => e
  @logger.error("Request to puppetdb at #{@current_url} failed with #{e}.")
  reject_url
  make_query(query, path)
end

#query_certnames(query) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/bolt/puppetdb/client.rb', line 18

def query_certnames(query)
  return [] unless query

  results = make_query(query)

  if results&.first && !results.first&.key?('certname')
    fields = results.first&.keys
    raise Bolt::PuppetDBError, "Query results did not contain a 'certname' field: got #{fields.join(', ')}"
  end
  results&.map { |result| result['certname'] }&.uniq
end

#reject_url ⇒ Object 



104
105
106
107
 
# File 'lib/bolt/puppetdb/client.rb', line 104

def reject_url
  @bad_urls << @current_url if @current_url
  @current_url = nil
end

#uri ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/bolt/puppetdb/client.rb', line 109

def uri
  require 'addressable/uri'

  @current_url ||= (@config.server_urls - @bad_urls).first
  unless @current_url
    msg = "Failed to connect to all PuppetDB server_urls: #{@config.server_urls.to_a.join(', ')}."
    raise Bolt::PuppetDBError, msg
  end

  uri = Addressable::URI.parse(@current_url)
  uri.port ||= 8081
  uri
end