puppetdb_foreman 4.0.0 → 6.0.0

data/test/unit/puppetdb_test.rb

@@ -1,56 +1,19 @@
+# frozen_string_literal: true
+
 require 'test_plugin_helper'
 
 class PuppetdbTest < ActiveSupport::TestCase
   setup do
     User.current = FactoryBot.build(:user, :admin)
-    setup_settings
     disable_orchestration
   end
 
   let(:client) { Puppetdb.client }
   let(:uuid) { SecureRandom.uuid }
 
-  context 'with V1 API' do
-    setup do
-      Setting[:puppetdb_api_version] = 1
-      Setting[:puppetdb_address] = 'https://localhost:8080/v3/commands'
-    end
-
-    test 'deactivate_node' do
-      stub_request(:post, 'https://localhost:8080/v3/commands')
-        .with(:body => 'payload={"command":"deactivate node","version":1,"payload":"\\"www.example.com\\""}',
-              :headers => { 'Accept' => 'application/json' })
-        .to_return(:status => 200, :body => "{\"uuid\" : \"#{uuid}\"}", :headers => { 'Content-Type' => 'application/json; charset=utf-8' })
-
-      assert_equal uuid, client.deactivate_node('www.example.com')
-    end
-
-    test 'query_nodes' do
-      stub_request(:get, 'https://localhost:8080/v3/nodes')
-        .with(:headers => { 'Accept' => 'application/json' })
-        .to_return(:status => 200, :body => fixture('query_nodes.json'), :headers => { 'Content-Type' => 'application/json; charset=utf-8' })
-      expected = (1..10).map { |i| "server#{i}.example.com" }
-      assert_equal expected, client.query_nodes
-    end
-
-    test 'facts' do
-      stub_request(:get, 'https://localhost:8080/v3/facts?query=%5B%22=%22,%20%22certname%22,%20%22host.example.com%22%5D')
-        .with(:headers => { 'Accept' => 'application/json' })
-        .to_return(:status => 200, :body => fixture('facts.json'), :headers => { 'Content-Type' => 'application/json; charset=utf-8' })
-      facts = client.facts('host.example.com')
-      assert_kind_of Array, facts
-      sample = {
-        'value' => 'CEST',
-        'name' => 'timezone',
-        'certname' => 'host.example.com'
-      }
-      assert_includes facts, sample
-    end
-  end
-
-  context 'with V3 API' do
+  context 'with V4 API' do
     setup do
-      Setting[:puppetdb_api_version] = 3
+      Setting[:puppetdb_api_version] = 4
     end
 
     let(:producer_timestamp) { Time.now.iso8601.to_s }
@@ -59,72 +22,58 @@ class PuppetdbTest < ActiveSupport::TestCase
       client.stubs(:producer_timestamp).returns(producer_timestamp)
 
       stub_request(:post, 'https://puppetdb:8081/pdb/cmd/v1')
-        .with(:body => "{\"command\":\"deactivate node\",\"version\":3,\"payload\":{\"certname\":\"www.example.com\",\"producer_timestamp\":\"#{producer_timestamp}\"}}",
-              :headers => { 'Accept' => 'application/json', 'Content-Type' => 'application/json' })
-        .to_return(:status => 200, :body => "{\"uuid\" : \"#{uuid}\"}", :headers => { 'Content-Type' => 'application/json; charset=utf-8' })
+        .with(
+          body: "{\"command\":\"deactivate node\",\"version\":3,\"payload\":{\"certname\":\"www.example.com\",\"producer_timestamp\":\"#{producer_timestamp}\"}}",
+          headers: {
+            'Accept' => 'application/json',
+            'Content-Type' => 'application/json',
+          }
+        )
+        .to_return(status: 200, body: "{\"uuid\" : \"#{uuid}\"}", headers: { 'Content-Type' => 'application/json; charset=utf-8' })
 
       assert_equal uuid, client.deactivate_node('www.example.com')
     end
 
     test 'query_nodes' do
       stub_request(:get, 'https://puppetdb:8081/pdb/query/v4/nodes')
-        .with(:headers => { 'Accept' => 'application/json' })
-        .to_return(:status => 200, :body => fixture('query_nodes_v3_4.json'), :headers => { 'Content-Type' => 'application/json; charset=utf-8' })
+        .with(headers: { 'Accept' => 'application/json' })
+        .to_return(status: 200, body: fixture('query_nodes_v3_4.json'), headers: { 'Content-Type' => 'application/json; charset=utf-8' })
       expected = (1..10).map { |i| "server#{i}.example.com" }
       assert_equal expected, client.query_nodes
     end
 
-    test 'facts' do
-      stub_request(:get, 'https://puppetdb:8081/pdb/query/v4/facts?query=%5B%22=%22,%20%22certname%22,%20%22host.example.com%22%5D')
-        .with(:headers => { 'Accept' => 'application/json' })
-        .to_return(:status => 200, :body => fixture('facts.json'), :headers => { 'Content-Type' => 'application/json; charset=utf-8' })
-      facts = client.facts('host.example.com')
-      assert_kind_of Array, facts
+    test 'resources' do
+      stub_request(:get, 'https://puppetdb:8081/pdb/query/v4/resources?query=%5B%22=%22,%20%22certname%22,%20%22host.example.com%22%5D')
+        .with(headers: { 'Accept' => 'application/json' })
+        .to_return(status: 200, body: fixture('resources.json'), headers: { 'Content-Type' => 'application/json; charset=utf-8' })
+
+      resources = client.resources('host.example.com')
       sample = {
-        'value' => 'CEST',
-        'name' => 'timezone',
-        'certname' => 'host.example.com'
+        'tags' => %w[params class],
+        'file' => nil,
+        'type' => 'Class',
+        'title' => 'Cron',
+        'line' => nil,
+        'resource' => 'f13ec266-2914-420c-8d71-13e3466c5856',
+        'certname' => 'host.example.com',
+        'parameters' => {},
+        'exported' => false,
       }
-      assert_includes facts, sample
-    end
-  end
-
-  context 'with V4 API' do
-    setup do
-      Setting[:puppetdb_api_version] = 4
-    end
 
-    let(:producer_timestamp) { Time.now.iso8601.to_s }
-
-    test 'deactivate_node' do
-      client.stubs(:producer_timestamp).returns(producer_timestamp)
-
-      stub_request(:post, 'https://puppetdb:8081/pdb/cmd/v1')
-        .with(:body => "{\"command\":\"deactivate node\",\"version\":3,\"payload\":{\"certname\":\"www.example.com\",\"producer_timestamp\":\"#{producer_timestamp}\"}}",
-              :headers => { 'Accept' => 'application/json', 'Content-Type' => 'application/json' })
-        .to_return(:status => 200, :body => "{\"uuid\" : \"#{uuid}\"}", :headers => { 'Content-Type' => 'application/json; charset=utf-8' })
-
-      assert_equal uuid, client.deactivate_node('www.example.com')
-    end
-
-    test 'query_nodes' do
-      stub_request(:get, 'https://puppetdb:8081/pdb/query/v4/nodes')
-        .with(:headers => { 'Accept' => 'application/json' })
-        .to_return(:status => 200, :body => fixture('query_nodes_v3_4.json'), :headers => { 'Content-Type' => 'application/json; charset=utf-8' })
-      expected = (1..10).map { |i| "server#{i}.example.com" }
-      assert_equal expected, client.query_nodes
+      assert_kind_of Array, resources
+      assert_includes resources, sample
     end
 
     test 'facts' do
       stub_request(:get, 'https://puppetdb:8081/pdb/query/v4/facts?query=%5B%22=%22,%20%22certname%22,%20%22host.example.com%22%5D')
-        .with(:headers => { 'Accept' => 'application/json' })
-        .to_return(:status => 200, :body => fixture('facts.json'), :headers => { 'Content-Type' => 'application/json; charset=utf-8' })
+        .with(headers: { 'Accept' => 'application/json' })
+        .to_return(status: 200, body: fixture('facts.json'), headers: { 'Content-Type' => 'application/json; charset=utf-8' })
       facts = client.facts('host.example.com')
       assert_kind_of Array, facts
       sample = {
         'value' => 'CEST',
         'name' => 'timezone',
-        'certname' => 'host.example.com'
+        'certname' => 'host.example.com',
       }
       assert_includes facts, sample
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppetdb_foreman
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 6.0.0
 platform: ruby
 authors:
 - Daniel Lobato Garcia
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-01-15 00:00:00.000000000 Z
+date: 2022-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -39,19 +39,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: theforeman-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.0
+        version: 0.1.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.0
+        version: 0.1.2
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -66,10 +66,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'Disable hosts on PuppetDB after they are deleted or built in Foreman,
-  and proxy the PuppetDB dashboard to Foreman. Follow https://github.com/theforeman/puppetdb_foreman
-  and raise an issue/submit a pull request if you need extra functionality. You can
-  also find some help in #theforeman IRC channel on Freenode.'
+description: 'Disable hosts on PuppetDB after they are deleted or built in Foreman.
+  Follow https://github.com/theforeman/puppetdb_foreman and raise an issue/submit
+  a pull request if you need extra functionality. You can also find some help in #theforeman
+  IRC channel on Freenode.'
 email: elobatocs@gmail.com
 executables: []
 extensions: []
@@ -80,23 +80,21 @@ files:
 - Rakefile
 - app/controllers/api/v2/puppetdb_nodes_controller.rb
 - app/controllers/puppetdb_foreman/nodes_controller.rb
-- app/controllers/puppetdb_foreman/puppetdb_controller.rb
+- app/helpers/concerns/puppetdb_foreman/hosts_helper_extensions.rb
 - app/models/concerns/orchestration/puppetdb.rb
 - app/models/puppetdb_foreman/host_extensions.rb
-- app/models/setting/puppetdb.rb
 - app/services/puppetdb.rb
 - app/services/puppetdb_client/base.rb
-- app/services/puppetdb_client/v1.rb
-- app/services/puppetdb_client/v3.rb
 - app/services/puppetdb_client/v4.rb
 - app/services/puppetdb_host.rb
 - app/views/api/v2/puppetdb_nodes/import.json.rabl
 - app/views/api/v2/puppetdb_nodes/index.json.rabl
 - app/views/api/v2/puppetdb_nodes/unknown.json.rabl
 - app/views/puppetdb_foreman/nodes/index.html.erb
-- app/views/puppetdb_foreman/puppetdb/error.html.erb
+- app/views/puppetdb_foreman/nodes/show.html.erb
 - config/routes.rb
 - db/migrate/20170717140010_migrate_puppetdb_api_version_setting.rb
+- db/migrate/20181001113836_remove_puppetdb_dashboard_address_setting.puppetdb_foreman.rb
 - lib/puppetdb_foreman.rb
 - lib/puppetdb_foreman/engine.rb
 - lib/puppetdb_foreman/version.rb
@@ -105,8 +103,8 @@ files:
 - test/controllers/nodes_controller_test.rb
 - test/models/host_test.rb
 - test/static_fixtures/facts.json
-- test/static_fixtures/query_nodes.json
 - test/static_fixtures/query_nodes_v3_4.json
+- test/static_fixtures/resources.json
 - test/test_plugin_helper.rb
 - test/unit/puppetdb_host_test.rb
 - test/unit/puppetdb_test.rb
@@ -114,7 +112,7 @@ homepage: http://www.github.com/theforeman/puppetdb_foreman
 licenses:
 - GPL-3.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -129,9 +127,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: This is a Foreman plugin to interact with PuppetDB.
 test_files:
@@ -139,8 +136,8 @@ test_files:
 - test/controllers/nodes_controller_test.rb
 - test/models/host_test.rb
 - test/static_fixtures/facts.json
-- test/static_fixtures/query_nodes.json
 - test/static_fixtures/query_nodes_v3_4.json
+- test/static_fixtures/resources.json
 - test/test_plugin_helper.rb
 - test/unit/puppetdb_host_test.rb
 - test/unit/puppetdb_test.rb

data/app/controllers/puppetdb_foreman/puppetdb_controller.rb

@@ -1,30 +0,0 @@
-module PuppetdbForeman
-  class PuppetdbController < ApplicationController
-    protect_from_forgery :except => :index
-
-    def index
-      uri = URI.parse(Setting[:puppetdb_dashboard_address])
-      puppetdb_url, layout = case params[:puppetdb]
-                             when 'd3.v2', 'charts' then ["#{uri.path}#{request.original_fullpath}", false]
-                             when 'v3', 'metrics', 'pdb/meta/v1/version', 'pdb/meta/v1/version/latest', 'pdb/dashboard/data' then [request.original_fullpath, false]
-                             else ["#{uri.path}/index.html", true]
-                             end
-      result = Net::HTTP.get_response(uri.host, puppetdb_url, uri.port)
-      render :text => result.body, :layout => layout
-    rescue SocketError
-      @proxy_error = "Problem connecting to host #{uri.host} on port #{uri.port}"
-      render :action => :error, :layout => true
-    rescue Errno::ECONNREFUSED
-      @proxy_error = "#{uri.host} refused our connection"
-      render :action => :error, :layout => true
-    rescue EOFError
-      @proxy_error = "Don't use ssl (https)"
-      render :action => :error, :layout => true
-    end
-
-    # Override from application controller to fix issue
-    def api_request?
-      request.format && (request.format.json? || request.format.yaml?)
-    end
-  end
-end

data/app/models/setting/puppetdb.rb

@@ -1,52 +0,0 @@
-class Setting::Puppetdb < ::Setting
-  BLANK_ATTRS << 'puppetdb_address'
-  BLANK_ATTRS << 'puppetdb_ssl_ca_file'
-  BLANK_ATTRS << 'puppetdb_ssl_certificate'
-  BLANK_ATTRS << 'puppetdb_ssl_private_key'
-  BLANK_ATTRS << 'puppetdb_api_version'
-
-  def self.default_settings
-    if SETTINGS[:puppetdb].present?
-      default_enabled = SETTINGS[:puppetdb][:enabled]
-      default_address = SETTINGS[:puppetdb][:address]
-      default_dashboard_address = SETTINGS[:puppetdb][:dashboard_address]
-      default_ssl_ca_file = SETTINGS[:puppetdb][:ssl_ca_file]
-      default_ssl_certificate = SETTINGS[:puppetdb][:ssl_certificate]
-      default_ssl_private_key = SETTINGS[:puppetdb][:ssl_private_key]
-      default_api_version = SETTINGS[:puppetdb][:api_version]
-    end
-
-    default_enabled = false if default_enabled.nil?
-    default_address ||= 'https://puppetdb:8081/pdb/cmd/v1'
-    default_dashboard_address ||= 'http://puppetdb:8080/pdb/dashboard'
-    default_ssl_ca_file ||= (SETTINGS[:ssl_ca_file]).to_s
-    default_ssl_certificate ||= (SETTINGS[:ssl_certificate]).to_s
-    default_ssl_private_key ||= (SETTINGS[:ssl_priv_key]).to_s
-    default_api_version ||= 4
-
-    [
-      set('puppetdb_enabled', _("Integration with PuppetDB, enabled will deactivate a host in PuppetDB when it's deleted in Foreman"), default_enabled),
-      set('puppetdb_address', _('Foreman will send PuppetDB requests to this address'), default_address),
-      set('puppetdb_dashboard_address', _('Foreman will proxy PuppetDB Performance Dashboard requests to this address'), default_dashboard_address),
-      set('puppetdb_ssl_ca_file', _('Foreman will send PuppetDB requests with this CA file'), default_ssl_ca_file),
-      set('puppetdb_ssl_certificate', _('Foreman will send PuppetDB requests with this certificate file'), default_ssl_certificate),
-      set('puppetdb_ssl_private_key', _('Foreman will send PuppetDB requests with this key file'), default_ssl_private_key),
-      set('puppetdb_api_version', _('Foreman will use this PuppetDB API version'), default_api_version, N_('PuppetDB API Version'), nil, collection: proc { ::Puppetdb::API_VERSIONS })
-    ]
-  end
-
-  def self.load_defaults
-    # Check the table exists
-    return unless super
-
-    transaction do
-      default_settings.each { |s| create! s.update(:category => 'Setting::Puppetdb') }
-    end
-
-    true
-  end
-
-  def self.humanized_category
-    N_('PuppetDB')
-  end
-end

data/app/services/puppetdb_client/v1.rb

@@ -1,29 +0,0 @@
-module PuppetdbClient
-  class V1 < Base
-    # The payload is expected to be the certname of a node as a serialized JSON string.
-    def deactivate_node_payload(nodename)
-      payload = {
-        'command' => 'deactivate node',
-        'version' => 1,
-        'payload' => nodename.to_json
-      }.to_json
-      'payload=' + payload
-    end
-
-    def command_url
-      '/v3/commands'
-    end
-
-    def nodes_url
-      '/v3/nodes'
-    end
-
-    def facts_url
-      '/v3/facts'
-    end
-
-    def query_nodes
-      super.map { |node| node['name'] }
-    end
-  end
-end

data/app/services/puppetdb_client/v3.rb

@@ -1,45 +0,0 @@
-module PuppetdbClient
-  class V3 < 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 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/views/puppetdb_foreman/puppetdb/error.html.erb

@@ -1,6 +0,0 @@
-<%= alert(:class => 'alert-warning',
-          :text => _("Error proxying PuppetDB Dashboard: #{@proxy_error}.") +
-          ' ' + _('Maybe you need to set ') +
-          link_to(_('puppetdb_dashboard_address'),
-          settings_path(:search => 'puppetdb_dashboard_address')) +
-          _(' in Settings')) %>

data/test/static_fixtures/query_nodes.json

@@ -1,61 +0,0 @@
-[ {
-  "name" : "server1.example.com",
-  "deactivated" : null,
-  "catalog_timestamp" : "2017-04-20T15:07:27.114Z",
-  "facts_timestamp" : "2017-04-20T15:06:52.738Z",
-  "report_timestamp" : null
-}, {
-  "name" : "server2.example.com",
-  "deactivated" : null,
-  "catalog_timestamp" : "2017-04-20T15:06:28.282Z",
-  "facts_timestamp" : "2017-04-20T15:06:12.253Z",
-  "report_timestamp" : null
-}, {
-  "name" : "server3.example.com",
-  "deactivated" : null,
-  "catalog_timestamp" : "2017-04-20T15:12:56.090Z",
-  "facts_timestamp" : "2017-04-20T15:12:32.117Z",
-  "report_timestamp" : null
-}, {
-  "name" : "server4.example.com",
-  "deactivated" : null,
-  "catalog_timestamp" : "2017-04-20T15:04:01.154Z",
-  "facts_timestamp" : "2017-04-20T15:03:38.150Z",
-  "report_timestamp" : null
-}, {
-  "name" : "server5.example.com",
-  "deactivated" : null,
-  "catalog_timestamp" : "2017-04-20T15:20:06.853Z",
-  "facts_timestamp" : "2017-04-20T15:19:49.088Z",
-  "report_timestamp" : null
-}, {
-  "name" : "server6.example.com",
-  "deactivated" : null,
-  "catalog_timestamp" : "2017-04-20T15:21:11.520Z",
-  "facts_timestamp" : "2017-04-20T15:20:57.685Z",
-  "report_timestamp" : null
-}, {
-  "name" : "server7.example.com",
-  "deactivated" : null,
-  "catalog_timestamp" : "2017-04-20T15:15:37.033Z",
-  "facts_timestamp" : "2017-04-20T15:15:13.918Z",
-  "report_timestamp" : null
-}, {
-  "name" : "server8.example.com",
-  "deactivated" : null,
-  "catalog_timestamp" : "2017-04-20T15:19:18.236Z",
-  "facts_timestamp" : "2017-04-20T15:19:02.659Z",
-  "report_timestamp" : null
-}, {
-  "name" : "server9.example.com",
-  "deactivated" : null,
-  "catalog_timestamp" : "2017-04-20T14:39:35.070Z",
-  "facts_timestamp" : "2017-04-20T14:39:19.003Z",
-  "report_timestamp" : null
-}, {
-  "name" : "server10.example.com",
-  "deactivated" : null,
-  "catalog_timestamp" : "2017-04-20T15:17:06.209Z",
-  "facts_timestamp" : "2017-04-20T15:16:50.007Z",
-  "report_timestamp" : null
-} ]