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 #37883 - halt if remote DB does not own EVR #984

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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions hooks/boot/01-kafo-hook-extensions.rb
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,50 @@ def log_and_say(level, message, do_say = true, do_log = true)
Kafo::KafoConfigure.logger.send(level, message) if do_log
end

def load_db_config(db)
case db
when 'foreman'
module_name = 'foreman'
user_param = 'username'
db_param = 'database'
param_prefix = 'db_'
when 'candlepin'
module_name = 'katello'
user_param = 'user'
db_param = 'name'
param_prefix = 'candlepin_db_'
when 'pulpcore'
module_name = 'foreman_proxy_content'
user_param = 'user'
db_param = 'db_name'
param_prefix = 'pulpcore_postgresql_'
else
raise "installer module unknown for db: #{db}"
end

{
host: param_value(module_name, "#{param_prefix}host") || 'localhost',
port: param_value(module_name, "#{param_prefix}port") || 5432,
database: param_value(module_name, "#{param_prefix}#{db_param}") || db,
username: param_value(module_name, "#{param_prefix}#{user_param}"),
password: param_value(module_name, "#{param_prefix}password"),
}
end

def pg_env(config)
{
'PGHOST' => config.fetch(:host, 'localhost'),
'PGPORT' => config.fetch(:port, '5432').to_s,
'PGUSER' => config[:username],
'PGPASSWORD' => config[:password],
'PGDATABASE' => config[:database],
}
end

def pg_sql_statement(statement)
"psql -t -c \"#{statement}\""
end

def execute!(command, do_say = true, do_log = true, extra_env = {})
stdout_stderr, status = execute_command(command, do_say, do_log, extra_env)

Expand Down
44 changes: 0 additions & 44 deletions hooks/pre/10-reset_data.rb
Original file line number Diff line number Diff line change
Expand Up @@ -10,36 +10,6 @@ def reset
reset_pulpcore if pulpcore_enabled?
end

def load_db_config(db)
case db
when 'foreman'
module_name = 'foreman'
user_param = 'username'
db_param = 'database'
param_prefix = 'db_'
when 'candlepin'
module_name = 'katello'
user_param = 'user'
db_param = 'name'
param_prefix = 'candlepin_db_'
when 'pulpcore'
module_name = 'foreman_proxy_content'
user_param = 'user'
db_param = 'db_name'
param_prefix = 'pulpcore_postgresql_'
else
raise "installer module unknown for db: #{db}"
end

{
host: param_value(module_name, "#{param_prefix}host") || 'localhost',
port: param_value(module_name, "#{param_prefix}port") || 5432,
database: param_value(module_name, "#{param_prefix}#{db_param}") || db,
username: param_value(module_name, "#{param_prefix}#{user_param}"),
password: param_value(module_name, "#{param_prefix}password"),
}
end

def empty_db_in_postgresql(db)
logger.notice "Dropping #{db} database!"

Expand All @@ -56,20 +26,6 @@ def reset_candlepin
empty_db_in_postgresql('candlepin')
end

def pg_env(config)
{
'PGHOST' => config.fetch(:host, 'localhost'),
'PGPORT' => config.fetch(:port, '5432').to_s,
'PGUSER' => config[:username],
'PGPASSWORD' => config[:password],
'PGDATABASE' => config[:database],
}
end

def pg_sql_statement(statement)
"psql -t -c \"#{statement}\""
end

# WARNING: deletes all the data owned by the user. No warnings. No confirmations.
def empty_database!(config)
delete_statement = 'DROP OWNED BY CURRENT_USER CASCADE;'
Expand Down
38 changes: 38 additions & 0 deletions hooks/pre_commit/42-evr_extension_permissions.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Managed databases will be handled automatically.
return if local_postgresql?
ianballou marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

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

You can't return outside of a function and it broke nightly pipelines

[2024-11-20T22:10:35.810Z]     /usr/share/foreman-installer/hooks/pre_commit/42-evr_extension_permissions.rb:2:in `block (4 levels) in load': unexpected return (LocalJumpError)
[2024-11-20T22:10:35.810Z]             from /usr/share/gems/gems/kafo-7.6.0/lib/kafo/hooking.rb:36:in `instance_eval'
[2024-11-20T22:10:35.810Z]             from /usr/share/gems/gems/kafo-7.6.0/lib/kafo/hooking.rb:36:in `block (4 levels) in load'
[2024-11-20T22:10:35.810Z]             from /usr/share/gems/gems/kafo-7.6.0/lib/kafo/hook_context.rb:19:in `instance_eval'
[2024-11-20T22:10:35.810Z]             from /usr/share/gems/gems/kafo-7.6.0/lib/kafo/hook_context.rb:19:in `execute'
[2024-11-20T22:10:35.810Z]             from /usr/share/gems/gems/kafo-7.6.0/lib/kafo/hooking.rb:67:in `block in execute'
[2024-11-20T22:10:35.810Z]             from /usr/share/gems/gems/kafo-7.6.0/lib/kafo/hooking.rb:65:in `each'
[2024-11-20T22:10:35.810Z]             from /usr/share/gems/gems/kafo-7.6.0/lib/kafo/hooking.rb:65:in `execute'
[2024-11-20T22:10:35.810Z]             from /usr/share/gems/gems/kafo-7.6.0/lib/kafo/kafo_configure.rb:219:in `execute'
[2024-11-20T22:10:35.810Z]             from /usr/share/gems/gems/clamp-1.3.2/lib/clamp/command.rb:66:in `run'
[2024-11-20T22:10:35.810Z]             from /usr/share/gems/gems/kafo-7.6.0/lib/kafo/kafo_configure.rb:184:in `run'
[2024-11-20T22:10:35.810Z]             from /usr/share/gems/gems/clamp-1.3.2/lib/clamp/command.rb:140:in `run'
[2024-11-20T22:10:35.810Z]             from /usr/share/gems/gems/kafo-7.6.0/lib/kafo/kafo_configure.rb:54:in `run'
[2024-11-20T22:10:35.810Z]             from /sbin/foreman-installer:8:in `<main>'

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Maybe this will solve it: #999

return unless katello_enabled?

config = load_db_config('foreman')

# If postgres is the owner of the DB, then the permissions will not matter.
return if config[:username] == 'postgres'

evr_existence_command = pg_sql_statement("SELECT 1 FROM pg_extension WHERE extname = 'evr';")
logger.debug "Checking if the evr extension exists via #{evr_existence_command}"
evr_existence_output, = execute_command(evr_existence_command, false, true, pg_env(config))

# If the evr extension does not exist, then we can skip this check.
return if evr_existence_output&.strip != '1'

check_evr_owner_sql = "SELECT CASE" \
" WHEN r.rolname = '#{config[:username]}' THEN 0" \
" ELSE 1" \
" END AS evr_owned_by_postgres" \
" FROM pg_extension e" \
" JOIN pg_roles r ON e.extowner = r.oid" \
" WHERE e.extname = 'evr';"

command = pg_sql_statement(check_evr_owner_sql)
logger.debug "Checking if the evr extension is owned by the postgres user via #{command}"
ianballou marked this conversation as resolved.
Show resolved Hide resolved
output, = execute_command(command, false, true, pg_env(config))

case output&.strip
when '0'
# The evr extension is owned by the foreman DB owner, so we can skip this check.
return
when '1'
fail_and_exit("The evr extension is not owned by the foreman DB owner. Please run the following command to fix it: " \
"UPDATE pg_extension SET extowner = (SELECT oid FROM pg_authid WHERE rolname='#{config[:username]}') WHERE extname='evr';")
else
fail_and_exit("Failed to check the ownership of the evr extension.")
end