foreman_rh_cloud 1.0.10 → 1.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb457584e95614e52c7026cb963409b2a2ea645b082315c0004b787db6ecf028
-  data.tar.gz: 6352df86d12f35dbdc4d90538c1604aa00e1c4710f09c6deb0066efce8a48277
+  metadata.gz: 830861dcfd46371108e610046d742960ace76310a79bf3fde268de4230de0ccb
+  data.tar.gz: a42767333df5769a37bcd9e28ebb9e7eab815a13933bdd38cb678c77602eb5b0
 SHA512:
-  metadata.gz: 1299b5836e5bf30151c690e5c222c67d34f351b0e5ffbd4e3ffeead0109457adce46279a1ddb550f3468aac4439c1050e366bf831dfb3c84b3e021e5cc2d9dd3
-  data.tar.gz: edc7f560cd4ed663a07535bc247b0d5baf7e5755a50f002e9c752116cda93b729a15cc7b4452c12a95d9cee542d7201f900142f408abfa43a8e308d390305aa2
+  metadata.gz: bc3f5e9f3f5dff9c8198bc10d131c42f6b2cd8ef5409711182af631effda0b0b99a2c12f9e0b0e1cf4d30a821f58d28fef94edc2341a2938693ba773832a8a27
+  data.tar.gz: 87731548c51473f8f88d20f9036d3709135734795c950ffb70fe86b302d18c209a3825fa720b1227ffbe3cc4a51960f7386a6cbfce0d91494f94afb0d2de4745

data/README.md

@@ -11,6 +11,39 @@ for how to install Foreman plugins
 
 *Usage here*
 
+### In Satellite
+
+#### 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 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
 
 *Todo list here*

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/hosts/_insights_tab.html.erb

@@ -0,0 +1,15 @@
+<% content_for(:javascripts) do %>
+  <%= webpacked_plugins_js_for :'foreman_rh_cloud' %>
+<% end %>
+
+<% content_for(:stylesheets) do %>
+    <%= webpacked_plugins_css_for :'foreman_rh_cloud' %>
+<% end %>
+
+<div id="host_details_insights_react_container"></div>
+<%= mount_react_component(
+  'InsightsHostDetailsTab',
+  '#host_details_insights_react_container',
+  { hostID: host.id }.to_json,
+  flatten_data: true
+) %>

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), 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), 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,14 +56,6 @@ module ForemanInventoryUpload
         env_vars
       end
 
-      def http_proxy_string
-        @http_proxy_string ||= begin
-          if Setting[:content_default_http_proxy]
-            HttpProxy.unscoped.find_by(name: Setting[:content_default_http_proxy])&.full_url
-          end
-        end
-      end
-
       def rh_credentials
         @rh_credentials ||= begin
           candlepin_id_certificate = @organization.owner_details['upstreamConsumer']['idCert']

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

data/lib/foreman_inventory_upload/generators/json_stream.rb

@@ -26,8 +26,13 @@ module ForemanInventoryUpload
         @out << string
       end
 
-      def simple_field(name, value, last = false)
-        @out << "\"#{name}\": #{stringify_value(value)}#{last ? '' : ','}" unless value.nil?
+      def simple_field(name, value, last = false, &block)
+        return if value.nil? || value.try(:empty?)
+        return if value.kind_of?(Array) && value.compact.empty?
+
+        block ||= ->(value) { value }
+
+        @out << "\"#{name}\": #{stringify_value(block.call(value))}#{last ? '' : ','}"
       end
 
       def array_field(name, last = false, &block)

data/lib/foreman_inventory_upload/generators/metadata.rb

@@ -21,6 +21,9 @@ module ForemanInventoryUpload
       private
 
       def render_report(metadata)
+        metadata ||= {}
+        metadata['foreman_rh_cloud_version'] = ForemanRhCloud::VERSION
+
         @stream.object do
           @stream.simple_field('report_id', Foreman.uuid)
           @stream.simple_field('host_inventory_api_version', '1.0')

data/lib/foreman_inventory_upload/generators/queries.rb

@@ -24,29 +24,29 @@ module ForemanInventoryUpload
               'dmi::system::product_name',
               'dmi::chassis::asset_tag',
               'insights_client::obfuscate_hostname_enabled',
+              'insights_client::obfuscate_ip_enabled',
               'insights_client::hostname',
+              'insights_client::ips',
             ]).pluck(:name, :id)
           ]
       end
 
       def self.for_slice(base)
-        fact_values = FactValue.where(fact_name_id: fact_names.values)
         base
           .joins(:subscription_facet)
-          .eager_load(:fact_values)
           .preload(
             :interfaces,
             :installed_packages,
             :content_facet,
             :host_statuses,
+            :inventory_upload_facts,
             subscription_facet: [:pools, :installed_products, :hypervisor_host]
           )
-          .merge(fact_values)
       end
 
       def self.for_report(portal_user)
         org_ids = organizations_for_user(portal_user).pluck(:id)
-        for_slice(Host.unscoped.where(organization_id: org_ids)).in_batches(of: 1_000)
+        for_org(org_ids)
       end
 
       def self.for_org(organization_id)