Skip to content

Commit

Permalink
Adding dialog code for generic VM Provisioning (#83)
Browse files Browse the repository at this point in the history 
* Adding dialog code for generic VM Provisioning
+ get_lifecycle_environments_filtered_by_tags
  + This method supplies lifecycle envs to a dropdown
  + Updated to supply name or ID of env, based on input to the method
+ get_templates_based_on_selected_os_and_location_and_environment
  + Build on template dialog element from miq consulting utils
  + filter by both location and envronment tags on provider

* Update to template dialog element
- more correctly handle un-initiated environment dialog element
- more correctly handle errors invoking satellite API
  • Loading branch information
@A-Beck @itewk
A-Beck authored and itewk committed Feb 9, 2019
1 parent 7fabd5e commit 40c86c7
Show file tree
Hide file tree
Showing 6 changed files with 497 additions and 139 deletions.
304 changes: 166 additions & 138 deletions ...Satellite/DynamicDialogs.class/__methods__/get_lifecycle_environments_filtered_by_tags.rb
View file
Original file line number Diff line number Diff line change
@@ -1,154 +1,182 @@
# Populates a dynamic drop down with the Lifecycle Enviornments from a Satellite Organization
# filtered by tags on the providers available.
#
@DEBUG = false
# Inputs:
# - return_key - string - determines if hash returned from dialog element provides name or ID. e.g { id => name } or { name => name }
# - acceptable values - 'name' or 'id'
# - default value - 'id'

require 'apipie-bindings'

TAG_CATEGORY = 'environment'
module RedHatConsulting_Satellite6
module Automate
module Integration
module Satellite
module DynamicDialogs
class GetLifecycleEnvironmentsFilteredByTags
include RedHatConsulting_Utilities::StdLib::Core

# Log an error and exit.
#
# @param msg Message to error with
def error(msg)
$evm.log(:error, msg)
$evm.root['ae_result'] = 'error'
$evm.root['ae_reason'] = msg.to_s
exit MIQ_STOP
end
TAG_CATEGORY = 'environment'
SATELLITE_CONFIG_URI = 'Integration/Satellite/Configuration/default'

# Gets all of the Tags in a given Tag Category
#
# @param category Tag Category to get all of the Tags for
#
# @return Hash of Tag names mapped to Tag descriptions
#
# @source https://pemcg.gitbooks.io/mastering-automation-in-cloudforms-4-2-and-manage/content/using_tags_from_automate/chapter.html#_getting_the_list_of_tags_in_a_category
def get_category_tags(category)
classification = $evm.vmdb(:classification).find_by_name(category)
tags = {}
$evm.vmdb(:classification).where(:parent_id => classification.id).each do |tag|
tags[tag.name] = tag.description
end

return tags
end
def initialize(handle = $evm)
@handle = handle
@DEBUG = false
end

# Create a Tag in a given Category if it does not already exist
#
# @param category Tag Category to create the Tag in
# @param tag Tag to create in the given Tag Category
#
# @source https://pemcg.gitbooks.io/mastering-automation-in-cloudforms-4-2-and-manage/content/using_tags_from_automate/chapter.html
def create_tag(category, tag)
create_tag_category(category)
tag_name = to_tag_name(tag)
unless $evm.execute('tag_exists?', category, tag_name)
$evm.execute('tag_create',
category,
:name => tag_name,
:description => tag)
end
end
def main

# Create a Tag Category if it does not already exist
#
# @param category Tag Category to create
# @param description Tag Category description.
# Optional
# Defaults to the `category`
# @param single_value True if a resource can only have one tag from this category,
# False if a resource can have multiple tags from this category.
# Optional.
# Defaults to `false`
#
# @source https://pemcg.gitbooks.io/mastering-automation-in-cloudforms-4-2-and-manage/content/using_tags_from_automate/chapter.html
def create_tag_category(category, description = nil, single_value = false)
category_name = to_tag_name(category)
unless $evm.execute('category_exists?', category_name)
$evm.execute('category_create',
:name => category_name,
:single_value => single_value,
:perf_by_tag => false,
:description => description || category)
end
end
# If there isn't a vmdb_object_type yet just exit. The method will be recalled with an vmdb_object_type
exit MIQ_OK unless @handle.root['vmdb_object_type']

# Takes a string and makes it a valid tag name
#
# @param str String to turn into a valid Tag name
#
# @return Given string transformed into a valid Tag name
def to_tag_name(str)
return str.downcase.gsub(/[^a-z0-9_]+/,'_')
end
satellite_api = get_satellite_api()

# Gets an ApiPie binding to the Satellite API.
#
# @return ApipieBindings to the Satellite API
SATELLITE_CONFIG_URI = 'Integration/Satellite/Configuration/default'
def get_satellite_api()
satellite_config = $evm.instantiate(SATELLITE_CONFIG_URI)
error("Satellite Configuration not found") if satellite_config.nil?

satellite_server = satellite_config['satellite_server']
satellite_username = satellite_config['satellite_username']
satellite_password = satellite_config.decrypt('satellite_password')

$evm.log(:info, "satellite_server = #{satellite_server}") if @DEBUG
$evm.log(:info, "satellite_username = #{satellite_username}") if @DEBUG

error("Satellite Server configuration not found") if satellite_server.nil?
error("Satellite User configuration not found") if satellite_username.nil?
error("Satellite Password configuration not found") if satellite_password.nil?

satellite_api = ApipieBindings::API.new({:uri => satellite_server, :username => satellite_username, :password => satellite_password, :api_version => 2})
$evm.log(:info, "satellite_api = #{satellite_api}") if @DEBUG
return satellite_api
end
satellite_organization_id = @handle.root['dialog_satellite_organization_id']
log(:info, "satellite_organization_id = #{satellite_organization_id}") if @DEBUG

param_return_key = get_param(:return_key)
log(:info, "Method input return_key => <#{param_return_key}>") if @DEBUG
return_key = param_return_key.downcase == 'name' ? 'name' : 'id' rescue 'id'
log(:info, "Returning Dialog element values based on <#{return_key}>") if @DEBUG

begin
# If there isn't a vmdb_object_type yet just exit. The method will be recalled with an vmdb_object_type
exit MIQ_OK unless $evm.root['vmdb_object_type']

satellite_api = get_satellite_api()

satellite_organization_id = $evm.root['dialog_satellite_organization_id']
$evm.log(:info, "satellite_organization_id = #{satellite_organization_id}") if @DEBUG

if !satellite_organization_id.length.zero?
environments_index = satellite_api.resource(:lifecycle_environments).call(:index,{:organization_id => satellite_organization_id})
$evm.log(:info, "environments_index = #{environments_index}") if @DEBUG
dialog_field_values = Hash[ *environments_index['results'].collect { |item| [item['id'], item['name']] }.flatten ]
else
dialog_field_values = {}
end

$evm.log(:info, "dialog_field_values pre filtering: #{dialog_field_values}") if @DEBUG
dialog_field_values.each do |id, name|
create_tag(TAG_CATEGORY, name)
end

providers = $evm.vmdb(:ems).all
dialog_field_values.delete_if do |id, name|
provider_tagged = false
tag_name = to_tag_name(name)

providers.each do |provider|
provider_tagged = provider.tagged_with?(TAG_CATEGORY, tag_name)
$evm.log(:info, "Provider '#{provider.name}' tagged with: #{TAG_CATEGORY} => #{tag_name}") if @DEBUG && provider_tagged
break if provider_tagged
if !satellite_organization_id.length.zero?
environments_index = satellite_api.resource(:lifecycle_environments).call(:index,{:organization_id => satellite_organization_id})
log(:info, "environments_index = #{environments_index}") if @DEBUG
dialog_field_values = Hash[ *environments_index['results'].collect { |item| [item[return_key], item['name']] }.flatten ]
log(:info, "Environment dialog_field_values = #{dialog_field_values}") if @DEBUG
else
dialog_field_values = {}
end

log(:info, "dialog_field_values pre filtering: #{dialog_field_values}") if @DEBUG
dialog_field_values.each do | key, name|
create_tag(TAG_CATEGORY, name)
end

providers = @handle.vmdb(:ems).all
dialog_field_values.delete_if do |id, name|
provider_tagged = false
tag_name = to_tag_name(name)

providers.each do |provider|
provider_tagged = provider.tagged_with?(TAG_CATEGORY, tag_name)
log(:info, "Provider '#{provider.name}' tagged with: #{TAG_CATEGORY} => #{tag_name}") if @DEBUG && provider_tagged
break if provider_tagged
end
log(:info, "No provider tagged with: #{TAG_CATEGORY} => #{tag_name}") if @DEBUG && !provider_tagged
!provider_tagged
end
log(:info, "dialog_field_values post filtering: #{dialog_field_values}") if @DEBUG


dialog_field_values['!'] = '--- Select Environment From List ---'
dialog_field = @handle.object
dialog_field["sort_by"] = "value"
dialog_field["sort_order"] = "ascending"
dialog_field["data_type"] = "string"
dialog_field["required"] = true
dialog_field["values"] = dialog_field_values

exit MIQ_OK

end

# Gets all of the Tags in a given Tag Category
#
# @param category Tag Category to get all of the Tags for
#
# @return Hash of Tag names mapped to Tag descriptions
#
# @source https://pemcg.gitbooks.io/mastering-automation-in-cloudforms-4-2-and-manage/content/using_tags_from_automate/chapter.html#_getting_the_list_of_tags_in_a_category
def get_category_tags(category)
classification = @handle.vmdb(:classification).find_by_name(category)
tags = {}
@handle.vmdb(:classification).where(:parent_id => classification.id).each do |tag|
tags[tag.name] = tag.description
end

return tags
end

# Create a Tag in a given Category if it does not already exist
#
# @param category Tag Category to create the Tag in
# @param tag Tag to create in the given Tag Category
#
# @source https://pemcg.gitbooks.io/mastering-automation-in-cloudforms-4-2-and-manage/content/using_tags_from_automate/chapter.html
def create_tag(category, tag)
create_tag_category(category)
tag_name = to_tag_name(tag)
unless @handle.execute('tag_exists?', category, tag_name)
@handle.execute('tag_create',
category,
:name => tag_name,
:description => tag)
end
end

# Create a Tag Category if it does not already exist
#
# @param category Tag Category to create
# @param description Tag Category description.
# Optional
# Defaults to the `category`
# @param single_value True if a resource can only have one tag from this category,
# False if a resource can have multiple tags from this category.
# Optional.
# Defaults to `false`
#
# @source https://pemcg.gitbooks.io/mastering-automation-in-cloudforms-4-2-and-manage/content/using_tags_from_automate/chapter.html
def create_tag_category(category, description = nil, single_value = false)
category_name = to_tag_name(category)
unless @handle.execute('category_exists?', category_name)
@handle.execute('category_create',
:name => category_name,
:single_value => single_value,
:perf_by_tag => false,
:description => description || category)
end
end

# Takes a string and makes it a valid tag name
#
# @param str String to turn into a valid Tag name
#
# @return Given string transformed into a valid Tag name
def to_tag_name(str)
return str.downcase.gsub(/[^a-z0-9_]+/,'_')
end

# Gets an ApiPie binding to the Satellite API.
#
# @return ApipieBindings to the Satellite API
def get_satellite_api()
satellite_config = @handle.instantiate(SATELLITE_CONFIG_URI)
error("Satellite Configuration not found") if satellite_config.nil?

satellite_server = satellite_config['satellite_server']
satellite_username = satellite_config['satellite_username']
satellite_password = satellite_config.decrypt('satellite_password')

log(:info, "satellite_server = #{satellite_server}") if @DEBUG
log(:info, "satellite_username = #{satellite_username}") if @DEBUG

error("Satellite Server configuration not found") if satellite_server.nil?
error("Satellite User configuration not found") if satellite_username.nil?
error("Satellite Password configuration not found") if satellite_password.nil?

satellite_api = ApipieBindings::API.new({:uri => satellite_server, :username => satellite_username, :password => satellite_password, :api_version => 2})
log(:info, "satellite_api = #{satellite_api}") if @DEBUG
return satellite_api
end

end
end
end
end
$evm.log(:info, "No provider tagged with: #{TAG_CATEGORY} => #{tag_name}") if @DEBUG && !provider_tagged

!provider_tagged
end
$evm.log(:info, "dialog_field_values post filtering: #{dialog_field_values}") if @DEBUG

dialog_field = $evm.object
dialog_field["sort_by"] = "value"
dialog_field["sort_order"] = "ascending"
dialog_field["data_type"] = "integer"
dialog_field["required"] = true
dialog_field["values"] = dialog_field_values
end

if __FILE__ == $PROGRAM_NAME
RedHatConsulting_Satellite6::Automate::Integration::Satellite::DynamicDialogs::GetLifecycleEnvironmentsFilteredByTags.new.main
end
25 changes: 24 additions & 1 deletion ...tellite/DynamicDialogs.class/__methods__/get_lifecycle_environments_filtered_by_tags.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,27 @@ object:
scope: instance
language: ruby
location: inline
inputs: []
embedded_methods:
- "/StdLib/Core/Core"
options: {}
inputs:
- field:
aetype:
name: return_key
display_name:
datatype:
priority: 1
owner:
default_value: id
substitute: false
message: create
visibility:
collect:
scope:
description:
condition:
on_entry:
on_exit:
on_error:
max_retries:
max_time:
Loading

0 comments on commit 40c86c7

Please sign in to comment.