agent_client 0.1.1

data/README

@@ -0,0 +1 @@
+Agent client for VMware BOSH.

data/Rakefile

@@ -0,0 +1,52 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+$:.unshift(File.expand_path("../../rake", __FILE__))
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __FILE__)
+
+require "rubygems"
+require "bundler"
+Bundler.setup(:default, :test)
+
+require "rake"
+require "rake"
+begin
+  require "rspec/core/rake_task"
+rescue LoadError
+end
+
+require "bundler_task"
+require "ci_task"
+
+gem_helper = Bundler::GemHelper.new(Dir.pwd)
+
+desc "Build BOSH Agent Client gem into the pkg directory"
+task "build" do
+  gem_helper.build_gem
+end
+
+desc "Build and install BOSH Agent Client into system gems"
+task "install" do
+  Rake::Task["bundler:install"].invoke
+  gem_helper.install_gem
+end
+
+BundlerTask.new
+
+if defined?(RSpec)
+  namespace :spec do
+    desc "Run Unit Tests"
+    rspec_task = RSpec::Core::RakeTask.new(:unit) do |t|
+      t.gemfile = "Gemfile"
+      t.pattern = "spec/unit/**/*_spec.rb"
+      t.rspec_opts = %w(--format progress --colour)
+    end
+
+    CiTask.new do |task|
+      task.rspec_task = rspec_task
+    end
+  end
+
+  desc "Install dependencies and run tests"
+  task :spec => %w(bundler:install:test spec:unit)
+end

data/lib/agent_client/base.rb

@@ -0,0 +1,28 @@
+module Bosh
+  module Agent
+    class BaseClient
+
+      def run_task(method, *args)
+        task = send(method.to_sym, *args)
+
+        while task["state"] == "running"
+          sleep(1.0)
+          task = get_task(task["agent_task_id"])
+        end
+
+        task
+      end
+
+      def method_missing(method_name, *args)
+        result = handle_method(method_name, args)
+
+        raise HandlerError, result["exception"] if result.has_key?("exception")
+        result["value"]
+      end
+
+      protected
+      def handle_method(method_name, args)
+      end
+    end
+  end
+end

data/lib/agent_client/errors.rb

@@ -0,0 +1,9 @@
+module Bosh
+  module Agent
+
+    class Error < StandardError; end
+    class AuthError < Error; end
+    class HandlerError < StandardError; end
+
+  end
+end

data/lib/agent_client/http_client.rb

@@ -0,0 +1,64 @@
+module Bosh; module Agent; end; end
+
+require "httpclient"
+
+module Bosh::Agent
+  class HTTPClient < BaseClient
+
+    IO_TIMEOUT      = 86400 * 3
+    CONNECT_TIMEOUT = 30
+
+    def initialize(base_uri, options = {})
+      @base_uri = base_uri
+      @options = options
+    end
+
+    protected
+
+    def handle_method(method, args)
+      payload = {
+        "method" => method, "arguments" => args,
+        "reply_to" => @options["reply_to"] || self.class.name
+      }
+      result = post_json("/agent", Yajl::Encoder.encode(payload))
+    end
+
+    private
+
+    def request(method, uri, content_type = nil, payload = nil, headers = {})
+      headers = headers.dup
+      headers["Content-Type"] = content_type if content_type
+
+      http_client = ::HTTPClient.new
+
+      http_client.send_timeout    = IO_TIMEOUT
+      http_client.receive_timeout = IO_TIMEOUT
+      http_client.connect_timeout = CONNECT_TIMEOUT
+
+      if @options['user'] && @options['password']
+        http_client.set_auth(@base_uri, @options['user'], @options['password'])
+      end
+
+      http_client.request(method, @base_uri + uri,
+                          :body => payload, :header => headers)
+
+    rescue URI::Error, SocketError, Errno::ECONNREFUSED => e
+      raise Error, "cannot access agent (%s)" % [ e.message ]
+    rescue SystemCallError => e
+      raise Error, "System call error while talking to agent: #{e}"
+    rescue ::HTTPClient::BadResponseError => e
+      raise Error, "Received bad HTTP response from agent: #{e}"
+    rescue => e
+      raise Error, "Agent call exception: #{e}"
+    end
+
+    def post_json(url, payload)
+      response = request(:post, url, "application/json", payload)
+      status = response.code
+      raise AuthError, "Authentication failed" if status == 401
+      raise Error, "Agent HTTP #{status}" if status != 200
+      Yajl::Parser.parse(response.body)
+    end
+
+  end
+end

data/lib/agent_client/version.rb

@@ -0,0 +1,7 @@
+module Bosh
+  module Agent
+    class Client
+      VERSION = "0.1.1"
+    end
+  end
+end

data/lib/agent_client.rb

@@ -0,0 +1,25 @@
+module Bosh; module Agent; end; end
+
+require "agent_client/version"
+require "agent_client/errors"
+require "agent_client/base"
+require "agent_client/http_client"
+
+require "uri"
+require "yajl"
+
+module Bosh
+  module Agent
+    class Client
+      def self.create(uri, options = { })
+        scheme = URI.parse(uri).scheme
+        case scheme
+        when "http"
+          HTTPClient.new(uri, options)
+        else
+          raise "Invalid client scheme, available providers are: 'http'"
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+# Copyright (c) 2009-2012 VMware, Inc.
+
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
+
+require "rubygems"
+require "bundler"
+Bundler.setup(:default, :test)
+
+require "rspec"
+require "agent_client"

data/spec/unit/http_agent_client_spec.rb

@@ -0,0 +1,135 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Bosh::Agent::HTTPClient do
+
+  before(:each) do
+    @httpclient = mock("httpclient")
+    HTTPClient.stub!(:new).and_return(@httpclient)
+  end
+
+  describe "options" do
+
+    it "should set up authentication when present" do
+      response = mock("response")
+      response.stub!(:code).and_return(200)
+      response.stub!(:body).and_return('{"value": "pong"}')
+
+      [:send_timeout=, :receive_timeout=, :connect_timeout=].each do |method|
+        @httpclient.should_receive(method)
+      end
+
+      @httpclient.should_receive(:set_auth).with("http://localhost", "john", "smith")
+      @httpclient.should_receive(:request).and_return(response)
+
+      @client = Bosh::Agent::HTTPClient.new("http://localhost",
+                                            { "user" => "john",
+                                              "password" => "smith" })
+      @client.ping
+    end
+
+    it "should encode arguments" do
+      response = mock("response")
+      response.stub!(:code).and_return(200)
+      response.stub!(:body).and_return('{"value": "iam"}')
+
+      [:send_timeout=, :receive_timeout=, :connect_timeout=].each do |method|
+        @httpclient.should_receive(method)
+      end
+
+      headers = { "Content-Type" => "application/json" }
+      payload = '{"method":"shh","arguments":["hunting","wabbits"],"reply_to":"elmer"}'
+
+      @httpclient.should_receive(:request).with(:post, "http://localhost/agent",
+                                                :body => payload, :header => headers).and_return(response)
+
+      @client = Bosh::Agent::HTTPClient.new("http://localhost", {"reply_to" => "elmer"})
+
+      @client.shh("hunting", "wabbits").should == "iam"
+    end
+
+    it "should receive a message value" do
+      response = mock("response")
+      response.stub!(:code).and_return(200)
+      response.stub!(:body).and_return('{"value": "pong"}')
+
+      [:send_timeout=, :receive_timeout=, :connect_timeout=].each do |method|
+        @httpclient.should_receive(method)
+      end
+
+      headers = { "Content-Type" => "application/json" }
+      payload = '{"method":"ping","arguments":[],"reply_to":"fudd"}'
+
+      @httpclient.should_receive(:request).with(:post, "http://localhost/agent",
+                                                :body => payload, :header => headers).and_return(response)
+
+      @client = Bosh::Agent::HTTPClient.new("http://localhost", {"reply_to" => "fudd"})
+
+      @client.ping.should == "pong"
+    end
+
+    it "should run_task" do
+      response = mock("response")
+      response.stub!(:code).and_return(200)
+      response.stub!(:body).and_return('{"value": {"state": "running", "agent_task_id": "task_id_foo"}}')
+
+      [:send_timeout=, :receive_timeout=, :connect_timeout=].each do |method|
+        @httpclient.should_receive(method)
+      end
+
+      headers = { "Content-Type" => "application/json" }
+      payload = '{"method":"compile_package","arguments":["id","sha1"],"reply_to":"bugs"}'
+
+      @httpclient.should_receive(:request).with(:post, "http://localhost/agent",
+                                                :body => payload, :header => headers).and_return(response)
+
+      response2 = mock("response2")
+      response2.stub!(:code).and_return(200)
+      response2.stub!(:body).and_return('{"value": {"state": "done"}')
+
+      payload = '{"method":"get_task","arguments":["task_id_foo"],"reply_to":"bugs"}'
+
+      [:send_timeout=, :receive_timeout=, :connect_timeout=].each do |method|
+        @httpclient.should_receive(method)
+      end
+
+      @httpclient.should_receive(:request).with(:post, "http://localhost/agent",
+                                                :body => payload, :header => headers).and_return(response2)
+
+      @client = Bosh::Agent::HTTPClient.new("http://localhost", {"reply_to" => "bugs"})
+
+      @client.run_task(:compile_package, "id", "sha1").should == { "state" => "done" }
+    end
+
+    it "should raise handler exception when method is invalid" do
+      response = mock("response")
+      response.stub!(:code).and_return(200)
+      response.stub!(:body).and_return('{"exception": "no such method"}')
+
+      [:send_timeout=, :receive_timeout=, :connect_timeout=].each do |method|
+        @httpclient.should_receive(method)
+      end
+
+      @httpclient.should_receive(:request).and_return(response)
+
+      @client = Bosh::Agent::HTTPClient.new("http://localhost")
+
+      lambda { @client.no_such_method }.should raise_error(Bosh::Agent::HandlerError)
+
+    end
+
+    it "should raise authentication exception when 401 is returned" do
+      response = mock("response")
+      response.stub!(:code).and_return(401)
+
+      [:send_timeout=, :receive_timeout=, :connect_timeout=].each do |method|
+        @httpclient.should_receive(method)
+      end
+
+      @httpclient.should_receive(:request).and_return(response)
+
+      @client = Bosh::Agent::HTTPClient.new("http://localhost")
+
+      lambda { @client.ping }.should raise_error(Bosh::Agent::AuthError)
+    end
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: agent_client
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- VMware
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-13 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httpclient
+  requirement: &18710880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *18710880
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: &18710200 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *18710200
+description: BOSH agent client
+email: support@vmware.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/agent_client.rb
+- lib/agent_client/base.rb
+- lib/agent_client/errors.rb
+- lib/agent_client/http_client.rb
+- lib/agent_client/version.rb
+- README
+- Rakefile
+- spec/spec_helper.rb
+- spec/unit/http_agent_client_spec.rb
+homepage: http://www.vmware.com
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 12617920935854716
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 12617920935854716
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: BOSH agent client
+test_files:
+- spec/spec_helper.rb
+- spec/unit/http_agent_client_spec.rb