brpm_content_framework 0.2.38 → 0.2.39

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjNiZmRlYTE2MWVlZjMyYzUwMDZmMWQyNTMzNzcxNGFjY2I3MDE3Ng==
+    NGJmYTgzYjZlNDBjMzYxODY3NDIwZWIxNDNlZmNhZDkzZDNlYmJiYQ==
   data.tar.gz: !binary |-
-    NmRjNzE0Y2U1NjBlYzNhMGY2ODUxNGVjNjA0MWY5ODc4YjZhMjgzYQ==
+    ZjkzY2VjNzZlMGU1NmM1MGU3YTgyMGY4NTU0YjI4NTA5YmZlNWUzZg==
 SHA512:
   metadata.gz: !binary |-
-    NjRmMzZjYTUwMWE0MzQwNjJlNjEyNGEzOGI1YzhkNTM1OTI1Mzc0YjNlMjc5
-    OWY1NDU3OWVmYjBlYjI2M2I4NmExNDI2ZWE2YWIzNGJhY2JjMzRlYzRhZDEz
-    NzI4MGI4OTZjY2Q4MzkzMzQ4N2VkNDdmYWM0OWRhZmI1OWFiYTM=
+    NjE3N2MyMTJjY2E0MWYwYmJmZWJjZDBlNTJlZjE2ZTU4ZDBiNjYyYTgzYTRj
+    MzYxN2JiN2NiYzA1Y2ZiZGUyYjYzN2U0ODgzMGE1NGZjNjc0YjljNjAyZjc0
+    MzM0NTljNjhlNjEzNGFhYjRiYmI0NDU5ODU1ZTU5OWM1OGQxMjM=
   data.tar.gz: !binary |-
-    ODA3ZmNlMzYyNDMwOTI0M2QyZjQ2YjQ2NWVjZjBkM2E1MDEwODFiNTQ5MDli
-    NTk4MzBjNjc4NTg1MjA4MmY2MmFlZDUxMmYwYTYxODRmZDQwYzk3NTdmNGE2
-    MjA1OGU2NjA1M2M5OWViZmY1YmYyZmM4MWRkMjgwNGFmNjhlMTY=
+    ODJiOTk1YmRiM2IwNGM2MzM2Nzk0NDNmYjlmY2JlNTY1OGQ0OTJkMDNjNmRi
+    ZmY5NjAyMDA0YTM5YjQ5YWE0N2UxMjYwODk1ZGE4ZWJkNzFhMGY2N2JlYTFh
+    MGQzOWQ4YzczZjQ3Yzk4YTIxZDkyMmQzZjk3Njc1ODYwYTVhYmQ=

data/config.yml

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

data/docker/Dockerfile

@@ -4,10 +4,10 @@ MAINTAINER Niek Bartholomeus <niek.bartholomeus@gmail.com>
 ENV BRPM_CONTENT_FRAMEWORK_VERSION 1.0.0
 ENV GEM_HOME /usr/lib/ruby/gems/1.9.1
 
-RUN gem install "brpm_content_framework" --ignore-dependencies -v "$BRPM_CONTENT_FRAMEWORK_VERSION" && \
-    cd "$GEM_HOME/gems/brpm_content_framework-$BRPM_CONTENT_FRAMEWORK_VERSION" && \
+RUN gem install brpm_content_framework -v $BRPM_CONTENT_FRAMEWORK_VERSION && \
+    cd $GEM_HOME/gems/brpm_content_framework-$BRPM_CONTENT_FRAMEWORK_VERSION && \
     bundle install && \
-    rm -rf "$GEM_HOME/cache"
+    rm -rf $GEM_HOME/cache
 
 ADD . /
 

data/infrastructure/scripts/publish_module_version.sh

@@ -12,7 +12,7 @@ fi
 cd $(dirname $0)/../../../$MODULE_NAME
 
 echo ""
-echo ">>> Publishing the module as a gem to rubygems.org..."
+echo ">>> Publishing module $MODULE_NAME as a gem to rubygems.org..."
 rake release
 if [ -f "docker/Dockerfile" ]; then
     MODULE_VERSION=$(eval "sed -n \"s=version: \(.*\)=\1=p\" config.yml")
@@ -27,17 +27,19 @@ if [ -f "docker/Dockerfile" ]; then
     sed -i "" s/$OLD_MODULE_VERSION/$MODULE_VERSION/ Dockerfile
 
     echo ""
-    echo ">>> Building the docker image..."
+    echo ">>> Building docker image 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..."
+    echo ">>> Publishing docker image bmcrlm/$MODULE_NAME:$MODULE_VERSION to the docker hub..."
     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 || { echo 'Aborting' ; exit 1; }
-    docker push bmcrlm/$MODULE_NAME:latest || { echo 'Aborting' ; exit 1; }
+    if [[ "$MODULE_NAME" == brpm_content_framework ]]; then
+        echo ""
+        echo ">>> Tagging bmcrlm/$MODULE_NAME:$MODULE_VERSION as bmcrlm/$MODULE_NAME:latest..."
+        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
 fi

data/lib/brpm_script_executor.rb

@@ -35,8 +35,9 @@ class BrpmScriptExecutor
           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?
+          _, _, _, status = BrpmAuto.execute_command("docker history -q bmcrlm/#{modul}:#{module_version}")
+
+          use_docker = status.success?
         else
           use_docker = false
         end
@@ -48,19 +49,19 @@ class BrpmScriptExecutor
         automation_results_path = params["SS_automation_results_dir"] || working_path
         script_support_path = params["SS_script_support_path"] || working_path
 
+        params_for_process = params.clone # we don't want to modify the current session's params
         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"] = 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_for_process["SS_output_dir"] = "/workdir"
+          params_for_process["SS_output_file"] = params_for_process["SS_output_file"].sub(working_path, "/workdir") if params_for_process["SS_output_file"]
+          params_for_process["SS_automation_results_dir"] = "/automation_results"
+          params_for_process["SS_script_support_path"] = "/script_support"
 
-          params["log_file"] = params["log_file"].sub(working_path, "/workdir") if params["log_file"]
+          params_for_process["log_file"] = params_for_process["log_file"].sub(working_path, "/workdir") if params_for_process["log_file"]
         end
 
         BrpmAuto.log "Temporarily storing the params to #{params_path}..."
         File.open(params_path, "w") do |file|
-          file.puts(params.to_yaml)
+          file.puts(params_for_process.to_yaml)
         end
 
         if use_docker
@@ -71,7 +72,6 @@ class BrpmScriptExecutor
             command += " \"#{offset}\"" if offset
             command += " \"#{max_records}\"" if max_records
           end
-          result = BrpmAuto.execute_shell(command)
 
         else
           env_var_gem_home = "export GEM_HOME=#{ENV["BRPM_CONTENT_HOME"] || "#{ENV["BRPM_HOME"]}/modules"};"
@@ -96,27 +96,24 @@ class BrpmScriptExecutor
           end
 
           BrpmAuto.log "Executing the script in a separate process..."
-          command = <<EOR
+          ruby_command = <<EOR
 #{require_bundler}
 require \\"brpm_script_executor\\"
 BrpmScriptExecutor.execute_automation_script_from_other_process(\\"#{modul}\\", \\"#{name}\\", \\"#{params_path}\\", \\"#{automation_type}\\", \\"#{parent_id}\\", \\"#{offset}\\", \\"#{max_records}\\")
 EOR
-          result = Bundler.with_clean_env { BrpmAuto.execute_shell("#{env_var_gem_home}#{env_var_bundler}ruby -e \"#{command}\"") }
+          command = "#{env_var_gem_home}#{env_var_bundler}ruby -e \"#{ruby_command}\""
         end
 
-        FileUtils.rm(params_path) if File.exists?(params_path)
-
-        unless result["status"] == 0
-          if result["stdout"] and !result["stdout"].empty?
-            BrpmAuto.log "stdout of the executed process:"
-            BrpmAuto.log "-----------------------------------------------------------"
-            BrpmAuto.log result["stdout"]
-            BrpmAuto.log "-----------------------------------------------------------"
+        _, stderr, _, status = Bundler.with_clean_env do
+          BrpmAuto.execute_command(command) do |stdout_err|
+            BrpmAuto.log "    #{stdout_err.chomp}"
           end
-
-          raise result["stderr"]
         end
 
+        FileUtils.rm(params_path) if File.exists?(params_path)
+
+        raise "The process failed with status #{status.exitstatus}.\n#{stderr}" unless status.success?
+
         if automation_type == "resource_automation"
           result_path = params_path.sub!("params", "result")
           BrpmAuto.log "Loading the result from #{result_path} and cleaning it up..."
@@ -139,11 +136,11 @@ EOR
     def execute_automation_script_from_other_process(modul, name, params_file, automation_type, parent_id = nil, offset = nil, max_records = nil)
       raise "Params file #{params_file} doesn't exist." unless File.exists?(params_file)
 
-      puts "#{Time.now.strftime("%Y-%m-%d %H:%M:%S")}|  Loading the params from #{params_file} and cleaning it up..."
+      puts "Loading the params from #{params_file} and cleaning it up..."
       params = YAML.load_file(params_file)
       FileUtils.rm(params_file)
 
-      puts "#{Time.now.strftime("%Y-%m-%d %H:%M:%S")}|  Setting up the BRPM Content framework..."
+      puts "Setting up the BRPM Content framework..."
       BrpmAuto.setup(params)
       BrpmAuto.log "  BRPM Content framework is version #{BrpmAuto.version}."
 

data/lib/module_installer.rb

@@ -83,8 +83,13 @@ class ModuleInstaller
       end
     end
 
+    remove_docker_image(module_name, module_version)
+
     BrpmAuto.log "Uninstalling gem #{module_name} #{module_version}..."
-    BrpmAuto.log `gem uninstall #{module_name} -v #{module_version} -x`
+    _, stderr, _, status = BrpmAuto.execute_command("gem uninstall #{module_name} -v #{module_version} -x") do |stdout_err|
+      BrpmAuto.log "    #{stdout_err.chomp}"
+    end
+    raise "The process failed with status #{status.exitstatus}.\n#{stderr}" unless status.success?
 
     true
   end
@@ -156,24 +161,25 @@ class ModuleInstaller
     if File.exists?(gemfile_path)
       command = "cd #{spec.gem_dir}; bundle install"
       BrpmAuto.log "Found a Gemfile so executing command '#{command}'..."
-      result = BrpmAuto.execute_shell(command)
+      _, stderr, _, status = BrpmAuto.execute_command(command) do |stdout_err|
+        BrpmAuto.log "    #{stdout_err.chomp}"
+      end
+      raise "The process failed with status #{status.exitstatus}.\n#{stderr}" unless status.success?
     else
       BrpmAuto.log "This module doesn't have a Gemfile."
     end
-
-    BrpmAuto.log result["stdout"] if result["stdout"] and !result["stdout"].empty?
-    unless result["status"] == 0
-      raise result["stderr"]
-    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}`
-      BrpmAuto.log output
-      unless output =~ /Image is up to date for/ or output =~ /Downloaded newer image for/
+      stdout, stderr, _, status = BrpmAuto.execute_command("docker pull bmcrlm/#{spec.name}:#{spec.version}") do |stdout_err|
+        BrpmAuto.log "    #{stdout_err.chomp}"
+      end
+      raise "The process failed with status #{status.exitstatus}.\n#{stderr}" unless status.success?
+
+      unless stdout =~ /Image is up to date for/ or output =~ /Downloaded newer image 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"
@@ -183,6 +189,17 @@ class ModuleInstaller
     end
   end
 
+  def remove_docker_image(module_name, module_version)
+    case BrpmAuto.global_params["execute_automation_scripts_in_docker"]
+    when "always", "if_docker_image_exists"
+      BrpmAuto.log "Removing the docker image..."
+      _, stderr, _, status = BrpmAuto.execute_command("docker rmi $(docker images | grep bmcrlm/#{module_name}:#{module_version} | awk {'print $3'})") do |stdout_err|
+        BrpmAuto.log "    #{stdout_err.chomp}"
+      end
+      raise "The process failed with status #{status.exitstatus}.\n#{stderr}" unless status.success?
+    end
+  end
+
   def get_symlink_path
     "#{ENV["GEM_HOME"]}/gems/brpm_content_framework-latest"
   end

data/lib/utilities.rb

@@ -1,5 +1,6 @@
+require 'open3'
+
 module Utilities
-  
   EXIT_CODE_FAILURE = 'Exit_Code_Failure'
   Windows = (RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/) unless defined?(Windows)
   
@@ -77,6 +78,31 @@ module Utilities
     cmd_result
   end
 
+  def execute_command(command, sensitive_data = nil)
+    Open3.popen3(command) do |stdin, stdout, stderr, thread|
+      logs = {:out => "", :err => ""}
+
+      if block_given?
+        { :out => stdout, :err => stderr }.each do |key, stream|
+          Thread.new do
+            while line = stream.gets
+              privatized_line = BrpmAuto.privatize(line, sensitive_data)
+              logs[key] += privatized_line
+              yield privatized_line
+            end
+          end if block_given?
+        end
+
+        thread.join
+      else
+        logs[:out] = stdout.read
+        logs[:err] = stderr.read
+      end
+
+      return logs[:out], logs[:err], thread.pid, thread.value
+    end
+  end
+
   # Returns a timestamp to the thousanth of a second
   #
   # ==== Returns

data/tests/brpm_auto_spec.rb

@@ -71,7 +71,7 @@ describe 'BRPM automation framework' do
       result = BrpmAuto.execute_shell("echo Hello")
 
       expect(result["status"]).to eql(0)
-      expect(result["stdout"]).to eql("Hello\n")
+      expect(result["stdout"].chomp).to eql("Hello")
     end
 
     it 'should return with a non-zero status when passing a bad command' do
@@ -80,6 +80,36 @@ describe 'BRPM automation framework' do
       expect(result["status"]).not_to eql(0)
     end
   end
+
+  describe 'execute_shell_stream_logs' do
+    it 'should execute a command successfully' do
+      stdout, _, _, status = BrpmAuto.execute_command("echo Hello")
+
+      expect(status.success?).to be_truthy
+      expect(stdout.chomp).to eql("Hello")
+    end
+
+    it 'should execute a command successfully and stream the stdout' do
+      streamed_logs = ""
+      _, _, _, status = BrpmAuto.execute_command("echo Hello") do |stdout_err|
+        streamed_logs += stdout_err
+      end
+
+      expect(status.success?).to be_truthy
+      expect(streamed_logs.chomp).to eql("Hello")
+    end
+
+    it 'should return with a non-zero status when passing a command that raises an exception and stream the stderr' do
+      _, stderr, _, status = BrpmAuto.execute_command("ruby -e \"raise 'Boom'\"")
+
+      expect(status.success?).to be_falsey
+      expect(stderr.chomp).to eql("-e:1:in `<main>': Boom (RuntimeError)")
+    end
+
+    it 'should return with a non-zero status when passing a bad command' do
+      expect { BrpmAuto.execute_command("xxxx") }.to raise_exception
+    end
+  end
 end
 
 

data/tests/brpm_script_executor_spec.rb

@@ -45,7 +45,7 @@ describe 'BRPM Script Executor' do
     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")
+    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)
     FileUtils.move("#{gemfile_path}_tmp", gemfile_path)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: brpm_content_framework
 version: !ruby/object:Gem::Version
-  version: 0.2.38
+  version: 0.2.39
 platform: ruby
 authors:
 - Niek Bartholomeus
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-30 00:00:00.000000000 Z
+date: 2015-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh