hrr_rb_netconf 0.1.1 → 0.2.0

data/lib/hrr_rb_netconf/server/session.rb

@@ -7,17 +7,19 @@ require 'thread'
 require 'monitor'
 require 'rexml/document'
 require 'hrr_rb_relaxed_xml'
-require 'hrr_rb_netconf/logger'
+require 'hrr_rb_netconf/loggable'
 require 'hrr_rb_netconf/server/capability'
 require 'hrr_rb_netconf/server/operation'
 
 module HrrRbNetconf
   class Server
     class Session
+      include Loggable
+
       attr_reader :session_id
 
-      def initialize server, capabilities, datastore, session_id, io, strict_capabilities
-        @logger = Logger.new self.class.name
+      def initialize server, capabilities, datastore, session_id, io, strict_capabilities, logger: nil
+        self.logger = logger
         @server = server
         @local_capabilities = capabilities
         @remote_capabilities = Array.new
@@ -55,12 +57,12 @@ module HrrRbNetconf
       end
 
       def close
-        @logger.info { "Being closed" }
+        log_info { "Being closed" }
         @closed = true
         @io_r.close_read rescue nil
         @notification_replay_thread.exit if @notification_replay_thread rescue nil
         @notification_termination_thread.exit if @notification_termination_thread rescue nil
-        @logger.info { "Closed" }
+        log_info { "Closed" }
       end
 
       def closed?
@@ -73,7 +75,7 @@ module HrrRbNetconf
       end
 
       def send_hello
-        @logger.info { "Local capabilities: #{@local_capabilities}" }
+        log_info { "Local capabilities: #{@local_capabilities}" }
         xml_doc = REXML::Document.new
         hello_e = xml_doc.add_element 'hello'
         hello_e.add_namespace('urn:ietf:params:xml:ns:netconf:base:1.0')
@@ -89,7 +91,7 @@ module HrrRbNetconf
         formatter = REXML::Formatters::Pretty.new(2)
         formatter.compact = true
         formatter.write(xml_doc, buf)
-        @logger.debug { "Sending hello message: #{buf.inspect}" }
+        log_debug { "Sending hello message: #{buf.inspect}" }
         @io_w.write "#{buf}\n]]>]]>"
       end
 
@@ -101,31 +103,31 @@ module HrrRbNetconf
             break
           end
         end
-        @logger.debug { "Received hello message: #{buf[0..-7].inspect}" }
+        log_debug { "Received hello message: #{buf[0..-7].inspect}" }
         remote_capabilities_xml_doc = REXML::Document.new(buf[0..-7], {:ignore_whitespace_nodes => :all})
         remote_capabilities_xml_doc.each_element('/hello/capabilities/capability'){ |c| @remote_capabilities.push c.text }
-        @logger.info { "Remote capabilities: #{@remote_capabilities}" }
+        log_info { "Remote capabilities: #{@remote_capabilities}" }
       end
 
       def negotiate_capabilities
         @capabilities = @local_capabilities.negotiate @remote_capabilities
-        @logger.info { "Negotiated capabilities: #{@capabilities.list_loadable}" }
+        log_info { "Negotiated capabilities: #{@capabilities.list_loadable}" }
         unless @capabilities.list_loadable.any?{ |c| /^urn:ietf:params:netconf:base:\d+\.\d+$/ =~ c }
-          @logger.error { "No base NETCONF capability negotiated" }
+          log_error { "No base NETCONF capability negotiated" }
           raise  "No base NETCONF capability negotiated"
         end
       end
 
       def initialize_sender_and_receiver
         base_capability = @capabilities.list_loadable.select{ |c| /^urn:ietf:params:netconf:base:\d+\.\d+$/ =~ c }.sort.last
-        @logger.info { "Base NETCONF capability: #{base_capability}" }
-        @sender   = Capability[base_capability]::Sender.new   @io_w
-        @receiver = Capability[base_capability]::Receiver.new @io_r
+        log_info { "Base NETCONF capability: #{base_capability}" }
+        @sender   = Capability[base_capability]::Sender.new   @io_w, logger: logger
+        @receiver = Capability[base_capability]::Receiver.new @io_r, logger: logger
       end
 
       def operation_loop
         datastore_session = @datastore.new_session self
-        operation = Operation.new self, @capabilities, datastore_session, @strict_capabilities
+        operation = Operation.new self, @capabilities, datastore_session, @strict_capabilities, logger: logger
 
         begin
           loop do
@@ -138,7 +140,7 @@ module HrrRbNetconf
               rpc_reply_e.add_namespace("urn:ietf:params:xml:ns:netconf:base:1.0")
               rpc_reply_e.add e.to_rpc_error
             rescue => e
-              @logger.error { e.message }
+              log_error { e.message }
               raise
             end
             @monitor.synchronize do
@@ -149,7 +151,7 @@ module HrrRbNetconf
                 rpc_reply_e.name = "rpc-reply"
                 rpc_reply_e.add e.to_rpc_error
               rescue => e
-                @logger.error { e.message }
+                log_error { e.message }
                 raise
               ensure
                 begin
@@ -164,7 +166,7 @@ module HrrRbNetconf
           datastore_session.close rescue nil
           @io_w.close_write rescue nil
         end
-        @logger.info { "Exit operation_loop" }
+        log_info { "Exit operation_loop" }
       end
 
       def close_other session_id
@@ -180,38 +182,38 @@ module HrrRbNetconf
       end
 
       def subscription_creatable? stream
-        @logger.info { "Check subscription for stream: #{stream}" }
+        log_info { "Check subscription for stream: #{stream}" }
         if ! @server.has_notification_stream? stream
-          @logger.error { "Server doesn't have notification stream: #{stream}" }
+          log_error { "Server doesn't have notification stream: #{stream}" }
           false
         elsif @subscribed_streams.has_key? stream
-          @logger.error { "Session already has subscription for stream: #{stream}" }
+          log_error { "Session already has subscription for stream: #{stream}" }
           false
         else
-          @logger.info { "Subscription creatable for stream: #{stream}" }
+          log_info { "Subscription creatable for stream: #{stream}" }
           true
         end
       end
 
       def create_subscription stream, start_time, stop_time
-        @logger.info { "Create subscription for stream: #{stream}" }
+        log_info { "Create subscription for stream: #{stream}" }
         @subscribed_streams[stream] = true
         start_notification_termination_thread stream, start_time, stop_time if stop_time
-        @logger.info { "Create subscription done for stream: #{stream}" }
+        log_info { "Create subscription done for stream: #{stream}" }
       end
 
       def terminate_subscription stream
-        @logger.info { "Terminate subscription for stream: #{stream}" }
+        log_info { "Terminate subscription for stream: #{stream}" }
         @subscribed_streams.delete stream
-        @logger.info { "Terminate subscription done for stream: #{stream}" }
+        log_info { "Terminate subscription done for stream: #{stream}" }
       end
 
       def notification_replay stream, start_time, stop_time, events
         if @server.notification_stream_support_replay? stream
           start_notification_replay_thread stream, start_time, stop_time, events
         else
-          @logger.error { "Notification replay is not supported by stream: #{stream}" }
-          raise Error['operation-failed'].new('protocol', 'error')
+          log_error { "Notification replay is not supported by stream: #{stream}" }
+          raise Error['operation-failed'].new('protocol', 'error', logger: logger)
         end
       end
 
@@ -221,11 +223,11 @@ module HrrRbNetconf
 
       def start_notification_replay_thread stream, start_time, stop_time, events
         @notification_replay_thread = Thread.new do
-          @logger.info { "Notification replay start for stream: #{stream}" }
+          log_info { "Notification replay start for stream: #{stream}" }
           begin
             @monitor.synchronize do
               unless events.respond_to? :each
-                @logger.error { "Argument `events' doesn't respond to :each method: #{events}" }
+                log_error { "Argument `events' doesn't respond to :each method: #{events}" }
               else
                 begin
                   events.each{ |arg1, arg2|
@@ -242,29 +244,29 @@ module HrrRbNetconf
                     end
                   }
                 rescue => e
-                  @logger.error { "Got an exception during processing replay: #{e.message}" }
+                  log_error { "Got an exception during processing replay: #{e.message}" }
                 end
               end
               send_replay_complete stream
             end
           ensure
-            @logger.info { "Notification replay completed for stream: #{stream}" }
+            log_info { "Notification replay completed for stream: #{stream}" }
           end
         end
       end
 
       def start_notification_termination_thread stream, start_time, stop_time
         @notification_termination_thread = Thread.new do
-          @logger.info { "Notification termination thread start for stream: #{stream}" }
+          log_info { "Notification termination thread start for stream: #{stream}" }
           begin
             loop do
               now = DateTime.now
               if now.to_time < stop_time.to_time
                 sleep_time = ((stop_time.to_time - now.to_time) / 2.0).ceil
-                @logger.debug { "Notification termination thread for stream: #{stream}: sleep [sec]: #{sleep_time}" }
+                log_debug { "Notification termination thread for stream: #{stream}: sleep [sec]: #{sleep_time}" }
                 sleep sleep_time
               else
-                @logger.info { "Notification termination thread terminates subscription for stream: #{stream}" }
+                log_info { "Notification termination thread terminates subscription for stream: #{stream}" }
                 @monitor.synchronize do
                   terminate_subscription stream
                   send_notification_complete stream
@@ -273,7 +275,7 @@ module HrrRbNetconf
               end
             end
           ensure
-            @logger.info { "Notification termination completed for stream: #{stream}" }
+            log_info { "Notification termination completed for stream: #{stream}" }
           end
         end
       end
@@ -288,7 +290,7 @@ module HrrRbNetconf
           begin
             @sender.send_message notif_e
           rescue IOError => e
-            @logger.warn { "Failed sending notification: #{e.message}" }
+            log_warn { "Failed sending notification: #{e.message}" }
           end
         end
       end

data/lib/hrr_rb_netconf/server.rb

@@ -4,7 +4,7 @@
 require 'date'
 require 'thread'
 require 'hrr_rb_relaxed_xml'
-require 'hrr_rb_netconf/logger'
+require 'hrr_rb_netconf/loggable'
 require 'hrr_rb_netconf/server/error'
 require 'hrr_rb_netconf/server/errors'
 require 'hrr_rb_netconf/server/datastore'
@@ -15,15 +15,17 @@ require 'hrr_rb_netconf/server/notification_streams'
 
 module HrrRbNetconf
   class Server
+    include Loggable
+
     SESSION_ID_UNALLOCATED = "UNALLOCATED"
     SESSION_ID_MIN = 1
     SESSION_ID_MAX = 2**32 - 1
     SESSION_ID_MODULO = SESSION_ID_MAX - SESSION_ID_MIN + 1
 
-    def initialize datastore, capabilities: nil, strict_capabilities: false
-      @logger = Logger.new self.class.name
+    def initialize datastore, capabilities: nil, strict_capabilities: false, logger: nil
+      self.logger = logger
       @datastore = datastore
-      @capabilities = capabilities || Capabilities.new
+      @capabilities = capabilities || Capabilities.new(logger: logger)
       @strict_capabilities = strict_capabilities
       @mutex = Mutex.new
       @sessions = Hash.new
@@ -36,7 +38,7 @@ module HrrRbNetconf
     def allocate_session_id
       session_id = (SESSION_ID_MODULO).times.lazy.map{ |idx| (@last_session_id + 1 + idx - SESSION_ID_MIN) % SESSION_ID_MODULO + SESSION_ID_MIN }.reject{ |sid| @sessions.has_key? sid }.first
       unless session_id
-        @logger.error { "Failed allocating Session ID" }
+        log_error { "Failed allocating Session ID" }
         raise "Failed allocating Session ID"
       end
       @last_session_id = session_id
@@ -49,20 +51,20 @@ module HrrRbNetconf
     end
 
     def start_session io
-      @logger.info { "Start session" }
+      log_info { "Start session" }
       session_id = SESSION_ID_UNALLOCATED
       begin
         @mutex.synchronize do
           session_id = allocate_session_id
-          @logger.info { "Session ID: #{session_id}" }
-          @sessions[session_id] = Session.new self, @capabilities, @datastore, session_id, io, @strict_capabilities
+          log_info { "Session ID: #{session_id}" }
+          @sessions[session_id] = Session.new self, @capabilities, @datastore, session_id, io, @strict_capabilities, logger: logger
         end
         @sessions[session_id].start
       rescue => e
-        @logger.error { "Session terminated: Session ID: #{session_id}" }
+        log_error { "Session terminated: Session ID: #{session_id}" }
         raise
       else
-        @logger.info { "Session closed: Session ID: #{session_id}" }
+        log_info { "Session closed: Session ID: #{session_id}" }
       ensure
         @lock_mutex.synchronize do
           @locks.delete_if{ |tgt, sid| sid == session_id }
@@ -74,16 +76,16 @@ module HrrRbNetconf
     end
 
     def close_session session_id
-      @logger.info { "Close session: Session ID: #{session_id}" }
+      log_info { "Close session: Session ID: #{session_id}" }
       @sessions[session_id].close
     end
 
     def lock target, session_id
-      @logger.info { "Lock: Target: #{target}, Session ID: #{session_id}" }
+      log_info { "Lock: Target: #{target}, Session ID: #{session_id}" }
       @lock_mutex.synchronize do
         if @locks.has_key? target
-          @logger.info { "Lock failed, lock is already held by session-id: #{@locks[target]}" }
-          raise Error['lock-denied'].new('protocol', 'error', info: {'session-id' => @locks[target].to_s}, message: 'Lock failed, lock is already held')
+          log_info { "Lock failed, lock is already held by session-id: #{@locks[target]}" }
+          raise Error['lock-denied'].new('protocol', 'error', info: {'session-id' => @locks[target].to_s}, message: 'Lock failed, lock is already held', logger: logger)
         else
           @locks[target] = session_id
         end
@@ -91,18 +93,18 @@ module HrrRbNetconf
     end
 
     def unlock target, session_id
-      @logger.info { "Unlock: Target: #{target}, Session ID: #{session_id}" }
+      log_info { "Unlock: Target: #{target}, Session ID: #{session_id}" }
       @lock_mutex.synchronize do
         if @locks.has_key? target
           if @locks[target] == session_id
             @locks.delete target
           else
-            @logger.info { "Unlock failed, lock is held by session-id: #{@locks[target]}" }
-            raise Error['operation-failed'].new('protocol', 'error')
+            log_info { "Unlock failed, lock is held by session-id: #{@locks[target]}" }
+            raise Error['operation-failed'].new('protocol', 'error', logger: logger)
           end
         else
-          @logger.info { "Unlock failed, lock is not held" }
-          raise Error['operation-failed'].new('protocol', 'error')
+          log_info { "Unlock failed, lock is not held" }
+          raise Error['operation-failed'].new('protocol', 'error', logger: logger)
         end
       end
     end
@@ -126,12 +128,12 @@ module HrrRbNetconf
     def send_notification arg1, arg2=nil
       event_xml = NotificationEvent.new(arg1, arg2).to_xml
       matched_streams = @notification_streams.matched_streams event_xml
-      @logger.info { "Send notification" }
-      @logger.debug { "Event time: #{event_xml.elements['eventTime'].text}, Event: #{event_xml.elements.to_a}" }
+      log_info { "Send notification" }
+      log_debug { "Event time: #{event_xml.elements['eventTime'].text}, Event: #{event_xml.elements.to_a}" }
       @sessions.each{ |session_id, session|
         session.filter_and_send_notification matched_streams, event_xml
       }
-      @logger.info { "Send notification done" }
+      log_info { "Send notification done" }
     end
   end
 end

data/lib/hrr_rb_netconf/version.rb

@@ -2,5 +2,5 @@
 # vim: et ts=2 sw=2
 
 module HrrRbNetconf
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/hrr_rb_netconf.rb

@@ -2,7 +2,6 @@
 # vim: et ts=2 sw=2
 
 require "hrr_rb_netconf/version"
-require "hrr_rb_netconf/logger"
 require "hrr_rb_netconf/server"
 
 module HrrRbNetconf

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hrr_rb_netconf
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - hirura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-09 00:00:00.000000000 Z
+date: 2020-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hrr_rb_relaxed_xml
@@ -87,7 +87,7 @@ files:
 - demo/server_with_sessionless-database.rb
 - hrr_rb_netconf.gemspec
 - lib/hrr_rb_netconf.rb
-- lib/hrr_rb_netconf/logger.rb
+- lib/hrr_rb_netconf/loggable.rb
 - lib/hrr_rb_netconf/server.rb
 - lib/hrr_rb_netconf/server/capabilities.rb
 - lib/hrr_rb_netconf/server/capability.rb

data/lib/hrr_rb_netconf/logger.rb

@@ -1,56 +0,0 @@
-# coding: utf-8
-# vim: et ts=2 sw=2
-
-module HrrRbNetconf
-  class Logger
-    @@logger = nil
-
-    class << self
-      def initialize logger
-        @@logger = logger
-      end
-
-      def uninitialize
-        @@logger = nil
-      end
-
-      def initialized?
-        @@logger != nil
-      end
-    end
-
-    def initialize name
-      @name = name
-    end
-
-    def fatal
-      if @@logger
-        @@logger.fatal { "p#{Process.pid}.t#{Thread.current.object_id}: #{@name}: #{yield}" }
-      end
-    end
-
-    def error
-      if @@logger
-        @@logger.error { "p#{Process.pid}.t#{Thread.current.object_id}: #{@name}: #{yield}" }
-      end
-    end
-
-    def warn
-      if @@logger
-        @@logger.warn { "p#{Process.pid}.t#{Thread.current.object_id}: #{@name}: #{yield}" }
-      end
-    end
-
-    def info
-      if @@logger
-        @@logger.info { "p#{Process.pid}.t#{Thread.current.object_id}: #{@name}: #{yield}" }
-      end
-    end
-
-    def debug
-      if @@logger
-        @@logger.debug { "p#{Process.pid}.t#{Thread.current.object_id}: #{@name}: #{yield}" }
-      end
-    end
-  end
-end