nuri 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d02365a26a71b3202e77accdc43826f5da8c63ca
-  data.tar.gz: 00b72bf869f9802a32fe1bc4a2f4b350ffb889d2
+  metadata.gz: 5713187406a70381abeffa8e382892172e1cab3a
+  data.tar.gz: 589c3291070bf16e6ee05e4846192ae3d0ddca81
 SHA512:
-  metadata.gz: 63f4c79c68d7e624ec3ac944fdb7445edd8a78ee5370122c5133e4c24c2fe7d998ed01900ccd7a3c4bd0315ab33d4005473b8f13a8d0db0dae1c26ff028ed7fe
-  data.tar.gz: ee932dd09a18574c7ec58c9f55ca21a2085bad5be3be735d90de26be4610e599106a40eb273168db60834647b7e308b035c619fd5ba0fef6056b94ecdd3d627e
+  metadata.gz: 5917ac035100aeb2e1dc75ff326034d9bbc7b5ef8a8679307581d389cca20dc8b9138bafddcdddccfbe9e6457184418eaa1ffb42ea6ddfd6c5fed6d8d30b8728
+  data.tar.gz: d14d4cfd96af587cdf02a4f622e1ad7773db83052eef68de3e304f1196313814aca4e0673d3069d721f662fba89db8158bef6a91b1b2f09eeb3e0ee13248c01a

data/README.md

@@ -1,8 +1,9 @@
-Nuri
+[Nuri](http://herry13.github.io/nuri)
 ====
 - author: Herry [herry13@gmail.com]
 - license: BSD
 
+[![Build Status](https://travis-ci.org/herry13/nuri.png?branch=master)](https://travis-ci.org/herry13/nuri)
 [![Gem Version](https://badge.fury.io/rb/nuri.png)](https://badge.fury.io/rb/nuri)
 
 Nuri is an automated workflow configuration tool. It allows us to define the desired state of
@@ -29,19 +30,19 @@ Requirements
 ------------
 - Ruby (>= 1.9.1)
 - Ruby Gems:
-	- sfplanner (>= 0.1.1)
-	- colorize (>= 0.5.8)
-	- coderay (>= 1.0.9)
+	- sfplanner
+	- sfpagent
+	- colorize
+	- coderay
 
-Tested on: **Ubuntu 12.04**, **Debian Squeeze**
+Tested on Linux: **Ubuntu 12.04**, **Debian Squeeze**, and **Fedora 13**
 
 
 To install
 ----------
 
-	$ apt-get install git make gcc curl ruby1.9.1 ruby1.9.1-dev libz-dev libaugeas-ruby1.9.1 libxml2-dev libxslt-dev
-	$ gem install sfplanner colorize coderay
-	$ git clone https://github.com/herry13/nuri
+	$ apt-get install curl ruby1.9.1 ruby1.9.1-dev libz-dev libaugeas-ruby1.9.1 libxml2-dev libxslt-dev make gcc
+	$ gem install nuri
 
 
 Usage
@@ -49,16 +50,46 @@ Usage
 Assume that the model of your system is in file "model.sfp".
 - to get the current state
 
-		$ ./bin/nuri -h -m model.sfp -s
+		$ nuri state -m model.sfp
 
 - to generate the plan
 
-		$ ./bin/nuri -h -m model.sfp -p
+		$ nuri plan -m model.sfp
 
   press 'Y' and enter to execute the plan (if the plan exists).
 
 - to execute any generated plan
 
-		$ ./bin/nuri -h -m model.sfp -a
+		$ nuri plan -m model.sfp -a
 
 
+Console mode
+------------
+We could enter Nuri console mode and do operations:
+- enter console mode
+
+		$ nuri console
+		
+- edit the model which is stored in ~/.nuri/main.sfp
+
+		nuri@user> edit
+
+- compile and print the model		
+		
+		nuri@user> model
+		
+- generate the current state of the system based on the model
+		
+		nuri@user> state
+		
+- generate the plan
+		
+		nuri@user> plan
+		
+- orchestrate the execution of any plan generated by Nuri
+		
+		nuri@user> plan -a
+		
+- choreograph the execution of any plan generated by Nuri
+		
+		nuri@user> bsig -a

data/VERSION

@@ -1 +1 @@
-0.5.1
+0.5.2

data/bin/delete_modules

@@ -1,11 +1,35 @@
-#!/bin/bash
-
-if [[ "$1" == "" ]]
-then
-	echo "Usage: delete_modules <address> [port]"
-elif [[ "$2" == "" ]]
-then
-	curl -i -X PUT $1:1314/modules
-else
-	curl -i -X PUT $1:$2/modules
-fi
+#!/usr/bin/env ruby
+
+require 'uri'
+require 'net/http'
+
+module Nuri
+	module Util
+		def self.delete_modules(address, port, protocol="http")
+			url = "#{protocol}://#{address}:#{port}/modules"
+			uri = URI.parse(url)
+			http = Net::HTTP.new(uri.host, uri.port)
+			request = Net::HTTP::Delete.new(uri.request_uri)
+			response = http.request(request)
+			(response.code == '200')
+		end
+	end
+end
+
+if $0 == __FILE__
+	DefaultPort = 1314
+
+	if ARGV.length < 1
+		puts "Usage: delete_modules <address> [port]"
+		exit(1)
+	end
+
+	address = ARGV.shift
+	port = (ARGV[0].nil? ? DefaultPort : ARGV[0].to_i)
+
+	if Nuri::Util.delete_modules(address, port)
+		puts '{"status":"ok"}'
+	else
+		puts '{"status":"failed"}'
+	end
+end

data/bin/install_module

@@ -1,65 +1,54 @@
-#!/bin/bash
-
-DefaultPort=1314
-
-# verify the arguments
-if [[ "$1" == "" ]] || [[ "$2" == "" ]]; then
-	echo "Usage: install_module <address> [port] <module-name> ..."
-	exit 1
-fi
-
-# set the agent's address
-address=$1
-shift
-
-# set the agent's port number
-re='^[0-9]+$'
-if [[ $1 =~ $re ]]; then
-	port=$1
-	shift
-else
-	port=$DefaultPort
-fi
-
-# set a template command for sending the modules
-cmd="curl -s -i -X PUT $address:$port/modules"
-
-# setup directory for temporary files
-dir="/tmp/"$(date +%s%N)"$RANDOM"
-mkdir -p $dir
-
-# for every module in the arguments:
-# - archive the module's files to a temporary file
-# - update the sending command by adding the module
-# if the module is not exist then the program will
-# set missing_module flag and then break from the loop
-missing_module=0
-for module in "$@" ; do
-	if [[ -d "$module" ]]; then
-		tar cvzhf $dir/$module.tgz $module 1>/dev/null
-		cmd="$cmd -F $module=@$dir/$module.tgz"
-	else
-		echo "Module $module is not exist!"
-		missing_module=`expr $missing_module + 1`
-	fi
-done
-
-if [[ $missing_module == 0 ]]; then
-	# execute the sending command there is no missing module
-	result=`$cmd`
-	re='.*HTTP/1\.1 200 OK.*'
-	if ! [[ $result =~ $re ]]; then
-		missing_module=`expr $missing_module + 1`
-	fi
-fi
-
-# delete directory that holds temporary files
-rm -rf $dir
-
-if [[ $missing_module == 0 ]]; then
-	echo "status: ok"
-else
-	echo "status: failed"
-fi
-
-exit $missing_module
+#!/usr/bin/env ruby
+
+require 'json'
+require 'uri'
+require 'net/http'
+require File.dirname(__FILE__) + '/../lib/nuri/targz'
+
+module Nuri
+	module Util
+		TarGzip = Object.new.extend(Util::Tar)
+	
+		def self.install_modules(address, port, modules, protocol="http")
+			data = {}
+			modules.each do |module_name|
+				raise Exception, "Module #{module_name} is not exist!" if not ::File.directory?(module_name)
+				data[module_name] = TarGzip.targzip(module_name, module_name).read
+			end
+
+			url = "#{protocol}://#{address}:#{port}/modules"
+			uri = URI.parse(url)
+			http = Net::HTTP.new(uri.host, uri.port)
+			request = Net::HTTP::Put.new(uri.request_uri)
+			request.set_form_data(data)
+			response = http.request(request)
+
+			(response.code == '200')
+		end
+	end
+end
+
+if $0 == __FILE__
+	if ARGV.length < 2
+		puts "Usage: install_module <address> [port] <module-name> ..."
+		exit(1)
+	end
+
+	DefaultPort = 1314
+
+	address = ARGV.shift
+	port = (ARGV.length >= 2 ? ARGV.shift : DefaultPort)
+	modules = ARGV
+	missing = modules.select { |mod| not ::File.directory?(mod) }
+	modules = modules - missing
+	
+	success = Nuri::Util.install_modules(address, port, modules),
+	output = {
+		:status => success,
+		:installed_modules => modules,
+		:missing_modules => missing
+	}
+	puts JSON.generate(output)
+
+	exit (success ? 0 : 1)
+end

data/bin/nuri

@@ -6,8 +6,6 @@ require "#{dir}/lib/nuri"
 Version = File.read(File.dirname(__FILE__) + "/../VERSION").strip
 About = "Nuri #{Version} (c) 2013"
 
-HTTP = Object.new.extend(Nuri::Net::Helper)
-
 Nuri.init
 
 def console(*args)
@@ -15,8 +13,9 @@ def console(*args)
 	$stdout.puts(args)
 end
 
-class Sfp::Console
-	PrettyStateGenerator = Sfp::Visitor::PrettyStateGenerator.new
+class Nuri::Console
+	include Nuri::Helper
+
 	ParentEliminator = Sfp::Visitor::ParentEliminator.new
 
 	def process_args(args, parser)
@@ -77,6 +76,7 @@ EOS
 			opt :plain, 'print output in plain JSON'
 			opt :no_interactive, 'disable interactive input'
 			opt :no_push_module, 'disable automatic push module'
+			opt :image, 'image graph of the generated plan', :default => Dir.home + '/.nuri/plan.png'
 		end
 		help, args = check_help(args)
 		opts = process_args args, parser
@@ -91,6 +91,13 @@ EOS
 			plan = master.get_plan(opts)
 			if plan.is_a?(Hash) and !plan['workflow'].nil?
 				if plan['workflow'].length > 0
+					plan_file = Dir.home + '/.nuri/plan.json'
+					File.open(plan_file, 'w') { |f| f.write(JSON.generate(plan)) }
+
+					if opts[:image]
+						system "#{File.dirname(__FILE__)}/sfw2graph #{plan_file} #{opts[:image]}"
+					end
+
 					if opts[:plain]
 						puts JSON.generate(plan)
 					else
@@ -120,6 +127,7 @@ EOS
 							puts "Execution failed!".red
 						end
 					end
+
 				elsif plan['workflow'].length == 0
 					puts (opts[:plain] ? 'Goal state has been achieved.' : 'Goal state has been achieved.').green
 				end
@@ -212,7 +220,7 @@ where <subcommand> is:
          model     get current model
           bsig     get current Behavioural Signature model
  exec <action>     execute given action description
-                    <action> = <path> [param1=value1 param2=value2 ...]
+                    <action> := <path> [param1=value1 param2=value2 ...]
         module     get modules list
            log     get last 100 lines of logs
           list     list of available agents from model file
@@ -224,6 +232,7 @@ EOS
 			opt :port, "port", :default => 1314
 			opt :ssh_user, "SSH username", :short => '-u', :default => 'root'
 			opt :ssh_port, "SSH port", :short => '-p', :default => '22'
+			opt :raw, "print a RAW output"
 		end
 		help, args = check_help(args)
 		subcommand = (args.length > 0 ? args.shift : '')
@@ -237,7 +246,7 @@ EOS
 	
 		if help
 			parser.educate(STDOUT)
-		elsif `which sfpagent`.strip.length > 0
+		elsif `which sfpagent`.strip.length > 0 or ssh_opt.length > 0
 			case subcommand
 			when 'install'
 				system("#{ssh_opt} sudo gem install sfpagent --no-ri --no-rdoc")
@@ -259,32 +268,52 @@ EOS
 				system("#{ssh_opt} sudo gem update sfpagent --no-ri --no-rdoc")
 
 			when 'state'
-				code, state = HTTP.get_data(opts[:address], 1314, "/state")
+				code, state = get_data(opts[:address], 1314, "/state")
 				if code == '200' and state =~ /{.*}/
 					state = JSON[state]['state']
-					state.keys.each { |key| state.delete(key) if state[key]['_context'] != 'object' }
-					puts CodeRay.encode(JSON.pretty_generate(state), :json, :terminal)
+					if not opts[:raw]
+						state.keys.each { |key| state.delete(key) if state[key]['_context'] != 'object' }
+						state.accept(Sfp::Helper::Sfp2Ruby)
+					end
+					puts CodeRay.encode(YAML.dump(state), :yaml, :terminal)
 				else
 					puts state
 				end
 
 			when 'model'
-				code, model = HTTP.get_data(opts[:address], 1314, "/model")
+				code, model = get_data(opts[:address], 1314, "/model")
 				if code == '200' and model =~ /{.*}/
 					model = JSON[model]
-					model.keys.each { |key| model.delete(key) if model[key]['_context'] != 'object' }
-					puts CodeRay.encode(JSON.pretty_generate(model), :json, :terminal)
+					if not opts[:raw]
+						model.select! { |k,v| k[0,1] != '_' and (not v.is_a?(Hash) or v['_context'] == 'object') }
+						model.accept(Sfp::Helper::Sfp2Ruby)
+					end
+					puts CodeRay.encode(YAML.dump(model), :yaml, :terminal)
+				elsif code == '404'
+					puts "The model of desired state is not exist!"
 				else
-					puts model
+					$stderr.puts "Error: #{code}"
 				end
 
 			when 'bsig'
-				code, json = HTTP.get_data(opts[:address], 1314, "/bsig")
-				puts (code == '200' and json.length >= 2 ? CodeRay.encode(JSON.pretty_generate(JSON[json]), :json, :terminal) : json)
+				code, json = get_data(opts[:address], 1314, "/bsig")
+				if code == '200' and json.length > 0
+					puts CodeRay.encode(JSON.pretty_generate(JSON[json]), :json, :terminal)
+				elsif code == '404'
+					puts 'Behavioural Signature model is not exist!'
+				else
+					$stderr.puts "Error: #{code}"
+				end
 
 			when 'module'
-				code, json = HTTP.get_data(opts[:address], 1314, "/bsig")
-				puts (code == '200' and json.length >= 2 ? CodeRay.encode(JSON.pretty_generate(JSON[json]), :json, :terminal) : json)
+				code, json = get_data(opts[:address], 1314, "/modules")
+				if code == '200' and json.length >= 2
+					puts CodeRay.encode(YAML.dump(JSON[json]), :yaml, :terminal)
+				elsif code == '404'
+					puts 'No module is available!'
+				else
+					$stderr.puts "Error: #{code}"
+				end
 
 			when 'exec', 'execute'
 				if args.length > 0
@@ -298,7 +327,7 @@ EOS
 						end
 					end
 					data = { 'action' => JSON.generate({ 'name' => name, 'parameters' => parameters }) }
-					code, _ = HTTP.post_data(opts[:address], 1314, "/execute", data)
+					code, _ = post_data(opts[:address], 1314, "/execute", data)
 					puts (code == '200' ? "Executing #{name} [OK]".green : "Executing #{name} [Failed]".red)
 				else
 					$stderr.puts 'Invalid parameters (usage: agent exec <action-path> [action-arguments]).'
@@ -497,23 +526,4 @@ EOS
 	end
 end
 
-module Sfp::Helper
-	Sfp2Ruby = Object.new
-	def Sfp2Ruby.visit(name, value, parent)
-		if name[0] == '_' 
-			parent.delete(name)
-		elsif value.is_a?(Hash)
-			case value['_context']
-			when 'null'
-				parent[name] = nil 
-			when 'any_value', 'constraint', 'procedure'
-				parent.delete(name)
-			when 'set'
-				parent[name] = value['_values']
-			end 
-		end 
-		true
-	end 
-end
-
-Sfp::Console.new.run if $0 == __FILE__
+Nuri::Console.new.run if $0 == __FILE__

data/bin/sfw2graph

@@ -0,0 +1,178 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'json'
+
+module Sfp
+end
+
+module Sfp::Graph
+	ActionColor = 'white'
+	ActionLabelWithParameters = false
+
+	def self.dot2image(dot, image_file)
+		dot_file = "/tmp/#{Time.now.getutc.to_i}.dot"
+		File.open(dot_file, 'w') { |f|
+			f.write(dot)
+			f.flush
+		}
+		!!system("dot -Tpng -o #{image_file} #{dot_file}")
+	ensure
+		File.delete(dot_file) if File.exist?(dot_file)
+	end
+
+	def self.clean(value)
+		return value[2, value.length-2] if value[0,2] == '$.'
+		return value
+	end
+	
+	def self.get_label(action, withparameters=true)
+		label = clean(action["name"])
+		if withparameters and ActionLabelWithParameters
+			label += "("
+			if action["parameters"].length > 0
+				action["parameters"].each { |key,value|
+					label += "#{clean(key)}=#{clean(value.to_s)},"
+				}
+				label.chop!
+			end
+			label += ')'
+		end
+		return label
+	end
+	
+	def self.partial2dot(json)
+		dot = "digraph {\n"
+	
+		dot += "init_state [label=\"\", shape=doublecircle, fixedsize=true, width=0.35];\n"
+		dot += "final_state [label=\"\", shape=doublecircle, style=filled, fillcolor=black, fixedsize=true, width=0.35];\n"
+		last_actions = Hash.new
+		json["workflow"].each { |action|
+			dot += "#{action["id"]}[label=\"#{get_label(action)}\", shape=rect, style=filled, fillcolor=#{ActionColor}];\n"
+			last_actions[action["id"].to_s] = action
+		}
+	
+		json["workflow"].each { |action|
+			has_predecessor = false
+			action["predecessors"].each { |prevId|
+				dot += "#{prevId} -> #{action["id"]};\n"
+				has_predecessor = true
+				last_actions.delete(prevId.to_s)
+			}
+			if not has_predecessor
+				dot += "init_state -> #{action["id"]};\n"
+			end
+		}
+	
+		last_actions.each { |id,action|
+			dot += "#{id} -> final_state;\n"
+		}
+	
+		dot += "}"
+	
+		return dot
+	end
+	
+	def self.stage2dot(json)
+		dot = "digraph {\n"
+	
+		dot += "init_state [label=\"\", shape=doublecircle, fixedsize=true, width=0.35];\n"
+		dot += "final_state [label=\"\", shape=doublecircle, style=filled, fillcolor=black, fixedsize=true, width=0.35];\n"
+		index = 0
+		prevState = "init_state"
+		json["workflow"].each { |stage|
+			id = 0
+			stage.each { |action|
+				dot += "a" + index.to_s + "a" + id.to_s + '[label="' + get_label(action) + '", shape=rect]' + ";\n"
+				dot += prevState + " -> a" + index.to_s + "a" + id.to_s + ";\n"
+				id += 1
+			}
+			if index < json["workflow"].length-1
+				dot += "state" + index.to_s + ' [label="", shape=circle, fixedsize=true, width=0.35]' + ";\n"
+				prevState = "state" + index.to_s
+				id = 0
+				stage.each { |action|
+					dot += "a" + index.to_s + "a" + id.to_s + " -> " + prevState + ";\n"
+					id += 1
+				}
+			else
+				id = 0
+				stage.each { |action|
+					dot += "a" + index.to_s + "a" + id.to_s + " -> final_state;\n"
+					id += 1
+				}
+			end
+			index += 1
+		}
+		dot += "}"
+		return dot
+	end
+	
+	def self.sequential2dot(json)
+		dot = "digraph {\n"
+	
+		dot += "init_state [label=\"\", shape=doublecircle, fixedsize=true, width=0.35];\n"
+		dot += "final_state [label=\"\", shape=doublecircle, style=filled, fillcolor=black, fixedsize=true, width=0.35];\n"
+		id = 0
+		json["workflow"].each { |action|
+			dot += id.to_s + '[label="' + get_label(action) + '", shape=rect]' + ";\n"
+			id += 1
+		}
+	
+		id = 0
+		prevActionId = nil
+		json["workflow"].each { |action|
+			if id == 0
+				dot += "init_state -> " + id.to_s + ";\n"
+			elsif id == json["workflow"].length-1
+				dot += id.to_s + " -> final_state;\n"
+			end
+			if prevActionId != nil
+				dot += prevActionId.to_s + " -> " + id.to_s + ";\n"
+			end
+			prevActionId = id
+			id += 1
+		}
+		dot += "}"
+		return dot
+	end
+end
+
+def main
+	if ARGV.length < 1
+		puts "Convert SFP plan to an image graph with Graphviz (dot).\n\nUsage: sfw2dot.rb <input-file> [output-file]\n\n"
+		exit
+	end
+	
+	fp = open(ARGV[0], "rb")
+	json = JSON.parse(fp.read)
+	fp.close
+	
+	dot = ""
+	case json["type"]
+	when 'partial-order', 'parallel'
+		dot = Sfp::Graph::partial2dot(json)
+	when 'sequential'
+		dot = Sfp::Graph::sequential2dot(json)
+	when 'stage'
+		dot = Sfp::Graph::stage2dot(json)
+	else
+		throw Exception, "Unrecognised type of workflow: #{json['type']}"
+	end
+	
+	outfile = "/tmp/#{Time.now.to_f}.dot"
+	fp = open(outfile, "w");
+	fp.write(dot)
+	fp.close
+	
+	cmd = 'dot -Tpng -o';
+	if ARGV.length > 1
+		cmd += "#{ARGV[1]} #{outfile}"
+	else
+		cmd += ARGV[0].sub(/\.[a-zA-Z]*/,'') + ".png < #{outfile}"
+	end
+	system(cmd)
+	File.delete(outfile)
+end
+
+main if __FILE__ == $0