lita-puppet 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b07d8d6ec3d4b8bd50ded82552c693d7bd49eae3
-  data.tar.gz: ad15dc7734ef6ef1495d577377e295febfcaf865
+  metadata.gz: 6753079e28465d80b49e7d463fb242c0730e6ab3
+  data.tar.gz: 20d8c779ebe29130f7643378d5963a03e586c269
 SHA512:
-  metadata.gz: 572fd736a463d2d65060757a7b4c038fb1195aa82096431a57616018d3195818f08a0029c3687a0279bb65668570252d05474f71a59a9f576c023c134252547d
-  data.tar.gz: 32bc47bb56b0564729733dc00209715b51bf5764c342e7ce3fd46a28744a5939f0ae39d17bc7b72be75cc3e5bd956e250df784c1864163ef14afb35408b2e4db
+  metadata.gz: 6e2324d74f2d7ec5cdd956bd065baf9d8dfd5334cea9989aa90913b5dc2613c35494829e20910ac2440753a03efaa3ce43f2d63a03ca68fda9d6cfee38d19667
+  data.tar.gz: e391af17aab49c66f4f427eb2b16db108d655d047e6c5c1f7ee1c829956f84ffb2b8c1543436e132ffcfbde81b3803811d33d94e118120bbb882ec38f6325134

data/.travis.yml

@@ -1,7 +1,15 @@
 language: ruby
 rvm:
-  - 2.2.5
-  - 2.3.1
+- 2.2.5
+- 2.3.1
 services:
-  - redis-server
+- redis-server
 cache: bundler
+deploy:
+  provider: rubygems
+  api_key:
+    secure: P5+R7mfECVqonuJQf4pHuzh71ihjH/PGJjAHbbfobxJf8krk8h8erD6c/86dxy/+Jyr/BDOvx2TH2Q1zn2lRo1unbKUsccP8nJfY4B8zkISqHs2JqkE2DZZqciYx7OIMO02Yyk3XS8FjaykHOCdgP1UpGY1i1ErfZkSkj3PcfybMLmgShZn/DrR15mulp4EHVtlsb7CZz4dIxsmnH+UP4bTirk1dcw1133iG5xx7hbQ03cMJI8Mjz51+edCI65dS6LN9Vyh2EKZfr+P/mRcp2gLcuHg0IjGvjv4/McMrkAxozTvvFdeSDoZda7sSdC1v0UwbjqHQMva9bcyjz9poKeQDRFjqRtoiuq1LIp4y26hzuOKZWjqnrXLKXRj50cLASiCL4enxr0xC9AkO23Il/MsExhu52Ke0bnS8DC3FkEcWsaVEYHoKC9w9dyMu4d5SCPX1tpbMNFjYacE9RGsKJFshCyi4SBVAu6MPy0X2tNO7bLBZTPAQSILult0D6s4H0j3laxLMZ2KSJpZWAEmsub5BjsheDgHTHZkQ0hAGP4lknqXiiU0F1ogP8LXagHqSLb0Bp+meb9BBhoe3mYafb5MB/r3SMdnOgjpbNxlkxeOwtNpW6PSHJJns1NzDG21PzaIq9MCfHjbDWHtk8n52KAVhSAg9QJ6xXIPSJyo3BYw=
+  gem: lita-puppet
+  on:
+    tags: true
+    repo: knuedge/lita-puppet

data/README.md

@@ -15,9 +15,13 @@ Add lita-puppet to your Lita instance's Gemfile:
 gem "lita-puppet"
 ```
 
+## Prerequisites
+
+* Some of the commands require a [PuppetDB](https://docs.puppet.com/puppetdb/) server, and it must be specified in the configuration.
+* Other commands require that Lita has SSH access to machines using an SSH key, and that Lita has Passwordless `sudo` capabilities. This sounds scary, but it can be done in a very restrictive way (and if you're using puppet, you can automate it).
+
 ## Configuration
 
-* `config.handlers.puppet.control_repo_path` - Path for `git pull` during r10k deployments
 * `config.handlers.puppet.master_hostname` - Puppet Master's hostname
 * `config.handlers.puppet.puppetdb_url` - PuppetDB hostname (for the [puppetdb-ruby](https://github.com/voxpupuli/puppetdb-ruby) gem)
 * `config.handlers.puppet.ssh_user` - SSH user for the Puppet Master for r10k deployments
@@ -56,15 +60,19 @@ This is also available as:
 **Note** though that this doesn't do anything on the client side. If you want puppet to work on the `<host>` machine you'll need to generate a new cert. Usually you run this if you're planning to do that anyway though.
 
 #### Query PuppetDB for the Roles and Profiles used by a node
-    puppet catalog <certname> profiles
+    puppet roles and profiles <certname>
 
 This is also available as:
 
-    puppet node <certname> profiles
-    pp catalog <certname> profiles
-    pp node <certname> profiles
+    puppet r&p <certname>
+    puppet profiles <certname>
+    puppet roles <certname>
+    pp roles and profiles <certname>
+    pp r&p <certname>
+    pp profiles <certname>
+    pp roles <certname>
 
-Where `<certname>` is the SSL certificate name used for Puppet. This is usually the FQDN for the host. This query assumes you use the roles and profiles paradigm with the classes namespaced as `profile::example` and `role::example` etc..
+Where `<certname>` is the SSL certificate name used for Puppet. This is usually the FQDN for the host. This query assumes you use the roles and profiles paradigm with the classes namespaced as `profile::example` and `role::example` etc.. Using only `roles` or `profiles` in the command will only return the requested information.
 
 #### Query PuppetDB for the nodes associated with a class
     puppet class nodes <class>

data/lib/lita/handlers/puppet.rb

@@ -4,7 +4,6 @@ module Lita
       namespace 'Puppet'
       config :master_hostname, required: true, type: String
       config :ssh_user, required: false, type: String, default: 'lita'
-      config :control_repo_path, required: false, type: String, default: '/opt/puppet/control'
       config :puppetdb_url, required: false, type: String
 
       route(
@@ -22,7 +21,7 @@ module Lita
       )
 
       route(
-        /(puppet|pp)\s+(catalog|node)\s+(\S+)\s+(profiles)/i,
+        /(puppet|pp)\s+(profiles|roles\sand\sprofiles|roles|r&p)\s+(\S+)/i,
         :node_profiles,
         command: true,
         help: { t('help.node_profiles.syntax') => t('help.node_profiles.desc') }
@@ -85,6 +84,7 @@ module Lita
 
       def node_profiles(response)
         host = response.matches[0][2]
+        what = response.matches[0][1]
         url  = config.puppetdb_url
 
         unless url
@@ -94,7 +94,7 @@ module Lita
 
         response.reply_with_mention(t('replies.node_profiles.working'))
 
-        profiles = node_roles_and_profiles(url, host)
+        profiles = node_roles_and_profiles(url, what, host)
 
         if profiles.is_a? String
           fail_message response, t('replies.node_profiles.failure', error: profiles)
@@ -138,22 +138,15 @@ module Lita
 
         response.reply_with_mention(t('replies.r10k_deploy.working'))
 
-        result1 = r10k_git_result(config.master_hostname, user, config.control_repo_path)
+        result = simple_ssh_command(config.master_hostname, user, r10k_command(environment, mod))
 
-        if result1[:exception]
-          fail_message response, t('replies.r10k_deploy.gitfail'), result1[:exception].message
-          return false
-        end
-
-        result2 = simple_ssh_command(config.master_hostname, user, r10k_command(environment, mod))
-
-        if result2[:exception]
-          fail_message response, t('replies.r10k_deploy.pupfail'), result2[:exception].message
+        if result[:exception]
+          fail_message response, t('replies.r10k_deploy.failure'), result[:exception].message
         else
           success_message(
             response,
             t('replies.r10k_deploy.success'),
-            [result1[:stdout].join("\n"), result2[:stderr].join("\n")].join("\n")
+            [result[:stdout].join("\n"), result[:stderr].join("\n")].join("\n")
           )
         end
       end
@@ -167,31 +160,11 @@ module Lita
 
       alias success_message fail_message
 
-      def simple_ssh_command(host, user, command, timeout = 300)
-        over_ssh(host: host, user: user, timeout: timeout) do |server|
-          server.cd '/tmp'
-          # Need to use sudo
-          server.enable_sudo
-          # scary...
-          server.disable_safe_mode
-
-          server.execute command
-        end
-      end
-
       def cert_clean_result(host, user, cert)
         cmd = "puppet cert clean #{cert} 2>&1"
         simple_ssh_command(host, user, cmd, 120)
       end
 
-      def r10k_git_result(host, user, repo_location)
-        over_ssh(host: host, user: user, timeout: 120) do |server|
-          # Need to use sudo
-          server.enable_sudo
-          server[repo_location].git :pull
-        end
-      end
-
       Lita.register_handler(self)
     end
   end

data/lib/utils/lita_puppet/puppetdb.rb

@@ -2,25 +2,6 @@ module Utils
   module LitaPuppet
     # Utility methods for working with PuppetDB
     module PuppetDB
-      def dbquery(url, q)
-        # TODO: validate incoming query structure
-        client = ::PuppetDB::Client.new(server: url)
-        client.request(*q)
-      end
-
-      def node_roles_and_profiles(url, nodename)
-        # TODO: validate url and nodename
-        ::PuppetDB::Client.new(server: url) # this is weird but required
-        d = ::PuppetDB::Client.get("/catalogs/#{nodename}")
-        return d['error'] if d['error']
-
-        tags = []
-        d['data']['resources'].each { |r| tags.concat(r['tags']) }
-
-        # return all the tags related to profile:: or role::
-        tags.sort.uniq.select { |t| t.match(/^(profile|role)::/) }
-      end
-
       def class_nodes(url, classname)
         client = ::PuppetDB::Client.new(server: url)
         q = client.request(
@@ -34,6 +15,26 @@ module Utils
 
         q.data.map { |node| node['certname'] }
       end
+
+      def node_roles_and_profiles(url, what, nodename)
+        # TODO: validate url and nodename
+        ::PuppetDB::Client.new(server: url) # this is weird but required
+        d = ::PuppetDB::Client.get("/catalogs/#{nodename}")
+        return d['error'] if d['error']
+
+        tags = []
+        d['data']['resources'].each { |r| tags.concat(r['tags']) }
+
+        # return all the tags related to profile:: or role::
+        case what
+        when 'profiles'
+          tags.sort.uniq.select { |t| t.match(/^profile::/) }
+        when 'roles'
+          tags.sort.uniq.select { |t| t.match(/^role::/) }
+        when 'r&p', 'p&r', 'roles and profiles'
+          tags.sort.uniq.select { |t| t.match(/^(profile|role)::/) }
+        end
+      end
     end
   end
 end

data/lib/utils/lita_puppet/ssh.rb

@@ -2,6 +2,19 @@ module Utils
   module LitaPuppet
     # Utility methods for doing things over SSH
     module SSH
+      # Only really used for the over_ssh method to determine success or failure
+      def calculate_result(output, exception)
+        result = {}
+        if exception
+          result[:exception] = exception
+        else
+          result[:exit_status] = output.exit_status
+          result[:stdout] = output.stdout
+          result[:stderr] = output.stderr
+        end
+        result
+      end
+
       # Intelligently do some things over SSH
       def over_ssh(opts = {})
         raise 'MissingSSHHost' unless opts[:host]
@@ -31,16 +44,17 @@ module Utils
         calculate_result(output, exception)
       end
 
-      def calculate_result(output, exception)
-        result = {}
-        if exception
-          result[:exception] = exception
-        else
-          result[:exit_status] = output.exit_status
-          result[:stdout] = output.stdout
-          result[:stderr] = output.stderr
+      # Provides a super simple way to just run a single command over ssh
+      def simple_ssh_command(host, user, command, timeout = 300)
+        over_ssh(host: host, user: user, timeout: timeout) do |server|
+          server.cd '/tmp'
+          # Need to use sudo
+          server.enable_sudo
+          # scary...
+          server.disable_safe_mode
+
+          server.execute command
         end
-        result
       end
     end
   end

data/lib/utils/lita_puppet/text.rb

@@ -2,15 +2,11 @@ module Utils
   module LitaPuppet
     # Utility methods for manipulating text
     module Text
-      # Strip off bad characters
-      def sanitze_for_chat(text)
-        # Remove bash colorings
-        text.gsub(/\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[mGK]/, '')
-      end
-
-      # camel case puppet classes
-      def class_camel(text)
-        text.split('::').map(&:capitalize).join('::')
+      def agent_command
+        command = 'puppet agent'
+        command << ' --onetime --verbose --no-daemonize'
+        command << ' --no-usecacheonfailure'
+        command << ' --no-splay --show_diff 2>&1'
       end
 
       # Format some text as code
@@ -20,6 +16,11 @@ module Utils
         '/code ' + sanitze_for_chat(text)
       end
 
+      # camel case puppet classes
+      def class_camel(text)
+        text.split('::').map(&:capitalize).join('::')
+      end
+
       def r10k_command(environment, mod)
         command = 'r10k deploy'
         if environment && mod
@@ -31,11 +32,10 @@ module Utils
         end
       end
 
-      def agent_command
-        command = 'puppet agent'
-        command << ' --onetime --verbose --no-daemonize'
-        command << ' --no-usecacheonfailure'
-        command << ' --no-splay --show_diff 2>&1'
+      # Strip off bad characters
+      def sanitze_for_chat(text)
+        # Remove bash colorings
+        text.gsub(/\x1B\[([0-9]{1,2}(;[0-9]{1,2})?)?[mGK]/, '')
       end
     end
   end

data/lita-puppet.gemspec

@@ -1,6 +1,7 @@
+# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
   spec.name          = 'lita-puppet'
-  spec.version       = '0.6.3'
+  spec.version       = '0.7.0'
   spec.authors       = ['Daniel Schaaff', 'Jonathan Gnagy'].sort
   spec.email         = ['jgnagy@knuedge.com']
   spec.description   = 'Some basic Puppet interactions for Lita'
@@ -14,6 +15,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  spec.required_ruby_version = '~> 2.2'
+
   spec.add_runtime_dependency 'lita', '~> 4.7'
   spec.add_runtime_dependency 'rye'
   spec.add_runtime_dependency 'puppetdb-ruby'
@@ -26,4 +29,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'travis', '~> 1.8'
 end

data/locales/en.yml

@@ -10,7 +10,7 @@ en:
             syntax: puppet cert clean <host>
             desc: Remove all traces of the SSL cert for <host> on the Puppet Master.
           node_profiles:
-            syntax: puppet catalog <host> profiles
+            syntax: puppet profiles | roles | roles and profiles <host>
             desc: Query PuppetDB to get a list of all roles and profiles applied to <host>.
           nodes_with_class:
             syntax: puppet class nodes <class>
@@ -39,6 +39,5 @@ en:
             success: "Here are all the nodes with class %{pclass}:"
           r10k_deploy:
             working: "I'll get right on that. Give me a moment and I'll let you know how it went."
-            gitfail: "your r10k run didn't seem to work. Looks like there was a problem with Git:"
-            pupfail: "your r10k run didn't seem to work. Here's what went wrong:"
+            failure: "your r10k run didn't seem to work. Here's what went wrong:"
             success: "your r10k deployment is done!"

data/spec/lita/handlers/puppet_spec.rb

@@ -1,23 +1,109 @@
 require 'spec_helper'
+require 'pry'
 
 describe Lita::Handlers::Puppet, lita_handler: true do
-  it 'routes agent run commands properly' do
-    is_expected.to route_command('puppet agent run on foo').to(:puppet_agent_run)
+  before do
+    registry.config.handlers.puppet.master_hostname = 'puppet.foo'
+    registry.config.handlers.puppet.puppetdb_url = 'http://pboard.foo:8080'
   end
 
-  it 'routes cert clean commands properly' do
-    is_expected.to route_command('puppet cert clean foo').to(:cert_clean)
+  let(:lita_user) { Lita::User.create('User', name: 'A User', mention_name: 'user') }
+
+  let(:new_puppetdb_request_only) do
+    instance_double('::PuppetDB::Client', request: puppetdb_nodes)
   end
 
-  it 'routes catalog profiles commands properly' do
-    is_expected.to route_command('puppet catalog foo profiles').to(:node_profiles)
+  let(:puppetdb_nodes) do
+    double(
+      data: [
+        { 'certname' => 'server1.foo' },
+        { 'certname' => 'server2.foo' }
+      ]
+    )
   end
 
-  it 'routes class nodes commands properly' do
-    is_expected.to route_command('puppet class nodes foo').to(:nodes_with_class)
+  let(:rye_box) do
+    box = instance_double(
+      'Rye::Box',
+      disable_safe_mode: true,
+      disconnect: true,
+      enable_sudo: true,
+      execute: rye_output_base
+    )
+    allow(box).to receive(:cd).with('/tmp').and_return(true)
+    box
   end
 
-  it 'routes r10k commands properly' do
+  let(:rye_output_base) { double(exit_status: 0, stdout: ['foo'], stderr: ['bar']) }
+
+  it 'should have the required routes' do
+    is_expected.to route_command('puppet agent run on foo').to(:puppet_agent_run)
+    is_expected.to route_command('puppet cert clean foo').to(:cert_clean)
+    is_expected.to route_command('puppet profiles foo').to(:node_profiles)
+    is_expected.to route_command('puppet class nodes foo').to(:nodes_with_class)
     is_expected.to route_command('puppet r10k').to(:r10k_deploy)
   end
+
+  describe('#cert_clean') do
+    it 'should clean a cert' do
+      allow(Rye::Box).to receive(:new).and_return(rye_box)
+      send_command('puppet cert clean server.name', as: lita_user)
+      expect(replies[-2]).to eq('your `puppet cert clean` is all done!')
+    end
+  end
+
+  describe('#puppet_agent_run') do
+    it 'should run a puppet agent' do
+      allow(Rye::Box).to receive(:new).and_return(rye_box)
+      send_command('puppet agent run on server.name', as: lita_user)
+      expect(replies[-2]).to eq('that puppet run is complete! It exited with status 0.')
+    end
+  end
+
+  describe('#node_profiles') do
+    it 'should provide a list of profiles and roles associated with a node' do
+      allow(::PuppetDB::Client).to receive(:get).and_return(
+        'data' => {
+          'resources' => [
+            { 'tags' => ['profile::foo'] },
+            { 'tags' => ['role::baz'] }
+          ]
+        }
+      )
+      send_command('puppet roles and profiles foo', as: lita_user)
+      expect(replies.last).to eq("/code profile::foo\nrole::baz")
+    end
+  end
+
+  describe('#nodes_with_class') do
+    it 'should provide a list of nodes containing a class' do
+      allow(::PuppetDB::Client).to receive(:new).and_return(new_puppetdb_request_only)
+      send_command('puppet class nodes profile::foo', as: lita_user)
+      expect(replies.last).to eq("/code server1.foo\nserver2.foo")
+    end
+  end
+
+  describe('#r10k_deploy') do
+    context 'without a module or environment' do
+      it 'should trigger r10k on the puppet master' do
+        allow(Rye::Box).to receive(:new).and_return(rye_box)
+        send_command('puppet deploy', as: lita_user)
+        expect(replies[-2]).to eq('your r10k deployment is done!')
+      end
+    end
+    context 'with an environment and no module' do
+      it 'should trigger r10k on the puppet master' do
+        allow(Rye::Box).to receive(:new).and_return(rye_box)
+        send_command('puppet deploy production', as: lita_user)
+        expect(replies[-2]).to eq('your r10k deployment is done!')
+      end
+    end
+    context 'with an environment and a module' do
+      it 'should trigger r10k on the puppet master' do
+        allow(Rye::Box).to receive(:new).and_return(rye_box)
+        send_command('puppet deploy production role', as: lita_user)
+        expect(replies[-2]).to eq('your r10k deployment is done!')
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lita-puppet
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Daniel Schaaff
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-03 00:00:00.000000000 Z
+date: 2016-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: lita
@@ -165,6 +165,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: travis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 description: Some basic Puppet interactions for Lita
 email:
 - jgnagy@knuedge.com
@@ -201,9 +215,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -211,7 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Allow the Lita bot to handle requests for puppet tasks