puppetdb_foreman 4.0.0 → 6.0.0

data/lib/puppetdb_foreman/engine.rb

@@ -1,58 +1,83 @@
+# frozen_string_literal: true
+
 module PuppetdbForeman
   class Engine < ::Rails::Engine
     engine_name 'puppetdb_foreman'
 
-    initializer 'puppetdb_foreman.load_default_settings', :before => :load_config_initializers do |_app|
-      require_dependency File.expand_path('../../../app/models/setting/puppetdb.rb', __FILE__) if begin
-                                                                                                     Setting.table_exists?
-                                                                                                   rescue StandardError
-                                                                                                     (false)
-                                                                                                   end
-    end
-
     initializer 'puppetdb_foreman.load_app_instance_data' do |app|
       PuppetdbForeman::Engine.paths['db/migrate'].existent.each do |path|
         app.config.paths['db/migrate'] << path
       end
     end
 
-    initializer 'puppetdb_foreman.register_plugin', :before => :finisher_hook do |_app|
+    initializer 'puppetdb_foreman.register_plugin', before: :finisher_hook do |_app|
       Foreman::Plugin.register :puppetdb_foreman do
-        requires_foreman '>= 1.17'
+        requires_foreman '>= 3.1'
 
         apipie_documented_controllers ["#{PuppetdbForeman::Engine.root}/app/controllers/api/v2/*.rb"]
 
+        settings do
+          category :puppetdb, N_('PuppetDB') do
+            setting :puppetdb_enabled,
+              type: :boolean,
+              default: false,
+              description: _("Integration with PuppetDB, enabled will deactivate a host in PuppetDB when it's deleted in Foreman")  # rubocop:disable Layout/LineLength
+
+            setting :puppetdb_address,
+              type: :string,
+              default: 'https://puppetdb:8081/pdb/cmd/v1',
+              description: _('Foreman will send PuppetDB requests to this address')
+
+            setting :puppetdb_ssl_ca_file,
+              type: :string,
+              default: SETTINGS[:ssl_ca_file],
+              description: _('Foreman will send PuppetDB requests with this CA file')
+
+            setting :puppetdb_ssl_certificate,
+              type: :string,
+              default: SETTINGS[:ssl_certificate],
+              description: _('Foreman will send PuppetDB requests with this certificate file')
+
+            setting :puppetdb_ssl_private_key,
+              type: :string,
+              default: SETTINGS[:ssl_priv_key],
+              description: _('Foreman will send PuppetDB requests with this key file')
+
+            setting :puppetdb_api_version,
+              type: :integer,
+              default: 4,
+              full_name: N_('PuppetDB API Version'),
+              description: _('Foreman will use this PuppetDB API version'),
+              collection: proc { ::Puppetdb::API_VERSIONS }
+          end
+        end
+
         security_block :puppetdb_foreman do
-          permission :view_puppetdb_dashboard, :'puppetdb_foreman/puppetdb' => [:index]
-          permission :view_puppetdb_nodes, :'puppetdb_foreman/nodes' => [:index],
-                                           :'api/v2/puppetdb_nodes' => [:index, :unknown]
-          permission :destroy_puppetdb_nodes, :'puppetdb_foreman/nodes' => [:destroy],
-                                              :'api/v2/puppetdb_nodes' => [:destroy]
-          permission :import_puppetdb_nodes, :'puppetdb_foreman/nodes' => [:import],
-                                             :'api/v2/puppetdb_nodes' => [:import]
+          permission :view_puppetdb_nodes, 'puppetdb_foreman/nodes': %i[index show],
+                                           'api/v2/puppetdb_nodes': %i[index unknown]
+
+          permission :destroy_puppetdb_nodes, 'puppetdb_foreman/nodes': [:destroy],
+                                              'api/v2/puppetdb_nodes': [:destroy]
+
+          permission :import_puppetdb_nodes, 'puppetdb_foreman/nodes': [:import],
+                                             'api/v2/puppetdb_nodes': [:import]
         end
 
-        role 'PuppetDB Dashboard', [:view_puppetdb_dashboard]
         role 'PuppetDB Node Viewer', [:view_puppetdb_nodes]
-        role 'PuppetDB Node Manager', [:view_puppetdb_nodes, :destroy_puppetdb_nodes, :import_puppetdb_nodes]
-
-        menu :top_menu, :puppetdb, :caption => N_('PuppetDB Dashboard'),
-                                   :url_hash => { :controller => 'puppetdb_foreman/puppetdb', :action => 'index', :puppetdb => 'puppetdb' },
-                                   :parent => :monitor_menu,
-                                   :last => :true
-        menu :top_menu, :nodes, :caption => N_('PuppetDB Nodes'),
-                                :url_hash => { :controller => 'puppetdb_foreman/nodes', :action => 'index' },
-                                :parent => :monitor_menu,
-                                :after => :puppetdb
+        role 'PuppetDB Node Manager', %i[view_puppetdb_nodes destroy_puppetdb_nodes import_puppetdb_nodes]
+
+        menu :top_menu, :nodes, caption: N_('PuppetDB Nodes'),
+                                url_hash: { controller: 'puppetdb_foreman/nodes', action: 'index' },
+                                parent: :monitor_menu,
+                                after: :puppetdb
       end
     end
 
     config.to_prepare do
-      begin
-        Host::Managed.send :include, PuppetdbForeman::HostExtensions
-      rescue StandardError => e
-        Rails.logger.warn "PuppetdbForeman: skipping engine hook (#{e})"
-      end
+      Host::Managed.include PuppetdbForeman::HostExtensions
+      HostsHelper.include PuppetdbForeman::HostsHelperExtensions
+    rescue StandardError => e
+      Rails.logger.warn "PuppetdbForeman: skipping engine hook (#{e})"
     end
   end
 end

data/lib/puppetdb_foreman/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PuppetdbForeman
-  VERSION = '4.0.0'.freeze
+  VERSION = '6.0.0'
 end

data/lib/puppetdb_foreman.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module PuppetdbForeman
   require 'puppetdb_foreman/engine'
 end

data/lib/tasks/puppetdb_foreman_tasks.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Tests
 namespace :test do
   desc 'Test PuppetdbForeman'
@@ -11,7 +13,7 @@ namespace :test do
 end
 
 namespace :puppetdb_foreman do
-  task :rubocop do
+  task rubocop: :environment do
     begin
       require 'rubocop/rake_task'
       RuboCop::RakeTask.new(:rubocop_puppetdb_foreman) do |task|
@@ -30,6 +32,4 @@ end
 Rake::Task[:test].enhance ['test:puppetdb_foreman']
 
 load 'tasks/jenkins.rake'
-if Rake::Task.task_defined?(:'jenkins:unit')
-  Rake::Task['jenkins:unit'].enhance ['test:puppetdb_foreman', 'puppetdb_foreman:rubocop']
-end
+Rake::Task['jenkins:unit'].enhance ['test:puppetdb_foreman', 'puppetdb_foreman:rubocop'] if Rake::Task.task_defined?(:'jenkins:unit')

data/test/controllers/api/v2/puppetdb_nodes_controller_test.rb

@@ -1,68 +1,73 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
-class Api::V2::PuppetdbNodesControllerTest < ActionController::TestCase
-  setup do
-    setup_settings
-    User.current = users(:admin)
-    @host = FactoryBot.create(:host, :managed)
-  end
+module Api
+  module V2
+    class PuppetdbNodesControllerTest < ActionController::TestCase
+      setup do
+        User.current = users(:admin)
+        @host = FactoryBot.create(:host, :managed)
+      end
 
-  context '#index' do
-    test 'lists puppetdb nodes unknown to foreman' do
-      ::PuppetdbClient::V4.any_instance.stubs(:query_nodes).returns(['one.example.com', 'two.example.com'])
-      get :index, session: set_session_user
-      assert_response :success
-      response = ActiveSupport::JSON.decode(@response.body)
-      hosts = response['results']
-      assert_includes hosts, 'name' => 'one.example.com'
-      assert_includes hosts, 'name' => 'two.example.com'
-    end
-  end
+      context '#index' do
+        test 'lists puppetdb nodes unknown to foreman' do
+          ::PuppetdbClient::V4.any_instance.stubs(:query_nodes).returns(['one.example.com', 'two.example.com'])
+          get :index, session: set_session_user
+          assert_response :success
+          response = ActiveSupport::JSON.decode(@response.body)
+          hosts = response['results']
+          assert_includes hosts, 'name' => 'one.example.com'
+          assert_includes hosts, 'name' => 'two.example.com'
+        end
+      end
 
-  context '#unknown' do
-    test 'lists puppetdb nodes unknown to foreman' do
-      host = FactoryBot.create(:host, :managed)
-      ::PuppetdbClient::V4.any_instance.stubs(:query_nodes).returns([host.name, 'two.example.com'])
-      get :unknown, session: set_session_user
-      assert_response :success
-      response = ActiveSupport::JSON.decode(@response.body)
-      hosts = response['results']
-      refute_includes hosts, 'name' => host.name
-      assert_includes hosts, 'name' => 'two.example.com'
-    end
-  end
+      context '#unknown' do
+        test 'lists puppetdb nodes unknown to foreman' do
+          host = FactoryBot.create(:host, :managed)
+          ::PuppetdbClient::V4.any_instance.stubs(:query_nodes).returns([host.name, 'two.example.com'])
+          get :unknown, session: set_session_user
+          assert_response :success
+          response = ActiveSupport::JSON.decode(@response.body)
+          hosts = response['results']
+          assert_not_includes hosts, 'name' => host.name
+          assert_includes hosts, 'name' => 'two.example.com'
+        end
+      end
 
-  context '#destroy' do
-    let(:node) { 'test.example.com' }
-    let(:uuid) { SecureRandom.uuid }
+      context '#destroy' do
+        let(:node) { 'test.example.com' }
+        let(:uuid) { SecureRandom.uuid }
 
-    before do
-      ::PuppetdbClient::V4.any_instance.expects(:deactivate_node).with(node).returns(uuid)
-    end
+        before do
+          ::PuppetdbClient::V4.any_instance.expects(:deactivate_node).with(node).returns(uuid)
+        end
 
-    test 'imports a host by puppetdb facts' do
-      delete :destroy, params: { :id => node }, session: set_session_user
-      assert_response :success
-      response = ActiveSupport::JSON.decode(@response.body)
-      expected = { 'job' => { 'uuid' => uuid } }
-      assert_equal expected, response
-    end
-  end
+        test 'imports a host by puppetdb facts' do
+          delete :destroy, params: { id: node }, session: set_session_user
+          assert_response :success
+          response = ActiveSupport::JSON.decode(@response.body)
+          expected = { 'job' => { 'uuid' => uuid } }
+          assert_equal expected, response
+        end
+      end
 
-  context '#import' do
-    let(:node) { 'test.example.com' }
-    let(:host) { FactoryBot.create(:host) }
+      context '#import' do
+        let(:node) { 'test.example.com' }
+        let(:host) { FactoryBot.create(:host) }
 
-    before do
-      ::PuppetdbClient::V4.any_instance.expects(:facts).with(node).returns({})
-      PuppetdbHost.any_instance.expects(:to_host).returns(host)
-    end
+        before do
+          ::PuppetdbClient::V4.any_instance.expects(:facts).with(node).returns({})
+          PuppetdbHost.any_instance.expects(:to_host).returns(host)
+        end
 
-    test 'imports a host by puppetdb facts' do
-      put :import, params: { :id => node }, session: set_session_user
-      assert_response :success
-      response = ActiveSupport::JSON.decode(@response.body)
-      assert_equal host.id, response['id']
+        test 'imports a host by puppetdb facts' do
+          put :import, params: { id: node }, session: set_session_user
+          assert_response :success
+          response = ActiveSupport::JSON.decode(@response.body)
+          assert_equal host.id, response['id']
+        end
+      end
     end
   end
 end

data/test/controllers/nodes_controller_test.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class NodesControllerTest < ActionController::TestCase
   tests ::PuppetdbForeman::NodesController
 
   setup do
-    setup_settings
     User.current = users(:admin)
     @host = FactoryBot.create(:host, :managed)
   end
@@ -15,21 +16,45 @@ class NodesControllerTest < ActionController::TestCase
       ::PuppetdbClient::V4.any_instance.stubs(:query_nodes).returns([host.name, 'two.example.com'])
       get :index, session: set_session_user
       assert_response :success
-      refute response.body =~ /#{host.name}/m
+      assert_not response.body =~ /#{host.name}/m
       assert response.body =~ /two.example.com/m
     end
   end
 
+  context '#show' do
+    let(:host) { FactoryBot.create(:host, :managed) }
+
+    before do
+      resources_resp = [
+        { 'type' => 'Class', 'title' => 'main' },
+        { 'type' => 'Class', 'title' => 'Settings' },
+        { 'type' => 'Stage', 'title' => 'main' },
+      ]
+
+      ::PuppetdbClient::V4.any_instance.stubs(:resources).returns(resources_resp)
+    end
+
+    test 'displays puppet classes information about a given node' do
+      get :show, params: { id: host.name }, session: set_session_user
+
+      assert_response :success
+      assert_includes response.body, '<tr><td>main</td></tr>'
+      assert_includes response.body, '<tr><td>Settings</td></tr>'
+      assert_includes response.body, '2</span> Classes'
+      assert_includes response.body, '2</span> Types'
+    end
+  end
+
   context '#destroy' do
     let(:node) { 'test.example.com' }
     test 'deactivating a node in puppetdb' do
       ::PuppetdbClient::V4.any_instance.expects(:deactivate_node).with(node).returns(true)
-      delete :destroy, params: { :id => node }, session: set_session_user
+      delete :destroy, params: { id: node }, session: set_session_user
       assert_response :found
       assert_redirected_to puppetdb_foreman_nodes_path
       assert_nil flash[:error]
-      assert_not_nil flash[:notice]
-      assert_equal "Deactivated node #{node} in PuppetDB", flash[:notice]
+      assert_not_nil flash[:notice] || flash[:success]
+      assert_equal "Deactivated node #{node} in PuppetDB", flash[:notice] || flash[:success]
     end
   end
 
@@ -43,12 +68,12 @@ class NodesControllerTest < ActionController::TestCase
     end
 
     test 'imports a host from puppetdb facts' do
-      put :import, params: { :id => node }, session: set_session_user
+      put :import, params: { id: node }, session: set_session_user
       assert_response :found
-      assert_redirected_to host_path(:id => host)
+      assert_redirected_to host_path(id: host)
       assert_nil flash[:error]
-      assert_not_nil flash[:notice]
-      assert_equal "Imported host #{node} from PuppetDB", flash[:notice]
+      assert_not_nil flash[:notice] || flash[:success]
+      assert_equal "Imported host #{node} from PuppetDB", flash[:notice] || flash[:success]
     end
   end
 end

data/test/models/host_test.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class HostTest < ActiveSupport::TestCase
   setup do
     User.current = FactoryBot.build(:user, :admin)
-    setup_settings
     disable_orchestration
   end
 
@@ -24,9 +25,9 @@ class HostTest < ActiveSupport::TestCase
         assert_equal 1, tasks.size
       end
 
-      test '#delPuppetdb' do
+      test '#del_puppetdb' do
         ::PuppetdbClient::V4.any_instance.expects(:deactivate_node).with(host.name).returns(true)
-        host.send(:delPuppetdb)
+        host.send(:del_puppetdb)
       end
     end
 
@@ -40,7 +41,7 @@ class HostTest < ActiveSupport::TestCase
         host.queue.clear
         host.send(:queue_puppetdb_destroy)
         tasks = host.queue.all.map(&:name)
-        assert_equal [], tasks
+        assert_empty tasks
       end
     end
   end

data/test/static_fixtures/resources.json

@@ -0,0 +1,41 @@
+[{
+  "tags": ["params", "class"],
+  "file": null,
+  "type": "Class",
+  "title": "Cron",
+  "line": null,
+  "resource": "f13ec266-2914-420c-8d71-13e3466c5856",
+  "certname": "host.example.com",
+  "parameters": {},
+  "exported": false
+}, {
+  "tags": ["class"],
+  "file": null,
+  "type": "Anchor",
+  "title": "postgresql",
+  "line": null,
+  "resource": "9b007f50-87f3-48a1-a4c5-584f2f9d1740",
+  "certname": "host.example.com",
+  "parameters": {},
+  "exported": false
+}, {
+  "tags": ["class"],
+  "file": null,
+  "type": "Class",
+  "title": "SomeClass",
+  "line": 21,
+  "resource": "4b68c39a-b1cc-45ab-96c2-690dbc045f76",
+  "certname": "host.example.com",
+  "parameters": {},
+  "exported": false
+}, {
+  "tags": ["class", "params"],
+  "file": null,
+  "type": "Class",
+  "title": "AnotherClass::Params",
+  "line": null,
+  "resource": "69293889-3e16-48e1-943f-5602096f6c47",
+  "certname": "host.example.com",
+  "parameters": {},
+  "exported": false
+}]

data/test/test_plugin_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This calls the main test_helper in Foreman-core
 require 'test_helper'
 require 'database_cleaner'
@@ -6,10 +8,6 @@ require 'webmock/minitest'
 # Foreman's setup doesn't handle cleaning up for Minitest::Spec
 DatabaseCleaner.strategy = :transaction
 
-def setup_settings
-  Setting::Puppetdb.load_defaults
-end
-
 def fixture(name)
   File.read(File.expand_path("../static_fixtures/#{name}", __FILE__))
 end

data/test/unit/puppetdb_host_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class PuppetdbHostTest < ActiveSupport::TestCase
@@ -7,7 +9,6 @@ class PuppetdbHostTest < ActiveSupport::TestCase
   setup do
     User.current = FactoryBot.create(:user, :admin)
     disable_orchestration
-    setup_settings
   end
 
   let(:sample_facts) do
@@ -15,7 +16,7 @@ class PuppetdbHostTest < ActiveSupport::TestCase
   end
 
   let(:pdbhost) do
-    PuppetdbHost.new(:facts => sample_facts)
+    PuppetdbHost.new(facts: sample_facts)
   end
 
   test 'parses facts' do
@@ -35,12 +36,12 @@ class PuppetdbHostTest < ActiveSupport::TestCase
 
   test 'updates an existing host by facts' do
     Setting[:update_subnets_from_facts] = true
-    FactoryBot.create(:host, :managed, :hostname => 'host', :domain => FactoryBot.create(:domain, :name => 'example.com'))
+    FactoryBot.create(:host, :managed, hostname: 'host', domain: FactoryBot.create(:domain, name: 'example.com'))
     pdbhost.to_host
     host = Host.find_by(name: 'host.example.com')
     assert_equal 'host.example.com', host.name
     # foreman core does not delete old interfaces when importing interfaces from facts
-    assert host.interfaces.where(:ip => '1.1.1.174').first
+    assert host.interfaces.where(ip: '1.1.1.174').first
     assert_equal Operatingsystem.find_by(title: 'RedHat 7.3'), host.operatingsystem
   end
 end