Class: HammerCLICsv::CsvCommand::SubscriptionsCommand

Inherits:
BaseCommand
  • Object
show all
Includes:
Utils::Subscriptions
Defined in:
lib/hammer_cli_csv/subscriptions.rb

Constant Summary collapse

ORGANIZATION =
'Organization'
MANIFEST =
'Manifest File'

Constants included from Utils::Subscriptions

Utils::Subscriptions::SUBSCRIPTIONS, Utils::Subscriptions::SUBS_ACCOUNT, Utils::Subscriptions::SUBS_CONTRACT, Utils::Subscriptions::SUBS_END, Utils::Subscriptions::SUBS_GUESTOF, Utils::Subscriptions::SUBS_NAME, Utils::Subscriptions::SUBS_QUANTITY, Utils::Subscriptions::SUBS_SKU, Utils::Subscriptions::SUBS_START, Utils::Subscriptions::SUBS_TYPE

Constants inherited from BaseCommand

BaseCommand::COUNT, BaseCommand::NAME

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Utils::Subscriptions

#debug_subscriptions, #get_all_subscriptions, #get_matching_subscriptions, #match_with_quantity_to_attach, #matches_by_account, #matches_by_contract, #matches_by_hypervisor, #matches_by_quantity, #matches_by_sku_and_name, #matches_by_sla, #matches_by_type, #split_subscription_details, #subscription_name

Methods inherited from BaseCommand

#apipie_check_param, #associate_locations, #associate_organizations, #authenticate_request, #build_os_name, #check_server_status, #collect_column, #count, #execute, #export_column, #foreman_architecture, #foreman_container, #foreman_domain, #foreman_environment, #foreman_filter, #foreman_host, #foreman_hostgroup, #foreman_location, #foreman_medium, #foreman_operatingsystem, #foreman_organization, #foreman_partitiontable, #foreman_permission, #foreman_provisioning_template, #foreman_role, #foreman_smart_proxy, #foreman_template_kind, #hammer, #hammer_context, #help, help_columns, #katello_contentview, #katello_contentviewversion, #katello_hostcollection, #katello_product, #katello_repository, #labelize, #lifecycle_environment, #namify, #pluralize, #split_os_name, #supported?, #thread_import

Methods included from Utils::Config

#api_connection

Class Method Details

.supported?Boolean

Returns:

  • (Boolean)


11
12
13
# File 'lib/hammer_cli_csv/subscriptions.rb', line 11

def self.supported?
  true
end

Instance Method Details

#add_subscription(line, manifest) ⇒ Object



137
138
139
140
141
142
143
144
145
146
147
148
# File 'lib/hammer_cli_csv/subscriptions.rb', line 137

def add_subscription(line, manifest)
  if find_existing_subscription(line, manifest)
    puts _("'%{name}' of quantity %{quantity} already attached") %
            {:name => line[SUBS_NAME], :quantity => line[SUBS_QUANTITY]} if option_verbose?
    return
  end
  print _("Attaching '%{name}' of quantity %{quantity}...") %
          {:name => line[SUBS_NAME], :quantity => line[SUBS_QUANTITY]} if option_verbose?
  manifest['available_subscriptions'] ||= get_available_subscriptions(manifest)
  attach_subscription(line, manifest)
  puts _('done')
end

#attach_subscription(line, manifest) ⇒ Object



150
151
152
153
154
155
156
157
158
159
160
# File 'lib/hammer_cli_csv/subscriptions.rb', line 150

def attach_subscription(line, manifest)
  manifest['available_subscriptions'].each do |subscription|
    if subscription['productId'] == line[SUBS_SKU] && subscription['quantity'] >= line[SUBS_QUANTITY]
      api = rest_client("/subscription/consumers/#{manifest['uuid']}/entitlements?pool=#{subscription['id']}&quantity=#{line[SUBS_QUANTITY]}")
      results = api.post({}.to_json)
      subscription['quantity'] -= line[SUBS_QUANTITY]
      return
    end
  end
  print _('subscription unavailable...')
end

#export(csv) ⇒ Object



30
31
32
33
34
35
36
37
38
# File 'lib/hammer_cli_csv/subscriptions.rb', line 30

def export(csv)
  csv << [NAME, ORGANIZATION, MANIFEST, SUBS_NAME, SUBS_QUANTITY, SUBS_SKU, SUBS_CONTRACT, SUBS_ACCOUNT, SUBS_START, SUBS_END]
  @api.resource(:organizations).call(:index, {:per_page => 999999})['results'].each do |organization|
    next if option_organization && organization['name'] != option_organization
    organization = @api.resource(:organizations).call(:show, {'id' => organization['id']})
    export_manifest(csv, organization)
    export_subscriptions(csv, organization)
  end
end

#export_manifest(csv, organization) ⇒ Object



40
41
42
43
44
45
46
# File 'lib/hammer_cli_csv/subscriptions.rb', line 40

def export_manifest(csv, organization)
  info = organization['owner_details']['upstreamConsumer']
  return if info.nil?

  csv << ["Manifest Name", organization['name'], info['name']]
  csv << ["Manifest URL", organization['name'], "https://#{info['webUrl']}#{info['uuid']}"]
end

#export_subscriptions(csv, organization) ⇒ Object



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# File 'lib/hammer_cli_csv/subscriptions.rb', line 48

def export_subscriptions(csv, organization)
  @api.resource(:subscriptions).call(:index, {
      'per_page' => 999999,
      'search' => option_search,
      'organization_id' => organization['id']
  })['results'].each do |subscription|
    next if subscription['product_id'].to_i != 0  # Red Hat subs do not have number SKU
    name = subscription['host'].nil? ? "Subscription" : "Guest Subscription for Host '#{subscription['host']['name']}'"
    quantity = subscription['quantity'] < 0 ? "Unlimited" : subscription['quantity']
    csv << [name, organization['name'], nil, subscription['name'],
            quantity, subscription['product_id'], subscription['contract_number'],
            subscription['account_number'],
            subscription['start_date'], subscription['end_date']]
  end
end

#find_existing_subscription(line, manifest) ⇒ Object



167
168
169
170
171
172
173
174
175
# File 'lib/hammer_cli_csv/subscriptions.rb', line 167

def find_existing_subscription(line, manifest)
  manifest['subscriptions'].each do |subscription|
    if !subscription['csv_matched'] && subscription['pool']['productId'] == line[SUBS_SKU] && subscription['quantity'] == line[SUBS_QUANTITY]
      subscription['csv_matched'] = true
      return true
    end
  end
  false
end

#get_available_subscriptions(manifest) ⇒ Object



162
163
164
165
# File 'lib/hammer_cli_csv/subscriptions.rb', line 162

def get_available_subscriptions(manifest)
  api = rest_client("/subscription/pools/?consumer=#{manifest['uuid']}&listall=false")
  JSON.parse(api.get)
end

#get_existing_manifest(line) ⇒ Object



205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
# File 'lib/hammer_cli_csv/subscriptions.rb', line 205

def get_existing_manifest(line)
  return @manifests[line[ORGANIZATION]][:manifest] if @manifests[line[ORGANIZATION]][:manifest]

  unless @manifests[line[ORGANIZATION]][:owner]
    api = rest_client("/subscription/users/#{option_portal_username}/owners")
    @manifests[line[ORGANIZATION]][:owner] = JSON.parse(api.get)[0]['key']
  end

  api = rest_client("/subscription/owners/#{@manifests[line[ORGANIZATION]][:owner]}/consumers?type=satellite")
  response = JSON.parse(api.get).each do |manifest|
    if manifest['name'] == @manifests[line[ORGANIZATION]][:name]
      @manifests[line[ORGANIZATION]][:manifest] = manifest
      break
    end
  end
  @manifests[line[ORGANIZATION]][:manifest]
end

#get_or_create_manifest(line) ⇒ Object



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
# File 'lib/hammer_cli_csv/subscriptions.rb', line 177

def get_or_create_manifest(line)
  manifest = get_existing_manifest(line)
  if manifest
    if manifest['subscriptions'].nil?
      api = rest_client("/subscription/consumers/#{manifest['uuid']}/entitlements")
      results = JSON.parse(api.get)
      manifest['subscriptions'] = results
    end
  else
    api = rest_client("/subscription/consumers?owner=#{@manifests[line[ORGANIZATION]][:owner]}")
    body = {
      'name' => line[MANIFEST],
      'type' => 'satellite',
      'facts' => {
        'distributor_version' => 'sat-6.0',
        'system.certificate_version' => '3.2'
      }
    }
    results = api.post(body.to_json,
        {'accept' => 'json', 'content_type' => 'application/json'}
    )
    manifest = JSON.parse(results)
    manifest['subscriptions'] = []
    @manifests[line[ORGANIZATION]][:manifest] = manifest
  end
  manifest
end

#importObject



64
65
66
67
68
69
70
71
72
73
74
# File 'lib/hammer_cli_csv/subscriptions.rb', line 64

def import
  if option_in_portal?
    import_into_portal
  else
    thread_import do |line|
      if line[NAME] == 'Manifest' && line[MANIFEST] && !line[MANIFEST].empty?
        import_manifest(line[ORGANIZATION], line[MANIFEST])
      end
    end
  end
end

#import_into_portalObject



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
# File 'lib/hammer_cli_csv/subscriptions.rb', line 88

def import_into_portal
  raise _("--portal-username and --portal-password required") unless option_portal_username && option_portal_password
  raise _("--portal required") unless option_portal

  @manifests = {}

  thread_import do |line|
    return if option_organization && line[ORGANIZATION] != option_organization

    @manifests[line[ORGANIZATION]] ||= {}
    import_subscription(line)
  end

  @manifests.each do |organization, manifest|
    print _("Downloading manifest for organization '%{organization}...") % {:organization => organization} if option_verbose?
    api = rest_client("/subscription/consumers/#{manifest[:manifest]['uuid']}/export")
    data = api.get({'accept' => 'application/zip'})
    filename = manifest[:file] || "#{manifest[:name]}.zip"
    print _("writing to file '%{filename}'...") % {:filename => filename} if option_verbose?
    File.open(filename, 'w') do |f|
      f.binmode
      f.write data
    end
    puts _("done") if option_verbose?
    import_manifest(organization, filename)
  end
end

#import_manifest(organization_name, filename) ⇒ Object



76
77
78
79
80
81
82
83
84
85
86
# File 'lib/hammer_cli_csv/subscriptions.rb', line 76

def import_manifest(organization_name, filename)
  return if option_organization && organization_name != option_organization
  print(_("Importing manifest '%{filename}' into organization '%{organization}'...") % {:filename => filename, :organization => organization_name}) if option_verbose?
  args = %W{
    --server #{ @server } --username #{ @username } --password #{ @password }
    subscription upload --file #{ filename }
    --organization-id #{ foreman_organization(:name => organization_name) }
  }
  hammer.run(args)
  puts(_("done")) if option_verbose?
end

#import_subscription(line) ⇒ Object



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
# File 'lib/hammer_cli_csv/subscriptions.rb', line 116

def import_subscription(line)
  case line[NAME]
  when "Manifest Name"
    print _("Checking manifest '%{name}'...") % {:name => line[MANIFEST]} if option_verbose?
    @manifests[line[ORGANIZATION]][:name] = line[MANIFEST]
    @manifests[line[ORGANIZATION]][:manifest] = get_or_create_manifest(line)
    puts _("done") if option_verbose?
  when "Manifest URL"
    # ignore
  when "Manifest"
    @manifests[line[ORGANIZATION]][:file] = line[MANIFEST]
  when "Subscription"
    manifest = @manifests[line[ORGANIZATION]][:manifest]
    raise _('Manifest Name row is required before updating from Subscription rows') unless manifest
    line[SUBS_QUANTITY] = line[SUBS_QUANTITY].to_i  #guarantee integer for future calculations
    add_subscription(line, manifest)
  else
    # ignore
  end
end

#rest_client(path) ⇒ Object



223
224
225
226
227
228
229
230
231
232
233
234
235
236
# File 'lib/hammer_cli_csv/subscriptions.rb', line 223

def rest_client(path)
  options = {
    :headers => {
      'accept' => 'application/json',
      'accept-language' => HammerCLI::I18n.locale,
      'content-type' => 'application/json'
    },
    :user => option_portal_username,
    :password => option_portal_password,
    :verify_ssl => OpenSSL::SSL::VERIFY_NONE
  }

  RestClient::Resource.new(option_portal + path, options)
end