yggdrasil 0.0.7 → 0.0.8

data/README.md

@@ -6,32 +6,69 @@ Yggdrasil is a subversion wrapper to manage server configurations and conditions
 
     $ gem install yggdrasil
 
-And you have to install subversion:
+subversion needs to be installed:
 
     (e.g.)$ sudo yum install subversion
 
-## Usage
+## Usage: private use(stand alone)
 
 Prepare subversion repository and initialize Yggdrasil:
 
-    (e.g.)$ svnadmin create ~/svn-repo
-    $ yggdrasil init --repo file://$HOME/svn-repo
+    $ ygg init --repo private
 
   You should use svn-server if you have.
   In that case, the configuration files of
   all the servers can be managed on the unification.
 
-Add configuration files:
+Add configuration files to manage:
 
-    $ yggdrasil add /etc/hosts /etc/fstab   ..etc
+    $ ygg add /etc/hosts /etc/fstab   ..etc
+    $ ygg check
+    $ ygg commit /
 
 Check modify and/or delete:
 
-    $ yggdrasil status /
+    $ vi /etc/hosts ..etc
+    $ ygg check
+    $ ygg commit /etc/hosts ..etc
 
 Refer Help:
 
-    $ yggdrasil help
+    $ ygg help
+
+## Usage: data center management (example)
+
+Prepare subversion repository and launch server on host:$YGG_SERVER:
+
+    (e.g. $YGG_REPO is anywhere you want)
+    $ svnadmin create $YGG_REPO
+    $ vi $YGG_REPO/conf/svnserve.conf
+    $ svnserve -d
+
+Prepare yggdrasil server on host:$YGG_SERVER:
+
+    $ yggserve init --repo svn://$YGG_SERVER/$YGG_REPO/{host} --port 4000
+    $ yggserve daemon
+
+Prepare yggdrasil client to manage config files:
+
+    $ ygg init --server $YGG_SERVER:4000
+    $ ls -al ~/.yggdrasil/checker
+    and add/modify executable script in "checker"
+    $ ygg add /etc/hosts /etc/fstab ..etc
+    $ ygg check
+    $ ygg commit /
+
+Prepare yggdrasil client to report check results to yggdrasil server, every day:
+
+    $ crontab -e
+    add following line(you should check path by 'which ygg')
+    17 5 * * * $GEMPATH/ygg check
+
+Check updates of configurations/conditions on host:$YGG_SERVER:
+
+    $ yggserve results --expire 1440
+    CI tool(e.g.Jenkins) may execute this command automatically to daily report/record.
 
 ## Environment
 

data/Rakefile

@@ -1,10 +1,10 @@
 #!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
 
 Bundler.setup
 require 'rspec/core/rake_task'
 
-desc "run spec"
+desc 'run spec'
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.rspec_opts = %w{-c -fs}
 end

data/bin/ygg

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'yggdrasil'
+
+Yggdrasil::command(ARGV)

data/bin/yggserve

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'yggdrasil_server'
+
+YggdrasilServer::command(ARGV)

data/lib/yggdrasil/check.rb

@@ -13,11 +13,13 @@ class Yggdrasil
     # execute checker
     `rm -rf #@checker_result_dir`
     Dir.mkdir @checker_result_dir, 0755
-    Find.find(@checker_dir).each do |file|
-      if File.file?(file) && File.executable?(file)
-        if file =~ %r{^#@checker_dir(.*)$}
-          file_body = $1
-          system3("#{file} > #@checker_result_dir#{file_body}")
+    if File.exist?(@checker_dir)
+      Find.find(@checker_dir).each do |file|
+        if File.file?(file) && File.executable?(file)
+          if file =~ %r{^#@checker_dir(.*)$}
+            file_body = $1
+            system3("#{file} > #@checker_result_dir#{file_body}")
+          end
         end
       end
     end
@@ -41,15 +43,17 @@ class Yggdrasil
     end
     check_result.gsub!(/^Status against revision:.*\n/, '')
     check_result.chomp!
-    if check_result != ""
+    if check_result == ''
+      puts 'yggdrasil check: OK!'
+    else
       check_result << "\n\n"
       cmd_arg = "#@svn diff --no-auth-cache --non-interactive -r HEAD"
       cmd_arg += username_password_options_to_read_repo
       FileUtils.cd @mirror_dir do
         check_result << system3(cmd_arg)
       end
+      puts check_result
     end
-    puts check_result
 
     if /^(.+):(\d+)$/ =~ @options[:server]
       host = $1

data/lib/yggdrasil/commit.rb

@@ -26,10 +26,10 @@ class Yggdrasil
 
     message = ''
     unless @options.has_key?(:message)
-      print "Input log message: "
+      print 'Input log message: '
       loop do
         input = $stdin.gets
-        error "can not input log message" unless input
+        error 'can not input log message' unless input
         input.chomp!
         if input =~ /^(.*)\\$/
           message += $1+"\n"
@@ -44,7 +44,7 @@ class Yggdrasil
     input_user_pass
     FileUtils.cd @mirror_dir do
       puts system3 "#@svn commit -m '#{@options[:message]}'"\
-                   " --no-auth-cache --non-interactive"\
+                   ' --no-auth-cache --non-interactive'\
                    " --username '#{@options[:username]}' --password '#{@options[:password]}'"\
                    " #{confirmed_updates.join(' ')}"
     end

data/lib/yggdrasil/help.rb

@@ -1,6 +1,5 @@
 class Yggdrasil
 
-
   # @param [Array] args
   def help(args)
     if args.size == 0
@@ -17,22 +16,19 @@ Available subcommands:
    diff (di)
    help (?, h)
    init
-   init-server
    list (ls)
    log
-   results
    revert
-   server
    status (stat, st)
    update
    version
 
 Yggdrasil is a subversion wrapper to manage server configurations and conditions.
-You should type 'yggdrasil init' at first.
+At first, you should type '#@base_cmd init' to create config file.
 
 EOS
     elsif args.size != 1 then
-      error "too many arguments."
+      error 'too many arguments.'
     else
       case args[0]
         when 'add'
@@ -51,7 +47,10 @@ usage: #@base_cmd check [OPTIONS...]
   For example, mount status, number of specific process and etc. can be checked
   by setting up executable files in ~/.yggdrasil/checker/
 
-  if the server is registered, the yggdrasil server receive and record the results.
+  If the yggdrasil server is registered,
+  this subcommand send the result to yggdrasil server
+  and yggdrasil server record the results for all managed servers.
+  Type 'yggserve help', if you need to know about yggdrasil server.
 
 Valid options:
   --username ARG           : specify a username ARG
@@ -122,22 +121,6 @@ Valid options:
   --server ARG             : specify a server address and port
                              e.g. 192.168.1.35:4000
 
-EOS
-        when 'init-server'
-          puts <<"EOS"
-init-server: setup server configuration.
-usage: #@base_cmd init-server [OPTIONS...]
-
-Valid options:
-  --port ARG               : specify a TCP port number ARG
-  --repo ARG               : URL of subversion repository
-                             ARG can contain {HOST} or a {host}
-                             {HOST} is replaced by client hostname with domain
-                             {host} is replaced by client hostname without domain
-                             e.g. svn://192.168.3.5/servers/{host}/ygg
-  --ro-username ARG        : specify a username ARG for read only
-  --ro-password ARG        : specify a password ARG for read only
-
 EOS
         when 'list', 'ls'
           puts <<"EOS"
@@ -175,15 +158,6 @@ Valid options:
                                 'COMMITTED'  last commit at or before BASE
                                 'PREV'       revision just before COMMITTED
 
-EOS
-        when 'results'
-          puts <<"EOS"
-results: display the result of yggdrasil check command.
-usage: #@base_cmd results [OPTIONS...]
-
-Valid options:
-  --limit ARG              : minutes from the final report, to judge the host not be alive
-
 EOS
         when 'revert'
           puts <<"EOS"
@@ -241,7 +215,7 @@ usage: #@base_cmd version
 
 EOS
         else
-          error "Unknown subcommand: '#{subcommand}'"
+          error "Unknown subcommand: '#{args[0]}'"
       end
     end
   end

data/lib/yggdrasil/init.rb

@@ -1,3 +1,5 @@
+require 'socket'
+
 class Yggdrasil
 
   # @param [Array] args
@@ -19,7 +21,7 @@ class Yggdrasil
     svn = out.chomp
 
     out = system3 'svn --version'
-    error "can not find version string: svn --version" unless /version (\d+\.\d+\.\d+) / =~ out
+    error 'can not find version string: svn --version' unless /version (\d+\.\d+\.\d+) / =~ out
     svn_version=$1
 
     error "already exist config file: #@config_file" if File.exist?(@config_file)
@@ -32,14 +34,14 @@ class Yggdrasil
     @options[:repo].chomp!('/')
     @options[:repo].gsub!(/\{HOST\}/, Socket.gethostname)
     @options[:repo].gsub!(/\{host\}/, Socket.gethostname.split('.')[0])
-    if @options[:repo] == "private"
+    if @options[:repo] == 'private'
       Dir.mkdir @config_dir, 0755 unless File.exist?(@config_dir)
       repo_dir = "#@config_dir/private_repo"
       system3 "svnadmin create #{repo_dir}"
       @options[:repo] = "file://#{repo_dir}"
     end
 
-    puts "check SVN access..."
+    puts 'check SVN access...'
     if @options.has_key?(:ro_username)
       anon_access = false
     else
@@ -79,9 +81,9 @@ class Yggdrasil
         msg = "not exist directory(s): #{url_parts[url_parts_num...url_parts.size].join('/')}"
         error msg if @options[:non_interactive?]
         puts msg
-        print "make directory(s)? [Yn]: "
+        print 'make directory(s)? [Yn]: '
         input = $stdin.gets
-        error "can not gets $stdin" if input.nil?
+        error 'can not gets $stdin' if input.nil?
         input.chomp!
         return if input == 'n'
         break if input == 'Y'
@@ -107,7 +109,7 @@ class Yggdrasil
     end
 
     # make config file
-    File.open(@config_file, "w") do |f|
+    File.open(@config_file, 'w') do |f|
       f.puts "path=#{ENV['PATH']}\n"\
              "svn=#{svn}\n"\
              "svn_version=#{svn_version}\n"\
@@ -133,16 +135,16 @@ class Yggdrasil
 
   def init_get_repo_interactive
     loop do
-      print "Input svn repo URL: "
+      print 'Input svn repo URL: '
       input = $stdin.gets
-      error "can not input svn repo URL" unless input
+      error 'can not input svn repo URL' unless input
 
       if %r{^(http://|https://|file://|svn://|private)} =~ input
         @options[:repo] = input
         break
       end
 
-      puts "ERROR: Invalid URL."
+      puts 'ERROR: Invalid URL.'
     end
   end
 end

data/lib/yggdrasil/list.rb

@@ -23,7 +23,7 @@ class Yggdrasil
     cmd_arg = "#@svn list --no-auth-cache --non-interactive"
     cmd_arg += username_password_options_to_read_repo
     cmd_arg += " -r #{@options[:revision]}" if @options.has_key?(:revision)
-    cmd_arg += " -R" if @options.has_key?(:recursive?)
+    cmd_arg += ' -R' if @options.has_key?(:recursive?)
     cmd_arg += ' ' + repos.join(' ')
     FileUtils.cd @mirror_dir do
       puts system3(cmd_arg)

data/lib/yggdrasil/log.rb

@@ -9,7 +9,7 @@ class Yggdrasil
 
     if args.size == 0
       dir = @mirror_dir + @current_dir
-      error "current directory is not managed." unless File.exist?(dir)
+      error 'current directory is not managed.' unless File.exist?(dir)
       args << dir
     else
       args.collect! do |arg|
@@ -26,7 +26,7 @@ class Yggdrasil
     if @options.has_key?(:revision)
       cmd_arg += " -r #{@options[:revision]}"
     else
-      cmd_arg += " -r HEAD:1"
+      cmd_arg += ' -r HEAD:1'
     end
     cmd_arg += ' ' + args.join(' ')
     puts system3(cmd_arg)

data/lib/yggdrasil/update.rb

@@ -30,7 +30,7 @@ class Yggdrasil
     confirmed_updates = confirm_updates(matched_updates) do |relative_path|
       FileUtils.cd @mirror_dir do
         cmd = "#@svn diff"
-        cmd += " --no-auth-cache --non-interactive"
+        cmd += ' --no-auth-cache --non-interactive'
         cmd += username_password_options_to_read_repo
         if @options.has_key?(:revision)
           cmd += " --old=#{relative_path} --new=#{relative_path}@#{@options[:revision]}"
@@ -50,7 +50,7 @@ class Yggdrasil
     if @options.has_key?(:revision)
       cmd_arg += " -r #{@options[:revision]}"
     else
-      cmd_arg += " -r HEAD"
+      cmd_arg += ' -r HEAD'
     end
     cmd_arg += ' ' + confirmed_updates.join(' ')
     FileUtils.cd @mirror_dir do

data/lib/yggdrasil/version.rb

@@ -1,5 +1,5 @@
 class Yggdrasil
-  VERSION = "0.0.7"
+  VERSION = '0.0.8'
 
   def version
     puts <<"EOS"

data/lib/yggdrasil.rb

@@ -1,21 +1,20 @@
 require 'fileutils'
 
-require "yggdrasil_common"
-require "yggdrasil_server"
-
-require "yggdrasil/version"
-require "yggdrasil/help"
-require "yggdrasil/init"
-require "yggdrasil/add"
-require "yggdrasil/commit"
-require "yggdrasil/cleanup"
-require "yggdrasil/diff"
-require "yggdrasil/list"
-require "yggdrasil/log"
-require "yggdrasil/status"
-require "yggdrasil/update"
-require "yggdrasil/revert"
-require "yggdrasil/check"
+require 'yggdrasil_common'
+
+require 'yggdrasil/version'
+require 'yggdrasil/help'
+require 'yggdrasil/init'
+require 'yggdrasil/add'
+require 'yggdrasil/commit'
+require 'yggdrasil/cleanup'
+require 'yggdrasil/diff'
+require 'yggdrasil/list'
+require 'yggdrasil/log'
+require 'yggdrasil/status'
+require 'yggdrasil/update'
+require 'yggdrasil/revert'
+require 'yggdrasil/check'
 
 class Yggdrasil
 
@@ -38,22 +37,16 @@ class Yggdrasil
         new.commit(args[1..-1])
       when 'diff', 'di'
         new.diff(args[1..-1])
-      when 'help', 'h', '?'
+      when 'help', '--help', 'h', '?'
         new(false).help(args[1..-1])
       when 'init'
         new(false).init(args[1..-1])
-      when 'init-server'
-        YggdrasilServer.new(false).init_server(args[1..-1])
       when 'list', 'ls'
         new.list(args[1..-1])
       when 'log'
         new.log(args[1..-1])
-      when 'results'
-        YggdrasilServer.new.results(args[1..-1])
       when 'revert'
         new.revert(args[1..-1])
-      when 'server'
-        YggdrasilServer.new.server(args[1..-1])
       when 'status', 'stat', 'st'
         new.status(args[1..-1])
       when 'update'
@@ -69,7 +62,7 @@ class Yggdrasil
   def initialize(exist_config = true)
     @base_cmd = File::basename($0)
     @current_dir = `readlink -f .`.chomp
-    @config_dir = "#{ENV["HOME"]}/.yggdrasil"
+    @config_dir = "#{ENV['HOME']}/.yggdrasil"
     @config_file = "#@config_dir/config"
     @mirror_dir = "#@config_dir/mirror"
     @checker_dir = "#@config_dir/checker"
@@ -77,9 +70,9 @@ class Yggdrasil
 
     return unless exist_config
     configs = read_config(@config_file)
-    error "need 'path' in config file" unless (ENV["PATH"] = configs[:path])
-    error "need 'svn' in config file" unless (@svn = configs[:svn])
-    error "need 'repo' in config file" unless (@repo = configs[:repo])
+    error 'need "path" in config file' unless (ENV['PATH'] = configs[:path])
+    error 'need "svn" in config file' unless (@svn = configs[:svn])
+    error 'need "repo" in config file' unless (@repo = configs[:repo])
     @anon_access = (configs[:anon_access] == 'read')
     @options ||= Hash.new
     @options[:server] = configs[:server] if configs.has_key?(:server)
@@ -106,7 +99,7 @@ class Yggdrasil
       files.each do |file|
         if !File.exist?("/#{file}")
           system3 "#@svn delete #{file} --force" +
-                      " --no-auth-cache --non-interactive"
+                      ' --no-auth-cache --non-interactive'
         elsif File.file?("/#{file}")
           if !File.exist?("#@mirror_dir/#{file}")
             cmd = "#@svn revert #{file}"
@@ -168,7 +161,7 @@ class Yggdrasil
       (0...updates.size).each do |i|
         puts "#{i}:#{updates[i][0]} #{updates[i][1]}"
       end
-      print "OK? [Y|n|<num to diff>]:"
+      print 'OK? [Y|n|<num to diff>]:'
       res = $stdin.gets
       return nil unless res
       res.chomp!
@@ -191,7 +184,7 @@ class Yggdrasil
     if @options.has_key?(:ro_password)
       " --username #{@options[:ro_username]} --password #{@options[:ro_password]}"
     else
-      ""
+      ''
     end
   end
 
@@ -213,9 +206,9 @@ class Yggdrasil
         # get repo
         sock = TCPSocket.open(host, port)
         error "can not connect to server: #{host}:#{port}" if sock.nil?
-        sock.puts "get_repo"
+        sock.puts 'get_repo'
         rcv = sock.gets
-        error "can not get repo from server" if rcv.nil?
+        error 'can not get repo from server' if rcv.nil?
         @options[:repo] = rcv.chomp
         sock.close
       end
@@ -223,12 +216,12 @@ class Yggdrasil
       #get read-only username/password
       sock = TCPSocket.open(host, port)
       error "can not connect to server: #{host}:#{port}" if sock.nil?
-      sock.puts("get_ro_id_pw")
+      sock.puts('get_ro_id_pw')
       username = sock.gets
       unless username.nil?
         @options[:ro_username] = username.chomp
         password = sock.gets
-        error "can not get ro_password" if password.nil?
+        error 'can not get ro_password' if password.nil?
         @options[:ro_password] = password.chomp
       end
       sock.close

data/lib/yggdrasil_common.rb

@@ -56,23 +56,23 @@ module YggdrasilCommon
 
   def input_user_pass
     until @options.has_key?(:username) do
-      error "Can't get username or password" if @options.has_key?(:non_interactive?)
-      print "Input svn username: "
+      error 'Can\'t get username or password' if @options.has_key?(:non_interactive?)
+      print 'Input svn username: '
       input = $stdin.gets
-      error "can not input username" unless input
+      error 'can not input username' unless input
       input.chomp!
       return if input.size == 0
       @options[:username] = @options[:ro_username] = input
     end
     until @options.has_key?(:password) do
-      error "Can't get username or password" if @options.has_key?(:non_interactive?)
-      print "Input svn password: "
+      error 'Can\'t get username or password' if @options.has_key?(:non_interactive?)
+      print 'Input svn password: '
       #input = `sh -c 'read -s hoge;echo $hoge'`
       system3 'stty -echo', false
       input = $stdin.gets
       system3 'stty echo', false
       puts
-      error "can not input password" unless input
+      error 'can not input password' unless input
       input.chomp!
       @options[:password] = @options[:ro_password] = input
     end
@@ -85,8 +85,13 @@ module YggdrasilCommon
 
     unless stat.success?
       return nil unless err_exit
-      $stderr.puts "#@base_cmd error: command failure: #{cmd}"
-      $stderr.puts "command output:"
+      if @options[:debug?]
+        cmd_disp = cmd
+      else
+        cmd_disp = (cmd.split)[0]+' ...'
+      end
+      $stderr.puts "#@base_cmd error: command failure: #{cmd_disp}"
+      $stderr.puts 'command output:'
       $stderr.puts out
       exit stat.exitstatus
     end

data/lib/yggdrasil_server/help.rb

@@ -0,0 +1,85 @@
+require 'yggdrasil_server'
+
+class YggdrasilServer
+
+  # @param [Array] args
+  def help(args)
+    if args.size == 0
+      puts <<EOS
+usage: #@base_cmd <subcommand> [options] [args]
+Yggdrasil version #{Yggdrasil::VERSION}
+Type '#@base_cmd help <subcommand>' for help on a specific subcommand.
+
+Available subcommands:
+   daemon
+   debug
+   help (?, h)
+   init
+   results
+   version
+
+Yggdrasil server is a TCP server
+to receive/record the yggdrasil check result of all managed servers.
+
+At first, you should type '#@base_cmd init' to create config file.
+
+EOS
+    elsif args.size != 1 then
+      error 'too many arguments.'
+    else
+      case args[0]
+        when 'daemon'
+          puts <<"EOS"
+daemon: launch TCP server by daemon mode.
+usage: #{File.basename($0)} daemon
+
+EOS
+        when 'debug'
+          puts <<"EOS"
+debug: launch TCP server by debug mode.
+usage: #{File.basename($0)} debug
+
+EOS
+        when 'help', '?', 'h'
+          puts <<"EOS"
+help (?,h): Describe the usage of this program or its subcommands.
+usage: #@base_cmd help [SUBCOMMAND]
+
+EOS
+        when 'init'
+          puts <<"EOS"
+init: setup yggdrasil server configuration.
+usage: #@base_cmd init [OPTIONS...]
+
+Valid options:
+  --port ARG               : specify a TCP port number ARG
+  --repo ARG               : URL of subversion repository
+                             ARG can contain {HOST} or a {host}
+                             {HOST} is replaced by client hostname with domain
+                             {host} is replaced by client hostname without domain
+                             e.g. svn://192.168.3.5/servers/{host}/ygg
+  --ro-username ARG        : specify a username ARG for read only
+  --ro-password ARG        : specify a password ARG for read only
+
+EOS
+        when 'results'
+          puts <<"EOS"
+results: display the result of yggdrasil check command.
+usage: #@base_cmd results [OPTIONS...]
+
+Valid options:
+  --expire ARG              : minutes from the final report, to judge the host not be alive
+
+EOS
+        when 'version', '--version'
+          puts <<"EOS"
+version: See the program version
+usage: #@base_cmd version
+
+EOS
+        else
+          error "Unknown subcommand: '#{subcommand}'"
+      end
+    end
+  end
+end