RubyGems - neptune - Versions diffs - 0.0.1 - Mend

neptune 0.0.1

Files changed (79) hide show

data/LICENSE +39 -0
data/README +50 -0
data/bin/neptune +16 -0
data/doc/AppControllerClient.html +468 -0
data/doc/CommonFunctions.html +368 -0
data/doc/LICENSE.html +131 -0
data/doc/Object.html +431 -0
data/doc/README.html +135 -0
data/doc/bin/neptune.html +58 -0
data/doc/created.rid +7 -0
data/doc/images/brick.png +0 -0
data/doc/images/brick_link.png +0 -0
data/doc/images/bug.png +0 -0
data/doc/images/bullet_black.png +0 -0
data/doc/images/bullet_toggle_minus.png +0 -0
data/doc/images/bullet_toggle_plus.png +0 -0
data/doc/images/date.png +0 -0
data/doc/images/find.png +0 -0
data/doc/images/loadingAnimation.gif +0 -0
data/doc/images/macFFBgHack.png +0 -0
data/doc/images/package.png +0 -0
data/doc/images/page_green.png +0 -0
data/doc/images/page_white_text.png +0 -0
data/doc/images/page_white_width.png +0 -0
data/doc/images/plugin.png +0 -0
data/doc/images/ruby.png +0 -0
data/doc/images/tag_green.png +0 -0
data/doc/images/wrench.png +0 -0
data/doc/images/wrench_orange.png +0 -0
data/doc/images/zoom.png +0 -0
data/doc/index.html +90 -0
data/doc/js/darkfish.js +116 -0
data/doc/js/jquery.js +32 -0
data/doc/js/quicksearch.js +114 -0
data/doc/js/thickbox-compressed.js +10 -0
data/doc/lib/app_controller_client_rb.html +60 -0
data/doc/lib/common_functions_rb.html +68 -0
data/doc/lib/job_rb.html +55 -0
data/doc/scripts/appscale/add_appserver_rb.html +52 -0
data/doc/scripts/appscale/add_database_rb.html +52 -0
data/doc/scripts/appscale/add_loadbalancer_rb.html +52 -0
data/doc/scripts/appscale/add_slave_rb.html +52 -0
data/doc/scripts/cewssa/cewssa-output.html +104 -0
data/doc/scripts/cewssa/get_cewssa_output_rb.html +52 -0
data/doc/scripts/cewssa/run_cewssa_rb.html +52 -0
data/doc/scripts/cewssa/test_dfsp_rb.html +52 -0
data/doc/scripts/dfsp/get_dfsp_output_rb.html +52 -0
data/doc/scripts/dfsp/make_output_public_rb.html +52 -0
data/doc/scripts/dfsp/run_dfsp_rb.html +52 -0
data/doc/scripts/dfsp/see_acl_rb.html +52 -0
data/doc/scripts/dfsp/test_dfsp_rb.html +52 -0
data/doc/scripts/mapreduce/get_mapreduce_output_rb.html +52 -0
data/doc/scripts/mapreduce/input-10.html +114 -0
data/doc/scripts/mapreduce/input-30.html +114 -0
data/doc/scripts/mapreduce/input-7.html +104 -0
data/doc/scripts/mapreduce/map_rb.html +56 -0
data/doc/scripts/mapreduce/reduce_rb.html +56 -0
data/doc/scripts/mapreduce/run_java_mr_rb.html +52 -0
data/doc/scripts/mapreduce/run_mapreduce_rb.html +52 -0
data/doc/scripts/mpi/Makefile.html +125 -0
data/doc/scripts/mpi/get_mpi_output_rb.html +52 -0
data/doc/scripts/mpi/hw2_c.html +52 -0
data/doc/scripts/mpi/hw2harness_c.html +52 -0
data/doc/scripts/mpi/hw2harness_h.html +52 -0
data/doc/scripts/mpi/run_mpi_cpi_rb.html +52 -0
data/doc/scripts/mpi/run_mpi_powermethod_rb.html +52 -0
data/doc/scripts/mpi/test_rb.html +52 -0
data/doc/scripts/x10/Makefile.html +106 -0
data/doc/scripts/x10/get_x10_output_rb.html +52 -0
data/doc/scripts/x10/run_x10_kmeans_rb.html +52 -0
data/doc/scripts/x10/run_x10_montypi_rb.html +52 -0
data/doc/scripts/x10/run_x10_nqueens_rb.html +52 -0
data/doc/scripts/x10/run_x10_powermethod_rb.html +52 -0
data/doc/scripts/x10/run_x10_qsort_rb.html +52 -0
data/doc/scripts/x10/test_rb.html +52 -0
data/lib/app_controller_client.rb +135 -0
data/lib/common_functions.rb +107 -0
data/lib/job.rb +161 -0
metadata +145 -0

data/doc/CommonFunctions.html ADDED Viewed

@@ -0,0 +1,368 @@
+<?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>Module: CommonFunctions</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="module">
+  <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/common_functions_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
+              class="thickbox" title="lib/common_functions.rb">lib/common_functions.rb</a></li>
+          </ul>
+        </div>
+      </div>
+    </div>
+    <div id="class-metadata">
+      <!-- Parent Class -->
+      <!-- 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-get_from_yaml">::get_from_yaml</a></li>
+          <li><a href="#method-c-get_secret_key">::get_secret_key</a></li>
+          <li><a href="#method-c-scp_file">::scp_file</a></li>
+          <li><a href="#method-c-scp_to_shadow">::scp_to_shadow</a></li>
+        </ul>
+      </div>
+      <!-- Included Modules -->
+    </div>
+    <div id="project-metadata">
+      <div id="fileindex-section" class="section project-section">
+        <h3 class="section-header">Files</h3>
+        <ul>
+          <li class="file"><a href="./LICENSE.html">LICENSE</a></li>
+          <li class="file"><a href="./README.html">README</a></li>
+        </ul>
+      </div>
+      <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="./CommonFunctions.html">CommonFunctions</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="module">CommonFunctions</h1>
+    <div id="description">
+<p>A helper module that aggregates functions that are not part of Neptune’s
+core functionality. Specifically, this module contains methods to scp files
+to other machines and the ability to read YAML files, which are often
+needed to determine which machine should be used for computation or to copy
+over code and input files.</p>
+    </div>
+    <!-- Constants -->
+    <!-- Attributes -->
+    <!-- Methods -->
+    <div id="public-class-method-details" class="method-section section">
+      <h3 class="section-header">Public Class Methods</h3>
+      <div id="get_from_yaml-method" class="method-detail ">
+        <a name="method-c-get_from_yaml"></a>
+        <div class="method-heading">
+          <span class="method-name">get_from_yaml</span><span
+            class="method-args">(keyname, tag, required=true)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Given the AppScale keyname, reads the associated YAML file and returns the
+contents of the given tag. The required flag (default value is true)
+indicates whether a value must exist for this tag: if set to true, this
+method aborts if the value doesn’t exist or the YAML file is malformed.
+If the required flag is set to false, it returns nil in either scenario
+instead.</p>
+          <div class="method-source-code"
+            id="get_from_yaml-source">
+<pre>
+<span class="ruby-comment"># File lib/common_functions.rb, line 79</span>
+def self.get_from_yaml(keyname, tag, required=true)
+  location_file = <span class="ruby-constant">File</span>.expand_path(&quot;~/.appscale/locations-#{keyname}.yaml&quot;)
+  abort(&quot;An AppScale instance is not currently running with the provided keyname, \&quot;#{keyname}\&quot;.&quot;) unless <span class="ruby-constant">File</span>.exists?(location_file)
+  begin
+    tree = <span class="ruby-constant">YAML</span>.load_file(location_file)
+  rescue <span class="ruby-constant">ArgumentError</span>
+    if required
+      abort(<span class="ruby-string">&quot;The yaml file you provided was malformed. Please correct any errors in it and try again.&quot;</span>)
+    else
+      return nil
+    end
+  end
+  value = tree[tag]
+  bad_yaml_format_msg = &quot;The file #{location_file} is in the wrong format and doesn't contain a #{tag} tag. Please make sure the file is in the correct format and try again&quot;
+  abort(bad_yaml_format_msg) if value.nil? and required
+  return value
+end</pre>
+          </div>
+        </div>
+      </div>
+      <div id="get_secret_key-method" class="method-detail ">
+        <a name="method-c-get_secret_key"></a>
+        <div class="method-heading">
+          <span class="method-name">get_secret_key</span><span
+            class="method-args">(keyname, required=true)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Returns the secret key needed for communication with AppScale’s Shadow
+node. This method is a nice frontend to the <a
+href="CommonFunctions.html#method-c-get_from_yaml">get_from_yaml</a>
+function, as the secret is stored in a YAML file.</p>
+          <div class="method-source-code"
+            id="get_secret_key-source">
+<pre>
+<span class="ruby-comment"># File lib/common_functions.rb, line 104</span>
+def self.get_secret_key(keyname, required=true)
+  return <span class="ruby-constant">CommonFunctions</span>.get_from_yaml(keyname, :secret)
+end</pre>
+          </div>
+        </div>
+      </div>
+      <div id="scp_file-method" class="method-detail ">
+        <a name="method-c-scp_file"></a>
+        <div class="method-heading">
+          <span class="method-name">scp_file</span><span
+            class="method-args">(local_file_loc, remote_file_loc, target_ip, public_key_loc)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Performs the actual remote copying of files: given the IP address and other
+information from <a
+href="CommonFunctions.html#method-c-scp_to_shadow">scp_to_shadow</a>,
+attempts to use scp to copy the file over. Aborts if the scp fails, which
+can occur if the network is down, if a bad keyname is provided, or if the
+wrong IP is given.</p>
+          <div class="method-source-code"
+            id="scp_file-source">
+<pre>
+<span class="ruby-comment"># File lib/common_functions.rb, line 37</span>
+def self.scp_file(local_file_loc, remote_file_loc, target_ip, public_key_loc)
+  cmd = <span class="ruby-string">&quot;&quot;</span>
+  local_file_loc = <span class="ruby-constant">File</span>.expand_path(local_file_loc)
+  if public_key_loc.class == <span class="ruby-constant">Array</span>
+    public_key_loc.each { |key|
+      key = <span class="ruby-constant">File</span>.expand_path(key)
+    }
+    cmd = &quot;scp -i #{public_key_loc.join(' -i ')} -o StrictHostkeyChecking=no 2&gt;&amp;1 #{local_file_loc} root@#{target_ip}:#{remote_file_loc}&quot;
+  else
+    public_key_loc = <span class="ruby-constant">File</span>.expand_path(public_key_loc)
+    cmd = &quot;scp -i #{public_key_loc} -o StrictHostkeyChecking=no 2&gt;&amp;1 #{local_file_loc} root@#{target_ip}:#{remote_file_loc}&quot;
+  end
+  cmd &lt;&lt; <span class="ruby-string">&quot;; echo $? &gt;&gt; ~/.appscale/retval&quot;</span>
+  retval_loc = <span class="ruby-constant">File</span>.expand_path(<span class="ruby-string">&quot;~/.appscale/retval&quot;</span>)
+  <span class="ruby-constant">FileUtils</span>.rm_f(retval_loc)
+  begin
+    <span class="ruby-constant">Timeout</span>::timeout(-1) { `#{cmd}` }
+  rescue <span class="ruby-constant">Timeout</span>::<span class="ruby-constant">Error</span>
+    abort(&quot;Remotely copying over files failed. Is the destination machine on and reachable from this computer? We tried the following command:\n\n#{cmd}&quot;)
+  end
+  loop {
+    break if <span class="ruby-constant">File</span>.exists?(retval_loc)
+    sleep(5)
+  }
+  retval = (<span class="ruby-constant">File</span>.open(retval_loc) { |f| f.read }).chomp
+  abort(&quot;\n\n[#{cmd}] returned #{retval} instead of 0 as expected. Is your environment set up properly?&quot;) if retval != <span class="ruby-string">&quot;0&quot;</span>
+  return cmd
+end</pre>
+          </div>
+        </div>
+      </div>
+      <div id="scp_to_shadow-method" class="method-detail ">
+        <a name="method-c-scp_to_shadow"></a>
+        <div class="method-heading">
+          <span class="method-name">scp_to_shadow</span><span
+            class="method-args">(local_file_loc, remote_file_loc, keyname)</span>
+          <span class="method-click-advice">click to toggle source</span>
+        </div>
+        <div class="method-description">
+          <p>Copies a file to the Shadow node (head node) within AppScale.  The caller
+specifies the local file location, the destination where the file should be
+placed, and the name of the key to use. The keyname is typically specified
+by the Neptune job given, but defaults to ”appscale” if not provided.</p>
+          <div class="method-source-code"
+            id="scp_to_shadow-source">
+<pre>
+<span class="ruby-comment"># File lib/common_functions.rb, line 25</span>
+def self.scp_to_shadow(local_file_loc, remote_file_loc, keyname)
+  shadow_ip = <span class="ruby-constant">CommonFunctions</span>.get_from_yaml(keyname, :shadow)
+  ssh_key = <span class="ruby-constant">File</span>.expand_path(&quot;~/.appscale/#{keyname}.key&quot;)
+  self.scp_file(local_file_loc, remote_file_loc, shadow_ip, ssh_key)
+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>

data/doc/LICENSE.html ADDED Viewed

@@ -0,0 +1,131 @@
+<?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>File: LICENSE [RDoc Documentation]</title>
+  <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
+  <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="file">
+  <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="project-metadata">
+      <div id="fileindex-section" class="section project-section">
+        <h3 class="section-header">Files</h3>
+        <ul>
+          <li class="file"><a href="./LICENSE.html">LICENSE</a></li>
+          <li class="file"><a href="./README.html">README</a></li>
+        </ul>
+      </div>
+      <div id="classindex-section" class="section project-section">
+        <h3 class="section-header">Class 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="./CommonFunctions.html">CommonFunctions</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>begin rdoc</h1>
+<p>Software License Agreement (BSD License)</p>
+<p>Copyright © 2008, Regents of the University of California All rights
+reserved.</p>
+<p>Redistribution and use of this software in source and binary forms, with or
+without modification, are permitted provided that the following conditions
+are met:</p>
+<ul><li>
+<p>Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.</p>
+</li><li>
+<p>Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.</p>
+</li></ul>
+<p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS
+IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.  USERS OF THIS SOFTWARE
+ACKNOWLEDGE THE POSSIBLE PRESENCE OF OTHER OPEN SOURCE LICENSED MATERIAL,
+COPYRIGHTED MATERIAL OR PATENTED MATERIAL IN THIS SOFTWARE, AND IF ANY SUCH
+MATERIAL IS DISCOVERED THE PARTY DISCOVERING IT MAY INFORM DR. CHANDRA
+KRINTZ AT THE UNIVERSITY OF CALIFORNIA,  SANTA BARBARA WHO WILL THEN
+ASCERTAIN THE MOST APPROPRIATE REMEDY, WHICH IN THE REGENTS’ DISCRETION
+MAY INCLUDE, WITHOUT LIMITATION, REPLACEMENT OF THE CODE SO IDENTIFIED,
+LICENSING OF THE CODE SO IDENTIFIED, OR WITHDRAWAL OF THE CODE CAPABILITY
+TO THE EXTENT NEEDED TO COMPLY WITH ANY SUCH LICENSES OR RIGHTS.</p>
+<h1>end</h1>
+  </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>