hrr_rb_netconf 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0feb4042406ce9043aa1f3f535da2ffbe4136197a28800f805e43860e43755a4
-  data.tar.gz: 8ec823251fe7a8c26223a7bc856b83263437833bf90938e6ff065ede68be97dd
+  metadata.gz: cc382a39772eb64eb2b49d6b2d2361f9f699b015f8905c48cff4ac04b06cb41a
+  data.tar.gz: 45196289a679e2a4ba86c08f721f01a538d6eeafa4741512bc1f97a3278b8173
 SHA512:
-  metadata.gz: 5755adcd86b0cb11c12e192542a10731dbfe3a00414bc901a652bd08a23b28bb1ba39a392f95a52b8c830c9132bc87b610e2381d1e01c9ceffd6c5009f136ce5
-  data.tar.gz: 7d72b95b3153cb54c28cfe808e24de5351a0c9327076b1b6dd1b1a8237a4ef29a9d1e456c0c9d9f5128d6fc1aae354b6956167516015d759855baa35d774a1ca
+  metadata.gz: 80d4339932ed79b121315f6cdcd1ee7b0c88cdc19f4eca8d682d9667fa4c0f4d163c282e6c73d63eb3cb895f8e1a9b2d189e79f4b398b0f7e3267ffe5e48c491
+  data.tar.gz: 8b9a3ae249db4bd51b93b84804aee99ad7fd64e827ff5146fc6d6ae04258c9173dd32a004b985a0de899ac0909837aef9a4a3b183d3764a92aceef3676e79b9c

data/demo/server.rb

@@ -14,9 +14,8 @@ end
 
 logger = Logger.new STDOUT
 logger.level = Logger::DEBUG
-HrrRbNetconf::Logger.initialize logger
 
-datastore = HrrRbNetconf::Server::Datastore.new('dummy'){ |db, session, oper_handler|
+datastore = HrrRbNetconf::Server::Datastore.new('dummy', logger: logger){ |db, session, oper_handler|
   begin
     logger.debug { "begin DB session" }
     oper_handler.start db
@@ -34,7 +33,7 @@ datastore.oper_proc('kill-session'){ |datastore, input_e|
   '<ok/>'
 }
 
-netconf_server = HrrRbNetconf::Server.new datastore
+netconf_server = HrrRbNetconf::Server.new datastore, logger: logger
 
 server = TCPServer.new 10830
 loop do

data/demo/server_over_ssh.rb

@@ -21,14 +21,12 @@ end
 
 
 logger = Logger.new STDOUT
-logger.level = Logger::INFO
 logger.level = Logger::DEBUG
-HrrRbNetconf::Logger.initialize logger
 
 
 db = '<root />'
 
-datastore = HrrRbNetconf::Server::Datastore.new(db)
+datastore = HrrRbNetconf::Server::Datastore.new(db, logger: logger)
 datastore.oper_proc('get'){ |db, input_e|
   db
 }
@@ -49,7 +47,7 @@ datastore.oper_proc('unlock'){ |db, input_e|
   # pass
 }
 
-netconf_server = HrrRbNetconf::Server.new datastore
+netconf_server = HrrRbNetconf::Server.new datastore, logger: logger
 
 
 auth_password = HrrRbSsh::Authentication::Authenticator.new { |context|
@@ -83,8 +81,8 @@ server = TCPServer.new 10830
 loop do
   Thread.new(server.accept) do |io|
     begin
-      ssh_server = HrrRbSsh::Server.new io, options
-      ssh_server.start
+      ssh_server = HrrRbSsh::Server.new options
+      ssh_server.start io
     rescue => e
       logger.error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
     ensure

data/demo/server_with_session-oriented-database.rb

@@ -69,14 +69,12 @@ end
 
 
 logger = Logger.new STDOUT
-logger.level = Logger::INFO
 logger.level = Logger::DEBUG
-HrrRbNetconf::Logger.initialize logger
 
 
 db = SessionOrientedDatabase.new
 
-datastore = HrrRbNetconf::Server::Datastore.new(db){ |db, session, oper_handler|
+datastore = HrrRbNetconf::Server::Datastore.new(db, logger: logger){ |db, session, oper_handler|
   begin
     logger.debug { "begin DB session" }
     db_session = db.new_session session.session_id
@@ -101,14 +99,14 @@ datastore.oper_proc('close-session'){ |db_session, dummy_arg, input_e|
   begin
     db_session.close
   rescue => e
-    raise HrrRbNetconf::Server::Error['operation-failed'].new('application', 'error', message: e.message)
+    raise HrrRbNetconf::Server::Error['operation-failed'].new('application', 'error', message: e.message, logger: logger)
   end
 }
 datastore.oper_proc('lock'){ |db_session, dummy_arg, input_e|
   begin
     db_session.lock
   rescue => e
-    raise HrrRbNetconf::Server::Error['resource-denied'].new('application', 'error', message: e.message)
+    raise HrrRbNetconf::Server::Error['resource-denied'].new('application', 'error', message: e.message, logger: logger)
   end
 }
 datastore.oper_proc('unlock'){ |db_session, dummy_arg, input_e|
@@ -117,7 +115,7 @@ datastore.oper_proc('unlock'){ |db_session, dummy_arg, input_e|
 
 
 server = TCPServer.new 10830
-netconf_server = HrrRbNetconf::Server.new datastore
+netconf_server = HrrRbNetconf::Server.new datastore, logger: logger
 loop do
   Thread.new(server.accept) do |io|
     begin

data/demo/server_with_sessionless-database.rb

@@ -34,14 +34,12 @@ end
 
 
 logger = Logger.new STDOUT
-logger.level = Logger::INFO
 logger.level = Logger::DEBUG
-HrrRbNetconf::Logger.initialize logger
 
 
 db = SessionlessDatabase.new
 
-datastore = HrrRbNetconf::Server::Datastore.new(db)
+datastore = HrrRbNetconf::Server::Datastore.new(db, logger: logger)
 datastore.oper_proc('get'){ |db, input_e|
   db.get
 }
@@ -64,7 +62,7 @@ datastore.oper_proc('unlock'){ |db, input_e|
 
 
 server = TCPServer.new 10830
-netconf_server = HrrRbNetconf::Server.new datastore
+netconf_server = HrrRbNetconf::Server.new datastore, logger: logger
 loop do
   Thread.new(server.accept) do |io|
     begin

data/lib/hrr_rb_netconf/loggable.rb

@@ -0,0 +1,42 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
+
+module HrrRbNetconf
+  module Loggable
+    attr_accessor :logger, :log_key
+
+    def log_fatal
+      if logger
+        logger.fatal(log_key){ yield }
+      end
+    end
+
+    def log_error
+      if logger
+        logger.error(log_key){ yield }
+      end
+    end
+
+    def log_warn
+      if logger
+        logger.warn(log_key){ yield }
+      end
+    end
+
+    def log_info
+      if logger
+        logger.info(log_key){ yield }
+      end
+    end
+
+    def log_debug
+      if logger
+        logger.debug(log_key){ yield }
+      end
+    end
+
+    def log_key
+      @log_key ||= self.class.to_s + "[%x]" % object_id
+    end
+  end
+end

data/lib/hrr_rb_netconf/server/capabilities.rb

@@ -2,15 +2,19 @@
 # vim: et ts=2 sw=2
 
 require 'tsort'
+require 'hrr_rb_netconf/loggable'
 require 'hrr_rb_netconf/server/capability'
 
 module HrrRbNetconf
   class Server
     class Capabilities
-      def initialize features=nil, capabilities_h=nil
+      include Loggable
+
+      def initialize features=nil, capabilities_h=nil, logger: nil
+        self.logger = logger
         @features = features
         unless capabilities_h
-          @caps = Capability.list.inject({}){ |a, b| a.merge({b => Capability[b].new}) }
+          @caps = Capability.list.inject({}){ |a, b| a.merge({b => Capability[b].new(logger: logger)}) }
         else
           @caps = capabilities_h
         end
@@ -26,11 +30,11 @@ module HrrRbNetconf
           a.merge({c.uri => c})
         }
         features = if @features.nil? then nil else @features.dup end
-        Capabilities.new features, capabilities_h
+        Capabilities.new features, capabilities_h, logger: logger
       end
 
       def register_capability name, &blk
-        cap = Capability.new(name)
+        cap = Capability.new name, logger: logger
         blk.call cap
         @caps[name] = cap
       end

data/lib/hrr_rb_netconf/server/capability/base_1_0.rb

@@ -2,7 +2,7 @@
 # vim: et ts=2 sw=2
 
 require 'rexml/document'
-require 'hrr_rb_netconf/logger'
+require 'hrr_rb_netconf/loggable'
 
 module HrrRbNetconf
   class Server
@@ -12,90 +12,94 @@ module HrrRbNetconf
         DEPENDENCIES = []
         IF_FEATURES  = []
 
-        oper_proc('get'){ |session, datastore, input_e|
-          datastore.run 'get', input_e
-        }
-
-        oper_proc('get-config'){ |session, datastore, input_e|
-          datastore.run 'get-config', input_e
-        }
-
-        oper_proc('edit-config'){ |session, datastore, input_e|
-          datastore.run 'edit-config', input_e
-          '<ok />'
-        }
-
-        oper_proc('copy-config'){ |session, datastore, input_e|
-          datastore.run 'copy-config', input_e
-          '<ok />'
-        }
-
-        oper_proc('delete-config'){ |session, datastore, input_e|
-          datastore.run 'delete-config', input_e
-          '<ok />'
-        }
-
-        oper_proc('lock'){ |session, datastore, input_e|
-          target = input_e.elements['target'].elements[1].name
-          session.lock target
-          begin
-            datastore.run 'lock', input_e
+        def define_capability
+          oper_proc('get'){ |session, datastore, input_e|
+            datastore.run 'get', input_e
+          }
+
+          oper_proc('get-config'){ |session, datastore, input_e|
+            datastore.run 'get-config', input_e
+          }
+
+          oper_proc('edit-config'){ |session, datastore, input_e|
+            datastore.run 'edit-config', input_e
+            '<ok />'
+          }
+
+          oper_proc('copy-config'){ |session, datastore, input_e|
+            datastore.run 'copy-config', input_e
+            '<ok />'
+          }
+
+          oper_proc('delete-config'){ |session, datastore, input_e|
+            datastore.run 'delete-config', input_e
             '<ok />'
-          rescue
+          }
+
+          oper_proc('lock'){ |session, datastore, input_e|
+            target = input_e.elements['target'].elements[1].name
+            session.lock target
+            begin
+              datastore.run 'lock', input_e
+              '<ok />'
+            rescue
+              session.unlock target
+              raise
+            end
+          }
+
+          oper_proc('unlock'){ |session, datastore, input_e|
+            datastore.run 'unlock', input_e
+            target = input_e.elements['target'].elements[1].name
             session.unlock target
-            raise
-          end
-        }
-
-        oper_proc('unlock'){ |session, datastore, input_e|
-          datastore.run 'unlock', input_e
-          target = input_e.elements['target'].elements[1].name
-          session.unlock target
-          '<ok />'
-        }
-
-        oper_proc('close-session'){ |session, datastore, input_e|
-          datastore.run 'close-session', input_e
-          session.close
-          '<ok />'
-        }
-
-        oper_proc('kill-session'){ |session, datastore, input_e|
-          session.close_other Integer(input_e.elements['session-id'].text)
-          '<ok />'
-        }
-
-        model 'get',           ['filter'],                             'leaf',     'type' => 'anyxml'
-        model 'get-config',    ['source'],                             'container'
-        model 'get-config',    ['source', 'config-source'],            'choice',   'mandatory' => true
-        model 'get-config',    ['source', 'config-source', 'running'], 'leaf',     'type' => 'empty'
-        model 'get-config',    ['filter'],                             'leaf',     'type' => 'anyxml'
-        model 'edit-config',   ['target'],                             'container'
-        model 'edit-config',   ['target', 'config-target'],            'choice',   'mandatory' => true
-        model 'edit-config',   ['default-operation'],                  'leaf',     'type' => 'enumeration', 'enum' => ['merge', 'replace', 'none'], 'default' => 'merge'
-        model 'edit-config',   ['error-option'],                       'leaf',     'type' => 'enumeration', 'enum' => ['stop-on-error', 'continue-on-error', 'rollback-on-error'], 'default' => 'stop-on-error'
-        model 'edit-config',   ['edit-content'],                       'choice',   'mandatory' => true
-        model 'edit-config',   ['edit-content', 'config'],             'leaf',     'type' => 'anyxml'
-        model 'copy-config',   ['target'],                             'container'
-        model 'copy-config',   ['target', 'config-target'],            'choice',   'mandatory' => true
-        model 'copy-config',   ['source'],                             'container'
-        model 'copy-config',   ['source', 'config-source'],            'choice',   'mandatory' => true
-        model 'copy-config',   ['source', 'config-source', 'running'], 'leaf',     'type' => 'empty'
-        model 'copy-config',   ['source', 'config-source', 'config'],  'leaf',     'type' => 'anyxml'
-        model 'delete-config', ['target'],                             'container'
-        model 'delete-config', ['target', 'config-target'],            'choice',   'mandatory' => true
-        model 'lock',          ['target'],                             'container'
-        model 'lock',          ['target', 'config-target'],            'choice',   'mandatory' => true
-        model 'lock',          ['target', 'config-target', 'running'], 'leaf',     'type' => 'empty'
-        model 'unlock',        ['target'],                             'container'
-        model 'unlock',        ['target', 'config-target'],            'choice',   'mandatory' => true
-        model 'unlock',        ['target', 'config-target', 'running'], 'leaf',     'type' => 'empty'
-        model 'close-session', []
-        model 'kill-session',  ['session-id'],                         'leaf',     'type' => 'integer', 'range' => [1, 2**32-1]
+            '<ok />'
+          }
+
+          oper_proc('close-session'){ |session, datastore, input_e|
+            datastore.run 'close-session', input_e
+            session.close
+            '<ok />'
+          }
+
+          oper_proc('kill-session'){ |session, datastore, input_e|
+            session.close_other Integer(input_e.elements['session-id'].text)
+            '<ok />'
+          }
+
+          model 'get',           ['filter'],                             'leaf',     'type' => 'anyxml'
+          model 'get-config',    ['source'],                             'container'
+          model 'get-config',    ['source', 'config-source'],            'choice',   'mandatory' => true
+          model 'get-config',    ['source', 'config-source', 'running'], 'leaf',     'type' => 'empty'
+          model 'get-config',    ['filter'],                             'leaf',     'type' => 'anyxml'
+          model 'edit-config',   ['target'],                             'container'
+          model 'edit-config',   ['target', 'config-target'],            'choice',   'mandatory' => true
+          model 'edit-config',   ['default-operation'],                  'leaf',     'type' => 'enumeration', 'enum' => ['merge', 'replace', 'none'], 'default' => 'merge'
+          model 'edit-config',   ['error-option'],                       'leaf',     'type' => 'enumeration', 'enum' => ['stop-on-error', 'continue-on-error', 'rollback-on-error'], 'default' => 'stop-on-error'
+          model 'edit-config',   ['edit-content'],                       'choice',   'mandatory' => true
+          model 'edit-config',   ['edit-content', 'config'],             'leaf',     'type' => 'anyxml'
+          model 'copy-config',   ['target'],                             'container'
+          model 'copy-config',   ['target', 'config-target'],            'choice',   'mandatory' => true
+          model 'copy-config',   ['source'],                             'container'
+          model 'copy-config',   ['source', 'config-source'],            'choice',   'mandatory' => true
+          model 'copy-config',   ['source', 'config-source', 'running'], 'leaf',     'type' => 'empty'
+          model 'copy-config',   ['source', 'config-source', 'config'],  'leaf',     'type' => 'anyxml'
+          model 'delete-config', ['target'],                             'container'
+          model 'delete-config', ['target', 'config-target'],            'choice',   'mandatory' => true
+          model 'lock',          ['target'],                             'container'
+          model 'lock',          ['target', 'config-target'],            'choice',   'mandatory' => true
+          model 'lock',          ['target', 'config-target', 'running'], 'leaf',     'type' => 'empty'
+          model 'unlock',        ['target'],                             'container'
+          model 'unlock',        ['target', 'config-target'],            'choice',   'mandatory' => true
+          model 'unlock',        ['target', 'config-target', 'running'], 'leaf',     'type' => 'empty'
+          model 'close-session', []
+          model 'kill-session',  ['session-id'],                         'leaf',     'type' => 'integer', 'range' => [1, 2**32-1]
+        end
 
         class Sender
-          def initialize io_w
-            @logger = Logger.new self.class.name
+          include Loggable
+
+          def initialize io_w, logger: nil
+            self.logger = logger
             @io_w = io_w
             @formatter = REXML::Formatters::Pretty.new(2)
             @formatter.compact = true
@@ -108,7 +112,7 @@ module HrrRbNetconf
               begin
                 @formatter.write(REXML::Document.new(msg, {:ignore_whitespace_nodes => :all}).root, buf)
               rescue => e
-                @logger.error { "Invalid sending message: #{msg.inspect}: #{e.message}" }
+                log_error { "Invalid sending message: #{msg.inspect}: #{e.message}" }
                 raise "Invalid sending message: #{msg.inspect}: #{e.message}"
               end
             when REXML::Document
@@ -116,22 +120,24 @@ module HrrRbNetconf
             when REXML::Element
               @formatter.write(msg, buf)
             else
-              @logger.error { "Unexpected sending message: #{msg.inspect}" }
+              log_error { "Unexpected sending message: #{msg.inspect}" }
               raise ArgumentError, "Unexpected sending message: #{msg.inspect}"
             end
-            @logger.debug { "Sending message: #{buf.inspect}" }
+            log_debug { "Sending message: #{buf.inspect}" }
             begin
               @io_w.write "#{buf}\n]]>]]>"
             rescue => e
-              @logger.info { "Sender IO closed: #{e.class}: #{e.message}" }
+              log_info { "Sender IO closed: #{e.class}: #{e.message}" }
               raise IOError, "Sender IO closed: #{e.class}: #{e.message}"
             end
           end
         end
 
         class Receiver
-          def initialize io_r
-            @logger = Logger.new self.class.name
+          include Loggable
+
+          def initialize io_r, logger: nil
+            self.logger = logger
             @io_r = io_r
           end
 
@@ -141,11 +147,11 @@ module HrrRbNetconf
               begin
                 tmp = @io_r.read(1)
               rescue => e
-                @logger.info { "Receiver IO closed: #{e.class}: #{e.message}" }
+                log_info { "Receiver IO closed: #{e.class}: #{e.message}" }
                 return nil
               end
               if tmp.nil?
-                @logger.info { "Receiver IO closed" }
+                log_info { "Receiver IO closed" }
                 return nil
               end
               buf += tmp
@@ -153,14 +159,14 @@ module HrrRbNetconf
                 break
               end
             end
-            @logger.debug { "Received message: #{buf[0..-7].inspect}" }
+            log_debug { "Received message: #{buf[0..-7].inspect}" }
             begin
               received_msg = REXML::Document.new(buf[0..-7], {:ignore_whitespace_nodes => :all}).root
               validate_received_msg received_msg
               received_msg
             rescue => e
               info = "Invalid received message: #{e.message.split("\n").first}: #{buf[0..-7].inspect}"
-              @logger.info { info }
+              log_info { info }
               raise info
             end
           end