puppetdb_foreman 4.0.0 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6a297f534df49f9b10ae4b8398bbc957b90a10156a2aaefa4344e0dc2af61a2
-  data.tar.gz: 2247fe908bad567d6c6d21efb7a45be0d20a4f2464d230694b802ec6b5dd00f4
+  metadata.gz: 2917867afdc2d20921a278f2c2fb35aa90ee71ad3ceca28cbfb6fbff4d087bd9
+  data.tar.gz: 3f6bd9d01c00bd9007220a95b1c0752c938cbbad24c01c670f03ae79e80fd6a5
 SHA512:
-  metadata.gz: 3a4841b0a410b36c6ca57fe2f523d3ccd9f9730bace770346377e051b4565bf3162c185b009a52478eb0dbdda6e3712a8b48ea1486ffb4ab8150f00b81498450
-  data.tar.gz: 4aef5cba6b027aa23cfb78d54551d05406103a9ecda2c821f69bed73695e452736a427c0f303d710a709cabb5bbefa868350ec23f02909758f5d87f2cbbf3045
+  metadata.gz: 424fd00c14417f01cc1ae6eac59d468bb6b32048f5fbd2f0e646319182500a8b46349f31d2797d87efb578d86704eed14cb42710bf25097334993118a335c904
+  data.tar.gz: 0e0ad581dbecf0ce351bb50e8fd88c348e080b64a812c82cb933da13c60a9006f681ba1bcdc6229987e36b96d5d37719895eb7be81c685a15ddb5ec1c8630121

data/README.md

@@ -2,15 +2,12 @@
 
 [![Code Climate](https://codeclimate.com/github/theforeman/puppetdb_foreman/badges/gpa.svg)](https://codeclimate.com/github/theforeman/puppetdb_foreman)
 [![Gem Version](https://badge.fury.io/rb/puppetdb_foreman.svg)](http://badge.fury.io/rb/puppetdb_foreman)
-[![Dependency Status](https://gemnasium.com/theforeman/puppetdb_foreman.svg)](https://gemnasium.com/theforeman/puppetdb_foreman)
-[![Issue stats](http://issuestats.com/github/theforeman/puppetdb_foreman/badge/pr?style=flat)](http://issuestats.com/github/theforeman/puppetdb_foreman)
 
 This is a [Foreman](http://theforeman.org) plugin to interact with [PuppetDB](https://docs.puppetlabs.com/puppetdb/index.html).
 
 It does the following:
 
   * Disables hosts on PuppetDB after they are deleted in Foreman.
-  * Proxies the PuppetDB Performance Dashboard for access through Foreman.
   * Compares nodes in PuppetDB to Hosts in Foreman.
   * Creates Hosts in Foreman from PuppetDB facts.
 
@@ -21,6 +18,8 @@ Feel free to raise issues, ask for features, anything, in the github repository
 | Foreman Version | Plugin Version |
 | --------------- | -------------- |
 | >= 1.17         | ~> 4.0.0       |
+| >= 1.20         | ~> 5.0.0       |
+| >= 3.1          | ~> 6.0.0       |
 
 # Installation:
 
@@ -51,26 +50,7 @@ puppetdb_foreman uses [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.
 
 # Usage:
 
-Go to Administer > Settings > PuppetDB and set `puppetdb_address` with your PuppetDB address, `puppetdb_dashboard_address` (optional) to proxy the dashboard, `puppetdb_enabled` to either true or false if you want to enable or disable PuppetDB integration. Obviously you will need a PuppetDB instance at the address you provide.
-
-Alternatively you can put your settings in `config/settings.yaml`. Please keep in mind these will be overwritten if changed in the application, and if the application is rebooted, YAML rules will overwrite again your manually changed settings. Hence passing your settings in this format is discouraged, but allowed.
-
-for PuppetDB 4
-```yaml
-:puppetdb:
-  :enabled: true
-  :address: 'https://puppetdb:8081/pdb/cmd/v1'
-  :dashboard_address: 'http://puppetdb:8080/pdb/dashboard'
-  :ssl_ca_file: '/etc/puppetlabs/puppet/ssl/certs/ca.pem'
-  :ssl_certificate: '/etc/puppetlabs/puppet/ssl/certs/FQDN.pem'
-  :ssl_private_key: '/etc/puppetlabs/puppet/ssl/private_keys/FQDN.pem'
-  :api_version: 4
-```
-
-You can find the dashboard under Monitor > PuppetDB dashboard. Only administrators and users with a role `view_puppetdb_dashboard` will be able to access it. Aside from convenience, the PuppetDB dashboard cannot be served over HTTPS, you can restrict your dashboard requests to only Foreman boxes and serve it securely to your users through HTTPS in Foreman.
-
-![Screenshot](http://i.imgur.com/5d80CtZ.png)
-
+Go to Administer > Settings > PuppetDB and set `puppetdb_address` with your PuppetDB address, `puppetdb_enabled` to either true or false if you want to enable or disable PuppetDB integration. Obviously you will need a PuppetDB instance at the address you provide.
 
 # Copyright:
 Copyright 2013 CERN, Switzerland and various authors

data/Rakefile

@@ -1,4 +1,6 @@
 #!/usr/bin/env rake
+# frozen_string_literal: true
+
 begin
   require 'bundler/setup'
 rescue LoadError
@@ -20,7 +22,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-APP_RAKEFILE = File.expand_path('../test/dummy/Rakefile', __FILE__)
+APP_RAKEFILE = File.expand_path('test/dummy/Rakefile', __dir__)
 
 Bundler::GemHelper.install_tasks
 
@@ -37,11 +39,12 @@ task default: :test
 
 begin
   require 'rubocop/rake_task'
-  RuboCop::RakeTask.new
-rescue => _
+rescue StandardError
   puts 'Rubocop not loaded.'
-end
+else
+  RuboCop::RakeTask.new
 
-task :default do
-  Rake::Task['rubocop'].execute
+  task :default do
+    Rake::Task['rubocop'].execute
+  end
 end

data/app/controllers/api/v2/puppetdb_nodes_controller.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module Api
   module V2
     class PuppetdbNodesController < V2::BaseController
       include Api::Version2
-      before_action :find_node, :only => [:destroy, :import]
+      before_action :find_node, only: %i[destroy import]
 
-      layout 'api/v2/layouts/index_layout', :only => [:index, :unknown]
+      layout 'api/v2/layouts/index_layout', only: %i[index unknown]
 
       api :GET, '/puppetdb_nodes/', N_('List all PuppetDB nodes')
       def index
@@ -19,20 +21,20 @@ module Api
       end
 
       api :DELETE, '/puppetdb_nodes/:id/', N_('Deactivate a node in PuppetDB')
-      param :id, String, :required => true
+      param :id, String, required: true
 
       def destroy
         uuid = Puppetdb.client.deactivate_node(@node)
-        response = { :job => { :uuid => uuid } }
+        response = { job: { uuid: uuid } }
         process_success response
       end
 
       api :PUT, '/puppetdb_nodes/:id/import/', N_('Import PuppetDB Node to Foreman Host')
-      param :id, :identifier, :required => true
+      param :id, :identifier, required: true
 
       def import
         facts = Puppetdb.client.facts(@node)
-        @host = PuppetdbHost.new(:facts => facts).to_host
+        @host = PuppetdbHost.new(facts: facts).to_host
       end
 
       # Overrides because PuppetDB is not backed by ActiveRecord

data/app/controllers/puppetdb_foreman/nodes_controller.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module PuppetdbForeman
   class NodesController < ApplicationController
-    before_action :find_node, :only => [:destroy, :import]
+    before_action :find_node, only: %i[show destroy import]
 
     def controller_permission
       'puppetdb_nodes'
@@ -12,19 +14,42 @@ module PuppetdbForeman
       @unknown_hosts = @puppetdb_hosts - @foreman_hosts
     end
 
+    def show # rubocop:disable Metrics/AbcSize
+      response = Puppetdb.client.resources(@node)
+
+      class_names = response.map { |v| v['title'] if v['type'] == 'Class' }.compact
+
+      @classes_count = class_names.count
+      @classes = class_names.paginate(page: params[:page], per_page: params[:per_page])
+
+      @type_names = response.map { |v| v['type'] }.uniq
+    end
+
     def destroy
       Puppetdb.client.deactivate_node(@node)
-      process_success :success_msg => _('Deactivated node %s in PuppetDB') % @node, :success_redirect => puppetdb_foreman_nodes_path
+      process_success(
+        success_msg: _('Deactivated node %s in PuppetDB') % @node,
+        success_redirect: puppetdb_foreman_nodes_path
+      )
     rescue StandardError => e
-      process_error(:redirect => puppetdb_foreman_nodes_path, :error_msg => _('Failed to deactivate node in PuppetDB: %s') % e.message)
+      process_error(
+        redirect: puppetdb_foreman_nodes_path,
+        error_msg: _('Failed to deactivate node in PuppetDB: %s') % e.message
+      )
     end
 
-    def import
+    def import # rubocop:disable Metrics/MethodLength
       facts = Puppetdb.client.facts(@node)
-      host = PuppetdbHost.new(:facts => facts).to_host
-      process_success :success_msg => _('Imported host %s from PuppetDB') % @node, :success_redirect => host_path(:id => host)
+      host = PuppetdbHost.new(facts: facts).to_host
+      process_success(
+        success_msg: _('Imported host %s from PuppetDB') % @node,
+        success_redirect: host_path(id: host)
+      )
     rescue StandardError => e
-      process_error(:redirect => puppetdb_foreman_nodes_path, :error_msg => _('Failed to import host from PuppetDB: %s') % e.message)
+      process_error(
+        redirect: puppetdb_foreman_nodes_path,
+        error_msg: _('Failed to import host from PuppetDB: %s') % e.message
+      )
     end
 
     private

data/app/helpers/concerns/puppetdb_foreman/hosts_helper_extensions.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module PuppetdbForeman
+  module HostsHelperExtensions
+    extend ActiveSupport::Concern
+
+    module Overrides
+      def show_appropriate_host_buttons(host)
+        buttons = super
+
+        if host.puppet_proxy_id?
+          buttons << link_to_if_authorized(
+            _('Puppet Classes'),
+            hash_for_puppetdb_foreman_node_path(id: host.name),
+            title: _('Browse host puppet classes'),
+            class: 'btn btn-default'
+          )
+        end
+
+        buttons.compact
+      end
+    end
+
+    included do
+      prepend Overrides
+    end
+  end
+end

data/app/models/concerns/orchestration/puppetdb.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Orchestration
   module Puppetdb
     extend ActiveSupport::Concern
@@ -10,18 +12,23 @@ module Orchestration
 
     def queue_puppetdb_destroy
       return unless ::Puppetdb.ready? && errors.empty?
-      queue.create(:name   => _('Deactivating node %s in PuppetDB') % self, :priority => 60,
-                   :action => [self, :delPuppetdb])
+      queue.create(
+        name: _('Deactivating node %s in PuppetDB') % self,
+        priority: 60,
+        action: [self, :del_puppetdb]
+      )
     end
 
-    def delPuppetdb
+    def del_puppetdb
       Rails.logger.info "Deactivating node in PuppetDB: #{name}"
       ::Puppetdb.client.deactivate_node(name)
     rescue StandardError => e
-      failure _("Failed to deactivate node %{name} in PuppetDB: %{message}\n ") %
-              { :name => name, :message => e.message }, e
+      failure format(
+        _("Failed to deactivate node %<name>s in PuppetDB: %<message>s\n "), name: name, message: e.message
+      ), e
     end
 
-    def setPuppetdb; end
+    def set_puppetdb
+    end
   end
 end

data/app/models/puppetdb_foreman/host_extensions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PuppetdbForeman
   module HostExtensions
     extend ActiveSupport::Concern
@@ -7,20 +9,19 @@ module PuppetdbForeman
       after_build :deactivate_host
     end
 
-    def deactivate_host
+    def deactivate_host # rubocop:disable Metrics/MethodLength
       logger.debug "Deactivating host #{name} in PuppetDB"
       return true unless Puppetdb.enabled?
 
       unless Puppetdb.configured?
-        errors.add(:base,
-                   _('PuppetDB plugin is enabled but not configured. Please configure it before trying to delete a host.'))
+        errors.add(:base, _('PuppetDB plugin is enabled but not configured. Please configure it before trying to delete a host.')) # rubocop:disable Layout/LineLength
       end
 
       begin
         Puppetdb.client.deactivate_node(name)
       rescue StandardError => e
         errors.add(:base, _("Could not deactivate host on PuppetDB: #{e}"))
-        return false
+        false
       end
     end
   end

data/app/services/puppetdb.rb

@@ -1,23 +1,19 @@
+# frozen_string_literal: true
+
 module Puppetdb
   API_VERSIONS = {
-    '4' => 'v4: PuppetDB 4.0, 4.1, 4.2, 4.3',
-    '3' => 'v3: PuppetDB 3.0, 3.1, 3.2',
-    '1' => 'v1: PuppetDB 1.1, 1.2, 1.3, 1.4, 1.5, 1.6, 2.0, 2.1, 2.2, 2.3'
+    '4' => 'v4: PuppetDB 4 - 7',
   }.freeze
 
-  def self.client
+  def self.client # rubocop:disable Metrics/MethodLength
     options = {
-      :uri => uri,
-      :ssl_ca_file => Setting[:puppetdb_ssl_ca_file],
-      :ssl_certificate_file => Setting[:puppetdb_ssl_certificate],
-      :ssl_private_key_file => Setting[:puppetdb_ssl_private_key]
+      uri: uri,
+      ssl_ca_file: Setting[:puppetdb_ssl_ca_file],
+      ssl_certificate_file: Setting[:puppetdb_ssl_certificate],
+      ssl_private_key_file: Setting[:puppetdb_ssl_private_key],
     }
 
     case api_version
-    when 1
-      PuppetdbClient::V1.new(options)
-    when 3
-      PuppetdbClient::V3.new(options)
     when 4
       PuppetdbClient::V4.new(options)
     else

data/app/services/puppetdb_client/base.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module PuppetdbClient
   class Base
-    delegate :logger, :to => :Rails
+    delegate :logger, to: :Rails
     attr_reader :uri, :ssl_ca_file, :ssl_certificate_file, :ssl_private_key_file
 
     def initialize(opts)
@@ -25,6 +27,10 @@ module PuppetdbClient
       parse(get(facts_url, query: "[\"=\", \"certname\", \"#{nodename}\"]"))
     end
 
+    def resources(nodename)
+      parse(get(resources_url, query: "[\"=\", \"certname\", \"#{nodename}\"]"))
+    end
+
     private
 
     def connection(url)
@@ -62,13 +68,13 @@ module PuppetdbClient
 
     def request_options
       {
-        headers: request_headers
+        headers: request_headers,
       }.merge(auth_options).merge(ssl_options)
     end
 
     def request_headers
       {
-        'Accept' => 'application/json'
+        'Accept' => 'application/json',
       }
     end
 
@@ -76,11 +82,11 @@ module PuppetdbClient
       if ssl_ca_file
         {
           ssl_ca_file: ssl_ca_file,
-          verify_ssl: true
+          verify_ssl: true,
         }
       else
         {
-          verify_ssl: false
+          verify_ssl: false,
         }
       end
     end
@@ -89,7 +95,7 @@ module PuppetdbClient
       return {} unless certificate_request?
       {
         ssl_client_cert: ssl_certificate,
-        ssl_client_key: ssl_private_key
+        ssl_client_key: ssl_private_key,
       }
     end
 

data/app/services/puppetdb_client/v4.rb

@@ -1,4 +1,51 @@
+# frozen_string_literal: true
+
 module PuppetdbClient
-  class V4 < V3
+  class V4 < Base
+    # The payload is formatted as a JSON map.
+    # certname: The name of the node for which the catalog was compiled.
+    # producer_timestamp: The time of command submission.
+    def deactivate_node_payload(nodename)
+      {
+        'command' => 'deactivate node',
+        'version' => 3,
+        'payload' => {
+          'certname' => nodename,
+          'producer_timestamp' => producer_timestamp,
+        },
+      }.to_json
+    end
+
+    def command_url
+      '/pdb/cmd/v1'
+    end
+
+    def nodes_url
+      '/pdb/query/v4/nodes'
+    end
+
+    def facts_url
+      '/pdb/query/v4/facts'
+    end
+
+    def resources_url
+      '/pdb/query/v4/resources'
+    end
+
+    def query_nodes
+      super.map { |node| node['certname'] }
+    end
+
+    private
+
+    def post_options
+      {
+        content_type: :json,
+      }
+    end
+
+    def producer_timestamp
+      Time.now.iso8601.to_s
+    end
   end
 end

data/app/services/puppetdb_host.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class PuppetdbHost
   attr_accessor :certname, :environment, :facts
 
@@ -7,9 +9,9 @@ class PuppetdbHost
   end
 
   def to_host
-    host = Host::Managed.import_host(facts[:fqdn], 'puppet', certname)
-    host.import_facts(facts)
-    host.update_attribute(:environment => environment) if environment
+    host = Host::Managed.import_host(facts[:fqdn], certname)
+    HostFactImporter.new(host).import_facts(facts)
+    host.update_attribute(environment: environment) if environment   # rubocop:disable Rails/SkipsModelValidations
     host
   end
 

data/app/views/api/v2/puppetdb_nodes/import.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 object @host
 
 extends 'api/v2/hosts/show'

data/app/views/api/v2/puppetdb_nodes/index.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 collection @nodes
 
 node :name do |node|

data/app/views/api/v2/puppetdb_nodes/unknown.json.rabl

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 collection @nodes
 
 extends 'api/v2/puppetdb_nodes/index'

data/app/views/puppetdb_foreman/nodes/index.html.erb

@@ -51,6 +51,7 @@
                       <td class="ellipsis"><%= node %></td>
                       <td>
                         <%= action_buttons(
+                          (display_link_if_authorized(_("Puppet Classes"), hash_for_puppetdb_foreman_node_path(:id => node), :method => :get)),
                           (display_link_if_authorized(_("Import"), hash_for_import_puppetdb_foreman_node_path(:id => node), :method => :put)),
                           (display_delete_if_authorized(hash_for_puppetdb_foreman_node_path(:id => node), :class => 'delete', :text => _('Deactivate')))
                         ) %>

data/app/views/puppetdb_foreman/nodes/show.html.erb

@@ -0,0 +1,69 @@
+<% title @node %>
+
+<% if respond_to?(:breadcrumbs) %>
+  <% breadcrumbs(
+       items: [
+       {
+         caption: _('Nodes'),
+         url: (url_for(puppetdb_foreman_nodes_path) if authorized_for(hash_for_puppetdb_foreman_nodes_path))
+       },
+       {
+         caption: @node
+       }],
+       switchable: false)
+  %>
+<% end %>
+
+<div class="col-md-12">
+  <div class="row">
+    <div class="container-fluid container-cards-pf">
+      <div class="row row-cards-pf">
+        <div class="col-xs-6 col-sm-4 col-md-4">
+          <div class="card-pf card-pf-accented card-pf-aggregate-status">
+            <h2 class="card-pf-title">
+              <span class="pficon pficon-infrastructure"></span><span class="card-pf-aggregate-status-count"><%= @classes_count %></span> <%= _('Classes') %>
+            </h2>
+            <div class="card-pf-body"></div>
+          </div>
+        </div>
+
+        <div class="col-xs-6 col-sm-4 col-md-4">
+          <div class="card-pf card-pf-accented card-pf-aggregate-status">
+            <h2 class="card-pf-title">
+              <span class="fa fa-wrench"></span><span class="card-pf-aggregate-status-count"><%= @type_names.count %></span> <%= _('Types') %>
+            </h2>
+            <div class="card-pf-body"></div>
+          </div>
+        </div>
+      </div>
+    </div>
+
+    <div class="col-md-8">
+      <div class="panel panel-default">
+        <div class="panel-heading">
+          <h3 class="panel-title"><%= _('Puppet classes') %></h3>
+        </div>
+
+        <div class="panel-body">
+          <% if @classes.any? %>
+            <table class="<%= table_css_classes 'table-fixed' %>">
+              <thead>
+                <tr>
+                  <th class="col-md-5"><%= _('Name') %></th>
+                </tr>
+              </thead>
+
+              <tbody>
+                <% @classes.each do |class_name| %>
+                  <tr><td><%= class_name %></td></tr>
+                <% end %>
+              </tbody>
+            </table>
+          <% end %>
+
+          <%= will_paginate_with_info @classes %>
+        </div>
+      </div>
+    </div>
+  </div>
+</div>

data/config/routes.rb

@@ -1,9 +1,9 @@
-Rails.application.routes.draw do
-  get ':puppetdb(/*puppetdb_url)', :to => 'puppetdb_foreman/puppetdb#index', :puppetdb => /d3\.v2|charts|v3|puppetdb|metrics|\/pdb\/meta\/v1\/version\/latest|pdb\/meta\/v1\/version|pdb\/dashboard\/data/, :as => 'puppetdb'
+# frozen_string_literal: true
 
+Rails.application.routes.draw do
   namespace :puppetdb_foreman do
-    constraints(:id => %r{[^\/]+}) do
-      resources :nodes, :only => [:index, :destroy] do
+    constraints(id: %r{[^/]+}) do
+      resources :nodes, only: %i[index show destroy] do
         member do
           put 'import'
         end
@@ -11,13 +11,13 @@ Rails.application.routes.draw do
     end
   end
 
-  namespace :api, :defaults => { :format => 'json' } do
-    scope '(:apiv)', :module => :v2,
-                     :defaults => { :apiv => 'v2' },
-                     :apiv => /v1|v2/,
-                     :constraints => ApiConstraints.new(:version => 2) do
-      constraints(:id => /[^\/]+/) do
-        resources :puppetdb_nodes, :only => [:index, :destroy] do
+  namespace :api, defaults: { format: 'json' } do
+    scope '(:apiv)', module: :v2,
+                     defaults: { apiv: 'v2' },
+                     apiv: /v1|v2/,
+                     constraints: ApiConstraints.new(version: 2) do
+      constraints(id: %r{[^/]+}) do
+        resources :puppetdb_nodes, only: %i[index destroy] do
           collection do
             get 'unknown'
           end

data/db/migrate/20170717140010_migrate_puppetdb_api_version_setting.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 class MigratePuppetdbApiVersionSetting < ActiveRecord::Migration[4.2]
   def up
-    puppetdb_address = Setting.where(:category => 'Setting::Puppetdb', :name => 'puppetdb_address').first.try(:value)
+    puppetdb_address = Setting.where(category: 'Setting::Puppetdb', name: 'puppetdb_address').first.try(:value)
     return unless puppetdb_address
 
     api_version = URI.parse(puppetdb_address).path.start_with?('/pdb') ? 3 : 1
-    setting = Setting.where(:category => 'Setting::Puppetdb', :name => 'puppetdb_api_version').first_or_create
+    setting = Setting.where(category: 'Setting::Puppetdb', name: 'puppetdb_api_version').first_or_create
     setting.value = api_version
     setting.save
   end

data/db/migrate/20181001113836_remove_puppetdb_dashboard_address_setting.puppetdb_foreman.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class RemovePuppetdbDashboardAddressSetting < ActiveRecord::Migration[5.2]
+  def change
+    Setting.where(name: 'puppetdb_dashboard_address').destroy_all
+  end
+end