girdle 0.0.6 → 0.0.7

data/README.markdown

@@ -27,7 +27,7 @@ Add another, this one dependent on the first:
     
 Submit the specification and return an id:
 
-    job_id = Girdle::Job.batch(spec.to_plist)
+    job_id = Girdle::Job.batch(spec)
     
 Create a new job using the returned id:
 

data/lib/girdle.rb

@@ -3,6 +3,8 @@ require 'bundler/setup'
 require 'nokogiri'
 require 'nokogiri-plist'
 
+require 'girdle/helpers'
+
 require 'girdle/version'
 require 'girdle/task'
 require 'girdle/specification'

data/lib/girdle/helpers.rb

@@ -0,0 +1,14 @@
+module Girdle
+  
+  module Helpers
+    extend self
+    
+    def validate_options!(valid_options, options)
+      options.each do |k,v|
+        raise ArgumentError unless valid_options.include? k
+      end
+      true
+    end
+    
+  end
+end

data/lib/girdle/job.rb

@@ -1,6 +1,7 @@
 module Girdle
 
   class Job
+    extend Girdle::Helpers
 
     attr_reader :name, :id
 
@@ -8,20 +9,70 @@ module Girdle
       @id = id
     end
 
-    def self.list
-      Girdle.run(job: 'list')['jobList']
-    end
-
-    def self.submit(cmd)
-      Girdle.run(job: 'submit', cmd: cmd)['jobIdentifier']
-    end
-
-    def self.run(cmd)
-      Girdle.run(job: 'run', cmd: cmd)
-    end
-
-    def self.batch(xml)
-      Girdle.run_batch(xml, job: 'batch')['jobIdentifier']
+    def self.list(options = {})
+      validate_options! [
+        :gid,       # grid identifier
+        ], options
+        
+      options.merge!(job: 'list')
+      
+      Girdle.run(options)['jobList']
+    end
+
+    def self.submit(cmd, options = {})
+      validate_options! [
+        :gid,       # grid identifier 
+        :si,        # standard in
+        :in,        # in directory
+        :dids,      # job identifiers
+        :email,     # notification email
+        :art,       # art path
+        :artid,     # art identifier
+        :artequal,  # art value (equal)
+        :artmin,    # art value (min)
+        :artmax     # art value (max)
+        ], options
+        
+      options.merge!(job: 'submit', cmd: cmd)
+        
+      Girdle.run(options)['jobIdentifier']
+    end
+
+    def self.run(cmd, options = {})
+      validate_options! [
+        :gid,       # grid identifier 
+        :si,        # standard in
+        :in,        # in directory
+        :so,        # standard out
+        :se,        # standard error
+        :out,       # out directory
+        :email,     # notification email
+        :art,       # art path
+        :artid,     # art identifier
+        :artequal,  # art value (equal)
+        :artmin,    # art value (min)
+        :artmax     # art value (max)
+        ], options
+        
+      options.merge!(job: 'run', cmd: cmd)
+        
+      Girdle.run(options)
+    end
+
+    def self.batch(spec, options = {})
+      validate_options! [
+        :gid,       # grid identifier
+        ], options
+        
+      options.merge!(job: 'batch')
+      
+      if spec.respond_to?(:to_plist)
+        plist = spec.to_plist
+      else
+        plist = spec
+      end
+        
+      Girdle.run_batch(plist, options)['jobIdentifier']
     end
 
     def attributes
@@ -68,8 +119,17 @@ module Girdle
       attributes['undoneTaskCount'].to_i
     end
 
-    def results
-      Girdle.run(job: 'results', id: id)
+    def results(options = {})
+      self.class.validate_options! [
+        :tid,       # task identifier
+        :so,        # standard out
+        :se,        # standard error
+        :out        # out directory
+        ], options
+        
+      options.merge!(job: 'results', id: id)
+        
+      Girdle.run(options)
     end
 
     def specification
@@ -79,6 +139,10 @@ module Girdle
     def log
       Girdle.run(job: 'log', id: id)['jobLog']
     end
+    
+    def wait
+      Girdle.run(job: 'wait', id: id)['jobStatus']
+    end
 
     def stop
       Girdle.run(job: 'stop', id: id)

data/lib/girdle/specification.rb

@@ -2,12 +2,13 @@ module Girdle
   
   class Specification
     
-    attr_accessor :name, :notification_email, :tasks
+    attr_accessor :name, :notification_email, :tasks, :depends_on
     
     def initialize(options = {})
       @name = options[:name]
       @notification_email = options[:notification_email]
       @tasks = options[:tasks] || []
+      @depends_on = options[:depends_on] || []
     end
     
     def to_plist
@@ -24,6 +25,15 @@ module Girdle
               xml.string name
               xml.key 'notificationEmail'
               xml.string notification_email
+              xml.key 'schedulerParameters'
+              xml.dict do
+                xml.key 'dependsOnJobs'
+                xml.array do
+                  depends_on.each do |dependency|
+                    xml.string dependency
+                  end
+                end
+              end
               xml.key 'taskSpecifications'
               xml.dict do
                 tasks.each do |task|
@@ -37,6 +47,13 @@ module Girdle
                     end
                     xml.key 'command'
                     xml.string task.command
+                    xml.key 'environment'
+                    xml.dict do
+                      task.environment.each do |k,v|
+                        xml.key k
+                        xml.string v
+                      end
+                    end
                     xml.key 'dependsOnTasks'
                     xml.array do
                       task.depends_on.each do |dependency|

data/lib/girdle/task.rb

@@ -2,13 +2,14 @@ module Girdle
   
   class Task
 
-    attr_reader :name, :command, :arguments, :depends_on
+    attr_reader :name, :command, :arguments, :depends_on, :environment
 
     def initialize(options = {})
-      @name       = options[:name]
-      @command    = options[:command]
-      @arguments  = options[:arguments]
-      @depends_on = options[:depends_on] || []
+      @name         = options[:name]
+      @command      = options[:command]
+      @arguments    = options[:arguments]
+      @depends_on   = options[:depends_on] || []
+      @environment  = options[:environment] || {}
     end
 
   end

data/lib/girdle/version.rb

@@ -1,3 +1,3 @@
 module Girdle
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/spec/girdle/helpers_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Girdle::Helpers do 
+  
+  describe '::validate_options!' do
+    
+    before do
+      @valid_options = [:foo, :bar]
+    end
+    
+    it 'must validate valid options' do
+      Girdle::Helpers.validate_options!(@valid_options, foo: 'foo', bar: 'bar').must_equal true
+    end
+    
+    it 'must invalidate invalid options' do
+      Proc.new { Girdle::Helpers.validate_options!(@valid_options, ugh: 'ugh', foo: 'foo')}.must_raise ArgumentError
+    end
+    
+  end
+end

data/spec/girdle/job_spec.rb

@@ -22,25 +22,34 @@ describe Girdle::Job do
       result.must_equal 'hello'
     end
 
-    it 'must submit batch file and return an id' do
-      plist = Girdle::Specification.new(
-        name: 'specification name',
-        notification_email: 'email@example.com',
-        tasks: [
-          Girdle::Task.new(
-            name: 'task name', 
-            command: '/bin/echo', 
-            arguments: ['hello'], 
-            depends_on: ['another task']
-          )
-        ]
-      ).to_plist
-      Girdle.expects(:run_batch).
-        with(plist, job: 'batch').
-        returns('jobIdentifier' => '123')
-      id = Girdle::Job.batch(plist)
-      id.must_equal '123'
+    describe '::batch' do
+      
+      before do
+        @plist = Girdle::Specification.new(
+          name: 'specification name',
+          notification_email: 'email@example.com',
+          tasks: [
+            Girdle::Task.new(
+              name: 'task name', 
+              command: '/bin/echo', 
+              arguments: ['hello'], 
+              depends_on: ['another task']
+            )
+          ]
+        )
+      end
+      
+      it 'must submit batch file and return an id' do
+        Girdle.expects(:run_batch).
+          with(@plist.to_plist, job: 'batch').
+          returns('jobIdentifier' => '123')
+        id = Girdle::Job.batch(@plist)
+        id.must_equal '123'
+      end
+      
     end
+    
+    
   end
   
   it 'must retrieve list of jobs' do
@@ -147,6 +156,11 @@ describe Girdle::Job do
       @job.log.must_equal []
     end
     
+    it 'must wait synchronously until job state changes' do
+      Girdle.expects(:run).with(job: 'wait', id: 123).returns('jobStatus' => 'finished')
+      @job.wait.must_equal 'finished'
+    end
+    
     describe 'status' do
       
       it 'must stop, but don\'t delete' do

data/spec/girdle/specification_spec.rb

@@ -11,9 +11,13 @@ describe Girdle::Specification do
           name: 'task name', 
           command: '/bin/echo', 
           arguments: ['hello'], 
-          depends_on: ['another task']
+          depends_on: ['another task'],
+          environment: {'MY_ENV_VARIABLE' => 'MY_VALUE'}
         )
-      ]
+      ],
+      depends_on: [
+        'another specification name'
+        ]
     )
   end
   
@@ -40,6 +44,13 @@ describe Girdle::Specification do
       <string>specification name</string>
       <key>notificationEmail</key>
       <string>email@example.com</string>
+      <key>schedulerParameters</key>
+      <dict>
+        <key>dependsOnJobs</key>
+        <array>
+          <string>another specification name</string>
+        </array>
+      </dict>
       <key>taskSpecifications</key>
       <dict>
         <key>task name</key>
@@ -50,6 +61,11 @@ describe Girdle::Specification do
           </array>
           <key>command</key>
           <string>/bin/echo</string>
+          <key>environment</key>
+          <dict>
+            <key>MY_ENV_VARIABLE</key>
+            <string>MY_VALUE</string>
+          </dict>
           <key>dependsOnTasks</key>
           <array>
             <string>another task</string>

data/spec/girdle/task_spec.rb

@@ -13,6 +13,7 @@ describe Girdle::Task do
     task.command.must_equal '/bin/echo'
     task.arguments.must_equal []
     task.depends_on.must_equal []
+    task.environment.must_equal Hash.new
   end
   
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: girdle
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-19 00:00:00.000000000Z
+date: 2011-08-23 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70127451669460 !ruby/object:Gem::Requirement
+  requirement: &70339972619540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70127451669460
+  version_requirements: *70339972619540
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70127451669040 !ruby/object:Gem::Requirement
+  requirement: &70339972619120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70127451669040
+  version_requirements: *70339972619120
 - !ruby/object:Gem::Dependency
   name: guard-minitest
-  requirement: &70127451692420 !ruby/object:Gem::Requirement
+  requirement: &70339975778240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70127451692420
+  version_requirements: *70339975778240
 - !ruby/object:Gem::Dependency
   name: rb-fsevent
-  requirement: &70127451692000 !ruby/object:Gem::Requirement
+  requirement: &70339975777820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70127451692000
+  version_requirements: *70339975777820
 - !ruby/object:Gem::Dependency
   name: growl_notify
-  requirement: &70127451691580 !ruby/object:Gem::Requirement
+  requirement: &70339975777400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70127451691580
+  version_requirements: *70339975777400
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70127451691160 !ruby/object:Gem::Requirement
+  requirement: &70339975776980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70127451691160
+  version_requirements: *70339975776980
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70127451690740 !ruby/object:Gem::Requirement
+  requirement: &70339975776560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70127451690740
+  version_requirements: *70339975776560
 - !ruby/object:Gem::Dependency
   name: nokogiri-plist
-  requirement: &70127451690320 !ruby/object:Gem::Requirement
+  requirement: &70339975776140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,7 +98,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70127451690320
+  version_requirements: *70339975776140
 description: An Xgrid client
 email:
 - jamiehodge@me.com
@@ -115,12 +115,14 @@ files:
 - lib/girdle.rb
 - lib/girdle/controller.rb
 - lib/girdle/grid.rb
+- lib/girdle/helpers.rb
 - lib/girdle/job.rb
 - lib/girdle/specification.rb
 - lib/girdle/task.rb
 - lib/girdle/version.rb
 - spec/girdle/controller_spec.rb
 - spec/girdle/grid_spec.rb
+- spec/girdle/helpers_spec.rb
 - spec/girdle/job_spec.rb
 - spec/girdle/specification_spec.rb
 - spec/girdle/task_spec.rb
@@ -153,6 +155,7 @@ summary: A client for submitting and managing Xgrid jobs
 test_files:
 - spec/girdle/controller_spec.rb
 - spec/girdle/grid_spec.rb
+- spec/girdle/helpers_spec.rb
 - spec/girdle/job_spec.rb
 - spec/girdle/specification_spec.rb
 - spec/girdle/task_spec.rb