copland 0.8.0 → 1.0.0

data/lib/copland/service-point.rb

@@ -88,6 +88,12 @@ module Copland
     # passed to the factory when a new instance is required.
     attr_accessor :schema
 
+    # The visibility of this service point. If <tt>:public</tt> (the default),
+    # the service point is accessible outside of its package. If it is
+    # <tt>:private</tt>, then it is only directly accessible to other services
+    # within its package.
+    attr_accessor :visibility
+
     # Create a new service point, contained by the +owner+ package. The only
     # recognized option currently is <tt>:default_service_model</tt>, which
     # is used to identify the service model to use when no other service model
@@ -95,6 +101,7 @@ module Copland
     def initialize( owner, name, opts={} )
       @owner = owner
       @name = name
+      @visibility = :public
 
       use_service_model opts[ :default_service_model ] || DEFAULT_SERVICE_MODEL
 

data/lib/copland/thread.rb

@@ -0,0 +1,104 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+#     * Redistributions of source code must retain the above copyright notice,
+#       this list of conditions and the following disclaimer.
+# 
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+# 
+#     * The names of its contributors may not be used to endorse or promote
+#       products derived from this software without specific prior written
+#       permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# =============================================================================
+#++
+
+require 'thread'
+
+module Copland
+
+  # A subclass of Mutex that allows clients to discover which thread has the
+  # mutex locked. This is necessary for (among other things) discovering
+  # cycles in the dependency graph of services.
+  class QueryableMutex < Mutex
+
+    # Checks to see if the current thread has the mutex locked, and if it
+    # does, raises an exception. Otherwise, locks the mutex and sets the
+    # locking thread to Thread.current.
+    def lock
+      if @locking_thread == Thread.current
+        raise ThreadError,
+          "an attempt was made to reacquire an existing lock " +
+          "(this could happen if you have a circular dependency on a service)"
+      end
+
+      while (Thread.critical = true; @locked)
+        @waiting.push Thread.current
+        Thread.stop
+      end
+      @locked = true
+      @locking_thread = Thread.current
+      Thread.critical = false
+      self
+    end
+
+    # Attempts to acquire the lock. Returns +true+ if the lock was acquired,
+    # and +false+ if the mutex was already locked.
+    def try_lock
+      result = false
+      Thread.critical = true
+      unless @locked
+        @locked = true
+        result = true
+        @locking_thread = Thread.current
+      end
+      Thread.critical = false
+      result
+    end
+    
+    # Unlocks the mutex and sets the locking thread to +nil+.
+    def unlock
+      return unless @locked
+      Thread.critical = true
+      @locked = false
+      begin
+        t = @waiting.shift
+        t.wakeup if t
+      rescue ThreadError
+        retry
+      end
+      @locking_thread = nil
+      Thread.critical = false
+      begin
+        t.run if t
+      rescue ThreadError
+      end
+      self
+    end
+
+    # Return +true+ if the current thread has locked this mutex.
+    def self_locked?
+      @locking_thread == Thread.current
+    end
+
+  end
+
+end

data/lib/copland/utils.rb

@@ -51,15 +51,19 @@ module Copland
   # it passes the correct pkg and unqualified service name to the block and
   # returns the result.
   def get_possibly_local_service( registry, pkg, id )
+    original_package = pkg
+
     if id =~ /^(.+)\.([^.]+)$/
       pkg = registry.package( $1 )
       id = $2
     end
 
+    local_service = ( original_package == pkg )
+
     if block_given?
-      yield pkg, id
+      yield pkg, id, local_service
     else
-      pkg.service( id )
+      pkg.service( id, local_service )
     end
   end
 
@@ -121,7 +125,9 @@ module Copland
   # real::       the value is interpreted as a floating point
   # string::     the value is interpreted as a string
   def translate_value( registry, pkg, point, value )
-    substitute_symbols( registry, value )
+    unless Thread.current[:disable_symbol_substitution]
+      substitute_symbols( registry, value )
+    end
 
     if value.is_a?( Array )
       return translate_array( registry, pkg, point, value )
@@ -140,6 +146,7 @@ module Copland
               pkg.configuration_point id
             end
           raise ConfigurationPointNotFound, value.value unless cfg
+          cfg.substitute_symbols!
           return cfg
         when "class"
           return get_class( value.value )

data/lib/copland/version.rb

@@ -36,8 +36,8 @@ module Copland
   # A simple module for holding version information about Copland.
   module Version
 
-    MAJOR = 0
-    MINOR = 8
+    MAJOR = 1
+    MINOR = 0
     TINY  = 0
 
     STRING = [ MAJOR, MINOR, TINY ].join( "." )

data/test/configuration/yaml/tc_service-point-processor.rb

@@ -81,6 +81,13 @@ class TC_ServicePointProcessor < Test::Unit::TestCase
     end
   end
 
+  def test_bad_visibility_type
+    assert_raise( Copland::Configuration::ParserError ) do
+      @processor.process "name", "implementor" => "something",
+                                 "visibility" => "blah"
+    end
+  end
+
   def test_valid
     point = nil
 
@@ -91,6 +98,7 @@ class TC_ServicePointProcessor < Test::Unit::TestCase
                                  "description" => "a",
                                  "interceptors" => [],
                                  "listen-to" => [],
+                                 "visibility" => "private",
                                  "schema" => "mock.MockParameterProcessor"
     end
 

data/test/custom-logger.yml

@@ -1,3 +1,4 @@
 filename: ./custom.log
-default-format: "date %Y-%m-%d %H:%M:%S"
+default-date-format: "date %Y-%m-%d %H:%M:%S"
+default-message-format: "%m"
 default-level: FATAL

data/test/impl/tc_logging-interceptor.rb

@@ -63,8 +63,8 @@ class TC_LoggingInterceptor < Test::Unit::TestCase
 
     assert_equal "", @device.message
     service.echo 15
-    assert_match( /DEBUG -- logging.Test: echo\( 15 \)/, @device.message )
-    assert_match( /DEBUG -- logging.Test: echo => 15/, @device.message )
+    assert_match( /\[DEBUG\] .* -- logging.Test: echo\( 15 \)/, @device.message )
+    assert_match( /\[DEBUG\] .* -- logging.Test: echo => 15/, @device.message )
   end
 
   def test_exclude
@@ -72,8 +72,8 @@ class TC_LoggingInterceptor < Test::Unit::TestCase
 
     assert_equal "", @device.message
     service.echo 15
-    assert_match( /DEBUG -- logging.TestExclude: echo\( 15 \)/, @device.message )
-    assert_match( /DEBUG -- logging.TestExclude: echo => 15/, @device.message )
+    assert_match( /\[DEBUG\] .* -- logging.TestExclude: echo\( 15 \)/, @device.message )
+    assert_match( /\[DEBUG\] .* -- logging.TestExclude: echo => 15/, @device.message )
 
     @device.clear
     assert_equal "", @device.message
@@ -91,8 +91,8 @@ class TC_LoggingInterceptor < Test::Unit::TestCase
 
     assert_equal "", @device.message
     service.echo 15
-    assert_match( /DEBUG -- logging.TestInclude: echo\( 15 \)/, @device.message )
-    assert_match( /DEBUG -- logging.TestInclude: echo => 15/, @device.message )
+    assert_match( /\[DEBUG\] .* -- logging.TestInclude: echo\( 15 \)/, @device.message )
+    assert_match( /\[DEBUG\] .* -- logging.TestInclude: echo => 15/, @device.message )
 
     @device.clear
     assert_equal "", @device.message
@@ -102,8 +102,8 @@ class TC_LoggingInterceptor < Test::Unit::TestCase
     @device.clear
     assert_equal "", @device.message
     service.echo_notme_multiple 15, 16
-    assert_match( /DEBUG -- logging.TestInclude: echo_notme_multiple\( 15, 16 \)/, @device.message )
-    assert_match( /DEBUG -- logging.TestInclude: echo_notme_multiple => \[15, 16\]/, @device.message )
+    assert_match( /\[DEBUG\] .* -- logging.TestInclude: echo_notme_multiple\( 15, 16 \)/, @device.message )
+    assert_match( /\[DEBUG\] .* -- logging.TestInclude: echo_notme_multiple => \[15, 16\]/, @device.message )
   end
 
   def test_include2
@@ -112,8 +112,8 @@ class TC_LoggingInterceptor < Test::Unit::TestCase
     @device.clear
     assert_equal "", @device.message
     service.echo_notme 15
-    assert_match( /DEBUG -- logging.TestInclude2: echo_notme\( 15 \)/, @device.message )
-    assert_match( /DEBUG -- logging.TestInclude2: echo_notme => 15/, @device.message )
+    assert_match( /\[DEBUG\] .* -- logging.TestInclude2: echo_notme\( 15 \)/, @device.message )
+    assert_match( /\[DEBUG\] .* -- logging.TestInclude2: echo_notme => 15/, @device.message )
 
     @device.clear
     assert_equal "", @device.message
@@ -126,8 +126,8 @@ class TC_LoggingInterceptor < Test::Unit::TestCase
 
     assert_equal "", @device.message
     service.echo 15, 16, 17
-    assert_match( /DEBUG -- logging.TestArity: echo\( 15, 16, 17 \)/, @device.message )
-    assert_match( /DEBUG -- logging.TestArity: echo => \[15, 16, 17\]/, @device.message )
+    assert_match( /\[DEBUG\] .* -- logging.TestArity: echo\( 15, 16, 17 \)/, @device.message )
+    assert_match( /\[DEBUG\] .* -- logging.TestArity: echo => \[15, 16, 17\]/, @device.message )
 
     @device.clear
     assert_equal "", @device.message

data/test/logger.yml

@@ -1,5 +1,5 @@
 filename: ./sample.log
-default-format: "%Y-%m-%d %H:%M:%S"
+default-date-format: "%Y-%m-%d %H:%M:%S"
 default-level: INFO
 levels:
   level.*: WARN

data/test/mock.rb

@@ -91,12 +91,14 @@ class MockServicePoint
 
   attr_accessor :instantiator
   attr_accessor :parameter_processor
+  attr_accessor :visibility
 
   def initialize( message="" )
     @message = message
     @pending_interceptors = []
     @event_producers = []
     @listeners = []
+    @visibility = :public
   end
 
   def instance

data/test/tc_logger.rb

@@ -62,21 +62,21 @@ class TC_Logger < Test::Unit::TestCase
   def test_log_config
     factory = Copland::LogFactory.new
     assert_equal "./sample.log", factory.device.filename
-    assert_equal "%Y-%m-%d %H:%M:%S", factory.default_format
+    assert_equal "%Y-%m-%d %H:%M:%S", factory.default_date_format
     assert_equal Logger::INFO, factory.default_level
     factory.close
 
     factory = Copland::LogFactory.new :config_file => 'custom-logger.yml'
     assert_equal "./custom.log", factory.device.filename
-    assert_equal "date %Y-%m-%d %H:%M:%S", factory.default_format
+    assert_equal "date %Y-%m-%d %H:%M:%S", factory.default_date_format
     assert_equal Logger::FATAL, factory.default_level
     factory.close
   end
 
   def test_log_options
-    factory = Copland::LogFactory.new :default_format => "%Y",
+    factory = Copland::LogFactory.new :default_date_format => "%Y",
                                       :default_level => Logger::FATAL
-    assert_equal "%Y", factory.default_format
+    assert_equal "%Y", factory.default_date_format
     assert_equal Logger::FATAL, factory.default_level
     factory.close
   end
@@ -105,7 +105,7 @@ class TC_Logger < Test::Unit::TestCase
     assert_equal "", io.message
 
     log.info "test"
-    assert_match( /INFO -- test.log1: test/, io.message )
+    assert_match( /\[INFO \] .* -- test.log1: test/, io.message )
 
     factory.close
     assert_equal "<closed>", io.message
@@ -123,9 +123,22 @@ class TC_Logger < Test::Unit::TestCase
     log = factory.get( "level.test.log1" )
 
     log.debug "test"
-    assert_match( /DEBUG -- level.test.log1: test/, io.message )
+    assert_match( /\[DEBUG\] .* -- level.test.log1: test/, io.message )
 
     factory.close
   end
 
+  def test_message_format
+    io = MockLogIO.new
+    factory = Copland::LogFactory.new :device => io,
+                :default_message_format => "%c %C [%-5p] %F %m %M %t %% %$"
+
+    log = factory.get( "message.log1" )
+    log.info "test"
+    assert_match(
+      /log1 message.log1 \[INFO \] \S*tc_logger.rb test test_message_format #{Thread.current.__id__} % #{$$}\n/,
+      io.message
+    )
+  end
+
 end

data/test/tc_package.rb

@@ -121,6 +121,31 @@ class TC_Package < Test::Unit::TestCase
     end
   end
 
+  def test_public_private
+    assert_equal 0, @package.service_points.length
+
+    point = MockServicePoint.new
+    point.visibility = :private
+    @package.add_service_point point
+
+    assert_equal 0, @package.service_point_count
+    assert_equal 1, @package.service_point_count(true)
+
+    assert_equal 0, @package.service_points.length
+    assert_equal 1, @package.service_points(true).length
+
+    assert_nil @package.service_point( "point" )
+    assert_not_nil @package.service_point( "point", true )
+
+    assert_raise( Copland::ServicePointNotFound ) do
+      @package.service( "point" )
+    end
+
+    assert_nothing_raised do
+      @package.service( "point", true )
+    end
+  end
+
   def test_configuration_points
     assert_equal 0, @package.configuration_points.length
 

data/test/tc_queryable-mutex.rb

@@ -0,0 +1,75 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+#     * Redistributions of source code must retain the above copyright notice,
+#       this list of conditions and the following disclaimer.
+# 
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+# 
+#     * The names of its contributors may not be used to endorse or promote
+#       products derived from this software without specific prior written
+#       permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+# =============================================================================
+#++
+
+$:.unshift "../lib"
+
+require 'test/unit'
+require 'copland/thread'
+
+class TC_QueryableMutex < Test::Unit::TestCase
+
+  def test_lock
+    mutex = Copland::QueryableMutex.new
+    assert !mutex.self_locked?
+    mutex.lock
+    assert mutex.self_locked?
+    mutex.unlock
+    assert !mutex.self_locked?
+  end
+
+  def test_reacquire_error
+    mutex = Copland::QueryableMutex.new
+    mutex.lock
+    assert_raise( ThreadError ) do 
+      mutex.lock
+    end
+  end
+
+  def test_safe_reacquire
+    mutex = Copland::QueryableMutex.new
+    mutex.lock
+
+    t = Thread.new do
+      assert mutex.locked?
+      assert !mutex.self_locked?
+      mutex.synchronize do
+        assert mutex.self_locked?
+      end
+    end
+
+    assert_nil t.join(0.1)
+    mutex.unlock
+    assert_not_nil t.join
+  end
+
+end