brpm_content_framework 0.1.59 → 0.1.60

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzIzOTUzOTY3ZWU0NGUyYmY1NmFkNDg4MzE0Y2VmZTk5NWJlZDFhNA==
+    NjFmNjQ0NmMyOWM0ZTMwM2QxMmUwZGU1OTBhYzZmMTEzYzkwODcyYg==
   data.tar.gz: !binary |-
-    ODUyN2Q0NGM1NzdiYjVmYTY2YzVhMThmNDJiMDg1ZWE4YmNmZWJmYg==
+    ODA4ODJlZmJiODhmODdjOTFlY2JhZDBmY2U5NDg1YTM4N2E4NzY5Yw==
 SHA512:
   metadata.gz: !binary |-
-    M2Q3MmVkMWU0NTlkNzI2MTZkNTY3ZjZlYzQyZWI4M2VlNmFhNDliYTU2ZDU1
-    MjE5Nzg5ZmZkZDdlOTkxNWRhOTVlZmQ0N2IxMzMxYzlmYjcxODE2OTNmNDMy
-    ZjkzNzI5ODhiZDk3YmE0YmJjNjFkNzYxMjkyZjMyZTlkNWI2NDg=
+    MDI0OTM0NmQ2MjlmZmI2NWMzMTQ5NTI4NWE3Njc0YjI0YjMyMTkzMmI2MDkw
+    NzUyYTVkOWVkMjVjZGIyYmQyY2ZlODY1NDUyYjFhYjlhNzdiMWJlOGM1MzJh
+    OWFhOGE5YTlhYzdkN2U1MDlhMTkwNjQxMWJiZmY5ODc5MTgzNGQ=
   data.tar.gz: !binary |-
-    MjY3ZWRmMTc3OTMzZGViODNlYzA2YjgxYWYzMjBlZGQ4NjQ5ZmUwNzEwNTkx
-    YjljODQ2NzNjOTZjMDQzODQzODE0NTVkMDA4ZDU2MzZiNzU5ZWZjZjk2YjZi
-    YWE5NTE2OWVkZDY5M2JlMzhmZDZiMjQ1NTk4YzM0ZDc4MmQ0MWI=
+    YjA4MWQxMDM0ZGQ4NjZiNGM0NGQ1OWM0MzE4NTYyZTNiZGUxOTAyYWM4M2Iz
+    NzM3NTVlN2YwNTkyYTdhMDQ5Nzk2ZDNlYzJjM2Y0OThjOTFhMTdjNjQyOTUz
+    NTQ4NjcwMmJkNDc1NmEwNjQzYWUxNGMzYjI1YjRhNjdlMDU2NDE=

data/config.yml

@@ -1,8 +1,8 @@
-version: 0.1.59
+version: 0.1.60
 
 author: Niek Bartholomeus
 email: niek.bartholomeus@gmail.com
-homepage: https://github.com/BMC-RLM/brpm_content
+homepage: https://github.com/BMC-RLM/brpm_content_framework
 license: MIT
 summary: BRPM Content Framework
 description: The BRPM Content Framework is a lightweight framework that allows to run automation logic on top of BRPM in a modular, re-usable, testable and developer-friendly way

data/lib/brpm_auto.rb

@@ -7,6 +7,7 @@ class BrpmAuto
   class << self
     attr_reader :config
     attr_reader :version
+    attr_reader :brpm_version
     attr_reader :logger
     attr_reader :params
     attr_reader :request_params
@@ -30,6 +31,8 @@ class BrpmAuto
       @config = get_config
       @version = @config["version"]
 
+      @brpm_version = get_brpm_version if ENV["BRPM_HOME"]
+
       @gems_root_path = get_gems_root_path
     end
 
@@ -326,6 +329,12 @@ class BrpmAuto
       YAML.load_file("#{@framework_root_path}/config.yml")
     end
 
+    def get_brpm_version
+      knob = YAML.load_file("#{ENV["BRPM_HOME"]}/server/jboss/standalone/deployments/RPM-knob.yml")
+      version_content = File.read("#{knob["application"]["root"]}/VERSION")
+      version_content.scan(/VERSION=([0-9\.]*)/)[0][0]
+    end
+
     def get_module_gem_path(module_name, module_version)
       "#{@gems_root_path}/gems/#{module_name}-#{module_version}"
     end

data/lib/module_installer.rb

@@ -76,7 +76,7 @@ class ModuleInstaller
         BrpmAuto.log "Uninstalling the automation script wrappers in the local BRPM instance..."
         failed_scripts = each_auto_script_wrapper(module_spec.gem_dir) do |auto_script_path, automation_type|
           BrpmAuto.log "Uninstalling automation script wrapper for script #{auto_script_path}..."
-          uninstall_auto_script_wrapper(auto_script_path, automation_type, module_friendly_name)
+          uninstall_auto_script_wrapper(auto_script_path, module_friendly_name)
         end
 
         if failed_scripts.size > 0
@@ -281,6 +281,42 @@ class ModuleInstaller
       end
     end
 
+    if Gem::Version.new(BrpmAuto.brpm_version) >= Gem::Version.new("4.8")
+      # For Local Shell
+      automation_dir = "#{module_path}/automations"
+      automation_script_paths = Dir.glob("#{automation_dir}/*.sh")
+
+      if automation_script_paths.size > 0
+        automation_script_paths.each do |auto_script_path|
+          begin
+            yield auto_script_path, "Local Shell"
+          rescue Exception => e
+            failed_scripts << auto_script_path
+            BrpmAuto.log_error(e)
+            BrpmAuto.log "\n\t" + e.backtrace.join("\n\t")
+          end
+        end
+      end
+    end
+
+    if Gem::Version.new(BrpmAuto.brpm_version) >= Gem::Version.new("4.8")
+      # For Remote Shell
+      automation_dir = "#{module_path}/remote_automations"
+      automation_script_paths = Dir.glob("#{automation_dir}/*.sh")
+
+      if automation_script_paths.size > 0
+        automation_script_paths.each do |auto_script_path|
+          begin
+            yield auto_script_path, "RemoteAutomation"
+          rescue Exception => e
+            failed_scripts << auto_script_path
+            BrpmAuto.log_error(e)
+            BrpmAuto.log "\n\t" + e.backtrace.join("\n\t")
+          end
+        end
+      end
+    end
+
     if failed_scripts.size > 0
       BrpmAuto.log "The following wrapper scripts generated errors:"
       failed_scripts.each do |failed_script|
@@ -294,12 +330,19 @@ class ModuleInstaller
   def install_auto_script_wrapper(auto_script_path, automation_type, module_name, module_friendly_name, integration_servers)
     auto_script_config = get_auto_script_config(auto_script_path, module_friendly_name)
 
+    if automation_type == "RemoteAutomation"
+      automation_type = auto_script_config["automation_type"] || "Remote Shell"
+    end
+    automation_type == "ResourceAutomation" if automation_type == "Data Retriever"
+
     BrpmAuto.log "Installing the wrapper script for automation script #{auto_script_config["name"]} (friendly name: #{auto_script_config["friendly_name"]}, automation type: #{automation_type})..."
 
-    if automation_type == "Automation"
+    if automation_type != "ResourceAutomation"
       add_version_params(auto_script_config["params"])
     end
 
+    automation_language = get_automation_language(automation_type)
+
     wrapper_script_content = ""
     if auto_script_config["params"].size > 0
       params_content = auto_script_config["params"].to_yaml
@@ -308,31 +351,45 @@ class ModuleInstaller
       wrapper_script_content = "###\n#{params_content}###\n"
     end
 
-    integration_server = nil
-    if auto_script_config["integration_server_type"]
-      server_type_id = @brpm_rest_client.get_id_for_project_server_type(auto_script_config["integration_server_type"])
-      if server_type_id
-        integration_server = integration_servers.find { |integr_server| integr_server["server_name_id"] == server_type_id } #TODO: support multiple integration servers of same type (user should pick one)
-      else
-        integration_server = integration_servers.find { |integr_server| integr_server["name"].include?(auto_script_config["integration_server_type"]) } #TODO: support multiple integration servers of same type (user should pick one)
-      end
+    if is_local_automation(automation_type)
+      integration_server = nil
+      if auto_script_config["integration_server_type"]
+        server_type_id = @brpm_rest_client.get_id_for_project_server_type(auto_script_config["integration_server_type"])
+        if server_type_id
+          integration_server = integration_servers.find { |integr_server| integr_server["server_name_id"] == server_type_id } #TODO: support multiple integration servers of same type (user should pick one)
+        else
+          integration_server = integration_servers.find { |integr_server| integr_server["name"].include?(auto_script_config["integration_server_type"]) } #TODO: support multiple integration servers of same type (user should pick one)
+        end
 
-      if integration_server
-        wrapper_script_content += "\n"
-        wrapper_script_content += get_integration_server_template(integration_server["id"], integration_server["name"], auto_script_config["integration_server_type"])
-      else
-        BrpmAuto.log "WARNING - An integration server of type #{auto_script_config["integration_server_type"]} (or that has #{auto_script_config["integration_server_type"]} in its name if the integration server type is not supported) doesn't exist so not setting the integration server in the wrapper script."
+        if integration_server
+          wrapper_script_content += "\n"
+          wrapper_script_content += get_integration_server_template(integration_server["id"], integration_server["name"], auto_script_config["integration_server_type"], automation_language)
+        else
+          BrpmAuto.log "WARNING - An integration server of type #{auto_script_config["integration_server_type"]} (or that has #{auto_script_config["integration_server_type"]} in its name if the integration server type is not supported) doesn't exist so not setting the integration server in the wrapper script."
+        end
       end
     end
 
     wrapper_script_content += "\n"
-    wrapper_script_content += get_script_executor_template(automation_type, module_name, auto_script_config["name"])
+    case automation_type
+    when "Automation", "ResourceAutomation"
+      wrapper_script_content += get_script_executor_template(automation_type, module_name, auto_script_config["name"])
+
+    when "Local Shell"
+      wrapper_script_content += "#{auto_script_path}\n"
+
+    when "Remote Shell", "Remote Dispatcher"
+      wrapper_script_content += File.read(auto_script_path)
+
+    end
 
     script = {}
     script["name"] = auto_script_config["friendly_name"]
     script["description"] = auto_script_config["description"] || ""
     script["automation_type"] = automation_type
     script["automation_category"] = module_friendly_name
+    script["agent_type"] = auto_script_config["agent_type"] if automation_type == "Remote Dispatcher" and auto_script_config["agent_type"]
+    script["os_type_ids"] = get_os_type_ids(auto_script_config["os_types"]) if automation_type == "Remote Shell" and auto_script_config["os_types"]
     script["content"] = wrapper_script_content
     script["integration_id"] = integration_server["id"] if auto_script_config["integration_server_type"] and integration_server
     if automation_type == "ResourceAutomation"
@@ -367,7 +424,7 @@ class ModuleInstaller
     end
   end
 
-  def uninstall_auto_script_wrapper(auto_script_path, automation_type, module_friendly_name)
+  def uninstall_auto_script_wrapper(auto_script_path, module_friendly_name)
     auto_script_config = get_auto_script_config(auto_script_path, module_friendly_name)
 
     script = @brpm_rest_client.get_script_by_name(auto_script_config["friendly_name"])
@@ -402,18 +459,49 @@ class ModuleInstaller
   end
 
   def get_auto_script_config(auto_script_path, module_friendly_name)
-    auto_script_name = File.basename(auto_script_path, ".rb")
+    auto_script_name = File.basename(auto_script_path, ".*")
     auto_script_config_path = "#{File.dirname(auto_script_path)}/#{auto_script_name}.meta"
 
     auto_script_config_content = File.exists?(auto_script_config_path) ? File.read(auto_script_config_path) : ""
     auto_script_config = YAML.load(auto_script_config_content) || {}
+    auto_script_config["name"] = auto_script_name
     auto_script_config["params"] = auto_script_config["params"] || {}
-    auto_script_config["name"] = File.basename(auto_script_path, ".rb")
     auto_script_config["friendly_name"] = auto_script_config["friendly_name"] || "#{module_friendly_name} - #{auto_script_config["name"].gsub("_", " ").capitalize}"
 
     auto_script_config
   end
 
+  def get_os_type_ids(os_types)
+    @os_type_map ||= { "200" => "Any", "201" => "Linux", "202" => "Windows" }
+    os_type_ids = []
+
+    os_types ||= ["Any"]
+
+    os_types.each do |os_type|
+        os_type_ids << @os_type_map.key(os_type)
+    end
+
+    os_type_ids
+  end
+
+  def is_local_automation(automation_type)
+    case automation_type
+    when "Automation", "Local Shell", "ResourceAutomation"
+      true
+    else
+      false
+    end
+  end
+
+  def get_automation_language(automation_type)
+    case automation_type
+    when "Automation", "ResourceAutomation"
+      "ruby"
+    else
+      "shell"
+    end
+  end
+
   def add_version_params(auto_script_params)
     include_position_attribute = false
     if auto_script_params.find { |_, param| param.has_key?("position") }
@@ -438,8 +526,10 @@ class ModuleInstaller
     auto_script_params["framework_version"] = framework_version_param
   end
 
-  def get_integration_server_template(integration_server_id, integration_server_name, integration_server_type)
-    <<EOR
+  def get_integration_server_template(integration_server_id, integration_server_name, integration_server_type, automation_language)
+    case automation_language
+    when "ruby"
+      <<EOR
 #=== #{integration_server_type} Integration Server: #{integration_server_name} ===#
 # [integration_id=#{integration_server_id}]
 #=== End ===#
@@ -449,6 +539,16 @@ 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)
 EOR
+    when "shell"
+      <<EOR
+#=== #{integration_server_type} Integration Server: #{integration_server_name} ===#
+# [integration_id=#{integration_server_id}]
+#=== End ===#
+EOR
+    else
+      BrpmAuto.log "WARNING - automation language #{automation_language} is not supported"
+      ""
+    end
   end
 
   def get_script_executor_template(automation_type, module_name, auto_script_name)

data/tests/module_installer_spec.rb

@@ -1,18 +1,44 @@
-require_relative "spec_helper"
-
 describe 'Module installer' do
   before(:all) do
     raise "Module installation tests don't work under Bundler." if ENV["RUBYOPT"] and ENV["RUBYOPT"].include?("-rbundler/setup")
+    raise "$BRPM_HOME is not set" unless ENV["BRPM_HOME"]
 
+    brpm_version = "4.6.00.00"
     FileUtils.mkdir_p "#{ENV["BRPM_HOME"]}/modules"
+    FileUtils.mkdir_p "#{ENV["BRPM_HOME"]}/server/jboss/standalone/deployments"
+    FileUtils.mkdir_p "#{ENV["BRPM_HOME"]}/releases/#{brpm_version}/RPM"
+
+    knob=<<EOR
+---
+application:
+  root: #{ENV["BRPM_HOME"]}/releases/#{brpm_version}/RPM
+environment:
+  RAILS_ENV: production
+web:
+  context: /brpm
+EOR
+
+    File.open("#{ENV["BRPM_HOME"]}/server/jboss/standalone/deployments/RPM-knob.yml", "w") do |file|
+      file.puts(knob)
+    end
+
+    version_content=<<EOR
+$VERSION=#{brpm_version}
+EOR
+
+    File.open("#{ENV["BRPM_HOME"]}/releases/#{brpm_version}/RPM/VERSION", "w") do |file|
+      file.puts(version_content)
+    end
+
+    require_relative "spec_helper"
 
     setup_brpm_auto
 
     BrpmAuto.log "Creating ~/.brpm file..."
     create_brpm_file
 
-    @module_name = "brpm_module_bladelogic"
-    @module_version = "0.1.22"
+    @module_name = "brpm_module_test"
+    @module_version = "0.1.3"
   end
 
   before(:each) do
@@ -28,21 +54,21 @@ describe 'Module installer' do
     end
   end
 
-  it "should install #{@module_name} from rubygems.org" do
+  it "should install a module from rubygems.org" do
     module_installer = ModuleInstaller.new
     module_installer.install_module(@module_name)
 
     expect{Gem::Specification.find_by_name(@module_name)}.not_to raise_error #(Gem::LoadError)
   end
 
-  it "should install a specific version of #{@module_name} from rubygems.org" do
+  it "should install a specific version of a module from rubygems.org" do
     module_installer = ModuleInstaller.new
     module_installer.install_module(@module_name, @module_version)
 
     expect{Gem::Specification.find_by_name(@module_name, Gem::Requirement.create(Gem::Version.new(@module_version)))}.not_to raise_error #(Gem::LoadError)
   end
 
-  it "should install #{@module_name} from a local gem file" do
+  it "should install a module from a local gem file" do
     `mkdir -p temp && cd temp && wget https://rubygems.org/downloads/#{@module_name}-#{@module_version}.gem` unless File.exists?("temp/#{@module_name}-#{@module_version}.gem")
 
     module_installer = ModuleInstaller.new

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brpm_content_framework
 version: !ruby/object:Gem::Version
-  version: 0.1.59
+  version: 0.1.60
 platform: ruby
 authors:
 - Niek Bartholomeus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-27 00:00:00.000000000 Z
+date: 2015-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -192,7 +192,7 @@ files:
 - transport/transport_baa.rb
 - transport/transport_nsh.rb
 - transport/transport_ssh.rb
-homepage: https://github.com/BMC-RLM/brpm_content
+homepage: https://github.com/BMC-RLM/brpm_content_framework
 licenses:
 - MIT
 metadata: {}