silk 0.0.1 → 0.0.2

data/README.rdoc

@@ -10,15 +10,17 @@ This gem is just the runner, that need to be installed on all client servers.
 
 (Requires Gemcutter)
 
-gem install silk
+  gem install silk
 
-Create /etc/silk and drop in a Rakefile - you can also add *.rake files in /etc/silk (or $HOME/.silk/) and they will automatically be read in.
+Create /etc/silk and drop *.rake files in /etc/silk (or $HOME/.silk/) and they will automatically be read in.
 
 == Usage
 
-The gem should install an executable called silk
+The gem should install an executable called silk run
 
-run silk -h for full argument descriptions.
+  silk -h 
+  
+for full argument descriptions.
 
 The system automatically converts the rest URL (only GETs at the moment) into a rake task name - if the name doesn't exist, you'll get a 404. Any query params get passed into the task
 
@@ -26,11 +28,19 @@ So http://localhost:8888/users/get?login=myles
 
 would run the users:get task. do something like this in the rake task:
 
-namespace :users do
-  task :get do |t, args|
-    # args[:login] will be populated with myles
+  require 'json'
+
+  namespace :users do
+    task :get do |t, args|
+      # args[:login] will be populated with myles
+      if args[:login]
+        puts "Success".to_json
+      else
+        $stderr.puts "Fail".to_json
+        exit(-1)
+      end
+    end
   end
-end
 
 NOTE: The idea is you write your own rake task to do stuff, and then interface them how you want. The project doesn't care what data you transfer and represent, although it would be possible to share rakefiles and interfaces for common tasks.
 
@@ -38,9 +48,17 @@ By default it runs on port 8888 and will probably need to be run as root to make
 
 Eventually it'll support SSL certificates etc, but until then, I suggest you either use SSH tunnels, and/or (at the very least) lock down via a firewall. You could also build a rack.up file, and run it behind a web server that gives you more control (Rack.up file is on the todo list).
 
+== Testing
+
+There is a test suite. It uses shoulda + mocha + test::rack
+
+If you are going to submit patches, please try to make sure the tests pass, and that you have created a test covering the changes you have made
+
+(Please note: I haven't got complete coverage yet, so I'm not really practicing what I preach. I'm working on it - feel free to help out!)
+
 == Status
 
-This is a really early release, that still needs formal testing (This is so far more proof of concept at this point), and may blow up at any given moment. Feel free to fork and help out.
+This is a really early release, that still needs more testing (This is so far more proof of concept at this point), and may blow up at any given moment. Feel free to fork and help out.
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -13,9 +13,14 @@ begin
     gem.authors = ["Myles Eftos"]
     
     gem.add_dependency 'daemons'
+    gem.add_dependency 'json'
+    gem.add_dependency 'sinatra'
     gem.add_dependency 'SyslogLogger'
     
-    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.add_development_dependency "rack-test"
+    gem.add_development_dependency "redgreen"
+    gem.add_development_dependency "mocha"
   end
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/silk/server.rb

@@ -40,9 +40,9 @@ module Silk
       headers('X_PROCESS_EXIT_STATUS' => $?.exitstatus.to_s)
       
       if $?.exitstatus != 0
-        error(500, results[:stderr])
+        error(500, results[:stderr].strip)
       else
-        results[:stdout]
+        results[:stdout].strip
       end
     end
   end

data/test/rakefiles/test.rake

@@ -0,0 +1,32 @@
+require 'json'
+
+desc "Level 1"
+task :level_1 do
+  puts "Level 1".to_json
+end
+
+namespace :level_1 do
+  desc "Level 2" 
+  task :level_2 do
+    puts "Level 2".to_json
+  end
+
+  desc "Level 2 with args" 
+  task :level_2_with_args do |t, args|
+    puts(("Level 2: " + args.inspect).to_json)
+  end
+
+  namespace :level_2 do
+    task :level_3 do
+      puts "Level 3".to_json
+    end
+  end
+end
+
+namespace :errors do
+  desc "Returns an error"
+  task :return do
+    $stderr.puts "Error".to_json
+    exit(-1)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+$:.unshift File.join(File.dirname(File.expand_path(__FILE__)), '..', 'lib')
+require 'rubygems' 
+require 'silk'
+ 
+require 'redgreen'
+require 'test/unit'
+require 'mocha'
+require 'shoulda'
+require 'rack/test'
+
+module TestHelper
+
+end

data/test/test_server.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+class TestSilk < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    Silk::Server
+  end
+
+  context '' do
+    setup do
+      Silk.options = { :filter_paths => File.join(File.dirname(File.expand_path(__FILE__)), 'rakefiles') }
+    end
+
+    should "return a 404 if the rake task is not found" do
+      get '/'
+      assert "application/json", last_response.headers['Content-Type']
+      assert last_response.not_found?
+    end
+
+    should "return a success if the rake task exists and is successfully run" do
+      get '/level_1'
+      assert last_response.ok?
+      assert "application/json", last_response.headers['Content-Type']
+      assert_equal "0", last_response.headers['X_PROCESS_EXIT_STATUS']
+      assert_equal "Level 1".to_json, last_response.body.to_s
+    end
+
+    should "return a success if the rake task exists at a second level and is successfully run" do
+      get '/level_1/level_2'
+      assert last_response.ok?
+      assert "application/json", last_response.headers['Content-Type']
+      assert_equal "0", last_response.headers['X_PROCESS_EXIT_STATUS']
+      assert_equal "Level 2".to_json, last_response.body
+    end
+
+    should "return a success if the rake task exists an process arguments if present" do
+      get '/level_1/level_2_with_args?argument_1=1&argument_2=2'
+      assert last_response.ok?
+      assert "application/json", last_response.headers['Content-Type']
+      assert_equal "0", last_response.headers['X_PROCESS_EXIT_STATUS']
+      assert_equal ("Level 2: " + { "argument_1" => "1", "argument_2" => "2" }.inspect).to_json, last_response.body
+    end
+
+    should "return read stderr, and set the exit status, and return 500 if the rake task exists, but returns a non-zero exit code" do
+      get '/errors/return'
+      assert_equal 500, last_response.status
+      assert "application/json", last_response.headers['Content-Type']
+      assert_equal "255", last_response.headers['X_PROCESS_EXIT_STATUS']
+      assert_equal "Error".to_json, last_response.body
+    end
+  end
+end

data/test/test_silk.rb

@@ -1,7 +1,7 @@
 require 'helper'
 
 class TestSilk < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
+  context '' do
+     
   end
 end

data/test/test_tasks.rb

@@ -0,0 +1,77 @@
+require 'test_helper'
+
+class TestSilk < Test::Unit::TestCase
+  context '' do
+    setup do
+      Silk.options = { :filter_paths => File.join(File.dirname(File.expand_path(__FILE__)), 'rakefiles') }
+      @task = Silk::Tasks.new
+    end
+
+    should "return a list of all the available rake tasks" do
+      assert @task.list.include?("level_1")
+      assert @task.list.include?("level_1:level_2")
+      assert @task.list.include?("level_1:level_2_with_args")
+      assert @task.list.include?("level_1:level_2:level_3")
+      assert @task.list.include?("errors:return")
+    end
+
+    should "run a task if it exists" do
+      stdout_read, stdout_write = IO.pipe
+      stderr_read, stderr_write = IO.pipe
+      pid = Process.fork do
+        $stdout.reopen stdout_write
+        $stderr.reopen stderr_write
+        stdout_read.close
+        stderr_read.close
+        @task.run("level_1")
+      end
+      
+      stdout_write.close
+      stderr_write.close
+
+      stdout = ''
+      stderr = ''
+      stdout_read.each do |line|
+        stdout += line
+      end
+      stderr_read.each do |line|
+        stderr += line
+      end
+      Process.waitpid(pid)
+ 
+      assert_equal "Level_1".to_json, stdout.strip
+      assert_equal "".to_json, stderr.strip
+    end
+
+    should "run a task and pass in arrguments if it exists" do
+      # I'm guessing this test fails because STDOUT and STDERR are already being captured
+      stdout_read, stdout_write = IO.pipe
+      stderr_read, stderr_write = IO.pipe
+      pid = Process.fork do
+        $stdout.reopen stdout_write
+        $stderr.reopen stderr_write
+        stdout_read.close
+        stderr_read.close
+        @task.run("level_2_with_args", { 'param_1' => '1' })
+      end
+      
+      stdout_write.close
+      stderr_write.close
+
+      stdout = ''
+      stderr = ''
+      stdout_read.each do |line|
+        stdout += line
+      end
+      stderr_read.each do |line|
+        stderr += line
+      end
+      Process.waitpid(pid)
+ 
+      assert_equal(("Level 2: " + { 'param_1' => '1' }.inspect).to_json, stdout.strip)
+      assert_equal "".to_json, stderr.strip
+    end
+
+    should "run the task only once if a new Application is built"
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: silk
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Myles Eftos
@@ -22,6 +22,26 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 - !ruby/object:Gem::Dependency 
   name: SyslogLogger
   type: :runtime
@@ -42,6 +62,36 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: redgreen
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: It allows you to write rake tasks to do common tasks, such as creating email addresses, adding users etc. Silk provides a HTTP wrapper the the rake tasks, and allows communication via JSON objects, which makes it dead easy for them to be called from a web app.
 email: myles@madpilot.com.au
 executables: 
@@ -60,12 +110,15 @@ files:
 - VERSION
 - bin/silk
 - lib/silk.rb
-- lib/silk/http.rb
 - lib/silk/options.rb
 - lib/silk/server.rb
 - lib/silk/tasks.rb
 - test/helper.rb
+- test/rakefiles/test.rake
+- test/test_helper.rb
+- test/test_server.rb
 - test/test_silk.rb
+- test/test_tasks.rb
 has_rdoc: true
 homepage: http://github.com/madpilot/silk
 licenses: []
@@ -95,5 +148,8 @@ signing_key:
 specification_version: 3
 summary: A framework for creating a hosting console
 test_files: 
+- test/test_server.rb
 - test/test_silk.rb
+- test/test_tasks.rb
+- test/test_helper.rb
 - test/helper.rb

data/lib/silk/http.rb

@@ -1,2 +0,0 @@
-require 'sinatra'
-require 'json'