hrr_rb_netconf 0.1.1 → 0.2.0

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

@@ -9,15 +9,17 @@ module HrrRbNetconf
         DEPENDENCIES = []
         IF_FEATURES  = ['validate']
 
-        oper_proc('validate'){ |session, datastore, input_e|
-          datastore.run 'validate', input_e
-          '<ok />'
-        }
+        def define_capability
+          oper_proc('validate'){ |session, datastore, input_e|
+            datastore.run 'validate', input_e
+            '<ok />'
+          }
 
-        model 'validate',    ['source'],                             'container'
-        model 'validate',    ['source', 'config-source'],            'choice',   'mandatory' => true
-        model 'validate',    ['source', 'config-source', 'running'], 'leaf',     'type' => 'empty'
-        model 'validate',    ['source', 'config-source', 'config'],  'leaf',     'type' => 'anyxml'
+          model 'validate',    ['source'],                             'container'
+          model 'validate',    ['source', 'config-source'],            'choice',   'mandatory' => true
+          model 'validate',    ['source', 'config-source', 'running'], 'leaf',     'type' => 'empty'
+          model 'validate',    ['source', 'config-source', 'config'],  'leaf',     'type' => 'anyxml'
+        end
       end
     end
   end

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

@@ -9,16 +9,18 @@ module HrrRbNetconf
         DEPENDENCIES = []
         IF_FEATURES  = ['validate']
 
-        oper_proc('validate'){ |session, datastore, input_e|
-          datastore.run 'validate', input_e
-          '<ok />'
-        }
+        def define_capability
+          oper_proc('validate'){ |session, datastore, input_e|
+            datastore.run 'validate', input_e
+            '<ok />'
+          }
 
-        model 'edit-config', ['test-option'],                        'leaf',     'type' => 'enumeration', 'enum' => ['test-then-set', 'set', 'test-only'], 'default' => 'test-then-set'
-        model 'validate',    ['source'],                             'container'
-        model 'validate',    ['source', 'config-source'],            'choice',   'mandatory' => true
-        model 'validate',    ['source', 'config-source', 'running'], 'leaf',     'type' => 'empty'
-        model 'validate',    ['source', 'config-source', 'config'],  'leaf',     'type' => 'anyxml'
+          model 'edit-config', ['test-option'],                        'leaf',     'type' => 'enumeration', 'enum' => ['test-then-set', 'set', 'test-only'], 'default' => 'test-then-set'
+          model 'validate',    ['source'],                             'container'
+          model 'validate',    ['source', 'config-source'],            'choice',   'mandatory' => true
+          model 'validate',    ['source', 'config-source', 'running'], 'leaf',     'type' => 'empty'
+          model 'validate',    ['source', 'config-source', 'config'],  'leaf',     'type' => 'anyxml'
+        end
       end
     end
   end

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

@@ -9,8 +9,10 @@ module HrrRbNetconf
         DEPENDENCIES = []
         IF_FEATURES  = ['writable-running']
 
-        model 'edit-config', ['target', 'config-target', 'running'], 'leaf', 'type' => 'empty'
-        model 'copy-config', ['target', 'config-target', 'running'], 'leaf', 'type' => 'empty'
+        def define_capability
+          model 'edit-config', ['target', 'config-target', 'running'], 'leaf', 'type' => 'empty'
+          model 'copy-config', ['target', 'config-target', 'running'], 'leaf', 'type' => 'empty'
+        end
       end
     end
   end

data/lib/hrr_rb_netconf/server/capability.rb

@@ -2,10 +2,13 @@
 # vim: et ts=2 sw=2
 
 require 'uri'
+require 'hrr_rb_netconf/loggable'
 
 module HrrRbNetconf
   class Server
     class Capability
+      include Loggable
+
       @subclass_list = Array.new
 
       class << self
@@ -29,49 +32,32 @@ module HrrRbNetconf
         private :__subclass_list__
       end
 
-      class << self
-        def oper_procs
-          @oper_procs || {}
-        end
-
-        def oper_proc oper_name, &blk
-          @oper_procs ||= Hash.new
-          @oper_procs[oper_name] = blk
-        end
-
-        def models
-          @models || []
-        end
-
-        def model oper_name, path, stmt=nil, attrs={}
-          @models ||= Array.new
-          @models.push [oper_name, path, stmt, attrs]
-        end
-
-        private :oper_proc, :model
-      end
-
       attr_accessor :if_features, :dependencies, :queries
 
-      def initialize id=nil
+      def initialize id=nil, logger: nil
+        self.logger = logger
         @id           = id || self.class::ID
         @queries      = (self.class::QUERIES rescue {})
         @if_features  = (self.class::IF_FEATURES rescue [])
         @dependencies = (self.class::DEPENDENCIES rescue [])
-        @oper_procs   = self.class.oper_procs.dup
-        @models       = (self.class.models rescue [])
         @uri_proc     = Proc.new { |id| id.split('?').first }
         @keyword_proc = Proc.new { |id| id.split('?').first.match(/^((?:.+(?:\/|:))+.+)(?:\/|:)(.+)$/)[1] }
         @version_proc = Proc.new { |id| id.split('?').first.match(/^((?:.+(?:\/|:))+.+)(?:\/|:)(.+)$/)[2] }
         @decode_queries_proc = Proc.new { |qs_s| URI.decode_www_form(qs_s).inject({}){|a,(k,v)| a.merge({k=>(v.split(','))})} }
         @encode_queries_proc = Proc.new { |qs_h| URI.encode_www_form(qs_h.map{|k,v| [k, v.join(',')]}) }
+        define_capability
+      end
+
+      def define_capability
+        # to be overridden
       end
 
       def oper_procs
-        @oper_procs
+        @oper_procs || {}
       end
 
       def oper_proc oper_name, &blk
+        @oper_procs ||= Hash.new
         if blk
           @oper_procs[oper_name] = blk
         end
@@ -79,10 +65,11 @@ module HrrRbNetconf
       end
 
       def models
-        @models
+        @models || []
       end
 
       def model oper_name, path, stmt=nil, attrs={}
+        @models ||= Array.new
         @models.push [oper_name, path, stmt, attrs]
       end
 
@@ -188,6 +175,8 @@ module HrrRbNetconf
           version <=> other.version
         end
       end
+
+      private :oper_proc, :model
     end
   end
 end

data/lib/hrr_rb_netconf/server/datastore/oper_handler.rb

@@ -1,26 +1,28 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_netconf/logger'
+require 'hrr_rb_netconf/loggable'
 
 module HrrRbNetconf
   class Server
     class Datastore
       class OperHandler
-        def initialize
-          @logger = Logger.new self.class.name
+        include Loggable
+
+        def initialize logger: nil
+          self.logger = logger
         end
 
         def start *args
-          @logger.info { "Starting OperHandler" }
-          @logger.debug { "args: #{args.inspect}" }
+          log_info { "Starting OperHandler" }
+          log_debug { "args: #{args.inspect}" }
           @args = args
           Fiber.yield
-          @logger.info { "Exiting OperHandler" }
+          log_info { "Exiting OperHandler" }
         end
 
         def run oper, input
-          @logger.debug { "run with oper, input: #{oper.inspect}, #{input.inspect}" }
+          log_debug { "run with oper, input: #{oper.inspect}, #{input.inspect}" }
           oper.call(*(@args + [input]))
         end
       end

data/lib/hrr_rb_netconf/server/datastore/session.rb

@@ -1,22 +1,24 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_netconf/logger'
+require 'hrr_rb_netconf/loggable'
 require 'hrr_rb_netconf/server/datastore/oper_handler'
 
 module HrrRbNetconf
   class Server
     class Datastore
       class Session
-        def initialize database, oper_procs, session_proc, session
-          @logger = Logger.new self.class.name
+        include Loggable
+
+        def initialize database, oper_procs, session_proc, session, logger: nil
+          self.logger = logger
           @database = database
           @oper_procs = oper_procs
           @session_proc = session_proc
           @session = session
 
           if @session_proc
-            @oper_handler = OperHandler.new
+            @oper_handler = OperHandler.new logger: logger
             @oper_thread = Fiber.new do |session|
               @session_proc.call @database, session, @oper_handler
             end
@@ -38,7 +40,7 @@ module HrrRbNetconf
 
         def run oper_name, input
           unless @oper_procs.has_key? oper_name
-            raise Error['operation-not-supported'].new('protocol', 'error')
+            raise Error['operation-not-supported'].new('protocol', 'error', logger: logger)
           end
           if @oper_thread
             @oper_handler.run @oper_procs[oper_name], input

data/lib/hrr_rb_netconf/server/datastore.rb

@@ -1,14 +1,16 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_netconf/logger'
+require 'hrr_rb_netconf/loggable'
 require 'hrr_rb_netconf/server/datastore/session'
 
 module HrrRbNetconf
   class Server
     class Datastore
-      def initialize database, &blk
-        @logger = Logger.new self.class.name
+      include Loggable
+
+      def initialize database, logger: nil, &blk
+        self.logger = logger
         @database = database
         @oper_procs = Hash.new
         @session_proc = blk
@@ -17,13 +19,13 @@ module HrrRbNetconf
       def oper_proc oper_name, &oper_proc
         if oper_proc
           @oper_procs[oper_name] = oper_proc
-          @logger.info { "Operation registered: #{oper_name}" }
+          log_info { "Operation registered: #{oper_name}" }
         end
         @oper_procs[oper_name]
       end
 
       def new_session session
-        Session.new @database, @oper_procs, @session_proc, session
+        Session.new @database, @oper_procs, @session_proc, session, logger: logger
       end
     end
   end

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

@@ -2,13 +2,16 @@
 # vim: et ts=2 sw=2
 
 require 'rexml/document'
+require 'hrr_rb_netconf/loggable'
 
 module HrrRbNetconf
   class Server
-    class Error < StandardError
+    class Error
       module RpcErrorable
-        def initialize type, severity, info: nil, app_tag: nil, path: nil, message: nil
-          @logger   = Logger.new self.class.name
+        include Loggable
+
+        def initialize type, severity, info: nil, app_tag: nil, path: nil, message: nil, logger: nil
+          self.logger = logger
 
           @tag      = self.class::TAG
           @type     = type
@@ -76,10 +79,10 @@ module HrrRbNetconf
                 raise ArgumentError.new "error-message arg must contain \"value\" key if Hash"
               end
               unless @message.fetch('attributes', {}).keys.include?('xml:lang')
-                @logger.warn { "error-message arg does not contain \"xml:lang\" attribute, so assuming \"en\"" }
+                log_warn { "error-message arg does not contain \"xml:lang\" attribute, so assuming \"en\"" }
               end
             else
-              @logger.warn { "error-message arg does not contain \"xml:lang\" attribute, so assuming \"en\"" }
+              log_warn { "error-message arg does not contain \"xml:lang\" attribute, so assuming \"en\"" }
             end
           end
         end

data/lib/hrr_rb_netconf/server/model.rb

@@ -2,13 +2,17 @@
 # vim: et ts=2 sw=2
 
 require 'rexml/document'
+require 'hrr_rb_netconf/loggable'
 require 'hrr_rb_netconf/server/error'
 require 'hrr_rb_netconf/server/model/node'
 
 module HrrRbNetconf
   class Server
     class Model
-      def initialize operation
+      include Loggable
+
+      def initialize operation, logger: nil
+        self.logger = logger
         @operation = operation
         @tree = Node.new nil, operation, 'root', {}
       end
@@ -48,7 +52,7 @@ module HrrRbNetconf
                   if c.options['validation'].nil?
                     true
                   else
-                    raise Error['operation-failed'].new('application', 'error', message: 'Not implemented')
+                    raise Error['operation-failed'].new('application', 'error', message: 'Not implemented', logger: logger)
                   end
                 else
                   validate_recursively c, xml_e.elements[c.name], parent_xml_e: xml_e
@@ -56,7 +60,7 @@ module HrrRbNetconf
               when 'choice'
                 validate_recursively c, xml_e, validated: validated
               else
-                raise Error['unknown-element'].new('application', 'error', info: {'bad-element' => "#{c.name}: #{c.stmt}"}, message: 'Not implemented')
+                raise Error['unknown-element'].new('application', 'error', info: {'bad-element' => "#{c.name}: #{c.stmt}"}, message: 'Not implemented', logger: logger)
               end
             }
           end && (xml_e.elements.to_a.map{|e| e.name} - validated).empty?
@@ -74,7 +78,7 @@ module HrrRbNetconf
             xml_e != nil && (REXML::Document.new(xml_e.text) rescue false)
           when 'inet:uri'
             xml_e != nil
-            raise Error['unknown-element'].new('application', 'error', info: {'bad-element' => "#{node.name}: #{node.stmt}"}, message: 'Not implemented: type inet:uri')
+            raise Error['unknown-element'].new('application', 'error', info: {'bad-element' => "#{node.name}: #{node.stmt}"}, message: 'Not implemented: type inet:uri', logger: logger)
           when 'integer'
             if xml_e == nil && node.options['default']
               parent_xml_e.add_element(node.name).text = node.options['default']
@@ -111,7 +115,7 @@ module HrrRbNetconf
             }
           end
         else
-          raise Error['unknown-element'].new('application', 'error', info: {'bad-element' => "#{c.name}: #{c.stmt}"}, message: 'Not implemented')
+          raise Error['unknown-element'].new('application', 'error', info: {'bad-element' => "#{c.name}: #{c.stmt}"}, message: 'Not implemented', logger: logger)
         end
       end
 

data/lib/hrr_rb_netconf/server/notification_event.rb

@@ -2,7 +2,6 @@
 # vim: et ts=2 sw=2
 
 require 'hrr_rb_relaxed_xml'
-require 'hrr_rb_netconf/logger'
 
 module HrrRbNetconf
   class Server

data/lib/hrr_rb_netconf/server/notification_streams.rb

@@ -1,7 +1,6 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_netconf/logger'
 require 'hrr_rb_netconf/server/notification_stream'
 
 module HrrRbNetconf

data/lib/hrr_rb_netconf/server/operation.rb

@@ -1,15 +1,17 @@
 # coding: utf-8
 # vim: et ts=2 sw=2
 
-require 'hrr_rb_netconf/logger'
+require 'hrr_rb_netconf/loggable'
 require 'hrr_rb_netconf/server/model'
 require 'hrr_rb_netconf/server/filter'
 
 module HrrRbNetconf
   class Server
     class Operation
-      def initialize session, capabilities, datastore_session, strict_capabilities
-        @logger = Logger.new self.class.name
+      include Loggable
+
+      def initialize session, capabilities, datastore_session, strict_capabilities, logger: nil
+        self.logger = logger
         @session = session
         @capabilities = capabilities
         @datastore_session = datastore_session
@@ -22,14 +24,14 @@ module HrrRbNetconf
 
       def load_capabilities
         @capabilities.each_loadable{ |c|
-          @logger.debug { "Load capability: #{c.id}" }
+          log_debug { "Load capability: #{c.id}" }
           c.oper_procs.each{ |k, v|
             @oper_procs[k] = v
           }
           if @strict_capabilities
             c.models.each{ |m|
               oper_name, path, stmt, options = m
-              @models[oper_name] ||= Model.new oper_name
+              @models[oper_name] ||= Model.new oper_name, logger: logger
               @models[oper_name].add c, path, stmt, options
             }
           end
@@ -48,24 +50,24 @@ module HrrRbNetconf
 
       def run xml_doc
         unless xml_doc.root.name == 'rpc'
-          @logger.error { "Invalid root tag: must be rpc, but got #{xml_doc.root.name}" }
-          raise Error['operation-not-supported'].new('protocol', 'error')
+          log_error { "Invalid root tag: must be rpc, but got #{xml_doc.root.name}" }
+          raise Error['operation-not-supported'].new('protocol', 'error', logger: logger)
         end
 
         message_id = xml_doc.attributes['message-id']
         unless message_id
-          raise Error['missing-attribute'].new('rpc', 'error', info: {'bad-attribute' => 'message-id', 'bad-element' => 'rpc'})
+          raise Error['missing-attribute'].new('rpc', 'error', info: {'bad-attribute' => 'message-id', 'bad-element' => 'rpc'}, logger: logger)
         end
 
         input_e = xml_doc.elements[1]
 
         unless @oper_procs.has_key? input_e.name
-          raise Error['operation-not-supported'].new('protocol', 'error')
+          raise Error['operation-not-supported'].new('protocol', 'error', logger: logger)
         end
 
         if @strict_capabilities
           unless validate input_e
-            raise Error['operation-not-supported'].new('application', 'error')
+            raise Error['operation-not-supported'].new('application', 'error', logger: logger)
           end
         end