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 #37065 - report_row now explicitly accepts args and kwargs #10047

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 8 additions & 5 deletions app/services/foreman/renderer/scope/report.rb
Original file line number Diff line number Diff line change
Expand Up @@ -59,17 +59,20 @@ def report_headers(*headers)
The only argument it accepts is a record definition. This is typically called in some **each** loop. Calling
this at least once is important so we know what columns are to be rendered in this report.
Calling this macro adds a record to the rendering queue."
required :row_data, Hash, desc: 'Data in form of hash, keys are column names, values are values for this record'
optional :row_data, Hash, desc: 'Data in form of hash, keys are column names, values are values for this record', default: {}
kwlist :row_data_kw, desc: 'Data in form of key: value list, keys are column names, values are values for this record'
returns Array, desc: 'Currently registered report data'
example "report_row(:name => 'host1.example.com', :ip => '192.168.0.2')"
example "<%- load_hosts.each_record do |host|\n report_row(:name => host.name, :ip => host.ip)\nend -%>"
end
def report_row(row_data)
new_headers = row_data.keys
# accept either a hash or kwargs for compatibility with Ruby 2.7 & 3
def report_row(row_data = {}, **row_data_kws)
jeremylenz marked this conversation as resolved.
Show resolved Hide resolved
data = row_data_kws.transform_keys(&:to_s).merge(row_data.transform_keys(&:to_s))
new_headers = data.keys
if @report_headers.size < new_headers.size
@report_headers |= new_headers.map(&:to_s)
@report_headers |= new_headers
end
@report_data << row_data.values
@report_data << data.values
end

def apply_order!(order)
Expand Down
23 changes: 23 additions & 0 deletions test/unit/foreman/renderer/scope/report_test.rb
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,29 @@ class ReportScopeTest < ActiveSupport::TestCase
assert_equal expected_yaml, @scope.report_render(format: :yaml)
end

test 'report_row handles symbol keys with safemode merge' do
renderer = Foreman::Renderer::SafeModeRenderer
base_opts = { 'Fruit1' => 'Apple', 'Fruit2' => 'Banana' }

content = "<%= report_row({
:Name => 'Orange',
:Global => 'Pomegranate'
}.merge(@base_opts)) %>"
source = OpenStruct.new(
name: 'Test',
content: content
)
@scope = Foreman::Renderer::Scope::Report.new(
source: source,
variables: { base_opts: base_opts }
)
result = ""
assert_nothing_raised do
result = renderer.render(source, @scope)
end
assert_equal result, "[[\"Orange\", \"Pomegranate\", \"Apple\", \"Banana\"]]"
end

test 'render types' do
@scope.report_row(
'List': ['Val1', 1, true],
Expand Down