gosen 0.1.0 → 0.1.1

data/README.html

@@ -0,0 +1,64 @@
+<h1>Gosen</h1>
+
+<p>Gosen is a Ruby library for the <a href="https://api.grid5000.fr/">Grid'5000 RESTful API</a>.
+It relies on the <a href="http://github.com/crohr/restfully">Restfully library</a> for interacting with the API.</p>
+
+<h2>Features</h2>
+
+<p>Currently, it allows to submit deployments that retry automatically when too many nodes failed, similarly to <a href="http://www.loria.fr/~lnussbau/katapult.html">Katapult</a>.</p>
+
+<h2>Installation</h2>
+
+<pre><code>$ gem install gosen
+</code></pre>
+
+<h2>Usage</h2>
+
+<p>The following example deploys the latest version of the Lenny-x64-big environment on the paramount-1 and paramount-2 nodes.
+If both nodes are not successfully deployed, Gosen retries again (in this case, at most 5 deployment are submitted).</p>
+
+<pre><code>#!/usr/bin/env ruby
+
+require 'gosen'
+require 'logger'
+require 'restfully'
+
+logger = Logger.new(STDOUT)
+
+Restfully::Session.new(:configuration_file =&gt; '~/.grid5000') do |grid, session|
+  site = grid.sites[:rennes]
+  nodes = [ 'paramount-1.rennes.grid5000.fr', 'paramount-2.rennes.grid5000.fr' ]
+  deployment = Gosen::Deployment.new(site, 'lenny-x64-big', nodes,
+  {
+    :logger =&gt; logger,
+    :max_deploy_runs =&gt; 5,
+    :min_deployed_nodes =&gt; nodes.length,
+    :ssh_public_key =&gt; File.read(File.expand_path('~/.ssh/authorized_keys'))
+  })
+  deployment.join
+end
+</code></pre>
+
+<p>The logger allows to print information about the deployment, in a style similar to Katapult:</p>
+
+<pre><code>I, [2010-04-21T11:31:09.351803 #21673]  INFO -- : Kadeploy run 1 with 2 nodes (0 already deployed, need 2 more)
+I, [2010-04-21T11:37:11.817323 #21673]  INFO -- : Nodes deployed: paramount-1.rennes.grid5000.fr paramount-2.rennes.grid5000.fr
+I, [2010-04-21T11:37:11.817440 #21673]  INFO -- : Had to run 1 kadeploy runs, deployed 2 nodes
+</code></pre>
+
+<h2>Note on Patches/Pull Requests</h2>
+
+<ul>
+<li>Fork the project.</li>
+<li>Make your feature addition or bug fix.</li>
+<li>Add tests for it. This is important so I don't break it in a
+future version unintentionally.</li>
+<li>Commit, do not mess with rakefile, version, or history.
+(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)</li>
+<li>Send me a pull request. Bonus points for topic branches.</li>
+</ul>
+
+
+<h2>Copyright</h2>
+
+<p>Copyright (c) 2010 Pierre Riteau. See LICENSE for details.</p>

data/README.md

@@ -1,6 +1,47 @@
 # Gosen
 
 Gosen is a Ruby library for the [Grid'5000 RESTful API](https://api.grid5000.fr/).
+It relies on the [Restfully library](http://github.com/crohr/restfully) for interacting with the API.
+
+## Features
+
+Currently, it allows to submit deployments that retry automatically when too many nodes failed, similarly to [Katapult](http://www.loria.fr/~lnussbau/katapult.html).
+
+## Installation
+
+    $ gem install gosen
+
+## Usage
+
+The following example deploys the latest version of the Lenny-x64-big environment on the paramount-1 and paramount-2 nodes.
+If both nodes are not successfully deployed, Gosen retries again (in this case, at most 5 deployment are submitted).
+
+    #!/usr/bin/env ruby
+
+    require 'gosen'
+    require 'logger'
+    require 'restfully'
+
+    logger = Logger.new(STDOUT)
+
+    Restfully::Session.new(:base_uri => 'https://api.grid5000.fr/2.0/grid5000') do |grid, session|
+      site = grid.sites[:rennes]
+      nodes = [ 'paramount-1.rennes.grid5000.fr', 'paramount-2.rennes.grid5000.fr' ]
+      deployment = Gosen::Deployment.new(site, 'lenny-x64-big', nodes,
+      {
+        :logger => logger,
+        :max_deploy_runs => 5,
+        :min_deployed_nodes => nodes.length,
+        :ssh_public_key => File.read(File.expand_path('~/.ssh/authorized_keys'))
+      })
+      deployment.join
+    end
+
+The logger allows to print information about the deployment, in a style similar to Katapult:
+
+    I, [2010-04-21T11:31:09.351803 #21673]  INFO -- : Kadeploy run 1 with 2 nodes (0 already deployed, need 2 more)
+    I, [2010-04-21T11:37:11.817323 #21673]  INFO -- : Nodes deployed: paramount-1.rennes.grid5000.fr paramount-2.rennes.grid5000.fr
+    I, [2010-04-21T11:37:11.817440 #21673]  INFO -- : Had to run 1 kadeploy runs, deployed 2 nodes
 
 ## Note on Patches/Pull Requests
 

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/lib/gosen/deployment.rb

@@ -30,8 +30,10 @@ module Gosen
       raise Gosen::Error if @max_deploy_runs < 1
 
       if options[:ssh_public_key]
-        @api_options[:key] = @ssh_public_key = options[:ssh_public_key]
+        @ssh_public_key = options[:ssh_public_key]
       end
+
+      @api_options = options
     end
 
     def good_nodes
@@ -46,7 +48,7 @@ module Gosen
 
     def join
       @max_deploy_runs.times do |i|
-        @deployment_resource = Gosen::DeploymentRun.new(@site, @environment, @bad_nodes)
+        @deployment_resource = Gosen::DeploymentRun.new(@site, @environment, @bad_nodes, @api_options)
         @logger.info("Kadeploy run #{i + 1} with #{@bad_nodes.length} nodes (#{@good_nodes.length} already deployed, need #{@min_deployed_nodes - @good_nodes.length} more)")
         @deployment_resource.wait_for_completion
         @deployment_resource.update_nodes

data/test/gosen/test_deployment.rb

@@ -153,6 +153,7 @@ class TestDeployment < Test::Unit::TestCase
       end
 
       should 'submit new deployment runs when needed' do
+        @ssh_public_key = 'ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAvwM1XBJCIMtAyQlweE7BVRtvgyKdwGTeYCI4AFlsTtti4y0Ipe5Hsygx3p7S0BHFiJsVZWDANMRwZ4tcjp8YnjnMkG2yp1jB1qgUf34t/MmEQL0KkoOk8tIIb28o7nTFYKO15mXJm9yBVS1JY8ozEfnA7s5hkrdnvM6h9Jv6VScp8C1XTKmpEy3sWOeUlmCkYftYSr1fLM/7qk9S2TnljA/CGiK9dq2mhJMjnDtulVrdpc1hbh+0oCzL6m2BfXX3v4q1ORml8o04oFeEYDN5qzZneL+FzK+YfJIidvsjZ9ziVTv+7Oy5ms4wvoKiUGNapP0v/meXXBU1KvFRof3VZQ== priteau@parallelogram.local'
         @deployment_resource1 = mock()
         @deployment_resource2 = mock()
         @deployment_resource1.stubs(:reload)
@@ -170,8 +171,8 @@ class TestDeployment < Test::Unit::TestCase
         @deployment_resource1.expects(:[]).with('result').returns(@deployment_result1)
         @deployment_resource2.expects(:[]).with('result').returns(@deployment_result2)
         @min_deployed_nodes = 2
-        @site_deployments.expects(:submit).with({ :environment => @environment, :nodes => @nodes }).returns(@deployment_resource1)
-        @site_deployments.expects(:submit).with({ :environment => @environment, :nodes => [ 'paramount-2.rennes.grid5000.fr'] }).returns(@deployment_resource2)
+        @site_deployments.expects(:submit).with({ :environment => @environment, :nodes => @nodes, :key => @ssh_public_key }).returns(@deployment_resource1)
+        @site_deployments.expects(:submit).with({ :environment => @environment, :nodes => [ 'paramount-2.rennes.grid5000.fr'], :key => @ssh_public_key }).returns(@deployment_resource2)
         @logger.expects(:info).with("Kadeploy run 1 with 2 nodes (0 already deployed, need 2 more)")
         @logger.expects(:info).with("Nodes deployed: paramount-1.rennes.grid5000.fr")
         @logger.expects(:info).with("Nodes which failed: paramount-2.rennes.grid5000.fr")
@@ -179,7 +180,7 @@ class TestDeployment < Test::Unit::TestCase
         @logger.expects(:info).with("Nodes deployed: paramount-2.rennes.grid5000.fr")
         @logger.expects(:info).with("Had to run 2 kadeploy runs, deployed 2 nodes")
 
-        @deployment = Gosen::Deployment.new(@site, @environment, @nodes, { :logger => @logger, :min_deployed_nodes => @min_deployed_nodes, :max_deploy_runs => 2 })
+        @deployment = Gosen::Deployment.new(@site, @environment, @nodes, { :logger => @logger, :min_deployed_nodes => @min_deployed_nodes, :max_deploy_runs => 2, :ssh_public_key => @ssh_public_key })
         @deployment.join
         assert_equal(@nodes, @deployment.good_nodes)
         assert_equal([], @deployment.bad_nodes)

data/test/gosen/test_deployment_run.rb

@@ -58,6 +58,7 @@ class TestDeploymentRun < Test::Unit::TestCase
 
   context 'A deployment run instance' do
     setup do
+      @ssh_public_key = 'ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAvwM1XBJCIMtAyQlweE7BVRtvgyKdwGTeYCI4AFlsTtti4y0Ipe5Hsygx3p7S0BHFiJsVZWDANMRwZ4tcjp8YnjnMkG2yp1jB1qgUf34t/MmEQL0KkoOk8tIIb28o7nTFYKO15mXJm9yBVS1JY8ozEfnA7s5hkrdnvM6h9Jv6VScp8C1XTKmpEy3sWOeUlmCkYftYSr1fLM/7qk9S2TnljA/CGiK9dq2mhJMjnDtulVrdpc1hbh+0oCzL6m2BfXX3v4q1ORml8o04oFeEYDN5qzZneL+FzK+YfJIidvsjZ9ziVTv+7Oy5ms4wvoKiUGNapP0v/meXXBU1KvFRof3VZQ== priteau@parallelogram.local'
       @result = {
         'paramount-1.rennes.grid5000.fr' => {
           'last_cmd_stderr' => '',
@@ -72,12 +73,12 @@ class TestDeploymentRun < Test::Unit::TestCase
       @resource.expects(:reload).twice
       Kernel.expects(:sleep).with(Gosen::DeploymentRun::POLLING_TIME).twice
 
-      @deployments = mock()
-      @deployments.expects(:submit).returns(@resource)
-      @site = stub(:deployments => @deployments)
       @environment = 'lenny-x64-base'
       @nodes = [ 'paramount-1.rennes.grid5000.fr' ]
-      @deployment = Gosen::DeploymentRun.new(@site, @environment, @nodes)
+      @deployments = mock()
+      @deployments.expects(:submit).with({ :environment => @environment, :nodes => @nodes, :key => @ssh_public_key}).returns(@resource)
+      @site = stub(:deployments => @deployments)
+      @deployment = Gosen::DeploymentRun.new(@site, @environment, @nodes, { :ssh_public_key => @ssh_public_key })
     end
 
     should 'wait for deployment completion and give access to the results' do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Pierre Riteau
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-02 00:00:00 +02:00
+date: 2010-04-22 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -79,6 +79,7 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
+- README.html
 - README.md
 files: 
 - .document
@@ -95,6 +96,7 @@ files:
 - test/gosen/test_deployment_run.rb
 - test/helper.rb
 - test/test_gosen.rb
+- README.html
 has_rdoc: true
 homepage: http://github.com/priteau/gosen
 licenses: []