easy_app_helper 3.0.6 → 3.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ea069d461f143561b29ca40450dd1f2f2ca3ddb
-  data.tar.gz: b96c99a38b96cdec7fe66338e5da0cdd72fd80c8
+  metadata.gz: 635c849e54c3e7484c113e625a6b7919b1d4608a
+  data.tar.gz: 5c0f578d46c51f52ce63871458155479f2bd09e7
 SHA512:
-  metadata.gz: 828ec354346f85946ac7330c63652a007797bda27105bfb408d0a8e0c2b6fce700650cd933e7e371abab9de1160134ca23f874bfb69d9712fb149a822e40e067
-  data.tar.gz: 81cdd985aab372438dfe47b59e9de0bbd6ee6f0caedc3f1dc46f7bc959d7b3a006573028cd982d755507deb2252701dc7cbd13cb112bf690e5fab2dd5ed05d52
+  metadata.gz: 123516bb890c57f720faeb44d34ceb600accd16d3807fe798a74ace6b0eff4029a3d0bd255ae0446b97380f7d0a7aca819d959e563f86d4166ba021e6e95e4bf
+  data.tar.gz: 06e01c697f545dc437a7e065be01c18b3922d0beff0ecc2c8cf462140f3e77c3b5284ff67caf2047c490983b17e84e4b9f38fa7641d7b125f9e42dc110f7a8c2

data/lib/easy_app_helper/processes/base.rb

@@ -0,0 +1,51 @@
+require 'open3'
+
+module EasyAppHelper
+  module Processes
+
+    class Base
+
+      include EasyAppHelper::Processes::Command
+      include EasyAppHelper::Processes::TimeManagement
+
+      attr_reader :process_state, :exit_status, :last_pid, :mode
+      attr_accessor :show_output, :log_output
+
+      def initialize(command = nil, mode = :synchronous)
+        self.command = command
+        self.process_state = :not_started
+        self.mode = mode
+        self.creation_time = Time.now
+      end
+
+      def mode=(mode)
+        mode_processor = Object.const_get "EasyAppHelper::Processes::#{mode.to_s.capitalize}"
+        self.extend mode_processor
+        @mode = mode.to_sym
+      rescue
+        raise "Invalid process mode '#{mode}'"
+      end
+
+      private
+
+      attr_writer :process_state, :exit_status, :last_pid
+
+      def report(message, to_stdout = true)
+        if show_output
+          to_stdout ? puts(message) : STDERR.puts(message)
+        end
+        if log_output
+            log_line = "[subprocess #{last_pid}] - #{message}"
+            if to_stdout
+              EasyAppHelper.logger.debug log_line
+            else
+              EasyAppHelper.logger.warn log_line
+            end
+        end
+
+      end
+
+    end
+
+  end
+end

data/lib/easy_app_helper/processes/command.rb

@@ -0,0 +1,15 @@
+module EasyAppHelper
+  module Processes
+
+    module Command
+
+      attr_accessor :command
+
+      def valid?
+        File.exists? self.command.split(' ').first
+      end
+
+    end
+
+  end
+end

data/lib/easy_app_helper/processes/synchronous.rb

@@ -0,0 +1,51 @@
+module EasyAppHelper
+  module Processes
+
+    module Synchronous
+
+      def execute
+        self.exit_status = nil
+        self.last_pid = nil
+        self.process_state = :running
+        self.start_time = Time.now
+        Open3.popen3(command) do |stdin, stdout, stderr, wait_thread|
+          stdin.close
+          self.last_pid = wait_thread.pid
+          begin
+            monitored_streams = [stdout, stderr]
+            loop do
+              begin
+                readables, writables = IO.select(monitored_streams)
+                writables.each(&:close)
+                readables.each do |io|
+                  begin
+                    buffer = ''
+                    buffer << io.read_nonblock(1) while buffer[-1] != "\n"
+                    report buffer, io == stdout
+                  rescue IO::WaitReadable
+                    next
+                  rescue EOFError => e
+                    monitored_streams.delete io
+                    monitored_streams.empty? ? raise(e) : next
+                  end
+                end
+              rescue EOFError
+                report "End of process #{wait_thread.value.pid}"
+                break
+              end
+            end
+          rescue Errno::EAGAIN
+            retry
+          end
+          self.exit_status = wait_thread.value
+          return self.exit_status
+        end
+      ensure
+        self.end_time = Time.now
+        self.process_state = :terminated
+      end
+
+    end
+
+  end
+end

data/lib/easy_app_helper/processes/time_management.rb

@@ -0,0 +1,21 @@
+require 'open3'
+
+module EasyAppHelper
+  module Processes
+
+    module TimeManagement
+
+      attr_reader :creation_time, :start_time, :end_time
+
+      def duration
+        end_time - start_time
+      end
+
+      private
+
+      attr_writer :creation_time, :start_time, :end_time
+
+    end
+
+  end
+end

data/lib/easy_app_helper/processes.rb

@@ -0,0 +1,4 @@
+require 'easy_app_helper/processes/time_management'
+require 'easy_app_helper/processes/command'
+require 'easy_app_helper/processes/synchronous'
+require 'easy_app_helper/processes/base'

data/lib/easy_app_helper/version.rb

@@ -1,3 +1,3 @@
 module EasyAppHelper
-  VERSION = '3.0.6'
+  VERSION = '3.0.7'
 end

data/lib/easy_app_helper.rb

@@ -10,18 +10,31 @@ require 'easy_app_helper/logger/initializer'
 require 'easy_app_helper/logger/wrapper'
 require 'easy_app_helper/managed_logger'
 
+require 'easy_app_helper/processes'
+
+
 module EasyAppHelper
 
   def puts_and_logs(*args)
     logger.puts_and_logs *args
   end
 
-  def safely_exec(message, *args, &block)
-    if self[:simulate]
-      puts_and_logs "SIMULATING: #{message}" unless message.nil?
+  def safely_exec_code(message, *args, &block)
+    if self.config[:simulate]
+      puts_and_logs "[SIMULATION MODE]: #{message}" unless message.nil?
     else
       puts_and_logs message
-      yield(*args)
+      block.call *args
+    end
+  end
+
+  def safely_exec_command(message, command, show_output = false, log_output = true)
+    safely_exec_code message, command, show_output, log_output do |command, show_output, log_output|
+      process = EasyAppHelper::Processes::Base.new command
+      process.show_output = show_output
+      process.log_output = log_output
+      process.execute
+      process
     end
   end
 

data/spec/easy_app_helper_spec.rb

@@ -3,7 +3,10 @@ require 'spec_helper'
 
 describe EasyAppHelper do
 
-  %i(config logger puts_and_logs safely_exec).each do |m|
+  let (:message) { :a_message }
+  subject {described_class}
+
+  %i(config logger puts_and_logs safely_exec_code safely_exec_command).each do |m|
     it "should have a :#{m.to_s} module method" do
       expect(subject).to respond_to m
     end
@@ -17,7 +20,7 @@ describe EasyAppHelper do
       A.new
     }
 
-    %i(config logger puts_and_logs safely_exec).each do |m|
+    %i(config logger puts_and_logs safely_exec_code safely_exec_command).each do |m|
       it "should have a :#{m.to_s} method " do
         expect(subject).to respond_to m
       end
@@ -25,4 +28,22 @@ describe EasyAppHelper do
     end
 
   end
+
+  it 'should allow to safely execute a block' do
+    expect do
+      subject.safely_exec_code message do
+        raise
+      end
+    end.to raise_error
+
+    subject.config[:simulate] = true
+    expect do
+      subject.safely_exec_code message do
+        raise
+      end
+    end.not_to raise_error
+
+  end
+
+
 end

data/spec/processes/base_spec.rb

@@ -0,0 +1,70 @@
+require 'spec_helper'
+
+describe EasyAppHelper::Processes::Base do
+
+  subject {described_class.new}
+
+  before(:all) do
+    EasyAppHelper.config[:debug] = true
+    EasyAppHelper.config[:'log-level'] = 0
+    io = IO.new File.open('/tmp/pipo.log', 'w').fileno
+    io.sync
+    EasyAppHelper::Logger::Initializer.setup_logger Logger.new(io)
+    EasyAppHelper.logger.info 'Hi World'
+  end
+
+  it 'should be a synchronous job by default' do
+    expect(subject.mode).to eq :synchronous
+  end
+
+  context 'when the command is invalid' do
+    let (:command) {'blablabla'}
+    subject {described_class.new command}
+
+    it 'should raise an exception' do
+      expect { subject.execute }.to raise_error
+    end
+
+  end
+
+  context 'when the command can execute and returns a status' do
+
+    let (:true_command) { 'true' }
+    let (:false_command) { 'false' }
+
+    it 'should capture the command exit status' do
+      subject.command = true_command
+      expect(subject.execute.success?).to be_truthy
+      subject.command = false_command
+      expect(subject.execute.success?).to be_falsey
+    end
+
+    it 'should have a valid duration' do
+      subject.command = true_command
+      expect(subject.creation_time).not_to be_nil
+      expect(subject.start_time).to be_nil
+      expect(subject.end_time).to be_nil
+      subject.execute
+      expect(subject.start_time).not_to be_nil
+      expect(subject.end_time).not_to be_nil
+      expect(subject.duration).to be > 0
+    end
+
+  end
+
+  context 'when executing a job that has "out" and "err" outputs' do
+
+    let (:command_with_out) {File.expand_path('../../../test/process/test.sh', __FILE__)}
+
+    it 'should capture everything' do
+      subject.command = command_with_out
+      subject.show_output = true
+      expect(STDOUT).to receive(:puts).exactly(3).times
+      expect(STDERR).to receive(:puts).exactly(2).times
+      subject.execute
+    end
+
+
+  end
+
+end

data/test/process/test.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+echo "This is on the standard OUTPUT"
+echo "This is on the standard ERROR" >&2
+echo "This is on the standard OUTPUT too"
+echo "This is on the standard ERROR too" >&2
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_app_helper
 version: !ruby/object:Gem::Version
-  version: 3.0.6
+  version: 3.0.7
 platform: ruby
 authors:
 - L.Briais
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-12 00:00:00.000000000 Z
+date: 2016-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,6 +116,11 @@ files:
 - lib/easy_app_helper/logger/initializer.rb
 - lib/easy_app_helper/logger/wrapper.rb
 - lib/easy_app_helper/managed_logger.rb
+- lib/easy_app_helper/processes.rb
+- lib/easy_app_helper/processes/base.rb
+- lib/easy_app_helper/processes/command.rb
+- lib/easy_app_helper/processes/synchronous.rb
+- lib/easy_app_helper/processes/time_management.rb
 - lib/easy_app_helper/tasks.rb
 - lib/easy_app_helper/version.rb
 - lib/tasks/easy_app_helper_tasks.rake
@@ -124,6 +129,7 @@ files:
 - spec/config_spec.rb
 - spec/easy_app_helper_spec.rb
 - spec/logger_spec.rb
+- spec/processes/base_spec.rb
 - spec/spec_helper.rb
 - test/foo/Gemfile
 - test/foo/LICENSE.txt
@@ -132,6 +138,7 @@ files:
 - test/foo/foo.gemspec
 - test/foo/lib/foo.rb
 - test/foo/lib/foo/version.rb
+- test/process/test.sh
 homepage: https://github.com/lbriais/easy_app_helper
 licenses:
 - MIT
@@ -161,6 +168,7 @@ test_files:
 - spec/config_spec.rb
 - spec/easy_app_helper_spec.rb
 - spec/logger_spec.rb
+- spec/processes/base_spec.rb
 - spec/spec_helper.rb
 - test/foo/Gemfile
 - test/foo/LICENSE.txt
@@ -169,3 +177,4 @@ test_files:
 - test/foo/foo.gemspec
 - test/foo/lib/foo.rb
 - test/foo/lib/foo/version.rb
+- test/process/test.sh