foreman_maintain 1.10.5 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0885ff686d1f9c5bb03c5cfa7f32e8da07cd5032dc0cd2f9631f716d8db688d7'
-  data.tar.gz: f07a9ea59b4dc4723a7e3f2a786269de44fe10d633b9add1b077ae8602d23545
+  metadata.gz: 0573bbda58a16e7632d6c074d5d99d4ddbace818cede03002efbc47ca9896f33
+  data.tar.gz: '009f7cf5f9fc5d2a7916041266c97dc76fbf44e1c6d670b368edcc0a4bf2c15c'
 SHA512:
-  metadata.gz: 70370ebf76c611e79113ad7068ee60907a674e130178635aa1c5c885618a56b765cce656d1efcedaf2f77b76d216a655758fdee85ba57287beb37eba86e09e2e
-  data.tar.gz: f6db48e5c475b4117d278f851217332d824bc0e6f052c46308780ad95984650f1eeea1a2b5874b170a0d0b592672f78dd9577d8453effc4f0207a4825212a73d
+  metadata.gz: 94f026030c038110b5d7fae4985313b3c00fb7e21e51bdd0026915ae017fb4bad826c72e8fa1797cfe78dc5dd89bcfe8d92d17ae25ffe288433e9a4cf278f79d
+  data.tar.gz: e7cc1350ad46e6d71a7651e83f9bbb4cdfb3db1eabe39691f84d102bb3ef12491db6920c682e364e8ed1e1db4e762fff2c6d4e11cb370a5b135ff820bc079c37

data/definitions/checks/system_registration.rb

@@ -10,11 +10,9 @@ class Checks::SystemRegistration < ForemanMaintain::Check
   end
 
   def run
-    assert(!rhsm_hostname_eql_hostname?, 'System is self registered',
-      {
-        :warn => true,
-        :next_steps => [Procedures::KnowledgeBaseArticle.new(:doc => 'self_registered')],
-      })
+    if rhsm_hostname_eql_hostname?
+      warn! 'System is self registered'
+    end
   end
 
   def rhsm_hostname

data/definitions/procedures/knowledge_base_article.rb

@@ -26,7 +26,6 @@ class Procedures::KnowledgeBaseArticle < ForemanMaintain::Procedure
       'fix_cpdb_validate_failure' => 'https://access.redhat.com/solutions/3362821',
       'fix_db_migrate_failure_on_duplicate_roles' => 'https://access.redhat.com/solutions/3998941',
       'many_fact_values' => 'https://access.redhat.com/solutions/4163891',
-      'self_registered' => 'https://access.redhat.com/solutions/3225941',
     }
   end
 end

data/definitions/reports/advisor_on_prem_remediations.rb

@@ -0,0 +1,33 @@
+module Reports
+  class AdvisorOnPremRemediations < ForemanMaintain::Report
+    metadata do
+      description 'Report number of remediations based on advisor rules from advisor on premise'
+    end
+
+    def run
+      data_field('advisor_on_prem_remediations_enabled') { advisor_on_prem_remediations_enabled }
+      data_field('advisor_on_prem_remediations_count') { advisor_on_prem_remediations_count }
+    end
+
+    def advisor_on_prem_remediations_enabled
+      if @iop_enabled.nil?
+        @iop_enabled = feature(:installer)&.answers&.dig(
+          'foreman::plugin::rh_cloud', 'enable_iop_advisor_engine'
+        ) || false
+      end
+      @iop_enabled
+    end
+
+    def advisor_on_prem_remediations_count
+      if advisor_on_prem_remediations_enabled
+        return sql_count('
+          job_invocations AS jobs
+          INNER JOIN remote_execution_features AS rexf ON jobs.remote_execution_feature_id = rexf.id
+          INNER JOIN template_invocations AS tinv ON jobs.id = tinv.job_invocation_id
+          WHERE rexf.label = \'rh_cloud_remediate_hosts\'
+          AND tinv.host_id IS NOT NULL
+        ')
+      end
+    end
+  end
+end

data/definitions/reports/alternate_content_sources.rb

@@ -0,0 +1,46 @@
+module Checks
+  module Report
+    class AlternateContentSources < ForemanMaintain::Report
+      metadata do
+        description 'Facts about ACSs'
+        confine do
+          feature(:katello)
+        end
+      end
+
+      def run
+        data_field('custom_alternate_content_sources_count') { custom_alternate_content_sources }
+        data_field('simplified_alternate_content_sources_count') do
+          simplified_alternate_content_sources
+        end
+        data_field('rhui_alternate_content_sources_count') { rhui_alternate_content_sources }
+        data_field('yum_alternate_content_sources_count') { yum_alternate_content_sources }
+        data_field('file_alternate_content_sources_count') { file_alternate_content_sources }
+      end
+
+      def custom_alternate_content_sources
+        sql_count(
+          "katello_alternate_content_sources WHERE alternate_content_source_type = 'custom'"
+        )
+      end
+
+      def simplified_alternate_content_sources
+        sql_count(
+          "katello_alternate_content_sources WHERE alternate_content_source_type = 'simplified'"
+        )
+      end
+
+      def rhui_alternate_content_sources
+        sql_count("katello_alternate_content_sources WHERE alternate_content_source_type = 'rhui'")
+      end
+
+      def yum_alternate_content_sources
+        sql_count("katello_alternate_content_sources WHERE content_type = 'yum'")
+      end
+
+      def file_alternate_content_sources
+        sql_count("katello_alternate_content_sources WHERE content_type = 'file'")
+      end
+    end
+  end
+end

data/definitions/reports/content.rb

@@ -0,0 +1,54 @@
+module Checks
+  module Report
+    class Content < ForemanMaintain::Report
+      metadata do
+        description 'Facts about Katello content'
+        confine do
+          feature(:katello)
+        end
+      end
+
+      def run
+        data_field('custom_library_yum_repositories_count') { custom_library_yum_repositories }
+        data_field('redhat_library_yum_repositories_count') { redhat_library_yum_repositories }
+        data_field('library_debian_repositories_count') { library_repositories('deb') }
+        data_field('library_container_repositories_count') { library_repositories('docker') }
+        data_field('library_file_repositories_count') { library_repositories('file') }
+        data_field('library_python_repositories_count') { library_repositories('python') }
+        data_field('library_ansible_collection_repositories_count') do
+          library_repositories('ansible_collection')
+        end
+        data_field('library_ostree_repositories_count') { library_repositories('ostree') }
+      end
+
+      def custom_library_yum_repositories
+        query_snippet =
+          <<-SQL
+            "katello_root_repositories"
+              WHERE "katello_root_repositories"."id" NOT IN
+              (SELECT "katello_root_repositories"."id" FROM "katello_root_repositories" INNER JOIN "katello_products"
+                ON "katello_products"."id" = "katello_root_repositories"."product_id" INNER JOIN "katello_providers"
+                ON "katello_providers"."id" = "katello_products"."provider_id" WHERE "katello_providers"."provider_type" = 'Red Hat')
+              AND "katello_root_repositories"."content_type" = 'yum'
+          SQL
+        sql_count(query_snippet)
+      end
+
+      def redhat_library_yum_repositories
+        query_snippet =
+          <<-SQL
+            "katello_root_repositories"
+              INNER JOIN "katello_products" ON "katello_products"."id" = "katello_root_repositories"."product_id"
+              INNER JOIN "katello_providers" ON "katello_providers"."id" = "katello_products"."provider_id"
+                WHERE "katello_providers"."provider_type" = 'Red Hat'
+              AND "katello_root_repositories"."content_type" = 'yum'
+          SQL
+        sql_count(query_snippet)
+      end
+
+      def library_repositories(content_type)
+        sql_count("katello_root_repositories WHERE content_type = '#{content_type}'")
+      end
+    end
+  end
+end

data/definitions/reports/image_mode_hosts.rb

@@ -0,0 +1,27 @@
+module Reports
+  class ImageModeHosts < ForemanMaintain::Report
+    metadata do
+      description 'Report number of image mode hosts registered by operating system'
+      confine do
+        feature(:katello)
+      end
+    end
+
+    def run
+      merge_data('image_mode_hosts_by_os_count') { image_mode_hosts_by_os_count }
+    end
+
+    # OS usage on image mode hosts
+    def image_mode_hosts_by_os_count
+      query(
+        <<-SQL
+          select max(operatingsystems.name) as os_name, count(*) as hosts_count
+          from hosts inner join operatingsystems on operatingsystem_id = operatingsystems.id inner join katello_content_facets on hosts.id = katello_content_facets.host_id
+          where bootc_booted_digest is not null
+          group by operatingsystems.name
+        SQL
+      ).
+        to_h { |row| [row['os_name'], row['hosts_count'].to_i] }
+    end
+  end
+end

data/definitions/reports/inventory.rb

@@ -10,6 +10,7 @@ module Reports
       merge_data('facts_by_type') { facts_by_type }
       merge_data('audits') { audits }
       merge_data('parameters_count') { parameters }
+      hosts_running_rhel_ai
     end
 
     # Hosts
@@ -80,5 +81,16 @@ module Reports
         max_created_at: row['max_created_at'],
       }
     end
+
+    def hosts_running_rhel_ai
+      query = <<~SQL
+        hosts
+        INNER JOIN katello_subscription_facets AS ksf ON hosts.id = ksf.host_id
+        INNER JOIN katello_subscription_facet_installed_products AS ksfip ON ksfip.subscription_facet_id = ksf.id
+        INNER JOIN katello_installed_products AS kip ON ksfip.installed_product_id = kip.id
+        WHERE kip.name = 'Red Hat Enterprise Linux AI'
+      SQL
+      data_field('rhel_ai_workload_host_count') { sql_count(query) }
+    end
   end
 end

data/definitions/reports/networking.rb

@@ -0,0 +1,78 @@
+require 'socket'
+
+module Reports
+  class Networking < ForemanMaintain::Report
+    metadata do
+      description 'Report information about networking'
+    end
+
+    def run
+      subnet_counts_by_type
+      hosts_by_address_family
+      interfaces_by_address_family
+      preference_settings
+    end
+
+    private
+
+    # How many ipv4 subnets are defined in Foreman?
+    # How many ipv6 subnets are defined in Foreman?
+    def subnet_counts_by_type
+      %w[Ipv4 Ipv6].each do |type|
+        data_field("subnet_#{type.downcase}_count") do
+          sql_count("subnets where type = 'Subnet::#{type}'")
+        end
+      end
+    end
+
+    # How many hosts in Foreman have an interface with an ipv4 address but no ipv6 address?
+    # How many hosts in Foreman have an interface with no ipv4 address but an ipv6 address?
+    # How many hosts in Foreman have an interface with both ipv4 and ipv6 addresses?
+    def hosts_by_address_family
+      { 'ipv4only': 'nics.ip IS NOT NULL AND nics.ip6 IS NULL',
+        'ipv6only': 'nics.ip IS NULL AND nics.ip6 IS NOT NULL',
+        'dualstack': 'nics.ip IS NOT NULL AND nics.ip6 IS NOT NULL' }.each do |kind, condition|
+        query = <<~SQL
+          hosts
+          WHERE id IN (SELECT host_id FROM nics WHERE #{condition})
+        SQL
+        data_field("hosts_with_#{kind}_interface_count") { sql_count(query) }
+      end
+    end
+
+    # How many of Foreman's interfaces:
+    # - only have a non-loopback, non-multicast ipv4 address?
+    # - only have a non-loopback, non-multicast, non-link-local ipv6 address?
+    # - have a non-loopback, non-multicast ipv4 address
+    #   as well as a non-loopback, non-multicast, non-link-local ipv6 address?
+    def interfaces_by_address_family
+      by_name = Socket.getifaddrs.group_by(&:name).transform_values { |addrs| addrs.map(&:addr) }
+      with_ipv4, without_ipv4 = by_name.partition { |_name, addrs| relevant_ipv4?(addrs) }
+      dualstack, ipv4_only = with_ipv4.partition { |_name, addrs| relevant_ipv6?(addrs) }
+      ipv6_only = without_ipv4.select { |_name, addrs| relevant_ipv6?(addrs) }
+
+      data_field("foreman_interfaces_ipv4only_count") { ipv4_only.count }
+      data_field("foreman_interfaces_ipv6only_count") { ipv6_only.count }
+      data_field("foreman_interfaces_dualstack_count") { dualstack.count }
+    end
+
+    def relevant_ipv4?(addrs)
+      addrs.any? { |addr| addr.ipv4? && !(addr.ipv4_loopback? || addr.ipv4_multicast?) }
+    end
+
+    def relevant_ipv6?(addrs)
+      addrs.any? do |addr|
+        addr.ipv6? && !(addr.ipv6_loopback? || addr.ipv6_multicast? || addr.ipv6_linklocal?)
+      end
+    end
+
+    def preference_settings
+      %w[remote_execution_connect_by_ip_prefer_ipv6 discovery_prefer_ipv6].each do |setting|
+        data_field("setting_#{setting}") do
+          value = sql_setting(setting)
+          value.nil? ? false : YAML.safe_load(value)
+        end
+      end
+    end
+  end
+end

data/definitions/reports/platform.rb

@@ -57,7 +57,7 @@ module Reports
 
     def settings_fields
       data_field('modified_settings') do
-        query("select name from settings").
+        query("select name from settings WHERE value IS NOT NULL").
           map { |setting_line| setting_line['name'] }.
           join(',')
       end

data/definitions/scenarios/foreman_upgrade.rb

@@ -116,7 +116,6 @@ module Scenarios::Foreman
       add_steps(
         Procedures::RefreshFeatures,
         Procedures::Service::Start,
-        Procedures::Pulpcore::RpmDatarepair,
         Procedures::Crond::Start,
         Procedures::SyncPlans::Enable,
         Procedures::MaintenanceMode::DisableMaintenanceMode

data/definitions/scenarios/satellite_upgrade.rb

@@ -120,7 +120,6 @@ module Scenarios::Satellite
       add_steps(
         Procedures::RefreshFeatures,
         Procedures::Service::Start,
-        Procedures::Pulpcore::RpmDatarepair,
         Procedures::Crond::Start,
         Procedures::SyncPlans::Enable,
         Procedures::MaintenanceMode::DisableMaintenanceMode,

data/lib/foreman_maintain/cli/base.rb

@@ -137,7 +137,7 @@ module ForemanMaintain
         option '--label', 'label',
           'Run only a specific check with a label. ' \
             '(Use "list" command to see available labels)' do |label|
-          raise ArgumentError, 'no value provided' if label.nil? || label.empty?
+          raise ArgumentError, 'value not specified' if label.nil? || label.empty?
           underscorize(label).to_sym
         end
       end
@@ -147,7 +147,7 @@ module ForemanMaintain
           'Run only those with all specific set of tags. ' \
             '(Use list-tags command to see available tags)',
           :multivalued => true) do |tags|
-          raise ArgumentError, 'no value provided' if tags.nil? || tags.empty?
+          raise ArgumentError, 'value not specified' if tags.nil? || tags.empty?
           tags.map { |tag| underscorize(tag).to_sym }
         end
       end
@@ -166,7 +166,7 @@ module ForemanMaintain
         if opts.include?('whitelist')
           option(['-w', '--whitelist'], 'whitelist',
             'Comma-separated list of labels of steps to be skipped') do |whitelist|
-            raise ArgumentError, 'no value provided' if whitelist.nil? || whitelist.empty?
+            raise ArgumentError, 'value not specified' if whitelist.nil? || whitelist.empty?
             whitelist.split(',').map(&:strip)
           end
         end

data/lib/foreman_maintain/version.rb

@@ -1,3 +1,3 @@
 module ForemanMaintain
-  VERSION = '1.10.5'.freeze
+  VERSION = '1.11.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreman_maintain
 version: !ruby/object:Gem::Version
-  version: 1.10.5
+  version: 1.11.0
 platform: ruby
 authors:
 - Ivan Nečas
@@ -55,16 +55,16 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest-reporters
   requirement: !ruby/object:Gem::Requirement
@@ -274,7 +274,6 @@ files:
 - definitions/procedures/packages/update.rb
 - definitions/procedures/packages/update_all_confirmation.rb
 - definitions/procedures/pulpcore/container_handle_image_metadata.rb
-- definitions/procedures/pulpcore/rpm_datarepair.rb
 - definitions/procedures/pulpcore/wait_for_tasks.rb
 - definitions/procedures/puppet/delete_empty_ca_cert_request_files.rb
 - definitions/procedures/puppet/remove_puppet.rb
@@ -307,13 +306,18 @@ files:
 - definitions/procedures/service/stop.rb
 - definitions/procedures/sync_plans/disable.rb
 - definitions/procedures/sync_plans/enable.rb
+- definitions/reports/advisor_on_prem_remediations.rb
+- definitions/reports/alternate_content_sources.rb
 - definitions/reports/compliance.rb
+- definitions/reports/content.rb
 - definitions/reports/external_auth_source.rb
 - definitions/reports/grouping.rb
+- definitions/reports/image_mode_hosts.rb
 - definitions/reports/instance.rb
 - definitions/reports/inventory.rb
 - definitions/reports/kerberos.rb
 - definitions/reports/ldap_auth_source.rb
+- definitions/reports/networking.rb
 - definitions/reports/oidc_usage.rb
 - definitions/reports/platform.rb
 - definitions/reports/provisioning.rb
@@ -447,7 +451,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Foreman maintenance tool belt
 test_files: []

data/definitions/procedures/pulpcore/rpm_datarepair.rb

@@ -1,17 +0,0 @@
-module Procedures::Pulpcore
-  class RpmDatarepair < ForemanMaintain::Procedure
-    include ForemanMaintain::Concerns::PulpCommon
-
-    metadata do
-      description 'Rename ContentArtifact relative_paths to match `{N-V-R.A.rpm}`'
-      for_feature :pulpcore
-    end
-
-    def run
-      with_spinner('Running pulpcore-manager rpm-datarepair 4073') do
-        # Assumption: services are already started
-        execute!(pulpcore_manager('rpm-datarepair 4073'))
-      end
-    end
-  end
-end