hieracles 0.2.0 → 0.2.1

data/lib/hieracles/options/ppdb.rb

@@ -0,0 +1,32 @@
+require 'hieracles/optparse'
+
+module Hieracles
+  module Options
+    class Ppdb < Hieracles::Optparse
+
+      def available_options
+        {
+          version: {
+            has_arg: false,
+            aliases: ['v', 'version']
+          }
+        }
+      end
+
+      def self.usage
+        return <<-END
+
+Usage: ppdb <endpoint> <command> [extra_args]
+
+Available commands:
+  node info <fqdn>
+  node facts <fqdn>
+  node resources <fqdn>
+
+        END
+      end
+
+    end
+  end
+end
+    

data/lib/hieracles/optparse.rb

@@ -4,48 +4,9 @@ module Hieracles
     
     attr_reader :options, :payload
 
-    OPTIONS = {
-      config: {
-        has_arg: true,
-        aliases: ['c', 'conf', 'config']
-      },
-      format: {
-        has_arg: true,
-        aliases: ['f', 'format']
-      },
-      params: {
-        has_arg: true,
-        aliases: ['p', 'params']
-      },
-      hierafile: {
-        has_arg: true,
-        aliases: ['h', 'hierafile']
-      },
-      basepath: {
-        has_arg: true,
-        aliases: ['b', 'basepath']
-      },
-      encpath: {
-        has_arg: true,
-        aliases: ['e', 'encpath']
-      },
-      version: {
-        has_arg: false,
-        aliases: ['v', 'version']
-      },
-      yaml_facts: {
-        has_arg: true,
-        aliases: ['y', 'yaml']
-      },
-      json_facts: {
-        has_arg: true,
-        aliases: ['j', 'json']
-      },
-      interactive: {
-        has_arg: false,
-        aliases: ['i', 'interactive']
-      }
-    }
+    def available_options
+      {}
+    end
 
     def initialize(array)
       @options = {}
@@ -71,7 +32,7 @@ module Hieracles
 
     def optionkeys
       back = {}
-      OPTIONS.each do |k, v|
+      available_options.each do |k, v|
         v[:aliases].each do |a|
           back[a] = { var: k, has_args: v[:has_arg] }
         end

data/lib/hieracles/puppetdb.rb

@@ -0,0 +1,12 @@
+require 'hieracles/puppetdb/fixsslconnectionadapter'
+require 'hieracles/puppetdb/apierror'
+require 'hieracles/puppetdb/query'
+require 'hieracles/puppetdb/filter'
+require 'hieracles/puppetdb/client'
+require 'hieracles/puppetdb/request'
+require 'hieracles/puppetdb/response'
+
+module Hieracles
+  module Puppetdb
+  end
+end

data/lib/hieracles/puppetdb/apierror.rb

@@ -0,0 +1,10 @@
+module Hieracles
+  module Puppetdb
+    class APIError < Exception
+      attr_reader :code, :response
+      def initialize(response)
+        @response = response
+      end
+    end
+  end
+end

data/lib/hieracles/puppetdb/client.rb

@@ -0,0 +1,63 @@
+require 'httparty'
+
+module Hieracles
+  module Puppetdb
+    class Client
+      include HTTParty
+ 
+      def initialize(options, version = 3)
+        @version = version
+        setup_if_ssl(options)
+        options['port'] ||= 8080
+        options['host'] ||= 'localhost'
+        scheme = options['usessl'] ? "https://" : "http://"
+        self.class.base_uri(scheme + 
+          options['host'] +
+          ':' + options['port'].to_s +
+          '/v' + @version.to_s())
+      end
+
+      def setup_if_ssl(options)
+        if options['usessl']
+          self.class.default_options = {:options => options}
+          self.class.connection_adapter(FixSSLConnectionAdapter)
+        end
+      end
+
+      def request(endpoint, method = 'get', query = nil, opts = {})
+        ret = send("#{method}_request".to_sym, endpoint, query, opts)
+        if ret.code.to_s() =~ /^[4|5]/ or ret.parsed_response.length < 1
+          notifications = [ Hieracles::Notification.new('puppetdb', 'No match.', 'error') ]
+          Response.new({}, 0, notifications)
+        else
+          total = ret.headers['X-Records']
+          if total.nil?
+            total = ret.parsed_response.length
+          end
+
+          Response.new(ret.parsed_response, total)
+        end
+      end
+
+      def get_request(endpoint, query, opts)
+        path = "/" + endpoint
+        if query
+          json_query = JSON.dump(query)
+          filtered_opts = {'query' => json_query}
+          opts.each do |k,v|
+            if k == :counts_filter
+              filtered_opts['counts-filter'] = JSON.dump(v)
+            else
+              filtered_opts[k.to_s.sub("_", "-")] = v
+            end
+          end
+          puts path ; puts filtered_opts ; exit(0)
+          self.class.get(path, query: filtered_opts)
+        else
+          self.class.get(path)
+        end
+      end
+
+    end
+  end
+end

data/lib/hieracles/puppetdb/filter.rb

@@ -0,0 +1,15 @@
+module Hieracles
+  module Puppetdb
+    class Filter
+
+      def initialize(regexp)
+        @regexp = Regexp.new(regexp)
+      end
+
+      def match(something)
+        @regexp.match something
+      end
+
+    end
+  end
+end

data/lib/hieracles/puppetdb/fixsslconnectionadapter.rb

@@ -0,0 +1,25 @@
+require 'httparty'
+
+module Hieracles
+  module Puppetdb
+    class FixSSLConnectionAdapter < HTTParty::ConnectionAdapter
+      def attach_ssl_certificates(http, options)
+        raise(IOError, "Cert file #{options['cert']} not found.") unless File.exist? options['cert'].to_s
+        raise(IOError, "Key file #{options['key']} not found.") unless File.exist? options['key']
+        raise(IOError, "CA file #{options['ca_file']} not found.") unless File.exist? options['ca_file']
+        http.cert = OpenSSL::X509::Certificate.new(File.read(options['cert']))
+        if options['key_password']
+          http.key = OpenSSL::PKey::RSA.new(File.read(options['key']), options['key_password'])
+        else
+          http.key = OpenSSL::PKey::RSA.new(File.read(options['key']))
+        end
+        http.ca_file = options['ca_file']
+        if options['verify_peer']
+          http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        else
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+      end
+    end
+  end
+end

data/lib/hieracles/puppetdb/query.rb

@@ -0,0 +1,79 @@
+module Hieracles
+  module Puppetdb
+    class Query
+
+      def initialize(elements)
+        @elements = parse(elements)
+      end
+
+      def parse(elements)
+        items = []
+        index = 0
+        if elements.length > 1
+          elements.each do |e|
+            puts items.inspect
+            if e == 'or'
+              index++
+              continue
+            end
+            if /(.*)(>|<|=|!=|~)(.*)/.match e
+              items[index] ||= []
+              items[index] << [$2, $1, $3]
+            end
+          end
+        else
+          if /(.*)(>|<|=|!=|~)(.*)/.match elements[0]
+            items = [$2, $1, $3]
+          end
+        end
+        items
+      end
+
+      def output
+        back = []
+        if @elements.length > 1
+          back << 'or' 
+          @elements.each do |e|
+            back << build_and(e)
+          end
+        else
+          @elements.each do |e|
+            back << build_and(e)
+          end
+        end
+        back
+      end
+
+      def build_and(arrays)
+        if arrays.length > 1
+          ['and', arrays]
+        else
+          arrays
+        end
+      end
+
+      def defined?
+        @elements.count > 0
+      end
+
+      def match(item)
+        @elements.each do |e|
+          matched = false
+          e.each do |a|
+            case a[0]
+            when '='
+
+            when '!='
+            when '<'
+            when '>'
+            when '!'
+            else
+            end
+          end
+          return true if matched
+        end
+      end
+
+    end
+  end
+end

data/lib/hieracles/puppetdb/request.rb

@@ -0,0 +1,44 @@
+module Hieracles
+  module Puppetdb
+    class Request
+
+      def initialize(options)
+        @client = Hieracles::Puppetdb::Client.new options
+      end
+
+      def node_info(fqdn)
+        @client.request("nodes/#{fqdn}")
+      end
+      alias_method :node_infos, :node_info
+
+      def node_facts(fqdn, regex = //)
+        resp = @client.request("nodes/#{fqdn}/facts")
+        filter = Filter.new regex
+        resp.data = resp.data.reduce({}) do |a, d|
+          if filter.match(d['name'])
+            a[d['name'].to_sym] = d['value']
+          end
+          a
+        end
+        resp
+      end
+      alias_method :node_fact, :node_facts
+
+      def node_resources(fqdn, *args)
+        resp = @client.request("nodes/#{fqdn}/resources")
+        field = args.shift
+        resp.data = resp.data.reduce({})  do |a, d|
+          if !field || Regexp.new(field).match(d['title'])
+            a[d['title']] = d
+          end
+          a
+        end
+        resp
+      end
+      alias_method :node_res, :node_resources
+
+
+
+    end
+  end
+end

data/lib/hieracles/puppetdb/response.rb

@@ -0,0 +1,14 @@
+module Hieracles
+  module Puppetdb
+    class Response
+      attr_reader :data, :total_records, :notifications
+      attr_writer :data
+
+      def initialize(data, total_records = nil, notifications = nil)
+        @data = data
+        @total_records = total_records
+        @notifications = notifications
+      end
+    end
+  end
+end

data/ppdb.1

@@ -0,0 +1,158 @@
+.TH ppdb 1 "2015-12-05" "version 0.2.1" "Hieracles command manual"
+
+.SH NAME
+ppdb \- Command line tool to query puppetdb
+.SH SYNOPSIS
+.B ppdb 
+.I object
+.I command
+.B [
+.I options
+.B ]
+
+.SH DESCRIPTION
+.PP
+This tool is part of the Hieracles tools suite.
+.PP
+PuppetDB stores information gathered by Puppet when nodes run 
+the puppet client. It exposes a very neat REST interface, but 
+its query system can be a little complicated.
+.PP
+The purpose of 
+.B ppdb
+is to overlay the calls to the REST API and propose a more
+user-friendly way to query the Puppet Database (puppetdb).
+.PP
+Note that this tool is designed to work fine with the version 3 
+of the PuppetDB API.
+.PP
+Ref http://docs.puppetlabs.com/puppetdb/2.3/api/
+.PP
+.B ppdb
+takes at minimum 2 arguments, an object (or endpoint)
+and a subcommand, plus extra parameters depending the subcommand.
+.PP
+The object is like the endpoint in PuppetDB API, but we extend it 
+to a different list of possible objects:
+
+.IP node 10
+Uses the nodes endpoint. It accepts the subcommands:
+.RS
+
+.IP info 10
+will display the equivalent of 
+.I "GET /v3/nodes/<NODE>"
+and takes the node 
+.B certname
+as an argument. 
+.RS 10
+Optionaly, you can add a filter to limit what fields are displayed.
+.TP
+eg. ppdb node info <fqdn>
+.RS
+will display all the fields from the API response
+.RE
+eg. ppdb node info <fqdn> time
+.RS
+will only display the fields containing 
+.I time
+in their label.
+.RE
+.RE
+
+.IP facts 10
+will display the equivalent of 
+.I "GET /v3/nodes/<NODE>/facts"
+and takes the node 
+.B certname
+as an argument. 
+.RS 10
+As the result can be verbose, you can add a filter to limit what 
+fields are displayed.
+.TP
+eg. ppdb node facts <fqdn>
+.RS
+will display all the fields from the API response
+.RE
+eg. ppdb node facts <fqdn> memory
+.RS
+will only display the fields containing 
+.I memory
+in their label.
+.RE
+.RE
+
+.IP resources 10
+will display the equivalent of 
+.I "GET /v3/nodes/<NODE>/resources"
+and takes the node 
+.B certname
+as an argument. You can use 
+.I res
+instead of 
+.I resources
+for shorter.
+.RS 10
+As the result can be verbose, you can add a filter to limit what 
+resources are displayed.
+.TP
+eg. ppdb node res <fqdn>
+.RS
+will display all the fields from the API response
+.RE
+eg. ppdb node res <fqdn> nagios
+.RS
+will only display the fields containing 
+.I nagios
+in their label.
+.RE
+.RE
+
+.SH OPTIONS
+
+.TP
+.PD 0
+.B \-v
+.TP
+.PD
+.B \-\-version
+outputs version.
+
+
+.SH FILES
+.I ~/.config/hieracles/config.yaml
+.RS
+ppdb uses the same configuration file as hieracles, and relies on
+its information to find the url of the PuppetDB
+
+.SH EXAMPLES
+A typical config file would contain, at minimum:
+.PP
+.RS
+---
+.RE
+.RS
+puppetdb:
+.RS
+  usessl: false
+.RE
+.RS
+  host: localhost
+.RE
+.RS
+  port: 8080
+.RE
+.RE
+
+.SH SEE ALSO
+hiera(1), puppet(8), hc(1)
+
+.SH BUGS
+Please report any bug to https://github.com/Gandi/hieracles/issues
+
+.SH AUTHORS
+Copyright (c) 2015 gandi.net https://gandi.net
+.LP
+Hieracles is written by mose@gandi.net
+.LP
+https://github.com/Gandi/hieracles