brpm_content 0.1.16

data/modules/framework/write_to.rb

@@ -0,0 +1 @@
+write_to(File.read(BrpmAuto.logger.step_run_log_file_path))

data/modules/jenkins/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/jenkins/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/jenkins/automations/f2_downloadJenkinsArtifact.rb

@@ -0,0 +1,126 @@
+# Description: Download an artifact from jenkins
+#  Instructions: Modify this automation for each flavor of application deployment
+#    add any arguments you want to be available to other steps here by prefixing them with "ARG_"
+#=> 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) 
+#---------------------- f2_getRequestInputs_basic -----------------------#
+# Description: Enter Request inputs for component deploy and promotion
+# Author(s): 2015 Brady Byrd
+#---------------------- Arguments --------------------------#
+###
+# Jenkins Artifact:
+#   name: Artifact to download from Jenkins
+#   type: in-text
+#   position: A1:D1
+#   required: no
+# Jenkins Project:
+#   name: Jenkins Project
+#   type: in-external-single-select
+#   external_resource: f2_rsc_jenkinsJobs
+#   position: A2:D2
+#   required: no
+# Jenkins Build No:
+#   name: Build number from Jenkins
+#   type: in-text
+#   position: A3:C3
+#   required: no
+###
+
+#=== 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 -----------------------#
+params["direct_execute"] = true #Set for local execution
+#require 'C:/BMC/persist/automation_libs/brpm_framework.rb'
+require "#{FRAMEWORK_DIR}/brpm_framework.rb"
+rpm_load_module "jenkins"
+
+#---------------------- Methods ----------------------------#
+# Assign local variables to properties and script arguments
+def logical_list_value(arg_value, match_value)
+  result = nil
+  items = [arg_value]
+  return !(match_value =~ /#{arg_value}.*/).nil? unless arg_value =~ /(\sor\s|\sand\s|\,)/
+  list_items = arg_value.split(" or ") if arg_value.include?(" or ")
+  list_items = arg_value.split(" and ") if arg_value.include?(" and ")
+  list_items = arg_value.split(",") if arg_value.include?(",")
+  list_items.map{|l| l.strip }.each{|k| 
+    result = (match_value =~ /#{k}.*/)
+    break if !result.nil?
+  }
+  !result.nil?
+end  
+
+#---------------------- Variables --------------------------#
+# Assign local variables to properties and script arguments
+ARG_PREFIX = "ARG_"
+jenkins_project = @p.get("Jenkins Project", @p.jenkins_project)
+jenkins_build_no = @p.get("Jenkins Build No", @p.jenkins_build_no) #if passed from rest
+jenkins_build_no = "lastSuccessfulBuild" if jenkins_build_no == ""
+jenkins_artifact_value = @p.required("Jenkins Artifact")
+package_name = "jenkins_#{jenkins_build_no}"
+staging_dir = @rpm.get_staging_dir(package_name, true)
+win_curl = @p.win_curl #"C:\\bmc\\curl.exe"
+download_file = ""
+transfer_properties = {}
+
+#---------------------- Main Body --------------------------#
+# Set a property in General for each component to deploy 
+@rpm.message_box "Artifacts from Jenkins Build", "title"
+@rpm.log "Jenkins:\n\tServer: #{SS_integration_dns}\n\tJob: #{jenkins_project}\n\tBuildNo: #{jenkins_build_no}\n\tArtifact: #{jenkins_artifact_value}"
+@jenkins = Jenkins.new(SS_integration_dns, script_params, {"username" => SS_integration_username, "password" => decrypt_string_with_prefix(SS_integration_password_enc), "job_name" => jenkins_project})
+cur_server = @p.get_server_list.keys.first
+raise "No server selected" if cur_server.length < 3
+channel_root = @p.get_server_property(cur_server, "CHANNEL_ROOT")
+channel_root = "C:\\temp" if channel_root == ""
+
+rest_result = @jenkins.job_build_data(jenkins_build_no)
+build_number = rest_result["data"]["number"]
+@rpm.log "Artifacts from Build #{build_number}:"
+found = false
+rest_result["data"]["artifacts"].each do |item| 
+  @rpm.log("\t#{item["fileName"]} => #{item["relativePath"]}")
+  if logical_list_value(jenkins_artifact_value, item["fileName"])
+    found = true 
+    download_file = item["fileName"]
+  end
+end
+raise "ERROR artifact not in list: #{jenkins_artifact}" unless found
+@rpm.log "Full Build Results:"
+@rpm.log rest_result["data"].inspect
+new_name = "Regression - #{jenkins_project} - #{build_number}"
+res = @rest.update("requests", (@p.request_id.to_i - 1000).to_s, {"request" => {"name" => new_name}})
+
+# New Method out of mem errors trying to download
+if false #<100mb files only
+  @rpm.log "Downloading file: #{download_file} to #{staging_dir}"
+  @jenkins.get_build_artifact(jenkins_build_no, download_file, staging_dir)
+  package_info = @nsh.package_staged_artifacts(staging_dir, "#{package_name}.zip")
+else
+  @rpm.log "Downloading #{download_file} from Jenkins on target"
+  # http://vw-aus-rem-dv11.bmc.com:8080/job/Trunk_BRPM_INSTALLERS/356/artifact/BRPM_Windows_201505220925.zip
+  url_part = "#{jenkins_build_no}/artifact/#{download_file}"
+  url = File.join(SS_integration_dns,"job",jenkins_project, url_part)
+  target_os = @rpm.get_server_list.first[1]["os_platform"]
+  cmd = "#{win_curl} -X GET #{url} > #{channel_root}\\#{download_file}"
+  @rpm.log "Command: #{cmd}"
+  script_file = @transport.make_temp_file(cmd, "windows")
+  result = @transport.execute_script(script_file, {"transfer_properties" => transfer_properties})
+  @rpm.log "cURL Output: #{result}"
+  package_info = {"instance_path" => File.join(channel_root, download_file)}
+end
+
+@p.assign_local_param("jenkins_build_no", build_number)
+@p.assign_local_param("instance_#{@p.SS_component}", package_info)
+@p.assign_local_param("jenkins_download_package", download_file)
+@p.save_local_params # Cleanup and save
+
+

data/modules/jenkins/config.yml

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

data/modules/jenkins/lib/jenkins.rb

@@ -0,0 +1,300 @@
+require 'uri'
+require 'net/http'
+
+# Base class for working with Subversion
+class Jenkins
+  
+  # Initializes an instance of the class
+  #
+  # ==== Attributes
+  #
+  # * +url+ - url for Jenkins server...
+  # * +params+ - params hash
+  # * +options+ - hash of options includes:...
+  #   job_name - jenkins job name (from url)...
+  #   username - jenkins user username...
+  #   password - jenkins user password...
+  #   verbose - true for verbose output (default = false)...
+  #   simulate - simulate command - echo it (default = false)...
+  #
+  def initialize(url, options, compat_options = {})
+    self.extend Utilities
+    if options.has_key?("SS_output_dir")
+      BrpmAuto.log "Load for this class has changed, no longer necessary to send params as 2nd argument"
+      options = compat_options 
+    end
+    @url = url
+    @username = get_option(options,"username")
+    @password = get_option(options,"password")
+    @job_name = get_option(options,"job_name")
+    @verbose = get_option(options,"verbose", false)
+    @simulate = get_option(options,"simulate", false)
+  end
+  
+  # Calls the jenkins server via rest
+  # Uses the current project and auth information
+  # ==== Attributes
+  # * +options+ - a hash of options, includes:
+  #  url_part - the fragment of the url past the project ex.
+  #  for this url: http://vw-aus-rem-dv11.bmc.com:8080/job/BRPM_4.6-D_WAR/231/api/json
+  #  the fragment is "231/api/json"
+  #  username - override existing username
+  #  password - override existing password
+  #  method - get/post, defaults to get
+  #
+  # ==== Returns
+  #
+  # * +rest_result+ - hash of information including status (success-failure) and data - the rest result 
+  #
+  def jenkins_rest_call(url_part, options = {})
+    result = {"status" => "Failure"}
+    options["username"] = @username unless options.has_key?("username")
+    options["password"] = @password unless options.has_key?("password")
+    method = get_option(options,"method") == "post" ? "post" : "get"
+    url = File.join(@url,"job",@job_name, url_part)
+    BrpmAuto.log "Full url [#{method}]: #{url}" if @simulate || @verbose      
+    unless @simulate
+      response = rest_call(url, method, options) 
+      BrpmAuto.log "Response: #{response.inspect}" if @verbose
+      result["data"] = "#{response["status"]}: #{response["message"]}" unless response["status"] == "success"
+      result["data"] = response["data"] if response["status"] == "success"
+      result["status"] = response["status"]
+    else
+      result["status"] = "simulate"
+    end
+    result
+  end
+  
+  def set_job_name(new_name)
+    @job_name = new_name
+    new_name
+  end
+  
+  # Returns the array of Build Jobs
+  #
+  # ==== Returns
+  #
+  # * +job_list+ - an array of hashes with job information
+  #
+  def job_list
+    options = {"username" => @username, "password" => @password}
+    response = rest_call("#{@url}/api/json", "get", options)
+    return "ERROR" if response["status"] == "ERROR"
+    response["data"]
+  end
+
+  # Returns the data of a Build Job
+  #
+  # ==== Returns
+  #
+  # * +job_data+ - a hash of job information
+  #
+  def job_data
+    jenkins_rest_call("/api/json")
+  end
+
+  # Returns the data of a build
+  # ==== Attributes
+  #
+  # * +build_no+ - the id of a build (omit for latest build)
+  #
+  # ==== Returns
+  #
+  # * +job_data+ - a hash of job information
+  #
+  def job_build_data(build_no = nil)
+    build_no = "lastBuild" if build_no.nil?
+    jenkins_rest_call("#{build_no}/api/json")
+  end
+
+  # Returns the status of a build
+  # ==== Attributes
+  #
+  # * +build_no+ - the id of a build (omit for latest build)
+  #
+  # ==== Returns
+  #
+  # * +hash+ - still_building (ture/false) and status (success/fail)
+  #
+  def build_status(build_no = nil)
+    response = job_build_data(build_no)
+    # Now parse for the status and build id
+    #log "Raw Result: #{response.inspect}"
+    ans = {}
+    ans["still_building"] = response["data"]["building"]
+    ans["success"] = response["status"]
+    ans
+  end
+
+  # Returns the raw results of a build
+  # ==== Attributes
+  #
+  # * +build_no+ - the id of a build (omit for latest build)
+  # * +get_link+ - returns a link to the results instead (optional - default = false)
+  #
+  # ==== Returns
+  #
+  # * +job_data+ - text of build output
+  #
+  def build_results(build_no, get_link = false)
+    url_part = "#{build_no}/consoleText"
+    if get_link
+      response = File.join(@url,"job",@job_name, url_part)
+    else
+      response = jenkins_rest_call(url_part, {"headers" => {}})
+    end
+    response
+  end
+
+  # Monitors a running build
+  # ==== Attributes
+  #
+  # * +build_no+ - the id of a build (omit for latest build)
+  #
+  # ==== Returns
+  #
+  # * +job_data+ - a hash of job information
+  #
+  def monitor_build(build_no)
+    # start with an initial build result
+    # Now parse for the status and build id
+    max_time = MaxBuildTime
+    sleep_interval = 15
+    result = build_status(build_no)
+    results = "Initial test: Build Number: #{build_no}, Status - building: #{result["still_building"].to_s}, result: #{result["success"]}\n"
+    # Now Check to see if the token matches
+    build_match = true
+    #build_match = response.include?(ss_token) if use_token_match # Enable this if using token matching
+    BrpmAuto.message_box "Monitoring Build Progress (id: #{build_no})"
+    if build_no.to_i > 0 && result["still_building"] == true && build_match
+      start_time = Time.now
+      elapsed = 0
+      complete = false
+      until elapsed > (max_time * 60) do
+        result = build_status(build_no)
+        results += "Status - building: #{result["still_building"].to_s}, result: #{result["success"]}\n"
+        if result["still_building"] == false
+          BrpmAuto.log "Success - #{result["success"]}"
+          complete = true if result["success"] == "SUCCESS"
+          complete = false if result["success"] != "SUCCESS"
+          break
+        else
+          elapsed = Time.now - start_time
+          BrpmAuto.log "Still building ...elapsed: #{elapsed.to_i.to_s}, pausing for #{sleep_interval.to_s} seconds"
+          sleep sleep_interval
+        end
+        elapsed = Time.now - start_time
+      end
+    elsif  result["success"] != "SUCCESS"
+      BrpmAuto.log "Build failed on initial parameters, either could not retrieve build id or token did not match output"
+      complete = false
+    else
+      BrpmAuto.log "Build Successful"
+      complete = true
+    end
+    complete
+  end
+
+  # Performs a build on the active project
+  # ==== Attributes
+  #
+  # * +build_arguments+ - a hash of the build arguments
+  #
+  # ==== Returns
+  #
+  # * +job_data+ - a hash of job information
+  #
+  def build(build_arguments = {})
+    # Fetch the next build number
+    build_details = job_data
+    next_build = build_details["data"]["nextBuildNumber"]
+    url_part = "build"
+    options = {"method" => post, "data" => build_arguments}
+    reponse = jenkins_rest_call(url_part, options)
+    last_build = next_build  
+    result = "Web server response: " + response["header"]
+    BrpmAuto.log result
+    unless response["header"].include?("HTTPFound 302") #response["status"] == "failure"
+      BrpmAuto.log "Command_Failed: Build did not launch"
+      return -1
+    end
+    launched = false
+    10.times do 
+      test_result = job_build_data(last_build)
+      if test_result["data"].is_a?(String) && test_result["data"].include?("failure")
+        BrpmAuto.log "Job not ready waiting..."
+        sleep(6)
+      else
+        launched = true
+        break
+      end
+    end
+    if launched
+      return last_build
+    else
+      BrpmAuto.log "Command_Failed: Build did not launch in 60 seconds"
+      return -1
+    end
+  end
+  
+  
+  # Returns the status of a build
+  # ==== Attributes
+  #
+  # * +build_no+ - jenkins build id
+  # * +artifact_name+ - name from the build artifacts list in job data
+  # * +target_path+ - folder to download to (default is SS_output_dir)
+  #
+  # ==== Returns
+  #
+  # * +status+ - success or failure
+  #
+  def get_build_artifact(build_no, artifact_name, target_path = nil)
+    # http://vw-aus-rem-dv11.bmc.com:8080/job/BRPM_4.6-D_WAR/lastSuccessfulBuild/artifact/brpm_231.war
+    url_part = "#{build_no}/artifact/#{artifact_name}"
+    url = File.join(@url,"job",@job_name, url_part)
+    target_path = @params["SS_output_dir"] if target_path.nil?
+    fetch_artifact(url, target_path)
+  end
+  
+  private
+  
+  def download_file(artifact_url, download_path)
+    package_name = artifact_url.split("/").last
+    uri = URI(artifact_url)  
+    Dir.chdir(download_path)
+    Net::HTTP.start(uri.host, uri.port) do |http|
+      request = Net::HTTP::Get.new uri.request_uri
+      BrpmAuto.log "Downloading: #{artifact_url} to #{download_path}"
+      fil = open(package_name, "wb")
+      begin
+        http.request_get(uri.request_uri) do |resp|
+          resp.read_body do |segment|
+            fil.write(segment)
+          end
+        end
+      ensure
+        fil.close()
+      end
+    end
+    "Downloaded to: #{download_path}"
+  end
+  
+  def fetch_artifact(url, download_path)
+    _response = Net::HTTP.get_response( URI.parse( url ) )
+    package_name = url.split("/").last
+    case _response
+    when Net::HTTPSuccess then
+      response = download_file(url, download_path)
+      _response
+    when Net::HTTPRedirection then
+      location = _response['location']
+      BrpmAuto.log "\tRedirected to #{location}"
+      response = download_file(location, download_path)
+      _response
+    else
+      _response.value
+    end
+  end
+    
+end