brpm_module_demo 0.1.16 → 0.1.17

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODI2YWVlY2VlYmIxMzk3YmIwNjMwOTQwNTIxYmM2ZjA0ODg3MDIzZg==
+    MWE3NzIxY2U2MTE0ODJiYjZhZmVmYTVmM2VlODUwODFjYzhmOGE0ZQ==
   data.tar.gz: !binary |-
-    MDQyYThjNzkwZGRjODRmZTdmNDRkZmNlOWU1MjMyN2MyODFmZWEyZg==
+    OGY1MGYxNjI2Yjk4ZjQ1ZjQ2NDI1OWM4M2ExMjg4MDU2MWQ4OTZkMw==
 SHA512:
   metadata.gz: !binary |-
-    NTdmZWJjNGM3M2VmYmQ2MjA4ZjhjN2IzNGZhNjczMjY1MWIyZDJiMmQ2ODgx
-    NDQ2MDM4YTI4OGFhNDg1ZmEwZThjY2RiNWUwMjNjNWQ4MGMzMzJkMjVkZjYw
-    ZjE3YTMzODJkNGI3ZjllOGNkY2U5MTI3YzNjZjU2Mjg0MmI1MzU=
+    ZmYxNmYzYmMxNjEzYzdhZmY4MTRlYmZlYzJiOTUwOTNmY2IxYjJjOTRmMTBj
+    MWQ3MTE3ZjE0YTYxM2Q4ZDE4NzY5OTcwZTY3ZTdkZTlmMDI0OGVjOTM4OTRj
+    ODIxNjhhNjI3ZDM0NTVjNTJmNjA5NjE4NmI3ZjgyZDM3YjM4NGM=
   data.tar.gz: !binary |-
-    MTJhMzQwZmI5MWFhMzM0ZGNhNWVmM2I1OWExOGEzMGU0MGFhNTlmY2FiOGY0
-    M2YwMDVhMWU2ZGI1MjU4Y2U2NmQ3NTIyOGQ4MDdmODg4MGNlOWIzNzcwZDIz
-    YjNhNThlMjczNGZmYTIxOWE3NjdkODIxZDg2YmM2MTY5MjUxYzQ=
+    ZjZkOWFkN2Q4ZmNiMzM2Y2E0MDdkZTU2MjU5NzRjNjNmYTMzMGY4M2M4NWI1
+    YmUzNTIwNTA0MmE5YmQ1NzkyNTk2MTVkOTA3MDE4MzBiZjAyZjg4YzVkMmY3
+    ZGY5ZTNlMjRlYTNjNzY2ZDE0NDIwZDg3ODVmYTA3MDdiNDA4ZmI=

data/README.md

@@ -4,4 +4,4 @@
 
 [![Gem Version](https://badge.fury.io/rb/brpm_module_demo.png)](http://badge.fury.io/rb/brpm_module_demo)
 
-This repository represents an module for a fictive customer "Demo", to be used on top of the [BRPM content framework](https://github.com/BMC-RLM/brpm_content_framework). It contains customer-specific logic to integrate BRPM and JIRA in both directions: creating BRPM tickets from created or updated JIRA issues and udating the state of JIRA issues after a request was deployed into an environment.
+This repository represents an module for a fictive customer "Demo", to be used on top of the [BRPM content framework](https://github.com/BMC-RLM/brpm_content_framework). It contains customer-specific logic to integrate JIRA, Jenkins and ServiceNow to BRPM.

data/config.yml

@@ -1,8 +1,9 @@
 dependencies:
   - brpm_module_brpm
   - brpm_module_jira
+  - brpm_module_servicenow
 
-version: 0.1.16
+version: 0.1.17
 
 author: Niek Bartholomeus
 email: niek.bartholomeus@gmail.com

data/lib/integrations/brpm/process_event_handler_event.rb

@@ -4,7 +4,10 @@ require_relative "../../jira_mappings"
 def process_event(event)
   @brpm_rest_client = BrpmRestClient.new("http://#{ENV["EVENT_HANDLER_BRPM_HOST"]}:#{ENV["EVENT_HANDLER_BRPM_PORT"]}/brpm", ENV["EVENT_HANDLER_BRPM_TOKEN"])
 
-  if event.has_key?("request")
+  if event.has_key?("step")
+    BrpmAuto.log "The event is for a step #{event["event"][0]}..."
+    process_step_event(event)
+  elsif event.has_key?("request")
     BrpmAuto.log "The event is for a request #{event["event"][0]}..."
     process_request_event(event)
   elsif event.has_key?("run")
@@ -16,11 +19,36 @@ def process_event(event)
   end
 end
 
+def process_step_event(event)
+  if event["event"][0] == "create"
+    step = event["step"].find { |item| item["type"] == "new" }
+
+    BrpmAuto.log "Step '#{step["name"][0]}' created"
+  elsif event["event"][0] == "update"
+    step_old_state = event["step"].find { |item| item["type"] == "old" }
+    step_new_state = event["step"].find { |item| item["type"] == "new" }
+
+    if step_old_state["aasm-state"][0] != step_new_state["aasm-state"][0] or step_new_state["aasm-state"][0] == "complete" #TODO bug when a request is moved to complete the old state is also reported as complete
+      BrpmAuto.log "Step '#{step_new_state["name"][0]}' moved from state '#{step_old_state["aasm-state"][0]}' to state '#{step_new_state["aasm-state"][0]}'"
+
+      if step_new_state["aasm-state"][0] == "complete" or step_new_state["aasm-state"][0] == "problem"
+        if step_new_state["property-values"][0].has_key?("add-logs-to-request-params") and step_new_state["property-values"][0]["add-logs-to-request-params"] == "true"
+          add_logs_to_ticket_in_servicenow(step_new_state)
+        end
+      end
+    end
+  end
+end
+
 def process_request_event(event)
   if event["event"][0] == "create"
     request = event["request"].find { |item| item["type"] == "new" }
 
     BrpmAuto.log "Request '#{request["name"][0]}' created"
+
+    if request["wiki-url"][0] == "ServiceNow change request"
+      add_link_to_ticket_in_servicenow(request)
+    end
   elsif event["event"][0] == "update"
     request_old_state = event["request"].find { |item| item["type"] == "old" }
     request_new_state = event["request"].find { |item| item["type"] == "new" }
@@ -86,9 +114,19 @@ def process_plan_event(event)
   end
 end
 
+
 #################################
 # BRPM
 
+def get_default_params
+  params = {}
+  params["brpm_url"] = "http://#{ENV["EVENT_HANDLER_BRPM_HOST"]}:#{ENV["EVENT_HANDLER_BRPM_PORT"]}/brpm"
+  params["brpm_api_token"] = ENV["EVENT_HANDLER_BRPM_TOKEN"]
+
+  params["log_file"] = ENV["EVENT_HANDLER_LOG_FILE"]
+  params
+end
+
 def process_app_release_event(request)
   release_request_stage_name = "Release"
   release_request_environment_name = "development"
@@ -116,21 +154,17 @@ end
 #################################
 # JIRA
 
-def get_default_params
-  params = {}
+def get_default_params_for_jira
+  params = get_default_params
   params["SS_integration_dns"] = ENV["EVENT_HANDLER_JIRA_URL"]
   params["SS_integration_username"] = ENV["EVENT_HANDLER_JIRA_USERNAME"]
   params["SS_integration_password"] = ENV["EVENT_HANDLER_JIRA_PASSWORD"]
 
-  params["brpm_url"] = "http://#{ENV["EVENT_HANDLER_BRPM_HOST"]}:#{ENV["EVENT_HANDLER_BRPM_PORT"]}/brpm"
-  params["brpm_api_token"] = ENV["EVENT_HANDLER_BRPM_TOKEN"]
-
-  params["log_file"] = ENV["EVENT_HANDLER_LOG_FILE"]
   params
 end
 
 def update_tickets_in_jira_by_request(request)
-  params = get_default_params
+  params = get_default_params_for_jira
   params["request_id"] = (request["id"][0]["content"].to_i + 1000).to_s
 
   request_with_details = @brpm_rest_client.get_request_by_id(request["id"][0]["content"])
@@ -145,7 +179,7 @@ def update_tickets_in_jira_by_request(request)
 end
 
 def update_tickets_in_jira_by_run(run)
-  params = get_default_params
+  params = get_default_params_for_jira
   params["run_id"] = run["id"][0]["content"]
 
   BrpmAuto.log "Getting the stage of this run..."
@@ -158,7 +192,7 @@ def update_tickets_in_jira_by_run(run)
 end
 
 def create_release_in_jira(plan)
-  params = get_default_params
+  params = get_default_params_for_jira
   params["jira_release_field_id"] = ENV["EVENT_HANDLER_JIRA_RELEASE_FIELD_ID"]
   params["release_name"] = plan["name"][0]
 
@@ -166,7 +200,7 @@ def create_release_in_jira(plan)
 end
 
 def update_release_in_jira(old_plan, new_plan)
-  params = get_default_params
+  params = get_default_params_for_jira
   params["jira_release_field_id"] = ENV["EVENT_HANDLER_JIRA_RELEASE_FIELD_ID"]
   params["old_release_name"] = old_plan["name"][0]
   params["new_release_name"] = new_plan["name"][0]
@@ -175,10 +209,49 @@ def update_release_in_jira(old_plan, new_plan)
 end
 
 def delete_release_in_jira(plan)
-  params = get_default_params
+  params = get_default_params_for_jira
   params["jira_release_field_id"] = ENV["EVENT_HANDLER_JIRA_RELEASE_FIELD_ID"]
   params["release_name"] = plan["name"][0]
 
   BrpmScriptExecutor.execute_automation_script("brpm_module_jira", "delete_release", params)
 end
 #################################
+
+#################################
+# ServiceNow
+
+def get_default_params_for_servicenow
+  params = get_default_params
+  params["SS_integration_dns"] = ENV["EVENT_HANDLER_SERVICENOW_URL"]
+  params["SS_integration_username"] = ENV["EVENT_HANDLER_SERVICENOW_USERNAME"]
+  params["SS_integration_password"] = ENV["EVENT_HANDLER_SERVICENOW_PASSWORD"]
+
+  params
+end
+
+def add_link_to_ticket_in_servicenow(request)
+  request_with_details = @brpm_rest_client.get_request_by_id(request["id"][0]["content"])
+
+  request_params = RequestParams.new_for_request("#{ENV["BRPM_HOME"]}/automation_results", request_with_details["apps"][0]["name"], request_with_details["id"].to_i + 1000)
+
+  params = get_default_params_for_servicenow
+  params["change_request_id"] = request_params["change_request_id"]
+
+  params["fields"] = { "u_url_brpm_request" => "#{params["brpm_url"]}/requests/#{request_with_details["id"]}" }
+
+  BrpmScriptExecutor.execute_automation_script("brpm_module_servicenow", "update_change_request", params)
+end
+
+def add_logs_to_ticket_in_servicenow(step)
+  step_with_details = @brpm_rest_client.get_step_by_id(step["id"][0]["content"])
+
+  request_params = RequestParams.new_for_request("#{ENV["BRPM_HOME"]}/automation_results", step_with_details["installed_component"]["app"]["name"], step["request"]["id"].to_i + 1000)
+
+  params = get_default_params_for_servicenow
+  params["change_request_id"] = request_params["change_request_id"]
+
+  params["fields"] = { "u_string_brpm_log_note" => request_params["logs"].map { |k, v| "#{k}:\n#{v}"} }
+
+  BrpmScriptExecutor.execute_automation_script("brpm_module_servicenow", "update_change_request", params)
+end
+#################################

data/lib/integrations/jira/README.md

@@ -0,0 +1,25 @@
+# JIRA to BRPM integration
+## Intro
+This integration will automatically synchronize JIRA issues with BRPM tickets when an issue is created, updated or deleted in JIRA. This is just a first step in integrating JIRA with BRPM. It can easily be extended to cover more complex integration needs. Integrations from BRPM to JIRA can be found in the [JIRA module](https://github.com/BMC-RLM/brpm_module_jira). 
+
+## Getting started
+The integration is done with webhooks: we will set up a tiny HTTP server that listens on a certain mount point (in this case "webhooks") and have JIRA send its notifications as POSTs to this server. The process_webhook_events.rb script will then take action based on the contents of the notifications.
+
+### Running the webhook receiver
+The ```process_webhook_event.rb``` script should be used with a [webhook_receiver](https://github.com/BMC-RLM/brpm_content_framework/blob/master/bin/webhook_receiver). The easiest way to set this up is with a wrapper script like ```run_jira_webhook_receiver.sh``` that sets the necessary environment variables. Copy it to a location of your choice and adapt the environment variables where needed.
+
+Execute the wrapper script in daemon mode: ```nohup /path/to/run_jira_webhook_receiver.sh &```
+
+### Mapping the fields
+The mapping between an issue in JIRA and a ticket in BRPM can be configured in the [jira_mappings.rb](https://github.com/BMC-RLM/brpm_module_demo/blob/master/lib/jira_mappings.rb) script. Make sure to restart the webhook receiver after each change to this script.
+
+### Configuring the webhook in JIRA
+- First of all make sure that your projects in JIRA have exactly the same name as your applications in BRPM.
+ 
+- Create a WebHook (in System > Advanced > WebHooks) and set the url to http://your-server:port/webhooks. You can tweak the other fields to your specific needs as it's all quite self-explanatory, just make sure to "include the details" of the issues.
+
+### Creating an issue in JIRA
+Voila, we're all set. Now create a change request in ServiceNow and see how it triggers a request in BRPM!
+
+
+

data/lib/integrations/jira/run_jira_webhook_receiver.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+# mandatory settings
+export WEBHOOK_RECEIVER_PORT=8089
+export WEBHOOK_RECEIVER_MOUNT_POINT=webhooks
+export WEBHOOK_RECEIVER_LOG_FILE=/tmp/webhook_receiver.log
+export WEBHOOK_RECEIVER_PROCESS_EVENT_SCRIPT=integrations/jira/process_webhook_event.rb
+
+# custom settings
+export WEBHOOK_RECEIVER_BRPM_HOST=localhost
+export WEBHOOK_RECEIVER_BRPM_PORT=8088
+export WEBHOOK_RECEIVER_BRPM_TOKEN=???
+export WEBHOOK_RECEIVER_INTEGRATION_ID=<the id of the JIRA integration in BRPM>
+export WEBHOOK_RECEIVER_JIRA_RELEASE_FIELD_ID=<the id of a custom dropdown field in JIRA that contains the release plans>
+
+webhook_receiver

data/lib/integrations/servicenow/README.md

@@ -1,16 +1,20 @@
-# Service-Now to BRPM integration
+# ServiceNow to BRPM integration
 ## Intro
-This integration will automatically create a request in BRPM when a new change request is created in Service-Now. This is just a first step in integration Service-Now with BRPM. It can easily be extended to cover more complex integration needs. 
+This integration will automatically create a request in BRPM when a change request is created in ServiceNow. This is just a first step in integrating ServiceNow with BRPM. It can easily be extended to cover more complex integration needs. Integrations from BRPM to ServiceNow can be found in the [ServiceNow module](https://github.com/BMC-RLM/brpm_module_servicenow). 
 
 ## Getting started
-### Running the webhook receiver as a daemon
-This script should be used with a [webhook_receiver wrapper](https://github.com/BMC-RLM/brpm_content_framework/blob/master/infrastructure/scripts/run_webhook_receiver.sh). Set the environment variable ```WEBHOOK_RECEIVER_PROCESS_EVENT_SCRIPT``` to the location of this script and execute it in daemon mode: ```nohup ./run_webhook_receiver.sh &```
+The integration is done with webhooks: we will set up a tiny HTTP server that listens on a certain mount point (in this case "webhooks") and have ServiceNow send its notifications as POSTs to this server. The process_webhook_events.rb script will then take action based on the contents of the notifications.  
+
+### Running the webhook receiver
+The ```process_webhook_event.rb``` script should be used with a [webhook_receiver](https://github.com/BMC-RLM/brpm_content_framework/blob/master/bin/webhook_receiver). The easiest way to set this up is with a wrapper script like ```run_servicenow_webhook_receiver.sh``` that sets the necessary environment variables. Copy it to a location of your choice and adapt the environment variables where needed.
+
+Execute the wrapper script in daemon mode: ```nohup /path/to/run_servicenow_webhook_receiver.sh &```
 
 ### Creating a request template in BRPM
 Create one or more request templates with the name ```[Template] Self Service - <automation type>``` where automation_type can be "Reboot server", etc.
 
-### Configuring Service-Now
-- Create a new dropdown field for a change request with the name u_choice_automation_type and configure a nmber of choices like "Reboot server" etc.
+### Configuring ServiceNow
+- Create a new dropdown field for a change request with the name u_choice_automation_type and configure a number of choices like "Reboot server" etc.
 
 - Create an outbound REST Message and set the endpoint to http://your-server:port/webhooks (only the POST HTTP method is needed so you may delete the others)
 
@@ -18,7 +22,7 @@ Create one or more request templates with the name ```[Template] Self Service -
 
 You can use this content as an example:
 ```
-{"change_request": {"number":"${number}", "automation_type":"${automation_type}", "cmdb_ci":"${cmdb_ci}"}}
+{"change_request": {"id":"${id}", "number":"${number}", "automation_type":"${automation_type}", "cmdb_ci":"${cmdb_ci}"}}
 ```
 
 - Copy the generated javascript code from the "Preview Script Usage" link
@@ -32,9 +36,10 @@ As an example of a javascript piece of code:
 function onAfter(current, previous) {
 	try {
 		var r = new sn_ws.RESTMessageV2('BRPM', 'post');
+		r.setStringParameter('id', current.sys_id);
 		r.setStringParameter('number', current.number);
 		r.setStringParameter('automation_type', current.u_choice_automation_type);
-		r.setStringParameter('cmdb_ci', current.cmdb_ci);
+		r.setStringParameter('cmdb_ci', current.cmdb_ci.getDisplayValue());
 		var response = r.execute();
 		var responseBody = response.getBody();
 		var httpStatus = response.getStatusCode();
@@ -45,8 +50,8 @@ function onAfter(current, previous) {
 }
 ```
 
-### Creating a change request
-Voila, we're all set. Now create a change request in Service-Now and see how it triggers a request in BRPM!
+### Creating a change request in ServiceNow
+Voila, we're all set. Now create a change request in ServiceNow and see how it triggers a request in BRPM!
 
 
 

data/lib/integrations/servicenow/run_servicenow_webhook_receiver.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+# mandatory settings
+export WEBHOOK_RECEIVER_PORT=8089
+export WEBHOOK_RECEIVER_MOUNT_POINT=webhooks
+export WEBHOOK_RECEIVER_LOG_FILE=/tmp/webhook_receiver.log
+export WEBHOOK_RECEIVER_PROCESS_EVENT_SCRIPT=integrations/servicenow/process_webhook_event.rb
+
+# custom settings
+export WEBHOOK_RECEIVER_BRPM_HOST=localhost
+export WEBHOOK_RECEIVER_BRPM_PORT=8088
+export WEBHOOK_RECEIVER_BRPM_TOKEN=???
+export WEBHOOK_RECEIVER_INTEGRATION_ID=<the id of the ServiceNow integration in BRPM>
+
+webhook_receiver

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brpm_module_demo
 version: !ruby/object:Gem::Version
-  version: 0.1.16
+  version: 0.1.17
 platform: ruby
 authors:
 - Niek Bartholomeus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-25 00:00:00.000000000 Z
+date: 2015-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brpm_content_framework
@@ -52,6 +52,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: brpm_module_servicenow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -101,9 +115,12 @@ files:
 - lib/integrations/jenkins/spec/api/plans_spec.rb
 - lib/integrations/jenkins/spec/api/requests_spec.rb
 - lib/integrations/jenkins/spec/spec_helper.rb
+- lib/integrations/jira/README.md
 - lib/integrations/jira/process_webhook_event.rb
+- lib/integrations/jira/run_jira_webhook_receiver.sh
 - lib/integrations/servicenow/README.md
 - lib/integrations/servicenow/process_webhook_event.rb
+- lib/integrations/servicenow/run_servicenow_webhook_receiver.sh
 - lib/jira_mappings.rb
 - module.gemspec
 - tests/gemspec_spec.rb