foreman_discovery 21.0.5 → 22.0.4

data/test/migrations/20221102075151_migrate_discovery_hostname_and_fact_column_to_array_test.rb

@@ -0,0 +1,89 @@
+require_relative '../test_plugin_helper'
+require ForemanDiscovery::Engine.root.join('db/migrate/20221102075151_migrate_discovery_hostname_and_fact_column_to_array')
+
+class MigrateDiscoveryHostnameAndFactColumnToArrayTest < ActiveSupport::TestCase
+  let(:migrations_paths) { ActiveRecord::Migrator.migrations_paths + [ForemanDiscovery::Engine.root.join('db/migrate/').to_s] }
+
+  let(:previous_version) { '20221102065954'.to_i }
+  let(:current_version) { '20221102075151'.to_i }
+
+  #only load the two migrations we care about (previous one and current one)
+  let(:migrations) do
+    [
+      ActiveRecord::MigrationProxy.new("FixDiscoverySettingsCategoryToDsl", previous_version, "#{ForemanDiscovery::Engine.root}/db/migrate/20221102065954_fix_discovery_settings_category_to_dsl.rb", ""),
+      ActiveRecord::MigrationProxy.new("MigrateDiscoveryHostnameAndFactColumnToArray", current_version, "#{ForemanDiscovery::Engine.root}/db/migrate/20221102075151_migrate_discovery_hostname_and_fact_column_to_array.rb", "")
+    ]
+  end
+
+  def migrate_up
+    ActiveRecord::Migrator.new(:up, migrations, ActiveRecord::SchemaMigration, current_version).migrate
+  end
+
+  def setup
+    ActiveRecord::Migration.suppress_messages do
+      ActiveRecord::Migrator.new(:down, migrations, ActiveRecord::SchemaMigration, previous_version).migrate
+    end
+  end
+
+  def test_discovery_hostname_string
+    Setting['discovery_hostname'] = 'discovery_bootif'
+
+    migrate_up
+
+    assert_equal ['discovery_bootif'], Setting['discovery_hostname']
+  end
+
+  def test_discovery_hostname_multistring
+    setting = Setting.find_or_create_by(name: 'discovery_hostname')
+    setting.value = 'discovery_bootif, fqdn'
+    setting.save(validate: false)
+
+    migrate_up
+
+    assert_equal ['discovery_bootif', 'fqdn'], Setting['discovery_hostname']
+  end
+
+  def test_discovery_hostname_array
+    Setting['discovery_hostname'] = ['discovery_bootif']
+
+    migrate_up
+
+    assert_equal ['discovery_bootif'], Setting['discovery_hostname']
+  end
+
+  def test_discovery_fact_column_empty
+    setting = Setting.find_or_create_by(name: 'discovery_fact_column')
+    setting.value = ''
+    setting.save(validate: false)
+
+    migrate_up
+
+    assert_equal [], Setting['discovery_fact_column']
+  end
+
+  def test_discovery_fact_column_string
+    Setting['discovery_fact_column'] = 'bios_vendor'
+
+    migrate_up
+
+    assert_equal ['bios_vendor'], Setting['discovery_fact_column']
+  end
+
+  def test_discovery_fact_column_multistring
+    setting = Setting.find_or_create_by(name: 'discovery_fact_column')
+    setting.value = 'bios_vendor, fqdn'
+    setting.save(validate: false)
+
+    migrate_up
+
+    assert_equal ['bios_vendor', 'fqdn'], Setting['discovery_fact_column']
+  end
+
+  def test_discovery_fact_column_array
+    Setting['discovery_fact_column'] = ['bios_vendor']
+
+    migrate_up
+
+    assert_equal ['bios_vendor'], Setting['discovery_fact_column']
+  end
+end

data/{app/views/foreman_discovery → test/static_fixtures}/redhat_kexec.erb

@@ -1,6 +1,7 @@
 <%#
 kind: kexec
 name: Discovery Red Hat kexec
+model: ProvisioningTemplate
 oses:
 - CentOS 4
 - CentOS 5
@@ -20,11 +21,14 @@ description: |
   environments. The template must generate JSON format with the following items
   "kernel", "initram", "append" and "extra". The kexec command is composed in
   the following way:
-  
+
   kexec --force --debug --append=$append --initrd=$initram $extra $kernel
-  
+
   Please read kexec(8) man page for more information about semantics.
   Extra options like --reset-vga can be set via "extra" array.
+require:
+- plugin: foreman_discovery
+ version: 22.0.0
 -%>
 <%
   mac = @host.facts['discovery_bootif']
@@ -44,13 +48,13 @@ description: |
   extra << "--kexec-file-syscall" if @host.pxe_loader.include?('SecureBoot')
 -%>
 {
-  "kernel": "<%= @kernel_uri %>",
-  "initram": "<%= @initrd_uri %>",
+"kernel": "<%= @kernel_uri %>",
+"initram": "<%= @initrd_uri %>",
 <% if (@host.operatingsystem.name == 'Fedora' and @host.operatingsystem.major.to_i > 16) or
-    (@host.operatingsystem.name != 'Fedora' and @host.operatingsystem.major.to_i >= 7) -%>
+  (@host.operatingsystem.name != 'Fedora' and @host.operatingsystem.major.to_i >= 7) -%>
   "append": "inst.ks=<%= foreman_url('provision') + "&static=yes" %> inst.ks.sendmac <%= "ip=#{ip}::#{gw}:#{mask}:::none nameserver=#{dns} ksdevice=bootif BOOTIF=#{bootif} nomodeset nokaslr " + options.compact.join(' ') %>",
 <% else -%>
   "append": "inst.ks=<%= foreman_url('provision') + "&static=yes" %> kssendmac nicdelay=5 <%= "ip=#{ip} netmask=#{mask} gateway=#{gw} dns=#{dns} ksdevice=#{mac} BOOTIF=#{bootif} nomodeset nokaslr " + options.compact.join(' ') %>",
 <% end -%>
-  "extra": <%= extra %>
-}
+"extra": <%= extra %>
+}

data/test/test_helper_discovery.rb

@@ -53,7 +53,7 @@ end
 
 def set_default_settings
   Setting['discovery_fact'] = 'discovery_bootif'
-  Setting['discovery_hostname'] = 'discovery_bootif'
+  Setting['discovery_hostname'] = ['discovery_bootif']
   Setting['discovery_auto'] = true
   Setting['discovery_reboot'] = true
   Setting['discovery_organization'] = "Organization 1"

data/test/unit/discovery_attribute_set_test.rb

@@ -6,7 +6,7 @@ class DiscoveryAttributeSetTest < ActiveSupport::TestCase
 
   setup do
     @facts = parse_json_fixture('regular_host', true)
-    Setting['discovery_hostname'] = 'discovery_bootif'
+    Setting['discovery_hostname'] = ['discovery_bootif']
     Setting['discovery_prefix'] = 'mac'
     ::ForemanDiscovery::HostConverter.stubs(:unused_ip_for_host)
   end

data/test/unit/host_discovered_test.rb

@@ -181,7 +181,7 @@ class HostDiscoveredTest < ActiveSupport::TestCase
   end
 
   test "should create discovered host with hostname if a fact was supplied" do
-    Setting[:discovery_hostname] = 'somefact'
+    Setting[:discovery_hostname] = ['somefact']
     facts = @facts.merge({"somefact" => "somename"})
     host = discover_host_from_facts(facts)
     assert_equal 'macsomename', host.name
@@ -219,7 +219,7 @@ class HostDiscoveredTest < ActiveSupport::TestCase
 
   test "should create discovered host with fact_name as a name if it is a valid mac" do
     Setting[:discovery_fact] = 'somefact'
-    Setting[:discovery_hostname] = 'somefact'
+    Setting[:discovery_hostname] = ['somefact']
     facts = @facts.merge({"somefact" => "E4:1F:13:CC:36:5A"})
     host = discover_host_from_facts(facts)
     assert_equal 'mace41f13cc365a', host.name
@@ -277,7 +277,7 @@ class HostDiscoveredTest < ActiveSupport::TestCase
   end
 
   test "should raise when hostname fact cannot be found" do
-    Setting[:discovery_hostname] = 'macaddress_foo'
+    Setting[:discovery_hostname] = ['macaddress_foo']
     exception = assert_raises(::Foreman::Exception) do
       discover_host_from_facts(@facts)
     end
@@ -293,22 +293,18 @@ class HostDiscoveredTest < ActiveSupport::TestCase
     host1 = FactoryBot.create(:host, :type => "Host::Discovered", :organization => org1)
     host2 = FactoryBot.create(:host, :type => "Host::Discovered", :organization => org2)
     host3 = FactoryBot.create(:host, :type => "Host::Discovered", :organization => org3)
-    hosts = nil
 
     assert_nil Organization.current
-    as_user(user_subset) do
-      hosts = Host::Discovered.all
-    end
-    assert_includes hosts, host1
-    assert_includes hosts, host2
-    refute_includes hosts, host3
 
-    as_user(user_all) do
-      hosts = Host::Discovered.all
-    end
-    assert_includes hosts, host1
-    assert_includes hosts, host2
-    assert_includes hosts, host3
+    hosts = as_user(user_subset) { Host::Discovered.all }.map(&:name)
+    assert_includes hosts, host1.name
+    assert_includes hosts, host2.name
+    refute_includes hosts, host3.name
+
+    hosts = as_user(user_all) { Host::Discovered.all }.map(&:name)
+    assert_includes hosts, host1.name
+    assert_includes hosts, host2.name
+    assert_includes hosts, host3.name
   end
 
   test "provisioning a discovered host without saving it doesn't create a token" do

data/test/unit/managed_extensions_test.rb

@@ -1,4 +1,5 @@
 require_relative '../test_plugin_helper'
+require 'test_helper'
 
 class ManagedExtensionsTest < ActiveSupport::TestCase
   class StubHost < ApplicationRecord
@@ -10,7 +11,7 @@ class ManagedExtensionsTest < ActiveSupport::TestCase
     end
   end
 
-  let(:kexec_template) { FactoryBot.build(:provisioning_template, :template => File.read(File.expand_path(File.join("..", "..", "..", "app", "views", "foreman_discovery", "redhat_kexec.erb"), __FILE__))) }
+  let(:kexec_template) { FactoryBot.build(:provisioning_template, :template => File.read(File.expand_path(File.join("..", "..", "static_fixtures", "redhat_kexec.erb"), __FILE__))) }
 
   context "stubbed orchestration" do
     setup do

data/webpack/src/ForemanDiscovery/DiscoveredHosts/Components/EmptyState/EmptyState.js

@@ -12,7 +12,7 @@ const EmptyState = props => {
   };
   return (
     <ForemanEmptyState
-      header="Foreman Discovery"
+      header={__('Foreman Discovery')}
       description={description}
       icon="gears"
       iconType="fa"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreman_discovery
 version: !ruby/object:Gem::Version
-  version: 21.0.5
+  version: 22.0.4
 platform: ruby
 authors:
 - Aditi Puntambekar
@@ -76,7 +76,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-16 00:00:00.000000000 Z
+date: 2023-03-09 00:00:00.000000000 Z
 dependencies: []
 description: MaaS Discovery Plugin engine for Foreman
 email: gsutclif@redhat.com
@@ -109,7 +109,6 @@ files:
 - app/models/host/managed_extensions.rb
 - app/models/hostgroup_extensions.rb
 - app/models/nic/managed_extensions.rb
-- app/models/setting/discovered.rb
 - app/services/discovery_fact_importer.rb
 - app/services/foreman_discovery/fact_parser.rb
 - app/services/foreman_discovery/fact_to_category_resolver.rb
@@ -166,8 +165,6 @@ files:
 - app/views/discovery_rules/index.html.erb
 - app/views/discovery_rules/new.html.erb
 - app/views/discovery_rules/welcome.html.erb
-- app/views/foreman_discovery/debian_kexec.erb
-- app/views/foreman_discovery/redhat_kexec.erb
 - config/as_deprecation_whitelist.yaml
 - config/initializers/discovery_setup.rb
 - config/routes.rb
@@ -192,7 +189,7 @@ files:
 - db/migrate/20171222120314_add_constraints_on_discovery_rules_hostgroups.rb
 - db/migrate/20180412124505_add_priority_score_to_discovery_rules.rb
 - db/migrate/20221102065954_fix_discovery_settings_category_to_dsl.rb
-- db/seeds.d/50_discovery_templates.rb
+- db/migrate/20221102075151_migrate_discovery_hostname_and_fact_column_to_array.rb
 - db/seeds.d/60_discovery_proxy_feature.rb
 - db/seeds.d/70_discovery_mail_notification.rb
 - db/seeds.d/80_discovery_ui_notification.rb
@@ -222,6 +219,8 @@ files:
 - locale/it/foreman_discovery.po
 - locale/ja/LC_MESSAGES/foreman_discovery.mo
 - locale/ja/foreman_discovery.po
+- locale/ka/LC_MESSAGES/foreman_discovery.mo
+- locale/ka/foreman_discovery.po
 - locale/ko/LC_MESSAGES/foreman_discovery.mo
 - locale/ko/foreman_discovery.po
 - locale/pt_BR/LC_MESSAGES/foreman_discovery.mo
@@ -260,6 +259,8 @@ files:
 - test/functional/discovery_rules_controller_test.rb
 - test/functional/foreman_discovery/concerns/hosts_controller_extensions_test.rb
 - test/integration/discovered_hosts_test.rb
+- test/migrations/20221102075151_migrate_discovery_hostname_and_fact_column_to_array_test.rb
+- test/static_fixtures/redhat_kexec.erb
 - test/test_helper_discovery.rb
 - test/test_plugin_helper.rb
 - test/unit/discovered_extensions_test.rb
@@ -319,7 +320,6 @@ summary: MaaS Discovery Plugin for Foreman
 test_files:
 - test/unit/discovered_extensions_test.rb
 - test/unit/discovered_mailer_test.rb
-- test/unit/discovery_attribute_set_test.rb
 - test/unit/discovery_rule_test.rb
 - test/unit/discovery_taxonomy_extensions_test.rb
 - test/unit/fact_parser_test.rb
@@ -327,6 +327,7 @@ test_files:
 - test/unit/lldp_neighbors_test.rb
 - test/unit/ui_notifications/destroy_host_test.rb
 - test/unit/ui_notifications/new_host_test.rb
+- test/unit/discovery_attribute_set_test.rb
 - test/unit/host_discovered_test.rb
 - test/unit/managed_extensions_test.rb
 - test/factories/discovery_host_related.rb
@@ -354,5 +355,7 @@ test_files:
 - test/functional/foreman_discovery/concerns/hosts_controller_extensions_test.rb
 - test/functional/discovered_hosts_controller_test.rb
 - test/integration/discovered_hosts_test.rb
-- test/test_helper_discovery.rb
 - test/test_plugin_helper.rb
+- test/migrations/20221102075151_migrate_discovery_hostname_and_fact_column_to_array_test.rb
+- test/static_fixtures/redhat_kexec.erb
+- test/test_helper_discovery.rb

data/app/models/setting/discovered.rb

@@ -1,22 +0,0 @@
-class Setting::Discovered
-  def self.discovery_fact_column_array
-    from_array(Setting['discovery_fact_column'])
-  end
-
-  def self.discovery_hostname_fact_array
-    return [] if !Setting['discovery_hostname'].present?
-    from_array Setting['discovery_hostname']
-  end
-
-  def self.discovery_lock?
-    Foreman::Cast.to_bool(Setting['discovery_lock'])
-  end
-
-  def self.from_array(setting)
-    return [] unless setting.present?
-    setting.to_s.split(",").map(&:strip)
-  rescue Exception => e
-    logger.warn "Failed to parse discovery_fact_column, ignoring: #{e}"
-    []
-  end
-end

data/app/views/foreman_discovery/debian_kexec.erb

@@ -1,41 +0,0 @@
-<%#
-kind: kexec
-name: Discovery Debian kexec
-oses:
-- Debian
-- Ubuntu
-description: |
-  This template is used to pass command line options to kexec when reloading
-  kernel on a discovered host instead of rebooting. This is useful in PXE-less
-  environments. The template must generate JSON format with the following items
-  "kernel", "initram", "append" and "extra". The kexec command is composed in
-  the following way:
-  
-  kexec --force --debug --append=$append --initrd=$initram $extra $kernel
-  
-  Please read kexec(8) man page for more information about semantics.
-  Extra options like --reset-vga can be set via "extra" array.
--%>
-<%
-  mac = @host.facts['discovery_bootif']
-  bootif = host_param("hardware_type", "01") + '-' + mac.gsub(':', '-') if mac
-  ip_cidr = @host.facts['discovery_ip_cidr']
-  ip = @host.facts['discovery_ip']
-  mask = @host.facts['discovery_netmask']
-  gw = @host.facts['discovery_gateway']
-  dns = @host.facts['discovery_dns']
-  options = ["nomodeset", "nokaslr", "auto=true"]
-  options << @host.facts['append']
-  options << "domain=#{@host.domain}"
-  options << 'console-setup/ask_detect=false console-setup/layout=USA console-setup/variant=USA keyboard-configuration/layoutcode=us localechooser/translation/warn-light=true localechooser/translation/warn-severe=true'
-  options << "locale=#{host_param('lang') || 'en_US'}"
-  options << "inst.stage2=#{@host.operatingsystem.medium_uri(@host)}" if @host.operatingsystem.name.match(/Atomic/i)
-  extra = []
-  extra << "--kexec-file-syscall" if @host.pxe_loader.include?('SecureBoot')
--%>
-{
-  "kernel": "<%= @kernel_uri %>",
-  "initram": "<%= @initrd_uri %>",
-  "append": "url=<%= foreman_url('provision') + "&static=yes" %> interface=<%= mac %> netcfg/get_ipaddress=<%= ip %> netcfg/get_netmask=<%= mask %> netcfg/get_gateway=<%= gw %> netcfg/get_nameservers=<%= dns %> netcfg/disable_dhcp=true netcfg/get_hostname=<%= @host.name %> BOOTIF=<%= bootif %> <%= options.compact.join(' ') %>",
-  "extra": <%= extra %>
-}

data/db/seeds.d/50_discovery_templates.rb

@@ -1,31 +0,0 @@
-organizations = Organization.unscoped.all
-locations = Location.unscoped.all
-
-kind = TemplateKind.unscoped.find_or_create_by(name: 'kexec')
-kind.description = N_("Command line options for kexec during PXE-less provisioning.")
-kind.save!
-
-ProvisioningTemplate.without_auditing do
-  [['redhat_kexec.erb', 'Red Hat'], ['debian_kexec.erb', 'Debian']].each do |tmpl_names|
-    content = File.read(File.join(ForemanDiscovery::Engine.root, 'app', 'views', 'foreman_discovery', tmpl_names[0]))
-    tmpl = ProvisioningTemplate.unscoped.where(:name => "Discovery #{tmpl_names[1]} kexec").first_or_create(
-      :template_kind_id => kind.id,
-      :snippet => false,
-      :template => content
-    )
-    tmpl.attributes = {
-      :template => content,
-      :default  => true,
-      :vendor   => "Foreman Discovery",
-      :locked   => true
-    }
-    tmpl.template = content
-    tmpl.organizations = organizations
-    tmpl.locations = locations
-
-    metadata = Template.parse_metadata(content)
-    tmpl.description = metadata['description']
-
-    tmpl.save!(:validate => false) if tmpl.changes.present?
-  end
-end