hrr_rb_netconf 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc382a39772eb64eb2b49d6b2d2361f9f699b015f8905c48cff4ac04b06cb41a
-  data.tar.gz: 45196289a679e2a4ba86c08f721f01a538d6eeafa4741512bc1f97a3278b8173
+  metadata.gz: fd342f37e0e13f7459c4de78725b3ef7ede91625be95a97149ac380e3074d458
+  data.tar.gz: d93a52b7e3b511f2724d8fcc8b2021713800f301a68d8cb44fdc196f6cd0a5b3
 SHA512:
-  metadata.gz: 80d4339932ed79b121315f6cdcd1ee7b0c88cdc19f4eca8d682d9667fa4c0f4d163c282e6c73d63eb3cb895f8e1a9b2d189e79f4b398b0f7e3267ffe5e48c491
-  data.tar.gz: 8b9a3ae249db4bd51b93b84804aee99ad7fd64e827ff5146fc6d6ae04258c9173dd32a004b985a0de899ac0909837aef9a4a3b183d3764a92aceef3676e79b9c
+  metadata.gz: 499d26b160c49904e7f6b9e6cbde6952e273c3f238bb55f8f48c2fa36620a2e7f32e8bd30677441652713321b494a30bcae86df85b8494a40be2e4a56a7b0b40
+  data.tar.gz: 78f35c4f9fb0fee405b7546558997ae20ae037876328792cd3b0bea49afc12c8d8a938371db8fe2a807698cc885ca98e262884b3d6017db1ecd74f5672cb9e14

data/.gitignore

@@ -22,7 +22,4 @@ Gemfile.lock
 .ruby-gemset
 
 # additional
-.DS_Store
-*~
-*.swp
 /yang/

data/README.md

@@ -71,25 +71,27 @@ Where, the `datastore` variable is an instance of `HrrRbNetconf::Server::Datasto
 
 #### Logging
 
-The library provides logging functionality. To enable logging of the library, initialize `HrrRbNetconf::Logger` class.
+The library provides logging functionality. To enable logging in the library, give a `logger` to `Server.new`.
 
 ```ruby
-HrrRbNetconf::Logger.initialize logger
+HrrRbNetconf::Server.new datastore, logger: logger
 ```
 
-Where, the `logger` variable can be an instance of standard Logger class or user-defined logger class. What `HrrRbNetconf::Logger` class requires for `logger` variable is that the `logger` instance responds to `#fatal`, `#error`, `#warn`, `#info` and `#debug`.
-
-For instance, `logger` variable can be prepared like below.
+Where, the `logger` variable can be an instance of standard Logger class or user-defined logger class. What the library requires for `logger` variable is that the `logger` instance responds to `#fatal`, `#error`, `#warn`, `#info` and `#debug` with the following syntax.
 
 ```ruby
-logger = Logger.new STDOUT
-logger.level = Logger::INFO
+logger.fatal(progname){ message }
+logger.error(progname){ message }
+logger.warn(progname){ message }
+logger.info(progname){ message }
+logger.debug(progname){ message }
 ```
 
-To disable logging, you can un-initialize `HrrRbNetconf::Logger`.
+For instance, `logger` variable can be prepared like below.
 
 ```ruby
-HrrRbNetconf::Logger.uninitialize
+logger = Logger.new STDOUT
+logger.level = Logger::INFO
 ```
 
 #### Handling datastore operations
@@ -220,7 +222,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/hirura
 
 ## Code of Conduct
 
-Everyone interacting in the HrrRbNetconf project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hirura/hrr_rb_netconf/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the HrrRbNetconf project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hirura/hrr_rb_netconf/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/demo/server.rb

@@ -12,8 +12,16 @@ rescue LoadError
 end
 
 
+class MyLoggerFormatter < ::Logger::Formatter
+  def call severity, time, progname, msg
+    "%s, [%s#%d.%x] %5s -- %s: %s\n" % [severity[0..0], format_datetime(time), Process.pid, Thread.current.object_id, severity, progname, msg2str(msg)]
+  end
+end
+
+
 logger = Logger.new STDOUT
 logger.level = Logger::DEBUG
+logger.formatter = MyLoggerFormatter.new
 
 datastore = HrrRbNetconf::Server::Datastore.new('dummy', logger: logger){ |db, session, oper_handler|
   begin

data/demo/server_over_ssh.rb

@@ -20,8 +20,16 @@ rescue LoadError
 end
 
 
+class MyLoggerFormatter < ::Logger::Formatter
+  def call severity, time, progname, msg
+    "%s, [%s#%d.%x] %5s -- %s: %s\n" % [severity[0..0], format_datetime(time), Process.pid, Thread.current.object_id, severity, progname, msg2str(msg)]
+  end
+end
+
+
 logger = Logger.new STDOUT
 logger.level = Logger::DEBUG
+logger.formatter = MyLoggerFormatter.new
 
 
 db = '<root />'

data/demo/server_with_session-oriented-database.rb

@@ -68,8 +68,16 @@ class SessionOrientedDatabase
 end
 
 
+class MyLoggerFormatter < ::Logger::Formatter
+  def call severity, time, progname, msg
+    "%s, [%s#%d.%x] %5s -- %s: %s\n" % [severity[0..0], format_datetime(time), Process.pid, Thread.current.object_id, severity, progname, msg2str(msg)]
+  end
+end
+
+
 logger = Logger.new STDOUT
 logger.level = Logger::DEBUG
+logger.formatter = MyLoggerFormatter.new
 
 
 db = SessionOrientedDatabase.new

data/demo/server_with_sessionless-database.rb

@@ -33,8 +33,16 @@ class SessionlessDatabase
 end
 
 
+class MyLoggerFormatter < ::Logger::Formatter
+  def call severity, time, progname, msg
+    "%s, [%s#%d.%x] %5s -- %s: %s\n" % [severity[0..0], format_datetime(time), Process.pid, Thread.current.object_id, severity, progname, msg2str(msg)]
+  end
+end
+
+
 logger = Logger.new STDOUT
 logger.level = Logger::DEBUG
+logger.formatter = MyLoggerFormatter.new
 
 
 db = SessionlessDatabase.new

data/lib/hrr_rb_netconf/server.rb

@@ -22,11 +22,12 @@ module HrrRbNetconf
     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: nil
+    def initialize datastore, capabilities: nil, strict_capabilities: false, enable_filter: true, logger: nil
       self.logger = logger
       @datastore = datastore
       @capabilities = capabilities || Capabilities.new(logger: logger)
       @strict_capabilities = strict_capabilities
+      @enable_filter = enable_filter
       @mutex = Mutex.new
       @sessions = Hash.new
       @locks = Hash.new
@@ -57,14 +58,11 @@ module HrrRbNetconf
         @mutex.synchronize do
           session_id = allocate_session_id
           log_info { "Session ID: #{session_id}" }
-          @sessions[session_id] = Session.new self, @capabilities, @datastore, session_id, io, @strict_capabilities, logger: logger
+          @sessions[session_id] = Session.new self, @capabilities, @datastore, session_id, io, @strict_capabilities, @enable_filter, logger: logger
         end
         @sessions[session_id].start
       rescue => e
-        log_error { "Session terminated: Session ID: #{session_id}" }
-        raise
-      else
-        log_info { "Session closed: Session ID: #{session_id}" }
+        log_error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
       ensure
         @lock_mutex.synchronize do
           @locks.delete_if{ |tgt, sid| sid == session_id }
@@ -72,6 +70,7 @@ module HrrRbNetconf
         @mutex.synchronize do
           delete_session session_id
         end
+        log_info { "Session closed: Session ID: #{session_id}" }
       end
     end
 

data/lib/hrr_rb_netconf/server/error/rpc_errorable.rb

@@ -50,7 +50,7 @@ module HrrRbNetconf
             unless @info.kind_of? Hash
               raise ArgumentError.new "error-info arg must be a kind of Hash, but given #{@info.class}"
             end
-            unless self.class::INFO.all?{ |e| @info[e] }
+            unless self.class::INFO.all?{ |k| @info.has_key? k }
               raise ArgumentError.new "error-info arg must contain #{self.class::INFO} as keys, but given #{@info}"
             end
           end

data/lib/hrr_rb_netconf/server/filter.rb

@@ -27,7 +27,7 @@ module HrrRbNetconf
         def filter raw_output_e, input_e
           filter_e = input_e.elements['filter']
           if filter_e
-            filter_type = filter_e.attributes['type']
+            filter_type = filter_e.attributes['type'] || 'subtree'
             if self[filter_type]
               self[filter_type].filter raw_output_e, filter_e
             else

data/lib/hrr_rb_netconf/server/operation.rb

@@ -10,12 +10,13 @@ module HrrRbNetconf
     class Operation
       include Loggable
 
-      def initialize session, capabilities, datastore_session, strict_capabilities, logger: nil
+      def initialize session, capabilities, datastore_session, strict_capabilities, enable_filter, logger: nil
         self.logger = logger
         @session = session
         @capabilities = capabilities
         @datastore_session = datastore_session
         @strict_capabilities = strict_capabilities
+        @enable_filter = enable_filter
         @models = Hash.new
         @oper_procs = Hash.new
 
@@ -83,7 +84,11 @@ module HrrRbNetconf
                        else
                          raise "Unexpected output: #{raw_output.inspect}"
                        end
-        output_e = Filter.filter(raw_output_e, input_e)
+        if @enable_filter
+          output_e = Filter.filter(raw_output_e, input_e)
+        else
+          output_e = raw_output_e
+        end
         rpc_reply_e = xml_doc.clone
         rpc_reply_e.name = "rpc-reply"
         rpc_reply_e.add output_e

data/lib/hrr_rb_netconf/server/session.rb

@@ -18,7 +18,7 @@ module HrrRbNetconf
 
       attr_reader :session_id
 
-      def initialize server, capabilities, datastore, session_id, io, strict_capabilities, logger: nil
+      def initialize server, capabilities, datastore, session_id, io, strict_capabilities, enable_filter, logger: nil
         self.logger = logger
         @server = server
         @local_capabilities = capabilities
@@ -34,6 +34,7 @@ module HrrRbNetconf
                          raise ArgumentError, "io must be an instance of IO or Array"
                        end
         @strict_capabilities = strict_capabilities
+        @enable_filter = enable_filter
         @closed = false
         @notification_enabled = false
         @monitor = Monitor.new
@@ -127,7 +128,7 @@ module HrrRbNetconf
 
       def operation_loop
         datastore_session = @datastore.new_session self
-        operation = Operation.new self, @capabilities, datastore_session, @strict_capabilities, logger: logger
+        operation = Operation.new self, @capabilities, datastore_session, @strict_capabilities, @enable_filter, logger: logger
 
         begin
           loop do
@@ -140,7 +141,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
-              log_error { e.message }
+              log_error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
               raise
             end
             @monitor.synchronize do
@@ -151,7 +152,7 @@ module HrrRbNetconf
                 rpc_reply_e.name = "rpc-reply"
                 rpc_reply_e.add e.to_rpc_error
               rescue => e
-                log_error { e.message }
+                log_error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
                 raise
               ensure
                 begin

data/lib/hrr_rb_netconf/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hrr_rb_netconf
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - hirura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-11 00:00:00.000000000 Z
+date: 2020-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hrr_rb_relaxed_xml