condor 1.0.0

data/README

@@ -0,0 +1,26 @@
+= Ruby Wrapper for Condor
+
+This is a Ruby wrapper for the {Condor}[http://www.cs.wisc.edu/condor/] distributed computing framework.
+
+It consists of a wrapper for a Condor submit file and a program, <tt>condor-exec</tt>, that submits an arbitrary command line as a Condor job.  For example:
+
+	condor-exec prog --option arg1 arg2
+
+queues up a job for the +prog+ with arguments <tt>--option arg1 arg2</tt>.  To pass options to <tt>condor-exec</tt> itself, place them before +prog+.  For example:
+
+	condor-exec --universe=MPI prog --option arg1 arg2
+
+= History
+
+1.0.0:: Basic submit file wrapper; <tt>condor-exec</tt> program
+
+= Copyright
+
+Copyright 2009, William Patrick McNeill
+
+This program is distributed under the GNU General Public License.
+
+
+= Author
+
+W.P. McNeill mailto:billmcn@gmail.com

data/bin/condor-exec

@@ -0,0 +1,75 @@
+#!/usr/bin/ruby
+
+# Copyright 2009 William Patrick McNeill
+#
+# This file is part of the Condor Ruby Wrapper.
+#
+# The Condor Ruby Wrapper is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or (at your
+# option) any later version.
+#
+# The Condor Ruby Wrapper is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
+# Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# editalign; if not, write to the Free Software Foundation, Inc., 51 Franklin
+# St, Fifth Floor, Boston, MA 02110-1301 USA
+
+#  This program runs the specified command line as a Condor job.
+
+require "condor"
+require "optparse"
+
+class CommandPassingOptionParser < OptionParser
+  # Treat all switches before the first non-switch as options for this
+  # program.  Treat switches after as options to be passed down to the program
+  # run by Condor.
+  def parse_command_line(argv = default_argv)
+    first_non_option_index = 0
+    argv.each_with_index do |arg, i|
+      first_non_option_index = i
+      break if arg !~ /^-/
+    end
+    parse(argv[0..first_non_option_index])
+    argv[first_non_option_index..argv.length]
+  end
+end
+
+options = {}
+p = CommandPassingOptionParser.new do |opts|
+  opts.banner = <<EOS
+Usage: #{File.basename(__FILE__)} [options] command [arguments]
+
+This program launches the specified command line as a Condor process by
+writing a submit file and calling Condor submit.
+
+It creates a condor_submit.nnn file in the current directory along with
+*.output and *.error files named after the program being run.  It also creates
+a Condor log file in the system temporary directory.
+
+Switch options appearing before the first non-switch argument are passed to
+#{File.basename(__FILE__)}.  Switch optios appearing after the first
+non-switch argument are treated as arguments to the command.
+
+Options:
+EOS
+  
+  opts.on("-gVALUE", "--getenv VALUE", "Get environment") do |value|
+    options[:getenv] = value
+  end
+
+  opts.on("-tVALUE", "--transfer-executable VALUE", "Transfer executable") do |value|
+    options[:transfer_executable] = value
+  end
+
+  opts.on("-uVALUE", "--universe VALUE", "Universe") do |value|
+    options[:universe] = value
+  end
+  
+end
+
+command_line = p.parse_command_line
+Condor.submit(command_line.shift, command_line, options)

data/lib/condor.rb

@@ -0,0 +1,108 @@
+# Copyright 2009 William Patrick McNeill
+#
+# This file is part of the Condor Ruby Wrapper.
+#
+# The Condor Ruby Wrapper is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or (at your
+# option) any later version.
+#
+# The Condor Ruby Wrapper is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
+# Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# editalign; if not, write to the Free Software Foundation, Inc., 51 Franklin
+# St, Fifth Floor, Boston, MA 02110-1301 USA
+
+require "erb"
+require "tempfile"
+
+# Wrapper for the Condor distributed computing system.
+module Condor
+
+  VERSION = "1.0.0"
+
+  # The text of a file that can be sent to the condor_submit program.
+  class SubmitFile < ERB
+    # Specify a single executable and a list of argument sets.  Each element
+    # of argument_list is a set of arguments.  One job will be queued up for
+    # each set of arguments.
+    def initialize(executable, argument_list, options = {})
+      # Get defaults for any unspecified options.
+      @options = {
+        :getenv => "true",
+        :transfer_executable => "false",
+        :universe => "vanilla"}.merge!(options)
+      # Create the submit file text.
+      @executable = executable
+      @argument_list = argument_list
+      @log = File.join(Dir::tmpdir, "#{ENV['USER']}.condor.$(Cluster).$(Process)")
+      @output = current_dir_log_file("output")
+      @error = current_dir_log_file("error")
+      # Create the header common to all the jobs.
+      template = <<-EOTEXT
+Universe   = <%= @options[:universe] %>
+getenv     = <%= @options[:getenv] %>
+transfer_executable = <%= @options[:transfer_executable] %>
+Log        = <%= @log %>
+Executable = <%= @executable %>
+      EOTEXT
+      # Queue up the arguments for each individual job.
+      argument_list.each_with_index do |arguments, i|
+        template += <<-EOTEXT
+
+arguments  = <%= @argument_list[#{i}].join(" ") %>
+output     = <%= @output %>
+error      = <%= @error %>
+Queue
+        EOTEXT
+      end
+      super(template)
+    end
+
+    # Allocate the name of a temporary file in the current directory.
+    def current_dir_log_file(name)
+      "#{File.basename(@executable).strip}.$(Cluster).$(Process).#{name}"
+    end
+
+    # Return a string that can serve as a Condor submit file.
+    def to_s
+      result(binding)
+    end
+    
+    private :current_dir_log_file
+  end
+
+
+  # This runs the specified executable and arguments as a Condor command.  The
+  # function creates a condor_submit.nnn file in the current directory. STDOUT
+  # and STDERR are routed to *.output and *.error files with the names of the
+  # executable and the process ID in the name.  The Condor log file is written
+  # to the system's temporary directory.
+  def Condor.submit(executable, arguments, options = {})
+    if executable.nil? or executable.empty?
+      raise "You must specify a command to run"
+    end
+    # Get full path to the command.  BUGBUG This is UNIX specific.
+    executable = `which #{executable} 2> /dev/null`.strip
+    raise "Invalid executable #{executable}" if executable.empty? 
+    # Create a unique submit file name of the form condor_submit.nnn.
+    n = 0
+    while n < 1000
+      ext = sprintf("%03d", n)
+      submit_name = "condor_submit.#{ext}"
+      break if not File.exists?(submit_name)
+      n += 1
+    end
+    raise "Cannot create unique submit file name" if n == 1000
+    # Write Condor information to the submit file.
+    File.open(submit_name, "w") do |file|
+      file << Condor::SubmitFile.new(executable, [arguments], options).to_s
+    end
+    # Submit the Condor job.
+    `condor_submit #{submit_name}`
+  end
+
+end # Condor

data/test/test_condor.rb

@@ -0,0 +1,35 @@
+#!/usr/bin/ruby
+
+#--
+
+# Copyright 2007-2008 William Patrick McNeill
+#
+# This file is part of the Condor Ruby Wrapper.
+#
+# The Condor Ruby Wrapper is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or (at your
+# option) any later version.
+#
+# The CondorRuby Wrapper is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
+# Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# editalign; if not, write to the Free Software Foundation, Inc., 51 Franklin
+# St, Fifth Floor, Boston, MA 02110-1301 USA
+#
+#++
+
+# Test cases for the Condor module
+
+require "test/unit"
+require "condor"
+
+
+class CondorTestCase < Test::Unit::TestCase
+  def test_submit_file
+    s = Condor::SubmitFile.new("ruby", "arg1 arg2")
+  end
+end # CondorTestCase

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: condor
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2009-01-16 00:00:00 -08:00
+summary: Ruby wrapper for the Condor distributed computing system
+require_paths: 
+- lib
+email: billmcn@gmail.com
+homepage: http://condor.rubyforge.org/
+rubyforge_project: condor
+description: This module is a Ruby wrapper for the Condor distributed computing system.
+autorequire: 
+default_executable: bin/condor-exec
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- W.P. McNeill
+files: 
+- test/test_condor.rb
+- lib/condor.rb
+- bin/condor-exec
+- README
+test_files: 
+- test/test_condor.rb
+rdoc_options: 
+- - --title
+  - Condor -- distributed computing
+  - --main
+  - README
+  - --line-numbers
+  - --inline-source
+extra_rdoc_files: 
+- README
+executables: 
+- condor-exec
+extensions: []
+
+requirements: []
+
+dependencies: []
+