Project

General

Profile

Download (25.9 KB) Statistics
| Branch: | Tag: | Revision:
module HammerCLICsv
class CsvCommand
class ContentHostsCommand < BaseCommand
include ::HammerCLIForemanTasks::Helper
include ::HammerCLICsv::Utils::Subscriptions

command_name 'content-hosts'
desc 'import or export content hosts'

def self.supported?
true
end

option %w(--itemized-subscriptions), :flag, _('Export one subscription per row, only process update subscriptions on import')
option %w(--clear-subscriptions), :flag, _('When processing --itemized-subscriptions, clear existing subscriptions first')
option %w(--columns), 'COLUMN_NAMES', _('Comma separated list of column names to export')

SEARCH = 'Search'
ORGANIZATION = 'Organization'
ENVIRONMENT = 'Environment'
CONTENTVIEW = 'Content View'
HOSTCOLLECTIONS = 'Host Collections'
VIRTUAL = 'Virtual'
HOST = 'Host' # deprecated for GUESTOF
GUESTOF = 'Guest of Host'
OPERATINGSYSTEM = 'OS'
ARCHITECTURE = 'Arch'
SOCKETS = 'Sockets'
RAM = 'RAM'
CORES = 'Cores'
SLA = 'SLA'
PRODUCTS = 'Products'

def self.help_columns
['', _('Columns:'),
_(" %{name} - Name of resource") % {:name => NAME},
_(" %{name} - Search for matching names during import (overrides '%{name_col}' column)") % {:name => SEARCH, :name_col => NAME},
_(" %{name} - Organization name") % {:name => ORGANIZATION},
_(" %{name} - Lifecycle environment name") % {:name => ENVIRONMENT},
_(" %{name} - Content view name") % {:name => CONTENTVIEW},
_(" %{name} - Comma separated list of host collection names") % {:name => HOSTCOLLECTIONS},
_(" %{name} - Is a virtual host, %{yes} or %{no}") % {:name => VIRTUAL, :yes => 'Yes', :no => 'No'},
_(" %{name} - Hypervisor host name for virtual hosts") % {:name => GUESTOF},
_(" %{name} - Operating system") % {:name => OPERATINGSYSTEM},
_(" %{name} - Architecture") % {:name => ARCHITECTURE},
_(" %{name} - Number of sockets") % {:name => SOCKETS},
_(" %{name} - Quantity of RAM in bytes") % {:name => RAM},
_(" %{name} - Number of cores") % {:name => CORES},
_(" %{name} - Service Level Agreement value") % {:name => SLA},
_(" %{name} - Comma separated list of products, each of the format \"<sku>|<name>\"") % {:name => PRODUCTS},
_(" %{name} - Comma separated list of subscriptions, each of the format \"<quantity>|<sku>|<name>|<contract>|<account>\"") % {:name => SUBSCRIPTIONS},
_(" %{name} - Subscription name (only applicable for --itemized-subscriptions)") % {:name => SUBS_NAME},
_(" %{name} - Subscription type (only applicable for --itemized-subscriptions)") % {:name => SUBS_TYPE},
_(" %{name} - Subscription quantity (only applicable for --itemized-subscriptions)") % {:name => SUBS_QUANTITY},
_(" %{name} - Subscription SKU (only applicable for --itemized-subscriptions)") % {:name => SUBS_SKU},
_(" %{name} - Subscription contract number (only applicable for --itemized-subscriptions)") % {:name => SUBS_CONTRACT},
_(" %{name} - Subscription account number (only applicable for --itemized-subscriptions)") % {:name => SUBS_ACCOUNT},
_(" %{name} - Subscription start date (only applicable for --itemized-subscriptions)") % {:name => SUBS_START},
_(" %{name} - Subscription end date (only applicable for --itemized-subscriptions)") % {:name => SUBS_END}
].join("\n")
end

def column_headers
@column_values = {}
if option_columns.nil?
if ::HammerCLI::Settings.settings[:csv][:columns] &&
::HammerCLI::Settings.settings[:csv][:columns]['content-hosts'.to_sym] &&
::HammerCLI::Settings.settings[:csv][:columns]['content-hosts'.to_sym][:export]
@columns = ::HammerCLI::Settings.settings[:csv][:columns]['content-hosts'.to_sym][:export]
else
if option_itemized_subscriptions?
@columns = shared_headers + [SUBS_NAME, SUBS_TYPE, SUBS_QUANTITY, SUBS_SKU,
SUBS_CONTRACT, SUBS_ACCOUNT, SUBS_START, SUBS_END, SUBS_GUESTOF]
else
@columns = shared_headers + [SUBSCRIPTIONS]
end
end
else
@columns = option_columns.split(',')
end

if ::HammerCLI::Settings.settings[:csv][:columns] && ::HammerCLI::Settings.settings[:csv][:columns]['content-hosts'.to_sym][:define]
@column_definitions = ::HammerCLI::Settings.settings[:csv][:columns]['content-hosts'.to_sym][:define]
end

@columns
end

def export(csv)
raise _("--clear-subscriptions option only relevant during import") if option_clear_subscriptions?

if option_itemized_subscriptions?
export_itemized_subscriptions csv
else
export_all csv
end
end

def export_itemized_subscriptions(csv)
csv << column_headers
iterate_hosts(csv) do |host|
shared_columns(host)
custom_columns(host)
if host['subscription_facet_attributes']
subscriptions = @api.resource(:host_subscriptions).call(:index, {
'organization_id' => host['organization_id'],
'host_id' => host['id'],
'full_results' => true
})['results']
if subscriptions.empty?
%W(#{SUBS_NAME} #{SUBS_TYPE} #{SUBS_QUANTITY} #{SUBS_SKU} #{SUBS_CONTRACT}
#{SUBS_ACCOUNT} #{SUBS_START} #{SUBS_END} #{SUBS_GUESTOF}).each do |entry|
@column_values[entry] = nil
end
columns_to_csv(csv)
else
subscriptions.each do |subscription|
%W(#{SUBS_NAME} #{SUBS_TYPE} #{SUBS_QUANTITY} #{SUBS_SKU} #{SUBS_CONTRACT}
#{SUBS_ACCOUNT} #{SUBS_START} #{SUBS_END} #{SUBS_GUESTOF}).each do |entry|
@column_values[entry] = nil
end
@column_values[SUBS_GUESTOF] = subscription['host']['name'] if subscription['host']
subscription_type = subscription['product_id'].to_i == 0 ? 'Red Hat' : 'Custom'
subscription_type += ' Guest' unless @column_values[SUBS_GUESTOF].nil?
subscription_type += ' Temporary' if subscription['type'] == 'UNMAPPED_GUEST'
@column_values[SUBS_NAME] = subscription['product_name']
@column_values[SUBS_TYPE] = subscription_type
@column_values[SUBS_QUANTITY] = subscription['quantity_consumed']
@column_values[SUBS_SKU] = subscription['product_id']
@column_values[SUBS_CONTRACT] = subscription['contract_number']
@column_values[SUBS_ACCOUNT] = subscription['account_number']
@column_values[SUBS_START] = DateTime.parse(subscription['start_date']).strftime('%m/%d/%Y')
@column_values[SUBS_END] = DateTime.parse(subscription['end_date']).strftime('%m/%d/%Y')
columns_to_csv(csv)
end
end
else
columns_to_csv(csv)
end
end
end

def export_all(csv)
csv << column_headers
iterate_hosts(csv) do |host|
all_subscription_column(host)
shared_columns(host)
custom_columns(host)
columns_to_csv(csv)
end
end

def import
raise _("--columns option only relevant with --export") unless option_columns.nil?

@existing = {}
@visited = {}
@hypervisor_guests = {}
@all_subscriptions = {}

thread_import do |line|
create_from_csv(line)
end

if !@hypervisor_guests.empty?
print(_('Updating hypervisor and guest associations...')) if option_verbose?
@hypervisor_guests.each do |host_id, guest_ids|
@api.resource(:hosts).call(:update, {
'id' => host_id,
'host' => {
'subscription_facet_attributes' => {
'autoheal' => false,
'hypervisor_guest_uuids' => guest_ids
}
}
})
end
puts _('done') if option_verbose?
end
end

def create_from_csv(line)
return if option_organization && line[ORGANIZATION] != option_organization

update_existing(line)

count(line[COUNT]).times do |number|
if !line[SEARCH].nil? && !line[SEARCH].empty?
search = namify(line[SEARCH], number)
@api.resource(:hosts).call(:index, {
'organization_id' => foreman_organization(:name => line[ORGANIZATION]),
'search' => search,
'per_page' => 999999
})['results'].each do |host|
if host['subscription_facet_attributes']
create_named_from_csv(host['name'], line)
end
end
else
name = namify(line[NAME], number)
create_named_from_csv(name, line)
end
end
end

private

def create_named_from_csv(name, line)
if option_itemized_subscriptions?
update_itemized_subscriptions(name, line)
else
update_or_create(name, line)
end
end

def update_itemized_subscriptions(name, line)
raise _("Content host '%{name}' must already exist with --itemized-subscriptions") % {:name => name} unless @existing.include? name

print(_("Updating subscriptions for content host '%{name}'...") % {:name => name}) if option_verbose?
host = @api.resource(:hosts).call(:show, {:id => @existing[name]})
remove_existing = clear_subscriptions?(host['name'])
update_subscriptions(host, line, remove_existing)
puts _('done') if option_verbose?
end

def update_or_create(name, line)
lifecycle_environment_id = lifecycle_environment(line[ORGANIZATION], :name => line[ENVIRONMENT])
content_view_id = katello_contentview(line[ORGANIZATION], :name => line[CONTENTVIEW])
if !@existing.include? name
print(_("Creating content host '%{name}'...") % {:name => name}) if option_verbose?
params = {
'name' => name,
'facts' => facts(name, line),
'lifecycle_environment_id' => lifecycle_environment_id,
'content_view_id' => content_view_id
}
params['installed_products'] = products(line) if line[PRODUCTS]
params['service_level'] = line[SLA] if line[SLA]
host = @api.resource(:host_subscriptions).call(:create, params)
@existing[name] = host['id']
else
print(_("Updating content host '%{name}'...") % {:name => name}) if option_verbose?
params = {
'id' => @existing[name],
'host' => {
'content_facet_attributes' => {
'lifecycle_environment_id' => lifecycle_environment_id,
'content_view_id' => content_view_id
},
'subscription_facet_attributes' => {
'installed_products' => products(line),
'service_level' => line[SLA],
'autoheal' => true
}
}
}
host = @api.resource(:hosts).call(:update, params)
end

hypervisor = hypervisor_from_line(line)
if line[VIRTUAL] == 'Yes' && hypervisor
raise "Content host '#{hypervisor}' not found" if !@existing[hypervisor]
@hypervisor_guests[@existing[hypervisor]] ||= []
@hypervisor_guests[@existing[hypervisor]] << "#{line[ORGANIZATION]}/#{name}"
end

update_facts(host, line)
update_host_collections(host, line)
update_subscriptions(host, line, true)

puts _('done') if option_verbose?
end

def facts(name, line, facts = {})
facts['system.certificate_version'] ||= '3.2' # Required for auto-attach to work
facts['network.hostname'] = name
facts['cpu.core(s)_per_socket'] = line[CORES] if !line[CORES].nil? && !line[CORES].empty?
facts['cpu.cpu_socket(s)'] = line[SOCKETS] if !line[SOCKETS].nil? && !line[SOCKETS].empty?
facts['memory.memtotal'] = line[RAM] if !line[RAM].nil? && !line[RAM].empty?
facts['uname.machine'] = line[ARCHITECTURE] if !line[ARCHITECTURE].nil? && !line[ARCHITECTURE].empty?
(facts['distribution.name'], facts['distribution.version']) = os_name_version(line[OPERATINGSYSTEM]) if !line[OPERATINGSYSTEM].nil? && !line[OPERATINGSYSTEM].empty?
if !line[VIRTUAL].nil? && !line[VIRTUAL].empty?
facts['virt.is_guest'] = line[VIRTUAL] == 'Yes' ? true : false
facts['virt.uuid'] = "#{line[ORGANIZATION]}/#{name}" if facts['virt.uuid'].nil? && facts['virt.is_guest']
end
facts['cpu.cpu(s)'] ||= 1
facts
end

def update_facts(host, line)
return if host['subscription_facet_attributes'].nil?

url = "#{@server}/rhsm/consumers/#{host['subscription_facet_attributes']['uuid']}"
uri = URI(url)
nethttp = Net::HTTP.new(uri.host, uri.port)
nethttp.use_ssl = uri.scheme == 'https'
nethttp.verify_mode = OpenSSL::SSL::VERIFY_NONE
nethttp.start do |http|
request = Net::HTTP::Get.new(uri.request_uri)
request = authenticate_request(request)
response = http.request(request)
results = JSON.parse(response.body)

facts = facts(host['name'], line, results['facts'])

request = Net::HTTP::Put.new(uri.request_uri, {'Content-Type' => 'application/json'})
request = authenticate_request(request)
request.body = {:facts => facts}.to_json
response = http.request(request)
JSON.parse(response.body)
end

end

def update_host_collections(host, line)
# TODO: http://projects.theforeman.org/issues/16234
# return nil if line[HOSTCOLLECTIONS].nil? || line[HOSTCOLLECTIONS].empty?
# CSV.parse_line(line[HOSTCOLLECTIONS]).each do |hostcollection_name|
# @api.resource(:host_collections).call(:add_hosts, {
# 'id' => katello_hostcollection(line[ORGANIZATION], :name => hostcollection_name),
# 'host_ids' => [host['id']]
# })
# end
end

def os_name_version(operatingsystem)
if operatingsystem.nil?
name = nil
version = nil
elsif operatingsystem.index(' ')
(name, version) = operatingsystem.split(' ')
else
(name, version) = ['RHEL', operatingsystem]
end
[name, version]
end

def products(line)
return if line[PRODUCTS].nil? || line[PRODUCTS].empty?
CSV.parse_line(line[PRODUCTS]).collect do |product_details|
product = {}
(product['product_id'], product['product_name']) = product_details.split('|')
product['arch'] = line[ARCHITECTURE]
product['version'] = os_name_version(line[OPERATINGSYSTEM])[1]
product
end
end

def update_subscriptions(host, line, remove_existing)
existing_subscriptions = @api.resource(:host_subscriptions).call(:index, {
'host_id' => host['id'],
'full_results' => true
})['results']
if remove_existing && existing_subscriptions.length != 0
print _("clearing existing subscriptions...") if option_verbose?
existing_subscriptions.map! do |existing_subscription|
subs = [{:id => existing_subscription['id'], :quantity => existing_subscription['quantity_consumed']}]
@api.resource(:host_subscriptions).call(:remove_subscriptions, {
'host_id' => host['id'],
'subscriptions' => subs
})
end
existing_subscriptions = []
end

if (line[SUBS_SKU].nil? || line[SUBS_SKU].empty?) &&
(line[SUBS_NAME].nil? || line[SUBS_NAME].empty?)
all_in_one_subscription(host, existing_subscriptions, line)
else
single_subscription(host, existing_subscriptions, line)
end
end

def single_subscription(host, existing_subscriptions, line)
matches = matches_by_sku_and_name([], line[SUBS_SKU], line[SUBS_NAME], existing_subscriptions)
matches = matches_by_hypervisor(matches, line[SUBS_GUESTOF])
unless matches.empty?
print _(" '%{name}' already attached...") % {:name => subscription_name(matches[0])} if option_verbose?
return
end

matches = get_matching_subscriptions(host['organization_id'],
:host => host, :sku => line[SUBS_SKU], :name => line[SUBS_NAME], :type => line[SUBS_TYPE],
:account => line[SUBS_ACCOUNT], :contract => line[SUBS_CONTRACT],
:quantity => line[SUBS_QUANTITY], :hypervisor => line[SUBS_GUESTOF],
:sla => line[SLA])

raise _("No matching subscriptions") if matches.empty?

match = matches[0]
print _(" attaching '%{name}'...") % {:name => subscription_name(match)} if option_verbose?

amount = line[SUBS_QUANTITY]
quantity = (amount.nil? || amount.empty? || amount == 'Automatic') ? 0 : amount.to_i

@api.resource(:host_subscriptions).call(:add_subscriptions, {
'host_id' => host['id'],
'subscriptions' => [{:id => match['id'], :quantity => quantity}]
})
end

def all_in_one_subscription(host, existing_subscriptions, line)
return if line[SUBSCRIPTIONS].nil? || line[SUBSCRIPTIONS].empty?

organization_id = foreman_organization(:name => line[ORGANIZATION])
hypervisor = hypervisor_from_line(line)

subscriptions = CSV.parse_line(line[SUBSCRIPTIONS], {:skip_blanks => true}).collect do |details|
(amount, sku, name, contract, account) = split_subscription_details(details)
matches = get_matching_subscriptions(organization_id,
:name => name, :contract => contract, :account => account, :quantity => amount,
:hypervisor => hypervisor, :sla => line[SLA])
raise "No matching subscription" if matches.empty?

{
:id => matches[0]['id'],
:quantity => (amount.nil? || amount.empty? || amount == 'Automatic') ? 0 : amount.to_i
}
end

@api.resource(:host_subscriptions).call(:add_subscriptions, {
'host_id' => host['id'],
'subscriptions' => subscriptions
})
end

def update_existing(line)
if !@existing[line[ORGANIZATION]]
@existing[line[ORGANIZATION]] = true
# Fetching all content hosts can be too slow and times so page
# http://projects.theforeman.org/issues/6307
total = @api.resource(:hosts).call(:index, {
'organization_id' => foreman_organization(:name => line[ORGANIZATION]),
'search' => option_search,
'per_page' => 1
})['subtotal'].to_i
(total / 20 + 1).to_i.times do |page|
@api.resource(:hosts).call(:index, {
'organization_id' => foreman_organization(:name => line[ORGANIZATION]),
'search' => option_search,
'page' => page + 1,
'per_page' => 20
})['results'].each do |host|
if host['subscription_facet_attributes']
@existing[host['name']] = host['id']
end
end
end
end
end

def iterate_hosts(csv)
hypervisors = []
hosts = []
@api.resource(:organizations).call(:index, {
'full_results' => true
})['results'].each do |organization|
next if option_organization && organization['name'] != option_organization

total = @api.resource(:hosts).call(:index, {
'organization_id' => foreman_organization(:name => organization['name']),
'search' => option_search,
'per_page' => 1
})['total'].to_i
(total / 20 + 1).to_i.times do |page|
@api.resource(:hosts).call(:index, {
'page' => page + 1,
'per_page' => 20,
'search' => option_search,
'organization_id' => foreman_organization(:name => organization['name'])
})['results'].each do |host|
host = @api.resource(:hosts).call(:show, {
'id' => host['id']
})
host['facts'] ||= {}
unless host['subscription_facet_attributes'].nil?
if host['subscription_facet_attributes']['virtual_guests'].empty?
hosts.push(host)
else
hypervisors.push(host)
end
end
end
end
end
hypervisors.each do |host|
yield host
end
hosts.each do |host|
yield host
end
end

def shared_headers
[NAME, ORGANIZATION, ENVIRONMENT, CONTENTVIEW, HOSTCOLLECTIONS, VIRTUAL, GUESTOF,
OPERATINGSYSTEM, ARCHITECTURE, SOCKETS, RAM, CORES, SLA, PRODUCTS]
end

def shared_columns(host)
name = host['name']
organization_name = host['organization_name']
if host['content_facet_attributes']
environment = host['content_facet_attributes']['lifecycle_environment']['name']
contentview = host['content_facet_attributes']['content_view']['name']
hostcollections = export_column(host['content_facet_attributes'], 'host_collections', 'name')
else
environment = nil
contentview = nil
hostcollections = nil
end
if host['subscription_facet_attributes']
hypervisor_host = host['subscription_facet_attributes']['virtual_host'].nil? ? nil : host['subscription_facet_attributes']['virtual_host']['name']
products = export_column(host['subscription_facet_attributes'], 'installed_products') do |product|
"#{product['productId']}|#{product['productName']}"
end
else
hypervisor_host = nil
products = nil
end
virtual = host['facts']['virt::is_guest'] == 'true' ? 'Yes' : 'No'
operatingsystem = host['facts']['distribution::name'] if host['facts']['distribution::name']
operatingsystem += " #{host['facts']['distribution::version']}" if host['facts']['distribution::version']
architecture = host['facts']['uname::machine']
sockets = host['facts']['cpu::cpu_socket(s)']
ram = host['facts']['memory::memtotal']
cores = host['facts']['cpu::core(s)_per_socket'] || 1
sla = ''

@column_values[NAME] = name
@column_values[ORGANIZATION] = organization_name
@column_values[ENVIRONMENT] = environment
@column_values[CONTENTVIEW] = contentview
@column_values[HOSTCOLLECTIONS] = hostcollections
@column_values[VIRTUAL] = virtual
@column_values[GUESTOF] = hypervisor_host
@column_values[OPERATINGSYSTEM] = operatingsystem
@column_values[ARCHITECTURE] = architecture
@column_values[SOCKETS] = sockets
@column_values[RAM] = ram
@column_values[CORES] = cores
@column_values[SLA] = sla
@column_values[PRODUCTS] = products
end

def custom_columns(host)
return if @column_definitions.nil?
@column_definitions.each do |definition|
@column_values[definition[:name]] = dig(host, definition[:json])
end
end

def dig(host, path)
path.inject(host) do |location, key|
location.respond_to?(:keys) ? location[key] : nil
end
end

def all_subscription_column(host)
if host['subscription_facet_attributes'] &&
(@columns.include?(SUBS_NAME) ||
@columns.include?(SUBSCRIPTIONS) ||
@columns.include?(SUBS_TYPE) ||
@columns.include?(SUBS_QUANTITY) ||
@columns.include?(SUBS_SKU) ||
@columns.include?(SUBS_CONTRACT) ||
@columns.include?(SUBS_ACCOUNT) ||
@columns.include?(SUBS_START) ||
@columns.include?(SUBS_END)
)
subscriptions = CSV.generate do |column|
column << @api.resource(:host_subscriptions).call(:index, {
'organization_id' => host['organization_id'],
'host_id' => host['id']
})['results'].collect do |subscription|
"#{subscription['quantity_consumed']}"\
"|#{subscription['product_id']}"\
"|#{subscription['product_name']}"\
"|#{subscription['contract_number']}|#{subscription['account_number']}"
end
end
subscriptions.delete!("\n")
else
subscriptions = nil
end
@column_values[SUBSCRIPTIONS] = subscriptions
end

def columns_to_csv(csv)
if @first_columns_to_csv.nil?
@columns.each do |column|
# rubocop:disable LineLength
if option_export? && !@column_values.key?(column)
$stderr.puts _("Warning: Column '%{name}' does not match any field, be sure to check spelling. A full list of supported columns are available with 'hammer csv content-hosts --help'") % {:name => column}
end
# rubocop:enable LineLength
end
@first_columns_to_csv = true
end
csv << @columns.collect do |column|
@column_values[column]
end
end

def hypervisor_from_line(line)
hypervisor = line[HOST] if !line[HOST].nil? && !line[HOST].empty?
hypervisor ||= line[GUESTOF] if !line[GUESTOF].nil? && !line[GUESTOF].empty?
hypervisor = namify(hypervisor, 1) if !hypervisor.nil? && !hypervisor.empty?
hypervisor
end

def clear_subscriptions?(name)
if option_clear_subscriptions? && !@visited.include?(name)
@visited[name] = true
true
else
false
end
end
end
end
end
(7-7/39)