brpm_content_framework 0.2.1 → 0.2.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTNmZjEwZDA2ZDQzMGNiNTVhMzU3YjI1NDNkYjAxMDkwNTM0YjliOA==
+    MTliYTJlZTEwMWZjYjZhZWUxYTk0NmQ3MDMzODY5ZmMxODdiNjY4Yg==
   data.tar.gz: !binary |-
-    NzEyZWQ0YzBlMjA0MDlkMzE3NjI0MDE5NjJiNWQ4YzRmYmQ0NDJiMQ==
+    MzdjYTA4ZWYxZWUyODQ1N2FjYzNiZDVjZjkxNDZlNWJiYjgyNWNjMQ==
 SHA512:
   metadata.gz: !binary |-
-    NmIwZTI4NjFkYjJhYjc3N2FmZjBjY2E3NzVhYjQ4ZDY1ZjZmYjg4YjM2MzUz
-    MGFmM2MxMGVkODg3NTYxNTkwNzcyNzA3NTUxMjc1Yzc1MWZkY2Q5NWM4NThj
-    YzA1OWE1OGRhODIyMmFiMDRiMzIzMTZjMDBkNWQ3ZDE2YWQ3Y2E=
+    NzhmNGUxYzI0OGZiNGNmMTEzMjdjNjZhYWQwZWY0YjE2YmFjM2NmOTI4Y2Fl
+    ZTUwMTczMGU3MGMzMjQ3ZThiODBiNzdiMjQ3NjNjYzFlMTU0Y2RjNzc2MDE5
+    ZjI2OGY5ZTYxZDUzZmQyNWM3MDQwOTljMjM0OWU2NjlhYmU0ZGU=
   data.tar.gz: !binary |-
-    NDY1MmQxZDE3MzQzNmQ0ZDI4NmVmYzhiYjllZWJhMGUyYjQ0M2RkOTJjMGI2
-    NzI0YjEzZTIwODY1MjYwZjg5NzIwYjg3YWFlYzA2MzhlOTJhNmUzMjMyOTRh
-    N2FkZWFiODM3ZDAxODQzYjI5MzBiZjYwOWRkNTNiYTU0NDAwMTE=
+    MDY1MWQwYTRkZDBmNGU0NTUzYTQyNGNlNjExMjg5YjY0NzA2MzZkYWMzNmMw
+    MzJlNzMzNWIwNDVjODdlNTE0NmUxMmE3Y2RmMzA3ZGJlMTcxMjdkZmRhNzcx
+    NjdjNjkwNzQ2ZGNhYTMxNGEyMmJlZTYzZjk5NjU5YTRjYTY2NzY=

data/config.yml

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

data/infrastructure/test_separate_process.rb

@@ -0,0 +1,3 @@
+require 'bundler/setup';
+require 'brpm_script_executor';
+BrpmScriptExecutor.execute_automation_script_from_other_process('brpm_module_test', 'test_ruby_raises_error', '/private/tmp/brpm_content/params_000_tmp.yml')

data/lib/brpm_auto.rb

@@ -31,6 +31,7 @@ class BrpmAuto
       @version = @config["version"]
 
       @brpm_version = get_brpm_version if self.brpm_installed?
+      @gems_root_path = get_gems_root_path
     end
 
     def setup(params = {})
@@ -173,7 +174,7 @@ class BrpmAuto
     end
 
     def get_module_gem_path(module_name, module_version)
-      "#{ENV["GEM_HOME"]}/gems/#{module_name}-#{module_version}"
+      "#{@gems_root_path}/gems/#{module_name}-#{module_version}"
     end
 
     def get_latest_installed_version(module_name)
@@ -228,6 +229,18 @@ class BrpmAuto
       end
     end
 
+    def  get_gems_root_path
+      if ENV["BRPM_CONTENT_HOME"]
+        ENV["BRPM_CONTENT_HOME"] # gemset location is overridden
+      elsif ENV["BRPM_HOME"]
+        "#{ENV["BRPM_HOME"]}/modules" # default gemset location when BRPM is installed
+      elsif ENV["GEM_HOME"]
+        ENV["GEM_HOME"] # default gemset location when BRPM is not installed
+      else
+        raise "Unable to find out the gems root path."
+      end
+    end
+
     def get_config
       YAML.load_file("#{@framework_root_path}/config.yml")
     end

data/lib/brpm_script_executor.rb

@@ -16,11 +16,45 @@ class BrpmScriptExecutor
         file.puts(params.to_yaml)
       end
 
-      BrpmAuto.log "Executing '#{modul}' '#{name}' in a separate process..."
-      Bundler.clean_system({"GEM_HOME" => ENV["BRPM_CONTENT_HOME"] || "#{ENV["BRPM_HOME"]}/modules"}, get_ruby_cmd, "-r", __FILE__, "-e", "BrpmScriptExecutor.execute_automation_script_from_other_process(\"#{modul}\", \"#{name}\", \"#{params_file}\")")
+      env_vars = {}
+      env_vars["GEM_HOME"] = ENV["BRPM_CONTENT_HOME"] || "#{ENV["BRPM_HOME"]}/modules"
+
+      BrpmAuto.log "Finding the module path..."
+      module_version = params["module_version"] || BrpmAuto.get_latest_installed_version(modul)
+      module_path = BrpmAuto.get_module_gem_path(modul, module_version)
+
+      if File.exists?(module_path)
+        BrpmAuto.log "Found module #{modul} #{module_version || ""} in path #{module_path}."
+      else
+        raise Gem::GemNotFoundException, "Module #{modul} version #{module_version} is not installed. Expected it on path #{module_path}."
+      end
+
+      require_statements = ""
+      gemfile_path = "#{module_path}/Gemfile"
+      unless File.exists?(gemfile_path)
+        BrpmAuto.log_error("This module doesn't have a Gemfile. Expected it at #{gemfile_path}.")
+        return
+      end
+
+      BrpmAuto.log "Found a Gemfile (#{gemfile_path}) so the automation script will have to run inside bundler."
+      env_vars["BUNDLE_GEMFILE"] = gemfile_path
+      require_statements += "require 'bundler/setup'; "
+      # TODO Bundler.require
+
+      BrpmAuto.log "Executing automation script '#{name}' from module '#{modul}' in a separate process..."
+      result = Bundler.clean_system(env_vars, RbConfig.ruby, "-e", "#{require_statements}; require 'brpm_script_executor'; BrpmScriptExecutor.execute_automation_script_from_other_process(\"#{modul}\", \"#{name}\", \"#{params_file}\")")
+      if result.nil?
+        BrpmAuto.log_error("The process that executed the automation script returned with 'Command execution failed'.")
+      elsif result == false
+        BrpmAuto.log_error("The process that executed the automation script  returned with non-zero exit code: #{$?.exitstatus}")
+      end
+
+      result
     end
 
     def execute_automation_script_from_other_process(modul, name, params_file)
+      raise "Params file #{params_file} doesn't exist." unless File.exists?(params_file)
+
       puts "Loading params file #{params_file}..."
       params = YAML.load_file(params_file)
 
@@ -49,20 +83,20 @@ class BrpmScriptExecutor
         BrpmAuto.log ">>>>>>>>>>>>>> START automation #{name}"
         start_time = Time.now
 
-        original_brpm_version = BrpmAuto.version
-
-        BrpmAuto.log "Initializing module #{modul}#{params["module_version"] ? " #{params["module_version"]}" : ""} and its dependencies..."
         module_version = params["module_version"] || BrpmAuto.get_latest_installed_version(modul)
-        module_path = initialize_module(modul, module_version)
-        BrpmAuto.log "Finished loading the module."
+        module_path = BrpmAuto.get_module_gem_path(modul, module_version)
 
-        BrpmAuto.log "Note: running on a different version of the BRPM Content framework now: #{BrpmAuto.version} (was #{original_brpm_version})" if original_brpm_version != BrpmAuto.version
+        if File.exists?(module_path)
+          BrpmAuto.log "Found module #{modul} #{module_version || ""} in gem path #{module_path}."
+        else
+          raise Gem::GemNotFoundException, "Module #{modul} version #{module_version} is not installed. Expected it on path #{module_path}."
+        end
 
         BrpmAuto.require_module(modul, module_version)
 
         automation_script_path = "#{module_path}/automations/#{name}.rb"
 
-        BrpmAuto.log "Loading the automation script #{automation_script_path}..."
+        BrpmAuto.log "Executing the automation script #{automation_script_path}..."
         load automation_script_path
 
       rescue Exception => e
@@ -98,7 +132,7 @@ class BrpmScriptExecutor
 
         automation_script_path = "#{module_path}/resource_automations/#{name}.rb"
 
-        BrpmAuto.log "Loading the resource automation script #{automation_script_path}..."
+        BrpmAuto.log "Executing the resource automation script #{automation_script_path}..."
         load automation_script_path
 
         BrpmAuto.log "Calling execute_resource_automation_script(params, parent_id, offset, max_records)..."
@@ -121,37 +155,6 @@ class BrpmScriptExecutor
     end
 
     alias_method :execute_resource_automation_script_from_gem, :execute_resource_automation_script
-
-    def get_ruby_cmd
-      @ruby ||= File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
-    end
-
-    # this method is used BEFORE BrpmAuto is activated so make sure not to use any logic from BrpmAuto in here
-    def initialize_module(module_name, module_version)
-      module_gem_path = BrpmAuto.get_module_gem_path(module_name, module_version)
-
-      if File.exists?(module_gem_path)
-        BrpmAuto.log "Found module #{module_name} #{module_version || ""} in gem path #{module_gem_path}."
-      else
-        raise Gem::GemNotFoundException, "Module #{module_name} version #{module_version} is not installed. Expected it on path #{module_gem_path}."
-      end
-
-      gemfile_path = "#{module_gem_path}/Gemfile"
-      if File.exists?(gemfile_path)
-        BrpmAuto.log "Found a Gemfile (#{gemfile_path}) so activating bundler..."
-        ENV["BUNDLE_GEMFILE"] = gemfile_path
-        require "bundler/setup"
-        # TODO Bundler.require
-
-        params = BrpmAuto.params
-
-        BrpmAuto.log "Reloading brpm_auto to make sure the version that was specified by the Gemfile/Gemfile.lock of the module is active from now on..."
-        require "brpm_auto"
-        BrpmAuto.setup(params)
-      end
-
-      module_gem_path
-    end
   end
 end
 

data/tests/brpm_script_executor_spec.rb

@@ -8,19 +8,50 @@ describe 'BRPM Script Executor' do
     require_relative "../lib/brpm_auto"
     BrpmAuto.setup(get_default_params)
 
-    BrpmAuto.log "Creating ~/.brpm file..."
-    create_brpm_file
+    test_gems = Dir.glob("#{ENV["BRPM_HOME"]}/modules/gems/brpm_module_test*")
+
+    if test_gems.empty?
+      # watch out we are running inside bundler, known for messing up the gem configs
+      ENV["GEM_HOME"] = "#{ENV["BRPM_HOME"]}/modules"
+      Gem.paths = ENV
 
-    gem_installed = `gem list -i brpm_module_test`.chomp
-    if gem_installed != "true" # we are running inside bundler here so simplest to install the gem using a separate process
       BrpmAuto.log "Installing brpm_module_test..."
-      # `gem install brpm_module_test`
+      specs = Gem.install("brpm_module_test")
+      spec = specs.find { |spec| spec.name == "brpm_module_test"}
+      BrpmAuto.log "Bundle install..."
+      `export GEM_HOME=#{ENV["GEM_HOME"]}; export BUNDLE_GEMFILE=#{spec.gem_dir}/Gemfile; bundle install`
     end
   end
 
+  it "should execute an automation script in-process" do
+    result = BrpmScriptExecutor.execute_automation_script("brpm_module_test", "test_ruby", get_default_params)
+
+    expect(result).to be_truthy
+  end
+
+  it "should return false when executing an non-existing automation script in-process" do
+    expect{BrpmScriptExecutor.execute_automation_script("brpm_module_test", "xxx", get_default_params)}.to raise_exception
+  end
+
+  it "should return false when executing an erroneous automation script in-process" do
+    expect{BrpmScriptExecutor.execute_automation_script("brpm_module_test", "test_ruby_raises_error", get_default_params)}.to raise_exception
+  end
+
   it "should execute an automation script in a separate process" do
     result = BrpmScriptExecutor.execute_automation_script_in_separate_process("brpm_module_test", "test_ruby", get_default_params)
 
     expect(result).to be_truthy
   end
+
+  it "should return false when executing an non-existing automation script in a separate process" do
+    result = BrpmScriptExecutor.execute_automation_script_in_separate_process("brpm_module_test", "xxx", get_default_params)
+
+    expect(result).to be_falsey
+  end
+
+  it "should return false when executing an erroneous automation script in a separate process" do
+    result = BrpmScriptExecutor.execute_automation_script_in_separate_process("brpm_module_test", "test_ruby_raises_error", get_default_params)
+
+    expect(result).to be_falsey
+  end
 end

data/tests/spec_helper.rb

@@ -3,10 +3,10 @@ require 'yaml'
 require 'json'
 
 FileUtils.mkdir_p "/tmp/brpm_content"
+raise "$BRPM_STUB_HOME is not set" unless ENV["BRPM_STUB_HOME"]
+ENV["BRPM_HOME"] = ENV["BRPM_STUB_HOME"]
 
 def setup_brpm_env
-  raise "$BRPM_STUB_HOME is not set" unless ENV["BRPM_STUB_HOME"]
-  ENV["BRPM_HOME"] = ENV["BRPM_STUB_HOME"]
 end
 
 def setup_brpm_auto
@@ -53,18 +53,3 @@ def decrypt_string_with_prefix(input) # mocked method
 
   input.gsub("_encrypted", "")
 end
-
-def create_brpm_file
-  if File.exists?("~/.brpm")
-    FileUtils.rm("~/.brpm")
-  end
-
-  params = get_default_params
-  brpm_params = {}
-  brpm_params["brpm_url"] = params["brpm_url"]
-  brpm_params["brpm_api_token"] = params["brpm_api_token"]
-
-  File.open(File.expand_path("~/.brpm"), "w") do |file|
-    file.puts(brpm_params.to_yaml)
-  end
-end

data/tests_no_bundler/spec_helper.rb

@@ -36,8 +36,36 @@ EOR
   end
 end
 
+def get_default_params
+  params = {}
+  params['unit_test'] = 'true'
+  params['also_log_to_console'] = 'true'
+
+  params['brpm_url'] = 'http://brpm-content.pulsar-it.be:8088/brpm'
+  params['brpm_api_token'] = ENV["BRPM_API_TOKEN"]
+
+  params['output_dir'] = "/tmp/brpm_content"
+
+  params
+end
+
 def setup_brpm_auto
   require_relative "../lib/brpm_auto" #require_relative because we can't run inside bundler, we can't run inside bundler because we need the brpm_module_test which is not included in the brpm_content_framework Gemfile
   BrpmAuto.setup(get_default_params)
 end
 
+def create_brpm_file
+  if File.exists?("~/.brpm")
+    FileUtils.rm("~/.brpm")
+  end
+
+  params = get_default_params
+  brpm_params = {}
+  brpm_params["brpm_url"] = params["brpm_url"]
+  brpm_params["brpm_api_token"] = params["brpm_api_token"]
+
+  File.open(File.expand_path("~/.brpm"), "w") do |file|
+    file.puts(brpm_params.to_yaml)
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brpm_content_framework
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.3
 platform: ruby
 authors:
 - Niek Bartholomeus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-01 00:00:00.000000000 Z
+date: 2015-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -152,6 +152,7 @@ files:
 - infrastructure/silent_install_options_4.6.txt
 - infrastructure/silent_install_options_upgrade_4.6.txt
 - infrastructure/smtp_settings.rb
+- infrastructure/test_separate_process.rb
 - lib/brpm_auto.rb
 - lib/brpm_script_executor.rb
 - lib/logging/brpm_logger.rb