vagrant-grid5000 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 613f9417d67cd5678dea8bd2ccfb3614a77074b4
-  data.tar.gz: 24d2c93783aa39a57b5b2156143b3969116f40a8
+  metadata.gz: 049b3239e51d78bc2e7278a79807d4dfa83347fa
+  data.tar.gz: 6f46fa07a915340c8875fe652f5d277afaedbf7d
 SHA512:
-  metadata.gz: cc15abf4ef72d1bdc9f45a43395192884101c0fb6575fe1fc2fd5e1b1403cba75a4dd752509d3333424a9e35bee261e56b329534843afe76b9ff6fab1b613240
-  data.tar.gz: f15092b80f70ef5553fb3c28b99555503bb6eb991624c4ab0145f5e962304262054fb75f40ceaad8669f3e543fc438913a6de95443db0bac19ec57b5e31ecefa
+  metadata.gz: f5923379e403ca03bf5ab71099a0770a8909d5d056c3c5bb41fe61da8040a37747c4af3145c72aaa5e6bf32efd8dbf2b3a16501377489a1eb0f813a54fd3700a
+  data.tar.gz: 3ae45922886bc50362a8acd708c3398cec35d7da6a3a307622a2ef124776df333e5b5f9904491dfcfff025971f809c589921fcac6859f95542f507e2792d2173

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/README.md

@@ -10,19 +10,7 @@ This is a [Vagrant](http://www.vagrantup.com) plugin that adds a provider for
 machines running on the [Grid'5000](https://www.grid5000.fr) testbed to
 Vagrant.
 
-This is still at an early state of development.
-
-## What works
-* vagrant up --provider=grid5000
-* vagrant status
-* vagrant ssh
-* vagrant destroy
-
-## What doesn't work
-
-* everything else
-
-## Installation
+## Installation and usage
 
 ```
 $ vagrant plugin install vagrant-grid5000
@@ -33,16 +21,16 @@ Each provider needs at least one ''box''. This does not really make sense here,
 $ vagrant box add --name dummy https://github.com/lnussbaum/vagrant-grid5000/raw/master/dummy.box
 ```
 
-Example Vagrantfile:
+Example basic Vagrantfile:
 ```ruby
 Vagrant.configure("2") do |config|
 
-  # Global configuration for Grid'5000 access
+  # Global configuration for Grid'5000
   config.vm.provider "grid5000" do |g5k|
-    # cute_parameters = { :conf_file =>"config file path" }
+    # Ruby-Cute's authentication parameters
+    #g5k.cute_parameters = { :conf_file => "config file path" }
     # For details about allowed parameters see
     # https://github.com/lnussbaum/vagrant-grid5000/blob/master/lib/vagrant-grid5000/config.rb
-
   end
 
   config.vm.define :my_g5k_box do |g5k|
@@ -51,6 +39,24 @@ Vagrant.configure("2") do |config|
 end
 ```
 
+Then try
+```
+$ vagrant up --provider=grid5000
+$ vagrant ssh
+$ vagrant provision
+$ vagrant destroy
+```
+
+For more details about Vagrantfile configuration parameters, see
+https://github.com/lnussbaum/vagrant-grid5000/blob/master/Vagrantfile
+
+### Synced folders
+
+Synced folders are a bit tricky. You need to install 'rsync' (which is not
+installed on jessie-x64-min), and then issue a ''vagrant reload'' to reload the
+configuration. Note that you can also use 'rsync-auto' to auto-synchronize
+changes.
+
 ## License
 
 The gem is available as free software under the terms of the [MIT License](http://opensource.org/licenses/MIT).
@@ -71,3 +77,5 @@ execute Vagrant.
 $ bundle exec vagrant up --provider=grid5000
 ```
 etc.
+
+To debug stuff, use vagrant --debug.

data/Vagrantfile

@@ -3,13 +3,65 @@
 
 Vagrant.configure("2") do |config|
 
-  # Global configuration for Grid'5000 access
+  # Global parameters for the Grid'5000 provider
   config.vm.provider "grid5000" do |g5k|
-    # cute_parameters = { :conf_file =>"config file path" }
+    
+    # Grid'5000 authentification parameters for Ruby-Cute
+    # see http://www.rubydoc.info/github/ruby-cute/ruby-cute/master/Cute%2FG5K%2FAPI%3Ainitialize
+    # default: use ~/.grid5000_api.yml
+    #g5k.cute_parameters = { :username => 'jdoe', :password => 'foo' }
+    
+    # Site to reserve on (default: nancy)
+    #g5k.site = rennes
+    
+    # OAR queue to use (default: default)
+    #g5k.queue = 'default'
 
+    # OAR properties to use (default: none)
+    #g5k.properties = "cluster='griffon'"
+    
+    # Walltime (default: reserve until the next end of day (18:55))
+    #g5k.walltime = '02:30'
+
+    # Environment to deploy (default: jessie-x64-min)
+    #g5k.env = 'jessie-x64-base'
   end
 
-  config.vm.define :my_g5k_box do |g5k|
-    g5k.vm.box = "dummy"
+  config.vm.define :testbox do |tb|
+    # All providers need to provide a box. This is a dummy, empty box for the grid5000 provider.
+    tb.vm.box = "dummy"
+
+    # VM-specific overrides
+    tb.vm.provider 'grid5000' do |g5k|
+      g5k.site = 'rennes'
+      g5k.walltime = '0:15'
+    end
   end
+
+  config.vm.define :testbox2 do |tb2|
+    tb2.vm.box = "dummy"
+
+    # VM-specific overrides
+    tb2.vm.provider 'grid5000' do |g5k|
+      g5k.site = 'lyon'
+      g5k.walltime = '0:15'
+    end
+
+    # Synced folders configuration, using rsync (you need to install it if you use -min or -base, see below)
+    tb2.vm.synced_folder ".", "/vagrant", type: "rsync", rsync__exclude: ".git/"
+  end
+
+  # Since we connect as root directly, we don't need to set 'privileged' to true
+  # However, it is a good idea to install sudo so that normal provisioning scripts
+  # work.
+  # rsync is needed for synced folders.
+  config.vm.provision "shell", privileged: false, inline: 'apt-get update && apt-get -y install sudo rsync'
+
+  # privileged: false is no longer required
+  config.vm.provision "shell", inline: <<-SHELL
+    #!/bin/bash -x
+    apt-get -y install less vim ruby
+    apt-get -y install git pv
+  SHELL
+
 end

data/lib/vagrant-grid5000/action.rb

@@ -9,50 +9,111 @@ module VagrantPlugins
       # Include the built-in modules so we can use them as top-level things.
       include Vagrant::Action::Builtin
 
-      def self.action_up
+      # TODO def self.action_halt
+
+      def self.action_destroy
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use Call, DestroyConfirm do |env, b2|
+            if env[:result]
+              b2.use ConfigValidate
+              b2.use Call, IsCreated do |env2, b3|
+                if !env2[:result]
+                  b3.use MessageNotCreated
+                  next
+                end
+                b3.use ConnectGrid5000
+                b3.use ReadState
+                b3.use DestroyInstance
+              end
+            end
+          end
+        end
+      end
+
+      # This action is called when `vagrant provision` is called.
+      def self.action_provision
         Vagrant::Action::Builder.new.tap do |b|
           b.use ConfigValidate
-          b.use ConnectGrid5000
-          b.use ReserveAndDeploy
+          b.use Call, IsCreated do |env, b2|
+            if !env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+            b2.use Provision
+          end
         end
       end
 
-      def self.action_ssh
+      # This action is called to read the state of the machine. The
+      # resulting state is expected to be put into the `:machine_state_id`
+      # key.
+      def self.action_read_state
         Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
           b.use ConnectGrid5000
           b.use ReadState
-          b.use SSHExec
+        end
+      end
+
+      def self.action_ssh
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            if !env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+            b2.use ConnectGrid5000
+            b2.use ReadState
+            b2.use SSHExec
+          end
         end
       end
 
       def self.action_ssh_run
-        return Vagrant::Action::Builder.new.tap do |b|
-          b.use ConnectGrid5000
-          b.use ReadState
-          b.use SSHRun
+        Vagrant::Action::Builder.new.tap do |b|
+          b.use ConfigValidate
+          b.use Call, IsCreated do |env, b2|
+            if !env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+            b2.use ConnectGrid5000
+            b2.use ReadState
+            b2.use SSHRun
+          end
         end
       end
 
-      def self.action_destroy
+      def self.action_up
         Vagrant::Action::Builder.new.tap do |b|
+          b.use HandleBox
+          b.use ConfigValidate
+          b.use BoxCheckOutdated
           b.use ConnectGrid5000
-          b.use ReadState
-          b.use Call, DestroyConfirm do |env, b2|
-            if env[:result]
-							b2.use DestroyInstance
+          b.use Call, IsCreated do |env1, b1|
+            if env1[:result]
+              b1.use MessageAlreadyCreated # TODO write a better message
+            else
+              b1.use ReserveAndDeploy
             end
           end
         end
       end
 
-      # This action is called to read the state of the machine. The
-      # resulting state is expected to be put into the `:machine_state_id`
-      # key.
-      def self.action_read_state
+      def self.action_reload
         Vagrant::Action::Builder.new.tap do |b|
           b.use ConfigValidate
           b.use ConnectGrid5000
-          b.use ReadState
+          b.use Call, IsCreated do |env, b2|
+            if !env[:result]
+              b2.use MessageNotCreated
+              next
+            end
+
+            # We do almost nothing during reload
+            b2.use SyncedFolders
+          end
         end
       end
 
@@ -62,6 +123,9 @@ module VagrantPlugins
       autoload :ReadState, action_root.join("read_state")
       autoload :ConnectGrid5000, action_root.join("connect_grid5000")
       autoload :DestroyInstance, action_root.join("destroy_instance")
+      autoload :IsCreated, action_root.join("is_created")
+      autoload :MessageAlreadyCreated, action_root.join("message_already_created")
+      autoload :MessageNotCreated, action_root.join("message_not_created")
     end
   end
 end

data/lib/vagrant-grid5000/action/connect_grid5000.rb

@@ -1,5 +1,7 @@
 require "log4r"
 
+$last_check_time = nil
+
 module VagrantPlugins
   module Grid5000
     module Action
@@ -13,8 +15,13 @@ module VagrantPlugins
 
         def call(env)
           env[:g5k] = Cute::G5K::API.new(env[:machine].provider_config.cute_parameters || {})
-          # FIXME customize logger to make it clear that ruby-cute is the one displaying messages
-          raise "Unable to retrieve the list of sites and find nancy in it" if not env[:g5k].site_uids.include?('nancy')
+          env[:g5k].logger = Logger.new(STDOUT)
+          env[:g5k].logger.progname = 'ruby-cute'
+          env[:g5k].logger.datetime_format = "%Y-%m-%d %H:%M:%S "
+          if $last_check_time.nil? or $last_check_time + 60 < Time::now
+            raise "Unable to retrieve the list of sites and find nancy in it" if not env[:g5k].site_uids.include?('nancy')
+            $last_check_time = Time::now
+          end
           @app.call(env)
         end
       end

data/lib/vagrant-grid5000/action/is_created.rb

@@ -0,0 +1,18 @@
+module VagrantPlugins
+  module Grid5000
+    module Action
+      # This can be used with "Call" built-in to check if the machine
+      # is created and branch in the middleware.
+      class IsCreated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:result] = env[:machine].state.id != :not_created
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-grid5000/action/message_already_created.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module Grid5000
+    module Action
+      class MessageAlreadyCreated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info('Machine already created.')
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-grid5000/action/message_not_created.rb

@@ -0,0 +1,16 @@
+module VagrantPlugins
+  module Grid5000
+    module Action
+      class MessageNotCreated
+        def initialize(app, env)
+          @app = app
+        end
+
+        def call(env)
+          env[:ui].info('Machine not created.')
+          @app.call(env)
+        end
+      end
+    end
+  end
+end

data/lib/vagrant-grid5000/action/read_state.rb

@@ -1,5 +1,8 @@
 require "log4r"
 
+$job_cache_data = {}
+$job_cache_time = {}
+
 module VagrantPlugins
   module Grid5000
     module Action
@@ -18,19 +21,19 @@ module VagrantPlugins
           @app.call(env)
         end
 
-        $last_state_read = nil
         def read_state(env)
-          
 					return :not_created if not env[:g5k] or not env[:machine]
           id = env[:machine].id
           return :not_created if id.nil?
           site, jobid, node = id.split(':')
 
-          if $last_state_read != nil and env[:job] and Time::now < $last_state_read + 60
-            # skip
+          # Very basic caching
+          if $job_cache_time.has_key?([site, jobid]) and $job_cache_time[[site, jobid]] + 60 > Time::now
+            env[:job] = $job_cache_data[[site, jobid]]
           else
 						env[:job] = env[:g5k].get_job(site, jobid)
-            $last_state_read = Time::now
+            $job_cache_data[[site, jobid]] = env[:job]
+            $job_cache_time[[site, jobid]] = Time::now
           end
 					env[:machine_ssh_info] = { :host => node, :port => 22, :username => 'root', :proxy_command => "ssh -W #{node}:22 #{env[:g5k].g5k_user}@access.grid5000.fr" }
           return :running if env[:job]['state'] == 'running'

data/lib/vagrant-grid5000/action/reserve_and_deploy.rb

@@ -1,5 +1,10 @@
 require "log4r"
 require 'time'
+require 'fileutils'
+
+VAGRANT_INSECURE_PUBLIC_KEY = <<EOF
+ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEA6NF8iallvQVp22WDkTkyrtvp9eWW6A8YVr+kz4TjGYe7gHzIw+niNltGEFHzD8+v1I2YJ6oXevct1YeS0o9HZyN1Q9qgCgzUFtdOKLv6IedplqoPkcmF0aYet2PkEDo3MlTBckFXPITAMzF8dJSIFo9D8HfdOV0IAdx4O7PtixWKn5y2hMNG0zQPyUecp4pzC6kivAIhyfHilFR61RGL+GPXQ2MWZWFYbAGjyiYJnAmCP3NOTd0jMZEnDkbUvxhMmBYSdETk1rRgm+R4LOzFUGaHqHDLKLX+FIPKcF96hrucXzcWyLbIbEgE98OHlnVYCzRdK8jlqm8tehUc9c9WhQ== vagrant insecure public key
+EOF
 
 module VagrantPlugins
   module Grid5000
@@ -14,24 +19,29 @@ module VagrantPlugins
           cfg = env[:machine].provider_config
           walltime = cfg.walltime
           if walltime.nil? # slightly broken: what if the local time doesn't switch DST at the same time as Europe/Paris?
-             if Time::now.dst?
-               target = '18:55:00 CEST'
-             else
-               target = '18:55:00 CET'
-             end
-             walltime = (Time::parse(target) - Time::now).to_i
-             walltime = format("%02d:%02d:%02d", walltime / (60*60), walltime / 60 % 60, walltime % 60)
+            if Time::now.dst?
+              target = '18:55:00 CEST'
+            else
+              target = '18:55:00 CET'
+            end
+            walltime = (Time::parse(target) - Time::now).to_i
+            walltime += 86400 if walltime < 0 # if we are after the deadline, target the next day
+            walltime = format("%02d:%02d:%02d", walltime / (60*60), walltime / 60 % 60, walltime % 60)
           end
           if ENV['VAGRANT_DEBUG'] == 'REUSE_JOB'
-						job = env[:g5k].get_my_jobs(cfg.site).first
+            job = env[:g5k].get_my_jobs(cfg.site).first
           else
-            job = env[:g5k].reserve(:site => cfg.site, :walltime => walltime,
-                                          :properties => cfg.properties, :env => cfg.env, :keys => cfg.keys,
-                                          :name => "vagrant-grid5000")
+            # hack: create a temporary file that holds the Vagrant public key, so that ruby-cute is happy.
+            f = `mktemp /tmp/vagrant-grid5000-public-key.XXXXXX.pub`.chomp
+            File::open(f, 'w') { |fd| fd.print VAGRANT_INSECURE_PUBLIC_KEY }
+            params = { :site => cfg.site, :walltime => walltime, :properties => cfg.properties, :queue => cfg.queue, :env => cfg.env, :keys => f.gsub('.pub', ''), :name => "vagrant-g5k" }
+            env[:ui].info("Initiating reservation and deployment with #{params.inspect}")
+            job = env[:g5k].reserve(params)
+            FileUtils::rm(f)
           end
           env[:node] = job['assigned_nodes'].first
           env[:machine_state_id] = :running
-          @logger.info("Node #{env[:node]} successfully started.")
+          env[:ui].info("Node #{env[:node]} successfully started.")
           env[:job] = job
           env[:machine].id = "#{cfg.site}:#{job['uid']}:#{env[:node]}"
           @app.call(env)

data/lib/vagrant-grid5000/config.rb

@@ -20,6 +20,10 @@ module VagrantPlugins
       # @return [String]
       attr_accessor :properties
 
+      # OAR queue to use when reserving resources. (default: 'default'; other values: production, besteffort)
+      # @return [String]
+      attr_accessor :queue
+
       # Walltime to use when reserving resources. (default: reserve resources until today at 6:55pm)
       # @return [String]
       attr_accessor :walltime
@@ -29,18 +33,12 @@ module VagrantPlugins
       # @return [String]
       attr_accessor :env
 
-      # SSH keys to copy to the deployed machine. (default: use Ruby-Cute's default, which is to copy
-      # the public keys found in ~/.ssh/
-      # @return [String]
-      attr_accessor :keys
-
-
       def initialize()
         @cute_parameters = UNSET_VALUE
         @env = UNSET_VALUE
         @site = UNSET_VALUE
-        @keys = UNSET_VALUE
         @properties = UNSET_VALUE
+        @queue = UNSET_VALUE
         @walltime = UNSET_VALUE
       end
 
@@ -48,8 +46,8 @@ module VagrantPlugins
         @cute_parameters = nil if @cute_parameters == UNSET_VALUE
         @site = 'nancy' if @site == UNSET_VALUE
         @env = 'jessie-x64-min' if @env == UNSET_VALUE
-        @keys = nil if @keys == UNSET_VALUE
         @properties = '' if @properties == UNSET_VALUE
+        @queue = 'default' if @queue == UNSET_VALUE
         @walltime = nil if @walltime == UNSET_VALUE
       end
 

data/lib/vagrant-grid5000/version.rb

@@ -1,5 +1,5 @@
 module VagrantPlugins
   module Grid5000
-    VERSION = "0.0.3"
+    VERSION = "0.1.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vagrant-grid5000
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Lucas Nussbaum
@@ -59,6 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -74,6 +75,9 @@ files:
 - lib/vagrant-grid5000/action.rb
 - lib/vagrant-grid5000/action/connect_grid5000.rb
 - lib/vagrant-grid5000/action/destroy_instance.rb
+- lib/vagrant-grid5000/action/is_created.rb
+- lib/vagrant-grid5000/action/message_already_created.rb
+- lib/vagrant-grid5000/action/message_not_created.rb
 - lib/vagrant-grid5000/action/read_state.rb
 - lib/vagrant-grid5000/action/reserve_and_deploy.rb
 - lib/vagrant-grid5000/config.rb