bosh_openstack_registry 0.0.3 → 0.0.4

data/README.md

@@ -0,0 +1,80 @@
+# BOSH OpenStack Registry
+Copyright (c) 2009-2012 VMware, Inc.
+
+For online documentation see: http://rubydoc.info/gems/bosh_openstack_registry/
+
+## Usage
+
+    bin/migrate [<options>]
+        -c, --config FILE  OpenStack Registry configuration file
+
+    bin/openstack_registry [<options>]
+        -c, --config FILE  OpenStack Registry configuration file
+
+## Configuration
+
+These options are passed to the OpenStack Registry when it is instantiated.
+
+### Registry options
+
+These are the options for the Registry HTTP server (by default server is
+bound to address 0.0.0.0):
+
+* `port` (required)
+  Registry port
+* `user` (required)
+  Registry user (for HTTP Basic authentication)
+* `password` (required)
+  Registry password (for HTTP Basic authentication)
+
+### Database options
+
+These are the options for the database connection where registry will store
+server properties:
+
+* `database` (required)
+  DB connection URI
+* `max_connections` (required)
+  Maximum size of the connection pool
+* `pool_timeout` (required)
+  Number of seconds to wait if a connection cannot be acquired before
+  raising an error
+
+### OpenStack options
+
+These are the credentials to connect to OpenStack services:
+
+* `auth_url` (required)
+  URL of the OpenStack Identity endpoint to connect to
+* `username` (required)
+  OpenStack user name
+* `api_key` (required)
+  OpenStack API key
+* `tenant` (required)
+  OpenStack tenant name
+* `region` (optional)
+  OpenStack region
+
+## Example
+
+This is a sample of an OpenStack Registry configuration file:
+
+    ---
+    loglevel: debug
+
+    http:
+      port: 25695
+      user: admin
+      password: admin
+
+    db:
+      database: "sqlite:///:memory:"
+      max_connections: 32
+      pool_timeout: 10
+
+    openstack:
+      auth_url: "http://127.0.0.1:5000/v2.0/tokens"
+      username: foo
+      api_key: bar
+      tenant: foo
+      region:

data/lib/openstack_registry/api_controller.rb

@@ -17,7 +17,7 @@ module Bosh::OpenstackRegistry
 
     get "/servers/:server_id/settings" do
       ip_check = authorized? ? nil : request.ip
-      settings = @server_manager.read_settings(params[:server_id])
+      settings = @server_manager.read_settings(params[:server_id], ip_check)
       json(:status => "ok", :settings => settings)
     end
 

data/lib/openstack_registry/config.rb

@@ -32,7 +32,8 @@ module Bosh::OpenstackRegistry
         :openstack_auth_url => @openstack_properties["auth_url"],
         :openstack_username => @openstack_properties["username"],
         :openstack_api_key => @openstack_properties["api_key"],
-        :openstack_tenant => @openstack_properties["tenant"]
+        :openstack_tenant => @openstack_properties["tenant"],
+        :openstack_region => @openstack_properties["region"]
       }
 
       @db = connect_db(config["db"])

data/lib/openstack_registry/runner.rb

@@ -44,7 +44,7 @@ module Bosh::OpenstackRegistry
 
     private
 
-    def handle_em_error(e)
+    def handle_em_error(e, level = :fatal)
       @logger.send(level, e.to_s)
       if e.respond_to?(:backtrace) && e.backtrace.respond_to?(:join)
         @logger.send(level, e.backtrace.join("\n"))

data/lib/openstack_registry/server_manager.rb

@@ -27,7 +27,12 @@ module Bosh::OpenstackRegistry
     ##
     # Reads server settings
     # @param [String] server_id OpenStack server id
-    def read_settings(server_id)
+    # @param [optional, String] remote_ip If this IP is provided, check will
+    #   be performed to see if the server id actually has this IP address
+    #   according to OpenStack.
+    def read_settings(server_id, remote_ip = nil)
+      check_instance_ips(remote_ip, server_id) if remote_ip
+
       get_server(server_id).settings
     end
 
@@ -37,6 +42,16 @@ module Bosh::OpenstackRegistry
 
     private
 
+    def check_instance_ips(ip, server_id)
+      return if ip == "127.0.0.1"
+      actual_ips = server_ips(server_id)
+      unless actual_ips.include?(ip)
+        raise ServerError, "Server IP mismatch, expected IP is " \
+                           "`%s', actual IP(s): `%s'" %
+                           [ ip, actual_ips.join(", ") ]
+      end
+    end
+
     def get_server(server_id)
       server = Models::OpenstackServer[:server_id => server_id]
 
@@ -47,6 +62,19 @@ module Bosh::OpenstackRegistry
       server
     end
 
+    # Get the list of IPs belonging to this server
+    def server_ips(server_id)
+      server = @openstack.servers.get(server_id)
+      raise ServerNotFound, "Server `#{server_id}' not found" unless server
+      ips = []
+      server.addresses.each do |network, addresses|
+        addresses.each do |addr|
+          ips.push(addr.kind_of?(Hash) ? addr["addr"] : addr)
+        end
+      end
+      ips
+    end
+
   end
 
 end

data/lib/openstack_registry/version.rb

@@ -2,6 +2,6 @@
 
 module Bosh
   module OpenstackRegistry
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/spec/assets/sample_config.yml

@@ -15,4 +15,5 @@ openstack:
   auth_url: "http://127.0.0.1:5000/v2.0/tokens"
   username: foo
   api_key: bar
-  tenant: foo
+  tenant: foo
+  region:

data/spec/spec_helper.rb

@@ -101,7 +101,8 @@ def valid_config
       "auth_url" => "http://127.0.0.1:5000/v2.0/tokens",
       "username" => "foo",
       "api_key" => "bar",
-      "tenant" => "foo"
+      "tenant" => "foo",
+      "region" => ""
     }
   }
 end

data/spec/unit/api_controller_spec.rb

@@ -22,7 +22,7 @@ describe Bosh::OpenstackRegistry::ApiController do
 
   it "returns settings for given OpenStack server (IP check)" do
     @server_manager.should_receive(:read_settings).
-      with("foo").and_return("bar")
+      with("foo", "127.0.0.1").and_return("bar")
 
     @session.get("/servers/foo/settings")
 
@@ -32,7 +32,7 @@ describe Bosh::OpenstackRegistry::ApiController do
 
   it "returns settings (authorized user, no IP check)" do
     @server_manager.should_receive(:read_settings).
-      with("foo").and_return("bar")
+      with("foo", nil).and_return("bar")
 
     @session.basic_authorize("admin", "admin")
     @session.get("/servers/foo/settings")

data/spec/unit/server_manager_spec.rb

@@ -5,10 +5,10 @@ require File.expand_path("../../spec_helper", __FILE__)
 describe Bosh::OpenstackRegistry::ServerManager do
 
   before(:each) do
-    openstack = double(Fog::Compute)
-    Fog::Compute.stub(:new).and_return(openstack)
-    @openstack = mock("openstack")
-    Bosh::OpenstackRegistry.openstack = @openstack
+    @compute = double(Fog::Compute)
+    Fog::Compute.stub(:new).and_return(@compute)
+    openstack = mock("openstack")
+    Bosh::OpenstackRegistry.openstack = openstack
   end
 
   let(:manager) do
@@ -19,18 +19,62 @@ describe Bosh::OpenstackRegistry::ServerManager do
     Bosh::OpenstackRegistry::Models::OpenstackServer.create(params)
   end
 
+  def actual_ip_is(private_ip, floating_ip = nil)
+    servers = mock("servers")
+    server = mock("server", :addresses => {
+        "private" => [{"version" => 4, "addr" => private_ip}],
+        "public" => [floating_ip]
+    })
+
+    @compute.should_receive(:servers).and_return(servers)
+    servers.should_receive(:get).with("foo").and_return(server)
+  end
+
   describe "reading settings" do
-    it "returns settings" do
+    it "returns settings after verifying IP address" do
+      create_server(:server_id => "foo", :settings => "bar")
+      actual_ip_is("10.0.0.1")
+      manager.read_settings("foo", "10.0.0.1").should == "bar"
+    end
+
+    it "returns settings after verifying floating IP address" do
+      create_server(:server_id => "foo", :settings => "bar")
+      actual_ip_is("10.0.0.1", "10.0.1.1")
+      manager.read_settings("foo", "10.0.1.1").should == "bar"
+    end
+
+    it "raises an error if IP cannot be verified" do
+      create_server(:server_id => "foo", :settings => "bar")
+      actual_ip_is("10.0.0.1", "10.0.1.1")
+      expect {
+        manager.read_settings("foo", "10.0.2.1")
+      }.to raise_error(Bosh::OpenstackRegistry::ServerError,
+                       "Server IP mismatch, expected IP is `10.0.2.1', " \
+                       "actual IP(s): `10.0.0.1, 10.0.1.1'")
+    end
+
+    it "doesn't check remote IP if it's not provided" do
       create_server(:server_id => "foo", :settings => "bar")
       manager.read_settings("foo").should == "bar"
     end
 
-    it "raises an error if server not found" do
+    it "raises an error if server not found in registry" do
       expect {
         manager.read_settings("foo")
       }.to raise_error(Bosh::OpenstackRegistry::ServerNotFound,
                        "Can't find server `foo'")
     end
+
+    it "raises an error if server not found in OpenStack" do
+      expect {
+        servers = mock("servers")
+        @compute.should_receive(:servers).and_return(servers)
+        servers.should_receive(:get).with("foo").and_return(nil)
+        create_server(:server_id => "foo", :settings => "bar")
+        manager.read_settings("foo", "10.0.0.1")
+      }.to raise_error(Bosh::OpenstackRegistry::ServerNotFound,
+                       "Server `foo' not found")
+    end
   end
 
   describe "updating settings" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bosh_openstack_registry
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-23 00:00:00.000000000 Z
+date: 2012-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel
@@ -80,7 +80,7 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.6.0
   type: :runtime
@@ -88,7 +88,7 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.6.0
 description: BOSH OpenStack registry
@@ -110,7 +110,7 @@ files:
 - lib/openstack_registry/server_manager.rb
 - lib/openstack_registry/version.rb
 - lib/openstack_registry/yaml_helper.rb
-- README
+- README.md
 - Rakefile
 - spec/assets/sample_config.yml
 - spec/spec_helper.rb
@@ -130,18 +130,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1388648985805055139
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1388648985805055139
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -155,3 +149,4 @@ test_files:
 - spec/unit/config_spec.rb
 - spec/unit/runner_spec.rb
 - spec/unit/server_manager_spec.rb
+has_rdoc: 

data/README

@@ -1,3 +0,0 @@
-# Copyright (c) 2009-2012 VMware, Inc.
-
-BOSH OpenStack Registry