hrr_rb_netconf 0.1.0

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/demo/server.rb

@@ -0,0 +1,54 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
+
+require 'socket'
+require 'logger'
+
+begin
+  require 'hrr_rb_netconf'
+rescue LoadError
+  $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+  require 'hrr_rb_netconf'
+end
+
+
+logger = Logger.new STDOUT
+logger.level = Logger::DEBUG
+HrrRbNetconf::Logger.initialize logger
+
+datastore = HrrRbNetconf::Server::Datastore.new('dummy'){ |db, session, oper_handler|
+  begin
+    logger.debug { "begin DB session" }
+    oper_handler.start db
+  ensure
+    logger.debug { "close DB in ensure" }
+  end
+}
+datastore.oper_proc('get'){ |datastore, input_e|
+  '<a xmlns="dummy"><b/></a>'
+}
+datastore.oper_proc('close-session'){ |datastore, input_e|
+  '<ok/>'
+}
+datastore.oper_proc('kill-session'){ |datastore, input_e|
+  '<ok/>'
+}
+
+netconf_server = HrrRbNetconf::Server.new datastore
+
+server = TCPServer.new 10830
+loop do
+  Thread.new(server.accept) do |io|
+    begin
+      netconf_server.start_session 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
+      begin
+        io.close
+      rescue => e
+        logger.error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
+      end
+    end
+  end
+end

data/demo/server_over_ssh.rb

@@ -0,0 +1,97 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
+
+require 'socket'
+require 'logger'
+require 'rexml/document'
+
+begin
+  require 'hrr_rb_ssh'
+rescue LoadError
+  STDERR.puts "Faild require 'hrr_rb_ssh' gem. Please install it with 'gem install hrr_rb_ssh'."
+  exit(1)
+end
+
+begin
+  require 'hrr_rb_netconf'
+rescue LoadError
+  $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+  require 'hrr_rb_netconf'
+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.oper_proc('get'){ |db, input_e|
+  db
+}
+datastore.oper_proc('get-config'){ |db, input_e|
+  db
+}
+datastore.oper_proc('edit-config'){ |db, input_e|
+  config_e = input_e.elements['config'].elements[1].to_s
+  db = config_e
+}
+datastore.oper_proc('close-session'){ |db, input_e|
+  # pass
+}
+datastore.oper_proc('lock'){ |db, input_e|
+  # pass
+}
+datastore.oper_proc('unlock'){ |db, input_e|
+  # pass
+}
+
+netconf_server = HrrRbNetconf::Server.new datastore
+
+
+auth_password = HrrRbSsh::Authentication::Authenticator.new { |context|
+  true # accept any user and password
+}
+conn_subsys = HrrRbSsh::Connection::RequestHandler.new { |context|
+  context.chain_proc { |chain|
+    case context.subsystem_name
+    when 'netconf'
+      begin
+        netconf_server.start_session context.io
+        exitstatus = 0
+      rescue => e
+        logger.error([e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join)
+        exitstatus = 1
+      end
+    else
+      exitstatus = 0
+    end
+    exitstatus
+  }
+}
+
+options = {}
+options['authentication_password_authenticator'] = auth_password
+options['connection_channel_request_subsystem']  = conn_subsys
+
+
+
+server = TCPServer.new 10830
+loop do
+  Thread.new(server.accept) do |io|
+    begin
+      ssh_server = HrrRbSsh::Server.new io, options
+      ssh_server.start
+    rescue => e
+      logger.error { [e.backtrace[0], ": ", e.message, " (", e.class.to_s, ")\n\t", e.backtrace[1..-1].join("\n\t")].join }
+    ensure
+      begin
+        io.close
+      rescue
+      end
+    end
+  end
+end

data/demo/server_with_session-oriented-database.rb

@@ -0,0 +1,134 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
+
+require 'socket'
+require 'logger'
+require 'rexml/document'
+
+begin
+  require 'hrr_rb_netconf'
+rescue LoadError
+  $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+  require 'hrr_rb_netconf'
+end
+
+class SessionOrientedDatabase
+  class DatabaseSession
+    def initialize db, session_id
+      @db = db
+      @session_id = session_id
+    end
+
+    def lock
+      # Dummy method
+    end
+
+    def unlock
+      # Dummy method
+    end
+
+    def close
+      # Dummy method
+    end
+
+    def get
+      @db.get
+    end
+
+    def get_config
+      @db.get_config
+    end
+
+    def edit input_e
+      @db.edit input_e
+    end
+  end
+
+  def initialize
+    @xml_doc = REXML::Document.new('<original />')
+    @content = ''
+  end
+
+  def new_session session_id
+    DatabaseSession.new self, session_id
+  end
+
+  def get
+    @xml_doc.root.deep_clone
+  end
+
+  def get_config
+    @xml_doc.root.deep_clone
+  end
+
+  def edit input_e
+    @xml_doc = REXML::Document.new
+    @xml_doc.add input_e
+  end
+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|
+  begin
+    logger.debug { "begin DB session" }
+    db_session = db.new_session session.session_id
+    dummy_arg = 'dummy_arg'
+    oper_handler.start db_session, dummy_arg
+  ensure
+    logger.debug { "close DB in ensure" }
+    db_session.close rescue nil
+  end
+}
+datastore.oper_proc('get'){ |db_session, dummy_arg, input_e|
+  db_session.get
+}
+datastore.oper_proc('get-config'){ |db_session, dummy_arg, input_e|
+  db_session.get_config
+}
+datastore.oper_proc('edit-config'){ |db_session, dummy_arg, input_e|
+  config_e = input_e.elements['config'].elements[1]
+  db_session.edit config_e
+}
+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)
+  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)
+  end
+}
+datastore.oper_proc('unlock'){ |db_session, dummy_arg, input_e|
+  db_session.unlock rescue nil
+}
+
+
+server = TCPServer.new 10830
+netconf_server = HrrRbNetconf::Server.new datastore
+loop do
+  Thread.new(server.accept) do |io|
+    begin
+      netconf_server.start_session 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
+      begin
+        io.close
+      rescue
+      end
+    end
+  end
+end

data/demo/server_with_sessionless-database.rb

@@ -0,0 +1,81 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
+
+require 'socket'
+require 'logger'
+require 'rexml/document'
+
+begin
+  require 'hrr_rb_netconf'
+rescue LoadError
+  $:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+  require 'hrr_rb_netconf'
+end
+
+class SessionlessDatabase
+  def initialize
+    @xml_doc = REXML::Document.new('<original />')
+    @content = ''
+  end
+
+  def get
+    @xml_doc.root.deep_clone
+  end
+
+  def get_config
+    @xml_doc.root.deep_clone
+  end
+
+  def edit input_e
+    @xml_doc = REXML::Document.new
+    @xml_doc.add input_e
+  end
+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.oper_proc('get'){ |db, input_e|
+  db.get
+}
+datastore.oper_proc('get-config'){ |db, input_e|
+  db.get_config
+}
+datastore.oper_proc('edit-config'){ |db, input_e|
+  config_e = input_e.elements['config'].elements[1]
+  db.edit config_e
+}
+datastore.oper_proc('close-session'){ |db, input_e|
+  # pass
+}
+datastore.oper_proc('lock'){ |db, input_e|
+  # pass
+}
+datastore.oper_proc('unlock'){ |db, input_e|
+  # pass
+}
+
+
+server = TCPServer.new 10830
+netconf_server = HrrRbNetconf::Server.new datastore
+loop do
+  Thread.new(server.accept) do |io|
+    begin
+      netconf_server.start_session 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
+      begin
+        io.close
+      rescue
+      end
+    end
+  end
+end

data/hrr_rb_netconf.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "hrr_rb_netconf/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hrr_rb_netconf"
+  spec.version       = HrrRbNetconf::VERSION
+  spec.license       = 'Apache-2.0'
+  spec.summary       = %q{Pure Ruby NETCONF server implementation}
+  spec.description   = %q{Pure Ruby NETCONF server implementation}
+  spec.authors       = ["hirura"]
+  spec.email         = ["hirura@gmail.com"]
+  spec.homepage      = "https://github.com/hirura/hrr_rb_netconf"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.16"
+end

data/lib/hrr_rb_netconf.rb

@@ -0,0 +1,10 @@
+# coding: utf-8
+# vim: et ts=2 sw=2
+
+require "hrr_rb_netconf/version"
+require "hrr_rb_netconf/logger"
+require "hrr_rb_netconf/server"
+
+module HrrRbNetconf
+  # Your code goes here...
+end

data/lib/hrr_rb_netconf/logger.rb

@@ -0,0 +1,56 @@
+# 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