ruby-cute 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07edfbc07f26d33908a645a9caf1b8fa786830e8
-  data.tar.gz: 95168f3f5d0b06290c526e713f8d2d3f9033e5e9
+  metadata.gz: 1bcde24cec062bee7628aff6089b9a146c46be33
+  data.tar.gz: 4398bc96b38dca6b342118828649b766dcb1550b
 SHA512:
-  metadata.gz: 26efbf1b1a42f09c73ef2626fd7bf1420872c6efc04d0a389635dc865eec7edf6a0e6f0911d792ff1e26af7f6377d81d9402dd706ad50432c1ad027b6c066af9
-  data.tar.gz: e9210765ad54ff59a42f81e20c6232499b992cb2591daee8899cfbfdcb1a4fa7d78d741bdbe46f7f6d97fb71b6a08de14dec2bdd5169f5b440e3e1d977ef4478
+  metadata.gz: 97d07be46381ca5ccca6c531eba4f8bbef52038ea0cce3d0acba250cd8d7505c5ef8f8ff7311b19d979cff04bf7c9f4f96b9c2c4175ad0852ae8454dcfaf2639
+  data.tar.gz: 960f749e351f01142c235620df0c7cef5d210dfbf620ac2900939c3a04f7e997c639315f9941d5b6e7a79e0b4427474f37839a0aefa3d5f85976dc78df6b5052

data/debian/changelog

@@ -1,3 +1,9 @@
+ruby-cute (0.5) UNRELEASED; urgency=medium
+
+  * New release.
+
+ -- Cristian Ruiz <cristian.ruiz@inria.fr>  Tue, 3 May 2016 08:54:42 +0100
+
 ruby-cute (0.4) UNRELEASED; urgency=medium
 
   * Initial release.

data/examples/g5k-tutorial.md

@@ -109,7 +109,10 @@ file with the following content in order to choose our prefered editor:
 
 Here, we will use **Ruby-cute** to carry out an experiment.
 In this experiment, we will ask for two nodes equipped with infiniband and
-then, we will perform some performance test using a network benchmark called *NETPIPE*.
+then, we will perform some performance tests using a network benchmark called
+[NETPIPE](http://bitspjoule.org/netpipe/).
+NETPIPE performs simple ping-pong tests, bouncing messages of increasing size between two processes.
+Message sizes are chosen at regular intervals, and with slight perturbations, to provide a complete test of the communication system.
 For this particular experiment we have the following requirements:
 
 - A pair of SSH keys
@@ -148,7 +151,6 @@ ruby script:
 Then, we execute it using the `play` command which will execute line by line this script in the context of a Pry session.
 
     [21] pry(main)> play find_infiniband.rb
-    => ["grenoble", "lille", "luxembourg", "lyon", "nancy", "nantes", "reims", "rennes", "sophia"]
 
 We can observe that the variable `sites_infiniband` is now defined, telling us that Grenoble and Nancy sites offer Infiniband interconnection.
 
@@ -157,19 +159,20 @@ We can observe that the variable `sites_infiniband` is now defined, telling us t
 
 Then, create a pair of SSH keys (Necessary for OARSSH):
 
-    $ ssh-keygen -b 1024 -N "" -t rsa -f ~/my_ssh_jobkey
+    [23] pry(main)> .ssh-keygen -b 1024 -N "" -t rsa -f ~/my_ssh_jobkey
 
-We send the generated keys to the chosen site:
+We send the generated keys to the chosen site (ssh configuration has be set up for the following command to work,
+see [SSH Configuration](https://www.grid5000.fr/mediawiki/index.php/SSH_and_Grid%275000) for more information):
 
-    [22] pry(main)> .scp ~/my_ssh* nancy:~/
+    [24] pry(main)> .scp ~/my_ssh* nancy:~/
 
 Now that we have found the sites, let's submit a job. You can use between Grenoble and Nancy sites. If you
 take a look at {https://www.grid5000.fr/mediawiki/index.php/Status Monika} you will see that in Nancy we should use the OAR property 'ib20g' and in Grenoble we should use 'ib10g'.
 Given that the MPI bench uses just one MPI process, we will need in realty just one core of a given machine.
 We will use OAR syntax to ask for two cores in two different nodes with ib10g in Grenoble.
 
-    [23] pry(main)> job = $g5k.reserve(:site => "grenoble", :resources => "{ib10g='YES'}/nodes=2/core=1",:walltime => '01:00:00', :keys => "~/my_ssh_jobkey" )
-    2015-12-04 14:07:31.370 => Reserving resources: {ib20g='YES'}/nodes=2/core=1,walltime=01:00 (type: ) (in grenoble)
+    [25] pry(main)> job = $g5k.reserve(:site => "nancy", :resources => "{ib20g='YES'}/nodes=2/core=1",:walltime => '01:00:00', :keys => "~/my_ssh_jobkey" )
+    2015-12-04 14:07:31.370 => Reserving resources: {ib20g='YES'}/nodes=2/core=1,walltime=01:00 (type: ) (in nancy)
     2015-12-04 14:07:41.358 => Waiting for reservation 692665
     2015-12-04 14:07:41.444 => Reservation 692665 should be available at 2015-12-04 14:07:34 +0100 (0 s)
     2015-12-04 14:07:41.444 => Reservation 692665 ready
@@ -329,6 +332,20 @@ After running the script, it will show the output of the benchmark in the `pry`
       11:      24 bytes  38808 times -->    106.69 Mbps in       1.72 usec
       12:      27 bytes  41271 times -->    119.77 Mbps in       1.72 usec
 
+The latency is given by the last column for a 1 byte message; the maximum throughput is given by the last line.
+We can try to performn the same test without using infiniband, in order to observe the difference in bandwidth and latency:
+
+    Net::SSH.start(nodes.first, "oar", grid5000_opt) do |ssh|
+      netpipe_url = "http://pkgs.fedoraproject.org/repo/pkgs/NetPIPE/NetPIPE-3.7.1.tar.gz/5f720541387be065afdefc81d438b712/NetPIPE-3.7.1.tar.gz"
+      ssh.exec!("mkdir -p netpipe_exp")
+      ssh.exec!("wget -O ~/netpipe_exp/NetPIPE.tar.gz #{netpipe_url}")
+      ssh.exec!("cd netpipe_exp && tar -zvxf NetPIPE.tar.gz")
+      ssh.exec!("cd netpipe_exp/NetPIPE-3.7.1 && make mpi")
+      mpi_command = "export OAR_JOB_KEY_FILE=~/my_ssh_jobkey;"
+      mpi_command+= "mpirun --mca plm_rsh_agent \"oarsh\" --mca btl self,sm,tcp -machinefile /tmp/machine_file ~/netpipe_exp/NetPIPE-3.7.1/NPmpi"
+      ssh.exec(mpi_command)
+    end
+
 We can modify slightly the previous script to write the result into a file.
 We need to use `ssh.exec!` to capture the output of the commands.
 
@@ -361,6 +378,13 @@ We can check the results by doing:
      8:      16 bytes  27177 times -->     71.87 Mbps in       1.70 usec
      9:      19 bytes  33116 times -->     85.00 Mbps in       1.71 usec
 
+
+
+Once finished, we could release the job:
+
+    [34] pry(main)> $g5k.release(job)
+    => ""
+
 At the end of the experiment you can use the command `hist` to see what you have done so far.
 This can help you to assemble everything together in a whole script.
 
@@ -387,7 +411,12 @@ This can help you to assemble everything together in a whole script.
 
 ## Running NAS benchmarks in Grid'5000: getting acquainted with parallel command execution
 
-In this experiment, we will run the NAS benchmark in Grid'5000 and we will script a scalability test for one of the benchmarks.
+In this experiment, we will run the NAS benchmarks in Grid'5000 and we will script a scalability test for one of the benchmarks.
+The NAS Parallel Benchmarks (NPB) are a set of benchmarks targeting performance evaluation of highly parallel supercomputers.
+These benchmarks gather parallel kernels and three simluated applications.
+They mimic the workload of large scale computational fluid dynamic applications.
+The objective of this tutorial is to perform a scalability test of the NAS benchmarks. We are going to study how the
+number of computing units used during the computation reduce the execution time of the application.
 This experiment has the following requirements:
 
 - 4 or 2 nodes from any Grid'5000 sites
@@ -413,7 +442,7 @@ and type the following code:
     job = {}
 
     sites.each do |site|
-      job = $g5k.reserve(:site => site, :nodes => 4, :wait => false, :walltime => "01:00:00")
+      job = $g5k.reserve(:site => site, :cluster => 1, :nodes => 4, :wait => false, :walltime => "01:00:00")
       begin
         job = $g5k.wait_for_job(job, :wait_time => 60)
         puts "Nodes assigned #{job['assigned_nodes']}"
@@ -583,9 +612,9 @@ Then, we can assign this to a new variable:
      [33] pry(main)> lu_path = results.values.first[:stdout]
      => "/tmp/NPB3.3/NPB3.3-MPI/bin/lu.A.32"
 
-The setup of the experiment is done. It is time to execute the benchmark by typing the following into `pry` console.
+The setup of the experiment is done. It is time to execute the benchmark by typing the following into `pry` console:
 
-    Net::SSH.start(nodes.first,"cruizsanabria") do |ssh|
+    Net::SSH.start(nodes.first) do |ssh|
       results = ssh.exec!("mpirun --mca btl self,sm,tcp -np 32 --machinefile machine_file #{lu_path}")
     end
 
@@ -610,7 +639,7 @@ And copy-paste the following script:
 
     expe_res = {}
 
-    Net::SSH.start(nodes.first,"cruizsanabria") do |ssh|
+    Net::SSH.start(nodes.first) do |ssh|
       binaries.each do |binary|
         processes = /A\.(\d*)/.match(binary)[1]
         expe_res[processes]= {}
@@ -649,7 +678,7 @@ Once finished, we could release the job:
 In this experiment, we will perform network measurements between two nodes located in different Grid'5000 sites.
 The network measurements will be carried out in an isolated VLAN.
 We will first reserved two nodes located in two different Grid'5000 sites in deploy mode and we will ask for two routed VLANs.
-Once the nodes are ready an environment will be deployed and the application iperf will be install in all nodes.
+Once the nodes are ready, an environment will be deployed and the application iperf will be install in all nodes.
 Then, we will perform some network measurements among the nodes.
 Finally, we will query the KWAPI using the G5K metrology API to get the network traffic generated during our experiment.
 
@@ -916,6 +945,7 @@ We could get all the names of the probes specific to this metric by typing:
 
     probes = $g5k.get_metric("rennes",:metric => "network_in").uids
 
+Please replace the first parameter with the site you have used in the experiment.
 If you type that in `pry` you will get:
 
     [13] pry(main)> probes
@@ -944,7 +974,7 @@ Which will give us an Array of Arrays that we can flatten by doing:
 
 As we are going to fetch the data for Rennes (First node). We could do:
 
-    [68] pry(main)> probe_expe = probes.select{ |p| p[nodes_normal[0].split(".")[0]]}
+    [68] pry(main)> probe_expe = probes.select{ |p| p == nodes_normal[0].split(".")[0] }
 
 So, at this point we already have the probe we want to request.
 Next step is to get the start time of the interval, we can choose for example, the time at which deployments have finished:
@@ -990,6 +1020,10 @@ and execute it with:
     1453293160.655534=>4498405298908,
     1453293161.998718=>4498405299219,
 
+We can release the nodes:
+
+    [58] pry(main)> jobs.values.each{ |j| $g5k.release(j)}
+
 ## Conclusions
 
 This tutorial has shown how the scripting of complex experiment can be done using the Ruby scripting language.

data/lib/cute/g5k_api.rb

@@ -200,7 +200,7 @@ module Cute
       def initialize(uri,api_version,user,pass,on_error)
         @user = user
         @pass = pass
-        @api_version = api_version.nil? ? "sid" : api_version
+        @api_version = api_version.nil? ? "stable" : api_version
         if (user.nil? or pass.nil?)
           @endpoint = uri # Inside Grid'5000
         else
@@ -289,15 +289,7 @@ module Cute
 
         # Handling G5k API errors
         case e.http_code
-        when 500
-          # This part deals with bug: https://intranet.grid5000.fr/bugzilla/show_bug.cgi?id=5912
-          # Grid'5000 returns 500 error code even though the error was generated by a bad request
-          http_body = JSON.parse("{#{e.http_body.split("\n").select{ |x| x.include?("code")}.first}}")
-          if http_body["code"] == 400
-            raise BadRequest.new("Bad request", e)
-          else
-            raise RequestFailed.new("Service internal error", e)
-          end
+
         when  400
           raise BadRequest.new("Bad request", e)
         when 404
@@ -308,7 +300,7 @@ module Cute
           if @on_error == :ignore
             return nil
           else
-            raise RequestFailed.new("Service internal error", e)
+            raise RequestFailed.new("Grid5000 API internal error", e)
           end
         end
       end
@@ -320,14 +312,14 @@ module Cute
     # To simplify the use of the module, it is better to create a file with the following information:
     #
     #     $ cat > ~/.grid5000_api.yml << EOF
-    #     $ uri: https://api.grid5000.fr/
-    #     $ username: user
-    #     $ password: **********
-    #     $ version: sid
-    #     $ EOF
+    #       uri: https://api.grid5000.fr/
+    #       username: user
+    #       password: **********
+    #       version: sid
+    #       EOF
     #
     # The *username* and *password* are not necessary if you are using the module from inside Grid'5000.
-    # You can take a look at the {Cute::G5K::API#initialize G5K::API constructor} to see more details for
+    # You can take a look at the {Cute::G5K::API#initialize G5K::API constructor} to see more details of
     # this configuration.
     #
     # = Getting started
@@ -339,8 +331,8 @@ module Cute
     # In the presence of error, {Cute::G5K::API G5K::API} raises exceptions (see {Cute::G5K::Error G5K exceptions}),
     # that you can handle to decide the workflow of your experiment
     # (see {Cute::G5K::API#wait_for_deploy wait_for_deploy} and {Cute::G5K::API#wait_for_deploy wait_for_job}).
-    # Let's show how {Cute::G5K::API G5K::API} is used through an example, suppose we want to reserve 3 nodes in Nancy site for 1 hour.
-    # In order to do that we would write something like this:
+    # In the following example it is shown how {Cute::G5K::API G5K::API} is used. The example represents
+    # the reservation of 3 nodes in Nancy site for 1 hour:
     #
     #     require 'cute'
     #
@@ -354,7 +346,7 @@ module Cute
     #
     #     $ ruby example.rb
     #
-    # The execution will block until you got the reservation. Then, you can interact with the nodes you reserved the way you used to or
+    # The execution will block until you got the reservation. Then, you can interact with the nodes you reserved in the way you used to or
     # add more code to the previous script for controlling your experiment with Ruby-Cute as shown in this
     # {http://www.rubydoc.info/github/ruby-cute/ruby-cute/master/file/examples/g5k_exp_virt.rb  example}.
     # We have just used the method {Cute::G5K::API#reserve reserve} that allow us to reserve resources in Grid'5000.
@@ -372,7 +364,7 @@ module Cute
     #
     #     puts "Assigned nodes : #{job['assigned_nodes']}"
     #
-    # Your public ssh key located in ~/.ssh will be copied by default on the deployed machines,
+    # By default your public ssh key '~/.ssh/id_rsa.pub' will be copied on the deployed machines,
     # you can specify another path for your keys with the option *:keys*.
     # In order to deploy your own environment, you have to put the tar file that contains the operating system you want to deploy and
     # the environment description file, under the public directory of a given site.
@@ -393,7 +385,7 @@ module Cute
     #     puts "Log in into the nodes using the following hostnames: #{g5k.get_vlan_nodes(job)}"
     #
     # If you do not want that the method {Cute::G5K::API#reserve reserve} perform the deployment for you, you have to use the option :type => :deploy.
-    # This can be useful when deploying different environments in your reserved nodes. For example deploying the environments for a small HPC cluster.
+    # This can be useful when deploying different environments in your reserved nodes, for example: deploying the environments for a small HPC cluster.
     # You have to use the method {Cute::G5K::API#deploy deploy} for performing the deploy.
     # This method do not block by default, that is why you have to use the method {Cute::G5K::API#wait_for_deploy wait_for_deploy} in order to block the execution
     # until the deployment is done.
@@ -480,7 +472,7 @@ module Cute
       #
       #     g5k = Cute::G5K::API.new(:conf_file =>"config file path")
       #
-      # You can specify other parameter to use:
+      # You can specify other parameters to use:
       #
       #     g5k = Cute::G5K::API.new(:uri => "https://api.grid5000.fr", :version => "sid")
       #
@@ -509,8 +501,8 @@ module Cute
         config = YAML.load(File.open(params[:conf_file],'r')) unless params[:conf_file].nil?
         @user = params[:username] || config["username"]
         @pass = params[:password] || config["password"]
-        @uri = params[:uri] || config["uri"]
-        @api_version = params[:version] || config["version"] || "sid"
+        @uri = params[:uri] || config["uri"] || "https://api.grid5000.fr/"
+        @api_version = params[:version] || config["version"] || "stable"
         @logger = nil
 
         begin
@@ -629,13 +621,18 @@ module Cute
       #         if a uid is provided only the jobs owned by the user are shown.
       # @param site [String] a valid Grid'5000 site name
       # @param uid [String] user name in Grid'5000
-      # @param state [String] jobs state: running, waiting
-      def get_jobs(site, uid = nil, state = nil)
-        filter = "?"
-        filter += state.nil? ? "" : "state=#{state}"
-        filter += uid.nil? ? "" : "&user=#{uid}"
-        filter += "limit=25" if (state.nil? and uid.nil?)
-        jobs = @g5k_connection.get_json(api_uri("/sites/#{site}/jobs/#{filter}")).items
+      # @param states [Array] or [String] jobs state: running, waiting (multiple states can be specified)
+      def get_jobs(site, uid = nil, states = nil)
+
+        parameters = []
+        if states then
+          states = [states] if states.is_a?(String)
+          parameters.push("state=#{states.join(",")}")
+        end
+        parameters.push("user=#{uid}") if uid
+        parameters.push("limit=25") if (states.nil? and uid.nil?)
+
+        jobs = @g5k_connection.get_json(api_uri("/sites/#{site}/jobs?#{parameters.join("&")}")).items
         jobs.map{ |j| @g5k_connection.get_json(j.rel_self)}
         # This request sometime is could take a little long when all jobs are requested
         # The API return by default 50 the limit was set to 25 (e.g., 23 seconds).
@@ -718,13 +715,18 @@ module Cute
       # By default it only shows the jobs in state *running*.
       # You can specify another state like this:
       #
-      # = Example
-      #    get_my_jobs("nancy", state="waiting")
+      # = Examples
+      #    get_my_jobs("nancy", "waiting")
+      # Getting several states:
+      #   get_my_jobs("nancy", ["waiting","running"])
       # Valid states are specified in {https://api.grid5000.fr/doc/4.0/reference/spec.html Grid'5000 API spec}
       # @return [Array] all my submitted jobs to a given site and their associated deployments.
       # @param site [String] a valid Grid'5000 site name
-      def get_my_jobs(site, state = "running")
-        jobs = get_jobs(site, g5k_user, state)
+      # @param states [String/Array]  possible job state values (waiting, launching, running, hold, error, terminated)
+      def get_my_jobs(site, states = "running")
+
+#        raise ArgumentError,"States parameter should be an Array" unless states.is_a?(Array)
+        jobs = get_jobs(site, g5k_user, states)
         deployments = get_deployments(site, g5k_user)
         # filtering deployments only the job in state running make sense
         jobs.map{ |j| j["deploy"] = deployments.select{ |d| d["created_at"] > j["started_at"]} if j["state"] == "running"}
@@ -877,7 +879,7 @@ module Cute
       # @option opts [Numeric] :nodes Number of nodes to reserve
       # @option opts [String] :walltime Walltime of the reservation
       # @option opts [String] :site Grid'5000 site
-      # @option opts [Symbol] :type Type of reservation: :deploy, :allow_classic
+      # @option opts [Symbol] :type Type of reservation: :deploy, :allow_classic_ssh
       # @option opts [String] :name Reservation name
       # @option opts [String] :cmd The command to execute when the job starts (e.g. ./my-script.sh).
       # @option opts [String] :cluster Valid Grid'5000 cluster
@@ -902,7 +904,7 @@ module Cute
         nodes = opts.fetch(:nodes, 1)
         walltime = opts.fetch(:walltime, '01:00:00')
         site = opts[:site]
-        type = opts[:type]
+        type = opts.fetch(:type, [])
         name = opts.fetch(:name, 'rubyCute job')
         command = opts[:cmd]
         opts[:wait] = true if opts[:wait].nil?
@@ -914,7 +916,8 @@ module Cute
         properties = opts[:properties]
         reservation = opts[:reservation]
         resources = opts.fetch(:resources, "")
-        type = :deploy if opts[:env]
+        type = [:deploy] if opts[:env]
+        type = [type] if type.is_a?(Symbol)
         keys = opts[:keys]
         queue = opts[:queue]
 
@@ -936,14 +939,17 @@ module Cute
         walltime = walltime.to_time
 
         command = "sleep #{secs}" if command.nil?
-        type = type.to_sym unless type.nil?
 
         if resources == ""
           resources = "/switch=#{switches}" unless switches.nil?
           resources += "/nodes=#{nodes}"
           resources += "/cpu=#{cpus}" unless cpus.nil?
           resources += "/core=#{cores}" unless cores.nil?
-          resources = "{cluster='#{cluster}'}" + resources unless cluster.nil?
+
+          if cluster
+            resources = (cluster.is_a?(Fixnum) ? "/cluster=#{cluster}" : "{cluster='#{cluster}'}") + resources
+          end
+
           resources = "{type='#{vlan}'}/vlan=1+" + resources unless vlan.nil?
           resources = "slash_#{subnets[0]}=#{subnets[1]}+" + resources unless subnets.nil?
         end
@@ -959,10 +965,11 @@ module Cute
         info "Reserving resources: #{resources} (type: #{type}) (in #{site})"
 
         payload['properties'] = properties unless properties.nil?
-        payload['types'] = [ type.to_s ] unless type.nil?
+        payload['types'] = type.map{ |t| t.to_s} unless type.nil?
+        type.map!{|t| t.to_sym}  unless type.nil?
         payload['queue'] = queue if queue
 
-        if not type == :deploy
+        unless type.include?(:deploy)
           if opts[:keys]
             payload['import-job-key-from-file'] = [ File.expand_path(keys) ]
           else
@@ -1030,7 +1037,8 @@ module Cute
       #    }
       #
       # @param job [G5KJSON] as described in {Cute::G5K::G5KJSON job}
-      # @param opts [Hash] options
+      # @param [Hash] opts Options
+      # @option opts [Numeric] :wait_time Number of seconds to wait before triggering a timeout
       def wait_for_job(job,opts={})
         opts[:wait_time] = 36000 if opts[:wait_time].nil?
         jid = job['uid']
@@ -1073,10 +1081,15 @@ module Cute
       #
       #    deploy(job, :nodes => ["genepi-2.grid5000.fr"], :env => "wheezy-x64-xen", :keys => "~/my_key")
       #
+      # The parameter *:keys* [String] can be a string specifying the path of the key (as the previous case)
+      # or the contents of the public ssh key as the example given below:
+      #
+      #    deploy(job,:env => "jessie-x64-big", :keys =>  File.read("/tmp/test_key/test_key.pub"))
+      #
       # @param job [G5KJSON] as described in {Cute::G5K::G5KJSON job}
       # @param [Hash] opts Deploy options
       # @option opts [String] :env {http://kadeploy3.gforge.inria.fr/ Kadeploy} environment to deploy
-      # @option opts [String] :nodes Specifies the nodes to deploy on
+      # @option opts [Array] :nodes Specifies the nodes to deploy on
       # @option opts [String] :keys Specifies the SSH keys to copy for the deployment
       # @option opts [Boolean] :wait Whether or not to wait until the deployment is done (default is false)
       # @return [G5KJSON] a job with deploy information as described in {Cute::G5K::G5KJSON job}
@@ -1102,9 +1115,19 @@ module Cute
 
         if opts[:keys].nil? then
           public_key_path = File.expand_path("~/.ssh/id_rsa.pub")
-          public_key_file = File.exist?(public_key_path) ? File.read(public_key_path) : ""
+          if File.exist?(public_key_path) then
+            public_key_file = File.read(public_key_path)
+          else
+            raise ArgumentError, "No public ssh key found"
+          end
+
         else
-          public_key_file = File.read("#{File.expand_path(opts[:keys])}.pub")
+          # We check if the string passed contains the ssh public key
+          if (opts[:keys].length < 300 && (opts[:keys] =~ /^ssh.*/).nil?)
+            public_key_file = File.read("#{File.expand_path(opts[:keys])}.pub").chop
+          else
+            public_key_file = opts[:keys]
+          end
         end
 
         payload = {

data/lib/cute/taktuk.rb

@@ -19,8 +19,66 @@ module Cute
   #       end
   #       puts results
   #
-  # You can go directly to the documentation of useful methods such {TakTuk::TakTuk#exec exec},
-  # {TakTuk::TakTuk#exec! exec!}, {TakTuk::TakTuk#put put}, {TakTuk::TakTuk#input input}, etc.
+  # = Understanding {TakTuk::TakTuk#exec exec} and {TakTuk::TakTuk#exec! exec!}
+  #
+  # This section explains the differences between {TakTuk::TakTuk#exec exec} and {TakTuk::TakTuk#exec! exec!} with
+  # several examples.
+  # == Example 1
+  #
+  #       Cute::TakTuk.start(['host1','host2','host3'],:user => "root") do |tak|
+  #            tak.exec("df")
+  #            tak.exec("ls -l")
+  #            tak.exec("sleep 20")
+  #            tak.exec("tar xvf file.tar")
+  #       end
+  #
+  # In the previous example all the commands will be executed concurrently on each host*.
+  # This will be equivalent to execute the following sequence in bash:
+  #
+  #       $ df &
+  #       $ ls -l &
+  #       $ sleep 20 &
+  #       $ tar xvf file.tar &
+  #       $ wait
+  #
+  # The {Cute::TakTuk#start start} method waits for all commands, it performs a {TakTuk::TakTuk#loop loop()} implicitly.
+  # This implicit {TakTuk::TakTuk#loop loop()} has the same behaviour as the 'wait' command in bash.
+  # == Example 2
+  #       Cute::TakTuk.start(['host1','host2','host3'],:user => "root") do |tak|
+  #            tak.exec("df")
+  #            tak.exec("ls -l")
+  #            tak.loop()
+  #            tak.exec("sleep 20")
+  #            tak.exec("tar xvf file.tar")
+  #       end
+  # This will execute the two first comamnds concurrently and then the remaining commands concurrently.
+  # It is equivalent to execute the following sequence in bash:
+  #       $ df &
+  #       $ ls -l &
+  #       $ wait
+  #       $ sleep 20 &
+  #       $ tar xvf file.tar &
+  #       $ wait
+  # == Example 3
+  #       Cute::TakTuk.start(['host1','host2','host3'],:user => "root") do |tak|
+  #            tak.exec("df")
+  #            tak.exec("ls -l")
+  #            tak.exec!("sleep 20")
+  #            tak.exec("tar xvf file.tar")
+  #       end
+  #
+  # Notice that we use now the {TakTuk::TakTuk#exec! exec!} method
+  # which will wait for the previous commands and then it will block until the command finishes.
+  # It is equivalent to execute the following sequence in bash:
+  #       $ df &
+  #       $ ls -l &
+  #       $ wait
+  #       $ sleep 20 &
+  #       $ wait
+  #       $ tar xvf file.tar &
+  #       $ wait
+  # You can go directly to the documentation of the mentioned methods {TakTuk::TakTuk#exec exec},
+  # {TakTuk::TakTuk#exec! exec!} and other useful methods such as: {TakTuk::TakTuk#put put}, {TakTuk::TakTuk#input input}, etc.
   # @see http://taktuk.gforge.inria.fr/.
   # @see TakTuk::TakTuk TakTuk Class for more documentation.
   module TakTuk

data/lib/cute/version.rb

@@ -1,3 +1,3 @@
 module Cute
-  VERSION = "0.4"
+  VERSION = "0.5"
 end

data/spec/g5k_api_check_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+#These tests will check the API Grid'5000 using all the methods that perform a GET request
+
+describe Cute::G5K::API do
+
+  subject { g5k = ENV['TEST_REAL'].nil?? Cute::G5K::API.new(:user => "test") : Cute::G5K::API.new() }
+
+  before :each do
+    if ENV['TEST_REAL']
+      WebMock.disable!
+    end
+  end
+
+  it "checks initialization of G5K::API" do
+    expect(subject.rest).to be_an_instance_of(Cute::G5K::G5KRest)
+  end
+
+  it "returns an array with the clusters ids in nancy" do
+    clusters = subject.cluster_uids("nancy")
+    expect(clusters.length).to be > 0
+  end
+
+  it "returns an array with the clusters ids in grenoble" do
+    clusters = subject.cluster_uids("grenoble")
+    expect(clusters.length).to be > 0
+  end
+
+  it "returns an array with the clusters ids in lyon" do
+    clusters = subject.cluster_uids("lyon")
+    expect(clusters.length).to be > 0
+  end
+
+  it "returns an array with the clusters ids in lille" do
+    clusters = subject.cluster_uids("lille")
+    expect(clusters.length).to be > 0
+  end
+
+  it "returns a JSON Hash with the status of a site grenoble" do
+    expect(subject.site_status("grenoble")).to be_an_instance_of(Cute::G5K::G5KJSON)
+  end
+
+  it "returns a JSON Hash with the status of a site nancy" do
+    expect(subject.site_status("nancy")).to be_an_instance_of(Cute::G5K::G5KJSON)
+  end
+
+  it "return my_jobs in lille site" do
+    expect(subject.get_my_jobs("lille")).to be_an_instance_of(Array)
+  end
+
+  it "returns all deployments in nancy" do
+    expect(subject.get_deployments("nancy")).to be_an_instance_of(Cute::G5K::G5KArray)
+  end
+
+  it "returns all deployments in lille" do
+    expect(subject.get_deployments("lille")).to be_an_instance_of(Cute::G5K::G5KArray)
+  end
+
+  it "returns all deployments in grenoble" do
+    expect(subject.get_deployments("grenoble")).to be_an_instance_of(Cute::G5K::G5KArray)
+  end
+
+end

data/spec/g5k_api_spec.rb

@@ -13,12 +13,13 @@ describe Cute::G5K::API do
     index = ((day/31.to_f)*sites.length).to_i
     index = 1 if index == 0
     @rand_site = sites[index]
-    @env = subject.environment_uids(@rand_site).first
+    @env = "jessie-x64-big" # This could change but there is no way to get the available environments
     if ENV['TEST_REAL']
       WebMock.disable!
       puts "Testing in real Grid'5000 using site: #{@rand_site}"
       puts "Warning G5K_USER environment variable has to be defined for some tests" if ENV['G5K_USER'].nil?
     end
+
   end
 
   it "checks initialization of G5K::API" do
@@ -56,6 +57,10 @@ describe Cute::G5K::API do
     expect(subject.get_my_jobs(@rand_site)).to be_an_instance_of(Array)
   end
 
+  it "return my jobs in different states" do
+    expect(subject.get_my_jobs(@rand_site,["running","terminated"]).length).to be > 1
+  end
+
   it "returns all deployments" do
     expect(subject.get_deployments(@rand_site)).to be_an_instance_of(Cute::G5K::G5KArray)
   end
@@ -104,6 +109,12 @@ describe Cute::G5K::API do
     subject.release(job)
   end
 
+  it "reserves besteffort" do
+    job = subject.reserve(:site => @rand_site, :type => [:besteffort,:deploy])
+    expect(job).to be_an_instance_of(Cute::G5K::G5KJSON)
+    subject.release(job)
+  end
+
 
   it "reserves with vlan and get vlan hostnames" do
     job = subject.reserve(:site => @rand_site, :nodes => 1, :type => :deploy, :vlan => :routed)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-cute
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Algorille team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-22 00:00:00.000000000 Z
+date: 2016-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -207,6 +207,7 @@ files:
 - lib/cute/version.rb
 - ruby-cute.gemspec
 - spec/extensions_spec.rb
+- spec/g5k_api_check_spec.rb
 - spec/g5k_api_spec.rb
 - spec/spec_helper.rb
 - spec/taktuk_spec.rb
@@ -232,12 +233,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Critically Useful Tools for Experiments
 test_files:
 - spec/extensions_spec.rb
+- spec/g5k_api_check_spec.rb
 - spec/g5k_api_spec.rb
 - spec/spec_helper.rb
 - spec/taktuk_spec.rb