ruby-cute 0.5 → 0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bcde24cec062bee7628aff6089b9a146c46be33
-  data.tar.gz: 4398bc96b38dca6b342118828649b766dcb1550b
+  metadata.gz: 4bee03262cac39274dd43426589fce86de6962eb
+  data.tar.gz: b0262a03d84c76f2557550f4a0c05bcefc7c2a09
 SHA512:
-  metadata.gz: 97d07be46381ca5ccca6c531eba4f8bbef52038ea0cce3d0acba250cd8d7505c5ef8f8ff7311b19d979cff04bf7c9f4f96b9c2c4175ad0852ae8454dcfaf2639
-  data.tar.gz: 960f749e351f01142c235620df0c7cef5d210dfbf620ac2900939c3a04f7e997c639315f9941d5b6e7a79e0b4427474f37839a0aefa3d5f85976dc78df6b5052
+  metadata.gz: 2241ac02410656a7dbf16006d2f28ea9d02767e1b4e395fc0861798e6891eb60d60ede93b7899d87f86fc3dbe355da0071a8e591760f828b5a6e14737f8011b2
+  data.tar.gz: ab9c2570faf491c33759ecd1317cf574b3e4779b86df251986b2456d50ba3b22eac475bc9af04e2017d278044f83bf0497f58ac6fb602ecc0be72f8f643f5a4e

data/README.md

@@ -27,6 +27,21 @@ Then, type the following for having ruby cute in your path (this is only necessa
 ```bash
 $ export PATH=$PATH:$(ruby -e 'puts "#{Gem.user_dir}/bin"')
 ```
+If you want to use Ruby-Cute outside Grid'5000 you need to create a configuration file with your credentials.
+By default you need to create a file called *.grid5000_api.yml* located in your home directory:
+
+```bash
+
+$ cat > ~/.grid5000_api.yml << EOF
+  uri: https://api.grid5000.fr/
+  username: user
+  password: **********
+  version: sid
+  EOF
+
+```
+
+For more details have a look at [G5K Module](http://www.rubydoc.info/github/ruby-cute/ruby-cute/master/Cute/G5K/API).
 
 ## Overview
 

data/debian/changelog

@@ -1,3 +1,9 @@
+ruby-cute (0.6) UNRELEASED; urgency=medium
+
+  * New release.
+
+ -- Cristian Ruiz <cristian.ruiz@inria.fr>  Thu, 20 Oct 2016 10:57:07 +0100
+
 ruby-cute (0.5) UNRELEASED; urgency=medium
 
   * New release.

data/examples/g5k-tutorial.md

@@ -199,8 +199,8 @@ A hash is returned containing all the information about the job that we have jus
      "directory"=>"/home/cruizsanabria",
      "events"=>[],
      "links"=>
-       [{"rel"=>"self", "href"=>"/sid/sites/nancy/jobs/692665", "type"=>"application/vnd.grid5000.item+json"},
-       {"rel"=>"parent", "href"=>"/sid/sites/nancy", "type"=>"application/vnd.grid5000.item+json"}],
+       [{"rel"=>"self", "href"=>"/3.0/sites/nancy/jobs/692665", "type"=>"application/vnd.grid5000.item+json"},
+       {"rel"=>"parent", "href"=>"/3.0/sites/nancy", "type"=>"application/vnd.grid5000.item+json"}],
      "resources_by_type"=>{"cores"=>["graphene-67.nancy.grid5000.fr", "graphene-45.nancy.grid5000.fr"]},
      "assigned_nodes"=>["graphene-67.nancy.grid5000.fr", "graphene-45.nancy.grid5000.fr"]}
 
@@ -751,7 +751,7 @@ In this variable, we can find information related with the deployment.
     [44] pry(main)> jobs["nancy"]["deploy"]
     => [{"created_at"=>1450439620,
     "environment"=>"jessie-x64-min",
-    "key"=>"https://api.grid5000.fr/sid/sites/nancy/files/cruizsanabria-key-84f3f1dbb1279bc1bddcd618e26c960307d653c5",
+    "key"=>"https://api.grid5000.fr/3.0/sites/nancy/files/cruizsanabria-key-84f3f1dbb1279bc1bddcd618e26c960307d653c5",
     "nodes"=>["graphite-4.nancy.grid5000.fr"],
     "result"=>{"graphite-4.nancy.grid5000.fr"=>{"macro"=>nil, "micro"=>nil, "state"=>"OK"}},
     "site_uid"=>"nancy",
@@ -761,8 +761,8 @@ In this variable, we can find information related with the deployment.
     "user_uid"=>"cruizsanabria",
     "vlan"=>14,
     "links"=>
-    [{"rel"=>"self", "href"=>"/sid/sites/nancy/deployments/D-b026879e-b185-4e20-8bc5-ea0842a6954b", "type"=>"application/vnd.grid5000.item+json"},
-    		     {"rel"=>"parent", "href"=>"/sid/sites/nancy", "type"=>"application/vnd.grid5000.item+json"}]}]
+    [{"rel"=>"self", "href"=>"/3.0/sites/nancy/deployments/D-b026879e-b185-4e20-8bc5-ea0842a6954b", "type"=>"application/vnd.grid5000.item+json"},
+    		     {"rel"=>"parent", "href"=>"/3.0/sites/nancy", "type"=>"application/vnd.grid5000.item+json"}]}]
 
 Some important information are: the status of the whole process and the state per node.
 We can use this information to check if the deployment have finished successfully in all nodes.

data/lib/cute/g5k_api.rb

@@ -116,8 +116,8 @@ module Cute
     #       "properties"=>"(deploy = 'YES') AND maintenance = 'NO'",
     #       "directory"=>"/home/name",
     #       "events"=>[],
-    #       "links"=>[{"rel"=>"self", "href"=>"/sid/sites/nancy/jobs/604692", "type"=>"application/vnd.grid5000.item+json"},
-    #                 {"rel"=>"parent", "href"=>"/sid/sites/nancy", "type"=>"application/vnd.grid5000.item+json"}],
+    #       "links"=>[{"rel"=>"self", "href"=>"/3.0/sites/nancy/jobs/604692", "type"=>"application/vnd.grid5000.item+json"},
+    #                 {"rel"=>"parent", "href"=>"/3.0/sites/nancy", "type"=>"application/vnd.grid5000.item+json"}],
     #       "resources_by_type"=>
     #        {"cores"=>
     #           ["griffon-8.nancy.grid5000.fr",
@@ -137,7 +137,7 @@ module Cute
     #       "deploy"=>
     #          {"created_at"=>1423575401,
     #           "environment"=>"http://public.sophia.grid5000.fr/~nniclausse/openmx.dsc",
-    #           "key"=>"https://api.grid5000.fr/sid/sites/nancy/files/cruizsanabria-key-84f3f1dbb1279bc1bddcd618e26c960307d653c5",
+    #           "key"=>"https://api.grid5000.fr/3.0/sites/nancy/files/cruizsanabria-key-84f3f1dbb1279bc1bddcd618e26c960307d653c5",
     #           "nodes"=>["griffon-8.nancy.grid5000.fr", "griffon-9.nancy.grid5000.fr", "griffon-77.nancy.grid5000.fr"],
     #           "site_uid"=>"nancy",
     #           "status"=>"processing",
@@ -146,7 +146,7 @@ module Cute
     #           "user_uid"=>"cruizsanabria",
     #           "vlan"=>5,
     #           "links"=>
-    #              [{"rel"=>"self", "href"=>"/sid/sites/nancy/deployments/D-751096de-0c33-461a-9d27-56be1b2dd980", "type"=>"application/vnd.grid5000.item+json"},
+    #              [{"rel"=>"self", "href"=>"/3.0/sites/nancy/deployments/D-751096de-0c33-461a-9d27-56be1b2dd980", "type"=>"application/vnd.grid5000.item+json"},
     class G5KJSON < Hash
 
       def items
@@ -259,8 +259,8 @@ module Cute
       def delete_json(path)
         begin
           return resource(path).delete()
-        rescue RestClient::InternalServerError => e
-          raise RequestFailed.new("Service internal error", e)
+        rescue  => e
+          handle_exception(e)
         end
       end
 
@@ -281,7 +281,15 @@ module Cute
       end
 
       # Issues a Cute::G5K exception according to the http status code
-      def handle_exception(e)
+      def handle_exception(e, req = nil)
+        puts("Error: #{$!}")
+        puts("Backtrace:\n\t"+e.backtrace.join("\n\t"))
+        if e.respond_to? :http_code
+          puts("HTTP Code: #{e.http_code}")
+        end
+        if e.respond_to? :response and e.response != ''
+          puts("Response: #{e.response}")
+        end
 
         unless e.respond_to? :http_code
           raise e
@@ -309,18 +317,17 @@ module Cute
 
     # This class helps you to access Grid'5000 REST API.
     # Thus, the most common actions such as reservation of nodes and deployment can be easily scripted.
-    # To simplify the use of the module, it is better to create a file with the following information:
+    # If you are using this module outside Grid'5000 you should created a configuration file with
+    # the following contents:
     #
     #     $ cat > ~/.grid5000_api.yml << EOF
     #       uri: https://api.grid5000.fr/
     #       username: user
     #       password: **********
-    #       version: sid
+    #       version: stable
     #       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 of
-    # this configuration.
+    # You can take a look at the {Cute::G5K::API#initialize G5K::API constructor} to see more details of this configuration.
     #
     # = Getting started
     #
@@ -368,9 +375,11 @@ module Cute
     # 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.
-    # *VLANS* are supported by adding the parameter :vlan => type where type can be: *:routed*, *:local*, *:global*.
+    # *VLANS* are supported by adding the parameter :vlan => type where type can be: *kavlan*, *kavlan-global*, *kavlan-local*.
     # The following example, reserves 10 nodes in the Lille site, starts the deployment of a custom environment over the nodes
-    # and puts the nodes under a routed VLAN. We used the method {Cute::G5K::API#get_vlan_nodes get_vlan_nodes} to get the
+    # and puts the nodes under a routed VLAN. The different types of VLANs are described
+    # in {https://www.grid5000.fr/mediawiki/index.php/KaVLAN KaVLAN}
+    # We used the method {Cute::G5K::API#get_vlan_nodes get_vlan_nodes} to get the
     # new hostnames assigned to your nodes.
     #
     #     require 'cute'
@@ -378,12 +387,14 @@ module Cute
     #     g5k = Cute::G5K::API.new()
     #
     #     job = g5k.reserve(:site => "lille", :nodes => 10,
-    #                       :env => 'https://public.lyon.grid5000.fr/~user/debian_custom_img.yaml',
-    #                       :vlan => :routed, :keys => "~/my_ssh_key")
+    #                       :env => 'http://public.lyon.grid5000.fr/~user/debian_custom_img.yaml',
+    #                       :vlan => "kavlan", :keys => "~/my_ssh_key")
     #
     #
     #     puts "Log in into the nodes using the following hostnames: #{g5k.get_vlan_nodes(job)}"
     #
+    # You should make sure when using custom environments that in the Kadeploy description file, you use an URL to specify the path to the tarball.
+    # Otherwise, you will get the error 'Invalid client's export'.
     # 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.
     # You have to use the method {Cute::G5K::API#deploy deploy} for performing the deploy.
@@ -401,8 +412,8 @@ module Cute
     #     slaves = nodes[1..4]
     #     master = nodes-slaves
     #
-    #     g5k.deploy(job,:nodes => master, :env => 'https://public.lyon.grid5000.fr/~user/debian_master_img.yaml')
-    #     g5k.deploy(job,:nodes => slaves, :env => 'https://public.lyon.grid5000.fr/~user/debian_slaves_img.yaml')
+    #     g5k.deploy(job,:nodes => master, :env => 'http://public.lyon.grid5000.fr/~user/debian_master_img.yaml')
+    #     g5k.deploy(job,:nodes => slaves, :env => 'http://public.lyon.grid5000.fr/~user/debian_slaves_img.yaml')
     #
     #     g5k.wait_for_deploy(job)
     #
@@ -450,6 +461,14 @@ module Cute
     #
     #    [12] pry(main)> $g5k.release(job)
     #    [13] pry(main)> $g5k.release_all("grenoble")
+    # == How to debug
+    #
+    # There are two ways for debugging: (1) by using the option *:debug* when initializing the {Cute::G5K::API#initialize G5K::API} object or
+    # (2) by enabling the RestClient's logging:
+    #
+    #     RESTCLIENT_LOG=stdout cute
+    #     RESTCLIENT_LOG=stdout path/to/my/script
+    #
     class API
 
       # Assigns a logger
@@ -480,6 +499,15 @@ module Cute
       #
       #     g5k = Cute::G5K::API.new(:on_error => :ignore)
       #
+      # To activate debugging mode you can use the option *:debug*:
+      #
+      #     g5k =  Cute::G5K::API.new(:debug => true)
+      #
+      # This will provide you with a *curl* command to try by hand the same request the library is trying to perform.
+      # For example:
+      #
+      #     2016-09-27 11:25:34.039 => CMD debug: curl -kn https://api.grid5000.fr/3.0/sites/nancy/deployments/?user=cruizsanabria
+      #
       # @param [Hash] params Contains initialization parameters.
       # @option params [String] :conf_file Path for configuration file
       # @option params [String] :uri REST API URI to contact
@@ -487,6 +515,7 @@ module Cute
       # @option params [String] :username Username to access the REST API
       # @option params [String] :password Password to access the REST API
       # @option params [Symbol] :on_error Set to :ignore if you want to ignore {Cute::G5K::RequestFailed ResquestFailed} exceptions.
+      # @option params [Boolean] :debug Activate the debug mode
       def initialize(params={})
         config = {}
         default_file = "#{ENV['HOME']}/.grid5000_api.yml"
@@ -504,6 +533,7 @@ module Cute
         @uri = params[:uri] || config["uri"] || "https://api.grid5000.fr/"
         @api_version = params[:version] || config["version"] || "stable"
         @logger = nil
+        @debug = params[:debug] || false
 
         begin
           @g5k_connection = G5KRest.new(@uri,@api_version,@user,@pass,params[:on_error])
@@ -524,7 +554,7 @@ module Cute
       end
 
       # It returns the site name. Example:
-      #    site #=> "rennes"
+      #     site #=> "rennes"
       # This will only work when {Cute::G5K::API G5K::API} is used within Grid'5000.
       # In the other cases it will return *nil*
       # @return [String] the site name where the method is called on
@@ -534,7 +564,15 @@ module Cute
         res[1] unless res.nil?
       end
 
-      # @api private
+      # It returns the RestClient::Resource object which provides you the *get_json* and  *post_json* methods. This enables to perform low level REST requests.
+      # This method is intended to be used along with the {G5K::API#api_uri api_uri} method for generating valid URI.
+      #
+      # = Example:
+      #     require 'cute'
+      #
+      #     g5k = Cute::G5K::API.new()
+      #     g5k.rest.get_json(g5k.api_uri("/sites/grenoble/clusters")
+      #
       # @return the rest point for performing low level REST requests
       def rest
         @g5k_connection
@@ -586,6 +624,7 @@ module Cute
       # @return [Hash] all the status information of a given Grid'5000 site
       # @param site [String] a valid Grid'5000 site name
       def site_status(site)
+        info(debug_cmd(api_uri("sites/#{site}/status"),"GET"), :debug)
         @g5k_connection.get_json(api_uri("sites/#{site}/status"))
       end
 
@@ -642,6 +681,7 @@ module Cute
       # @param site [String] a valid Grid'5000 site name
       # @param uid [String] user name in Grid'5000
       def get_deployments(site, uid = nil)
+        info(debug_cmd(api_uri("sites/#{site}/deployments/?user=#{uid}"),"GET"), :debug)
         @g5k_connection.get_json(api_uri("sites/#{site}/deployments/?user=#{uid}")).items
       end
 
@@ -649,12 +689,14 @@ module Cute
       # @param site [String] a valid Grid'5000 site name
       # @param jid [Fixnum] a valid job identifier
       def get_job(site, jid)
+        info(debug_cmd(api_uri("/sites/#{site}/jobs/#{jid}"),"GET"), :debug)
         @g5k_connection.get_json(api_uri("/sites/#{site}/jobs/#{jid}"))
       end
 
       # @return [Hash] switches information available in a given Grid'5000 site.
       # @param site [String] a valid Grid'5000 site name
       def get_switches(site)
+        info(debug_cmd(api_uri("/sites/#{site}/network_equipments"),"GET"), :debug)
         items = @g5k_connection.get_json(api_uri("/sites/#{site}/network_equipments")).items
         items = items.select { |x| x['kind'] == 'switch' }
         # extract nodes connected to those switches
@@ -688,7 +730,7 @@ module Cute
       #    get_metric("rennes")
       #
       # If you are only interested in the names of the available metrics:
-      #   get_metric("rennes").uids #=> ["cpu_nice", "boottime", "bytes_in", ...]
+      #    get_metric("rennes").uids #=> ["cpu_nice", "boottime", "bytes_in", ...]
       #
       # Then, you can get information about the probes available for a specific metric:
       #    get_metric("rennes",:metric => "network_in")
@@ -708,6 +750,7 @@ module Cute
           params+="?"
           opts[:query].each{ |k,v| params+="#{k}=#{v}&"}
         end
+        info debug_cmd(api_uri("sites/#{site}/metrics#{params}"),"GET"), :debug
         @g5k_connection.get_json(api_uri("sites/#{site}/metrics#{params}")).items
       end
 
@@ -718,7 +761,7 @@ module Cute
       # = Examples
       #    get_my_jobs("nancy", "waiting")
       # Getting several states:
-      #   get_my_jobs("nancy", ["waiting","running"])
+      #    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
@@ -828,15 +871,23 @@ module Cute
       # If walltime is not specified, 1 hour walltime will be assigned to the reservation.
       #
       #     job = g5k.reserve(:site => 'lille', :cluster => 'chirloute', :nodes => 2,
-      #                            :env => 'wheezy-x64-xen', :keys => "~/my_ssh_jobkey",
+      #                            :env => 'wheezy-x64-xen', :keys => "path/to/my_ssh_jobkey",
       #                            :subnets => [22,2])
       #
+      # == Multiple types
+      #
+      # The option *:type* accepts an array for specifying multiple types.
+      # For example, if we want to submit a job deploy and destructive, we will type:
+      #
+      #     job = g5k.reserve(:site => "nancy", :nodes => 1, :walltime => "2:00:00", :type => [:deploy,:destructive])
+      #
       # == Before using OAR hierarchy
       # All non-deploy reservations are submitted by default with the OAR option "-allow_classic_ssh"
       # which does not take advantage of the CPU/core management level.
       # Therefore, in order to take advantage of this capability, SSH keys have to be specified at the moment of reserving resources.
       # This has to be used whenever we perform a reservation with cpu and core hierarchy.
-      # Users are encouraged to create a pair of SSH keys for managing jobs, for instance the following command can be used:
+      # Given that OAR needs access to both keys private and public users are encouraged
+      # to create a pair of SSH keys for managing jobs, for instance the following command can be used:
       #
       #     ssh-keygen -N "" -t rsa -f ~/my_ssh_jobkey
       #
@@ -844,8 +895,11 @@ module Cute
       # You have to specify different keys per reservation if you want several jobs running at the same time in the same site.
       # Example using the OAR hierarchy:
       #
-      #     job = g5k.reserve(:site => "grenoble", :switches => 3, :nodes => 1, :cpus => 1, :cores => 1, :keys => "~/my_ssh_jobkey")
+      #     job = g5k.reserve(:site => "grenoble", :switches => 3, :nodes => 1, :cpus => 1, :cores => 1, :keys => "path/to/my_ssh_jobkey")
       #
+      # Remember that the path passed in the *:keys* parameter corresponds to the path in the Grid'5000 site frontend where you are submitting the job.
+      # This is because OAR needs to access to both keys (private and public) locally.
+      # For deployments the path corresponds to the local path from where the script is being executed (See {Cute::G5K::API#deploy deploy} method).
       # == Using OAR syntax
       #
       # The parameter *:resources* can be used instead of parameters such as: *:cluster*, *:nodes*, *:cpus*, *:walltime*, *:vlan*, *:subnets*, *:properties*, etc,
@@ -879,14 +933,15 @@ 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_ssh
+      # @option opts [Array or Symbol] :type Type of reservation: :deploy, :allow_classic_ssh, [:deploy,:destructive]
       # @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
       # @option opts [String] :queue A specific job queue
       # @option opts [Array]  :subnets 1) prefix_size, 2) number of subnets
       # @option opts [String] :env Environment name for {http://kadeploy3.gforge.inria.fr/ Kadeploy}
-      # @option opts [Symbol] :vlan Vlan type: :routed, :local, :global
+      # @option opts [String] :vlan VLAN type and number: kavlan-local, kavlan, kavlan-topo, etc
+      # @option opts [Numeric] :num_vlan Number of VLANs
       # @option opts [String] :properties OAR properties defined in the cluster
       # @option opts [String] :resources OAR syntax for complex submissions
       # @option opts [String] :reservation Request a job to be scheduled a specific date.
@@ -896,7 +951,7 @@ module Cute
 
         # checking valid options
         valid_opts = [:site, :cluster, :switches, :cpus, :cores, :nodes, :walltime, :cmd,
-                      :type, :name, :subnets, :env, :vlan, :properties, :resources,
+                      :type, :name, :subnets, :env, :vlan, :num_vlan,:properties, :resources,
                       :reservation, :wait, :keys, :queue, :env_user]
         unre_opts = opts.keys - valid_opts
         raise ArgumentError, "Unrecognized option #{unre_opts}" unless unre_opts.empty?
@@ -920,15 +975,18 @@ module Cute
         type = [type] if type.is_a?(Symbol)
         keys = opts[:keys]
         queue = opts[:queue]
+        vlan = opts[:vlan]
+        num_vlan = opts.fetch(:num_vlan, 1)
+
+
+        available_vlans = nil
+        if opts[:vlan]
+          available_vlans = @g5k_connection.get_json(api_uri("sites/#{site}/vlans")).items.map{ |item| item["type"]}.uniq
+          available_vlans.delete("NULL")
+        end
 
-        vlan_opts = {:routed => "kavlan",:global => "kavlan-global",:local => "kavlan-local"}
-        vlan = nil
         unless opts[:vlan].nil?
-          if vlan_opts.include?(opts[:vlan]) then
-            vlan = vlan_opts.fetch(opts[:vlan])
-          else
-            raise ArgumentError, 'Option for vlan not recognized'
-          end
+          raise ArgumentError, "VLAN type not available in site #{site}" unless available_vlans.include?(vlan)
         end
 
         raise 'At least nodes, time and site must be given'  if [nodes, walltime, site].any? { |x| x.nil? }
@@ -950,7 +1008,7 @@ module Cute
             resources = (cluster.is_a?(Fixnum) ? "/cluster=#{cluster}" : "{cluster='#{cluster}'}") + resources
           end
 
-          resources = "{type='#{vlan}'}/vlan=1+" + resources unless vlan.nil?
+          resources = "{type='#{vlan}'}/vlan=#{num_vlan}+" + resources unless vlan.nil?
           resources = "slash_#{subnets[0]}=#{subnets[1]}+" + resources unless subnets.nil?
         end
 
@@ -985,13 +1043,15 @@ module Cute
         begin
           # Support for the option "import-job-key-from-file"
           # The request has to be redirected to the OAR API given that Grid'5000 API
-          # does not support some OAR options.
+          # does not support some OAR options. Bug #7360: https://intranet.grid5000.fr/bugzilla/show_bug.cgi?id=7360
           if payload['import-job-key-from-file'] then
 
             temp = @g5k_connection.post_json(api_uri("sites/#{site}/internal/oarapi/jobs"),payload)
+            info debug_cmd(api_uri("sites/#{site}/internal/oarapi/jobs"),"POST",payload.to_json), :debug
             sleep 1 # This is for being sure that our job appears on the list
             r = get_my_jobs(site,nil).select{ |j| j["uid"] == temp["id"] }.first
           else
+            info debug_cmd(api_uri("sites/#{site}/jobs"),"POST",payload.to_json), :debug
             r = @g5k_connection.post_json(api_uri("sites/#{site}/jobs"),payload)  # This makes reference to the same class
           end
         rescue Error => e
@@ -1004,7 +1064,17 @@ module Cute
         job = @g5k_connection.get_json(r.rel_self)
         job = wait_for_job(job) if opts[:wait] == true
         opts.delete(:nodes) # to not collapse with deploy options
-        deploy(job,opts) unless opts[:env].nil? #type == :deploy
+        opts.delete(:vlan)
+        opts.delete(:num_vlan)
+        if opts[:env]
+          if opts[:vlan]
+            vlan_id = job.resources["vlans"].first
+            deploy(job,opts.merge!({:vlan_id => vlan_id}))
+          else
+            deploy(job,opts) #type == :deploy
+          end
+        end
+
         return job
 
       end
@@ -1020,21 +1090,21 @@ module Cute
       #
       #    require 'cute'
       #
-      #    g5k = Cute::G5K::API.new()
+      #     g5k = Cute::G5K::API.new()
       #
-      #    sites = g5k.site_uids
+      #     sites = g5k.site_uids
       #
-      #    sites.each{ |site|
-      #       job = g5k.reserve(:site => site, :nodes => 5, :wait => false, :walltime => "03:00:00")
-      #       begin
-      #         job = g5k.wait_for_job(job, :wait_time => 60)
-      #         puts "Nodes assigned #{job['assigned_nodes']}"
-      #         break
-      #       rescue  Cute::G5K::EventTimeout
-      #         puts "We waited too long in site #{site} let's release the job and try in another site"
-      #         g5k.release(job)
-      #       end
-      #    }
+      #     sites.each{ |site|
+      #        job = g5k.reserve(:site => site, :nodes => 5, :wait => false, :walltime => "03:00:00")
+      #        begin
+      #          job = g5k.wait_for_job(job, :wait_time => 60)
+      #          puts "Nodes assigned #{job['assigned_nodes']}"
+      #          break
+      #        rescue  Cute::G5K::EventTimeout
+      #          puts "We waited too long in site #{site} let's release the job and try in another site"
+      #          g5k.release(job)
+      #        end
+      #     }
       #
       # @param job [G5KJSON] as described in {Cute::G5K::G5KJSON job}
       # @param [Hash] opts Options
@@ -1097,7 +1167,7 @@ module Cute
 
         # checking valid options, same as reserve option even though some option dont make any sense
         valid_opts = [:site, :cluster, :switches, :cpus, :cores, :nodes, :walltime, :cmd,
-                      :type, :name, :subnets, :env, :vlan, :properties, :resources,
+                      :type, :name, :subnets, :env, :vlan_id, :properties, :resources,
                       :reservation, :wait, :keys, :queue, :env_user]
 
         unre_opts = opts.keys - valid_opts
@@ -1136,17 +1206,14 @@ module Cute
                    'key' => public_key_file,
                   }
 
-        if !job.resources["vlans"].nil?
-          vlan = job.resources["vlans"].first
-          payload['vlan'] = vlan
-          info "Found VLAN with uid = #{vlan}"
-        end
+        payload['vlan'] = opts[:vlan_id] if opts[:vlan_id]
 
         payload['user'] = opts[:env_user] unless opts[:env_user].nil?
 
         info "Creating deployment"
 
         begin
+          info debug_cmd(api_uri("sites/#{site}/deployments"),"POST",payload.to_json), :debug
           r = @g5k_connection.post_json(api_uri("sites/#{site}/deployments"), payload)
         rescue Error => e
           info "Fail to deploy"
@@ -1171,7 +1238,7 @@ module Cute
       #
       # = Example
       #
-      #   deploy_status(job, :nodes => ["adonis-10.grenoble.grid5000.fr"], :status => "terminated")
+      #    deploy_status(job, :nodes => ["adonis-10.grenoble.grid5000.fr"], :status => "terminated")
       #
       # @return [Array] status of deploys within a job
       # @param job [G5KJSON] as described in {Cute::G5K::G5KJSON job}
@@ -1261,24 +1328,41 @@ module Cute
         deploy_info["result"].select{ |p,v|  v["state"] == "KO"}.keys
       end
 
+      # Returns a valid  URI using the current G5K API version.
+      # @return [String] valid URI
+      def api_uri(path)
+        path = path[1..-1] if path.start_with?('/')
+        return "#{@api_version}/#{path}"
+      end
+
       private
       # Handles the output of messages within the module
       # @param msg [String] message to show
-      def info(msg)
+      def info(msg,mode =nil)
+
+        return if mode == :debug and not @debug
+
         if @logger.nil? then
           t = Time.now
           s = t.strftime('%Y-%m-%d %H:%M:%S.%L')
           puts "#{s} => #{msg}"
         else
-          @logger.info(msg)
+          if mode == :debug
+            @logger.debug(msg)
+          else
+            @logger.info(msg)
+          end
         end
+
       end
 
-      # @return a valid Grid'5000 resource
-      # it avoids "//"
-      def api_uri(path)
-        path = path[1..-1] if path.start_with?('/')
-        return "#{@api_version}/#{path}"
+      # @return a string containing the command line equivalent for debugging purposes
+      def debug_cmd(path,method,payload=nil)
+        if method == "GET"
+          return "CMD debug: curl -kn #{@uri}#{path}"
+        else
+          return "CMD debug: curl -kni #{@uri}#{path} -X POST -H'Content-Type: application/json' -d '#{payload}'"
+        end
       end
 
     end

data/lib/cute/version.rb

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

data/spec/g5k_api_spec.rb

@@ -3,7 +3,11 @@ require 'spec_helper'
 # Real tests can be activated by setting the shell variable TEST_REAL
 describe Cute::G5K::API do
 
-  subject { g5k = ENV['TEST_REAL'].nil?? Cute::G5K::API.new(:user => "test") : Cute::G5K::API.new() }
+  if ENV['TEST_REAL']
+    subject { g5k = ENV['DEBUG'].nil?? Cute::G5K::API.new() : Cute::G5K::API.new(:debug => true) }
+  else
+    subject { g5k = ENV['DEBUG'].nil?? Cute::G5K::API.new(:user => "test") : Cute::G5K::API.new(:user => "test",:debug => true) }
+  end
 
   let(:sites) { subject.site_uids}
 
@@ -99,7 +103,7 @@ describe Cute::G5K::API do
   end
 
   it "raises error vlan" do
-    expect {subject.reserve(:site => @rand_site, :vlan => :nonsense)}.to raise_error(ArgumentError,'Option for vlan not recognized')
+    expect {subject.reserve(:site => @rand_site, :vlan => :nonsense)}.to raise_error(ArgumentError,"VLAN type not available in site #{@rand_site}")
   end
 
 
@@ -117,7 +121,7 @@ describe Cute::G5K::API do
 
 
   it "reserves with vlan and get vlan hostnames" do
-    job = subject.reserve(:site => @rand_site, :nodes => 1, :type => :deploy, :vlan => :routed)
+    job = subject.reserve(:site => @rand_site, :nodes => 1, :type => :deploy, :vlan => "kvlan")
     expect(subject.get_vlan_nodes(job)).to be_an_instance_of(Array)
     subject.release(job)
   end

data/spec/spec_helper.rb

@@ -55,6 +55,11 @@ RSpec.configure do |config|
     stub_request(:any,/^https:\/\/.*\:.*@api.grid5000.fr\/...\/sites\/non-found\/.*/).
       to_return(:status => 404)
 
+    stub_request(:get,/^https:\/\/.*\:.*@api.grid5000.fr\/...\/sites\/.*vlans$/).
+      to_return(:status => 200, :body => {'total' => 3, 'items' => [{'type' => "kavlan-local"},{'type' => "kvlan"}]}.to_json)
+
+      # to_return(:status => 200, :body => {:total => 3, :items => [{:type => "kavlan-local"},{:type => "kavlan"}]})
+
     stub_request(:post, /^https:\/\/.*\:.*@api.grid5000.fr\/.*/).
       with(:body => hash_including("resources" => "/slash_22=1+{nonsense},walltime=01:00")).
       to_return(:status => 400, :body => "Oarsub failed: please verify your request syntax")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-cute
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.6'
 platform: ruby
 authors:
 - Algorille team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-03 00:00:00.000000000 Z
+date: 2016-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler