brpm_content_framework 0.2.48 → 0.2.49

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MDcyOTBlZDU1ZWQxNjY2NTJmZDVkNzdkOWRiZDgxMmIzMWZkMTAzNw==
+    ZTk5NDdmY2U5MTJhYTk2NjFiMzUxZTI4MDliYzRkYTlhMjE5Y2IyZQ==
   data.tar.gz: !binary |-
-    YzBmYjBjMWM4Yzk0MzNkYzQ0YWNlNGQ1NGZiZTg3YzBhYmU4NDc3Mg==
+    YjBlMGVmODM4YmFiNThkYmRlNDM4OTc4NDgxN2Q0ZmRlYWY2MGE3OQ==
 SHA512:
   metadata.gz: !binary |-
-    YmM5MTk3NWNlNjA2YTc2NmUxMTE3NjlhYjYzODVjYjc1YzFmNDA4ZTRmMDdm
-    ZmY1NmIyYWYxNTFlZDUyNDczYTE5MTFjMTZiYTg2OGVkNmU0MTRkY2QzYzEy
-    MDFkNmQ2N2FkMjRhZWQ4ZTczNDRkNjgzODIxNzQ2OTU4NDZlMDk=
+    ZmNmZjRmZmVhNjYwOTAzZjIxZTc3NmEzYTNkOGFlZDI4ZWVhODhiMjZkYzBk
+    ODMwNWU0NWFkNTUxMDkxMzEzNTU5Y2M3NTViNmEyYTViMGQwN2JmNTc5ODg2
+    YmIyOTIxN2VhNzQ2OWQ4NDcyYzY5YTViNTQ0ZmEzNmE1M2RiYjc=
   data.tar.gz: !binary |-
-    NDM1MGM0OWMyNzE2ZmFkMTQ5MzRmYmRiZmY2MGQ4YzljMjA5NjBiZmM5NjZj
-    MDA3NDI4NjJkMTMyYjViNDNhODM5MTI0YjA4NGI2ZDk0Y2M0YzViZTA3Nzg2
-    NTE0NzU4ZGY4YWQ3YjgxMTE0ODE3ZGE1OTBlZDk3YjcxN2NlNjE=
+    N2JhNmQ0OWY0NTY1MWZhZTg5NGQ2Yjc3MzM5YmQ2NzM4OWYwYTMwMmEwNWEw
+    ZTA4NjFiMzY3MmNlMzczZDUxNjVhNDdmMGM2NWI5OGM4MmE4MzU4M2U2ZWRm
+    Yjg3MjY2OTM5OTE0OGNiMjZiMzdhMGY1ZmU5ZTFjMTAwZTUwZmQ=

data/README.md

@@ -11,9 +11,10 @@ It is designed around a number of core concepts like modularity, re-usability, t
 ## Getting started
 
 ### Installation
+By default the automation scripts will be executed by the jruby interpreter that is included with the BRPM install. See the end of this section if you want to use a custom ruby interpreter instead.
 
 #### environment variables
-First of all, make sure that the necessary environment variables are set on the BRPM instance, e.g. for a default BRPM installation:
+First of all, make sure that the necessary environment variables are set, e.g. for a default BRPM installation:
 ```shell
 export BRPM_HOME=/opt/bmc/RLM
 export JAVA_HOME="$BRPM_HOME/lib/jre"
@@ -23,7 +24,7 @@ export GEM_HOME="$BRPM_HOME/modules"
 export PATH="$GEM_HOME/bin:$JRUBY_HOME/bin:$PATH"
 ```
 
-If BRPM is installed on a custom location you can modify the first line accordingly. The PATH variable is modified to make sure the ruby scripts that come with the modules are in the PATH.  
+If BRPM is installed on a custom location you can modify the first line accordingly. The PATH variable is modified to make sure the ruby scripts that come with the modules are in the PATH. 
 
 #### .brpm
 Then create a file .brpm with the following contents in the root directory of the user account that runs BRPM:
@@ -68,6 +69,22 @@ brpm_install /path/to/module-name-x.x.x.gem
 
 The gem file of the module can be found on rubygems.org. 
 
+#### custom ruby interpreter
+To improve the performance of the automation scripts you can also decide to have the scripts executed by a ruby interpreter of your choice.
+
+In that case make sure that the location of the ruby command is added to the PATH environment variable. There is no more need to set the JAVA_HOME or JRUBY_HOME environment variables anymore, the remaining environment variables can be set as following:
+```shell
+export BRPM_HOME=/opt/bmc/RLM
+export GEM_HOME="$BRPM_HOME/modules"
+
+export PATH="$GEM_HOME/bin:$PATH"
+```
+
+Create a file server.yml in $BRPM_HOME/config and add the following key/value pair to it, in YAML format:
+```
+automation_scripts_ruby_command: "ruby"
+```
+
 ### Usage
 Once the module is installed you can immediately start using its contained automation scripts by linking the requests' steps to them.  
 
@@ -134,7 +151,8 @@ gem sources -a http://your-private-gem-server:9292/
 
 You can simply execute (or debug if your ruby IDE supports it, e.g. RubyMine) the scripts on your development machine. See further the section on Testability.
 
-For an example see the [Bladelogic](https://github.com/BMC-RLM/brpm_module_bladelogic) module.
+See the [recorded demo](https://youtu.be/08NuePJakGE) for a step-by-step explanation on how you can easily create your own module.
+
  
 ## Re-usability
 
@@ -327,6 +345,19 @@ For an example of how to synchronize JIRA issues with BRPM tickets see the [web
 
 BRPM comes with a messaging engine that can send a notification for many events like the creation or update or requests, plans etc. The framework contains an [event handler script](https://github.com/BMC-RLM/brpm_content_framework/blob/master/bin/event_handler) with an associated [bash wrapper script](https://github.com/BMC-RLM/brpm_content_framework/blob/master/infrastructure/scripts/run_event_handler.sh) that can be set up to listen to these incoming events. You can pass it a custom script that can take care of processing the received events. Typically this event processing script will then execute the appropriate automation scripts.
 
+The messaging can be enabled by activating the "Create queue messages for integrations?" checkbox in the Systems - Settings - General section of BRPM and by adding the following sections to the file ```$BRPM_HOME/server/jboss/standalone/configuration/standalone.xml```:
+In the ```<acceptors>``` section of ```<hornetq-server>```:
+```
+<netty-acceptor name="stomp-acceptor" socket-binding="messaging-stomp">
+    <param key="protocol" value="stomp"/>
+</netty-acceptor>
+```
+ 
+In the ```<socket-binding-group name="standard-sockets">``` section:
+```
+<socket-binding name="messaging-stomp" port="61613"/>
+```
+
 A messaging solution can be used for extending the out-of-the-box BRPM feature set or for synchronizing BRPM owned data with other systems. 
 
 For an example of how to update the status of the associated JIRA tickets after a deployment request finished successfully see the [event handler script](https://github.com/BMC-RLM/brpm_module_demo/integrations/brpm/process_event_handler_event.rb) (search for update_tickets_in_jira_by_request) that could be used for this purpose. As soon as the script is run in daemon mode it will start receiving events when requests change status. 

data/config.yml

@@ -1,4 +1,4 @@
-version: 0.2.48
+version: 0.2.49
 author: Niek Bartholomeus
 email: niek.bartholomeus@gmail.com
 homepage: https://github.com/BMC-RLM/brpm_content_framework

data/infrastructure/config/server.yml

@@ -1,4 +1,6 @@
 # This file should be located in BRPM_HOME/config
 # See the README for more information on how to use this file
-execute_automation_scripts_in_docker: "if_docker_image_exists" #possible values: never, if_docker_image_exists, always
+execute_automation_scripts_in_docker: "if_docker_image_exists" # possible values: never, if_docker_image_exists, always
+automation_scripts_ruby_command: "ruby" # specify ruby when you want to execute the automation scripts from a non-jruby interpreter, defaults to jruby
+
 my_parameter: "abc"

data/infrastructure/scripts/restore_database.sh

@@ -24,7 +24,7 @@ $BRPM_HOME/pgsql/bin/dropdb -U $BRPM_DB_USER $BRPM_DB_NAME
 echo "Creating database $BRPM_DB_NAME..."
 $BRPM_HOME/pgsql/bin/createdb -O $BRPM_DB_USER -E UTF8 -U $BRPM_DB_USER $BRPM_DB_NAME
 
-echo "Restoring database from /root/database_backups/brpm_database_dump_$DATE.sql to $BRPM_DB_NAME..."
+echo "Restoring database from $DUMP_FILE to $BRPM_DB_NAME..."
 $BRPM_HOME/pgsql/bin/psql -U $BRPM_DB_USER -d $BRPM_DB_NAME -f $DUMP_FILE
 
 echo "Restarting BRPM..."

data/infrastructure/silent_install_options_upgrade_4.6.txt

@@ -53,24 +53,31 @@
 # -J BMC_DB_PORT=1433 # SQL_SERVER
 # -J BMC_DB_PORT=1521 # Oracle
 -J BMC_DB_NAME=bmc_rpm_db
--J BMC_DB_USER_NAME=brpmuser
+-J BMC_DB_USER_NAME=rlm_user
 -J BMC_DB_USER_PASSWORD=DES\:a751b8161238d051e4e986421d24d2dcd1cff043003f0e35
 
 #------------ BRPM Migration Information ----------#
 # Options true, false
 -J BMC_MIGRATE_EXISTING_BRPM_INSTALLATION=true
--J BMC_REFERENCE_BRPM_INSTALLATION_PATH=/opt/bmc/RLM/releases/4.4.00.07/RPM
+
 # Options USE_SAME_DATABASE, USE_SAME_DATABASE_EMPTY_DATABASE_CONTENTS
 -J BMC_BRPM_DATABASE_MIGRATION=USE_SAME_DATABASE
-# Options 4.4.00, BRLM_4_3_00, BRPM_2_6
--J BMC_BRPM_MIGRATION_VERSION=4.4.00
+
+-J BMC_AUTOMATION_RESULTS=COPY_DATA
+
 # Options COPY_CONFIGURATION, DISCARD
 -J BMC_OTHER_SETTINGS=COPY_CONFIGURATION
+
+-J BMC_REFERENCE_BRPM_INSTALLATION_PATH=/opt/bmc/RLM/releases/4.6.00.05/RPM
+
+# Options 4.4.00, BRLM_4_3_00, BRPM_2_6
+-J BMC_BRPM_MIGRATION_VERSION=4.6.00
+
 -J BMC_BRPM_SKIP_DB_MODIFICATION_FOR_CLUSTER=false
 
 #------------ Email Information ----------#
--J BMC_SENDMAIL_FROM=admin@example.com
 -J MAIL_NOTIFICATIONS=USE_SMTP
+-J BMC_SENDMAIL_FROM=admin@example.com
 -J BMC_SMTP_HOST=smtp.mycorp.com
 -J BMC_SMTP_PORT=25
 -J BMC_SMTP_DOMAIN_NAME=mycorp.com

data/lib/brpm_script_executor.rb

@@ -64,6 +64,13 @@ class BrpmScriptExecutor
           file.puts(params_for_process.to_yaml)
         end
 
+        destination_utf_file = File.expand_path("file_in_utf.rb", script_support_path)
+        source_utf_file = File.expand_path("../../config/initializers/file_in_utf.rb", script_support_path)
+        if File.exists?(source_utf_file) and File.size(destination_utf_file) != File.size(source_utf_file)
+          BrpmAuto "Copying file_in_utf.rb from RPM/config/initializers to #{script_support_path}..."
+          FileUtils.copy(source_utf_file, destination_utf_file)
+        end
+
         if use_docker
           BrpmAuto.log "Executing the script in a docker container..."
           command = "docker run -v #{working_path}:/workdir -v #{automation_results_path}:/automation_results -v #{script_support_path}:/script_support --rm bmcrlm/#{modul}:#{module_version} /docker_execute_automation \"#{name}\" \"/workdir/#{params_file}\" \"#{automation_type}\""
@@ -101,7 +108,7 @@ class BrpmScriptExecutor
 require \\"brpm_script_executor\\"
 BrpmScriptExecutor.execute_automation_script_from_other_process(\\"#{modul}\\", \\"#{name}\\", \\"#{params_path}\\", \\"#{automation_type}\\", \\"#{parent_id}\\", \\"#{offset}\\", \\"#{max_records}\\")
 EOR
-          command = "#{env_var_gem_home}#{env_var_bundler}ruby -e \"#{ruby_command}\""
+          command = "#{env_var_gem_home}#{env_var_bundler}#{BrpmAuto.global_params["automation_scripts_ruby_command"] || "jruby"} -e \"#{ruby_command}\""
         end
 
         result = Bundler.with_clean_env do

data/tests/brpm_script_executor_spec.rb

@@ -35,18 +35,24 @@ describe 'BRPM Script Executor' do
   # Note: the following tests will run the automation scripts in a separate process and will therefore use an already installed brpm_content_framework module,
   # either the version from their Gemfile/Gemfile.lock or the latest, but not the one from source code
   it "should execute an automation script in a separate process inside a bundler context" do
-    result = BrpmScriptExecutor.execute_automation_script_in_separate_process("brpm_module_test", "test_ruby", get_default_params)
+    params = get_default_params
+    params["home_dir"] = "#{File.dirname(__FILE__)}/customer_include"
+
+    result = BrpmScriptExecutor.execute_automation_script_in_separate_process("brpm_module_test", "test_ruby", params)
 
     expect(result).to be_truthy
   end
 
   it "should execute an automation script in a separate process outside a bundler context" do
+    params = get_default_params
+    params["home_dir"] = "#{File.dirname(__FILE__)}/customer_include"
+
     module_version = BrpmScriptExecutor.get_latest_installed_version(@module_name)
     module_gem_path = BrpmScriptExecutor.get_module_gem_path(@module_name, module_version)
     gemfile_path = "#{module_gem_path}/Gemfile"
 
     FileUtils.move(gemfile_path, "#{gemfile_path}_tmp") if File.exists?(gemfile_path)
-    result = BrpmScriptExecutor.execute_automation_script_in_separate_process(@module_name, "test_ruby", get_default_params)
+    result = BrpmScriptExecutor.execute_automation_script_in_separate_process(@module_name, "test_ruby", params)
     FileUtils.move("#{gemfile_path}_tmp", gemfile_path)
 
     expect(result).to be_truthy
@@ -71,7 +77,10 @@ describe 'BRPM Script Executor' do
   end
 
   it "should execute a resource automation script in a separate process" do
-    result = BrpmScriptExecutor.execute_resource_automation_script_in_separate_process(@module_name, "test_resource", get_default_params, nil, 0, 10)
+    params = get_default_params
+    params["home_dir"] = "#{File.dirname(__FILE__)}/customer_include"
+
+    result = BrpmScriptExecutor.execute_resource_automation_script_in_separate_process(@module_name, "test_resource", params, nil, 0, 10)
 
     expect(result.count).to eql(3)
   end

data/tests/customer_include/config/server.yml

@@ -1,4 +1,5 @@
 # This file should be located in BRPM_HOME/config
 # See the README for more information on how to use this file
 key2: "value2"
+automation_scripts_ruby_command: "ruby"
 # a_commented_out_key: "comment"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brpm_content_framework
 version: !ruby/object:Gem::Version
-  version: 0.2.48
+  version: 0.2.49
 platform: ruby
 authors:
 - Niek Bartholomeus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-20 00:00:00.000000000 Z
+date: 2015-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh