lita-puppet 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21c2bf71dcadd164239ace4a8810aa2a7ef3ac78
-  data.tar.gz: 769464679133edea58a9d1e7791af3b5a39efea9
+  metadata.gz: b1b3f7b216de57ce1507c62606049abe09c4a6d7
+  data.tar.gz: bf814b1efdb2b666499d4df0149fe28bbbeff81d
 SHA512:
-  metadata.gz: 5b5d3cc7423f4b833e0658cb23a3aa3c473def0f9576ff1f7c803d3b486af75bf4be55a8211eb2dc64fbaeb92e5a5a9120cf2bba5dd024bc7b573c23c3561fc6
-  data.tar.gz: fd0bbf3801dc0e55b8b6ea8ab93cf5fd19795b6303f75e3f99db94413f55d10009656864f560039950fcf9f5d0c8b9dbac3b17bd5d38cb7e04658de2b9157998
+  metadata.gz: 0b01deb2674c47f115759323cae6093828d2aa9d5c727068c3f97edd1e83b69957d4c029682cf07ddaf6a3dc2b6ca8399d9c592a9ca1b64cb2cadc631ff28ed3
+  data.tar.gz: 40617d283ae66ef75a502f68ebcced9c35e126b5227e3057b96f62f92f972b2d557569463729199a5b7fe8d5f4f2b6f37a50dcc407e2d6581c9da6768396ace8

data/.rubocop.yml

@@ -16,7 +16,7 @@ Metrics/MethodLength:
   Max: 20
 
 Metrics/ClassLength:
-  Max: 150
+  Max: 165
 
 Metrics/BlockLength:
   Max: 30

data/README.md

@@ -94,3 +94,19 @@ This is also available as:
     pp class nodes <class>
 
 Where `<class>` is a class name as it shows up in the catalog. Usually something like Role::Foo_bar
+
+#### Query PuppetDB for the fact value of a given node
+`puppet fact <certname> <fact>`
+
+This is also available as:
+
+`pp fact <certname> <fact>`
+
+#### Query PuppetDB for some basic info about a node
+`puppet <certname> info`
+
+This is also available as:
+
+`pp <certname> info`
+
+This queries the [PuppetDB nodes endpoint](https://docs.puppet.com/puppetdb/4.4/api/query/v4/nodes.html) 

data/Rakefile

@@ -5,4 +5,4 @@ require 'rubocop/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:spec, :rubocop]
+task default: %i[spec rubocop]

data/lib/lita/handlers/puppet.rb

@@ -40,6 +40,20 @@ module Lita
         help: { t('help.nodes_with_class.syntax') => t('help.nodes_with_class.desc') }
       )
 
+      route(
+        /(puppet|pp)\s+(fact)\s+(\S+)\s+(\S+)/i,
+        :node_facts,
+        command: true,
+        help: { t('help.node_facts.syntax') => t('help.node_facts.desc') }
+      )
+
+      route(
+        /(puppet|pp)\s+(\S+)\s+(info)/i,
+        :nodes_info,
+        command: true,
+        help: { t('help.nodes_info.syntax') => t('help.nodes_info.desc') }
+      )
+
       route(
         /(puppet|pp)\s+(r10k|deploy)(\s+(\S+)(\s+(\S+))?)?/i,
         :r10k_deploy,
@@ -92,16 +106,10 @@ module Lita
       def node_profiles(response)
         host = response.matches[0][2]
         what = response.matches[0][1]
-        url  = config.puppetdb_url
-
-        unless url
-          response.reply(t('replies.node_profiles.notconf'))
-          return false
-        end
 
         response.reply_with_mention(t('replies.node_profiles.working'))
 
-        profiles = node_roles_and_profiles(url, what, host)
+        profiles = node_roles_and_profiles(what, host)
 
         if profiles.is_a? String
           fail_message response, t('replies.node_profiles.failure', error: profiles)
@@ -116,16 +124,10 @@ module Lita
 
       def nodes_with_class(response)
         puppet_class = response.matches[0][3]
-        url = config.puppetdb_url
-
-        unless url
-          response.reply(t('replies.nodes_with_class.notconf'))
-          return false
-        end
 
         response.reply_with_mention(t('replies.nodes_with_class.working'))
 
-        puppet_classes = class_nodes(url, class_camel(puppet_class))
+        puppet_classes = class_nodes(class_camel(puppet_class))
         if puppet_classes.empty?
           fail_message response, t('replies.nodes_with_class.failure', pclass: puppet_class)
         else
@@ -137,6 +139,31 @@ module Lita
         end
       end
 
+      def node_facts(response)
+        host = response.matches[0][2]
+        fact = response.matches[0][3]
+        result = query_fact(host, fact)
+        if result.nil?
+          response.reply_with_mention(
+            t('replies.node_facts.error', host: host)
+          )
+        else
+          response.reply result
+        end
+      end
+
+      def nodes_info(response)
+        host = response.matches[0][1]
+        result = node_info(host)
+        if result.nil?
+          response.reply_with_mention(
+            t('replies.nodes_info.error', host: host)
+          )
+        else
+          response.reply result
+        end
+      end
+
       # rubocop:disable Metrics/AbcSize
       def r10k_deploy(response)
         environment = response.matches[0][3]

data/lib/utils/lita_puppet/puppetdb.rb

@@ -2,16 +2,19 @@ module Utils
   module LitaPuppet
     # Utility methods for working with PuppetDB
     module PuppetDB
-      def class_nodes(url, classname)
-        client = ::PuppetDB::Client.new({
-                                          server: url,
-                                          pem: {
-                                            'key' => config.puppetdb_key,
-                                            'cert'    => config.puppetdb_cert,
-                                            'ca_file' => config.puppetdb_ca_cert
-                                          }
-                                        }, config.puppetdb_api_vers)
-        q = client.request(
+      def db_connect
+        ::PuppetDB::Client.new({
+                                 server: config.puppetdb_url,
+                                 pem: {
+                                   'key' => config.puppetdb_key,
+                                   'cert'    => config.puppetdb_cert,
+                                   'ca_file' => config.puppetdb_ca_cert
+                                 }
+                               }, config.puppetdb_api_vers)
+      end
+
+      def class_nodes(classname)
+        q = db_connect.request(
           'resources',
           [
             :and,
@@ -23,11 +26,37 @@ module Utils
         q.data.map { |node| node['certname'] }
       end
 
+      def query_fact(node, fact)
+        q = db_connect.request(
+          "facts/#{fact}",
+          [:'=', 'certname', node]
+        )
+        begin
+          raise 'invalid query' if q.data.empty?
+          q.data.last['value']
+        rescue
+          nil
+        end
+      end
+
+      def node_info(node)
+        q = db_connect.request(
+          'nodes',
+          [:'=', 'certname', node]
+        )
+        begin
+          raise 'invalid node' if q.data.empty?
+          q.data.last.to_yaml
+        rescue
+          nil
+        end
+      end
+
       # rubocop:disable AbcSize
-      def node_roles_and_profiles(url, what, nodename)
+      def node_roles_and_profiles(what, nodename)
         # TODO: validate url and nodename
         ::PuppetDB::Client.new({
-                                 server: url,
+                                 server: config.puppetdb_url,
                                  pem: {
                                    'key' => config.puppetdb_key,
                                    'cert'    => config.puppetdb_cert,

data/lita-puppet.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = 'lita-puppet'
-  spec.version       = '2.0.0'
+  spec.version       = '2.1.0'
   spec.authors       = ['Daniel Schaaff', 'Jonathan Gnagy'].sort
   spec.email         = ['jgnagy@knuedge.com']
   spec.description   = 'Some basic Puppet interactions for Lita'

data/locales/en.yml

@@ -15,6 +15,12 @@ en:
           nodes_with_class:
             syntax: puppet class nodes <class>
             desc: Query PuppetDB to get a list of all nodes containing a class.
+          node_facts:
+            syntax: puppet fact <certname> <factname>
+            desc: Query PuppetDB for facts of a given node
+          nodes_info:
+            syntax: puppet <certname> info
+            desc: returns basic info about a node from puppetdb
           r10k_deploy:
             syntax: puppet r10k [env [module]]
             desc: Deploy the latest puppet code on the puppet master via r10k, optionally specifying an environment, and possibly a module.
@@ -37,6 +43,10 @@ en:
             working: "let me see what I can find in PuppetDB for you."
             failure: "There are no nodes with %{pclass} class, are you sure it's a valid class?"
             success: "Here are all the nodes with class %{pclass}:"
+          node_facts:
+            error: "that didn't work, are you sure %{host} is a valid certname?"
+          nodes_info:
+            error: "that didn't work, are you sure %{host} is a valid certname?"
           r10k_deploy:
             working: "I'll get right on that. Give me a moment and I'll let you know how it went."
             failure: "your r10k run didn't seem to work. Here's what went wrong:"

data/spec/lita/handlers/puppet_spec.rb

@@ -16,6 +16,18 @@ describe Lita::Handlers::Puppet, lita_handler: true do
     instance_double('::PuppetDB::Client', request: puppetdb_nodes)
   end
 
+  let(:fact_request) do
+    instance_double('::PuppetDB::Client', request: puppetdb_fact_result)
+  end
+
+  let(:info_request) do
+    instance_double('::PuppetDB::Client', request: puppetdb_host_info)
+  end
+
+  let(:bad_request) do
+    instance_double('::PuppetDB::Client', request: puppetdb_nil_data)
+  end
+
   let(:puppetdb_nodes) do
     double(
       data: [
@@ -25,6 +37,35 @@ describe Lita::Handlers::Puppet, lita_handler: true do
     )
   end
 
+  let(:puppetdb_nil_data) do
+    double(
+      data: [
+      ]
+    )
+  end
+  let(:puppetdb_host_info) do
+    double(
+      data: [
+        { 'deactivated' => nil,
+          'latest_report_hash' => '693feed',
+          'facts_environment' => 'production' }
+      ]
+    )
+  end
+
+  let(:puppetdb_fact_result) do
+    double(
+      data: [
+        {
+          'certname' => 'foo.example.com',
+          'name' => 'operatingsystem',
+          'value' => 'Darwin',
+          'environment' => 'production'
+        }
+      ]
+    )
+  end
+
   let(:rye_box) do
     box = instance_double(
       'Rye::Box',
@@ -48,6 +89,8 @@ describe Lita::Handlers::Puppet, lita_handler: true do
     is_expected.to route_command('puppet class nodes foo').to(:nodes_with_class)
     is_expected.to route_command('puppet r10k')
       .with_authorization_for(:puppet_admins).to(:r10k_deploy)
+    is_expected.to route_command('puppet fact node foo').to(:node_facts)
+    is_expected.to route_command('puppet node info').to(:nodes_info)
   end
 
   describe('#cert_clean') do
@@ -95,6 +138,35 @@ describe Lita::Handlers::Puppet, lita_handler: true do
     end
   end
 
+  describe('#node_facts') do
+    it 'should return error msg for invalid certname' do
+      allow(::PuppetDB::Client).to receive(:new).and_return(bad_request)
+      send_command('puppet fact foo.example.com operatingsystem')
+      expect(replies.last)
+        .to eq("that didn't work, are you sure foo.example.com is a valid certname?")
+    end
+    it 'should return error msg for invalid certname' do
+      allow(::PuppetDB::Client).to receive(:new).and_return(fact_request)
+      send_command('puppet fact foo.example.com operatingsystem')
+      expect(replies.last).to eq('Darwin')
+    end
+  end
+
+  describe('#nodes_info') do
+    it 'should return error msg for invalid certname' do
+      allow(::PuppetDB::Client).to receive(:new).and_return(bad_request)
+      send_command('puppet foo.example.com info')
+      expect(replies.last)
+        .to eq("that didn't work, are you sure foo.example.com is a valid certname?")
+    end
+    it 'should return the node info' do
+      allow(::PuppetDB::Client).to receive(:new).and_return(info_request)
+      send_command('puppet foo.example.com info')
+      expect(replies.last)
+        .to eq("---\ndeactivated: \nlatest_report_hash: 693feed\nfacts_environment: production\n")
+    end
+  end
+
   describe('#r10k_deploy') do
     before do
       robot.auth.add_user_to_group!(lita_user, :puppet_admins)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lita-puppet
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Daniel Schaaff
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-22 00:00:00.000000000 Z
+date: 2017-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -225,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Allow the Lita bot to handle requests for puppet tasks