foreman_rh_cloud 0.9.6 → 1.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7eee1b8b134db1bd55e2d737aab48dd46a97a8b97a5e8cd077ffe6381f13187
-  data.tar.gz: 6d00068cd4e2ca0cf50ccf45d5eff5ba6546b8c45638c53c3ac3a3703c974812
+  metadata.gz: cf631b63f0110a4a5d39aa664905fef695e8b402d458fe20704db84880bdf33f
+  data.tar.gz: ac49f7073bf0e2828964587434f84275029ca0aef285f963d00ddc7e569b8197
 SHA512:
-  metadata.gz: 66a8870e7e6950cfbfeab6ee4f1f98718bcc7ac4dbd5ac8a38c5ba5165c9d9e577e4f459092eb2b121fd388dddd3c9aa8b225e069645a248a5a43db7ab79ebed
-  data.tar.gz: 48820898171bca9808a0dedd1d0f494cd7407a40e668fde73d8e33b4a311812609b9c37ec0bd99f7244a431fcd8cf93243607e041884549aa63270ae14c0fe85
+  metadata.gz: 9d9015a4931ab563c5d56cc38c1ea9ba54df04ebf9305f4077d5b88284b84b78da02f9dfed267192a8ce7ed49e98bf4b89e884eda8eae08a68fe8699771a9f69
+  data.tar.gz: 45a135ff52da1cedacb37b84a70b3f73347d741e62beb95a96e0fed7cf022928649ca470b6d9242c9bfe55b790e28f2fb734f76fa0524f6548351fcc81d7b580

data/app/controllers/foreman_inventory_upload/accounts_controller.rb

@@ -1,12 +1,8 @@
 module ForemanInventoryUpload
   class AccountsController < ::ApplicationController
-    # override default "welcome screen behavior, since we don't have a model"
-    def welcome
-      true
-    end
-
     def index
-      labels = Organization.all.pluck(:id, :name)
+      organizations = User.current.my_organizations
+      labels = organizations.pluck(:id, :name)
 
       accounts = Hash[
         labels.map do |id, label|

data/app/controllers/foreman_rh_cloud/react_controller.rb

@@ -0,0 +1,8 @@
+module ForemanRhCloud
+  class ReactController < ::ApplicationController
+    layout "foreman_rh_cloud/application"
+
+    def inventory_upload
+    end
+  end
+end

data/app/models/setting/rh_cloud.rb

@@ -1,15 +1,11 @@
 class Setting::RhCloud < Setting
-  def self.load_defaults
+  def self.default_settings
     return unless ActiveRecord::Base.connection.table_exists?('settings')
     return unless super
-
-    transaction do
-      [
-        set('allow_auto_inventory_upload', N_('Allow automatic upload of the host inventory to the Red Hat cloud'), true),
-      ].each { |s| create! s.update(:category => 'Setting::RhCloud')}
-    end
-
-    true
+    [
+      set('allow_auto_inventory_upload', N_('Allow automatic upload of the host inventory to the Red Hat cloud'), true),
+      set('obfuscate_inventory_hostnames', N_('Obfuscate host names sent to Red Hat cloud'), false),
+    ]
   end
 
   def self.humanized_category

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

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

data/app/views/{foreman_inventory_upload/layouts/react.html.erb → layouts/foreman_rh_cloud/application.html.erb}

@@ -10,7 +10,7 @@
   <%= 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="ForemanInventoryUploadReactRoot"></div>
+  <div id="ForemanRhCloudReactRoot"></div>
+  <%= yield %>
 <% end %>
 <%= render file: "layouts/base" %>
-<%= mount_react_component('ForemanInventoryUpload', '#ForemanInventoryUploadReactRoot') %>

data/config/routes.rb

@@ -1,6 +1,5 @@
 Rails.application.routes.draw do
   namespace :foreman_inventory_upload do
-    get 'index', to: 'react#index'
     get ':organization_id/reports/last', to: 'reports#last', constraints: { organization_id: %r{[^\/]+} }
     post ':organization_id/reports', to: 'reports#generate', constraints: { organization_id: %r{[^\/]+} }
     get ':organization_id/uploads/last', to: 'uploads#last', constraints: { organization_id: %r{[^\/]+} }
@@ -8,4 +7,8 @@ Rails.application.routes.draw do
     get 'accounts', to: 'accounts#index'
     post 'auto_upload', to: 'uploads#auto_upload'
   end
+
+  namespace :foreman_rh_cloud do
+    get 'inventory_upload', to: 'react#inventory_upload'
+  end
 end

data/lib/foreman_inventory_upload/async/queue_for_upload_job.rb

@@ -30,11 +30,16 @@ module ForemanInventoryUpload
       def ensure_output_script
         return if File.exist?(script_file)
 
-        script_source_file = File.join(ForemanRhCloud::Engine.root, 'lib/foreman_inventory_upload/scripts/uploader.sh.erb')
-
-        script_source = File.read(script_source_file)
-        script_source.gsub!('<%= @upload_url %>', ForemanInventoryUpload.upload_url)
-
+        script_source = File.join(ForemanRhCloud::Engine.root, 'lib/foreman_inventory_upload/scripts/uploader.sh.erb')
+
+        template_src = Foreman::Renderer::Source::String.new(content: File.read(script_source))
+        scope = Foreman::Renderer::Scope::Base.new(
+          source: template_src,
+          variables: {
+            upload_url: ForemanInventoryUpload.upload_url,
+          }
+        )
+        script_source = Foreman::Renderer.render(template_src, scope)
         File.write(script_file, script_source)
         FileUtils.chmod('+x', script_file)
       end

data/lib/foreman_inventory_upload/generators/fact_helpers.rb

@@ -3,6 +3,11 @@ module ForemanInventoryUpload
     module FactHelpers
       extend ActiveSupport::Concern
 
+      CLOUD_AMAZON = 'aws'
+      CLOUD_GOOGLE = 'google'
+      CLOUD_AZURE = 'azure'
+      CLOUD_ALIBABA = 'alibaba'
+
       def fact_value(host, fact_name)
         value_record = host.fact_values.find do |fact_value|
           fact_value.fact_name_id == ForemanInventoryUpload::Generators::Queries.fact_names[fact_name]
@@ -26,6 +31,44 @@ module ForemanInventoryUpload
         @organization_golden_tickets ||= {}
         @organization_golden_tickets[organization.id] ||= result
       end
+
+      def cloud_provider(host)
+        bios_version = fact_value(host, 'dmi::bios::version')
+
+        if bios_version
+          return CLOUD_AMAZON if bios_version.downcase['amazon']
+          return CLOUD_GOOGLE if bios_version.downcase['google']
+        end
+
+        chassis_asset_tag = fact_value(host, 'dmi::chassis::asset_tag')
+        return CLOUD_AZURE if chassis_asset_tag && chassis_asset_tag['7783-7084-3265-9085-8269-3286-77']
+
+        system_manufacturer = fact_value(host, 'dmi::system::manufacturer')
+        return CLOUD_ALIBABA if system_manufacturer && system_manufacturer.downcase['alibaba cloud']
+
+        product_name = fact_value(host, 'dmi::system::product_name')
+        return CLOUD_ALIBABA if product_name && product_name.downcase['alibaba cloud ecs']
+
+        nil
+      end
+
+      def obfuscate_hostname?(host)
+        insights_client_setting = fact_value(host, 'insights_client::obfuscate_hostname_enabled')
+        insights_client_setting = ActiveModel::Type::Boolean.new.cast(insights_client_setting)
+        return insights_client_setting unless insights_client_setting.nil?
+
+        Setting[:obfuscate_inventory_hostnames]
+      end
+
+      def fqdn(host)
+        return host.fqdn unless obfuscate_hostname?(host)
+
+        fact_value(host, 'insights_client::hostname') || obfuscate_fqdn(host.fqdn)
+      end
+
+      def obfuscate_fqdn(fqdn)
+        Base64.urlsafe_encode64(Digest::SHA1.digest(fqdn), padding: false)
+      end
     end
   end
 end

data/lib/foreman_inventory_upload/generators/queries.rb

@@ -20,6 +20,11 @@ module ForemanInventoryUpload
               'distribution::version',
               'distribution::id',
               'virt::is_guest',
+              'dmi::system::manufacturer',
+              'dmi::system::product_name',
+              'dmi::chassis::asset_tag',
+              'insights_client::obfuscate_hostname_enabled',
+              'insights_client::hostname',
             ]).pluck(:name, :id)
           ]
       end

data/lib/foreman_inventory_upload/generators/slice.rb

@@ -39,7 +39,7 @@ module ForemanInventoryUpload
 
       def report_host(host)
         @stream.object do
-          @stream.simple_field('fqdn', host.fqdn)
+          @stream.simple_field('fqdn', fqdn(host))
           @stream.simple_field('account', account_id(host.organization).to_s)
           @stream.simple_field('subscription_manager_id', host.subscription_facet&.uuid)
           @stream.simple_field('satellite_id', host.subscription_facet&.uuid)
@@ -126,6 +126,7 @@ module ForemanInventoryUpload
           'infrastructure_type',
           ActiveModel::Type::Boolean.new.cast(fact_value(host, 'virt::is_guest')) ? 'virtual' : 'physical'
         )
+        @stream.simple_field('cloud_provider', cloud_provider(host))
         unless (installed_products = host.subscription_facet&.installed_products).empty?
           @stream.array_field('installed_products') do
             @stream.raw(installed_products.map do |product|

data/lib/foreman_inventory_upload/scripts/uploader.sh.erb

@@ -1,6 +1,7 @@
 #! /bin/sh
 
 DEST=<%= @upload_url %>
+RH_USERNAME=<%= @rh_username %>
 
 if [ -z "$FILES" ]
 then

data/lib/foreman_rh_cloud/engine.rb

@@ -26,19 +26,31 @@ module ForemanRhCloud
 
     initializer 'foreman_rh_cloud.register_plugin', :before => :finisher_hook do |_app|
       Foreman::Plugin.register :foreman_rh_cloud do
-        requires_foreman '>= 1.20'
+        requires_foreman '~> 1.24.0'
 
         # Add permissions
         security_block :foreman_rh_cloud do
-          permission :view_foreman_rh_cloud, :'foreman_rh_cloud/reports' => [:last]
+          permission(:generate_foreman_rh_cloud, :'foreman_inventory_upload/reports' => [:generate])
+          permission(:view_foreman_rh_cloud,
+                     'foreman_inventory_upload/accounts': [:index],
+                     'foreman_inventory_upload/reports': [:last],
+                     'foreman_inventory_upload/uploads': [:auto_upload, :download_file, :last],
+                     'foreman_rh_cloud/react': [:inventory_upload]
+                    )
         end
 
-        # Add a new role called 'Discovery' if it doesn't exist
-        role 'ForemanRhCloud', [:view_foreman_rh_cloud]
+        plugin_permissions = [:view_foreman_rh_cloud, :generate_foreman_rh_cloud]
+
+        role 'ForemanRhCloud', plugin_permissions, 'Role granting permissions to view the hosts inventory,
+                                                    generate a report, upload it to the cloud and download it locally'
+
+        add_permissions_to_default_roles Role::ORG_ADMIN => plugin_permissions,
+                                         Role::MANAGER => plugin_permissions,
+                                         Role::SYSTEM_ADMIN => plugin_permissions
 
         # Adding a sub menu after hosts menu
         sub_menu :top_menu, :foreman_rh_cloud, :caption => N_('RH Cloud'), :icon => 'fa fa-cloud-upload' do
-          menu :top_menu, :level1, :caption => N_('Inventory Upload'), :url_hash => { controller: :'foreman_inventory_upload/react', :action => :index}
+          menu :top_menu, :level1, :caption => N_('Inventory Upload'), :url_hash => { controller: :'foreman_rh_cloud/react', :action => :inventory_upload}
         end
       end
     end

data/lib/foreman_rh_cloud/version.rb

@@ -1,3 +1,3 @@
 module ForemanRhCloud
-  VERSION = '0.9.6'.freeze
+  VERSION = '1.0.7'.freeze
 end

data/test/unit/slice_generator_test.rb

@@ -38,6 +38,11 @@ class ReportGeneratorTest < ActiveSupport::TestCase
       'distribution::version',
       'distribution::id',
       'virt::is_guest',
+      'dmi::system::manufacturer',
+      'dmi::system::product_name',
+      'dmi::chassis::asset_tag',
+      'insights_client::obfuscate_hostname_enabled',
+      'insights_client::hostname',
     ]
   end
 
@@ -63,6 +68,58 @@ class ReportGeneratorTest < ActiveSupport::TestCase
     assert_equal 1, generator.hosts_count
   end
 
+  test 'obfuscates fqdn when instructed by insights-client' do
+    FactoryBot.create(:fact_value, fact_name: fact_names['insights_client::obfuscate_hostname_enabled'], value: 'true', host: @host)
+    FactoryBot.create(:fact_value, fact_name: fact_names['insights_client::hostname'], value: 'obfuscated_name', host: @host)
+
+    batch = Host.where(id: @host.id).in_batches.first
+    generator = create_generator(batch)
+
+    json_str = generator.render
+    actual = JSON.parse(json_str.join("\n"))
+
+    assert_equal 'slice_123', actual['report_slice_id']
+    assert_not_nil(actual_host = actual['hosts'].first)
+    assert_equal 'obfuscated_name', actual_host['fqdn']
+    assert_equal '1234', actual_host['account']
+    assert_equal 1, generator.hosts_count
+  end
+
+  test 'obfuscates fqdn when setting set' do
+    FactoryBot.create(:setting, :name => 'obfuscate_inventory_hostnames', :value => true)
+
+    batch = Host.where(id: @host.id).in_batches.first
+    generator = create_generator(batch)
+
+    json_str = generator.render
+    actual = JSON.parse(json_str.join("\n"))
+
+    obfuscated_fqdn = Base64.urlsafe_encode64(Digest::SHA1.digest(@host.fqdn), padding: false)
+
+    assert_equal 'slice_123', actual['report_slice_id']
+    assert_not_nil(actual_host = actual['hosts'].first)
+    assert_equal obfuscated_fqdn, actual_host['fqdn']
+    assert_equal '1234', actual_host['account']
+    assert_equal 1, generator.hosts_count
+  end
+
+  test 'does not obfuscate fqdn when insights-client sets to false' do
+    FactoryBot.create(:fact_value, fact_name: fact_names['insights_client::obfuscate_hostname_enabled'], value: 'false', host: @host)
+    FactoryBot.create(:fact_value, fact_name: fact_names['insights_client::hostname'], value: 'obfuscated_name', host: @host)
+
+    batch = Host.where(id: @host.id).in_batches.first
+    generator = create_generator(batch)
+
+    json_str = generator.render
+    actual = JSON.parse(json_str.join("\n"))
+
+    assert_equal 'slice_123', actual['report_slice_id']
+    assert_not_nil(actual_host = actual['hosts'].first)
+    assert_equal @host.fqdn, actual_host['fqdn']
+    assert_equal '1234', actual_host['account']
+    assert_equal 1, generator.hosts_count
+  end
+
   test 'generates a report with satellite facts' do
     Foreman.expects(:instance_id).twice.returns('satellite-id')
     batch = Host.where(id: @host.id).in_batches.first
@@ -260,6 +317,81 @@ class ReportGeneratorTest < ActiveSupport::TestCase
     assert_equal 'physical', actual_profile['infrastructure_type']
   end
 
+  test 'Identifies Amazon cloud provider' do
+    FactoryBot.create(:fact_value, fact_name: fact_names['dmi::bios::version'], value: 'Test Amazon version', host: @host)
+
+    batch = Host.where(id: @host.id).in_batches.first
+    generator = create_generator(batch)
+
+    json_str = generator.render
+    actual = JSON.parse(json_str.join("\n"))
+
+    assert_equal 'slice_123', actual['report_slice_id']
+    assert_not_nil(actual_host = actual['hosts'].first)
+    assert_not_nil(actual_profile = actual_host['system_profile'])
+    assert_equal 'aws', actual_profile['cloud_provider']
+  end
+
+  test 'Identifies Google cloud provider' do
+    FactoryBot.create(:fact_value, fact_name: fact_names['dmi::bios::version'], value: 'Test Google version', host: @host)
+
+    batch = Host.where(id: @host.id).in_batches.first
+    generator = create_generator(batch)
+
+    json_str = generator.render
+    actual = JSON.parse(json_str.join("\n"))
+
+    assert_equal 'slice_123', actual['report_slice_id']
+    assert_not_nil(actual_host = actual['hosts'].first)
+    assert_not_nil(actual_profile = actual_host['system_profile'])
+    assert_equal 'google', actual_profile['cloud_provider']
+  end
+
+  test 'Identifies Azure cloud provider' do
+    FactoryBot.create(:fact_value, fact_name: fact_names['dmi::chassis::asset_tag'], value: '7783-7084-3265-9085-8269-3286-77', host: @host)
+
+    batch = Host.where(id: @host.id).in_batches.first
+    generator = create_generator(batch)
+
+    json_str = generator.render
+    actual = JSON.parse(json_str.join("\n"))
+
+    assert_equal 'slice_123', actual['report_slice_id']
+    assert_not_nil(actual_host = actual['hosts'].first)
+    assert_not_nil(actual_profile = actual_host['system_profile'])
+    assert_equal 'azure', actual_profile['cloud_provider']
+  end
+
+  test 'Identifies Alibaba cloud provider via manufacturer' do
+    FactoryBot.create(:fact_value, fact_name: fact_names['dmi::system::manufacturer'], value: 'Test Alibaba Cloud version', host: @host)
+
+    batch = Host.where(id: @host.id).in_batches.first
+    generator = create_generator(batch)
+
+    json_str = generator.render
+    actual = JSON.parse(json_str.join("\n"))
+
+    assert_equal 'slice_123', actual['report_slice_id']
+    assert_not_nil(actual_host = actual['hosts'].first)
+    assert_not_nil(actual_profile = actual_host['system_profile'])
+    assert_equal 'alibaba', actual_profile['cloud_provider']
+  end
+
+  test 'Identifies Alibaba cloud provider via product name' do
+    FactoryBot.create(:fact_value, fact_name: fact_names['dmi::system::product_name'], value: 'Test Alibaba Cloud ECS product', host: @host)
+
+    batch = Host.where(id: @host.id).in_batches.first
+    generator = create_generator(batch)
+
+    json_str = generator.render
+    actual = JSON.parse(json_str.join("\n"))
+
+    assert_equal 'slice_123', actual['report_slice_id']
+    assert_not_nil(actual_host = actual['hosts'].first)
+    assert_not_nil(actual_profile = actual_host['system_profile'])
+    assert_equal 'alibaba', actual_profile['cloud_provider']
+  end
+
   private
 
   def create_generator(batch, name = 'slice_123')

data/webpack/ForemanInventoryUpload/Components/AccountList/AccountList.fixtures.js

@@ -1,6 +1,6 @@
 import { noop } from 'patternfly-react';
 
-export const API_SUCCESS_RESPONSE = {
+export const accounts = {
   Account1: {
     label: 'test_org1',
     upload_report_status: 'running',
@@ -18,7 +18,9 @@ export const API_SUCCESS_RESPONSE = {
   },
 };
 
-export const accounts = API_SUCCESS_RESPONSE;
+export const accountIDs = Object.keys(accounts);
+
+export const API_SUCCESS_RESPONSE = accounts;
 
 export const pollingProcessID = 0;
 
@@ -30,6 +32,8 @@ export const processStatusName = 'upload_report_status';
 
 export const autoUploadEnabled = true;
 
+export const filterTerm = 'some_filter';
+
 export const props = {
   accounts,
   fetchAccountsStatus: noop,

data/webpack/ForemanInventoryUpload/Components/AccountList/AccountList.js

@@ -4,6 +4,8 @@ import PropTypes from 'prop-types';
 import ListItem from './Components/ListItem';
 import EmptyState from './Components/EmptyState';
 import ErrorState from './Components/ErrorState';
+import EmptyResults from './Components/EmptyResults';
+import { filterAccounts } from './AccountListHelper';
 import './accountList.scss';
 
 class AccountList extends Component {
@@ -20,8 +22,9 @@ class AccountList extends Component {
   }
 
   render() {
-    const { accounts, error } = this.props;
+    const { accounts, error, filterTerm } = this.props;
     const accountIds = Object.keys(accounts);
+    const filteredAccountIds = filterAccounts(accounts, accountIds, filterTerm);
 
     if (error) {
       return <ErrorState error={error} />;
@@ -30,16 +33,14 @@ class AccountList extends Component {
     if (accountIds.length === 0) {
       return <EmptyState />;
     }
-    const items = accountIds.map((accountID, index) => {
+
+    if (filteredAccountIds.length === 0) {
+      return <EmptyResults />;
+    }
+
+    const items = filteredAccountIds.map((accountID, index) => {
       const account = accounts[accountID];
-      return (
-        <ListItem
-          key={index}
-          accountID={accountID}
-          account={account}
-          initExpanded={index === 0}
-        />
-      );
+      return <ListItem key={index} accountID={accountID} account={account} />;
     });
     return <ListView className="account_list">{items}</ListView>;
   }
@@ -56,6 +57,7 @@ AccountList.propTypes = {
   }),
   accounts: PropTypes.object,
   error: PropTypes.string,
+  filterTerm: PropTypes.string,
 };
 
 AccountList.defaultProps = {
@@ -69,6 +71,7 @@ AccountList.defaultProps = {
   },
   accounts: {},
   error: '',
+  filterTerm: null,
 };
 
 export default AccountList;