quixoten-puppetdb-terminus 2.0.0 → 2.1.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63d1b44d864f009e45fe74dfd053ec9b0081bad6
-  data.tar.gz: 94b6c795415596d826a110609a7d9dc123e7d876
+  metadata.gz: 6ec041c3332210b8491e8e7867f4a7c1b08e3c9d
+  data.tar.gz: a8ad9e389b33309ecd2b99e25b987283d0d84739
 SHA512:
-  metadata.gz: 75ef2cfbec9fc27b048a4f24e4dd11239d0720ae17325c3526826320ddfe173de078412f8e113148f8f268691c20ac7f9194a7e2fbcd284471aed4add4e6ea01
-  data.tar.gz: 36f2d1628d0413d1e8357d2c7820e99fa85ee18046c101854b8418059495b6c2d2df81547e430c74be243dde2aa38c86e6a425705e4a6379511a9c34a492d828
+  metadata.gz: e4d435e16b3d6aec80101b8020fce096b8f639056139f046d570bdbd1617ced6d79d2c1dde2c95597b0766db092bffb9932fc2321f7e370e115a884b10ab21fe
+  data.tar.gz: 39df67b4547a42b34c1af11429b64f9b587d767d2b9e5a51f70769972d4d41f22c4ffc1eedf946e32fafe083e72d20487c012bc6297c1ef6ae5f86801d994bb0

data/lib/puppet/face/node/status.rb

@@ -26,7 +26,7 @@ Puppet::Face.define(:node, '0.0.1') do
 
       args.map do |node|
         begin
-          response = http.get("/v3/nodes/#{CGI.escape(node)}", headers)
+          response = http.get(Puppet::Util::Puppetdb.url_path("/v3/nodes/#{CGI.escape(node)}"), headers)
           if response.is_a? Net::HTTPSuccess
             result = JSON.parse(response.body)
           elsif response.is_a? Net::HTTPNotFound

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

@@ -17,7 +17,7 @@ class Puppet::Node::Facts::Puppetdb < Puppet::Indirector::REST
     profile "facts#save" do
       payload = profile "Encode facts command submission payload" do
         facts = request.instance.dup
-        facts.values = facts.values.dup
+        facts.values = facts.strip_internal
         facts.stringify
         {
           "name" => facts.name,
@@ -36,7 +36,7 @@ class Puppet::Node::Facts::Puppetdb < Puppet::Indirector::REST
   def find(request)
     profile "facts#find" do
       begin
-        url = "/v3/nodes/#{CGI.escape(request.key)}/facts"
+        url = Puppet::Util::Puppetdb.url_path("/v3/nodes/#{CGI.escape(request.key)}/facts")
         response = profile "Query for nodes facts: #{url}" do
           http_get(request, url, headers)
         end
@@ -105,7 +105,7 @@ class Puppet::Node::Facts::Puppetdb < Puppet::Indirector::REST
       query_param = CGI.escape(query.to_json)
 
       begin
-        url = "/v3/nodes?query=#{query_param}"
+        url = Puppet::Util::Puppetdb.url_path("/v3/nodes?query=#{query_param}")
         response = profile "Fact query request: #{URI.unescape(url)}" do
           http_get(request, url, headers)
         end

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

@@ -31,7 +31,7 @@ class Puppet::Resource::Puppetdb < Puppet::Indirector::REST
       query_param = CGI.escape(expr.to_json)
 
       begin
-        url = "/v3/resources?query=#{query_param}"
+        url = Puppet::Util::Puppetdb.url_path("/v3/resources?query=#{query_param}")
         response = profile "Resources query: #{URI.unescape(url)}" do
           http_get(request, url, headers)
         end

data/lib/puppet/reports/puppetdb.rb

@@ -15,52 +15,45 @@ Puppet::Reports.register_report(:puppetdb) do
   command.
   DESC
 
-
+  # Process the report by formatting it into a PuppetDB 'store report'
+  # command and submitting it.
+  #
+  # @return [void]
   def process
     profile "report#process" do
-      submit_command(self.host, report_to_hash, CommandStoreReport, 3)
+      submit_command(self.host, report_to_hash, CommandStoreReport, 4)
     end
-  end
 
-  # TODO: It seems unfortunate that we have to access puppet_version and
-  # report_format directly as instance variables.  I've filed the following
-  # ticket / pull req against puppet to expose them via accessors, which
-  # seems more consistent and safer for the long-term.  However, for reasons
-  # relating to backwards compatibility we won't be able to switch over to
-  # the accessors until version 3.x of puppet is our oldest supported version.
-  #
-  # This was resolved in puppet 3.x via ticket #16139 (puppet pull request #1073).
-
-  # @api private
-  def report_format
-    @report_format
-  end
-
-  # @api private
-  def puppet_version
-    @puppet_version
+    nil
   end
 
   # Convert `self` (an instance of `Puppet::Transaction::Report`) to a hash
   # suitable for sending over the wire to PuppetDB
   #
+  # @return Hash[<String, Object>]
   # @api private
   def report_to_hash
     profile "Convert report to wire format hash" do
-      add_v4_fields_to_report(
-        {
-          "certname"                => host,
-          "puppet-version"          => puppet_version,
-          "report-format"           => report_format,
-          "configuration-version"   => configuration_version.to_s,
-          "start-time"              => Puppet::Util::Puppetdb.to_wire_time(time),
-          "end-time"                => Puppet::Util::Puppetdb.to_wire_time(time + run_duration),
-          "resource-events"         => build_events_list,
-          "environment"             => environment,
-        })
+      if environment.nil?
+        raise Puppet::Error, "Environment is nil, unable to submit report. This may be due a bug with Puppet. Ensure you are running the latest revision, see PUP-2508 for more details."
+      end
+
+      {
+        "certname"                => host,
+        "puppet-version"          => puppet_version,
+        "report-format"           => report_format,
+        "configuration-version"   => configuration_version.to_s,
+        "start-time"              => Puppet::Util::Puppetdb.to_wire_time(time),
+        "end-time"                => Puppet::Util::Puppetdb.to_wire_time(time + run_duration),
+        "resource-events"         => build_events_list,
+        "environment"             => environment,
+        "transaction-uuid"        => transaction_uuid,
+        "status"                  => status,
+      }
     end
   end
 
+  # @return Array[Hash]
   # @api private
   def build_events_list
     profile "Build events list (count: #{resource_statuses.count})" do
@@ -70,19 +63,13 @@ Puppet::Reports.register_report(:puppetdb) do
           events.concat(status.events.map { |event| event_to_hash(status, event) })
         elsif status.skipped
           events.concat([fabricate_event(status, "skipped")])
-        elsif status.failed
-          # PP-254:
-          #   We have to fabricate resource events here due to a bug/s in report providers
-          #   that causes them not to include events on a resource status that has failed.
-          #   When PuppetDB is able to make a hard break from older version of Puppet that
-          #   have this bug, we can remove this behavior.
-          events.concat([fabricate_event(status, "failure")])
         end
         events
       end)
     end
   end
 
+  # @return Number
   # @api private
   def run_duration
     # TODO: this is wrong in puppet.  I am consistently seeing reports where
@@ -97,71 +84,49 @@ Puppet::Reports.register_report(:puppetdb) do
     if metrics["time"] and metrics["time"]["total"]
       metrics["time"]["total"]
     else
-      raise Puppet::Error, "Report from #{host} contained no metrics, which is often caused by a failed catalog compilation. Unable to process."
+      0
     end
   end
 
   # Convert an instance of `Puppet::Transaction::Event` to a hash
   # suitable for sending over the wire to PuppetDB
   #
+  # @return Hash[<String, Object>]
   # @api private
   def event_to_hash(resource_status, event)
-    add_v4_fields_to_event(resource_status,
-      {
-        "status"            => event.status,
-        "timestamp"         => Puppet::Util::Puppetdb.to_wire_time(event.time),
-        "resource-type"     => resource_status.resource_type,
-        "resource-title"    => resource_status.title,
-        "property"          => event.property,
-        "new-value"         => event.desired_value,
-        "old-value"         => event.previous_value,
-        "message"           => event.message,
-        "file"              => resource_status.file,
-        "line"              => resource_status.line
-      })
+    {
+      "status"            => event.status,
+      "timestamp"         => Puppet::Util::Puppetdb.to_wire_time(event.time),
+      "resource-type"     => resource_status.resource_type,
+      "resource-title"    => resource_status.title.to_s,
+      "property"          => event.property,
+      "new-value"         => event.desired_value,
+      "old-value"         => event.previous_value,
+      "message"           => event.message,
+      "file"              => resource_status.file,
+      "line"              => resource_status.line,
+      "containment-path"  => resource_status.containment_path,
+    }
   end
 
-  # Given an instance of `Puppet::Resource::Status` and a status string,
-  # this method fabricates a PuppetDB event object with the provided
-  # `"status"`.
+  # Given an instance of `Puppet::Resource::Status` and a status
+  # string, this method fabricates a PuppetDB event object with the
+  # provided `"status"`.
   #
   # @api private
   def fabricate_event(resource_status, event_status)
-    add_v4_fields_to_event(resource_status,
-      {
-        "status"            => event_status,
-        "timestamp"         => Puppet::Util::Puppetdb.to_wire_time(resource_status.time),
-        "resource-type"     => resource_status.resource_type,
-        "resource-title"    => resource_status.title,
-        "property"          => nil,
-        "new-value"         => nil,
-        "old-value"         => nil,
-        "message"           => nil,
-        "file"              => resource_status.file,
-        "line"              => resource_status.line
-      })
-  end
-
-  # Backwards compatibility with versions of Puppet prior to report format 4
-  #
-  # @api private
-  def add_v4_fields_to_report(report_hash)
-    if report_format >= 4
-      report_hash.merge("transaction-uuid" => transaction_uuid)
-    else
-      report_hash.merge("transaction-uuid" => nil)
-    end
-  end
-
-  # Backwards compatibility with versions of Puppet prior to report format 4
-  #
-  # @api private
-  def add_v4_fields_to_event(resource_status, event_hash)
-    if report_format >= 4
-      event_hash.merge("containment-path" => resource_status.containment_path)
-    else
-      event_hash.merge("containment-path" => nil)
-    end
+    {
+      "status"            => event_status,
+      "timestamp"         => Puppet::Util::Puppetdb.to_wire_time(resource_status.time),
+      "resource-type"     => resource_status.resource_type,
+      "resource-title"    => resource_status.title.to_s,
+      "property"          => nil,
+      "new-value"         => nil,
+      "old-value"         => nil,
+      "message"           => nil,
+      "file"              => resource_status.file,
+      "line"              => resource_status.line,
+    }
   end
 
   # Filter out blacklisted events, if we're configured to do so

data/lib/puppet/util/puppetdb/command.rb

@@ -9,7 +9,7 @@ class Puppet::Util::Puppetdb::Command
   include Puppet::Util::Puppetdb
   include Puppet::Util::Puppetdb::CommandNames
 
-  Url                = "/v3/commands"
+  CommandsUrl = "/v3/commands"
 
   # Public instance methods
 
@@ -45,7 +45,8 @@ class Puppet::Util::Puppetdb::Command
     begin
       response = profile "Submit command HTTP post" do
         http = Puppet::Network::HttpPool.http_instance(config.server, config.port)
-        http.post(Url + "?checksum=#{checksum}", payload, headers)
+        http.post(Puppet::Util::Puppetdb.url_path(CommandsUrl + "?checksum=#{checksum}"),
+                  payload, headers)
       end
 
       Puppet::Util::Puppetdb.log_x_deprecation_header(response)

data/lib/puppet/util/puppetdb/config.rb

@@ -11,6 +11,7 @@ class Config
     defaults = {
       :server                    => "puppetdb",
       :port                      => 8081,
+      :url_prefix                => "",
       :soft_write_failure        => false,
       :ignore_blacklisted_events => true,
     }
@@ -52,11 +53,12 @@ class Config
     main_section = main_section.inject({}) {|h, (k,v)| h[k.to_sym] = v ; h}
     # merge with defaults but filter out anything except the legal settings
     config_hash = defaults.merge(main_section).reject do |k, v|
-      !([:server, :port, :ignore_blacklisted_events, :soft_write_failure].include?(k))
+      !([:server, :port, :url_prefix, :ignore_blacklisted_events, :soft_write_failure].include?(k))
     end
 
     config_hash[:server] = config_hash[:server].strip
     config_hash[:port] = config_hash[:port].to_i
+    config_hash[:url_prefix] = normalize_url_prefix(config_hash[:url_prefix].strip)
     config_hash[:ignore_blacklisted_events] =
       Puppet::Util::Puppetdb.to_bool(config_hash[:ignore_blacklisted_events])
     config_hash[:soft_write_failure] =
@@ -84,6 +86,10 @@ class Config
     config[:port]
   end
 
+  def url_prefix
+    config[:url_prefix]
+  end
+
   def ignore_blacklisted_events?
     config[:ignore_blacklisted_events]
   end
@@ -96,6 +102,17 @@ class Config
     config[:soft_write_failure]
   end
 
+  # @!group Private class methods
+  def self.normalize_url_prefix(prefix)
+    if prefix == ""
+      prefix
+    elsif prefix.start_with?("/")
+      prefix
+    else
+      "/" + prefix
+    end
+  end
+
   # @!group Private instance methods
 
   # @!attribute [r] count

data/lib/puppet/util/puppetdb.rb

@@ -19,6 +19,13 @@ module Puppet::Util::Puppetdb
     config.port
   end
 
+  def self.url_path(path)
+    unless path.start_with?("/")
+      path = "/" + path
+    end
+    config.url_prefix + path
+  end
+
   def self.config
     @config ||= Puppet::Util::Puppetdb::Config.load
     @config
@@ -68,6 +75,7 @@ module Puppet::Util::Puppetdb
   # @param payload [String] payload
   # @param command_name [String] name of command
   # @param version [Number] version number of command
+  # @return [Hash <String, String>]
   def submit_command(certname, payload, command_name, version)
     profile "Submitted command '#{command_name}' version '#{version}'" do
       command = Puppet::Util::Puppetdb::Command.new(command_name, version, certname, payload)

data/lib/puppetdb/terminus/version.rb

@@ -1,5 +1,5 @@
 module PuppetDB
   module Terminus
-    VERSION = "2.0.0"
+    VERSION = "2.1.0.rc1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: quixoten-puppetdb-terminus
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0.rc1
 platform: ruby
 authors:
 - Devin Christensen
@@ -87,9 +87,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.2.2