brpm_module_bladelogic 0.1.14 → 0.1.15

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDNjOGM4YjBhYTBiOTIwOGYyN2NhYWQxMjQzZDJlYmI1NzcxOWFiYQ==
+    YjI3MzIxMGQ4ZjM0OTE2YTE3MmU5NmQ4NWYxNDE1MjgyYmRlYjNlYw==
   data.tar.gz: !binary |-
-    NDJjNGU3OGU5OTFhN2E5NWE5M2RiM2NlMzZkZTc0Y2I1YjRlNWVjYw==
+    ZjI2MjIyYzlkNWJlYzViY2E3NWE1ZjdmN2M1ODZjNGQ0NDZmNjQ3Yw==
 SHA512:
   metadata.gz: !binary |-
-    ZTYzNTM0ZjhjMWExYmQ1OGJmMDI4NWFlMTA1M2NjNTRlNzM0OGQyZTdhMWQz
-    OTgxNWI2NDA4YzBiNTE1ZTBkOTVmZDNkMDVkNzliYzliMjBmODMzZWUyYjYw
-    MWFiMjkyOTVlZjFlMTJkMGY2YjQzMDNhYjY4NDAyNDFlNzExMTA=
+    YzgxNDhlMWQ0YWRhMTJmMDMxODU0MjNmZmRjZDY5YWJkZjRiYzE4NTZlM2Yy
+    MGQxYTUwYTdlMjM2OTQ5NTI5Yzc2NmM4ZjNkOGE2NDVhYmI1MjYyYjY2ZWNh
+    MGMxMzhkMDRlOTMyM2I1NmFlYTg3MDgyZGJhMTM5NDBmMDVjMjM=
   data.tar.gz: !binary |-
-    NGY2NzU0NWEzNDMyM2NmOTg2MDMyM2RhNDk1ZmVlOTZlNTA1NjJjMjNmMTA5
-    NTFiMzgzZmNjYzljNWY3Mjg1YjU1ZTIyMDIyZDUwOTkzMmViZWI3NDJmMGEy
-    YzdlYzU0OGYyYThmY2M1ZTE3OGUyNGU3YjVjYjRkMzg2MWIxNGU=
+    NDA4ZTNiZWJiMWU1MjUxYmJkODY0NzA3MjljMGNjNmU1MDkxNjM2ZGY5NDI1
+    MDk3NDQwNTRkYWVhOWQwMDI3ZmM1MmFhMzBhNGEwZWFhMDc0YWZiMDEwZTQ2
+    MjM3OWZjNjdiYTQyOTVhOWE3YjRhYmFiNDcyZWUyZjhmYmFkZWM=

data/automations/deploy_package.meta

@@ -19,6 +19,11 @@ params:
   target_path_or_servers:
     name: Target path or servers (comma separated)
     position: A6:F6
+  deploy_options:
+    name: Deploy options
+    type: in-list-single
+    list_pairs: 0,Complete deployment|1,Only upload package|2,Only execute package
+    position: A7:F7
   job_status:
     name: Job Status
     type: out-text

data/automations/deploy_package.rb

@@ -3,48 +3,113 @@ brpm_rest_client = BrpmRestClient.new
 
 environment = params.request_environment
 
-target_type = BrpmAuto.first_defined(BrpmAuto.substitute_tokens(params["target_type"]), "Server group")
+if params["target_type"] == "Component group" and (params["deploy_options"] == "Only upload package")
+  raise "Deploy option 'Only upload package' is not supported when the target type is 'Component group'" #TODO: find out how to find a component by component group so we can use the createComponentBasedDeployJob
+end
+
+BrpmAuto.log "Deploy options: #{params["deploy_options"]}"
+
+BrpmAuto.log("Logging on to Bladelogic...")
+bsa_soap_client = BsaSoapClient.new
+
+if params["deploy_options"] == "Only execute package"
+  BrpmAuto.log "Getting the Deploy job db key from the request params..."
+  job_db_key = BrpmAuto.request_params["#{params.component}_deploy_job_db_key"]
 
-if target_type == "Servers"
-  target_servers = BrpmAuto.first_defined(BrpmAuto.substitute_tokens(params["target_path_or_servers"]), BrpmAuto.params.servers.keys.join(","))
+  raise "The Deploy job db key for component #{params.component} is not specified in the request_params" unless job_db_key
+
+  deploy_job_name = bsa_soap_client.job.get_job_name_by_db_key({:job_db_key => job_db_key})
+  deploy_job_group_path_id = bsa_soap_client.job.get_group_id({:job_key => job_db_key})
+  deploy_job_group_path = bsa_soap_client.group.get_a_qualified_group_name({:group_type => 5005, :group_id => deploy_job_group_path_id})
 else
-  unless params["server_group"] # can already be populated by the automated tests
-    BrpmAuto.log("Getting the server group from the step...")
-    params["server_group"] = brpm_rest_client.get_server_group_from_step_id(params["step_id"])
+  target_type = BrpmAuto.first_defined(BrpmAuto.substitute_tokens(params["target_type"]), "Server group")
+  BrpmAuto.log "Target type: #{params["target_type"]}"
+
+  target_path = nil
+  target_servers = nil
+
+  if target_type == "Servers"
+    target_servers = BrpmAuto.first_defined(BrpmAuto.substitute_tokens(params["target_path_or_servers"]), BrpmAuto.params.servers.keys.join(","))
+  else
+    unless params["server_group"] # can already be populated by the automated tests
+      BrpmAuto.log("Getting the server group from the step...")
+      params["server_group"] = brpm_rest_client.get_server_group_from_step_id(params["step_id"])
+    end
+    server_group = params["server_group"]
+
+    target_path = BrpmAuto.first_defined(BrpmAuto.substitute_tokens(params["target_path_or_servers"]), "/Applications/#{params["application"]}/#{params["request_environment"]}/#{server_group}")
   end
-  server_group = params["server_group"]
 
-  target_path = BrpmAuto.first_defined(BrpmAuto.substitute_tokens(params["target_path_or_servers"]), "/Applications/#{params["application"]}/#{params["request_environment"]}/#{server_group}")
-end
+  deploy_job_name = BrpmAuto.first_defined(BrpmAuto.substitute_tokens(params["deploy_job_name"]), "Deploy #{params["component"]} #{params["component_version"]} in #{environment} - #{Time.now.strftime("%Y-%m-%d %H:%M:%S")}")
+  deploy_job_group_path = BrpmAuto.first_defined(BrpmAuto.substitute_tokens(params["deploy_job_group_path"]), "/Applications/#{params["application"]}")
 
-deploy_job_name = BrpmAuto.first_defined(BrpmAuto.substitute_tokens(params["deploy_job_name"]), "Deploy #{params["component"]} #{params["component_version"]} in #{environment} - #{Time.now.strftime("%Y-%m-%d %H:%M:%S")}")
-deploy_job_group_path = BrpmAuto.first_defined(BrpmAuto.substitute_tokens(params["deploy_job_group_path"]), "/Applications/#{params["application"]}")
+  depot_group_path = BrpmAuto.first_defined(BrpmAuto.substitute_tokens(params["depot_group_path"]), "/Applications/#{params["application"]}/#{params["component"]}")
+  package_name = BrpmAuto.first_defined(BrpmAuto.substitute_tokens(params["bl_package_name"]), params["component_version"])
 
-depot_group_path = BrpmAuto.first_defined(BrpmAuto.substitute_tokens(params["depot_group_path"]), "/Applications/#{params["application"]}/#{params["component"]}")
-package_name = BrpmAuto.first_defined(BrpmAuto.substitute_tokens(params["bl_package_name"]), params["component_version"])
+  BrpmAuto.log("Retrieving the db key of blpackage #{depot_group_path}/#{package_name}...")
+  package_db_key = bsa_soap_client.blpackage.get_dbkey_by_group_and_name({:parent_group => depot_group_path, :depot_group_path => package_name })
 
-BrpmAuto.log("Logging on to Bladelogic...")
-bsa_soap_client = BsaSoapClient.new
+  BrpmAuto.log("Retrieving the id of job group #{deploy_job_group_path}...")
+  deploy_job_group_id = bsa_soap_client.job_group.group_name_to_id({:group_name => deploy_job_group_path })
+
+  job_db_key = nil
+  if target_type == "Server group"
+    BrpmAuto.log("Retrieving the id of server group #{target_path}...")
+    server_group_id = bsa_soap_client.server_group.group_name_to_id({:group_name => target_path })
+
+    #Find an individual server name because the create_deploy_job_advanced blcli command for some reason needs one :-(
+    target_servers = bsa_soap_client.server.find_server_objects_by_group({:group_id => server_group_id, :recursive => true})
+
+    if target_servers.nil? or target_servers.empty?
+      BrpmAuto.log "The server group does not contain any servers. Aborting the deployment."
+      exit
+    else
+      server_name = target_servers.split("\n")[0]
+    end
+
+    BrpmAuto.log("Creating Deploy job #{deploy_job_group_path}/#{deploy_job_name}...")
+    job_db_key = bsa_soap_client.deploy_job.create_deploy_job_advanced({:job_name => deploy_job_name, :group_id => deploy_job_group_id, :package_db_key => package_db_key, :server_name => server_name})
 
-BrpmAuto.log("Retrieving the db key of blpackage #{depot_group_path}/#{package_name}...")
-package_db_key = bsa_soap_client.blpackage.get_dbkey_by_group_and_name({:parent_group => depot_group_path, :depot_group_path => package_name })
+    BrpmAuto.log("Adding server group #{target_path} to the Deploy job...")
+    job_db_key = bsa_soap_client.job.add_target_group({:job_key => job_db_key, :group_name => target_path})
 
-BrpmAuto.log("Retrieving the id of job group #{deploy_job_group_path}...")
-deploy_job_group_id = bsa_soap_client.job_group.group_name_to_id({:group_name => deploy_job_group_path })
+  elsif target_type == "Servers"
+    #Find an individual server name because the create_deploy_job_advanced blcli command for some reason needs one :-(
+    if target_servers.nil? or target_servers.empty?
+      BrpmAuto.log "No target servers found. Aborting the deployment."
+      exit
+    else
+      server_name = target_servers.split(",")[0]
+    end
 
-BrpmAuto.log("Creating Deploy job #{deploy_job_group_path}/#{deploy_job_name}...")
-job_db_key = bsa_soap_client.deploy_job.create_deploy_job_without_target({:job_name => deploy_job_name, :group_id => deploy_job_group_id, :package_db_key => package_db_key})
+    BrpmAuto.log("Creating Deploy job #{deploy_job_group_path}/#{deploy_job_name}...")
+    job_db_key = bsa_soap_client.deploy_job.create_deploy_job_advanced({:job_name => deploy_job_name, :group_id => deploy_job_group_id, :package_db_key => package_db_key, :server_name => server_name})
 
-if target_type == "Server group"
-  BrpmAuto.log("Adding server group #{target_path} to the Deploy job...")
-  job_db_key = bsa_soap_client.job.add_target_group({:job_key => job_db_key, :group_name => target_path})
-elsif target_type == "Component group"
-  BrpmAuto.log("Adding component group #{target_path} to the Deploy job...")
-  job_db_key = bsa_soap_client.job.add_target_component_group({:job_key => job_db_key, :group_name => target_path})
-elsif target_type == "Servers"
-  unless target_servers.nil? or target_servers.empty?
     BrpmAuto.log("Adding servers #{target_servers} to the Deploy job...")
     job_db_key = bsa_soap_client.job.add_target_servers({:job_key => job_db_key, :server_names => target_servers})
+
+  elsif target_type == "Component group"
+    BrpmAuto.log("Creating Deploy job #{deploy_job_group_path}/#{deploy_job_name}...")
+    job_db_key = bsa_soap_client.deploy_job.create_deploy_job_without_target({:job_name => deploy_job_name, :group_id => deploy_job_group_id, :package_db_key => package_db_key})
+
+    BrpmAuto.log("Adding component group #{target_path} to the Deploy job...")
+    job_db_key = bsa_soap_client.job.add_target_component_group({:job_key => job_db_key, :group_name => target_path})
+  end
+
+  if params["deploy_options"] == "Only upload package"
+    wait_time = 30
+    start_time = Time.now + wait_time
+    BrpmAuto.log("Setting the phase schedule of the Deploy job to only execute the stage phase, starting in #{wait_time} seconds (at #{start_time.strftime("%Y-%m-%d %H:%M:%S")})...")
+    job_db_key = bsa_soap_client.deploy_job.set_phase_schedule_by_dbkey({:job_run_key => job_db_key,
+                                                                         :simulate_type => "AtTime",
+                                                                         :simulate_date => start_time.strftime("%Y-%m-%d %H:%M:%S"),
+                                                                         :stage_type => "AfterPreviousPhase",
+                                                                         :stage_date => "",
+                                                                         :commit_type => "NotScheduled",
+                                                                         :commit_date => ""})
+
+    BrpmAuto.log "Storing the Deploy job db key to the request params so it can be used later to execute the package (right now we are only going to upload the package to the target servers)."
+    BrpmAuto.request_params["#{params.component}_deploy_job_db_key"] = job_db_key
   end
 end
 
@@ -52,6 +117,15 @@ BrpmAuto.log("Executing the Deploy job...")
 job_run_key = bsa_soap_client.job.execute_job_and_wait({:job_key => job_db_key})
 BrpmAuto.log("Job run key is #{job_run_key}.")
 
+if params["deploy_options"] == "Only upload package"
+  BrpmAuto.log("Polling the Deploy job until it is finished...")
+  begin
+    sleep(wait_time)
+    is_still_running = bsa_soap_client.job_run.get_job_run_is_running_by_run_key({:job_run_key => job_run_key})
+  end while is_still_running
+  BrpmAuto.log("The Deploy job has finished.")
+end
+
 BrpmAuto.log("Checking if the job finished successfully...")
 had_errors = bsa_soap_client.job_run.get_job_run_had_errors({:job_run_key => job_run_key})
 

data/config.yml

@@ -1,7 +1,7 @@
 dependencies:
  - brpm_module_brpm
 
-version: 0.1.14
+version: 0.1.15
 
 author: Niek Bartholomeus
 email: niek.bartholomeus@gmail.com

data/lib/bl_soap/bsa_soap_client.rb

@@ -24,10 +24,26 @@ class BsaSoapClient < BsaSoapBase
     @job_group ||= JobGroup.new(@url, @session_id)
   end
 
+  def group
+    @group ||= Group.new(@url, @session_id)
+  end
+
   def depot_group
     @depot_group ||= DepotGroup.new(@url, @session_id)
   end
 
+  def server_group
+    @server_group ||= ServerGroup.new(@url, @session_id)
+  end
+
+  def component_group
+    @component_group ||= ComponentGroup.new(@url, @session_id)
+  end
+
+  def server
+    @server ||= Server.new(@url, @session_id)
+  end
+
   def utility
     @utility ||= Utility.new(@url, @session_id)
   end

data/lib/bl_soap/component_group.rb

@@ -0,0 +1,12 @@
+class ComponentGroup < BsaSoapBase
+	def group_name_to_id(options = {})
+		validate_cli_options_hash([:group_name], options)
+		integer_result = execute_cli_with_param_list(self.class, "groupNameToId",
+																								 [
+																										 options[:group_name]	# Fully qualified path
+																								 ])
+		integer_value = get_cli_return_value(integer_result)
+	rescue => exception
+		raise "Exception executing #{self.class} function: #{exception.to_s}"
+	end
+end

data/lib/bl_soap/deploy_job.rb

@@ -33,6 +33,36 @@ class DeployJob < BsaSoapBase
     raise "Exception executing #{self.class} function: #{exception.to_s}"
   end
 
+  def create_deploy_job_advanced(options = {})
+    validate_cli_options_hash([:job_name, :group_id, :package_db_key, :server_name], options)
+    db_key_result = execute_cli_with_param_list(self.class, "createDeployJob",
+                                                [
+                                                    options[:job_name],
+                                                    options[:group_id],
+                                                    options[:package_db_key],
+                                                    1,                              #deployType (0 = BASIC, 1 = ADVANCED)
+                                                    options[:server_name],
+                                                    true,                           #isSimulateEnabled
+                                                    true,                           #isCommitEnabled
+                                                    false,                          #isStagedIndirect
+                                                    2,                              #logLevel (0 = ERRORS, 1 = ERRORS_AND_WARNINGS, 2 = ALL_INFO)
+                                                    true,                           #isExecuteByPhase
+                                                    false,                          #isResetOnFailure
+                                                    true,                           #isRollbackAllowed
+                                                    false,                          #isRollbackOnFailure
+                                                    true,                           #isRebootIfRequired
+                                                    true,                           #isCopyLockedFilesAfterReboot
+                                                    true,                           #isStagingAfterSimulate
+                                                    true                            #isCommitAfterStaging
+                                                ])
+    db_key = get_cli_return_value(db_key_result)
+  rescue => exception
+    raise "Exception executing #{self.class} function: #{exception.to_s}"
+  end
+
+
+
+
   def get_dbkey_by_group_and_name(options = {})
     validate_cli_options_hash([:group_name, :job_name], options)
     db_key_result = execute_cli_with_param_list(self.class, "getDBKeyByGroupAndName",

data/lib/bl_soap/group.rb

@@ -0,0 +1,13 @@
+class Group < BsaSoapBase
+	def get_a_qualified_group_name(options = {})
+    validate_cli_options_hash([:group_type, :group_id], options)
+		string_result = execute_cli_with_param_list(self.class, "getAQualifiedGroupName",
+			[
+				options[:group_type],
+				options[:group_id],
+			])
+		string_value = get_cli_return_value(string_result)
+	rescue => exception
+		raise "Exception executing #{self.class} function: #{exception.to_s}"
+	end
+end

data/lib/bl_soap/server.rb

@@ -1,5 +1,5 @@
 class Server < BsaSoapBase
-	def get_server_id_by_name(ession_id, options = {})
+	def get_server_id_by_name(options = {})
     validate_cli_options_hash([:server_name], options)
 		integer_result = execute_cli_with_param_list(self.class, "getServerIdByName",
 			[
@@ -9,4 +9,16 @@ class Server < BsaSoapBase
 	rescue => exception
 		raise "Exception executing #{self.class} function: #{exception.to_s}"
 	end
+
+	def find_server_objects_by_group(options = {})
+		validate_cli_options_hash([:group_id, :recursive], options)
+		string_result = execute_cli_with_param_list(self.class, "findServerObjectsByGroup",
+																								 [
+																										 options[:group_id],
+																										 options[:recursive],
+																								 ])
+		string_value = get_cli_return_value(string_result)
+	rescue => exception
+		raise "Exception executing #{self.class} function: #{exception.to_s}"
+	end
 end

data/lib/bl_soap/server_group.rb

@@ -0,0 +1,12 @@
+class ServerGroup < BsaSoapBase
+	def group_name_to_id(options = {})
+		validate_cli_options_hash([:group_name], options)
+		integer_result = execute_cli_with_param_list(self.class, "groupNameToId",
+																								 [
+																										 options[:group_name]	# Fully qualified path
+																								 ])
+		integer_value = get_cli_return_value(integer_result)
+	rescue => exception
+		raise "Exception executing #{self.class} function: #{exception.to_s}"
+	end
+end

data/tests/deploy_package_spec.rb

@@ -5,6 +5,10 @@ describe 'deploy package' do
     setup_brpm_auto
   end
 
+  before(:each) do
+    cleanup_request_params
+  end
+
   it 'should deploy a package to a server group in BladeLogic' do
     params = get_default_params
     params = params.merge(get_integration_params_for_bladelogic)
@@ -26,7 +30,37 @@ describe 'deploy package' do
     params["component"] = 'EF - Java calculation engine'
     params["component_version"] = '2.0.0'
     params["request_environment"] = "development"
-    params["target_path_or_servers"] = "/Applications/#{params["application"]}/#{params["request_environment"]}/EF - java app servers - development"
+    params["server_group"] = "EF - java app servers - development"
+    params["target_path_or_servers"] = "/Applications/rpm{application}/rpm{request_environment}/rpm{server_group}"
+
+    BrpmScriptExecutor.execute_automation_script_from_gem("brpm_module_bladelogic", "deploy_package", params)
+  end
+
+  it 'should deploy a package to a component group in BladeLogic' do
+    params = get_default_params
+    params = params.merge(get_integration_params_for_bladelogic)
+
+    params["application"] = 'E-Finance'
+    params["component"] = 'EF - Java calculation engine'
+    params["component_version"] = '2.0.0'
+    params["request_environment"] = "development"
+    params["target_type"] = "Component group"
+    params["server_group"] = "EF - java app servers - development"
+
+    BrpmScriptExecutor.execute_automation_script_from_gem("brpm_module_bladelogic", "deploy_package", params)
+  end
+
+  it 'should deploy a package to a custom component group in BladeLogic' do
+    params = get_default_params
+    params = params.merge(get_integration_params_for_bladelogic)
+
+    params["application"] = 'E-Finance'
+    params["component"] = 'EF - Java calculation engine'
+    params["component_version"] = '2.0.0'
+    params["request_environment"] = "development"
+    params["target_type"] = "Component group"
+    params["server_group"] = "EF - java app servers - development"
+    params["target_path_or_servers"] = "/Applications/rpm{application}/rpm{request_environment}/rpm{server_group}"
 
     BrpmScriptExecutor.execute_automation_script_from_gem("brpm_module_bladelogic", "deploy_package", params)
   end
@@ -58,5 +92,25 @@ describe 'deploy package' do
 
     BrpmScriptExecutor.execute_automation_script_from_gem("brpm_module_bladelogic", "deploy_package", params)
   end
+
+  it 'should deploy a package in two phases: download and execute' do
+    params = get_default_params
+    params = params.merge(get_integration_params_for_bladelogic)
+
+    params["application"] = 'E-Finance'
+    params["component"] = 'EF - Java calculation engine'
+    params["component_version"] = '2.0.0'
+    params["request_environment"] = "development"
+    params["server_group"] = "EF - java app servers - development"
+    params["deploy_options"] = "Only upload package"
+
+    BrpmScriptExecutor.execute_automation_script_from_gem("brpm_module_bladelogic", "deploy_package", params)
+    expect(BrpmAuto.request_params).to have_key("#{params["component"]}_deploy_job_db_key")
+
+    params["deploy_options"] = "Only execute package"
+
+    BrpmScriptExecutor.execute_automation_script_from_gem("brpm_module_bladelogic", "deploy_package", params)
+  end
 end
 
+

data/tests/spec_helper.rb

@@ -78,6 +78,11 @@ def cleanup_package path, name
   end
 end
 
+def cleanup_request_params
+  request_params_file = "/tmp/brpm_content/request_data.json"
+  File.delete(request_params_file) if File.exist?(request_params_file)
+end
+
 def pack_response key, value
   BrpmAuto.log "pack_response: #{key}: #{value}"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brpm_module_bladelogic
 version: !ruby/object:Gem::Version
-  version: 0.1.14
+  version: 0.1.15
 platform: ruby
 authors:
 - Niek Bartholomeus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-19 00:00:00.000000000 Z
+date: 2015-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brpm_content
@@ -96,8 +96,10 @@ files:
 - lib/bl_soap/bsa_soap_base.rb
 - lib/bl_soap/bsa_soap_client.rb
 - lib/bl_soap/compliance_job.rb
+- lib/bl_soap/component_group.rb
 - lib/bl_soap/deploy_job.rb
 - lib/bl_soap/depot_group.rb
+- lib/bl_soap/group.rb
 - lib/bl_soap/job.rb
 - lib/bl_soap/job_group.rb
 - lib/bl_soap/job_management.rb
@@ -109,6 +111,7 @@ files:
 - lib/bl_soap/patch_remediation_job.rb
 - lib/bl_soap/patching_job.rb
 - lib/bl_soap/server.rb
+- lib/bl_soap/server_group.rb
 - lib/bl_soap/template.rb
 - lib/bl_soap/utility.rb
 - resource_automations/select_job.meta