command_exec 0.1.3 → 0.2.0

data/spec/formatter/xml_spec.rb

@@ -0,0 +1,33 @@
+#encoding: utf-8
+
+require 'spec_helper'
+
+describe Formatter::XML do
+  before :each do
+    @formatter = Formatter::XML.new
+  end
+
+  it "outputs data as XML string" do
+      @formatter.stderr(["output of stderr"])
+      @formatter.stdout("output of stdout")
+      @formatter.log_file("output of log file")
+      @formatter.return_code("output of return code")
+      @formatter.pid(4711)
+      @formatter.status(:failed)
+      @formatter.executable('/usr/bin/true')
+
+      expect(@formatter.output(:stdout,:stderr)).to eq("<command>\n  <stdout>output of stdout</stdout>\n  <stderr>output of stderr</stderr>\n</command>\n")
+  end
+
+  it "outputs data as XML string (attributes with multiple values)" do
+      @formatter.stderr(["output of stderr 1/2", "output of stderr 2/2"])
+      @formatter.stdout("output of stdout")
+      @formatter.log_file("output of log file")
+      @formatter.return_code("output of return code")
+      @formatter.pid(4711)
+      @formatter.status(:failed)
+      @formatter.executable('/usr/bin/true')
+
+      expect(@formatter.output(:stdout,:stderr)).to eq("<command>\n  <stdout>output of stdout</stdout>\n  <stderr>output of stderr 1/2</stderr>\n  <stderr>output of stderr 2/2</stderr>\n</command>\n")
+  end
+end

data/spec/formatter/yaml_spec.rb

@@ -0,0 +1,21 @@
+#encoding: utf-8
+
+require 'spec_helper'
+
+describe Formatter::YAML do
+  before :each do
+    @formatter = Formatter::YAML.new
+  end
+
+  it "outputs data as yaml string" do
+      @formatter.stderr(["output of stderr"])
+      @formatter.stdout("output of stdout")
+      @formatter.log_file("output of log file")
+      @formatter.return_code("output of return code")
+      @formatter.pid(4711)
+      @formatter.status(:failed)
+      @formatter.executable('/usr/bin/true')
+
+      expect(@formatter.output(:stdout,:stderr)).to eq("---\n:stdout:\n- output of stdout\n:stderr:\n- output of stderr\n")
+  end
+end

data/spec/process/process_spec.rb

@@ -0,0 +1,329 @@
+#encoding: utf-8
+
+require 'spec_helper'
+
+describe CommandExec::Process do
+
+  let(:dev_null) { StringIO.new }
+
+  context :private_api do; end
+
+  context :public_api do
+
+    it "has a executable" do
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null))
+      process.executable = '/bin/sh'
+      expect(process.executable).to eq('/bin/sh')
+    end
+
+    it "opens a log file" do
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null))
+      tmp_file = create_temp_file_with('process.log' , 'this is content' )
+      process.log_file = tmp_file
+
+      expect(process.log_file).to eq(['this is content'])
+    end
+
+    it "accepts nil as filename" do
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null))
+      process.log_file = nil
+
+      expect(process.log_file).to eq([])
+    end
+
+    it 'accepts a start time' do
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null))
+      time = Time.now
+      process.start_time = time
+
+      expect(process.start_time).to eq(time)
+    end
+
+    it 'accepts an end time' do
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null))
+      time = Time.now
+      process.end_time = time
+
+      expect(process.end_time).to eq(time)
+    end
+
+    it 'calculates the run time' do
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null))
+      time = Time.now
+      process.start_time = time
+      process.end_time = time + 2.seconds
+
+      expect(process.run_time).to eq(2.seconds)
+    end
+
+    it "goes on with a warning, if log file doesn't exists" do
+      file = '/tmp/test1234.txt'
+      bucket = StringIO.new
+      process = CommandExec::Process.new(lib_logger: Logger.new(bucket))
+      tmp_file = create_temp_file_with('process.log' , 'this is content' )
+      process.log_file = file
+      process.log_file
+
+      expect(bucket.string[file]).to_not eq(nil)
+    end
+
+    it "takes stdout" do
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null)) 
+      process.stdout = 'content'
+      expect(process.stdout).to eq(['content'])
+
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null)) 
+      process.stdout = ['content']
+      expect(process.stdout).to eq(['content'])
+    end
+
+    it "takes stderr" do
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null)) 
+      process.stderr = 'content'
+      expect(process.stderr).to eq(['content'])
+
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null)) 
+      process.stderr = ['content']
+      expect(process.stderr).to eq(['content'])
+    end
+
+    it "takes a pid" do
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null)) 
+      process.pid = 4711
+      expect(process.pid).to eq("4711")
+
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null)) 
+      process.pid = "4711"
+      expect(process.pid).to eq("4711")
+    end
+
+    it "takes a status" do
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null)) 
+      process.status = :failed
+      expect(process.status).to eq(:failed)
+
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null)) 
+      process.status = :success
+      expect(process.status).to eq(:success)
+
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null)) 
+      process.status = :unknown
+      expect(process.status).to eq(:failed)
+    end
+
+    it "takes a reason for a failure" do
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null)) 
+      process.reason_for_failure = 'this is an error msg'
+      expect(process.reason_for_failure).to eq(['this is an error msg'])
+    end
+
+    it "takes a return code" do
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null)) 
+      process.return_code = 1
+      expect(process.return_code).to eq(1)
+    end
+
+    it "returns an array" do
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null)) 
+
+      process.stderr = "output of stderr"
+      process.stdout = "output of stdout"
+      process.log_file = create_temp_file_with('process.log' , 'output of log file' )
+      process.return_code = "output of return code"
+      process.status = :failed
+      process.pid = 4711
+      process.reason_for_failure = 'great an error occured'
+      process.executable = '/bin/true'
+
+      start_time = Time.now
+      end_time= start_time + 2.seconds
+      process.start_time = start_time
+      process.end_time = end_time
+
+      expect(process.to_a).to eq([
+        "=====       STATUS       =====",
+        "\e[1;31mFAILED\e[0m",
+        "=====    RETURN CODE     =====",
+        "output of return code",
+        "=====       STDERR       =====",
+        "output of stderr",
+        "=====       STDOUT       =====",
+        "output of stdout",
+        "=====      LOG FILE      =====",
+        "output of log file",
+        "=====        PID         =====",
+        "4711",
+        "===== REASON FOR FAILURE =====",
+        "great an error occured",
+        "=====     EXECUTABLE     =====",
+        "/bin/true",
+        "=====     START TIME     =====",
+        start_time,
+        "=====      END TIME      =====",
+        end_time,
+      ])
+
+      expect(process.to_a(:status)).to eq([
+        "=====       STATUS       =====",
+        "\e[1;31mFAILED\e[0m",
+      ])
+
+    end
+
+    it "returns a hash" do
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null)) 
+
+      process.stderr = "output of stderr"
+      process.stdout = "output of stdout"
+      process.log_file = create_temp_file_with('process.log' , 'output of log file' )
+      process.return_code = "output of return code"
+      process.status = :failed
+      process.pid = 4711
+      process.reason_for_failure = 'great an error occured'
+      process.executable = '/usr/bin/true'
+
+      start_time = Time.now
+      end_time= start_time + 2.seconds
+      process.start_time = start_time
+      process.end_time = end_time
+
+      expect(process.to_h).to eq({ 
+        stderr: ["output of stderr"],
+        stdout: ["output of stdout"],
+        log_file: ["output of log file"],
+        return_code: ["output of return code"],
+        status: ['FAILED'],
+        pid: ['4711'],
+        reason_for_failure: ['great an error occured'],
+        executable: ['/usr/bin/true'],
+        start_time: [ start_time ],
+        end_time: [ end_time],
+      })
+    end
+
+    it 'returns a string version of process' do
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null)) 
+
+      process.stderr = "output of stderr"
+      process.stdout = "output of stdout"
+      process.log_file = create_temp_file_with('process.log' , 'output of log file' )
+      process.return_code = "output of return code"
+      process.status = :failed
+      process.pid = 4711
+      process.reason_for_failure = 'great an error occured'
+      process.executable = '/usr/bin/true'
+
+      start_time = Time.now
+      end_time= start_time + 2.seconds
+      process.start_time = start_time
+      process.end_time = end_time
+
+      expect(process.to_s).to eq([
+        "=====       STATUS       =====",
+        "\e[1;31mFAILED\e[0m",
+        "=====    RETURN CODE     =====",
+        "output of return code",
+        "=====       STDERR       =====",
+        "output of stderr",
+        "=====       STDOUT       =====",
+        "output of stdout",
+        "=====      LOG FILE      =====",
+        "output of log file",
+        "=====        PID         =====",
+        "4711",
+        "===== REASON FOR FAILURE =====",
+        "great an error occured",
+        "=====     EXECUTABLE     =====",
+        "/usr/bin/true",
+        "=====     START TIME     =====",
+        start_time,
+        "=====      END TIME      =====",
+        end_time,
+      ].join("\n")
+                                )
+    end
+
+    it 'returns a json encoded string' do
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null)) 
+
+      process.stderr = "output of stderr"
+      process.stdout = "output of stdout"
+      process.log_file = create_temp_file_with('process.log' , 'output of log file' )
+      process.return_code = "output of return code"
+      process.status = :failed
+      process.pid = 4711
+      process.reason_for_failure = 'great an error occured'
+      process.executable = '/usr/bin/true'
+
+      start_time = Time.now
+      end_time= start_time + 2.seconds
+      process.start_time = start_time
+      process.end_time = end_time
+
+      expect(process.to_json).to eq("{\"status\":[\"FAILED\"],\"return_code\":[\"output of return code\"],\"stderr\":[\"output of stderr\"],\"stdout\":[\"output of stdout\"],\"log_file\":[\"output of log file\"],\"pid\":[\"4711\"],\"reason_for_failure\":[\"great an error occured\"],\"executable\":[\"/usr/bin/true\"],\"start_time\":[\"#{start_time}\"],\"end_time\":[\"#{end_time}\"]}")
+    end
+
+    it 'returns a json encoded string and supports unicode as well' do
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null)) 
+
+      process.stderr = "this is an 'ä'"
+      process.stdout = "output of stdout"
+      process.log_file = create_temp_file_with('process.log' , 'output of log file' )
+      process.return_code = "output of return code"
+      process.status = :failed
+      process.pid = 4711
+      process.reason_for_failure = 'great an error occured'
+      process.executable = '/usr/bin/true'
+
+      start_time = Time.now
+      end_time= start_time + 2.seconds
+      process.start_time = start_time
+      process.end_time = end_time
+
+      expect(process.to_json).to eq("{\"status\":[\"FAILED\"],\"return_code\":[\"output of return code\"],\"stderr\":[\"this is an 'ä'\"],\"stdout\":[\"output of stdout\"],\"log_file\":[\"output of log file\"],\"pid\":[\"4711\"],\"reason_for_failure\":[\"great an error occured\"],\"executable\":[\"/usr/bin/true\"],\"start_time\":[\"#{start_time}\"],\"end_time\":[\"#{end_time}\"]}")
+    end
+
+    it 'returns a yaml encoded string' do
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null)) 
+
+      process.stderr = "output of stderr"
+      process.stdout = "output of stdout"
+      process.log_file = create_temp_file_with('process.log' , 'output of log file' )
+      process.return_code = "output of return code"
+      process.status = :failed
+      process.pid = 4711
+      process.reason_for_failure = 'great an error occured'
+      process.executable = '/usr/bin/true'
+
+      start_time = Time.now
+      end_time= start_time + 2.seconds
+      process.start_time = start_time
+      process.end_time = end_time
+
+      time_format_string = "%Y-%m-%d %H:%M:%S.%9N %:z"
+
+      expect(process.to_yaml).to eq("---\n:status:\n- FAILED\n:return_code:\n- output of return code\n:stderr:\n- output of stderr\n:stdout:\n- output of stdout\n:log_file:\n- output of log file\n:pid:\n- '4711'\n:reason_for_failure:\n- great an error occured\n:executable:\n- /usr/bin/true\n:start_time:\n- #{start_time.strftime(time_format_string)}\n:end_time:\n- #{end_time.strftime(time_format_string)}\n")
+    end
+
+    it 'returns a xml encoded string' do
+      process = CommandExec::Process.new(lib_logger: Logger.new(dev_null)) 
+
+      process.stderr = "output of stderr"
+      process.stdout = "output of stdout"
+      process.log_file = create_temp_file_with('process.log' , 'output of log file' )
+      process.return_code = "output of return code"
+      process.status = :failed
+      process.pid = 4711
+      process.reason_for_failure = 'great an error occured'
+      process.executable = '/usr/bin/true'
+
+      start_time = Time.now
+      end_time= start_time + 2.seconds
+      process.start_time = start_time
+      process.end_time = end_time
+
+      expect(process.to_xml).to eq("<command>\n  <status>FAILED</status>\n  <return_code>output of return code</return_code>\n  <stderr>output of stderr</stderr>\n  <stdout>output of stdout</stdout>\n  <log_file>output of log file</log_file>\n  <pid>4711</pid>\n  <reason_for_failure>great an error occured</reason_for_failure>\n  <executable>/usr/bin/true</executable>\n  <start_time>#{start_time}</start_time>\n  <end_time>#{end_time}</end_time>\n</command>\n")
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -1,21 +1,32 @@
 #encoding: utf-8
+
 $LOAD_PATH << File.expand_path('../lib' , File.dirname(__FILE__))
 
-require 'pry'
-require 'stringio'
+unless ENV['TRAVIS_CI'] == 'true'
+  require 'pry'
+  require 'debugger'
+  require 'ap'
+end
 
+require 'stringio'
 require 'tempfile'
 
-require 'simplecov'
-SimpleCov.start
+unless ENV['TRAVIS_CI'] == 'true'
+  require 'simplecov'
+  SimpleCov.start
+end
 
 require 'command_exec'
 require 'command_exec/spec_helper_module'
+require 'active_support/core_ext/numeric/time'
 
 include CommandExec
 include CommandExec::Exceptions
 
 RSpec.configure do |c|
   c.include CommandExec::SpecHelper
+  c.treat_symbols_as_metadata_keys_with_true_values = true
+  c.filter_run_including :focus => true
 end
 
+#ENV['PATH'] = '/bin'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: command_exec
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-23 00:00:00.000000000 Z
+date: 2012-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: POpen4
+  name: smart_colored
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -28,7 +28,23 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: colored
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: xml-simple
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -51,21 +67,58 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
+- .yardopts
 - Gemfile
 - Gemfile.lock
 - Guardfile
 - LICENSE.md
 - README.md
+- RELEASE_NOTES.md
 - Rakefile
 - TODO.md
 - command_exec.gemspec
+- gemfiles/Gemfile.default
+- gemfiles/Gemfile.travis
+- gemfiles/Gemfile.travis.lock
 - lib/command_exec.rb
 - lib/command_exec/command.rb
 - lib/command_exec/exceptions.rb
+- lib/command_exec/field_helper.rb
+- lib/command_exec/formatter/array.rb
+- lib/command_exec/formatter/hash.rb
+- lib/command_exec/formatter/json.rb
+- lib/command_exec/formatter/string.rb
+- lib/command_exec/formatter/xml.rb
+- lib/command_exec/formatter/yaml.rb
+- lib/command_exec/logger.rb
+- lib/command_exec/process.rb
 - lib/command_exec/spec_helper_module.rb
 - lib/command_exec/version.rb
+- script/console
 - script/terminal
 - spec/command/command_spec.rb
+- spec/command/test_data/echo_test
+- spec/command/test_data/exit_status_test
+- spec/command/test_data/log_file_test
+- spec/command/test_data/logger_test
+- spec/command/test_data/not_raise_error_test
+- spec/command/test_data/not_throw_error_test
+- spec/command/test_data/output_test
+- spec/command/test_data/raise_error_test
+- spec/command/test_data/runner_open3_test
+- spec/command/test_data/runner_system_test
+- spec/command/test_data/stderr_test
+- spec/command/test_data/stdout_multiple_lines_test
+- spec/command/test_data/stdout_test
+- spec/command/test_data/throw_error_test
+- spec/command/test_data/true_test
+- spec/formatter/array_spec.rb
+- spec/formatter/hash_spec.rb
+- spec/formatter/json_spec.rb
+- spec/formatter/xml_spec.rb
+- spec/formatter/yaml_spec.rb
+- spec/process/process_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses: []
@@ -87,11 +140,32 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Helper gem to exectue arbitrary shell commands
 test_files:
 - spec/command/command_spec.rb
+- spec/command/test_data/echo_test
+- spec/command/test_data/exit_status_test
+- spec/command/test_data/log_file_test
+- spec/command/test_data/logger_test
+- spec/command/test_data/not_raise_error_test
+- spec/command/test_data/not_throw_error_test
+- spec/command/test_data/output_test
+- spec/command/test_data/raise_error_test
+- spec/command/test_data/runner_open3_test
+- spec/command/test_data/runner_system_test
+- spec/command/test_data/stderr_test
+- spec/command/test_data/stdout_multiple_lines_test
+- spec/command/test_data/stdout_test
+- spec/command/test_data/throw_error_test
+- spec/command/test_data/true_test
+- spec/formatter/array_spec.rb
+- spec/formatter/hash_spec.rb
+- spec/formatter/json_spec.rb
+- spec/formatter/xml_spec.rb
+- spec/formatter/yaml_spec.rb
+- spec/process/process_spec.rb
 - spec/spec_helper.rb
 has_rdoc: