brpm_content 0.1.16

data/modules/jenkins/resource_automations/f2_rsc_jenkinsJobs.rb

@@ -0,0 +1,58 @@
+# Description: Resource to choose the tech stack(components) for deployment
+#=> About the f2 framework: upon loading the automation, several utility classes will be available
+#   @rpm: the BrpmAutomation class, @p: the Param class, @rest: the BrpmRest class and 
+#   @transport: the Transport class - the transport class will be loaded dependent on the SS_transport property value (ssh, nsh or baa) 
+
+#=== General Integration Server: DevOps_Jenkins ===#
+# [integration_id=2]
+SS_integration_dns = "http://vw-aus-rem-dv11.bmc.com:8080"
+SS_integration_username = "bbyrd"
+SS_integration_password = "-private-"
+SS_integration_details = ""
+SS_integration_password_enc = "__SS__Cj1Jek1QTjBaTkYyUQ=="
+#=== End ===#
+#---------------------- Declarations ------------------------------#
+@script_name_handle = "choose_jenkins"
+FRAMEWORK_DIR = "/opt/bmc/persist/automation_lib"
+eval File.open("#{FRAMEWORK_DIR}/brpm_framework.rb").read
+
+#---------------------- Methods --------------------------------#
+
+#---------------------- Main Body --------------------------#
+  
+def execute(script_params, parent_id, offset, max_records)
+  #returns all the environments of a component
+  require "#{FRAMEWORK_DIR}/lib/brpm_automation.rb"
+  @rpm = BrpmAutomation.new(script_params)
+  require "#{FRAMEWORK_DIR}/lib/jenkins.rb"
+  log_it "Starting Automation"
+  begin
+    #get_request_params
+    @jenkins = Jenkins.new(SS_integration_dns, script_params, {"username" => SS_integration_username, "password" => decrypt_string_with_prefix(SS_integration_password_enc), "job_name" => "none"})
+    temps = {}
+    rest_result = @jenkins.job_list
+    return default_list("NoProjectsReturned") unless rest_result.has_key?("jobs")
+    rest_result["jobs"].each do |job|
+      url = job["url"]
+      job_uri = url[(url.index("job/") + 4)..(url.length - 1)]
+      temps[job_uri] = job["name"]
+    end
+    #@request_params["jenkins_jobs"] = rest_result["jobs"]
+    log_it temps
+    
+    result = hashify_list(temps)
+    select_hash = {}
+    select_hash["Select"] = ""
+    result.unshift(select_hash)
+    write_to result.inspect
+    #save_request_params
+    log_it(result)
+  rescue Exception => e
+    log_it "Error: #{e.message}\n#{e.backtrace}"
+  end
+  return result
+end
+
+def import_script_parameters
+  { "render_as" => "List" }
+end

data/modules/jira/automations/add_comment.rb

@@ -0,0 +1,4 @@
+params = BrpmAuto.params
+
+BrpmAuto.log "Adding a comment for issue '#{params["issue_id"]}'..."
+JiraRestClient.new.add_comment(params["issue_id"], params["comment"])

data/modules/jira/automations/add_comment.txt

@@ -0,0 +1,23 @@
+###
+# issue_id:
+#   name: Issue Id
+#   required: yes
+# comment:
+#   name: Comment
+#   required: yes
+###
+
+#=== BMC Application Automation Integration Server: JIRA ===#
+# [integration_id=4]
+#=== End ===#
+
+require "#{params["SS_script_support_path"]}/git_repos/brpm_content/modules/framework/brpm_script_executor.rb"
+
+params["direct_execute"] = "true"
+
+params["SS_integration_dns"] = SS_integration_dns
+params["SS_integration_username"] = SS_integration_username
+params["SS_integration_password_enc"] = SS_integration_password_enc
+params["SS_integration_details"] = YAML.load(SS_integration_details)
+
+BrpmScriptExecutor.execute_automation_script("jira", "add_comment", params)

data/modules/jira/automations/create_release.rb

@@ -0,0 +1,4 @@
+params = BrpmAuto.params
+
+BrpmAuto.log "Creating a new option for plan '#{params["release_name"]}' in the JIRA dropdown custom field with id #{params["jira_release_field_id"]}..."
+JiraRestClient.new.create_option_for_dropdown_custom_field(params["jira_release_field_id"], params["release_name"])

data/modules/jira/automations/create_release.txt

@@ -0,0 +1,23 @@
+###
+# jira_release_field_id:
+#   name: JIRA release field id
+#   required: yes
+# release_name:
+#   name: Release name
+#   required: yes
+###
+
+#=== BMC Application Automation Integration Server: JIRA ===#
+# [integration_id=4]
+#=== End ===#
+
+require "#{params["SS_script_support_path"]}/git_repos/brpm_content/modules/framework/brpm_script_executor.rb"
+
+params["direct_execute"] = "true"
+
+params["SS_integration_dns"] = SS_integration_dns
+params["SS_integration_username"] = SS_integration_username
+params["SS_integration_password_enc"] = SS_integration_password_enc
+params["SS_integration_details"] = YAML.load(SS_integration_details)
+
+BrpmScriptExecutor.execute_automation_script("jira", "create_release", params)

data/modules/jira/automations/delete_release.rb

@@ -0,0 +1,4 @@
+params = BrpmAuto.params
+
+BrpmAuto.log "Deleting option for plan '#{params["release_name"]}' in the JIRA dropdown custom field with id #{params["jira_release_field_id"]}..."
+JiraRestClient.new.delete_option_for_dropdown_custom_field(params["jira_release_field_id"], params["release_name"])

data/modules/jira/automations/delete_release.txt

@@ -0,0 +1,23 @@
+###
+# jira_release_field_id:
+#   name: JIRA release field id
+#   required: yes
+# release_name:
+#   name: Release name
+#   required: yes
+###
+
+#=== BMC Application Automation Integration Server: JIRA ===#
+# [integration_id=4]
+#=== End ===#
+
+require "#{params["SS_script_support_path"]}/git_repos/brpm_content/modules/framework/brpm_script_executor.rb"
+
+params["direct_execute"] = "true"
+
+params["SS_integration_dns"] = SS_integration_dns
+params["SS_integration_username"] = SS_integration_username
+params["SS_integration_password_enc"] = SS_integration_password_enc
+params["SS_integration_details"] = YAML.load(SS_integration_details)
+
+BrpmScriptExecutor.execute_automation_script("jira", "delete_release", params)

data/modules/jira/automations/transition_issue.rb

@@ -0,0 +1,4 @@
+params = BrpmAuto.params
+
+BrpmAuto.log "Setting the status of issue #{params["issue_id"]} to #{params["target_issue_status"]}"
+JiraRestClient.new.set_issue_to_status(params["issue_id"], params["target_issue_status"])

data/modules/jira/automations/transition_issue.txt

@@ -0,0 +1,23 @@
+###
+# issue_id:
+#   name: Issue Id
+#   required: yes
+# target_issue_status:
+#   name: Target issue status
+#   required: yes
+###
+
+#=== BMC Application Automation Integration Server: JIRA ===#
+# [integration_id=4]
+#=== End ===#
+
+require "#{params["SS_script_support_path"]}/git_repos/brpm_content/modules/framework/brpm_script_executor.rb"
+
+params["direct_execute"] = "true"
+
+params["SS_integration_dns"] = SS_integration_dns
+params["SS_integration_username"] = SS_integration_username
+params["SS_integration_password_enc"] = SS_integration_password_enc
+params["SS_integration_details"] = YAML.load(SS_integration_details)
+
+BrpmScriptExecutor.execute_automation_script("jira", "transition_issues_for_request", params)

data/modules/jira/automations/transition_issues_for_request.rb

@@ -0,0 +1,29 @@
+brpm_rest_client = BrpmRestClient.new
+params = BrpmAuto.params
+
+BrpmAuto.log  "Getting the tickets that are linked to the request..."
+tickets = brpm_rest_client.get_tickets_by_request_id(params.rest_request_id)
+
+if tickets.count == 0
+  BrpmAuto.log "This request has no tickets, nothing further to do."
+  return
+end
+
+unless params["target_issue_status"]
+  BrpmAuto.log  "Getting the stage of this request..."
+  request_with_details = brpm_rest_client.get_request_by_id(params.rest_request_id)
+
+  if request_with_details.has_key?("plan_member")
+    stage_name = request_with_details["plan_member"]["stage"]["name"]
+
+    params["target_issue_status"] = "Deployed to #{stage_name}"
+  else
+    BrpmAuto.log "The request is not part of a plan so not processing the tickets."
+    return
+  end
+end
+
+tickets.each do |ticket|
+  BrpmAuto.log "Setting the status of issue #{ticket["foreign_id"]} to #{params["target_issue_status"]}"
+  JiraRestClient.new.set_issue_to_status(ticket["foreign_id"], params["target_issue_status"])
+end

data/modules/jira/automations/transition_issues_for_request.txt

@@ -0,0 +1,20 @@
+###
+# target_issue_status:
+#   name: Target issue status
+#   required: yes
+###
+
+#=== BMC Application Automation Integration Server: JIRA ===#
+# [integration_id=4]
+#=== End ===#
+
+require "#{params["SS_script_support_path"]}/git_repos/brpm_content/modules/framework/brpm_script_executor.rb"
+
+params["direct_execute"] = "true"
+
+params["SS_integration_dns"] = SS_integration_dns
+params["SS_integration_username"] = SS_integration_username
+params["SS_integration_password_enc"] = SS_integration_password_enc
+params["SS_integration_details"] = YAML.load(SS_integration_details)
+
+BrpmScriptExecutor.execute_automation_script("jira", "transition_issues_for_request", params)

data/modules/jira/automations/transition_issues_for_run.rb

@@ -0,0 +1,26 @@
+brpm_rest_client = BrpmRestClient.new
+params = BrpmAuto.params
+
+run_id = params["request_run_id"] || params["run_id"]
+
+BrpmAuto.log  "Getting the tickets that are linked to the requests of this run..."
+tickets = brpm_rest_client.get_tickets_by_run_id_and_request_state(run_id, "completed")
+
+if tickets.count == 0
+  BrpmAuto.log "This run has no tickets, nothing further to do."
+  return
+end
+
+unless params["target_issue_status"]
+  if params["request_plan_stage"]
+    params["target_issue_status"] = "Deployed to #{params["request_plan_stage"]}"
+  else
+    BrpmAuto.log "The request is not part of a plan so not processing the tickets."
+    return
+  end
+end
+
+tickets.each do |ticket|
+  BrpmAuto.log "Setting the status of issue #{ticket["foreign_id"]} to #{params["target_issue_status"]}"
+  JiraRestClient.new.set_issue_to_status(ticket["foreign_id"], params["target_issue_status"])
+end

data/modules/jira/automations/transition_issues_for_run.txt

@@ -0,0 +1,20 @@
+###
+# target_issue_status:
+#   name: Target issue status
+#   required: yes
+###
+
+#=== BMC Application Automation Integration Server: JIRA ===#
+# [integration_id=4]
+#=== End ===#
+
+require "#{params["SS_script_support_path"]}/git_repos/brpm_content/modules/framework/brpm_script_executor.rb"
+
+params["direct_execute"] = "true"
+
+params["SS_integration_dns"] = SS_integration_dns
+params["SS_integration_username"] = SS_integration_username
+params["SS_integration_password_enc"] = SS_integration_password_enc
+params["SS_integration_details"] = YAML.load(SS_integration_details)
+
+BrpmScriptExecutor.execute_automation_script("jira", "transition_issues_for_run", params)

data/modules/jira/automations/update_release.rb

@@ -0,0 +1,4 @@
+params = BrpmAuto.params
+
+BrpmAuto.log "Updating option for plan from '#{params["old_release_name"]}' to '#{params["new_release_name"]}' in the JIRA dropdown custom field with id #{params["jira_release_field_id"]}..."
+JiraRestClient.new.update_option_for_dropdown_custom_field(params["jira_release_field_id"], params["old_release_name"], params["new_release_name"])

data/modules/jira/automations/update_release.txt

@@ -0,0 +1,26 @@
+###
+# jira_release_field_id:
+#   name: JIRA release field id
+#   required: yes
+# old_release_name:
+#   name: Old release name
+#   required: yes
+# new_release_name:
+#   name: New release name
+#   required: yes
+###
+
+#=== BMC Application Automation Integration Server: JIRA ===#
+# [integration_id=4]
+#=== End ===#
+
+params["direct_execute"] = "true"
+
+require "#{params["SS_script_support_path"]}/git_repos/brpm_content/modules/framework/brpm_script_executor.rb"
+
+params["SS_integration_dns"] = SS_integration_dns
+params["SS_integration_username"] = SS_integration_username
+params["SS_integration_password_enc"] = SS_integration_password_enc
+params["SS_integration_details"] = YAML.load(SS_integration_details)
+
+BrpmScriptExecutor.execute_automation_script("jira", "update_release", params)

data/modules/jira/config.yml

@@ -0,0 +1,7 @@
+dependencies:
+ - brpm
+
+integration_servers:
+ - JIRA
+
+version: 1.0.0

data/modules/jira/lib/jira_rest_client.rb

@@ -0,0 +1,185 @@
+require 'json'
+require 'uri'
+
+#=============================================================================#
+# Jira Rest Module                                                            #
+#-----------------------------------------------------------------------------#
+# The REST module currently supports the 6.0.8 version of the Jira API as     #
+# well as a rest client which supports both HTTP and HTTPS                    #
+#=============================================================================#
+
+class JiraRestClient
+  def initialize(integration_settings = BrpmAuto.integration_settings)
+    @url = integration_settings.dns
+    @username = integration_settings.username
+    @password = integration_settings.password
+
+    @api_url = "#{@url}/rest/api/2"
+  end
+
+  # POST /rest/api/2/issue/{issueIdOrKey}/comment
+  def add_comment(issue_id, comment_body = 'Dummy Comment')
+    cmmnt = {:body => comment_body}
+    Rest.post("#{@api_url}/issue/#{issue_id}/comment", cmmnt, { :username => @username, :password => @password })["response"]
+  end
+
+  # GET /rest/api/2/issue/{issueIdOrKey}/transitions[?expand=transitions.fields]
+  def get_issue_transitions(issue_id, expand_transition = false)
+    url = "#{@api_url}/issue/#{issue_id}/transitions"
+    if expand_transition
+      url = "#{url}?expand=transitions.fields"
+    end
+    Rest.get(url, { :username => @username, :password => @password })["response"]
+  end
+
+  # GET /rest/api/2/issue/{issueIdOrKey}/transitions?transitionId={transistion_id}[&expand=transitions.fields]
+  def get_issue_transition(issue_id, transition_id, expand_transition = false)
+    url = "#{@api_url}/issue/#{issue_id}/transitions?transitionId=#{transition_id}"
+    if expand_transition
+        url = "#{url}&expand=transitions.fields"
+    end
+    Rest.get(url, { :username => @username, :password => @password })["response"]
+  end
+
+  # POST /rest/api/2/issue/{issueIdOrKey}/transitions[?expand=transitions.fields]
+  def post_issue_transition(issue_id, transition_id, comment = 'simple comment', expand_transition = false)
+    url = "#{@api_url}/issue/#{issue_id}/transitions"
+    if expand_transition
+      url = "#{url}?expand=transitions.fields"
+    end
+    transition = {:update=>{:comment =>[{:add => {:body => "#{comment}"}}]}, :transition => {:id => "#{transition_id}"}}
+    #Simple post as only return code is returned
+    Rest.post(url, transition, { :username => @username, :password => @password })["response"]
+  end
+
+  # GET /rest/api/2/project
+  def get_projects()
+    Rest.get("#{@api_url}/project", { :username => @username, :password => @password })["response"]
+  end
+
+  def set_issue_to_status(issue_id, status)
+    BrpmAuto.log "Getting the possible transitions for issue #{issue_id}..."
+    result = get_issue_transitions(issue_id)
+    transitions = result["transitions"]
+
+    transition = transitions.find { |transition| transition["to"]["name"] == status }
+
+    if transition
+      BrpmAuto.log "Issuing transition #{transition["name"]} to update the status of the issue to #{status}..."
+      issues = post_issue_transition(issue_id, transition["id"])
+    else
+      BrpmAuto.log "This ticket does not have a transition to status #{status} currently. Leaving it in its current state."
+    end
+  end
+
+  # GET /rest/api/2/search?jql=[Some Jira Query Language Search][&startAt=<num>&maxResults=<num>&fields=<field,field,...>&expand=<param,param,...>]
+  def search(jql, start_at = 0, max_results = 50, fields = '', expand = '')
+    url = "#{@api_url}/search?jql=#{jql}"
+    url = "#{url}&startAt=#{start_at}" unless start_at == 0
+    url = "#{url}&maxResults=#{max_results}" unless max_results == 50
+    url = "#{url}&fields=#{fields}" unless fields == ''
+    url = "#{url}&expand=#{expand}" unless expand == ''
+
+    Rest.get(url, { :username => @username, :password => @password })["response"]
+  end
+
+  # GET /rest/api/2/issue/{issueIdOrKey}[?fields=<field,field,...>&expand=<param,param,...>]
+  def get_issue(issue_id, fields = '', expand = '')
+    added = false
+    url = "#{@api_url}/issue/#{issue_id}"
+    if not fields.eql? ''
+      url = "#{url}?fields=#{fields}"
+      added = true
+    end
+    if not expand.eql? ''
+      if added
+        url = "#{url}&expand=#{expand}"
+      else
+        url = "#{url}?expand=#{expand}"
+      end
+    end
+    Rest.get(url, { :username => @username, :password => @password })["response"]
+  end
+
+  def get_option_for_dropdown_custom_field(custom_field_id, option_value)
+    # NOTE: this method assumes that the "Customfield Editor Plugin" is installed on the JIRA instance and that permission was granted for the custom field
+
+    url = "#{@url}/rest/jiracustomfieldeditorplugin/1.1/user/customfieldoptions/customfield_#{custom_field_id}"
+    result = Rest.get(url, { :username => @username, :password => @password })
+
+    if result["status"] == "success"
+      custom_field_options = result["response"]
+      return custom_field_options.find { |custom_field_option| custom_field_option["optionvalue"] == option_value }
+    else
+      if result["code"] == 404
+        return nil
+      else
+        raise "Error getting option: #{result["error_message"]}"
+      end
+    end
+  end
+
+  def create_option_for_dropdown_custom_field(custom_field_id, option_value)
+    # NOTE: this method assumes that the "Customfield Editor Plugin" is installed on the JIRA instance and that permission was granted for the custom field
+
+    custom_field_option = get_option_for_dropdown_custom_field(custom_field_id, option_value)
+
+    if custom_field_option
+      BrpmAuto.log "The option already exists, nothing to do."
+      return custom_field_option
+    end
+
+    url = "#{@url}/rest/jiracustomfieldeditorplugin/1.1/user/customfieldoption/customfield_#{custom_field_id}"
+    data = {:optionvalue => option_value }
+
+    result = Rest.post(url, data, { :username => @username, :password => @password })
+
+    if result["status"] == "success"
+      return result["response"]
+    else
+      raise "Could not create option: #{result["error_message"]}"
+    end
+  end
+
+  def update_option_for_dropdown_custom_field(custom_field_id, old_option_value, new_option_value)
+    # NOTE: this method assumes that the "Customfield Editor Plugin" is installed on the JIRA instance and that permission was granted for the custom field
+
+    custom_field_option_to_update = get_option_for_dropdown_custom_field(custom_field_id, old_option_value)
+
+    if custom_field_option_to_update
+      url = "#{@url}/rest/jiracustomfieldeditorplugin/1.1/user/customfieldoption/customfield_#{custom_field_id}/#{custom_field_option_to_update["id"]}"
+      data = {:optionvalue => new_option_value }
+
+      result = Rest.put(url, data, { :username => @username, :password => @password })
+
+      if result["status"] == "success"
+        return result["response"]
+      else
+        raise "Could not update option: #{result["error_message"]}"
+      end
+    else
+      BrpmAuto.log "The option doesn't exist yet, creating it instead of updating..."
+      create_option_for_dropdown_custom_field(custom_field_id, new_option_value)
+    end
+  end
+
+  def delete_option_for_dropdown_custom_field(custom_field_id, option_value)
+    # NOTE: this method assumes that the "Customfield Editor Plugin" is installed on the JIRA instance and that permission was granted for the custom field
+
+    custom_field_option_to_delete = get_option_for_dropdown_custom_field(custom_field_id, option_value)
+
+    if custom_field_option_to_delete
+      url = "#{@url}/rest/jiracustomfieldeditorplugin/1.1/user/customfieldoption/customfield_#{custom_field_id}/#{custom_field_option_to_delete["id"]}"
+
+      result = Rest.delete(url, { :username => @username, :password => @password })
+
+      if result["status"] == "success"
+        return result["response"]
+      else
+        raise "Could not delete option: #{result["error_message"]}"
+      end
+    else
+      BrpmAuto.log "The option doesn't exist, nothing to do."
+    end
+  end
+end