neptune 0.2.1 → 0.2.2

data/test/{unit/test_neptune.rb → test_neptune.rb}

@@ -1,6 +1,6 @@
 # Programmer: Chris Bunch (cgb@cs.ucsb.edu)
 
-$:.unshift File.join(File.dirname(__FILE__), "..", "..", "lib")
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
 require 'neptune'
 
 require 'test/unit'
@@ -77,50 +77,51 @@ class TestNeptune < Test::Unit::TestCase
 
   def test_preprocess_mpi
     # not specifying nodes to use or procs to use should throw an error
-    job_data_1 = {}
+    job_data_1 = {"@output" => "baz", "@error" => "boo",
+      "@metadata" => "bar"}
     assert_raise(BadConfigurationException) { 
       NeptuneHelper.preprocess_mpi(job_data_1, nil)
     }
 
     # not specifying procs to use should throw an error
-    job_data_2 = {"@nodes_to_use" => 4}
+    job_data_2 = job_data_1.merge({"@nodes_to_use" => 4})
     assert_raise(BadConfigurationException) { 
       NeptuneHelper.preprocess_mpi(job_data_2, nil)
     }
 
     # specifying procs to use == nodes to use should not throw an error
-    job_data_3 = {"@nodes_to_use" => 4, "@procs_to_use" => 4}
+    job_data_3 = job_data_1.merge({"@nodes_to_use" => 4, "@procs_to_use" => 4})
     assert_equal(job_data_3, NeptuneHelper.preprocess_mpi(job_data_3, nil))
 
     # specifying procs to use < nodes to use should throw an error
-    job_data_4 = {"@nodes_to_use" => 4, "@procs_to_use" => 1}
+    job_data_4 = job_data_1.merge({"@nodes_to_use" => 4, "@procs_to_use" => 1})
     assert_raise(BadConfigurationException) { 
       NeptuneHelper.preprocess_mpi(job_data_4, nil)
     }
  
     # specifying an empty string for argv should be ok
-    job_data_5 = {"@nodes_to_use" => 4, "@procs_to_use" => 4, "@argv" => ""}
+    job_data_5 = job_data_1.merge({"@nodes_to_use" => 4, "@procs_to_use" => 4, "@argv" => ""})
     assert_equal(job_data_5, NeptuneHelper.preprocess_mpi(job_data_5, nil))
 
     # specifying an empty array for argv should be ok
-    job_data_6 = {"@nodes_to_use" => 4, "@procs_to_use" => 4, "@argv" => []}
+    job_data_6 = job_data_1.merge({"@nodes_to_use" => 4, "@procs_to_use" => 4, "@argv" => []})
     expected_job_data_6 = job_data_6.dup
     expected_job_data_6["@argv"] = ""
     assert_equal(expected_job_data_6, NeptuneHelper.preprocess_mpi(job_data_6, nil))
 
     # specifying something that's not a string or array for argv should throw
     # an error
-    job_data_7 = {"@nodes_to_use" => 4, "@procs_to_use" => 4, "@argv" => 2}
+    job_data_7 = job_data_1.merge({"@nodes_to_use" => 4, "@procs_to_use" => 4, "@argv" => 2})
     assert_raise(BadConfigurationException) { 
       NeptuneHelper.preprocess_mpi(job_data_7, nil)
     }
 
     # specifying a non-empty string for argv should be ok
-    job_data_8 = {"@nodes_to_use" => 4, "@procs_to_use" => 4, "@argv" => "--file coo"}
+    job_data_8 = job_data_1.merge({"@nodes_to_use" => 4, "@procs_to_use" => 4, "@argv" => "--file coo"})
     assert_equal(job_data_8, NeptuneHelper.preprocess_mpi(job_data_8, nil))
 
     # specifying a non-empty array for argv should be ok
-    job_data_9 = {"@nodes_to_use" => 4, "@procs_to_use" => 4, "@argv" => ["--file", "coo"]}
+    job_data_9 = job_data_1.merge({"@nodes_to_use" => 4, "@procs_to_use" => 4, "@argv" => ["--file", "coo"]})
     expected_job_data_9 = job_data_9.dup
     expected_job_data_9["@argv"] = "--file coo"
     assert_equal(expected_job_data_9, NeptuneHelper.preprocess_mpi(job_data_9, nil))
@@ -169,10 +170,11 @@ class TestNeptune < Test::Unit::TestCase
     expected_job_data_5 = {"@type" => "input", "@keyname" => "boo"}
     assert_equal(expected_job_data_5, NeptuneHelper.get_job_data(params_5))
 
+    nodes = {"cloud1" => 1, "cloud2" => 1}
     params_6 = {:type => :mpi, :output => "/boo",
-      :nodes_to_use => {"cloud1" => 1, "cloud2" => 1}}
+      :nodes_to_use => nodes}
     expected_job_data_6 = {"@type" => "mpi", "@output" => "/boo",
-      "@keyname" => "appscale", "@nodes_to_use" => ["cloud1", 1, "cloud2", 1]}
+      "@keyname" => "appscale", "@nodes_to_use" => nodes.to_a.flatten}
     assert_equal(expected_job_data_6, NeptuneHelper.get_job_data(params_6))
   end
 
@@ -227,7 +229,7 @@ class TestNeptune < Test::Unit::TestCase
     }
 
     @file.should_receive(:exists?).and_return(false)
-    flexmock(AppControllerClient).new_instances { |instance|
+    flexmock(NeptuneManagerClient).new_instances { |instance|
       instance.should_receive(:put_input).and_return(true)
     }
 
@@ -241,7 +243,7 @@ class TestNeptune < Test::Unit::TestCase
     shadow_ip = "localhost?"
     secret = "abcdefg"
 
-    flexmock(AppControllerClient).new_instances { |instance|
+    flexmock(NeptuneManagerClient).new_instances { |instance|
       instance.should_receive(:put_input).and_return(true)
     }
 
@@ -266,6 +268,8 @@ class TestNeptune < Test::Unit::TestCase
   def test_babel_job_validation
     input = "/boo/input.txt"
     output = "/boo/baz.txt"
+    error = "/boo/baz-err.txt"
+    metadata = "/boo/baz-meta.txt"
     code = "/boo/code.go"
     engine = "appscale-sqs"
     all_engines = [engine]
@@ -273,10 +277,11 @@ class TestNeptune < Test::Unit::TestCase
     @commonfunctions.should_receive(:get_from_yaml).and_return("127.0.0.1")
     @commonfunctions.should_receive(:get_secret_key).and_return("secret")
 
-    flexmock(AppControllerClient).new_instances { |instance|
+    flexmock(NeptuneManagerClient).new_instances { |instance|
       instance.should_receive(:start_neptune_job).and_return("babel job is now running")
       instance.should_receive(:get_supported_babel_engines).and_return(all_engines)
-      instance.should_receive(:does_file_exist?).and_return(true, false, true)
+      # code exists - output, error, metadata do not - something else does
+      instance.should_receive(:does_file_exist?).and_return(true, false, false, false, true)
     }
 
     # test cases where we don't give all the correct params
@@ -293,6 +298,8 @@ class TestNeptune < Test::Unit::TestCase
 
     params = {:type => :babel,
               :output => output,
+              :error => error,
+              :metadata => metadata,
               :code => code,
               :engine => engine,
               :argv => [input]}
@@ -302,6 +309,8 @@ class TestNeptune < Test::Unit::TestCase
 
   def test_babel_where_remote_files_dont_exist
     output = "/boo/baz.txt"
+    error = "/boo/baz-err.txt"
+    metadata = "/boo/baz-meta.txt"
     code = "/boo/code.go"
     engine = "appscale-sqs"
     all_engines = [engine]
@@ -309,7 +318,7 @@ class TestNeptune < Test::Unit::TestCase
     @commonfunctions.should_receive(:get_from_yaml).and_return("127.0.0.1")
     @commonfunctions.should_receive(:get_secret_key).and_return("secret")
 
-    flexmock(AppControllerClient).new_instances { |instance|
+    flexmock(NeptuneManagerClient).new_instances { |instance|
       instance.should_receive(:start_neptune_job).and_return("babel job is now running")
       instance.should_receive(:get_supported_babel_engines).and_return(all_engines)
       instance.should_receive(:does_file_exist?).and_return(false)
@@ -317,6 +326,8 @@ class TestNeptune < Test::Unit::TestCase
 
     params = {:type => :babel,
       :output => output,
+      :error => error,
+      :metadata => metadata,
       :code => code,
       :engine => engine}
     assert_raises(FileNotFoundException) { neptune(params) }

data/test/{unit/test_app_controller_client.rb → test_neptune_manager_client.rb}

@@ -1,7 +1,7 @@
 # Programmer: Chris Bunch (cgb@cs.ucsb.edu)
 
-$:.unshift File.join(File.dirname(__FILE__), "..", "..", "lib")
-require 'app_controller_client'
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'neptune_manager_client'
 
 require 'test/unit'
 
@@ -9,9 +9,8 @@ class FakeConnection
   # Since all the methods we're faking take the same arguments and have
   # the same semantics (return true or abort), just cover it all in one place.
   def method_missing(id, *args, &block)
-    method_names = ["neptune_start_job", "neptune_put_input"] +
-      ["neptune_get_output", "neptune_get_acl", "neptune_set_acl"] +
-      ["neptune_compile_code"]
+    method_names = ["start_job", "put_input", "get_output", "get_acl"] +
+      ["set_acl", "compile_code"]
 
     if method_names.include?(id.to_s)
       job_data = args[0]
@@ -26,9 +25,9 @@ class FakeConnection
   end
 end
 
-class TestAppControllerClient < Test::Unit::TestCase
+class TestNeptuneManagerClient < Test::Unit::TestCase
   def setup
-    @client = AppControllerClient.new("localhost", "secret")
+    @client = NeptuneManagerClient.new("localhost", "secret")
     @client.conn = FakeConnection.new()
 
     @job_data_ok = ["OK"]
@@ -41,7 +40,7 @@ class TestAppControllerClient < Test::Unit::TestCase
     no_retry_on_exception = false
 
     call_number = 0
-    assert_nothing_raised(AppControllerException) {
+    assert_nothing_raised(NeptuneManagerException) {
       @client.make_call(no_timeout, retry_on_exception) {
         call_number += 1
         case call_number
@@ -57,13 +56,13 @@ class TestAppControllerClient < Test::Unit::TestCase
       }
     }
 
-    assert_raise(AppControllerException) {
+    assert_raise(NeptuneManagerException) {
       @client.make_call(no_timeout, no_retry_on_exception) {
         raise Errno::ECONNREFUSED
       }
     }
 
-    assert_raise(AppControllerException) {
+    assert_raise(NeptuneManagerException) {
       @client.make_call(no_timeout, no_retry_on_exception) {
         raise Exception
       }
@@ -76,31 +75,31 @@ class TestAppControllerClient < Test::Unit::TestCase
   # result unless it has 'Error:' in it. If it does, it aborts execution.
   def test_start_neptune_job
     assert(@client.start_neptune_job(@job_data_ok))
-    assert_raise(AppControllerException) { @client.start_neptune_job(@job_data_err) }
+    assert_raise(NeptuneManagerException) { @client.start_neptune_job(@job_data_err) }
   end
 
   def test_put_input
     assert(@client.put_input(@job_data_ok))
-    assert_raise(AppControllerException) { @client.put_input(@job_data_err) }
+    assert_raise(NeptuneManagerException) { @client.put_input(@job_data_err) }
   end
 
   def test_get_output
     assert(@client.get_output(@job_data_ok))
-    assert_raise(AppControllerException) { @client.get_output(@job_data_err) }
+    assert_raise(NeptuneManagerException) { @client.get_output(@job_data_err) }
   end
 
   def test_get_acl
     assert(@client.get_acl(@job_data_ok))
-    assert_raise(AppControllerException) { @client.get_acl(@job_data_err) }
+    assert_raise(NeptuneManagerException) { @client.get_acl(@job_data_err) }
   end
 
   def test_set_acl
     assert(@client.set_acl(@job_data_ok))
-    assert_raise(AppControllerException) { @client.set_acl(@job_data_err) }
+    assert_raise(NeptuneManagerException) { @client.set_acl(@job_data_err) }
   end
 
   def test_compile_code
     assert(@client.compile_code(@job_data_ok))
-    assert_raise(AppControllerException) { @client.compile_code(@job_data_err) }
+    assert_raise(NeptuneManagerException) { @client.compile_code(@job_data_err) }
   end
 end

data/test/test_task_info.rb

@@ -0,0 +1,32 @@
+# Programmer: Chris Bunch (cgb@cs.ucsb.edu)
+
+
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'task_info'
+
+
+require 'rubygems'
+require 'flexmock/test_unit'
+
+
+class TestTaskInfo < Test::Unit::TestCase
+
+
+  def test_init
+    assert_raises(BadConfigurationException) {
+      TaskInfo.new("not a Hash")
+    }
+  end
+
+  
+  def test_to_from_json
+    job_data = {'a' => 'b', 'c' => 'd'}
+    task = TaskInfo.new(job_data)
+
+    task_as_json = task.to_json
+    task_as_task = TaskInfo.new(task_as_json)
+    assert_equal(task.job_data, task_as_task.job_data)
+  end
+
+
+end

data/test/{unit/ts_all.rb → ts_all.rb}

@@ -5,7 +5,9 @@ require 'flexmock'
 require 'flexmock/test_unit'
 
 $:.unshift File.join(File.dirname(__FILE__))
-require 'test_app_controller_client'
 require 'test_babel'
 require 'test_common_functions'
+require 'test_exodus'
 require 'test_neptune'
+require 'test_neptune_manager_client'
+require 'test_task_info'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: neptune
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Chris Bunch
@@ -15,8 +15,7 @@ autorequire: neptune
 bindir: bin
 cert_chain: []
 
-date: 2012-02-12 00:00:00 -08:00
-default_executable: neptune
+date: 2012-07-31 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: promise
@@ -47,21 +46,21 @@ files:
 - bin/neptune
 - doc/CommonFunctions.html
 - doc/Object.html
+- doc/ExodusHelper.html
+- doc/TaskInfo.html
 - doc/js/jquery.js
+- doc/js/searcher.js
+- doc/js/search_index.js
 - doc/js/darkfish.js
-- doc/js/quicksearch.js
-- doc/js/thickbox-compressed.js
-- doc/AppControllerClient.html
-- doc/AppControllerException.html
+- doc/js/navigation.js
+- doc/js/search.js
 - doc/NeptuneHelper.html
+- doc/NeptuneManagerClient.html
 - doc/FileNotFoundException.html
-- doc/lib/neptune_rb.html
-- doc/lib/custom_exceptions_rb.html
-- doc/lib/app_controller_client_rb.html
-- doc/lib/babel_rb.html
-- doc/lib/common_functions_rb.html
 - doc/index.html
-- doc/bin/neptune.html
+- doc/ExodusTaskInfo.html
+- doc/table_of_contents.html
+- doc/NeptuneManagerException.html
 - doc/BabelHelper.html
 - doc/images/wrench.png
 - doc/images/loadingAnimation.gif
@@ -72,40 +71,38 @@ files:
 - doc/images/brick_link.png
 - doc/images/page_green.png
 - doc/images/brick.png
+- doc/images/delete.png
 - doc/images/date.png
+- doc/images/add.png
 - doc/images/bug.png
 - doc/images/bullet_black.png
 - doc/images/page_white_width.png
 - doc/images/tag_green.png
 - doc/images/macFFBgHack.png
 - doc/images/wrench_orange.png
+- doc/images/transparent.png
 - doc/images/ruby.png
 - doc/images/bullet_toggle_plus.png
 - doc/images/package.png
 - doc/images/bullet_toggle_minus.png
+- doc/images/tag_blue.png
 - doc/created.rid
 - doc/BadConfigurationException.html
 - lib/common_functions.rb
-- lib/app_controller_client.rb
+- lib/exodus.rb
 - lib/babel.rb
+- lib/neptune_manager_client.rb
+- lib/task_info.rb
+- lib/exodus_task_info.rb
 - lib/custom_exceptions.rb
 - lib/neptune.rb
-- test/integration/tc_c.rb
-- test/integration/tc_dfsp.rb
-- test/integration/test_helper.rb
-- test/integration/tc_mpi.rb
-- test/integration/tc_dwssa.rb
-- test/integration/tc_erlang.rb
-- test/integration/tc_storage.rb
-- test/integration/tc_x10.rb
-- test/integration/tc_upc.rb
-- test/integration/ts_neptune.rb
-- test/integration/tc_mapreduce.rb
-- test/unit/test_app_controller_client.rb
-- test/unit/test_babel.rb
-- test/unit/test_neptune.rb
-- test/unit/test_common_functions.rb
-- test/unit/ts_all.rb
+- test/test_babel.rb
+- test/test_task_info.rb
+- test/test_exodus.rb
+- test/test_neptune.rb
+- test/test_neptune_manager_client.rb
+- test/test_common_functions.rb
+- test/ts_all.rb
 - samples/upc/run_upc_ring.rb
 - samples/upc/helloworld/HelloWorld.c
 - samples/upc/helloworld/Makefile
@@ -184,7 +181,6 @@ files:
 - samples/mpi/get_mpi_output.rb
 - README
 - LICENSE
-has_rdoc: true
 homepage: http://neptune-lang.org
 licenses: []
 
@@ -214,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: A domain specific language for deploying HPC apps to cloud platforms

data/doc/AppControllerClient.html

@@ -1,702 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-<head>
-  <meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
-
-  <title>Class: AppControllerClient</title>
-
-  <link rel="stylesheet" href="./rdoc.css" type="text/css" media="screen" />
-
-  <script src="./js/jquery.js" type="text/javascript"
-    charset="utf-8"></script>
-  <script src="./js/thickbox-compressed.js" type="text/javascript"
-    charset="utf-8"></script>
-  <script src="./js/quicksearch.js" type="text/javascript"
-    charset="utf-8"></script>
-  <script src="./js/darkfish.js" type="text/javascript"
-    charset="utf-8"></script>
-
-</head>
-<body class="class">
-
-  <div id="metadata">
-    <div id="home-metadata">
-      <div id="home-section" class="section">
-        <h3 class="section-header">
-          <a href="./index.html">Home</a>
-          <a href="./index.html#classes">Classes</a>
-          <a href="./index.html#methods">Methods</a>
-        </h3>
-      </div>
-    </div>
-
-    <div id="file-metadata">
-      <div id="file-list-section" class="section">
-        <h3 class="section-header">In Files</h3>
-        <div class="section-body">
-          <ul>
-          
-            <li><a href="./lib/app_controller_client_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
-              class="thickbox" title="lib/app_controller_client.rb">lib/app_controller_client.rb</a></li>
-          
-          </ul>
-        </div>
-      </div>
-
-      
-    </div>
-
-    <div id="class-metadata">
-
-      <!-- Parent Class -->
-      
-      <div id="parent-class-section" class="section">
-        <h3 class="section-header">Parent</h3>
-        
-        <p class="link"><a href="Object.html">Object</a></p>
-        
-      </div>
-      
-
-      <!-- Namespace Contents -->
-      
-
-      <!-- Method Quickref -->
-      
-      <div id="method-list-section" class="section">
-        <h3 class="section-header">Methods</h3>
-        <ul class="link-list">
-          
-          <li><a href="#method-c-new">::new</a></li>
-          
-          <li><a href="#method-i-compile_code">#compile_code</a></li>
-          
-          <li><a href="#method-i-does_file_exist-3F">#does_file_exist?</a></li>
-          
-          <li><a href="#method-i-get_acl">#get_acl</a></li>
-          
-          <li><a href="#method-i-get_output">#get_output</a></li>
-          
-          <li><a href="#method-i-get_supported_babel_engines">#get_supported_babel_engines</a></li>
-          
-          <li><a href="#method-i-make_call">#make_call</a></li>
-          
-          <li><a href="#method-i-put_input">#put_input</a></li>
-          
-          <li><a href="#method-i-set_acl">#set_acl</a></li>
-          
-          <li><a href="#method-i-start_neptune_job">#start_neptune_job</a></li>
-          
-        </ul>
-      </div>
-      
-
-      <!-- Included Modules -->
-      
-    </div>
-
-    <div id="project-metadata">
-      
-      
-
-      <div id="classindex-section" class="section project-section">
-        <h3 class="section-header">Class/Module Index
-          <span class="search-toggle"><img src="./images/find.png"
-            height="16" width="16" alt="[+]"
-            title="show/hide quicksearch" /></span></h3>
-        <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
-        <fieldset>
-          <legend>Quicksearch</legend>
-          <input type="text" name="quicksearch" value=""
-            class="quicksearch-field" />
-        </fieldset>
-        </form>
-
-        <ul class="link-list">
-        
-          <li><a href="./AppControllerClient.html">AppControllerClient</a></li>
-        
-          <li><a href="./AppControllerException.html">AppControllerException</a></li>
-        
-          <li><a href="./BabelHelper.html">BabelHelper</a></li>
-        
-          <li><a href="./BadConfigurationException.html">BadConfigurationException</a></li>
-        
-          <li><a href="./CommonFunctions.html">CommonFunctions</a></li>
-        
-          <li><a href="./FileNotFoundException.html">FileNotFoundException</a></li>
-        
-          <li><a href="./NeptuneHelper.html">NeptuneHelper</a></li>
-        
-          <li><a href="./Object.html">Object</a></li>
-        
-        </ul>
-        <div id="no-class-search-results" style="display: none;">No matching classes.</div>
-      </div>
-
-      
-    </div>
-  </div>
-
-  <div id="documentation">
-    <h1 class="class">AppControllerClient</h1>
-
-    <div id="description">
-      
-<p>A client that uses SOAP messages to communicate with the underlying cloud
-platform (here, AppScale). This client is similar to that used in the
-AppScale Tools, but with non-Neptune SOAP calls removed.</p>
-
-    </div>
-
-    <!-- Constants -->
-    
-
-    <!-- Attributes -->
-    
-    <div id="attribute-method-details" class="method-section section">
-      <h3 class="section-header">Attributes</h3>
-
-      
-      <div id="conn-attribute-method" class="method-detail">
-        <a name="conn"></a>
-        
-        <a name="conn="></a>
-        
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">conn</span><span
-            class="attribute-access-type">[RW]</span>
-        </div>
-
-        <div class="method-description">
-        
-        <p>The SOAP client that we use to communicate with the AppController.</p>
-        
-        </div>
-      </div>
-      
-      <div id="ip-attribute-method" class="method-detail">
-        <a name="ip"></a>
-        
-        <a name="ip="></a>
-        
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">ip</span><span
-            class="attribute-access-type">[RW]</span>
-        </div>
-
-        <div class="method-description">
-        
-        <p>The IP address of the AppController that we will be connecting to.</p>
-        
-        </div>
-      </div>
-      
-      <div id="secret-attribute-method" class="method-detail">
-        <a name="secret"></a>
-        
-        <a name="secret="></a>
-        
-        <div class="method-heading attribute-method-heading">
-          <span class="method-name">secret</span><span
-            class="attribute-access-type">[RW]</span>
-        </div>
-
-        <div class="method-description">
-        
-        <p>The secret string that is used to authenticate this client with
-AppControllers. It is initially generated by appscale-run-instances and can
-be found on the machine that ran that tool, or on any AppScale machine.</p>
-        
-        </div>
-      </div>
-      
-    </div>
-    
-
-    <!-- Methods -->
-    
-    <div id="public-class-method-details" class="method-section section">
-      <h3 class="section-header">Public Class Methods</h3>
-
-    
-      <div id="new-method" class="method-detail ">
-        <a name="method-c-new"></a>
-
-        
-        <div class="method-heading">
-          <span class="method-name">new</span><span
-            class="method-args">(ip, secret)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>A constructor that requires both the IP address of the machine to
-communicate with as well as the secret (string) needed to perform
-communication. AppControllers will reject SOAP calls if this secret
-(basically a password) is not present - it can be found in the user’s
-.appscale directory, and a helper method is usually present to fetch this
-for us.</p>
-          
-
-          
-          <div class="method-source-code"
-            id="new-source">
-<pre>
-<span class="ruby-comment"># File lib/app_controller_client.rb, line 41</span>
-def initialize(ip, secret)
-  <span class="ruby-ivar">@ip</span> = ip
-  <span class="ruby-ivar">@secret</span> = secret
-  
-  <span class="ruby-ivar">@conn</span> = <span class="ruby-constant">SOAP</span>::<span class="ruby-constant">RPC</span>::<span class="ruby-constant">Driver</span>.new(&quot;https://#{@ip}:17443&quot;)
-  <span class="ruby-ivar">@conn</span>.add_method(<span class="ruby-string">&quot;neptune_start_job&quot;</span>, <span class="ruby-string">&quot;job_data&quot;</span>, <span class="ruby-string">&quot;secret&quot;</span>)
-  <span class="ruby-ivar">@conn</span>.add_method(<span class="ruby-string">&quot;neptune_put_input&quot;</span>, <span class="ruby-string">&quot;job_data&quot;</span>, <span class="ruby-string">&quot;secret&quot;</span>)
-  <span class="ruby-ivar">@conn</span>.add_method(<span class="ruby-string">&quot;neptune_get_output&quot;</span>, <span class="ruby-string">&quot;job_data&quot;</span>, <span class="ruby-string">&quot;secret&quot;</span>)
-  <span class="ruby-ivar">@conn</span>.add_method(<span class="ruby-string">&quot;neptune_get_acl&quot;</span>, <span class="ruby-string">&quot;job_data&quot;</span>, <span class="ruby-string">&quot;secret&quot;</span>)
-  <span class="ruby-ivar">@conn</span>.add_method(<span class="ruby-string">&quot;neptune_set_acl&quot;</span>, <span class="ruby-string">&quot;job_data&quot;</span>, <span class="ruby-string">&quot;secret&quot;</span>)
-  <span class="ruby-ivar">@conn</span>.add_method(<span class="ruby-string">&quot;neptune_compile_code&quot;</span>, <span class="ruby-string">&quot;job_data&quot;</span>, <span class="ruby-string">&quot;secret&quot;</span>)
-  <span class="ruby-ivar">@conn</span>.add_method(<span class="ruby-string">&quot;neptune_get_supported_babel_engines&quot;</span>, <span class="ruby-string">&quot;job_data&quot;</span>, <span class="ruby-string">&quot;secret&quot;</span>)
-  <span class="ruby-ivar">@conn</span>.add_method(<span class="ruby-string">&quot;neptune_does_file_exist&quot;</span>, <span class="ruby-string">&quot;file&quot;</span>, <span class="ruby-string">&quot;job_data&quot;</span>, <span class="ruby-string">&quot;secret&quot;</span>)
-end</pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-    </div>
-  
-    <div id="public-instance-method-details" class="method-section section">
-      <h3 class="section-header">Public Instance Methods</h3>
-
-    
-      <div id="compile_code-method" class="method-detail ">
-        <a name="method-i-compile_code"></a>
-
-        
-        <div class="method-heading">
-          <span class="method-name">compile_code</span><span
-            class="method-args">(job_data)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>Instructs the AppController to fetch the code specified and compile it. The
-result should then be placed in a location specified in the job data.</p>
-          
-
-          
-          <div class="method-source-code"
-            id="compile_code-source">
-<pre>
-<span class="ruby-comment"># File lib/app_controller_client.rb, line 178</span>
-def compile_code(job_data)
-  result = <span class="ruby-string">&quot;&quot;</span>
-  make_call(<span class="ruby-constant">NO_TIMEOUT</span>, false) { 
-    result = conn.neptune_compile_code(job_data, <span class="ruby-ivar">@secret</span>)
-  }  
-  raise <span class="ruby-constant">AppControllerException</span>.new(result) if result =~ <span class="ruby-regexp">/Error:/</span>
-  return result
-end</pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="does_file_exist-3F-method" class="method-detail ">
-        <a name="method-i-does_file_exist-3F"></a>
-
-        
-        <div class="method-heading">
-          <span class="method-name">does_file_exist?</span><span
-            class="method-args">(file, job_data)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>Asks the AppController to see if the given file exists in the remote
-datastore. If extra credentials are needed for this operation, they are
-searched for within the job data.</p>
-          
-
-          
-          <div class="method-source-code"
-            id="does_file_exist-3F-source">
-<pre>
-<span class="ruby-comment"># File lib/app_controller_client.rb, line 203</span>
-def does_file_exist?(file, job_data)
-  result = false
-  make_call(<span class="ruby-constant">NO_TIMEOUT</span>, false) {
-    result = conn.neptune_does_file_exist(file, job_data, <span class="ruby-ivar">@secret</span>)
-  }
-  return result
-end</pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="get_acl-method" class="method-detail ">
-        <a name="method-i-get_acl"></a>
-
-        
-        <div class="method-heading">
-          <span class="method-name">get_acl</span><span
-            class="method-args">(job_data)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>Returns the ACL associated with the named piece of data stored in the
-underlying cloud platform. Right now, data can only be public or private,
-but future versions will add individual user support. Input, output, and
-exceptions mirror that of start_neptune_job.</p>
-          
-
-          
-          <div class="method-source-code"
-            id="get_acl-source">
-<pre>
-<span class="ruby-comment"># File lib/app_controller_client.rb, line 151</span>
-def get_acl(job_data)
-  result = <span class="ruby-string">&quot;&quot;</span>
-  make_call(<span class="ruby-constant">NO_TIMEOUT</span>, false) { 
-    result = conn.neptune_get_acl(job_data, <span class="ruby-ivar">@secret</span>)
-  }  
-  raise <span class="ruby-constant">AppControllerException</span>.new(result) if result =~ <span class="ruby-regexp">/Error:/</span>
-  return result
-end</pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="get_output-method" class="method-detail ">
-        <a name="method-i-get_output"></a>
-
-        
-        <div class="method-heading">
-          <span class="method-name">get_output</span><span
-            class="method-args">(job_data)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>Retrieves the output of a Neptune job, stored in an underlying database.
-Within AppScale, a special application runs, referred to as the Repository,
-which provides a key-value interface to Neptune job data. Data is stored as
-though it were on a file system, therefore output be of the usual form
-/folder/filename . Currently the contents of the file is returned as a
-string to the caller, but as this may be inefficient for non-trivial output
-jobs, the next version of Neptune will add an additional call to directly
-copy the output to a file on the local filesystem. See <a
-href="AppControllerClient.html#method-i-start_neptune_job">start_neptune_job</a>
-for conditions by which this method can raise AppControllerException.new as
-well as the input format used for job_data.</p>
-          
-
-          
-          <div class="method-source-code"
-            id="get_output-source">
-<pre>
-<span class="ruby-comment"># File lib/app_controller_client.rb, line 136</span>
-def get_output(job_data)
-  result = <span class="ruby-string">&quot;&quot;</span>
-  make_call(<span class="ruby-constant">NO_TIMEOUT</span>, false) { 
-    result = conn.neptune_get_output(job_data, <span class="ruby-ivar">@secret</span>)
-  }  
-  raise <span class="ruby-constant">AppControllerException</span>.new(result) if result =~ <span class="ruby-regexp">/Error:/</span>
-  return result
-end</pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="get_supported_babel_engines-method" class="method-detail ">
-        <a name="method-i-get_supported_babel_engines"></a>
-
-        
-        <div class="method-heading">
-          <span class="method-name">get_supported_babel_engines</span><span
-            class="method-args">(job_data)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>Asks the AppController for a list of all the Babel engines (each of which
-is a queue to store jobs and something that executes tasks) that are
-supported for the given credentials.</p>
-          
-
-          
-          <div class="method-source-code"
-            id="get_supported_babel_engines-source">
-<pre>
-<span class="ruby-comment"># File lib/app_controller_client.rb, line 191</span>
-def get_supported_babel_engines(job_data)
-  result = []
-  make_call(<span class="ruby-constant">NO_TIMEOUT</span>, false) {
-    result = conn.neptune_get_supported_babel_engines(job_data, <span class="ruby-ivar">@secret</span>)
-  }
-  return result
-end</pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="make_call-method" class="method-detail ">
-        <a name="method-i-make_call"></a>
-
-        
-        <div class="method-heading">
-          <span class="method-name">make_call</span><span
-            class="method-args">(time, retry_on_except)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>A helper method to make SOAP calls for us. This method is mainly here to
-reduce code duplication: all SOAP calls expect a certain timeout and can
-tolerate certain exceptions, so we consolidate this code into this method.
-Here, the caller specifies the timeout for the SOAP call (or NO_TIMEOUT if
-an infinite timeout is required) as well as whether the call should be
-retried in the face of exceptions. Exceptions can occur if the machine is
-not yet running or is too busy to handle the request, so these exceptions
-are automatically retried regardless of the retry value. Typically callers
-set this to false to catch ‘Connection Refused’ exceptions or the like.
-Finally, the caller must provide a block of code that indicates the SOAP
-call to make: this is really all that differs between the calling methods.
-The result of the block is returned to the caller.</p>
-          
-
-          
-          <div class="method-source-code"
-            id="make_call-source">
-<pre>
-<span class="ruby-comment"># File lib/app_controller_client.rb, line 70</span>
-def make_call(time, retry_on_except)
-  begin
-    <span class="ruby-constant">Timeout</span>::timeout(time) {
-      yield if block_given?
-    }
-  rescue <span class="ruby-constant">Errno</span>::<span class="ruby-constant">ECONNREFUSED</span>
-    if retry_on_except
-      retry
-    else
-      raise <span class="ruby-constant">AppControllerException</span>.new(<span class="ruby-string">&quot;Connection was refused. Is the AppController running?&quot;</span>)
-    end
-  rescue <span class="ruby-constant">OpenSSL</span>::<span class="ruby-constant">SSL</span>::<span class="ruby-constant">SSLError</span>, <span class="ruby-constant">NotImplementedError</span>, <span class="ruby-constant">Timeout</span>::<span class="ruby-constant">Error</span>
-    retry
-  rescue <span class="ruby-constant">Exception</span> =&gt; except
-    if retry_on_except
-      retry
-    else
-      raise <span class="ruby-constant">AppControllerException</span>.new(&quot;We saw an unexpected error of the type #{except.class} with the following message:\n#{except}.&quot;)
-    end
-  end
-end</pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="put_input-method" class="method-detail ">
-        <a name="method-i-put_input"></a>
-
-        
-        <div class="method-heading">
-          <span class="method-name">put_input</span><span
-            class="method-args">(job_data)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>Stores a file stored on the user’s local file system in the underlying
-database. The user can specify to use either the underlying database that
-AppScale is using, or alternative storage mechanisms (as of writing, Google
-Storage, Amazon S3, and Eucalyptus Walrus are supported) via the storage
-parameter.</p>
-          
-
-          
-          <div class="method-source-code"
-            id="put_input-source">
-<pre>
-<span class="ruby-comment"># File lib/app_controller_client.rb, line 116</span>
-def put_input(job_data)
-  result = <span class="ruby-string">&quot;&quot;</span>
-  make_call(<span class="ruby-constant">NO_TIMEOUT</span>, false) {
-    result = conn.neptune_put_input(job_data, <span class="ruby-ivar">@secret</span>)
-  }  
-  raise <span class="ruby-constant">AppControllerException</span>.new(result) if result =~ <span class="ruby-regexp">/Error:/</span>
-  return result
-end</pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="set_acl-method" class="method-detail ">
-        <a name="method-i-set_acl"></a>
-
-        
-        <div class="method-heading">
-          <span class="method-name">set_acl</span><span
-            class="method-args">(job_data)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>Sets the ACL of a specified pieces of data stored in the underlying cloud
-platform. As is the case with <a
-href="AppControllerClient.html#method-i-get_acl">get_acl</a>, ACLs can be
-either public or private right now, but this will be expanded upon in the
-future. As with the other SOAP calls, input, output, and exceptions mirror
-that of start_neptune_job.</p>
-          
-
-          
-          <div class="method-source-code"
-            id="set_acl-source">
-<pre>
-<span class="ruby-comment"># File lib/app_controller_client.rb, line 166</span>
-def set_acl(job_data)
-  result = <span class="ruby-string">&quot;&quot;</span>
-  make_call(<span class="ruby-constant">NO_TIMEOUT</span>, false) { 
-    result = conn.neptune_set_acl(job_data, <span class="ruby-ivar">@secret</span>)
-  }  
-  raise <span class="ruby-constant">AppControllerException</span>.new(result) if result =~ <span class="ruby-regexp">/Error:/</span>
-  return result
-end</pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-      <div id="start_neptune_job-method" class="method-detail ">
-        <a name="method-i-start_neptune_job"></a>
-
-        
-        <div class="method-heading">
-          <span class="method-name">start_neptune_job</span><span
-            class="method-args">(job_data)</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        
-
-        <div class="method-description">
-          
-          <p>Initiates the start of a Neptune job, whether it be a HPC job (MPI, X10, or
-MapReduce), or a scaling job (e.g., for AppScale itself). This method
-should not be used for retrieving the output of a job or getting / setting
-output ACLs, but just for starting new HPC / scaling jobs. This method
-takes a hash containing the parameters of the job to run, and can raise
-AppControllerException.new if the AppController it calls returns an error
-(e.g., if a bad secret is used or the machine isn’t running). Otherwise,
-the return value of this method is the result returned from the
-AppController.</p>
-          
-
-          
-          <div class="method-source-code"
-            id="start_neptune_job-source">
-<pre>
-<span class="ruby-comment"># File lib/app_controller_client.rb, line 101</span>
-def start_neptune_job(job_data)
-  result = <span class="ruby-string">&quot;&quot;</span>
-  make_call(<span class="ruby-constant">NO_TIMEOUT</span>, false) { 
-    result = conn.neptune_start_job(job_data, <span class="ruby-ivar">@secret</span>)
-  }  
-  raise <span class="ruby-constant">AppControllerException</span>.new(result) if result =~ <span class="ruby-regexp">/Error:/</span>
-  return result
-end</pre>
-          </div>
-          
-        </div>
-
-        
-
-        
-      </div>
-
-    
-    </div>
-  
-
-  </div>
-
-  <div id="validator-badges">
-    <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-    <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
-      Rdoc Generator</a> 2</small>.</p>
-  </div>
-
-</body>
-</html>
-