rubyang 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bf6ba0d6403e44658776ca41420c57286cb758d
-  data.tar.gz: f6443bd567723e7693972f72972c298d1aaf1eb2
+  metadata.gz: 000a93a9ac2a85ec169ecbe1c54112b330e026b4
+  data.tar.gz: 3e81e19d9247fe5459de45aa57120508371d12fc
 SHA512:
-  metadata.gz: e0a78dad49333f4721d9aa13eff55c04acf013ad77733d1c14ded2252e390591bbd59ec3883aa51c70d7cc863f1e4c1bbf6efd37f104380eeb21338c4440561a
-  data.tar.gz: ca383e240527e026eba7151c05e1c17e5a3bd638c0e6794647b80e5d9f312654addd7d05e70efc96a744d4e61c64e85f5f74d207824977149a6e28673fcde80b
+  metadata.gz: 4d5ab6836505d061b019f844893a17fcfc4c4761eb2bf7e1d140670d8aa97970faacb952c8bffd10a337a80efe07d7be26c15ad3b50048f7c6697432d60e8668
+  data.tar.gz: ad6e739291421f469746f786755ef8288821af5a30cbda43b3c0fb757434019eddda5668422ff315b587002e23e82324c7251374d3674a2b04ee46450738e2bd

data/.codeclimate.yml

@@ -25,3 +25,6 @@ ratings:
   - "**.rb"
 exclude_paths:
 - spec/
+- vendor/
+- lib/rubyang/model/parser/parser.tab.rb
+- lib/rubyang/xpath/parser/parser.tab.rb

data/.gitignore

@@ -39,3 +39,4 @@ Gemfile.lock
 .DS_Store
 *~
 *.swp
+/yang/

data/README.md

@@ -1,9 +1,10 @@
 # rubyang
 
 [![Build Status](https://travis-ci.org/hirura/rubyang.svg?branch=master)](https://travis-ci.org/hirura/rubyang)
-[![Coverage Status](https://coveralls.io/repos/github/hirura/rubyang/badge.svg?branch=master)](https://coveralls.io/github/hirura/rubyang?branch=master)
 [![Code Climate](https://codeclimate.com/github/hirura/rubyang/badges/gpa.svg)](https://codeclimate.com/github/hirura/rubyang)
+[![Test Coverage](https://codeclimate.com/github/hirura/rubyang/badges/coverage.svg)](https://codeclimate.com/github/hirura/rubyang/coverage)
 [![Issue Count](https://codeclimate.com/github/hirura/rubyang/badges/issue_count.svg)](https://codeclimate.com/github/hirura/rubyang)
+[![Gem Version](https://badge.fury.io/rb/rubyang.svg)](https://badge.fury.io/rb/rubyang)
 
 YANG parser and tree structure data store
 
@@ -25,7 +26,110 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Core
+
+You can use Rubyang as yang database or as server
+
+To use rubyang as database, add this line to head of your code:
+
+```ruby
+require 'rubyang'
+```
+
+You can specify YANG model as String:
+
+```ruby
+yang = <<EOB
+module rubyang-example {
+  namespace 'http://rubyang/example';
+  prefix 'rubyang-example';
+  container container1 {
+    leaf leaf1 {
+      type string;
+    }
+  }
+}
+EOB
+```
+
+And prepare DB for configurations:
+
+```ruby
+db = Rubyang::Database.new
+```
+
+You can load YANG model to DB:
+
+```ruby
+db.load_model Rubyang::Model::Parser.parse( yang )
+```
+
+Then configurations can be set with YANG model:
+
+```ruby
+db.configure.edit( "container1" ).edit( "leaf1" ).set( "hoge" )
+```
+
+And you can see configured data in XML format:
+
+```ruby
+puts db.configure.to_xml( pretty: true )
+# => <config xmlns='http://rubyang/config/0.1'>
+#      <container1 xmlns='http://rubyang/example'>
+#        <leaf1>hoge</leaf1>
+#      </container1>
+#    </config>
+```
+
+And also JSON format:
+
+```ruby
+puts db.configure.to_json( pretty: true )
+# => {
+#      "config": {
+#        "container1": {
+#          "leaf1": "hoge"
+#        }
+#      }
+#    }
+```
+
+And to use rubyang as server
+
+```ruby
+require 'rubyang/server/base'
+```
+
+and create some class inheriting Rubyang::Server::Base class
+
+```ruby
+class Example < Rubyang::Server::Base
+end
+```
+
+now you can run server
+
+```ruby
+example = Example.new
+example.run
+```
+
+you can connect to this server with cli.rb
+
+```ruby
+require 'rubyang/cli'
+
+cli = Rubyang::Cli.new
+cli.run
+```
+
+### Additional Component
+
+Rubyang provides component mechanism to develop some component for users.
+Users can develop some components and load those components.
+The components which is defined as "hook commit" in configuraion are called when commit is executed.
+
+Example component is stored in "/path/to/rubyang/component/example.rb"
 
 ## Development
 

data/lib/rubyang/cli.rb

@@ -1,120 +1,131 @@
 # coding: utf-8
 
+require 'drb/drb'
 require 'readline'
 
-require_relative 'cli/parser'
-
 require_relative '../rubyang'
+require_relative 'cli/parser'
 
 module Rubyang
-	module Cli
-	end
-end
+	class Cli
+		def initialize
+			@sock_file = "/tmp/rubyang/server/Example.sock"
+			@db = DRbObject.new_with_uri( "drbunix:#{@sock_file}" )
 
-target_yang = File.expand_path( File.dirname( __FILE__ ) ) + '/cli/target.yang'
-model = Rubyang::Model::Parser.parse( File.open( target_yang, 'r' ).read )
-db = Rubyang::Database.new
-db.load_model model
-$config_tree = db.configure
+			@config_tree = @db.configure
 
-$fo = File.open('./cli/log.txt', 'w')
-$fo.sync = true
-
-def set config_tree, tokens
-	set_recursive config_tree, tokens
-end
-
-def set_recursive config_tree, tokens
-	return config_tree if tokens.size == 0
-	token = tokens[0]
-	case tokens[1..-1].size
-	when 0
-		config_tree.set token
-	else
-		child_tree = config_tree.edit token
-		set_recursive child_tree, tokens[1..-1]
-	end
-end
+			@fo = File.open("#{File.dirname(__FILE__)}/cli/log.txt", 'w')
+			@fo.sync = true
 
-def get_candidates config_tree, tokens
-	$fo.puts config_tree.class
-	$fo.puts tokens.inspect
-	token = tokens[0].to_s
-	case config_tree
-	when Rubyang::Database::DataTree::Leaf
-		if tokens.size == 1
-			[config_tree.value]
-		else
-			[]
+			#Readline.basic_word_break_characters = ""
+			#Readline.completer_word_break_characters = ""
+			Readline.completion_append_character = " "
+			Readline.completion_proc = proc { |buf|
+				@fo.puts "line_buffer: #{Readline.line_buffer}"
+				begin
+					tokens = Rubyang::Cli::Parser.parse( Readline.line_buffer )
+				rescue
+					next
+				end
+				command_type = tokens.shift
+				case command_type
+				when /^set$/
+					if tokens.size == 0
+						all_candidates = ['set']
+						candidates = all_candidates
+					else
+						value = tokens.last.to_s
+						all_candidates = get_candidates( @config_tree, tokens )
+						candidates = all_candidates.grep(/^#{Regexp.escape(value.to_s)}/)
+					end
+				when /^show$/
+					format = tokens[0].to_s
+					all_candidates = ['xml', 'json']
+					candidates = all_candidates.grep(/^#{Regexp.escape(format.to_s)}/)
+					candidates
+				else
+					all_candidates = ['set', 'show']
+					candidates = all_candidates.grep(/^#{Regexp.escape(command_type.to_s)}/)
+					candidates
+				end
+				@fo.puts "tokens = #{tokens.inspect}"
+				@fo.puts "all_candidates = #{all_candidates.inspect}"
+				@fo.puts "candidates = #{candidates.inspect}"
+				@fo.puts
+				@fo.puts
+				candidates
+			}
 		end
-	else
-		if tokens.size > 1 and config_tree.schema.children.map{ |c| c.arg }.include? token
-			child_tree = config_tree.edit token
-			get_candidates child_tree, tokens[1..-1]
-		else
-			config_tree.schema.children.map{ |c| c.arg }
-		end
-	end
-end
 
+		def set config_tree, tokens
+			set_recursive config_tree, tokens
+		end
 
-#Readline.basic_word_break_characters = ""
-#Readline.completer_word_break_characters = ""
-Readline.completion_append_character = " "
-Readline.completion_proc = proc { |buf|
-	$fo.puts "line_buffer: #{Readline.line_buffer}"
-	begin
-		tokens = Rubyang::Cli::Parser.parse( Readline.line_buffer )
-	rescue
-		next
-	end
-	command_type = tokens.shift
-	case command_type
-	when /^set$/
-		if tokens.size == 0
-			all_candidates = ['set']
-			candidates = all_candidates
-		else
-			value = tokens.last.to_s
-			all_candidates = get_candidates( $config_tree, tokens )
-			candidates = all_candidates.grep(/^#{Regexp.escape(value.to_s)}/)
+		def set_recursive config_tree, tokens
+			return config_tree if tokens.size == 0
+			token = tokens[0]
+			case tokens[1..-1].size
+			when 0
+				config_tree.set token
+			else
+				child_tree = config_tree.edit token
+				set_recursive child_tree, tokens[1..-1]
+			end
 		end
-	when /^show$/
-		format = tokens[0].to_s
-		all_candidates = ['xml', 'json']
-		candidates = all_candidates.grep(/^#{Regexp.escape(format.to_s)}/)
-		candidates
-	else
-		all_candidates = ['set', 'show']
-		candidates = all_candidates.grep(/^#{Regexp.escape(command_type.to_s)}/)
-		candidates
-	end
-	$fo.puts "tokens = #{tokens.inspect}"
-	$fo.puts "all_candidates = #{all_candidates.inspect}"
-	$fo.puts "candidates = #{candidates.inspect}"
-	$fo.puts
-	$fo.puts
-	candidates
-}
 
-while buf = Readline.readline("> ", true)
-	tokens = Rubyang::Cli::Parser.parse( buf )
-	command_type = tokens.shift
-	case command_type
-	when /^set$/
-		begin
-			set $config_tree, tokens
-			$config_tree.commit
-		rescue => e
-			puts e
+		def get_candidates config_tree, tokens
+			@fo.puts config_tree.class
+			@fo.puts tokens.inspect
+			token = tokens[0].to_s
+			case config_tree
+			when Rubyang::Database::DataTree::Leaf
+				if tokens.size == 1
+					[config_tree.value]
+				else
+					[]
+				end
+			else
+				if tokens.size > 1 and config_tree.schema.children.map{ |c| c.arg }.include? token
+					child_tree = config_tree.edit token
+					get_candidates child_tree, tokens[1..-1]
+				else
+					config_tree.schema.children.map{ |c| c.arg }
+				end
+			end
 		end
-	when /^show$/
-		show_type = tokens.shift
-		case show_type
-		when /^xml$/
-			puts $config_tree.to_xml( pretty: true )
-		when /^json$/
-			puts $config_tree.to_json( pretty: true )
+
+		def run
+			while buf = Readline.readline("> ", true)
+				tokens = Rubyang::Cli::Parser.parse( buf )
+				command_type = tokens.shift
+				case command_type
+				when /^set$/
+					begin
+						set @config_tree, tokens
+					rescue => e
+						puts "Error: #{e}"
+					end
+				when /^show$/
+					show_type = tokens.shift
+					case show_type
+					when /^xml$/
+						puts @config_tree.to_xml( pretty: true )
+					when /^json$/
+						puts @config_tree.to_json( pretty: true )
+					end
+				when /^commit$/
+					begin
+						@config_tree.commit
+					rescue => e
+						puts "Error: #{e}"
+					end
+				end
+			end
 		end
 	end
 end
+
+if __FILE__ == $0
+	cli = Rubyang::Cli.new
+	cli.run
+end

data/lib/rubyang/cli/parser.rb

@@ -5,7 +5,7 @@ require 'strscan'
 #require_relative 'parser/parser.tab.rb'
 
 module Rubyang
-	module Cli
+	class Cli
 		class Parser
 			def self.parse( str )
 				parser = self.new

data/lib/rubyang/component/base.rb

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+require 'bundler/setup'
+
+require 'fileutils'
+require 'drb/drb'
+
+module Rubyang
+	module Component
+		class Base
+			include DRb::DRbUndumped
+
+			def initialize
+				@rubyang_sock_file = "/tmp/rubyang/server/Example.sock"
+				@db = DRbObject.new_with_uri( "drbunix:#{@rubyang_sock_file}" )
+
+				#@pid = Process.pid
+				@sock_dir = "/tmp/rubyang/component"
+				#@sock_file = "#{@sock_dir}/#{self.class}.#{pid}.sock"
+				@sock_file = "#{@sock_dir}/#{self.class}.sock"
+
+				FileUtils.mkdir_p @sock_dir
+
+				DRb.start_service( "drbunix:#{@sock_file}", self )
+				DRb.thread.join
+			end
+
+			def run
+			end
+
+			def finish
+			end
+		end
+	end
+end

data/lib/rubyang/component/example.rb

@@ -0,0 +1,15 @@
+# coding: utf-8
+
+require_relative 'base'
+
+class Example < Rubyang::Component::Base
+	def run
+		config = @db.configure
+		File.open( '/tmp/rubyang_component_example.txt', 'w' ){ |fo|
+			fo.puts config.to_xml( pretty: true )
+		}
+	end
+end
+
+example = Example.new
+example.run

data/lib/rubyang/database/component_manager.rb

@@ -0,0 +1,77 @@
+# coding: utf-8
+
+require 'open3'
+require 'drb/drb'
+
+require_relative '../../rubyang'
+
+module Rubyang
+	class Database
+		class ComponentManager
+			class Component
+				attr_reader :name, :hook, :path, :sock, :thread, :instance
+
+				def initialize name, hook, path
+					@name = name
+					@hook = hook
+					@path = path
+					@sock = "/tmp/rubyang/component/#{@name}.sock"
+				end
+
+				def start
+					begin
+						@thread = Thread.new( @path ) do |path|
+							stdout, stderr, status = Open3.capture3( "#{RUBY_ENGINE} #{path}" )
+						end
+						10.times{ |i|
+							break if File.socket? @sock
+							sleep 1
+							raise "Load failed: #{@name} : #{@path}" if i == 9
+						}
+						@instance = DRbObject.new_with_uri( "drbunix:#{@sock}" )
+					rescue => e
+						puts "Error: #{e}"
+					end
+				end
+
+				def run
+					begin
+						@instance.run
+					rescue => e
+						puts "Error: #{e}"
+					end
+				end
+			end
+
+			def initialize
+				@components = Array.new
+			end
+
+			def update components
+				current_component_names = @components.map{ |c| c.name }
+				new_component_names = components.map{ |c| c[0] }
+				unloading_component_names = current_component_names - new_component_names
+				loading_component_names = new_component_names - current_component_names
+				puts "Load: #{loading_component_names}"
+				puts "Unload: #{unloading_component_names}"
+				unloading_component_names.each{ |n|
+					component = @components.find{ |c| c.name == n }
+					component.thread.kill
+					@components.delete_if{ |c| c.name == n }
+				}
+				loading_component_names.each{ |n|
+					name, hook, path = components.find{ |c| c[0] == n }
+					component = Component.new name, hook, path
+					component.start
+					@components.push component
+				}
+			end
+
+			def run hook
+				@components.select{ |c| c.hook == hook }.each{ |c|
+					c.run
+				}
+			end
+		end
+	end
+end