hieracles 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a6b5269d88007785d1a82bc4ea5d9a6575206923
-  data.tar.gz: 3771f9302b9061157874ab0bf715f6c1588525ef
+  metadata.gz: 576b1abbe8d06fcf61896855b5474ed2d549e277
+  data.tar.gz: 79022f2d38d33472e1e629724ebc4882c7718ba3
 SHA512:
-  metadata.gz: e475ba6285c981327d5dd5a662bc8ed27d82606c3a78c383f5f2a9e0cbd8d85666bd8f3a2641ad0c2bd883f960ac7892fba3760d91d38e8e008f8d6f7aec7d4d
-  data.tar.gz: 8f554bbede7cf6fb3dceca5cf6f18c62defd5ee89b1b20df4a9403014044713b53f931e0e38c85cebe03fa990f67b0ab0ac3c01e41291bced3b9eea89b229303
+  metadata.gz: fd35c1ac42aca8724d507904387fb8bbd9543977482bd47e12e8e6301ec09e31ad655521b25904cd99c155caa5bb1ad1799e4e2ee3e4008fdc76f5582eb01139
+  data.tar.gz: 8a0528fd874dc417140713ac28858f131f0d858a843e4df1d07861934e7ac57d18061201ba360876333f986457be88f1365c94562d50b5d50331162b77cedc81

data/CHANGELOG.md

@@ -1,6 +1,17 @@
 Hieracles Changelog
 =======================
 
+### 0.3.0 - 2015-12-16
+- added json output as an option to ppdb
+- added some more ppdb commands
+  - ppdb resources <queries>
+  - ppdb same
+  - ppdb factnames
+- updated manpage for ppdb with proper documentation
+- prepare a queries transformation class to 
+  match puppetdb weird query language with a more human one
+- updated ppdb zsh completion
+
 ### 0.2.2 - 2015-12-11
 - remove support for ruby 1.9.3
   because of the mime-type gem

data/bin/ppdb

@@ -12,31 +12,40 @@ if opt.options.has_key? :version
   exit(0)
 end
 
-unless opt.payload[1]
+unless opt.payload[0]
   puts Hieracles::Options::Ppdb.usage
   exit(1)
 end
 
-command = "#{opt.payload[0]}_#{opt.payload[1]}"
-args = opt.payload[2..-1] || []
+endpoint = opt.payload[0]
 
+if Hieracles::Puppetdb::Request.method_defined? endpoint
+  command = endpoint
+  args = opt.payload[1..-1] || []
+elsif Hieracles::Puppetdb::Request.method_defined? "#{opt.payload[0]}_#{opt.payload[1]}"
+  command = "#{opt.payload[0]}_#{opt.payload[1]}"
+  args = opt.payload[2..-1] || []
+else
+  puts "*** Unknown command: #{command}"
+  puts Hieracles::Options::Ppdb.usage
+  exit(1)
+end
+  
 Hieracles::Config.load opt.options
 
-if Hieracles::Puppetdb::Request.method_defined? command
-  request = Hieracles::Puppetdb::Request.new Hieracles::Config.puppetdb
-  meth = request.method(command.to_sym)
-  required = request.method(command.to_sym).parameters.select { |arg| arg[0] == :req }.map { |arg| arg[1] }
-  if args.length < required.length
-    args = required.join(', ')
-    puts "*** The #{command} method requires arguments: #{args}"
-    exit(1)
+request = Hieracles::Puppetdb::Request.new Hieracles::Config.puppetdb
+meth = request.method(command.to_sym)
+required = request.method(command.to_sym).parameters.select { |arg| arg[0] == :req }.map { |arg| arg[1] }
+if args.length < required.length
+  args = required.join(', ')
+  puts "*** The #{command} method requires arguments: #{args}"
+  exit(1)
+else
+  if Hieracles::Config.format == 'Json'
+    format = Hieracles::Formats::Json.new(nil)
   else
     format = Hieracles::Formats::Console.new(nil)
-    resp = meth.call(*args)
-    puts format.build_list(resp.data, resp.notifications, [])
   end
-else
-  puts "*** Unknown command: #{command}"
-  puts Hieracles::Options::Ppdb.usage
-  exit(1)
+  resp = meth.call(*args)
+  puts format.build_list(resp.data, resp.notifications, [])
 end

data/lib/hieracles/formats/console.rb

@@ -35,17 +35,23 @@ module Hieracles
 
       def build_list(hash, notifications, filter)
         back = ''
-        back << build_notifications(notifications) if notifications
-        if filter[0]
-          hash.select! { |k, v| Regexp.new(filter[0]).match(k.to_s) }
-        end
-        length = max_key_length(hash) + 2
-        title = format(COLORS[8], "%-#{length}s")
-        hash.each do |k, v|
-          if v.class.name == 'Hash' || v.class.name == 'Array'
-            v = v.ai({ indent: 10, raw: true}).strip
+        if hash.class.name == 'Array'
+          hash.each do |v|
+            back << "#{v}\n"
+          end
+        else
+          back << build_notifications(notifications) if notifications
+          if filter[0]
+            hash.select! { |k, v| Regexp.new(filter[0]).match(k.to_s) }
+          end
+          length = max_key_length(hash) + 2
+          title = format(COLORS[8], "%-#{length}s")
+          hash.each do |k, v|
+            if v.class.name == 'Hash' || v.class.name == 'Array'
+              v = v.ai({ indent: 10, raw: true}).strip
+            end
+            back << format("#{title} %s\n", k, v)
           end
-          back << format("#{title} %s\n", k, v)
         end
         back
       end

data/lib/hieracles/formats/json.rb

@@ -33,6 +33,13 @@ module Hieracles
         @node.params(false).merge(alerts).to_json
       end
 
+      def build_list(hash, notifications, filter)
+        {
+          'notifications' => notifications,
+          'payload' => hash
+        }.to_json
+      end
+
     private
 
       def alerts

data/lib/hieracles/options/ppdb.rb

@@ -9,6 +9,10 @@ module Hieracles
           version: {
             has_arg: false,
             aliases: ['v', 'version']
+          },
+          format: {
+            has_arg: true,
+            aliases: ['f', 'format']
           }
         }
       end
@@ -16,13 +20,20 @@ module Hieracles
       def self.usage
         return <<-END
 
-Usage: ppdb <endpoint> <command> [extra_args]
+Usage: ppdb <command> [extra_args]
 
 Available commands:
   node info <fqdn>
   node facts <fqdn>
   node resources <fqdn>
-
+  facts <name> <value>
+  same <name> <fqdn>
+  factnames
+  res[ources] <query>
+              query following the form:
+              type=sometype title=what
+              type=sometype or type=another
+              type~someregexp type!~excluded
         END
       end
 

data/lib/hieracles/puppetdb/client.rb

@@ -24,7 +24,7 @@ module Hieracles
         end
       end
 
-      def request(endpoint, method = 'get', query = nil, opts = {})
+      def request(endpoint, query = nil, method = 'get', 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') ]
@@ -34,7 +34,6 @@ module Hieracles
           if total.nil?
             total = ret.parsed_response.length
           end
-
           Response.new(ret.parsed_response, total)
         end
       end
@@ -51,7 +50,7 @@ module Hieracles
               filtered_opts[k.to_s.sub("_", "-")] = v
             end
           end
-          puts path ; puts filtered_opts ; exit(0)
+          #puts path ; puts filtered_opts ; exit(0)
           self.class.get(path, query: filtered_opts)
         else
           self.class.get(path)

data/lib/hieracles/puppetdb/query.rb

@@ -2,78 +2,67 @@ module Hieracles
   module Puppetdb
     class Query
 
+      attr_reader :elements
+
       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
+        if number_or(elements) > 0
+          elements = build_or(elements)
         end
-        items
+        build_and elements
       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)
+      def build_and(arrays)
+        back = arrays.reduce([]) do |a, v|
+          if v.class.name == 'Array'
+            if v.length > 1
+              a << ['and'] + v.map { |e| expression(e) }
+            else
+              e = expression(v[0])
+              a << e if e
+            end
+          elsif v == 'or'
+            a << 'or'
+          else
+            e = expression(v)
+            a << e if e
           end
+          a
+        end
+        if back.length == 1 and back[0].class.name == 'Array'
+          back = back[0]
+        elsif back[0].class.name == 'Array' and back.length > 1
+          back.unshift('and')
         end
         back
       end
 
-      def build_and(arrays)
-        if arrays.length > 1
-          ['and', arrays]
-        else
-          arrays
+      def build_or(arrays)
+        back = ['or']
+        (0..number_or(arrays)-1).each do |a|
+          back << arrays.slice!(0..arrays.index('or')-1)
+          arrays.shift
         end
+        back << arrays
       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
+      def expression(e)
+        if /([^!]*)(!)?(>|<|=|~)(.*)/.match e
+          if $2
+            ['not', [$3, $1, $4]]
+          else
+            [$3, $1, $4]
           end
-          return true if matched
         end
       end
 
+      def number_or(a)
+        a.select { |i| i == 'or' }.length
+      end
+
     end
   end
 end

data/lib/hieracles/puppetdb/request.rb

@@ -27,17 +27,54 @@ module Hieracles
       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
+        make_hashed resp
+      end
+      alias_method :node_res, :node_resources
+
+      def facts(label, value)
+        resp = @client.request("facts/#{label}/#{value}")
+        extract_names resp
+      end
+
+      def same(name, fqdn)
+        r = @client.request("nodes/#{fqdn}/facts/#{name}")
+        if r.data.length > 0
+          value = r.data[0]['value']
+          facts name, value
+        else
+          r
+        end
+      end
+
+      def factnames()
+        @client.request("fact-names")
+      end
+
+      def resources(*args)
+        query = Query.new args
+        make_hashed @client.request("resources", query.elements)
+      end
+      alias_method :res, :resources
+
+    private
+
+      def extract_names(resp, label = 'certname')
+        resp.data = resp.data.reduce([]) do |a, d|
+          a << d[label]
+          a
+        end.sort
+        resp
+      end
+
+      def make_hashed(resp, label = 'title', filter = nil)
+        resp.data = resp.data.reduce({}) do |a, d|
+          if !filter || Regexp.new(filter).match(d[label])
+            a[d[label]] = d
           end
           a
         end
         resp
       end
-      alias_method :node_res, :node_resources
-
-
 
     end
   end

data/ppdb.1

@@ -4,7 +4,6 @@
 ppdb \- Command line tool to query puppetdb
 .SH SYNOPSIS
 .B ppdb 
-.I object
 .I command
 .B [
 .I options
@@ -29,17 +28,11 @@ of the PuppetDB API.
 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
+takes a command, plus extra parameters depending the command.
 
-.IP info 10
+.TP
+.PD 0
+.B node info \fR<fqdn>
 will display the equivalent of 
 .I "GET /v3/nodes/<NODE>"
 and takes the node 
@@ -60,7 +53,9 @@ in their label.
 .RE
 .RE
 
-.IP facts 10
+.TP
+.PD 0
+.B node facts \fR<fqdn>
 will display the equivalent of 
 .I "GET /v3/nodes/<NODE>/facts"
 and takes the node 
@@ -82,7 +77,9 @@ in their label.
 .RE
 .RE
 
-.IP resources 10
+.TP
+.PD 0
+.B node resources \fR<fqdn>
 will display the equivalent of 
 .I "GET /v3/nodes/<NODE>/resources"
 and takes the node 
@@ -108,6 +105,65 @@ in their label.
 .RE
 .RE
 
+.RE
+
+.TP
+.PD 0
+.B facts <name> <value>
+will list all fqdn (aka. certnames) of the nodes having the <name> 
+fact set to <value>.
+.RS
+eq. ppdb facts puppet_environment dev
+.RE
+
+.TP
+.PD 0
+.B same <name> <fqdn>
+will list all the fqdn having the same value for the fact <name> as
+<fqdn> has.
+.RS
+eq. ppdb same farm node32.example.com
+.RE
+
+.TP
+.PD 0
+.B resources <queries>
+.TP
+.PD
+.B res <queries>
+will list the resources matching a given set of queries. 
+Queries are a combination of statements, with a label, an operator
+and a value. You can use 
+.I or
+to separate one or several statements. If there is no
+.I or
+indicated, the statements follow an
+.I and 
+logic. All statements that don't contain an operator or match the 
+.I or
+keyword are purely ignored (which makes possible to use the 
+.I and
+keyword for mental stability purpose).
+
+.RS
+Operators can be >, <, =, ~ and can be prefixed by a ! to negate them.
+.RS
+eq. ppdb res type=Nagios_ghost and tag~api
+.RE
+.RS
+eq. ppdb res tag~api title!~dev
+.RE
+.RS
+eq. ppdb res tag~api or certname~api or title~api
+.RE
+.RE
+
+.TP
+.PD 0
+.B factnames
+will list all the factnames puppetdb knows about.
+This may be a long list.
+
 .SH OPTIONS
 
 .TP
@@ -118,6 +174,15 @@ in their label.
 .B \-\-version
 outputs version.
 
+.TP
+.PD 0
+.B \-f \fRformat
+.TP
+.PD
+.B \-\-format \fRformat
+outputs in the selected format. For now only the json format
+is available as an alternative to the default console format.
+
 
 .SH FILES
 .I ~/.config/hieracles/config.yaml

data/spec/lib/puppetdb/client_spec.rb

@@ -26,7 +26,7 @@ describe Hieracles::Puppetdb::Client do
   describe '.request' do
     context 'with a GET request' do
       let(:client) { Hieracles::Puppetdb::Client.new Hash.new }
-      let(:request) { client.request('endpoint', 'get')}
+      let(:request) { client.request('endpoint')}
       let(:response) { Hieracles::Puppetdb::Response.new(Hash.new, 0, Array.new) }
       before {
         resp = double
@@ -49,7 +49,7 @@ describe Hieracles::Puppetdb::Client do
   describe '.get_request' do
     let(:client) { Hieracles::Puppetdb::Client.new Hash.new }
     context 'without query' do
-      let(:request) { client.request('endpoint', 'get')}
+      let(:request) { client.request('endpoint')}
       before {
         allow(client.class).
           to receive(:get).

data/spec/lib/puppetdb/query_spec.rb

@@ -2,18 +2,6 @@ require 'spec_helper'
 
 describe Hieracles::Puppetdb::Query do
 
-  describe '.new' do
-    let(:elements) { [ 'something=value' ] }
-    let(:query) { Hieracles::Puppetdb::Query.new elements }
-    before {
-      allow(query).
-        to receive(:parse).
-        with(elements).
-        and_return(['=', 'something', 'value'])
-    }
-    it { expect(query.instance_variable_get(:@elements)).to eq ['=', 'something', 'value'] }
-  end
-
   describe '.parse' do
     context 'with a single argument not matching an assignment' do
       let(:elements) { [ 'anything' ] }
@@ -29,11 +17,91 @@ describe Hieracles::Puppetdb::Query do
     end
     context 'with 2 arguments matching an assignment' do
       let(:elements) { [ 'something=value', 'another=else' ] }
-      let(:expected) { [['=', 'something', 'value'], ['=', 'another', 'else']] }
+      let(:expected) { ['and', ['=', 'something', 'value'], ['=', 'another', 'else']] }
+      let(:query) { Hieracles::Puppetdb::Query.new elements }
+      it { expect(query.instance_variable_get(:@elements)).to eq expected }
+    end
+    context 'with 3 arguments but only 2 match assignment' do
+      let(:elements) { [ 'something=value', 'and', 'another=else' ] }
+      let(:expected) { ['and', ['=', 'something', 'value'], ['=', 'another', 'else']] }
+      let(:query) { Hieracles::Puppetdb::Query.new elements }
+      it { expect(query.instance_variable_get(:@elements)).to eq expected }
+    end
+    context 'with 2 arguments separated by a or' do
+      let(:elements) { [ 'something=value', 'or', 'another=else' ] }
+      let(:expected) { ['or', ['=', 'something', 'value'], ['=', 'another', 'else']] }
       let(:query) { Hieracles::Puppetdb::Query.new elements }
-      #it { expect(query.instance_variable_get(:@elements)).to eq expected }
+      it { expect(query.instance_variable_get(:@elements)).to eq expected }
     end
+    context 'with 3 arguments including a or' do
+      let(:elements) { [ 'something=value', 'or', 'another=else', 'more=ever' ] }
+      let(:expected) { 
+        [ 'or',
+          ['=', 'something', 'value'], 
+          ['and', ['=', 'another', 'else'], ['=', 'more', 'ever']]
+          ] 
+      }
+      let(:query) { Hieracles::Puppetdb::Query.new elements }
+      it { expect(query.instance_variable_get(:@elements)).to eq expected }
+    end
+  end
 
+  describe '.build_and' do
+    let(:query) { Hieracles::Puppetdb::Query.new [] }
+    context 'with no and' do
+      let(:array) { ["a=b"]}
+      let(:expected) { ['=', 'a', 'b'] }
+      it { expect(query.send(:build_and, array)).to eq expected }
+    end
+    context 'with a single and' do
+      let(:array) { ["a=b",  "a=c"]}
+      let(:expected) { ['and', ['=', 'a', 'b'],['=', 'a', 'c']] }
+      it { expect(query.send(:build_and, array)).to eq expected }
+    end
+
+  end
+
+  describe '.build_or' do
+    let(:query) { Hieracles::Puppetdb::Query.new [] }
+    context 'with a single or' do
+      let(:array) { ["a=b", "or", "a=c"]}
+      let(:expected) { ['or', ['a=b'],['a=c']]}
+      it { expect(query.send(:build_or, array)).to eq expected }
+    end
+    context 'with a double or' do
+      let(:array) { ["a=b", "or", "a=c", "or", "a=d"]}
+      let(:expected) { ['or', ['a=b'],['a=c'],['a=d']]}
+      it { expect(query.send(:build_or, array)).to eq expected }
+    end
+    context 'with a double or and multiple ands' do
+      let(:array) { ["a=b", "a=x", "or", "a=c", "or", "a=d"]}
+      let(:expected) { ['or', ['a=b', 'a=x'],['a=c'],['a=d']]}
+      it { expect(query.send(:build_or, array)).to eq expected }
+    end
+  end
+
+  describe '.expression' do
+    let(:query) { Hieracles::Puppetdb::Query.new [] }
+    context 'with a = sign' do
+      let(:string) { 'a=b' }
+      let(:expected) { ['=', 'a', 'b']}
+      it { expect(query.send(:expression, string)).to eq expected }      
+    end
+    context 'with a != sign' do
+      let(:string) { 'a!=b' }
+      let(:expected) { ['not', ['=', 'a', 'b']]}
+      it { expect(query.send(:expression, string)).to eq expected }      
+    end
+    context 'with a ~ sign' do
+      let(:string) { 'a~b' }
+      let(:expected) { ['~', 'a', 'b']}
+      it { expect(query.send(:expression, string)).to eq expected }      
+    end
+    context 'with a !~ sign' do
+      let(:string) { 'a!~b' }
+      let(:expected) { ['not', ['~', 'a', 'b']]}
+      it { expect(query.send(:expression, string)).to eq expected }      
+    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hieracles
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - mose
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-11 00:00:00.000000000 Z
+date: 2015-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty