foreman_rh_cloud 2.0.10 → 2.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a340f8085bfc6d4d08048369230ab9b90a392cc460b86d53c30bbe8a90ed3c86
-  data.tar.gz: dd76bc695e8d183ac9b9afd05e84ca8650730584919243f9b99d10da522dd707
+  metadata.gz: 778b0d71a8930862a9ea89c96b28024ef830b62bfe09c393da68200884bf1581
+  data.tar.gz: '01600923d9766697d70c1739a1e8a2257357804c01200b5571f8b63464401f8e'
 SHA512:
-  metadata.gz: dbd457318e1c1b23db3e5d2e9a71974f30f6d089fa7df5af02d4b6fbce6487c8b3cedd0749da05d76b32aa5af22a2a1cc99ffaef3d141c77a1edffd838d8bc70
-  data.tar.gz: 7269c01c4e2599456f4d340425ad60b56a9f65749642d0e5cbda9c2217fd792b8cf1d61808a787c36a644d0f785e7c623a22d47b58af83e693530acbb77824fd
+  metadata.gz: e48907c9626cbf815b00bc257a45801f5a55d0f5f6e797cf7d11fadd549e822580d420e60004efa8e92aabb75c1c3b799ecda447c06fa53a6cc7a36a72160747
+  data.tar.gz: 853e77b02847333267442716d2c4909cd9738cd1dbdcfa7a063b0a09859b90832f73f75cd2db78565ffaffba000aa0fdd8ea6924ad98d74f554a998f17cd5964

data/README.md

@@ -13,11 +13,36 @@ for how to install Foreman plugins
 
 ### In Satellite
 
-Normally you run it via UI in RH Cloud -> Inventory Upload -> Restart, but if you need to run from command-line for some reason:
+#### Inventory upload
+
+In UI: Configure -> Inventory Upload -> Restart
+
+From command-line:
 
     export organization_id=1
     export target=/var/lib/foreman/red_hat_inventory/generated_reports/
-    /usr/sbin/foreman-rake foreman_inventory_upload:report:generate
+    /usr/sbin/foreman-rake rh_cloud_inventory:report:generate
+
+#### Fetch hosts remediation data
+
+In UI: Configure -> Insights -> Sync now
+
+From command-line:
+
+    /usr/sbin/foreman-rake rh_cloud_inventory:sync
+
+#### Synchronize inventory status
+
+In UI: Configure -> Inventory Upload -> Sync inventory status
+
+From command-line:
+
+    # all organizations
+    /usr/sbin/foreman-rake rh_cloud_insights:sync
+    
+    # specific organization with id 1
+    export organization_id=1
+    /usr/sbin/foreman-rake rh_cloud_insights:sync
 
 ## TODO
 

data/app/controllers/foreman_inventory_upload/accounts_controller.rb

@@ -23,7 +23,9 @@ module ForemanInventoryUpload
       render json: {
         autoUploadEnabled: Setting[:allow_auto_inventory_upload],
         hostObfuscationEnabled: Setting[:obfuscate_inventory_hostnames],
+        ipsObfuscationEnabled: Setting[:obfuscate_inventory_ips],
         cloudToken: Setting[:rh_cloud_token],
+        excludePackages: Setting[:exclude_installed_packages],
         accounts: accounts,
       }, status: :ok
     end

data/app/controllers/foreman_inventory_upload/uploads_controller.rb

@@ -46,6 +46,24 @@ module ForemanInventoryUpload
       ActiveModel::Type::Boolean.new.cast(params.require(:value))
     end
 
+    def installed_packages_inclusion
+      Setting[:exclude_installed_packages] = host_obfuscation_params
+      render_setting(:excludePackages, :exclude_installed_packages)
+    end
+
+    def installed_packages_inclusion_params
+      ActiveModel::Type::Boolean.new.cast(params.require(:value))
+    end
+
+    def ips_obfuscation
+      Setting[:obfuscate_inventory_ips] = ips_obfuscation_params
+      render_setting(:ipsObfuscationEnabled, :obfuscate_inventory_ips)
+    end
+
+    def ips_obfuscation_params
+      ActiveModel::Type::Boolean.new.cast(params.require(:value))
+    end
+
     private
 
     def render_setting(node_name, setting)

data/app/controllers/insights_cloud/hits_controller.rb

@@ -0,0 +1,17 @@
+module InsightsCloud
+  class HitsController < ::ApplicationController
+    def index
+      host = Host.where(id: host_id_param).first
+
+      render json: {
+        hits: host.insights.hits,
+      }, status: :ok
+    end
+
+    private
+
+    def host_id_param
+      params.require(:host_id)
+    end
+  end
+end

data/app/helpers/foreman_inventory_upload_host_helper.rb

@@ -5,11 +5,10 @@ module ForemanInventoryUploadHostHelper
 
   def hits_counts_cell(host)
     host_hits = hits_counts[host.id]
-    content = n_('One recommendation', '%{hits} recommendations', host_hits) % { hits: host_hits } if host_hits
-    tag.td class: ['hidden-xs', 'ellipsis'] do
+    tag.td class: ['hidden-xs', 'ellipsis', 'text-center'] do
       if host_hits
         link_to(
-          content,
+          host_hits,
           InsightsCloud::WebUi.system_url(InsightsCloud::WebUi::ADVISOR, host.insights.uuid),
           :rel => 'external noopener noreferrer',
           :target => '_blank'

data/app/models/concerns/rh_cloud_host.rb

@@ -0,0 +1,15 @@
+module RhCloudHost
+  extend ActiveSupport::Concern
+
+  included do
+    has_many(
+      :inventory_upload_facts,
+      -> { where(fact_name_id: ForemanInventoryUpload::Generators::Queries.fact_names.values) },
+      class_name: 'FactValue',
+      foreign_key: :host_id
+    )
+
+    has_many :insights_hits, through: :insights, source: :hits
+    scoped_search :relation => :insights, :on => :hits_count, :only_explicit => true, :rename => :insights_recommendations_count
+  end
+end

data/app/models/insights_hit.rb

@@ -2,5 +2,5 @@ class InsightsHit < ApplicationRecord
   has_one :host
   # since the facet is one-to-one association with a host, we can connect
   # through host_id column on both this model and facet.
-  has_one :insights_facet, foreign_key: 'host_id', primary_key: 'host_id'
+  belongs_to :insights_facet, foreign_key: 'host_id', primary_key: 'host_id', counter_cache: :hits_count
 end

data/app/models/setting/rh_cloud.rb

@@ -6,7 +6,9 @@ class Setting::RhCloud < Setting
       set('allow_auto_inventory_upload', N_('Allow automatic upload of the host inventory to the Red Hat cloud'), false),
       set('allow_auto_insights_sync', N_('Allow recommendations synchronization from Red Hat cloud'), false),
       set('obfuscate_inventory_hostnames', N_('Obfuscate host names sent to Red Hat cloud'), false),
+      set('obfuscate_inventory_ips', N_('Obfuscate ip addresses sent to Red Hat cloud'), false),
       set('rh_cloud_token', N_('Authentication token to Red Hat cloud services. Used to authenticate requests to cloud APIs'), 'DEFAULT', N_('Red Hat Cloud token'), nil, encrypted: true),
+      set('exclude_installed_packages', N_('Exclude installed packages from Red Hat cloud inventory report'), false),
     ]
   end
 

data/app/overrides/hosts_list.rb

@@ -2,7 +2,7 @@ Deface::Override.new(
   virtual_path: 'hosts/_list',
   name: 'insights_hits_header',
   insert_before: 'thead tr th.hidden-xs:first-of-type',
-  text: '<th class="hidden-xs" width="10%"><%= _("Insights")%></th>'
+  text: '<th class="hidden-xs ellipsis" width="12%"><%= sort :insights_recommendations_count, :as => _("Recommendations")%></th>'
 )
 
 Deface::Override.new(

data/app/services/foreman_rh_cloud/cloud_auth.rb

@@ -0,0 +1,28 @@
+module ForemanRhCloud
+  module CloudAuth
+    extend ActiveSupport::Concern
+
+    def rh_credentials
+      @rh_credentials ||= query_refresh_token
+    end
+
+    def query_refresh_token
+      token_response = RestClient::Request.execute(
+        method: :post,
+        url: ForemanRhCloud.authentication_url,
+        verify_ssl: ForemanRhCloud.verify_ssl_method,
+        proxy: ForemanRhCloud.transformed_http_proxy_string(logger: logger),
+        payload: {
+          grant_type: 'refresh_token',
+          client_id: 'rhsm-api',
+          refresh_token: Setting[:rh_cloud_token],
+        }
+      )
+
+      JSON.parse(token_response)['access_token']
+    rescue RestClient::ExceptionWithResponse => e
+      Foreman::Logging.exception('Unable to authenticate using rh_cloud_token setting', e)
+      raise ::Foreman::WrappedException.new(e, N_('Unable to authenticate using rh_cloud_token setting'))
+    end
+  end
+end

data/app/views/foreman_rh_cloud/react/insights_cloud.html.erb

@@ -1,6 +1 @@
-<%= mount_react_component(
-'InsightsCloudSync',
-'#ForemanRhCloudReactRoot',
-{
-  settingsUrl: settings_url(search: 'name = rh_cloud_token')
-}.to_json) %>
+<%= react_component('InsightsCloudSync', { settingsUrl: settings_url(search: 'name = rh_cloud_token') }) %>

data/app/views/foreman_rh_cloud/react/inventory_upload.html.erb

@@ -1 +1 @@
-<%= mount_react_component('ForemanInventoryUpload', '#ForemanRhCloudReactRoot') %>
+<%= react_component('ForemanInventoryUpload') %>

data/app/views/hosts/_insights_tab.html.erb

@@ -0,0 +1,9 @@
+<% content_for(:javascripts) do %>
+  <%= webpacked_plugins_js_for :'foreman_rh_cloud' %>
+<% end %>
+
+<% content_for(:stylesheets) do %>
+    <%= webpacked_plugins_css_for :'foreman_rh_cloud' %>
+<% end %>
+
+<%= react_component('InsightsHostDetailsTab', { hostID: host.id }) %>

data/app/views/layouts/foreman_rh_cloud/application.html.erb

@@ -10,7 +10,6 @@
   <%= notifications %>
   <div id="organization-id" data-id="<%= Organization.current.id if Organization.current %>" ></div>
   <div id="user-id" data-id="<%= User.current.id if User.current %>" ></div>
-  <div id="ForemanRhCloudReactRoot"></div>
   <%= yield %>
 <% end %>
 <%= render file: "layouts/base" %>

data/config/routes.rb

@@ -8,6 +8,8 @@ Rails.application.routes.draw do
     get 'auto_upload', to: 'uploads#show_auto_upload'
     post 'auto_upload', to: 'uploads#auto_upload'
     post 'host_obfuscation', to: 'uploads#host_obfuscation'
+    post 'installed_packages_inclusion', to: 'uploads#installed_packages_inclusion'
+    post 'ips_obfuscation', to: 'uploads#ips_obfuscation'
 
     resources :tasks, only: [:create]
   end
@@ -15,6 +17,7 @@ Rails.application.routes.draw do
   namespace :insights_cloud do
     resources :tasks, only: [:create]
     resource :settings, only: [:show, :update]
+    get 'hits/:host_id', to: 'hits#index'
   end
 
   namespace :foreman_rh_cloud do

data/db/migrate/20201007115752_add_hits_count_to_insights_facets_table.foreman_rh_cloud.rb

@@ -0,0 +1,5 @@
+class AddHitsCountToInsightsFacetsTable < ActiveRecord::Migration[5.0]
+  def change
+    add_column :insights_facets, :hits_count, :integer
+  end
+end

data/db/migrate/20201007121540_setup_hits_count_cache.foreman_rh_cloud.rb

@@ -0,0 +1,10 @@
+class SetupHitsCountCache < ActiveRecord::Migration[5.0]
+  def up
+    ActiveRecord::Base.connection.execute <<-SQL.squish
+    UPDATE insights_facets
+    SET hits_count = (SELECT count(1)
+                              FROM insights_hits
+                              WHERE insights_hits.host_id = insights_facets.host_id)
+    SQL
+  end
+end

data/lib/foreman_inventory_upload/async/generate_report_job.rb

@@ -23,7 +23,7 @@ module ForemanInventoryUpload
       end
 
       def command
-        "#{rake_prefix}rake foreman_inventory_upload:report:generate"
+        "#{rake_prefix}rake rh_cloud_inventory:report:generate"
       end
 
       def env

data/lib/foreman_inventory_upload/async/shell_process.rb

@@ -8,24 +8,30 @@ module ForemanInventoryUpload
       def perform(instance_label)
         klass_name = self.class.name
         logger.debug("Starting #{klass_name} with label #{instance_label}")
-        progress_output = ProgressOutput.register(instance_label)
-        Open3.popen2e(hash_to_s(env), *preprocess_command(command)) do |_stdin, stdout_stderr, wait_thread|
-          progress_output.status = "Running in pid #{wait_thread.pid}"
+        progress_output_for(instance_label) do |progress_output|
+          Open3.popen2e(hash_to_s(env), *preprocess_command(command)) do |_stdin, stdout_stderr, wait_thread|
+            progress_output.status = "Running in pid #{wait_thread.pid}"
 
-          stdout_stderr.each do |out_line|
-            progress_output.write_line(out_line)
-          end
+            stdout_stderr.each do |out_line|
+              progress_output.write_line(out_line)
+            end
 
-          progress_output.status = wait_thread.value.to_s
+            progress_output.status = wait_thread.value.to_s
+          end
         end
         logger.debug("Finished job #{klass_name} with label #{instance_label}")
-      ensure
-        progress_output.close
       end
 
       def command
       end
 
+      def progress_output_for(instance_label)
+        progress_output = ProgressOutput.register(instance_label)
+        yield(progress_output)
+      ensure
+        progress_output.close
+      end
+
       def env
         {}
       end

data/lib/foreman_inventory_upload/async/upload_report_job.rb

@@ -8,15 +8,33 @@ module ForemanInventoryUpload
       end
 
       def perform(filename, organization_id)
+        label = UploadReportJob.output_label(organization_id)
         @filename = filename
         @organization = Organization.find(organization_id)
 
+        if Setting[:content_disconnected]
+          progress_output_for(label) do |progress_output|
+            progress_output.write_line('Upload was stopped since disconnected mode setting is enabled for content on this instance.')
+            progress_output.status = "Task aborted, exit 1"
+          end
+          return
+        end
+
+        unless @organization.owner_details&.fetch('upstreamConsumer')&.fetch('idCert')
+          logger.info("Skipping organization '#{@organization}', no candlepin certificate defined.")
+          progress_output_for(label) do |progress_output|
+            progress_output.write_line("Skipping organization #{@organization}, no candlepin certificate defined.")
+            progress_output.status = "Task aborted, exit 1"
+          end
+          return
+        end
+
         Tempfile.create([@organization.name, '.pem']) do |cer_file|
           cer_file.write(rh_credentials[:cert])
           cer_file.write(rh_credentials[:key])
           cer_file.flush
           @cer_path = cer_file.path
-          super(UploadReportJob.output_label(organization_id))
+          super(label)
         end
       end
 
@@ -29,6 +47,8 @@ module ForemanInventoryUpload
           'FILES' => @filename,
           'CER_PATH' => @cer_path
         )
+
+        http_proxy_string = ForemanRhCloud.http_proxy_string(logger: logger)
         if http_proxy_string
           env_vars['http_proxy'] = http_proxy_string
           env_vars['https_proxy'] = http_proxy_string
@@ -36,13 +56,6 @@ module ForemanInventoryUpload
         env_vars
       end
 
-      def http_proxy_string
-        @http_proxy_string ||=
-          HttpProxy.default_global_content_proxy&.full_url ||
-          cdn_proxy ||
-          global_foreman_proxy
-      end
-
       def rh_credentials
         @rh_credentials ||= begin
           candlepin_id_certificate = @organization.owner_details['upstreamConsumer']['idCert']
@@ -52,31 +65,6 @@ module ForemanInventoryUpload
           }
         end
       end
-
-      def cdn_proxy
-        cdn_settings = SETTINGS[:katello][:cdn_proxy] || {}
-
-        return nil unless cdn_settings[:host]
-
-        proxy_uri = URI('')
-
-        original_uri = URI.parse(cdn_settings[:host])
-
-        proxy_uri.scheme = original_uri.scheme || 'http'
-        proxy_uri.host = original_uri.host || original_uri.path
-        proxy_uri.port = cdn_settings[:port]
-        proxy_uri.user = cdn_settings[:user]
-        proxy_uri.password = cdn_settings[:password]
-
-        proxy_uri.to_s
-      rescue URI::Error => e
-        logger.warn("cdn_proxy parsing failed: #{e}")
-        nil
-      end
-
-      def global_foreman_proxy
-        Setting[:http_proxy]
-      end
     end
   end
 end

data/lib/foreman_inventory_upload/generators/fact_helpers.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module ForemanInventoryUpload
   module Generators
     module FactHelpers
@@ -69,6 +71,39 @@ module ForemanInventoryUpload
       def obfuscate_fqdn(fqdn)
         "#{Digest::SHA1.hexdigest(fqdn)}.example.com"
       end
+
+      def obfuscate_ips?(host)
+        insights_client_setting = fact_value(host, 'insights_client::obfuscate_ip_enabled')
+        insights_client_setting = ActiveModel::Type::Boolean.new.cast(insights_client_setting)
+        return insights_client_setting unless insights_client_setting.nil?
+
+        Setting[:obfuscate_inventory_ips]
+      end
+
+      def host_ips(host)
+        return obfuscated_ips(host) if obfuscate_ips?(host)
+
+        # return a pass through proxy hash in case no obfuscation needed
+        Hash.new { |h, k| k }
+      end
+
+      def obfuscated_ips(host)
+        insights_client_ips = JSON.parse(fact_value(host, 'insights_client::ips') || '[]')
+
+        obfuscated_ips = Hash[
+          insights_client_ips.map { |ip_record| [ip_record['original'], ip_record['obfuscated']] }
+        ]
+
+        obfuscated_ips.default_proc = proc do |hash, key|
+          hash[key] = obfuscate_ip(key, hash)
+        end
+
+        obfuscated_ips
+      end
+
+      def obfuscate_ip(ip, ips_dict)
+        "10.230.230.#{ips_dict.count + 1}"
+      end
     end
   end
 end