silver_spurs 1.0.1 → 1.0.2

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 \#*#
+/silver_spurs_async

data/.rspec

@@ -0,0 +1,2 @@
+-fd
+-c

data/.simplecov

@@ -0,0 +1,4 @@
+SimpleCov.start do
+  add_filter '/spec/'
+  minimum_coverage 100
+end

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - 1.9.2
+  - ruby-head

data/README.md

@@ -1,29 +1,76 @@
-# SilverSpurs
+# SilverSpurs [![Build Status](https://travis-ci.org/christian-blades-cb/silver_spurs.png?branch=master)](https://travis-ci.org/christian-blades-cb/silver_spurs)
 
-TODO: Write a gem description
+RESTful Chef bootstrapping
+
+Instead of using a CLI to kick off bootstrapping, hit an API endpoint and let the service do it for you. 
 
 ## Installation
 
+Install chef and set up knife on the machine (refer to the [chef docs](http://docs.opscode.com))
+
 Add this line to your application's Gemfile:
 
     gem 'silver_spurs'
 
+Create a config.ru:
+
+    require 'bundler'
+    Bundler.setup
+    
+    require 'silver_spurs'
+    
+    # SilverSpurs::App.deployment_key = '/opt/deployment_key.pem'
+    # SilverSpurs::App.deployment_user = 'deployer'
+    # SilverSpurs::App.node_name_filter = /\w{3,10}/
+    # SilverSpurs::Asyncifier.base_path = '/opt/silver_spurs'
+    
+    run SilverSpurs::App    
+    
 And then execute:
 
     $ bundle
+    $ rackup
 
-Or install it yourself as:
+## Usage
 
-    $ gem install silver_spurs
+### Kick off a bootstrap
 
-## Usage
+    $ curl -X PUT -i -d node_name=machineotron http://localhost/bootstrap/10.0.1.2
+    
+The redirect will point to the query URL for the bootstrap run. Since these runs tend to take several minutes, this is preferable to a long-running HTTP request.
+
+Further GET requests to this endpoint will return a log of the run in progress. HEAD requests will return just the status code.
+
+### Status codes
+
+* 406 - Missing a required parameter
+* 404 - Unknown endpoint or resource
+* 201 - Run completed successfully
+* 202 - Run in progress
+* 550 - Run ended in failure
+
+## Using the client
+
+Add this line to the application's Gemfile:
+
+    gem 'silver_spurs'
+
+Sample application
 
-TODO: Write usage instructions here
+    require 'silver_spurs/client'
+    
+    silver = SilverSpurs::Client.new('http://localhost')
+    bootstrap = silver.start_bootstrap('10.0.1.2', 'machineotron')
+    while bootstrap.status == :pending do
+      sleep 10
+    end
+    puts bootstrap.log
 
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+4. Add you some tests
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -1,2 +1,20 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+desc 'Run all tests'
+task :test => [:spec]
+task :default => [:coverage]
+
+desc "Run all rspec tests"
+RSpec::Core::RakeTask.new 'spec' do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+  t.rspec_opts = '-fd -c'
+end
+
+desc "Run all rspec tests and generate a coverage report"
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['spec'].invoke
+  `open coverage/index.html` if RUBY_PLATFORM.downcase.include? 'darwin'
+end

data/lib/silver_spurs/asyncifier.rb

@@ -28,7 +28,7 @@ module SilverSpurs
     def spawn_process(process_name, command)
       create_directory_tree
       logged_command = "#{command} 1> #{log_file_path process_name} 2>&1 && touch #{success_file_path process_name}"
-      logger.debug "Executing: #{logger_command}"
+      logger.debug "Executing: #{logged_command}"
       pid = Process.spawn logged_command
       File.open(pid_file_path(process_name), 'wb') { |f| f.write pid }
       Process.detach pid
@@ -38,7 +38,7 @@ module SilverSpurs
       return false unless File.exists? pid_file_path(process_name)
       
       pid = File.read(pid_file_path(process_name)).to_i
-      `ps -o command -p #{pid}`.split("\n").count == 2
+      IO.popen("ps -o command -p #{pid}").read.split("\n").count == 2
     end
 
     def success?(process_name)
@@ -63,7 +63,7 @@ module SilverSpurs
         sleep 1
         Process.kill('TERM', pid) if has_lock? process_name
       end
-      reap_lock_if_done process_name
+      reap_orphaned_lock process_name
     end
 
     def reap_old_process(process_name)

data/lib/silver_spurs/client.rb

@@ -17,13 +17,7 @@ module SilverSpurs
       payload = parameterize_hash params
       headers = {:accept => :json, :content_type=> 'application/x-www-form-urlencoded'}
 
-      response = spur_host["bootstrap/#{ip}"].put(payload, headers) do |response, &block|
-        if response.code == 303
-          response
-        else
-          response.return! &block
-        end
-      end
+      response = spur_host["bootstrap/#{ip}"].put(payload, headers, &method(:dont_redirect_for_303))
       
       throw ClientException.new("unexpected response", response) unless response.code == 303
 
@@ -46,6 +40,14 @@ module SilverSpurs
     def spur_host
       RestClient::Resource.new(@host_url, :timeout => @timeout)
     end
-            
+
+    def dont_redirect_for_303(response, origin, orig_result, &block)
+      if response.code == 303
+        response
+      else
+        response.return! &block
+      end
+    end
+                
   end
 end

data/lib/silver_spurs/client/bootstrap_run.rb

@@ -39,6 +39,7 @@ module SilverSpurs
     end
 
     private
+    
     def no_exception_for_550(response, origin, orig_result, &block)
       if response.code == 550
         response
@@ -49,7 +50,3 @@ module SilverSpurs
         
   end
 end
-
-
-    
-    

data/lib/silver_spurs/knife_interface.rb

@@ -37,7 +37,7 @@ module SilverSpurs
 
       arguments = expand_bootstrap_args bootstrap_options
 
-      command = ['knife', 'bootstrap', *arguments, ip].join ' '      
+      command = ['knife', 'bootstrap', '--no-host-key-verify', *arguments, ip].join ' '      
     end
     
   end

data/lib/silver_spurs/version.rb

@@ -1,3 +1,3 @@
 module SilverSpurs
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/silver_spurs.gemspec

@@ -26,5 +26,6 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'growl'
   gem.add_development_dependency 'rb-fsevent',  '~> 0.9'
   gem.add_development_dependency 'rack-test'
+  gem.add_development_dependency 'rake'
 
 end

data/spec/lib/silver_spurs/app_spec.rb

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'json'
 
 describe SilverSpurs::App do
   include Rack::Test::Methods
@@ -6,11 +7,54 @@ describe SilverSpurs::App do
   def app
     SilverSpurs::App
   end
+
+  describe '/' do
+    it "should return 200" do
+      get '/'
+      last_response.status.should be 200
+    end
+  end
+
+  describe '/settings' do
+    it "should tell us about the deployment_key, deployment_user and node_name_filter" do
+      get '/settings'
+      settings_hash = JSON.parse last_response.body
+      [:deployment_key, :deployment_user, :node_name_filter].each do |setting|
+        settings_hash.keys.should include setting.to_s
+      end
+    end
+  end
   
   describe "/bootstrap/:ip" do
+
+    context "when the node is not already being bootstrapped" do
+      before :each do
+        SilverSpurs::Asyncifier.stub(:has_lock?).and_return false
+      end
+      
+      it "builds a bootstrap command" do
+        SilverSpurs::Asyncifier.stub(:spawn_process)
+        SilverSpurs::KnifeInterface.should_receive(:bootstrap_command).with('10.0.0.0', 'yourmom', kind_of(String), kind_of(String), kind_of(Hash))
+
+        put '/bootstrap/10.0.0.0', :node_name => 'yourmom'
+      end
+
+      it "spawns a knife run" do
+        SilverSpurs::Asyncifier.should_receive(:spawn_process).with(kind_of(String), kind_of(String))
+        SilverSpurs::KnifeInterface.stub(:bootstrap_command).and_return 'knife bootstrap'
+
+        put '/bootstrap/10.0.0.0', :node_name => 'yourmom'
+      end
+    end
     
+    context "when a node name is not passed in" do
+      it "should return a 406 status" do
+        put '/bootstrap/10.0.0.0'
+        last_response.status.should be 406
+      end
+    end
+        
     context "with bad node name" do
-      
       it "should reject node names with spaces" do
         node_name = "your mom"
         put "/bootstrap/10.0.0.0", :node_name => node_name
@@ -46,47 +90,186 @@ describe SilverSpurs::App do
         put "/bootstrap/10.0.0.0", :node_name => node_name
         last_response.status.should eq 406
       end
-            
     end
 
     context "with good node name" do
       before(:each) do
-        SilverSpurs::KnifeInterface.stub(:bootstrap).and_return({:exit_code => 0, :log_lines => "I'm a test!"})
+        SilverSpurs::Asyncifier.stub(:has_lock?).and_return true
       end
       
       it "should accept node names with dashes" do
         node_name = "your-mom"
         put "/bootstrap/10.0.0.0", :node_name => node_name
-        last_response.status.should eq 201
+        last_response.status.should eq 303
       end
 
       it "should accept one-word node names" do
         node_name = "mom"
         put "/bootstrap/10.0.0.0", :node_name => node_name
-        last_response.status.should eq 201
+        last_response.status.should eq 303
       end
 
       it "should accept node names with numbers" do
         node_name = "mombot-3000"
         put "/bootstrap/10.0.0.0", :node_name => node_name
-        last_response.status.should eq 201
+        last_response.status.should eq 303
       end
 
       it "should accept node names with 15 chars" do
         node_name = "123456789012345"
         put "/bootstrap/10.0.0.0", :node_name => node_name
-        last_response.status.should eq 201
+        last_response.status.should eq 303
       end
 
       it "should accept node names with 3 chars" do
         node_name = "123"
         put "/bootstrap/10.0.0.0", :node_name => node_name
-        last_response.status.should eq 201
+        last_response.status.should eq 303
+      end
+    end
+    
+  end
+
+  describe '/bootstrap/query/:process_id' do
+    
+    describe 'HEAD' do
+      
+      context 'when process does not exist' do
+        before :each do
+          SilverSpurs::Asyncifier.stub(:exists?).and_return false
+        end
+                
+        it 'should return a 404' do
+          head '/bootstrap/query/fake_process'
+          last_response.status.should eq 404
+        end
+      end
+
+      context 'when process is still running' do
+        before :each do
+          SilverSpurs::Asyncifier.stub(:exists?).and_return true
+          SilverSpurs::Asyncifier.stub(:reap_old_process)
+          SilverSpurs::Asyncifier.stub(:has_lock?).and_return true
+        end
+
+        it 'should return a 202' do
+          head '/bootstrap/query/fake_process'
+          last_response.status.should eq 202
+        end
+      end
+
+      context 'when process finished successfully' do
+        before :each do
+          SilverSpurs::Asyncifier.stub(:exists?).and_return true
+          SilverSpurs::Asyncifier.stub(:reap_old_process)
+          SilverSpurs::Asyncifier.stub(:has_lock?).and_return false
+          SilverSpurs::Asyncifier.stub(:success?).and_return true
+        end
+
+        it 'should return a 201' do
+          head '/bootstrap/query/fake_process'
+          last_response.status.should eq 201
+        end
+      end
+
+      context 'when process finished in failure' do
+        before :each do
+          SilverSpurs::Asyncifier.stub(:exists?).and_return true
+          SilverSpurs::Asyncifier.stub(:reap_old_process)
+          SilverSpurs::Asyncifier.stub(:has_lock?).and_return false
+          SilverSpurs::Asyncifier.stub(:success?).and_return false
+        end
+
+        it 'should return a 550' do
+          head '/bootstrap/query/fake_process'
+          last_response.status.should eq 550
+        end
       end
-            
+      
     end
+
+    describe 'GET' do
+      before :each do
+        SilverSpurs::Asyncifier.stub(:get_log).and_return "Loggylog"
+      end
+      
+      context 'when process does not exist' do
+        before :each do
+          SilverSpurs::Asyncifier.stub(:exists?).and_return false
+        end
+                
+        it 'should return a 404' do
+          get '/bootstrap/query/fake_process'
+          last_response.status.should eq 404
+        end
+
+        it 'should not spit out a log' do
+          get '/bootstrap/query/fake_process'
+          last_response.body.should_not eq 'Loggylog'
+        end
         
+      end
+
+      context 'when process is still running' do
+        before :each do
+          SilverSpurs::Asyncifier.stub(:exists?).and_return true
+          SilverSpurs::Asyncifier.stub(:reap_old_process)
+          SilverSpurs::Asyncifier.stub(:has_lock?).and_return true
+        end
+
+        it 'should return a 202' do
+          get '/bootstrap/query/fake_process'
+          last_response.status.should eq 202
+        end
+
+        it 'should spit out a log' do
+          get '/bootstrap/query/fake_process'
+          last_response.body.should eq 'Loggylog'
+        end        
+      end
+
+      context 'when process finished successfully' do
+        before :each do
+          SilverSpurs::Asyncifier.stub(:exists?).and_return true
+          SilverSpurs::Asyncifier.stub(:reap_old_process)
+          SilverSpurs::Asyncifier.stub(:has_lock?).and_return false
+          SilverSpurs::Asyncifier.stub(:success?).and_return true
+        end
+
+        it 'should return a 201' do
+          get '/bootstrap/query/fake_process'
+          last_response.status.should eq 201
+        end
+
+        it 'should spit out a log' do
+          get '/bootstrap/query/fake_process'
+          last_response.body.should eq 'Loggylog'
+        end
+      end
+
+      context 'when process finished in failure' do
+        before :each do
+          SilverSpurs::Asyncifier.stub(:exists?).and_return true
+          SilverSpurs::Asyncifier.stub(:reap_old_process)
+          SilverSpurs::Asyncifier.stub(:has_lock?).and_return false
+          SilverSpurs::Asyncifier.stub(:success?).and_return false
+        end
+
+        it 'should return a 550' do
+          get '/bootstrap/query/fake_process'
+          last_response.status.should eq 550
+        end
+
+        it 'should spit out a log' do
+          get '/bootstrap/query/fake_process'
+          last_response.body.should eq 'Loggylog'
+        end
+      end
+      
+    end
+    
   end
+   
 end