quixoten-puppetdb-terminus 2.0.0.rc1

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

@@ -0,0 +1,113 @@
+require 'puppet/error'
+require 'puppet/network/http_pool'
+require 'puppet/util/puppetdb'
+require 'puppet/util/puppetdb/command_names'
+require 'puppet/util/puppetdb/char_encoding'
+require 'json'
+
+class Puppet::Util::Puppetdb::Command
+  include Puppet::Util::Puppetdb
+  include Puppet::Util::Puppetdb::CommandNames
+
+  Url                = "/v3/commands"
+
+  # Public instance methods
+
+  # Initialize a Command object, for later submission.
+  #
+  # @param command String the name of the command; should be one of the
+  #   constants defined in `Puppet::Util::Puppetdb::CommandNames`
+  # @param version Integer the command version number
+  # @param certname The certname that this command operates on (is not
+  #   included in the actual submission)
+  # @param payload Object the payload of the command.  This object should be a
+  #   primitive (numeric type, string, array, or hash) that is natively supported
+  #   by JSON serialization / deserialization libraries.
+  def initialize(command, version, certname, payload)
+    @command = command
+    @version = version
+    @certname = certname
+    profile "Format payload" do
+      @payload = self.class.format_payload(command, version, payload)
+    end
+  end
+
+  attr_reader :command, :version, :certname, :payload
+
+  # Submit the command, returning the result hash.
+  #
+  # @return [Hash <String, String>]
+  def submit
+    checksum = Digest::SHA1.hexdigest(payload)
+
+    for_whom = " for #{certname}" if certname
+
+    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)
+      end
+
+      Puppet::Util::Puppetdb.log_x_deprecation_header(response)
+
+      if response.is_a? Net::HTTPSuccess
+        result = JSON.parse(response.body)
+        Puppet.info "'#{command}' command#{for_whom} submitted to PuppetDB with UUID #{result['uuid']}"
+        result
+      else
+        # Newline characters cause an HTTP error, so strip them
+        error = "[#{response.code} #{response.message}] #{response.body.gsub(/[\r\n]/, '')}"
+        if config.soft_write_failure
+          Puppet.err "'#{command}'command#{for_whom} failed during submission to PuppetDB: #{error}"
+        else
+          raise Puppet::Error, error
+        end
+      end
+    rescue => e
+      error = "Failed to submit '#{command}' command#{for_whom} to PuppetDB at #{config.server}:#{config.port}: #{e}"
+      if config.soft_write_failure
+        Puppet.err error
+      else
+        # TODO: Use new exception handling methods from Puppet 3.0 here as soon as
+        #  we are able to do so (can't call them yet w/o breaking backwards
+        #  compatibility.)  We should either be using a nested exception or calling
+        #  Puppet::Util::Logging#log_exception or #log_and_raise here; w/o them
+        #  we lose context as to where the original exception occurred.
+        puts e, e.backtrace if Puppet[:trace]
+        raise Puppet::Error, error
+      end
+    end
+  end
+
+
+  # @!group Private class methods
+
+  # @api private
+  def self.format_payload(command, version, payload)
+    message = {
+      :command => command,
+      :version => version,
+      :payload => payload,
+    }.to_pson
+
+    Puppet::Util::Puppetdb::CharEncoding.utf8_string(message)
+  end
+
+  # @!group Private instance methods
+
+  # @api private
+  def headers
+    {
+      "Accept" => "application/json",
+      "Content-Type" => "application/json",
+    }
+  end
+
+  # @api private
+  def config
+    # Would prefer to pass this to the constructor or acquire it some other
+    # way besides this pseudo-global reference.
+    Puppet::Util::Puppetdb.config
+  end
+
+end

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

@@ -0,0 +1,8 @@
+module Puppet::Util::Puppetdb
+  module CommandNames
+    CommandReplaceCatalog   = "replace catalog"
+    CommandReplaceFacts     = "replace facts"
+    CommandDeactivateNode   = "deactivate node"
+    CommandStoreReport      = "store report"
+  end
+end

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

@@ -0,0 +1,112 @@
+require 'puppet/util/puppetdb/command_names'
+require 'puppet/util/puppetdb/blacklist'
+
+module Puppet::Util::Puppetdb
+class Config
+  include Puppet::Util::Puppetdb::CommandNames
+
+  # Public class methods
+
+  def self.load(config_file = nil)
+    defaults = {
+      :server                    => "puppetdb",
+      :port                      => 8081,
+      :soft_write_failure        => false,
+      :ignore_blacklisted_events => true,
+    }
+
+    config_file ||= File.join(Puppet[:confdir], "puppetdb.conf")
+
+    if File.exists?(config_file)
+      Puppet.debug("Configuring PuppetDB terminuses with config file #{config_file}")
+      content = File.read(config_file)
+    else
+      Puppet.debug("No #{config_file} file found; falling back to default server and port #{defaults[:server]}:#{defaults[:port]}")
+      content = ''
+    end
+
+    result = {}
+    section = nil
+    content.lines.each_with_index do |line,number|
+      # Gotta track the line numbers properly
+      number += 1
+      case line
+        when /^\[(\w+)\s*\]$/
+          section = $1
+          result[section] ||= {}
+        when /^\s*(\w+)\s*=\s*(\S+)\s*$/
+          raise "Setting '#{line}' is illegal outside of section in PuppetDB config #{config_file}:#{number}" unless section
+          result[section][$1] = $2
+        when /^\s*[#;]/
+          # Skip comments
+        when /^\s*$/
+          # Skip blank lines
+        else
+          raise "Unparseable line '#{line}' in PuppetDB config #{config_file}:#{number}"
+      end
+    end
+
+
+    main_section = result['main'] || {}
+    # symbolize the keys
+    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))
+    end
+
+    config_hash[:server] = config_hash[:server].strip
+    config_hash[:port] = config_hash[:port].to_i
+    config_hash[:ignore_blacklisted_events] =
+      Puppet::Util::Puppetdb.to_bool(config_hash[:ignore_blacklisted_events])
+    config_hash[:soft_write_failure] =
+      Puppet::Util::Puppetdb.to_bool(config_hash[:soft_write_failure])
+
+    self.new(config_hash)
+  rescue => detail
+    puts detail.backtrace if Puppet[:trace]
+    Puppet.warning "Could not configure PuppetDB terminuses: #{detail}"
+    raise
+  end
+
+  # @!group Public instance methods
+
+  def initialize(config_hash = {})
+    @config = config_hash
+    initialize_blacklisted_events()
+  end
+
+  def server
+    config[:server]
+  end
+
+  def port
+    config[:port]
+  end
+
+  def ignore_blacklisted_events?
+    config[:ignore_blacklisted_events]
+  end
+
+  def is_event_blacklisted?(event)
+   @blacklist.is_event_blacklisted? event
+  end
+
+  def soft_write_failure
+    config[:soft_write_failure]
+  end
+
+  # @!group Private instance methods
+
+  # @!attribute [r] count
+  #   @api private
+  attr_reader :config
+
+  Blacklist = Puppet::Util::Puppetdb::Blacklist
+
+  # @api private
+  def initialize_blacklisted_events(events = Blacklist::BlacklistedEvents)
+    @blacklist = Blacklist.new(events)
+  end
+end
+end

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

@@ -0,0 +1,31 @@
+require 'semver'
+require 'puppet/version'
+require 'puppet/error'
+
+module Puppet::Util::Puppetdb
+  # Global checks for version support and other validations before the terminus
+  # is used.
+  #
+  class GlobalCheck
+    # Validate that the support for the version of Puppet we are running on is
+    # still maintained.
+    #
+    # @param minimum [String] minimum version for operation
+    # @throws [Puppet::Error] raised if current version is unsupported
+    # @api private
+    def self.puppet_version_check(minimum)
+      minimum_version = ::SemVer.new(minimum)
+      puppet_version = ::SemVer.new(Puppet.version)
+      if (puppet_version <=> minimum_version) == -1 then
+        raise Puppet::Error, "You are attempting to use puppetdb-terminus on an unsupported version of Puppet (#{puppet_version}) the minimum supported version is #{minimum_version}"
+      end
+    end
+
+    # Run all checks
+    #
+    # @throws [Puppet::Error] raised for any validation errors
+    def self.run
+      self.puppet_version_check("3.5.1")
+    end
+  end
+end

data/lib/puppet/util/puppetdb.rb

@@ -0,0 +1,108 @@
+require 'puppet/util'
+require 'puppet/util/logging'
+require 'puppet/util/profiler'
+require 'puppet/util/puppetdb/global_check'
+require 'puppet/util/puppetdb/command_names'
+require 'puppet/util/puppetdb/command'
+require 'puppet/util/puppetdb/config'
+require 'digest/sha1'
+require 'time'
+require 'fileutils'
+
+module Puppet::Util::Puppetdb
+
+  def self.server
+    config.server
+  end
+
+  def self.port
+    config.port
+  end
+
+  def self.config
+    @config ||= Puppet::Util::Puppetdb::Config.load
+    @config
+  end
+
+  # This magical stuff is needed so that the indirector termini will make requests to
+  # the correct host/port, because this module gets mixed in to our indirector
+  # termini.
+  module ClassMethods
+    def server
+      Puppet::Util::Puppetdb.server
+    end
+
+    def port
+      Puppet::Util::Puppetdb.port
+    end
+  end
+
+  def self.included(child)
+    child.extend ClassMethods
+  end
+
+  # Given an instance of ruby's Time class, this method converts it to a String
+  # that conforms to PuppetDB's wire format for representing a date/time.
+  def self.to_wire_time(time)
+    # The current implementation simply calls iso8601, but having this method
+    # allows us to change that in the future if needed w/o being forced to
+    # update all of the date objects elsewhere in the code.
+    time.iso8601(9)
+  end
+
+  # Convert a value (usually a string) to a boolean
+  def self.to_bool(value)
+    case value
+    when true, "true"; return true
+    when false, "false"; return false
+    else
+      raise ArgumentError.new("invalid value for Boolean: \"#{val}\"")
+    end
+  end
+
+  # @!group Public instance methods
+
+  # Submit a command to PuppetDB.
+  #
+  # @param certname [String] hostname name of puppetdb instance
+  # @param payload [String] payload
+  # @param command_name [String] name of command
+  # @param version [Number] version number of command
+  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)
+      command.submit
+    end
+  end
+
+  # Profile a block of code and log the time it took to execute.
+  #
+  # This outputs logs entries to the Puppet masters logging destination
+  # providing the time it took, a message describing the profiled code
+  # and a leaf location marking where the profile method was called
+  # in the profiled hierachy.
+  #
+  # @param message [String] A description of the profiled event
+  # @param block [Block] The segment of code to profile
+  # @api public
+  def profile(message, &block)
+    message = "PuppetDB: " + message
+    Puppet::Util::Profiler.profile(message, &block)
+  end
+
+  # @!group Private instance methods
+
+  # @api private
+  def config
+    Puppet::Util::Puppetdb.config
+  end
+
+  # @api private
+  def log_x_deprecation_header(response)
+    if warning = response['x-deprecation']
+      Puppet.deprecation_warning "Deprecation from PuppetDB: #{warning}"
+    end
+  end
+  module_function :log_x_deprecation_header
+
+end

data/lib/puppetdb/terminus/version.rb

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

data/lib/puppetdb/terminus.rb

@@ -0,0 +1,6 @@
+require "puppetdb/terminus/version"
+
+module PuppetDB
+  module Terminus
+  end
+end

data/lib/puppetdb-terminus.rb

@@ -0,0 +1 @@
+require 'puppetdb/terminus'

data/lib/quixoten-puppetdb-terminus.rb

@@ -0,0 +1 @@
+require 'puppetdb-terminus'

data/puppetdb-terminus.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'puppetdb/terminus/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "quixoten-puppetdb-terminus"
+  spec.version       = PuppetDB::Terminus::VERSION
+  spec.authors       = ["Devin Christensen"]
+  spec.email         = ["quixoten@gmail.com"]
+  spec.summary       = %q{PuppetDB Terminus}
+  spec.description   = %q{PuppetDB Terminus}
+  spec.homepage      = "https://github.com/quixoten/puppetdb-terminus"
+  spec.license       = "Apache 2.0"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: quixoten-puppetdb-terminus
+version: !ruby/object:Gem::Version
+  version: 2.0.0.rc1
+platform: ruby
+authors:
+- Devin Christensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: PuppetDB Terminus
+email:
+- quixoten@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/puppet/application/storeconfigs.rb
+- lib/puppet/face/node/deactivate.rb
+- lib/puppet/face/node/status.rb
+- lib/puppet/face/storeconfigs.rb
+- lib/puppet/indirector/catalog/puppetdb.rb
+- lib/puppet/indirector/facts/puppetdb.rb
+- lib/puppet/indirector/facts/puppetdb_apply.rb
+- lib/puppet/indirector/node/puppetdb.rb
+- lib/puppet/indirector/resource/puppetdb.rb
+- lib/puppet/reports/puppetdb.rb
+- lib/puppet/util/puppetdb.rb
+- lib/puppet/util/puppetdb/blacklist.rb
+- lib/puppet/util/puppetdb/char_encoding.rb
+- lib/puppet/util/puppetdb/command.rb
+- lib/puppet/util/puppetdb/command_names.rb
+- lib/puppet/util/puppetdb/config.rb
+- lib/puppet/util/puppetdb/global_check.rb
+- lib/puppetdb-terminus.rb
+- lib/puppetdb/terminus.rb
+- lib/puppetdb/terminus/version.rb
+- lib/quixoten-puppetdb-terminus.rb
+- puppetdb-terminus.gemspec
+homepage: https://github.com/quixoten/puppetdb-terminus
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: PuppetDB Terminus
+test_files: []