brpm_module_servicenow 0.0.10 → 0.0.11

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MGMyYjczYTA0NTMzNDU5NjQ5YTc5YWQ1ODRmY2Q2Mzg4MDg1NzE0Zg==
+    MzY1YTBiMDVhMzNlNzBmOGExMjJjNDEyMDdjM2Y4Zjc4MGM1OGMzMA==
   data.tar.gz: !binary |-
-    NzA2ZjJhYzlkNzJlMzI2ZmU5NTgwZDgwMDA4MGU5NDA5MTNjMzNkOQ==
+    YjNhMjY4NjE1NmY0ZjlmNTBmY2RkMzU5YjJiODgxZDEwYTI5ZWQ0OA==
 SHA512:
   metadata.gz: !binary |-
-    YWZlNGMyNGY1ZmUyYjcyZjkxNDQ0NzZlODE2YTZmNTk0YTA3MmI5N2MyYWJl
-    Y2VmNGMyMmRhZTM4MjkxZTM0YWUzNWU4MDhiYzlmODE0YTY0YmEyMTI3MzIx
-    YTI2YzIxMDdkODk2OGY3MzJlNjIzZmI3NmZhOGNmNzcxY2UwMTQ=
+    YmFlMTA5MmM2ZWExZmFmMjdiZWVkODUzZmU0NDJmMmJmOGYxM2VlMGZlZjcy
+    MjQ2NDcxZTZhOTUxNzJhYmY4MmVmZWQzOTNlMThjMTQzMjBhOWVkYjIxNjg3
+    YTY0OGY2MDRkN2NkMWQwYzFjNmZiYjIwZDE2ODEzZjEyMzVlZGY=
   data.tar.gz: !binary |-
-    NzkwMmI2ZGE1MTFjZDgyMTQ2ZGE3MTliMWIzM2YwYmMwM2I3NGY0OTNhM2Q4
-    M2UxY2I3ZTBjMGQ3OWEzMTc4OGM0ZmI2NTc3OTBmYTA3MWJjZjhjZWI1OTRi
-    MGI1NjFhYjlhNzIxOTU3NmM3Nzk5MTZiODYzOTQ2ZjQxYjA5Mjk=
+    NmM2NDQxMDhmZDIwZTQ3MDZiOWE5MjdjYzAyMmIwOWVhNTkwOTFmMTQwZDJl
+    YWQxNmRiNzIxODA4MmYxNmNiNTFhODQwZDg4MmNiYmJkYTZmNzYyNGNmYmEz
+    Y2RmOGQ5ODY1MzRlMTEwYjhhNjNmOWI2M2IxMjNiNjU2ZTdkOGY=

data/automations/await_approval_of_change_request.meta

@@ -0,0 +1,12 @@
+params:
+  change_request_id:
+    name: Change request id (optional, if not specified the change request id of the request param will be used)
+    position: A1:C1
+  change_request_url:
+    name: Change request url
+    type: out-url
+    position: A1:E1
+
+
+integration_server_type: ServiceNow
+

data/automations/await_approval_of_change_request.rb

@@ -0,0 +1,35 @@
+change_request_id = BrpmAuto.all_params["change_request_id"]
+
+raise "No change request id was specified." if change_request_id.nil? or change_request_id.empty?
+
+snow_rest_client = SnowRestClient.new
+
+max_time = 15*60 # seconds
+checking_interval = 15 #seconds
+
+start_time = Time.now
+elapsed = 0
+
+BrpmAuto.log "Starting the monitoring loop for change request #{change_request_id} with an interval of #{checking_interval} seconds and a maximum time of #{max_time} seconds ..."
+until elapsed > max_time
+  change_request = snow_rest_client.get_record("change_request", change_request_id)
+
+  if change_request["approval"] == "approved"
+    BrpmAuto.log "The change request is approved."
+    break
+  end
+
+  if change_request["approval"] == "rejected"
+    raise "The change request is rejected."
+  end
+
+  BrpmAuto.log "\tWaiting(#{elapsed.floor.to_s}) - Current status: #{change_request["approval"]}"
+  sleep(checking_interval)
+  elapsed = Time.now - start_time
+end
+
+if elapsed > max_time
+  raise "Maximum time: #{max_time}(secs) reached."
+end
+
+BrpmAuto.pack_response("change_request_url", "#{BrpmAuto.integration_settings.dns}/nav_to.do?uri=change_request.do?sys_id=#{change_request_id}")

data/automations/create_change_request.meta

@@ -0,0 +1,15 @@
+params:
+  short_description:
+    name: Short description
+    position: A1:F1
+  description:
+    name: Description
+    position: A2:F2
+  change_request_url:
+    name: Change request url
+    type: out-url
+    position: A1:E1
+
+
+integration_server_type: ServiceNow
+

data/automations/create_change_request.rb

@@ -0,0 +1,16 @@
+snow_rest_client = SnowRestClient.new
+
+fields = {}
+fields["short_description"] = BrpmAuto.params["short_description"]
+fields["description"] = BrpmAuto.params["description"]
+fields["u_brpm_url"] = "#{BrpmAuto.params["base_url"]}/requests/#{BrpmAuto.params["request_id"]}"
+
+change_request = snow_rest_client.create_record("change_request", fields)
+
+fields = {}
+fields["approval"] = "requested"
+snow_rest_client.update_record("change_request", change_request["sys_id"], fields)
+
+BrpmAuto.pack_response("change_request_url", "#{BrpmAuto.integration_settings.dns}/nav_to.do?uri=change_request.do?sys_id=#{change_request["sys_id"]}")
+
+BrpmAuto.request_params["change_request_id"] = change_request["sys_id"]

data/automations/update_change_request.meta

@@ -2,9 +2,12 @@ params:
   change_request_id:
     name: Change request id (optional, if not specified the change request id of the request param will be used)
     position: A1:C1
-  fields:
-    name: Fields
+  comments:
+    name: Comments
     position: A2:F2
+  work_notes:
+    name: Work notes
+    position: A3:F3
   change_request_url:
     name: Change request url
     type: out-url

data/automations/update_change_request.rb

@@ -2,7 +2,11 @@ change_request_id = BrpmAuto.all_params["change_request_id"]
 
 raise "No change request id was specified." if change_request_id.nil? or change_request_id.empty?
 
+fields = {}
+fields["comments"] = BrpmAuto.params["comments"]
+fields["work_notes"] = BrpmAuto.params["work_notes"]
+
 snow_rest_client = SnowRestClient.new
-snow_rest_client.update_record("change_request", change_request_id, BrpmAuto.all_params["fields"])
+snow_rest_client.update_record("change_request", change_request_id, fields)
 
 BrpmAuto.pack_response("change_request_url", "#{BrpmAuto.integration_settings.dns}/nav_to.do?uri=change_request.do?sys_id=#{change_request_id}")

data/config.yml

@@ -1,4 +1,4 @@
-version: 0.0.10
+version: 0.0.11
 
 author: Niek Bartholomeus
 email: niek.bartholomeus@gmail.com

data/lib/snow_rest_client.rb

@@ -23,6 +23,30 @@ class SnowRestClient
     end
   end
 
+  def get_record(table, id)
+    url = "#{@api_url}/#{table}/#{id}"
+
+    result = Rest.get(url, { :username => @username, :password => @password })
+
+    unless result["status"] == "success"
+      raise "Could not get the record: #{result["error_message"]}"
+    end
+
+    result["response"]["result"]
+  end
+
+  def create_record(table, fields)
+    url = "#{@api_url}/#{table}"
+
+    result = Rest.post(url, fields, { :username => @username, :password => @password })
+
+    unless result["status"] == "success"
+      raise "Could not create the record: #{result["error_message"]}"
+    end
+
+    result["response"]["result"]
+  end
+
   def update_record(table, id, fields)
     url = "#{@api_url}/#{table}/#{id}"
 
@@ -32,6 +56,6 @@ class SnowRestClient
       raise "Could not update the record: #{result["error_message"]}"
     end
 
-    result["response"]
+    result["response"]["result"]
   end
 end

data/tests/await_approval_of_change_request_spec.rb

@@ -0,0 +1,20 @@
+require_relative "spec_helper"
+
+describe 'await approval of issue' do
+  before(:all) do
+    setup_brpm_auto
+    cleanup_request_params
+  end
+
+  describe '' do
+    it 'should await the approval of a change request in ServiceNow' do
+      params = get_default_params
+      params = params.merge(get_integration_params_for_servicenow)
+
+      params["change_request_id"] = "6e262e730f8d120072588b9ae1050e62"
+
+      BrpmScriptExecutor.execute_automation_script("brpm_module_servicenow", "await_approval_of_change_request", params)
+    end
+  end
+end
+

data/tests/create_change_request_spec.rb

@@ -0,0 +1,24 @@
+require_relative "spec_helper"
+
+describe 'create issue' do
+  before(:all) do
+    setup_brpm_auto
+    cleanup_request_params
+  end
+
+  describe '' do
+    it 'should create a change request in ServiceNow' do
+      params = get_default_params
+      params = params.merge(get_integration_params_for_servicenow)
+
+      params["short_description"] = "This change request is created by BRPM"
+      params["description"] = "And a bit more blablabla"
+
+      params["base_url"] = "http://brpm.pulsar-it.be:29418/brpm"
+      params["request_id"] = "2199"
+
+      BrpmScriptExecutor.execute_automation_script("brpm_module_servicenow", "create_change_request", params)
+    end
+  end
+end
+

data/tests/spec_helper.rb

@@ -25,9 +25,15 @@ end
 
 def get_integration_params_for_servicenow
   params = {}
-  params["SS_integration_dns"] = 'https://dev14275.service-now.com'
+  params["SS_integration_dns"] = 'https://dev17019.service-now.com'
   params["SS_integration_username"] = 'admin'
   params["SS_integration_password"] = ENV["SERVICENOW_PASSWORD"]
 
   params
 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
+

data/tests/transition_change_request_spec.rb

@@ -3,6 +3,7 @@ require_relative "spec_helper"
 describe 'transition issue' do
   before(:all) do
     setup_brpm_auto
+    cleanup_request_params
   end
 
   describe '' do
@@ -10,7 +11,7 @@ describe 'transition issue' do
       params = get_default_params
       params = params.merge(get_integration_params_for_servicenow)
 
-      params["change_request_id"] = "2f31ef3b0fbb42000d3f758ce1050edd"
+      params["change_request_id"] = "af5362730f8d120072588b9ae1050e5c"
 
       params["target_change_request_status"] = "Pending"
       BrpmScriptExecutor.execute_automation_script("brpm_module_servicenow", "transition_change_request", params)

data/tests/update_change_request_spec.rb

@@ -0,0 +1,23 @@
+require_relative "spec_helper"
+
+describe 'update issue' do
+  before(:all) do
+    setup_brpm_auto
+    cleanup_request_params
+  end
+
+  describe '' do
+    it 'should update a change request in ServiceNow' do
+      params = get_default_params
+      params = params.merge(get_integration_params_for_servicenow)
+
+      params["change_request_id"] = "6e262e730f8d120072588b9ae1050e62"
+
+      params["comments"] = "Hello world"
+      params["work_notes"] = "Lots of work to do"
+
+      BrpmScriptExecutor.execute_automation_script("brpm_module_servicenow", "update_change_request", params)
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brpm_module_servicenow
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Niek Bartholomeus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-02 00:00:00.000000000 Z
+date: 2016-01-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: brpm_content_framework
@@ -65,6 +65,10 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- automations/await_approval_of_change_request.meta
+- automations/await_approval_of_change_request.rb
+- automations/create_change_request.meta
+- automations/create_change_request.rb
 - automations/transition_change_request.meta
 - automations/transition_change_request.rb
 - automations/update_change_request.meta
@@ -72,8 +76,11 @@ files:
 - config.yml
 - lib/snow_rest_client.rb
 - module.gemspec
+- tests/await_approval_of_change_request_spec.rb
+- tests/create_change_request_spec.rb
 - tests/spec_helper.rb
 - tests/transition_change_request_spec.rb
+- tests/update_change_request_spec.rb
 homepage: https://github.com/BMC-RLM/brpm_module_servicenow
 licenses:
 - MIT