maestro_shell 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38403db26c3a5efb5b432a820decf1f2903400b4
+  data.tar.gz: efd918de63d982acac5623e41d483e32e33b7ce6
+SHA512:
+  metadata.gz: 48f1468bbe9cd070fd9179499c30702caa957687bbad57f28bab347822363eee1bcd65b584b2aeb96d3fc70886f05e5090a563fa3709915d341b24e3482e0254
+  data.tar.gz: a7a615eab7b4ef79e509d1128d56fcb5054326426b0f07d7cf9824179f8fcfffe0759f0e6215043a4ae9c740dc77411c47fb913bd6eef0634b298d8953888641

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rvmrc

@@ -0,0 +1 @@
+rvm use jruby-1.7.4

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    maestro_shell (0.0.1)
+      json (>= 1.4.6)
+      logging (= 1.8.0)
+      rubyzip (= 0.9.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    json (1.8.0)
+    json (1.8.0-java)
+    little-plugger (1.1.3)
+    logging (1.8.0)
+      little-plugger (>= 1.1.3)
+      multi_json (>= 1.3.6)
+    metaclass (0.0.1)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    multi_json (1.7.7)
+    rake (10.0.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    rubyzip (0.9.8)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  maestro_shell!
+  mocha (>= 0.10.0)
+  rake
+  rspec (~> 2.13.0)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Etienne Pelletier
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+Maestro Shell Utility Gem
+=========================
+
+Library For Executing Shell commands on Linux and Windows
+=========================================================
+
+# Introduction
+
+This gem provides a simple class that allows shell commands to be run, with output gathered (both stdout and stderr) and
+return-code availability.
+Callbacks are available to deliver output in real-time as it occurs, or it may be read at the end of execution.
+
+Important:
+This gem utilizes the IO::popen4 functionality available in JRUBY.
+It is not intended to work in a non-JRUBY environment.
+
+# Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'maestro_shell'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install maestro_shell
+
+# Usage
+
+In code:
+
+    require 'shell'
+
+## Simple single-function-call:
+
+    result = Maestro::Util::Shell.run_command('ls')
+
+    puts "Return Code: #{result[0]}"
+    puts "Output:      #{result[1]}"
+
+## More complete example:
+
+This requires a delegate class/method that can read and process output as it is generated.
+The signature of the delegate method should be:
+    def method(text, is_stderr)
+
+Example code:
+
+    shell = Maestro::Util::Shell.new()
+    shell.create_script('ls')
+    shell.run_script_with_delegate(delegate, on_output)
+
+    if shell.exit_code.success?
+      puts 'Yay!'
+    else
+      puts 'Boo!!'
+    end
+
+    puts "Script exit code: #{script.exit_code.exit_code}
+    puts "Entire output:    #{script}"  # or #{script.to_s}, or #{script.output}
+
+
+    # The +text+ parameter is not necessarily a line of text... it could just be a "." being
+    # output from a long-running process.  It could also include non-printable characters
+    # as it is the raw stream from the command.
+    def output_handler(text, is_stderr)
+      # is_stderr is set if the text came from stderr vs normal stdout.
+      # This is so you can process separately if you wish
+      if is_stderr
+        handle_error_text(text)
+      end
+
+      print my_logging_class.debug(text)
+    end
+
+Notes
+-----
+
+* The 'command' passed to the shell is actually written to a script file, which is then executed.  As such, it is possible to execute multi-line commands - just pass the entire string to be written to the script file as a command.
+* The script file is run by the native shell on the target OS, in the case of Linux this is the bash shell, in Windows this is the default command processor.

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rake/clean'
+
+#require File.expand_path('../lib/maestro_plugin/version', __FILE__)
+
+CLEAN.include('pkg')
+CLOBBER.include('.bundle', '.config', 'coverage', 'InstalledFiles', 'spec/reports', 'rdoc', 'test', 'tmp')
+
+task :default => [:clean, :bundle, :spec, :build]
+
+RSpec::Core::RakeTask.new
+
+desc 'Get dependencies with Bundler'
+task :bundle do
+  sh %{bundle install}
+end

data/lib/shell.rb

@@ -0,0 +1,2 @@
+require 'util/logging'
+require 'util/shell'

data/lib/util/logging.rb

@@ -0,0 +1,21 @@
+# Copyright 2013 (c) MaestroDev.  All rights reserved.
+require 'logging'
+
+module Maestro
+
+  unless Maestro.const_defined?('Logging')
+
+    module Logging
+
+      def log
+        ::Logging::Logger.new(STDOUT)
+      end
+
+    end
+  end
+
+  class << self
+    include Maestro::Logging unless Maestro.include?(Maestro::Logging)
+  end
+
+end

data/lib/util/shell.rb

@@ -0,0 +1,121 @@
+# Copyright 2011 (c) MaestroDev.  All rights reserved.
+
+require 'tempfile'
+require 'rbconfig'
+
+module Maestro
+  module Util
+    class Shell
+
+      attr_reader :script_file
+      attr_reader :output_file
+      attr_reader :shell
+      attr_reader :exit_code
+
+      class ExitCode
+        attr_reader :exit_code
+
+        def initialize(status)
+          @exit_code = status.exitstatus
+        end
+
+        def success?
+          @exit_code == 0
+        end
+      end
+
+      # Utility variables
+      IS_WINDOWS         = RbConfig::CONFIG['host_os'] =~ /mswin/
+      SEPARATOR          = IS_WINDOWS ? "\\" : "/"
+      MOVE_COMMAND       = IS_WINDOWS ? 'move' : 'mv'
+      ENV_EXPORT_COMMAND = IS_WINDOWS ? 'set' : 'export'
+      COMMAND_SEPARATOR  = '&&' # IS_WINDOWS ? '&&' : '&&'
+      SCRIPT_EXTENSION   = IS_WINDOWS ? '.bat' : '.shell'
+      SHELL_EXECUTABLE   = IS_WINDOWS ? '' : 'bash '
+
+      def Shell.unset_env_variable(var)
+        IS_WINDOWS ? "set #{var}=" : "unset #{var}"
+      end
+
+      def Shell.run_command(command)
+        shell = Shell.new
+        shell.create_script(command)
+        shell.run_script
+        return shell.exit_code, shell.to_s
+      end
+
+      def create_script(contents)
+        raise "Script Cannot Be Empty" if contents.nil? or contents.empty?
+
+        @script_file = Tempfile.new(["script", SCRIPT_EXTENSION])
+        @output_file = Tempfile.new(['output','log'])
+        # Run any commands in the default system Ruby environment, rather
+        # than the one the agent is currently using (which within the wrapper,
+        # sets clean values for these to avoid RVM or System gems that might
+        # conflict). If the caller needs a specific Ruby environment, it should
+        # establish that itself (as the rake task does through rvm if chosen)
+        # Add clear env variable commands to head of script, since we don't necessarily have access to env here (depending on
+        # version of ruby/bugs)
+        contents = "#{Shell.unset_env_variable('GEM_HOME')}\n#{Shell.unset_env_variable('GEM_PATH')}\n#{contents}"
+        @script_file.write(contents)
+        @script_file.close
+        Maestro.log.debug "Writing Script File To #{@script_file.path}"
+        return get_command(@script_file.path)
+      end
+
+      def run_script
+        run_script_with_delegate(nil, nil)
+      end
+
+      # if +delegate+ provided, the method named/symbolized by +on_output+ value will be called for each line
+      # of output to either stdout or stderr.
+      # two parameters are passed:
+      #   +text+  String  Output text.  This may be any amount of data from 1 character to many lines.
+      #                   do not assume it always represents a single line.
+      #   +err+   Boolean True if line is from stderr
+      def run_script_with_delegate(delegate, on_output)
+        File.open(@output_file.path, 'a') do |out_file|
+          status = IO.popen4(@command_line) do |pid, stdin, stdout, stderr|
+            threads = []
+            # Read stdout/stderr and push to output
+            [ stdout, stderr ].each do |stream|
+              threads << Thread.new do
+                while !stream.eof? && text = stream.readpartial(1024)
+                  out_file.write(text)
+
+                  if delegate && on_output
+                    delegate.send(on_output, text, stream == stderr)
+                  end
+                end
+              end
+            end
+
+            # Wait for stream handler threads to exit
+            threads.each { |t| t.join }
+          end
+        end
+
+        @exit_code = ExitCode.new($?)
+
+        return @exit_code
+      end
+
+      def to_s
+        @output_file.read if @output_file
+      end
+      alias :output :to_s
+
+      ###########
+      # PRIVATE #
+      ###########
+
+      private
+      
+      def get_command(path)
+        @command_line = "#{SHELL_EXECUTABLE}#{path}"
+        @command_line
+      end
+
+    end
+  end
+end

data/lib/util/version.rb

@@ -0,0 +1,7 @@
+module Maestro
+  module Util
+    class Shell
+      VERSION = '0.0.1'
+    end
+  end
+end

data/maestro_shell.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'util/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'maestro_shell'
+  spec.version       = Maestro::Util::Shell::VERSION
+  spec.authors       = ['Doug Henderson']
+  spec.email         = ['dhenderson@maestrodev.com']
+  spec.description   = %q{A ruby library to help with the creation of Maestro plugins that need Shell functionality}
+  spec.summary       = %q{Maestro Shell utility}
+  spec.homepage      = 'https://github.com/maestrodev/maestro-shell'
+  spec.license       = 'Apache 2.0'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'logging', '1.8.0'
+  spec.add_dependency 'rubyzip', '0.9.8'
+  spec.add_dependency 'json', '>= 1.4.6'
+
+  spec.add_development_dependency "mocha", '>=0.10.0'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+#  spec.add_development_dependency 'jruby-openssl'
+  spec.add_development_dependency 'rspec', '~> 2.13.0'
+
+end

data/pom.xml

@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>com.maestrodev</groupId>
+  <artifactId>maestro-shell</artifactId>
+  <version>1.0-SNAPSHOT</version>
+  <name>maestro-shell</name>
+  <packaging>pom</packaging>
+
+  <scm>
+    <developerConnection>scm:git:git@github.com:maestrodev/maestro-shell.git</developerConnection>
+    <connection>scm:git:git@github.com:maestrodev/maestro-shell.git</connection>
+  </scm>
+
+  <distributionManagement>
+    <repository>
+      <id>maestro-deploy</id>
+      <url>https://repo.maestrodev.com/archiva/repository/public-releases/</url>
+    </repository>
+    <snapshotRepository>
+      <id>maestro-deploy</id>
+      <url>https://repo.maestrodev.com/archiva/repository/public-snapshots/</url>
+    </snapshotRepository>
+  </distributionManagement>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>org.codehaus.mojo</groupId>
+        <artifactId>build-helper-maven-plugin</artifactId>
+        <version>1.7</version>
+        <executions>
+          <execution>
+            <id>attach-zip</id>
+            <phase>package</phase>
+            <goals>
+              <goal>attach-artifact</goal>
+            </goals>
+            <configuration>
+              <artifacts>
+                <artifact>
+                  <file>${project.artifactId}-${project.version}.zip</file>
+                  <type>zip</type>
+                  <classifier>bin</classifier>
+                </artifact>
+              </artifacts>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+
+</project>

data/spec/shell_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+
+describe Maestro::Util::Shell do
+  
+  # it 'should create a script' do
+  #   path = subject.create_script "some shell command"
+  #   
+  #   File.exists?(path).should be_true
+  # end
+
+  # it 'should create a script without random path' do
+  #   subject = Maestro::Util::Shell.new("/tmp/maestro-test-script")
+  #   path = subject.create_script "some shell command"
+  #   subject.shell.should eql("/bin/bash")
+  #   File.exists?(path).should be_true
+  # end
+
+  # it 'should create a script with shell parameter' do
+  #   subject = Maestro::Util::Shell.new(nil, "/tmp/bash")
+  #   path = subject.create_script "some shell command"
+  #   File.exists?(path).should be_true
+  #   path.should_not eql("/tmp/bash")
+  # end
+  # 
+  # it 'should create two scripts with random name' do
+  #   path1 = subject.create_script "some shell command"
+  #   path2 = subject.create_script "another shell command"
+  # 
+  #   path1.should_not eql(path2)
+  #   File.exists?(path1).should be_true
+  #   File.exists?(path2).should be_true
+  # end
+
+  it 'should run script' do
+    path = subject.create_script "echo willy"
+    # File.exists?(path).should be_true
+    
+    subject.run_script.success?.should be_true
+    
+    subject.to_s.chomp.should eql('willy')
+  end
+  
+  it 'should run script with delegate' do
+     path = subject.create_script "echo willy"
+     
+     delegate = mock()
+     delegate.expects(:write_output).at_least(1)
+     
+     subject.run_script_with_delegate(delegate, "write_output")
+     subject.to_s.chomp.should eql('willy')
+   end
+
+   it 'should parse output' do
+     path = subject.create_script "echo wonka"
+   
+     
+     subject.run_script
+     subject.to_s.chomp.should eql("wonka")
+   end
+
+   it 'should return error on error' do
+     path = subject.create_script "blah hello"
+     
+     subject.run_script.success?.should be_false
+     subject.to_s.should include("blah: command not found")
+   end
+
+   it 'should run with with export inline' do
+     command =<<-CMD
+#{Maestro::Util::Shell::ENV_EXPORT_COMMAND} BLAH=blah; echo $BLAH
+     CMD
+     
+     path = subject.create_script command
+     
+     subject.run_script.success?.should be_true
+     subject.to_s.should eql("blah\n")
+   end
+
+
+   it 'should run multiline command' do
+     command =<<-CMD
+echo hello\r\n
+echo goodbye     
+     CMD
+     
+     path = subject.create_script command
+     
+     subject.run_script.success?.should be_true
+     subject.to_s.should eql("hello\r\ngoodbye\n")
+   end
+
+   it 'should create run and return result in on call' do
+     exit_code, output = Maestro::Util::Shell.run_command('echo what')
+     output.should eql("what\n")
+     exit_code.success?.should be_true
+   end
+
+   it 'should maintain env' do
+     temp = Tempfile.new('script.sh')
+     temp.write("echo $BLAH")
+     temp.close
+     File.chmod(0777, temp.path)
+     command =<<-CMD
+#{Maestro::Util::Shell::ENV_EXPORT_COMMAND} BLAH=blah; echo $BLAH
+#{temp.path}
+     CMD
+
+     path = subject.create_script command
+     
+     subject.run_script.success?.should be_true
+     subject.to_s.should eql("blah\nblah\n")
+     
+     temp = Tempfile.new('script.sh')
+     temp.write("pwd")
+     temp.close
+     File.chmod(0777, temp.path)
+     command =<<-CMD
+     pwd
+     cd /
+#{temp.path}
+     CMD
+
+     path = subject.create_script command
+     
+     subject.run_script.success?.should be_true
+     subject.to_s.should eql("#{`pwd`}/\n")
+   end
+   
+   it "should load all of a large output" do
+      output =`cat #{File.join(File.dirname(__FILE__), '..','maestro_shell.gemspec')}`.chomp
+      subject.create_script "cat #{File.join(File.dirname(__FILE__), '..','maestro_shell.gemspec')}"
+      
+      subject.run_script
+      subject.to_s.chomp.should eql(output)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rspec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib') unless $LOAD_PATH.include?(File.dirname(__FILE__) + '/../lib')
+
+require 'shell'
+
+RSpec.configure do |config|
+
+  config.mock_with :mocha
+
+end
+
+
+

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: maestro_shell
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Doug Henderson
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2013-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logging
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.8
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: json
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.6
+  prerelease: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  name: mocha
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: bundler
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rake
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+  type: :development
+- !ruby/object:Gem::Dependency
+  name: rspec
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  prerelease: false
+  type: :development
+description: A ruby library to help with the creation of Maestro plugins that need Shell functionality
+email:
+- dhenderson@maestrodev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/shell.rb
+- lib/util/logging.rb
+- lib/util/shell.rb
+- lib/util/version.rb
+- maestro_shell.gemspec
+- pom.xml
+- spec/shell_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/maestrodev/maestro-shell
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.0.3
+signing_key:
+specification_version: 4
+summary: Maestro Shell utility
+test_files:
+- spec/shell_spec.rb
+- spec/spec_helper.rb