md-puppetdb-terminus 2.0.0.3

data/lib/puppet/indirector/catalog/puppetdb.rb

@@ -0,0 +1,350 @@
+require 'puppet/resource/catalog'
+require 'puppet/indirector/rest'
+require 'puppet/util/puppetdb'
+
+class Puppet::Resource::Catalog::Puppetdb < Puppet::Indirector::REST
+  include Puppet::Util::Puppetdb
+  include Puppet::Util::Puppetdb::CommandNames
+
+  # Run initial checks
+  def initialize
+    Puppet::Util::Puppetdb::GlobalCheck.run
+  end
+
+  def save(request)
+    profile "catalog#save" do
+      catalog = munge_catalog(request.instance, extract_extra_request_data(request))
+
+      submit_command(request.key, catalog, CommandReplaceCatalog, 4)
+    end
+  end
+
+  def find(request)
+    nil
+  end
+
+  # @api private
+  def extract_extra_request_data(request)
+    {
+      :transaction_uuid => request.options[:transaction_uuid],
+      :environment => request.environment,
+    }
+  end
+
+  def munge_catalog(catalog, extra_request_data = {})
+    profile "Munge catalog" do
+      hash = profile "Convert catalog to PSON data hash" do
+        catalog.to_pson_data_hash
+      end
+
+      data = hash['data']
+
+      add_parameters_if_missing(data)
+      add_namevar_aliases(data, catalog)
+      stringify_titles(data)
+      stringify_version(data)
+      sort_unordered_metaparams(data)
+      munge_edges(data)
+      synthesize_edges(data, catalog)
+      filter_keys(data)
+      add_transaction_uuid(data, extra_request_data[:transaction_uuid])
+      add_environment(data, extra_request_data[:environment])
+
+      data
+    end
+  end
+
+  Relationships = {
+    :before    => {:direction => :forward, :relationship => 'before'},
+    :require   => {:direction => :reverse, :relationship => 'required-by'},
+    :notify    => {:direction => :forward, :relationship => 'notifies'},
+    :subscribe => {:direction => :reverse, :relationship => 'subscription-of'},
+  }
+
+  # Metaparams that may contain arrays, but whose semantics are
+  # fundamentally unordered
+  UnorderedMetaparams = [:alias, :audit, :before, :check, :notify, :require, :subscribe, :tag]
+
+  # Include environment in hash, returning the complete hash.
+  #
+  # @param hash [Hash] original data hash
+  # @param environment [String] environment
+  # @return [Hash] returns original hash augmented with environment
+  # @api private
+  def add_environment(hash, environment)
+    hash['environment'] = environment
+
+    hash
+  end
+
+  # Include transaction_uuid in hash, returning the complete hash.
+  #
+  # @param hash [Hash] original data hash
+  # @param transaction_uuid [String] transaction_uuid
+  # @return [Hash] returns original hash augmented with transaction_uuid
+  # @api private
+  def add_transaction_uuid(hash, transaction_uuid)
+    hash['transaction-uuid'] = transaction_uuid
+
+    hash
+  end
+
+  # Version is an integer (time since epoch in millis). The wire
+  # format specifies version should be a string
+  #
+  # @param hash [Hash] original data hash
+  # @return [Hash] returns a modified original hash
+  def stringify_version(hash)
+    hash['version'] = hash['version'].to_s
+
+    hash
+  end
+
+  def stringify_titles(hash)
+    resources = hash['resources']
+    profile "Stringify titles (resource count: #{resources.count})" do
+      resources.each do |resource|
+        resource['title'] = resource['title'].to_s
+      end
+    end
+
+    hash
+  end
+
+  def add_parameters_if_missing(hash)
+    resources = hash['resources']
+    profile "Add parameters if missing (resource count: #{resources.count})" do
+      resources.each do |resource|
+        resource['parameters'] ||= {}
+      end
+    end
+
+    hash
+  end
+
+  def add_namevar_aliases(hash, catalog)
+    resources = hash['resources']
+    profile "Add namevar aliases (resource count: #{resources.count})" do
+      resources.each do |resource|
+        real_resource = catalog.resource(resource['type'], resource['title'])
+
+        # Resources with composite namevars can't be referred to by
+        # anything other than their title when declaring
+        # relationships. Trying to snag the :alias for these resources
+        # will only return _part_ of the name (a problem with Puppet
+        # proper), so skipping the adding of aliases for these resources
+        # is both an optimization and a safeguard.
+        next if real_resource.key_attributes.count > 1
+
+        aliases = [real_resource[:alias]].flatten.compact
+
+        # Non-isomorphic resources aren't unique based on namevar, so we can't
+        # use it as an alias
+        type = real_resource.resource_type
+        if !type.respond_to?(:isomorphic?) or type.isomorphic?
+          # This makes me a little sad.  It turns out that the "to_hash" method
+          #  of Puppet::Resource can have side effects.  In particular, if the
+          #  resource type specifies a title_pattern, calling "to_hash" will trigger
+          #  the title_pattern processing, which can have the side effect of
+          #  populating the namevar (potentially with a munged value).  Thus,
+          #  it is important that we search for namevar aliases in that hash
+          #  rather than in the resource itself.
+          real_resource_hash = real_resource.to_hash
+
+          name = real_resource_hash[real_resource.send(:namevar)]
+          unless name.nil? or real_resource.title == name or aliases.include?(name)
+            aliases << name
+          end
+        end
+
+        resource['parameters']['alias'] = aliases unless aliases.empty?
+      end
+    end
+
+    hash
+  end
+
+  def sort_unordered_metaparams(hash)
+    resources = hash['resources']
+    profile "Sort unordered metaparams (resource count: #{resources.count})" do
+      resources.each do |resource|
+        params = resource['parameters']
+        UnorderedMetaparams.each do |metaparam|
+          if params[metaparam].kind_of? Array then
+            values = params[metaparam].sort
+            params[metaparam] = values unless values.empty?
+          end
+        end
+      end
+    end
+
+    hash
+  end
+
+  def munge_edges(hash)
+    edges = hash['edges']
+    profile "Munge edges (edge count: #{edges.count})" do
+      edges.each do |edge|
+        %w[source target].each do |vertex|
+          edge[vertex] = resource_ref_to_hash(edge[vertex]) if edge[vertex].is_a?(String)
+        end
+        edge['relationship'] ||= 'contains'
+      end
+
+      hash
+    end
+  end
+
+  def map_aliases_to_title(hash)
+    resources = hash['resources']
+    aliases = {}
+
+    profile "Map aliases to title (resource count: #{resources.count})" do
+      resources.each do |resource|
+        names = resource['parameters']['alias'] || []
+        resource_hash = {'type' => resource['type'], 'title' => resource['title']}
+        names.each do |name|
+          alias_array = [resource['type'], name]
+          aliases[alias_array] = resource_hash
+        end
+      end
+    end
+
+    aliases
+  end
+
+  def synthesize_edges(hash, catalog)
+    profile "Synthesize edges" do
+      aliases = map_aliases_to_title(hash)
+
+      resource_table = {}
+      profile "Build up resource_table" do
+        hash['resources'].each do |resource|
+          resource_table[ [resource['type'], resource['title']] ] = resource
+        end
+      end
+
+      profile "Primary synthesis" do
+        hash['resources'].each do |resource|
+          # Standard virtual resources don't appear in the catalog. However,
+          # exported resources which haven't been also collected will appears as
+          # exported and virtual (collected ones will only be exported). They will
+          # eventually be removed from the catalog, so we can't add edges involving
+          # them. Puppet::Resource#to_pson_data_hash omits 'virtual', so we have to
+          # look it up in the catalog to find that information. This isn't done in
+          # a separate step because we don't actually want to send the field (it
+          # will always be false). See ticket #16472.
+          #
+          # The outer conditional is here because Class[main] can't properly be
+          # looked up using catalog.resource and will return nil. See ticket
+          # #16473. Yay.
+          if real_resource = catalog.resource(resource['type'], resource['title'])
+            next if real_resource.virtual?
+          end
+
+          Relationships.each do |param,relation|
+            if value = resource['parameters'][param]
+              [value].flatten.each do |other_ref|
+                edge = {'relationship' => relation[:relationship]}
+
+                resource_hash = {'type' => resource['type'], 'title' => resource['title']}
+                other_hash = resource_ref_to_hash(other_ref)
+
+                # Puppet doesn't always seem to check this correctly. If we don't
+                # users will later get an invalid relationship error instead.
+                #
+                # Primarily we are trying to catch the non-capitalized resourceref
+                # case problem here: http://projects.puppetlabs.com/issues/19474
+                # Once that problem is solved and older versions of Puppet that have
+                # the bug are no longer supported we can probably remove this code.
+                unless other_ref =~ /^[A-Z][a-z0-9_]*(::[A-Z][a-z0-9_]*)*\[.*\]/
+                  rel = edge_to_s(resource_hash_to_ref(resource_hash), other_ref, param)
+                  raise Puppet::Error, "Invalid relationship: #{rel}, because " +
+                    "#{other_ref} doesn't seem to be in the correct format. " +
+                    "Resource references should be formatted as: " +
+                    "Classname['title'] or Modulename::Classname['title'] (take " +
+                    "careful note of the capitalization)."
+                end
+
+                # This is an unfortunate hack.  Puppet does some weird things w/rt
+                # munging off trailing slashes from file resources, and users may
+                # legally specify relationships using a different number of trailing
+                # slashes than the resource was originally declared with.
+                # We do know that for any file resource in the catalog, there should
+                # be a canonical entry for it that contains no trailing slashes.  So,
+                # here, in case someone has specified a relationship to a file resource
+                # and has used one or more trailing slashes when specifying the
+                # relationship, we will munge off the trailing slashes before
+                # we look up the resource in the catalog to create the edge.
+                if other_hash['type'] == 'File' and other_hash['title'] =~ /\/$/
+                  other_hash['title'] = other_hash['title'].sub(/\/+$/, '')
+                end
+
+                other_array = [other_hash['type'], other_hash['title']]
+
+                # Try to find the resource by type/title or look it up as an alias
+                # and try that
+                other_resource = resource_table[other_array]
+                if other_resource.nil? and alias_hash = aliases[other_array]
+                  other_resource = resource_table[ alias_hash.values_at('type', 'title') ]
+                end
+
+                raise Puppet::Error, "Invalid relationship: #{edge_to_s(resource_hash_to_ref(resource_hash), other_ref, param)}, because #{other_ref} doesn't seem to be in the catalog" unless other_resource
+
+                # As above, virtual exported resources will eventually be removed,
+                # so if a real resource refers to one, it's wrong. Non-virtual
+                # exported resources are exported resources that were also
+                # collected in this catalog, so they're okay. Virtual non-exported
+                # resources can't appear in the catalog in the first place, so it
+                # suffices to check for virtual.
+                if other_real_resource = catalog.resource(other_resource['type'], other_resource['title'])
+                  if other_real_resource.virtual?
+                    raise Puppet::Error, "Invalid relationship: #{edge_to_s(resource_hash_to_ref(resource_hash), other_ref, param)}, because #{other_ref} is exported but not collected"
+                  end
+                end
+
+                # If the ref was an alias, it will have a different title, so use
+                # that
+                other_hash['title'] = other_resource['title']
+
+                if relation[:direction] == :forward
+                  edge.merge!('source' => resource_hash, 'target' => other_hash)
+                else
+                  edge.merge!('source' => other_hash, 'target' => resource_hash)
+                end
+                hash['edges'] << edge
+              end
+            end
+          end
+        end
+      end
+
+      profile "Make edges unique" do
+        hash['edges'].uniq!
+      end
+
+      hash
+    end
+  end
+
+  def filter_keys(hash)
+    profile "Filter extraneous keys from the catalog" do
+      hash.delete_if do |k,v|
+        ! ['name', 'version', 'edges', 'resources'].include?(k)
+      end
+    end
+  end
+
+  def resource_ref_to_hash(ref)
+    ref =~ /^([^\[\]]+)\[(.+)\]$/m
+    {'type' => $1, 'title' => $2}
+  end
+
+  def resource_hash_to_ref(hash)
+    "#{hash['type']}[#{hash['title']}]"
+  end
+
+  def edge_to_s(specifier_resource, referred_resource, param)
+    "#{specifier_resource} { #{param} => #{referred_resource} }"
+  end
+end

data/lib/puppet/indirector/facts/puppetdb.rb

@@ -0,0 +1,134 @@
+require 'uri'
+require 'puppet/node/facts'
+require 'puppet/indirector/rest'
+require 'puppet/util/puppetdb'
+require 'json'
+
+class Puppet::Node::Facts::Puppetdb < Puppet::Indirector::REST
+  include Puppet::Util::Puppetdb
+  include Puppet::Util::Puppetdb::CommandNames
+
+  # Run initial checks
+  def initialize
+    Puppet::Util::Puppetdb::GlobalCheck.run
+  end
+
+  def save(request)
+    profile "facts#save" do
+      payload = profile "Encode facts command submission payload" do
+        facts = request.instance.dup
+        facts.values = facts.values.dup
+        facts.stringify
+        {
+          "name" => facts.name,
+          "values" => facts.values,
+          # PDB-453: we call to_s to avoid a 'stack level too deep' error
+          # when we attempt to use ActiveSupport 2.3.16 on RHEL 5 with
+          # legacy storeconfigs.
+          "environment" => request.environment.to_s,
+        }
+      end
+
+      submit_command(request.key, payload, CommandReplaceFacts, 2)
+    end
+  end
+
+  def find(request)
+    profile "facts#find" do
+      begin
+        url = "/v3/nodes/#{CGI.escape(request.key)}/facts"
+        response = profile "Query for nodes facts: #{url}" do
+          http_get(request, url, headers)
+        end
+        log_x_deprecation_header(response)
+
+        if response.is_a? Net::HTTPSuccess
+          profile "Parse fact query response (size: #{response.body.size})" do
+            result = JSON.parse(response.body)
+            # Note: the Inventory Service API appears to expect us to return nil here
+            # if the node isn't found.  However, PuppetDB returns an empty array in
+            # this case; for now we will just look for that condition and assume that
+            # it means that the node wasn't found, so we will return nil.  In the
+            # future we may want to improve the logic such that we can distinguish
+            # between the "node not found" and the "no facts for this node" cases.
+            if result.empty?
+              return nil
+            end
+            facts = result.inject({}) do |a,h|
+              a.merge(h['name'] => h['value'])
+            end
+            Puppet::Node::Facts.new(request.key, facts)
+          end
+        else
+          # Newline characters cause an HTTP error, so strip them
+          raise "[#{response.code} #{response.message}] #{response.body.gsub(/[\r\n]/, '')}"
+        end
+      rescue => e
+        raise Puppet::Error, "Failed to find facts from PuppetDB at #{self.class.server}:#{self.class.port}: #{e}"
+      end
+    end
+  end
+
+  # Search for nodes matching a set of fact constraints. The constraints are
+  # specified as a hash of the form:
+  #
+  # `{type.name.operator => value`
+  #
+  # The only accepted `type` is 'facts'.
+  #
+  # `name` must be the fact name to query against.
+  #
+  # `operator` may be one of {eq, ne, lt, gt, le, ge}, and will default to 'eq'
+  # if unspecified.
+  def search(request)
+    profile "facts#search" do
+      return [] unless request.options
+      operator_map = {
+        'eq' => '=',
+        'gt' => '>',
+        'lt' => '<',
+        'ge' => '>=',
+        'le' => '<=',
+      }
+      filters = request.options.sort.map do |key,value|
+        type, name, operator = key.to_s.split('.')
+        operator ||= 'eq'
+        raise Puppet::Error, "Fact search against keys of type '#{type}' is unsupported" unless type == 'facts'
+        if operator == 'ne'
+          ['not', ['=', ['fact', name], value]]
+        else
+          [operator_map[operator], ['fact', name], value]
+        end
+      end
+
+      query = ["and"] + filters
+      query_param = CGI.escape(query.to_json)
+
+      begin
+        url = "/v3/nodes?query=#{query_param}"
+        response = profile "Fact query request: #{URI.unescape(url)}" do
+          http_get(request, url, headers)
+        end
+        log_x_deprecation_header(response)
+
+        if response.is_a? Net::HTTPSuccess
+          profile "Parse fact query response (size: #{response.body.size})" do
+            JSON.parse(response.body).collect {|s| s["name"]}
+          end
+        else
+          # Newline characters cause an HTTP error, so strip them
+          raise "[#{response.code} #{response.message}] #{response.body.gsub(/[\r\n]/, '')}"
+        end
+      rescue => e
+        raise Puppet::Error, "Could not perform inventory search from PuppetDB at #{self.class.server}:#{self.class.port}: #{e}"
+      end
+    end
+  end
+
+  def headers
+    {
+      "Accept" => "application/json",
+      "Content-Type" => "application/x-www-form-urlencoded; charset=UTF-8",
+    }
+  end
+end