script-runner 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f22b256b65aee577b02653246ac9cbe78293160
+  data.tar.gz: 87bfc1a45a8641e30766401b4921ab0a7d06cca9
+SHA512:
+  metadata.gz: dd472b956d336a913fc90c988dbeb0f26cbc49ebe252f0971bfd4a956d6d4451763a9532d75111e9421368d903826ed66b396e799469714f0d37f71160084631
+  data.tar.gz: 56e000a50487089ba19f66565bdbea1f25426f2b03d0bfc9d6bfcc47087752788cba0d88087dae0fa36a2c1cc14cd9d5eede0a2d677e0cc693a50adf555381c0

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/.ruby-gemset

@@ -0,0 +1 @@
+script-runner

data/.ruby-version

@@ -0,0 +1 @@
+2.0.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+# Specify your gem's dependencies in mongo-db-utils.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    script-runner (0.0.1)
+      thor
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.4)
+    rake (10.1.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
+    thor (0.18.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rake (~> 10.1.0)
+  rspec (~> 2.6)
+  script-runner!

data/README.md

@@ -0,0 +1,45 @@
+# script-runner
+
+A very simple library for running scripts on a file system.
+
+## Usage
+
+    require 'script-runner'
+    ScriptRunner.run( array_of_paths, array_of_env_paths, error_handler, &handle_script_output )
+    
+## Example
+
+If we have the following file structure
+    
+
+    path-one/
+      script.sh
+    path-two/
+      path-two-one/
+        script.sh
+      script.sh
+    env-one/
+      one.properties
+      
+The following:
+
+    require 'script-runner'
+    error_handler = lamba{ |script_path| raise "an error occured with: #{script_path}" }
+    ScriptRunner.run( ["path-one", "path-two"], ["env-one"], error_handler ){ |script_output| puts script_output}
+
+Will:
+* set env vars as defined in `env-one/one.properties`
+* run `path-one/script.sh`, `path-two/path-two-one/script.sh`, `path-two/script.sh` - with the env vars defined
+* the output will be sent to the console using `puts`
+* any errors will call `error_handler`
+
+Note: for each root_path, all files under are invoked in alphabetical order
+
+### installation
+
+    cd script-runner
+    gem install bundler
+    bundle install
+    rake # run tests
+    rake build # make .gem file
+    gem install pkg/script-runner-0.0.1.gem

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/script-runner.rb

@@ -0,0 +1,18 @@
+require 'script-runner/main'
+
+module ScriptRunner
+
+  # Run a set of scripts
+  #
+  # Note: non executable files are skipped and a warning is sent to the console
+  #
+  # @paths - an array of paths with scripts to invoke
+  # @env_vars - an array of paths that contains .properties files
+  # @error_handler - a callback if a non-zero exit code occured
+  # @block - a block to handle the output of the script if non is given it is sent to the console
+  def self.run( paths, env_vars, error_handler = nil, &block)
+    runner = ScriptRunner::Main.new
+    runner.run(paths, env_vars, error_handler, &block)
+  end
+
+end

data/lib/script-runner/cmds.rb

@@ -0,0 +1,19 @@
+module ScriptRunner
+
+  module Commands
+
+    class Ping
+      def initialize
+      end
+
+      def run(msg, options = { :reverse => false })
+        if options[:reverse]
+          msg.reverse
+        else
+          msg
+        end
+      end
+    end
+  end
+end
+

data/lib/script-runner/main.rb

@@ -0,0 +1,66 @@
+module ScriptRunner
+
+  class Main
+
+    # Run a set of scripts
+    #
+    # Note: non executable files are skipped and a warning is sent to the console
+    #
+    # @paths - an array of paths with scripts to invoke
+    # @env_vars - an array of paths that contains .properties files
+    # @error_handler - a callback if a non-zero exit code occured
+    # @block - a block to handle the output of the script if non is given it is sent to the console
+    def run( paths, env_vars, error_handler = nil, &block)
+      set_env(env_vars)
+      all_paths = all_files(paths).select{ |p| File.file? p }
+      runnable = all_paths.select{ |p| File.executable? p }
+      non_runnable = all_paths - runnable
+
+      non_runnable.each{ |nr|
+        puts "warning: #{nr} is not runnable - skipping"
+      }
+
+      all_paths.each{ |p|
+        exec(p, error_handler, &block)
+      }
+    end
+
+    private
+
+    def exec(script_path, error_handler = nil, &block)
+      IO.popen(script_path) do |io|
+        while line = io.gets
+          if block_given?
+            block.call(line.chomp)
+          else
+            puts line.chomp
+          end
+        end
+        io.close
+        error_handler.call(script_path) if $?.to_i != 0 and !error_handler.nil?
+      end
+    end
+
+    def all_files(array)
+      array.inject([]){ |acc,y|
+        acc.concat(Dir["#{y}/**/*"].entries)
+      }
+    end
+
+    def set_env(env_paths)
+      env_files = all_files(env_paths)
+
+      env_files.each{ |p|
+        puts "setting env from #{p}"
+        File.readlines(p).each do |line|
+          if line.include? "="
+            values = line.split("=")
+            ENV[values[0].chomp] = values[1].chomp
+          end
+        end
+      }
+    end
+
+  end
+
+end

data/lib/script-runner/version.rb

@@ -0,0 +1,4 @@
+module ScriptRunner
+  VERSION = "0.0.1"
+end
+

data/script-runner.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/script-runner/version', __FILE__)
+
+name = "script-runner"
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["ed.eustace"]
+  gem.email         = ["ed.eustace@gmail.com"]
+  gem.description   = %q{it just runs scripts}
+  gem.summary       = gem.description
+  gem.homepage      = "http://github.com/edeustace/script-runner"
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = name
+  gem.require_paths = ["lib"]
+  gem.required_ruby_version = '>= 2.0.0'
+  gem.version       = ScriptRunner::VERSION
+  gem.add_development_dependency "rspec", "~> 2.6"
+  gem.add_development_dependency "rake", "~> 10.1.0"
+  gem.add_dependency "thor"
+
+end

data/spec/cmds_spec.rb

@@ -0,0 +1,11 @@
+require 'script-runner/cmds'
+
+include ScriptRunner
+
+describe Commands do
+  it "should ping" do
+    p = Commands::Ping.new
+    p.run("hello world").should eql("hello world")
+    p.run("hello world", :reverse => true).should eql("hello world".reverse)
+  end
+end

data/spec/fixtures/has_error/scripts/error.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+
+exit 1

data/spec/fixtures/nested/scripts/a/one.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+echo "$0"

data/spec/fixtures/nested/scripts/one.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+echo "$0"

data/spec/fixtures/nested_two/nested/scripts/a/one.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+echo "$0"

data/spec/fixtures/nested_two/nested/scripts/one.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+echo "$0"

data/spec/fixtures/nested_two/scripts/a/one.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+echo "$0"

data/spec/fixtures/nested_two/scripts/one.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+echo "$0"

data/spec/fixtures/one/env/one.properties

@@ -0,0 +1 @@
+CUSTOM_VAR=custom var

data/spec/fixtures/one/scripts/one.sh

@@ -0,0 +1,2 @@
+#!/usr/bin/env bash
+echo "hello there $CUSTOM_VAR"

data/spec/main_spec.rb

@@ -0,0 +1,51 @@
+require 'script-runner'
+
+describe ScriptRunner do
+
+  before(:each) do
+    @test_files = "spec/fixtures"
+    @all_output = []
+    @error_files = []
+  end
+
+  def scripts(*names)
+    file_array("scripts", names)
+  end
+
+  def env(*names)
+    file_array("env", names)
+  end
+
+  def file_array(key,names)
+    names.map{ |n| File.join(@test_files, n, key) }
+  end
+
+  it "should run scripts" do
+    p = ScriptRunner.run(scripts("one"), env("one")) { |output| @all_output << output }
+    @all_output.should eql ["hello there custom var"]
+    @error_files.length.should eql 0
+  end
+
+  it "should allow errors to be handled" do
+    error_handler = lambda{ |p| @error_files << p}
+    p = ScriptRunner.run(scripts("one", "has_error"), env("one"), error_handler) { |output| @all_output << output }
+    @error_files.length.should eql 1
+  end
+
+  it "should call nested in alphabetical order" do
+    puts "before : #{@all_output}"
+    p = ScriptRunner.run(scripts("nested"), env("one")) { |output| @all_output << output }
+    @all_output.should eql ["spec/fixtures/nested/scripts/a/one.sh", "spec/fixtures/nested/scripts/one.sh"]
+  end
+
+  it "should call multiple nested in alphabetical order" do
+    puts "before : #{@all_output}"
+    p = ScriptRunner.run(scripts("one", "nested_two", "nested"), env("one")) { |output| @all_output << output }
+    @all_output.should eql [
+      "hello there custom var",
+      "spec/fixtures/nested_two/scripts/a/one.sh",
+      "spec/fixtures/nested_two/scripts/one.sh",
+      "spec/fixtures/nested/scripts/a/one.sh",
+      "spec/fixtures/nested/scripts/one.sh"]
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: script-runner
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ed.eustace
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.1.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: it just runs scripts
+email:
+- ed.eustace@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/script-runner.rb
+- lib/script-runner/cmds.rb
+- lib/script-runner/main.rb
+- lib/script-runner/version.rb
+- script-runner.gemspec
+- spec/cmds_spec.rb
+- spec/fixtures/has_error/scripts/error.sh
+- spec/fixtures/nested/scripts/a/one.sh
+- spec/fixtures/nested/scripts/one.sh
+- spec/fixtures/nested_two/nested/scripts/a/one.sh
+- spec/fixtures/nested_two/nested/scripts/one.sh
+- spec/fixtures/nested_two/scripts/a/one.sh
+- spec/fixtures/nested_two/scripts/one.sh
+- spec/fixtures/one/env/one.properties
+- spec/fixtures/one/scripts/one.sh
+- spec/main_spec.rb
+homepage: http://github.com/edeustace/script-runner
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 2.0.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: it just runs scripts
+test_files:
+- spec/cmds_spec.rb
+- spec/fixtures/has_error/scripts/error.sh
+- spec/fixtures/nested/scripts/a/one.sh
+- spec/fixtures/nested/scripts/one.sh
+- spec/fixtures/nested_two/nested/scripts/a/one.sh
+- spec/fixtures/nested_two/nested/scripts/one.sh
+- spec/fixtures/nested_two/scripts/a/one.sh
+- spec/fixtures/nested_two/scripts/one.sh
+- spec/fixtures/one/env/one.properties
+- spec/fixtures/one/scripts/one.sh
+- spec/main_spec.rb