brpm_content_framework 0.2.32 → 0.2.33

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YzQxZGE2NGI0ZGQ4YzgxZGY1YzQyYjBiZGIzOTE2YzQ2Y2RhZTdhYg==
+    ZGE3ODVjYmZiOTE3MzYwNTE0MjIwZWUzN2NkNDk5MGZlN2IwODE5YQ==
   data.tar.gz: !binary |-
-    NDkxOWQ3ZTk0OTQ0ZDkyMTZlOWYxMTgzZWRjYjY2ZDQyMTJmZTMyMg==
+    MDYzNWYwZjQyNjAzYzNhMDgxNmQ3ZDdmYzg3Y2Y3MzcwYjUwZTc5ZA==
 SHA512:
   metadata.gz: !binary |-
-    ODEzYWRlZjg4YWQ3ZDkwZTk3ODJjNjIwOGY0YzAwOGFmOWZmYjdhYTdjOTg2
-    OWZjMzdkZjMyZDcyZWQ5MzI0M2RiYmFmZDM0YzFhMjVhNTNmNTU3YzE2NzM5
-    ZjBiNGM2YzM1OTUyNjA2Y2RkOGI5YTY0NTJmM2FmZGViODhjYWE=
+    MzkxMDAyMDA4NGNmNTE0ZGY2ZjgyNTE5NDc3YjBjMDlkYmJiYzFhZWE3YjY5
+    ZTRkOGFhMjc1OGVlYzQ1ZWM5NDUyZTY0NzZiN2JmNjhiZmI1MjNhYWRkNWQ4
+    YWZkZDIyYzg2Mjg1YTU0NjYwZDRmZTBmNmNiZjIwMjNhYmRlNWQ=
   data.tar.gz: !binary |-
-    OTI2MWQ0N2U4NDgwMzM2OThhMGE2NGE0MDQ2ODRlMzdiZmI0NzJhMWEwYTFi
-    MzQxYjkzZDMyOTUwM2U5OGUxMmZjN2JjNTJjOTA1NWRjMTRkMjgzM2NlNzhk
-    YjEzZmExMTUzZGM4ZGZhY2VkMGRhYWZhZDRkODAzOGUzNjk2YmY=
+    OTRlZDMyNzk0Yjk0OTFmNzc0ZjhmOTk3M2Q1NmQwYzJiYWRjNGU2Y2NiYzc2
+    MmE4Njk4ZmM1ZDc3NTU3ZDg1M2VmYTdmMmY2YTMyMDE2NWJhNzI3Mzc1YzRl
+    NTliNWMwZDQyOWVjOGRkYTI1MzBmNDFiMWE0NDQyMmY5NmIxMzk=

data/config.yml

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

data/{infrastructure/docker → docker}/Dockerfile

@@ -11,4 +11,5 @@ RUN gem install brpm_content_framework --ignore-dependencies -v "$BRPM_CONTENT_F
 ADD . /
 
 VOLUME [ "/workdir" ]
-VOLUME [ "/automation_results" ]
+VOLUME [ "/automation_results" ]
+VOLUME [ "/script_support" ]

data/infrastructure/scripts/publish_module_version.sh

@@ -2,7 +2,6 @@
 USAGE="publish_module_version.sh <module name>"
 
 MODULE_NAME=$1
-MODULE_VERSION=$2
 
 if [ -z "$MODULE_NAME" ]; then
     echo "Module name is not specified. Aborting."
@@ -12,23 +11,29 @@ fi
 
 cd $(dirname $0)/../../../$MODULE_NAME
 
+echo ""
 echo ">>> Publishing the module as a gem to rubygems.org..."
 rake release
-if [ -f "Dockerfile" ]; then
+if [ -f "docker/Dockerfile" ]; then
     MODULE_VERSION=$(eval "sed -n \"s=version: \(.*\)=\1=p\" config.yml")
 
+    cd docker
+
     OLD_MODULE_VERSION=$(eval "sed -n \"s=ENV VERSION \(.*\)=\1=p\" Dockerfile")
     sed -i "" s/$OLD_MODULE_VERSION/$MODULE_VERSION/ Dockerfile
 
+    echo ""
     echo ">>> Building the docker image..."
-    docker build -t bmcrlm/$MODULE_NAME:$MODULE_VERSION .
+    docker build -t bmcrlm/$MODULE_NAME:$MODULE_VERSION . || { echo 'Aborting' ; exit 1; }
+
+    sed -i "" s/$MODULE_VERSION/$OLD_MODULE_VERSION/ Dockerfile
 
+    echo ""
     echo ">>> Publishing the docker image to the docker hub..."
-    docker push bmcrlm/$MODULE_NAME:$MODULE_VERSION
+    docker push bmcrlm/$MODULE_NAME:$MODULE_VERSION || { echo 'Aborting' ; exit 1; }
 
+    echo ""
     echo ">>> Tagging the module version as 'latest'..."
-    docker tag -f bmcrlm/$MODULE_NAME:$MODULE_VERSION bmcrlm/$MODULE_NAME:latest
-    docker push bmcrlm/$MODULE_NAME:latest
-
-    sed -i "" s/$MODULE_VERSION/$OLD_MODULE_VERSION/ Dockerfile
+    docker tag -f bmcrlm/$MODULE_NAME:$MODULE_VERSION bmcrlm/$MODULE_NAME:latest || { echo 'Aborting' ; exit 1; }
+    docker push bmcrlm/$MODULE_NAME:latest || { echo 'Aborting' ; exit 1; }
 fi

data/lib/brpm_auto.rb

@@ -25,6 +25,7 @@ class BrpmAuto
     attr_reader :request_params
     attr_reader :all_params
     attr_reader :integration_settings
+    attr_reader :global_params
 
     attr_reader :framework_root_path
 
@@ -42,8 +43,8 @@ class BrpmAuto
     def setup(params = {})
       @params = Params.new(params)
 
-      load_server_params
-      load_customer_include_file
+      @global_params = get_global_params
+      @global_params.merge!(load_customer_include_file)
 
       if @params.run_from_brpm
         @logger = BrpmLogger.new
@@ -78,27 +79,26 @@ class BrpmAuto
       @params
     end
 
-    def load_server_params
+    def get_global_params
       server_config_file_path = "#{self.params.config_dir}/server.yml"
       if File.exists?(server_config_file_path)
-        server_config = YAML.load_file(server_config_file_path)
-        server_config.each do |key, value|
-          @params[key] = value unless @params.has_key?(key)
-        end
+        YAML.load_file(server_config_file_path) || {}
+      else
+        {}
       end
     end
 
     def load_customer_include_file
       customer_include_file_path = "#{self.params.config_dir}/customer_include.rb"
+      params = {}
       if File.exists?(customer_include_file_path)
         load customer_include_file_path # use load instead of require to avoid having to restart BRPM after modifying the customer include file in a resource automation scenario
         if defined?(get_customer_include_params)
-          customer_include_params = get_customer_include_params
-          customer_include_params.each do |key, value|
-            @params[key] = value
-          end
+          params = get_customer_include_params || {}
         end
       end
+
+      params
     end
 
     def initialize_logger(log_file, also_log_to_console = false)

data/lib/brpm_script_executor.rb

@@ -15,112 +15,117 @@ class BrpmScriptExecutor
     end
 
     def execute_automation_script_in_separate_process_internal(modul, name, params, automation_type, parent_id = nil, offset = nil, max_records = nil)
-      BrpmAuto.setup(params)
-      BrpmAuto.log ""
-      BrpmAuto.log "Executing #{automation_type} '#{name}' from module '#{modul}' in a separate process..."
-
-      BrpmAuto.log "Finding the module's version..."
-      case automation_type
-      when "automation"
-        module_version = params["module_version"] || get_latest_installed_version(modul)
-      when "resource_automation"
-        module_version = get_latest_installed_version(modul) #TODO: get the module version of the calling script
-      else
-        raise "Automation type #{automation_type} is not supported."
-      end
+      begin
+        BrpmAuto.setup(params)
+        BrpmAuto.log ""
+        BrpmAuto.log "Executing #{automation_type} '#{name}' from module '#{modul}' in a separate process..."
+
+        BrpmAuto.log "Finding the module's version..."
+        case automation_type
+        when "automation"
+          module_version = params["module_version"] || get_latest_installed_version(modul)
+        when "resource_automation"
+          module_version = get_latest_installed_version(modul) #TODO: get the module version of the calling script
+        else
+          raise "Automation type #{automation_type} is not supported."
+        end
 
-      case BrpmAuto.params["execute_automation_scripts_in_docker"]
-      when "always"
-        use_docker = true
-      when "if_docker_image_exists"
-        BrpmAuto.log "Checking if a docker image exists for bmcrlm/#{modul}:#{module_version}..."
-        output = `docker history -q bmcrlm/#{modul}:#{module_version} 2>&1 >/dev/null`
-        if output.empty?
+        case BrpmAuto.global_params["execute_automation_scripts_in_docker"] || params["execute_automation_scripts_in_docker"]
+        when "always"
           use_docker = true
+        when "if_docker_image_exists"
+          BrpmAuto.log "Checking if a docker image exists for bmcrlm/#{modul}:#{module_version}..."
+          output = `docker history -q bmcrlm/#{modul}:#{module_version} 2>&1 >/dev/null`
+          use_docker = output.empty?
         else
-          BrpmAuto.log "The image doesn't exist locally, checking if we can pull it from the Docker Hub..."
-          output = `docker pull bmcrlm/#{modul}:#{module_version}`
-          use_docker = (output =~ /Image is up to date for/)
+          use_docker = false
         end
-      else
-        use_docker = false
-      end
-      BrpmAuto.log "The automation script will be executed in a docker container." if	use_docker
-
-      working_path = File.expand_path(BrpmAuto.params.output_dir)
-      params_file = "params_#{params["SS_run_key"] || params["run_key"] || "000"}.yml"
-      params_path = "#{working_path}/#{params_file}"
-      automation_results_path = params["SS_automation_results_dir"] || working_path
-
-      if use_docker
-        params["SS_output_dir"] = "/workdir"
-        params["SS_output_file"].sub!(working_path, "/workdir") if params["SS_output_file"]
-        params["SS_automation_results_dir"] = "/automation_results"
-
-        params["log_file"].sub!(working_path, "/workdir") if params["log_file"]
-      end
-
-      BrpmAuto.log "Temporarily storing the params to #{params_path}..."
-      File.open(params_path, "w") do |file|
-        file.puts(params.to_yaml)
-      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 --rm bmcrlm/#{modul}:#{module_version} /docker_execute_automation \"#{name}\" \"/workdir/#{params_file}\" \"#{automation_type}\""
-        if automation_type == "resource_automation"
-          command += " \"#{parent_id}\"" if parent_id
-          command += " \"#{offset}\"" if offset
-          command += " \"#{max_records}\"" if max_records
+        BrpmAuto.log "The automation script will be executed in a docker container." if	use_docker
+
+        working_path = File.expand_path(BrpmAuto.params.output_dir)
+        params_file = "params_#{params["SS_run_key"] || params["run_key"] || "000"}.yml"
+        params_path = "#{working_path}/#{params_file}"
+        automation_results_path = params["SS_automation_results_dir"] || working_path
+        script_support_path = params["SS_script_support_path"] || working_path
+
+        if use_docker
+          params = params.clone # we don't want to modify the current session's params
+          params["SS_output_dir"] = "/workdir"
+          params["SS_output_file"].sub!(working_path, "/workdir") if params["SS_output_file"]
+          params["SS_automation_results_dir"] = "/automation_results"
+          params["SS_script_support_path"] = "/script_support"
+
+          params["log_file"].sub!(working_path, "/workdir") if params["log_file"]
         end
-        BrpmAuto.log command
-        return_value = system(command)
-      else
-        env_vars = {}
-        env_vars["GEM_HOME"] = ENV["BRPM_CONTENT_HOME"] || "#{ENV["BRPM_HOME"]}/modules"
 
-        module_path = get_module_gem_path(modul, module_version)
+        BrpmAuto.log "Temporarily storing the params to #{params_path}..."
+        File.open(params_path, "w") do |file|
+          file.puts(params.to_yaml)
+        end
 
-        if File.exists?(module_path)
-          BrpmAuto.log "Found module #{modul} #{module_version || ""} in path #{module_path}."
+        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}\""
+          if automation_type == "resource_automation"
+            command += " \"#{parent_id}\"" if parent_id
+            command += " \"#{offset}\"" if offset
+            command += " \"#{max_records}\"" if max_records
+          end
+          BrpmAuto.log command
+          return_value = system(command)
         else
-          raise Gem::GemNotFoundException, "Module #{modul} version #{module_version} is not installed. Expected it on path #{module_path}."
+          env_vars = {}
+          env_vars["GEM_HOME"] = ENV["BRPM_CONTENT_HOME"] || "#{ENV["BRPM_HOME"]}/modules"
+
+          module_path = 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
+
+          gemfile_path = "#{module_path}/Gemfile"
+          if File.exists?(gemfile_path)
+            BrpmAuto.log "Using Gemfile #{gemfile_path}."
+            env_vars["BUNDLE_GEMFILE"] = gemfile_path
+            require_bundler = "require 'bundler/setup';"
+          else
+            BrpmAuto.log("This module doesn't have a Gemfile.")
+            require_bundler = ""
+          end
+
+          BrpmAuto.log "Executing the script in a separate process..."
+          return_value = Bundler.clean_system(env_vars, "ruby", "-e", "#{require_bundler}require 'brpm_script_executor'; BrpmScriptExecutor.execute_automation_script_from_other_process(\"#{modul}\", \"#{name}\", \"#{params_path}\", \"#{automation_type}\", \"#{parent_id}\", \"#{offset}\", \"#{max_records}\")")
         end
 
-        gemfile_path = "#{module_path}/Gemfile"
-        if File.exists?(gemfile_path)
-          BrpmAuto.log "Using Gemfile #{gemfile_path}."
-          env_vars["BUNDLE_GEMFILE"] = gemfile_path
-          require_bundler = "require 'bundler/setup';"
-        else
-          BrpmAuto.log("This module doesn't have a Gemfile.")
-          require_bundler = ""
+        FileUtils.rm(params_path) if File.exists?(params_path)
+        if return_value.nil?
+          message = "The process that executed the automation script returned with 'Command execution failed'."
+          BrpmAuto.log_error message
+          raise message
+        elsif return_value == false
+          message = "The process that executed the automation script returned with non-zero exit code: #{$?.exitstatus}"
+          BrpmAuto.log_error message
+          raise message
         end
 
-        BrpmAuto.log "Executing the script in a separate process..."
-        return_value = Bundler.clean_system(env_vars, "ruby", "-e", "#{require_bundler}require 'brpm_script_executor'; BrpmScriptExecutor.execute_automation_script_from_other_process(\"#{modul}\", \"#{name}\", \"#{params_path}\", \"#{automation_type}\", \"#{parent_id}\", \"#{offset}\", \"#{max_records}\")")
-      end
+        if automation_type == "resource_automation"
+          result_path = params_path.sub!("params", "result")
+          BrpmAuto.log "Loading the result from #{result_path} and cleaning it up..."
+          result = YAML.load_file(result_path)
+          FileUtils.rm result_path
 
-      FileUtils.rm(params_path) if File.exists?(params_path)
-      if return_value.nil?
-        message = "The process that executed the automation script returned with 'Command execution failed'."
-        BrpmAuto.log_error message
-        raise message
-      elsif return_value == false
-        message = "The process that executed the automation script returned with non-zero exit code: #{$?.exitstatus}"
-        BrpmAuto.log_error message
-        raise message
-      end
+          result
+        else
+          return_value
+        end
 
-      if automation_type == "resource_automation"
-        result_file = params_file.sub!("params", "result")
-        BrpmAuto.log "Loading the result from #{result_file} and cleaning it up..."
-        result = YAML.load_file(result_file)
-        FileUtils.rm result_file
+      rescue Exception => e
+        BrpmAuto.log_error "#{e}"
+        BrpmAuto.log "\n\t" + e.backtrace.join("\n\t")
 
-        result
-      else
-        return_value
+        raise e
       end
     end
 
@@ -136,8 +141,8 @@ class BrpmScriptExecutor
       BrpmAuto.log "  BRPM Content framework is version #{BrpmAuto.version}."
 
       if BrpmAuto.params["SS_run_key"] and BrpmAuto.params["SS_script_support_path"]
-        BrpmAuto.log "  Loading the BRPM core framework's libraries..."
-        load File.expand_path("#{File.dirname(__FILE__)}/../infrastructure/create_output_file.rb")
+        BrpmAuto.log "  Setting up the BRPM core framework..."
+        load File.expand_path("#{File.dirname(__FILE__)}/../infrastructure/setup_brpm_core_framework.rb")
       end
 
       result = execute_automation_script_internal(modul, name, params, automation_type, parent_id, offset, max_records)

data/lib/logging/brpm_logger.rb

@@ -26,6 +26,8 @@ class BrpmLogger < LoggerBase
 
     log_message = "#{prefix}#{message}\n"
 
+    print(log_message) if BrpmAuto.params.also_log_to_console
+
     File.open(@request_log_file_path, "a") do |log_file|
       log_file.print(log_message)
     end
@@ -33,7 +35,5 @@ class BrpmLogger < LoggerBase
     File.open(@step_run_log_file_path, "a") do |log_file|
       log_file.print(log_message)
     end
-
-    print(log_message) if BrpmAuto.params.also_log_to_console
   end
 end

data/lib/module_installer.rb

@@ -13,6 +13,7 @@ class ModuleInstaller
       brpm_content_spec = specs.find { |spec| spec.name == "brpm_content_framework" } if specs
 
       install_bundle(module_spec)
+      pull_docker_image(module_spec)
     else
       module_name = module_name_or_path
       module_spec = Gem::Specification.find_by_name(module_name)
@@ -166,6 +167,21 @@ class ModuleInstaller
     end
   end
 
+  def pull_docker_image(spec)
+    case BrpmAuto.global_params["execute_automation_scripts_in_docker"]
+    when "always", "if_docker_image_exists"
+      BrpmAuto.log "Pulling the docker image from the Docker Hub..."
+      output = `docker pull bmcrlm/#{spec.name}:#{spec.version}`
+      unless output =~ /Image is up to date for/
+        if BrpmAuto.global_params["execute_automation_scripts_in_docker"] == "always"
+          raise "Docker image bmcrlm/#{spec.name}:#{spec.version} doesn't exist."
+        elsif BrpmAuto.global_params["execute_automation_scripts_in_docker"] == "if_docker_image_exists"
+          BrpmAuto.log "Docker image bmcrlm/#{spec.name}:#{spec.version} doesn't exist."
+        end
+      end
+    end
+  end
+
   def get_symlink_path
     "#{ENV["GEM_HOME"]}/gems/brpm_content_framework-latest"
   end

data/tests/brpm_script_executor_spec.rb

@@ -76,7 +76,7 @@ describe 'BRPM Script Executor' do
     expect(result.count).to eql(3)
   end
 
-  it "should execute a resource automation script in a docker container" do
+  xit "should execute a resource automation script in a docker container" do
     params = get_default_params
     params['output_dir'] = File.expand_path("~/tmp/brpm_content") # docker volume mappong only works from the current user's home directory on Mac OSX
     params["execute_automation_scripts_in_docker"] = "always"

data/tests/customer_include_spec.rb

@@ -12,7 +12,7 @@ describe 'Customer include' do
 
     BrpmAuto.setup(input_params)
 
-    params = BrpmAuto.params
+    params = BrpmAuto.global_params
 
     expect(params).to have_key("key1")
     expect(params["key1"]).to eql("value1")

data/tests/server_yaml_spec.rb

@@ -12,7 +12,7 @@ describe 'Server yaml' do
 
     BrpmAuto.setup(input_params)
 
-    params = BrpmAuto.params
+    params = BrpmAuto.global_params
 
     expect(params).to have_key("key2")
     expect(params["key2"]).to eql("value2")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brpm_content_framework
 version: !ruby/object:Gem::Version
-  version: 0.2.32
+  version: 0.2.33
 platform: ruby
 authors:
 - Niek Bartholomeus
@@ -179,13 +179,12 @@ files:
 - bin/event_handler
 - bin/webhook_receiver
 - config.yml
+- docker/Dockerfile
+- docker/docker_execute_automation
 - infrastructure/.bashrc
 - infrastructure/.brpm
 - infrastructure/config/customer_include.rb
 - infrastructure/config/server.yml
-- infrastructure/create_output_file.rb
-- infrastructure/docker/Dockerfile
-- infrastructure/docker/docker_execute_automation
 - infrastructure/log.html
 - infrastructure/module_template/Dockerfile
 - infrastructure/module_template/Gemfile
@@ -211,6 +210,7 @@ files:
 - infrastructure/scripts/run_event_handler.sh
 - infrastructure/scripts/run_webhook_receiver.cmd
 - infrastructure/scripts/run_webhook_receiver.sh
+- infrastructure/setup_brpm_core_framework.rb
 - infrastructure/silent_install_options_4.6.txt
 - infrastructure/silent_install_options_upgrade_4.6.txt
 - infrastructure/smtp_settings.rb