Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixes #36626 - safe checks for the pxe_loader #9785

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions app/models/concerns/pxe_loader_suggestion.rb
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
module PxeLoaderSuggestion
extend ActiveSupport::Concern
def suggest_default_pxe_loader
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This method doesn't guarantee that self.pxe_loader is set to a string. Was that the intention?

I think this now also no longer returns self.pxe_loader at all, unless it is set via the preferred_loader. It doesn't look like that's used so perhaps the API should be formalized to always return nil?

Another difference is that if the user set the pxe-loader parameter to the empty string it will now ignore it and use the preferred loader. I'm not sure if that's common or even valid, but certainly a difference.

Copy link
Contributor Author

@stejskalleos stejskalleos Aug 7, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This method doesn't guarantee that self.pxe_loader is set to a string. Was that the intention?

Nope, fixed and added test.

Another difference is that if the user set the pxe-loader parameter to the empty string it will now ignore it and use the preferred loader.

Good point, but how many CUs (if any) did it, hard to say ...

self.pxe_loader ||= try(:operatingsystem).try(:parameters).try(:find_by_name, "pxe-loader").try(:value)
self.pxe_loader ||= try(:operatingsystem).try(:preferred_loader) if respond_to?(:pxe_loader)
stejskalleos marked this conversation as resolved.
Show resolved Hide resolved
return if pxe_loader.presence

from_os_params = try(:operatingsystem).try(:parameters).try(:find_by_name, "pxe-loader")
self.pxe_loader = from_os_params.try(:value)
return if pxe_loader.presence

self.pxe_loader = try(:operatingsystem).try(:preferred_loader).presence || ''
end
end
4 changes: 3 additions & 1 deletion app/models/concerns/pxe_loader_support.rb
Original file line number Diff line number Diff line change
Expand Up @@ -70,9 +70,11 @@ def pxe_loader_kind(host)
# Suggested PXE loader when template kind is available (PXEGrub2, then PXELinux, then PXEGrub in this order)
def preferred_loader
associated_templates = os_default_templates.map(&:template_kind).compact.map(&:name)

template_kinds.each do |loader|
return PREFERRED_KINDS[loader] if associated_templates.include? loader
end
nil

''
end
end
3 changes: 2 additions & 1 deletion app/models/host/managed.rb
Original file line number Diff line number Diff line change
Expand Up @@ -729,8 +729,9 @@ def explicit_pxe_loader
self[:pxe_loader].presence
end

# @return [String] The name of the PXE loader to be used or empty string if none
def pxe_loader
stejskalleos marked this conversation as resolved.
Show resolved Hide resolved
explicit_pxe_loader || hostgroup.try(:pxe_loader)
explicit_pxe_loader || hostgroup.try(:pxe_loader) || ''
end

def pxe_loader_efi?
Expand Down
2 changes: 1 addition & 1 deletion app/views/common/os_selection/_pxe_loader.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
%>
<%= selectable_f f, :pxe_loader,
loaders.to_a, {
:include_blank => pxe_loader_selected,
:include_blank => false,
:selected => pxe_loader_selected == true ? f.object.pxe_loader : pxe_loader_selected
},
:label => _('PXE loader'),
Expand Down
17 changes: 15 additions & 2 deletions test/models/concerns/pxe_loader_suggestion_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ def setup

test 'host does not suggest PXEloader when OS is not set' do
@host.suggest_default_pxe_loader
assert_nil @host.pxe_loader
assert_empty @host.pxe_loader
end

test 'host suggests default PXEloader for OS' do
Expand Down Expand Up @@ -56,7 +56,7 @@ def setup

test 'hostgroup does not suggest PXEloader when OS is not set' do
@hostgroup.suggest_default_pxe_loader
assert_nil @hostgroup.pxe_loader
assert_empty @hostgroup.pxe_loader
end

test 'hostgroup suggests default PXEloader for OS' do
Expand All @@ -72,4 +72,17 @@ def setup
assert_equal 'PXELinux UEFI', @hostgroup.pxe_loader
end
end

context 'validations' do
def setup
@os = FactoryBot.create(:operatingsystem)
@host = FactoryBot.create(:host, operatingsystem: @os)
Operatingsystem.any_instance.stubs(:preferred_loader).returns('')
end

test 'always returns string' do
@os.os_parameters.create!(:name => 'pxe-loader', :value => '')
assert_empty @host.pxe_loader
end
end
end
6 changes: 3 additions & 3 deletions test/models/concerns/pxe_loader_support_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -139,18 +139,18 @@ def setup
test "is none for zero template kinds and templates" do
@subject.expects(:template_kinds).returns([])
@subject.expects(:os_default_templates).returns([])
assert_nil @subject.preferred_loader
assert_empty @subject.preferred_loader
end

test "is none for zero templates" do
@subject.expects(:os_default_templates).returns([])
assert_nil @subject.preferred_loader
assert_empty @subject.preferred_loader
end

test "is none for zero template kinds" do
@subject.expects(:template_kinds).returns([])
@subject.expects(:os_default_templates).returns([@template_pxelinux, @template_pxegrub, @template_pxegrub2])
assert_nil @subject.preferred_loader
assert_empty @subject.preferred_loader
end

test "is PXELinux for all associated template kinds" do
Expand Down
4 changes: 2 additions & 2 deletions test/models/operatingsystem_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -258,11 +258,11 @@ class OperatingsystemTest < ActiveSupport::TestCase
end

test "should not have preferred pxe loader for an OS without architecture associated" do
assert_nil Operatingsystem.new.preferred_loader
assert_empty Operatingsystem.new.preferred_loader
end

test "should have preferred pxe loader for an Solaris OS without any templates" do
assert_nil Solaris.new.preferred_loader
assert_empty Solaris.new.preferred_loader
end

test "should have preferred pxe loader for OS with PXELinux template" do
Expand Down