wtnabe-vbox_config_admin 0.0.2

data/ChangeLog

@@ -0,0 +1,4 @@
+== 0.0.1 / 2009-08-11
+
+* initial release
+

data/README

@@ -0,0 +1,60 @@
+
+= vbox_config_admin
+
+  http://github.com/wtnabe/vbox_config_admin/tree/master
+
+== Description
+
+ VirtualBox config xml file manager written in Ruby and Rake
+
+== Requirements
+
+ * Ruby ( 1.8 or later )
+ * Rake
+
+== Installation
+
+=== Gem Installation
+
+	gem install vbox_config_admin
+
+ If you use windows, type like below:
+
+ C:\Ruby\bin> copy ..\lib\ruby\gems\1.8\gems\vbox_config_admin-X.X.X\bin\vbox_config_admin.bat .
+
+ Remember the last period(.) !
+
+ Note: I've tested it on MacOSX and Windows host. But Linux host hasn't been tried yet.
+
+=== Clone
+
+	git clone git://github.com/wtnabe/vbox_config_admin.git 
+
+== Features/Problems
+
+ * create backup for both whole and each machines' config xml
+ * check and delete backup files
+ * open real config and backup file
+
+ Problem: On Windows host, you will not open XXXX.xml config file. But you can open backup files. I don't know why.
+
+== Synopsis
+
+ Just type as:
+
+ vbox_config_admin 
+
+ You can see available tasks, if you've already installed VirtualBox.
+
+== Copyright
+
+Author::    wtnabe <wtnabe@gmail.com>
+Copyright:: Copyright (c) 2009 wtnabe
+License::   Two-clause BSD
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+   1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+   2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE FREEBSD PROJECT ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FREEBSD PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,146 @@
+# -*- mode: ruby -*-
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+require 'rake/rdoctask'
+require 'rake/contrib/rubyforgepublisher'
+require 'rake/contrib/sshpublisher'
+require 'fileutils'
+require 'lib/vbox_config_admin'
+include FileUtils
+
+NAME              = "vbox_config_admin"
+AUTHOR            = "wtnabe"
+EMAIL             = "wtnabe@gmail.com"
+DESCRIPTION       = "Create and delete backups for VirtualBox configuration, and open config & backups"
+RUBYFORGE_PROJECT = ""
+HOMEPATH          = ""
+BIN_FILES         = %w( vbox_config_admin )
+
+VERS              = VboxConfigAdmin::VERSION
+REV = File.read(".svn/entries")[/committed-rev="(d+)"/, 1] rescue nil
+CLEAN.include ['**/.*.sw?', '*.gem', '.config']
+RDOC_OPTS = [
+	'--title', "#{NAME} documentation",
+	"--charset", "utf-8",
+	"--opname", "index.html",
+	"--line-numbers",
+	"--main", "README",
+	"--inline-source",
+]
+
+task :default => [:test]
+task :package => [:clean]
+
+Rake::TestTask.new("test") do |t|
+	t.libs   << "test"
+	t.pattern = "test/**/*_test.rb"
+	t.verbose = true
+end
+
+spec = Gem::Specification.new do |s|
+	s.name              = NAME
+	s.version           = VERS
+	s.platform          = Gem::Platform::RUBY
+	s.has_rdoc          = true
+	s.extra_rdoc_files  = ["README", "ChangeLog"]
+	s.rdoc_options     += RDOC_OPTS + ['--exclude', '^(examples|extras)/']
+	s.summary           = DESCRIPTION
+	s.description       = DESCRIPTION
+	s.author            = AUTHOR
+	s.email             = EMAIL
+	s.homepage          = HOMEPATH
+	s.executables       = BIN_FILES
+	s.rubyforge_project = RUBYFORGE_PROJECT
+	s.bindir            = "bin"
+	s.require_path      = "lib"
+	#s.autorequire       = ""
+	s.test_files        = Dir["test/*_test.rb"]
+
+	s.add_dependency('rake', '>= 0')
+        s.requirements << 'rake'
+	#s.required_ruby_version = '>= 1.8.2'
+
+	s.files = %w(README ChangeLog Rakefile) +
+		Dir.glob("{bin,doc,test,lib,templates,generator,extras,website,script}/**/*") + 
+		Dir.glob("ext/**/*.{h,c,rb}") +
+		Dir.glob("examples/**/*.rb") +
+		Dir.glob("tools/*.rb") +
+		Dir.glob("rails/*.rb")
+
+	s.extensions = FileList["ext/**/extconf.rb"].to_a
+end
+
+Rake::GemPackageTask.new(spec) do |p|
+	p.need_tar = true
+	p.gem_spec = spec
+end
+
+task :install do
+	name = "#{NAME}-#{VERS}.gem"
+	sh %{rake package}
+	sh %{sudo gem install pkg/#{name}}
+end
+
+task :uninstall => [:clean] do
+	sh %{sudo gem uninstall #{NAME}}
+end
+
+
+Rake::RDocTask.new do |rdoc|
+	rdoc.rdoc_dir = 'html'
+	rdoc.options += RDOC_OPTS
+	rdoc.template = "resh"
+	#rdoc.template = "#{ENV['template']}.rb" if ENV['template']
+	if ENV['DOC_FILES']
+		rdoc.rdoc_files.include(ENV['DOC_FILES'].split(/,\s*/))
+	else
+		rdoc.rdoc_files.include('README', 'ChangeLog')
+		rdoc.rdoc_files.include('lib/**/*.rb')
+		rdoc.rdoc_files.include('ext/**/*.c')
+	end
+end
+
+desc "Publish to RubyForge"
+task :rubyforge => [:rdoc, :package] do
+	require 'rubyforge'
+	Rake::RubyForgePublisher.new(RUBYFORGE_PROJECT, 'wtnabe').upload
+end
+
+desc 'Package and upload the release to rubyforge.'
+task :release => [:clean, :package] do |t|
+	v = ENV["VERSION"] or abort "Must supply VERSION=x.y.z"
+	abort "Versions don't match #{v} vs #{VERS}" unless v == VERS
+	pkg = "pkg/#{NAME}-#{VERS}"
+
+	require 'rubyforge'
+	rf = RubyForge.new.configure
+	puts "Logging in"
+	rf.login
+
+	c = rf.userconfig
+#	c["release_notes"] = description if description
+#	c["release_changes"] = changes if changes
+	c["preformatted"] = true
+
+	files = [
+		"#{pkg}.tgz",
+		"#{pkg}.gem"
+	].compact
+
+	puts "Releasing #{NAME} v. #{VERS}"
+	rf.add_release RUBYFORGE_PROJECT, NAME, VERS, *files
+end
+
+desc 'Show information about the gem.'
+task :debug_gem do
+	puts spec.to_ruby
+end
+
+desc 'Update gem spec'
+task :gemspec do
+  open("#{NAME}.gemspec", 'w').write spec.to_ruby
+end

data/bin/vbox_config_admin

@@ -0,0 +1,90 @@
+#! /usr/bin/env rake -f
+# -*- mode: ruby; coding: utf-8 -*-
+
+unless ( ENV['PATH'].split( File::PATH_SEPARATOR ).include?( File.dirname( __FILE__ ) ) )
+  $LOAD_PATH << File.expand_path("../lib", File.dirname(__FILE__))
+end
+require 'vbox_config_admin'
+
+#
+# global tasks
+#
+namespace :vbox do
+  desc "show VirtualBox version number"
+  task :version do
+    puts VboxConfigAdmin.new.version
+  end
+
+  desc "backup all config files"
+  task :backup_configs do
+    v = VboxConfigAdmin.new
+    v.machines.each { |m|
+      v.create_backup( m )
+      puts "Backup completed #{m}"
+    }
+    v.create_backup
+    puts "Backup completed #{File.basename( v.config_file )}"
+  end
+
+  desc "clear all backup files"
+  task :clear_backups do
+    v = VboxConfigAdmin.new
+    v.machines.each { |m|
+      v.clear_backups( m )
+      puts "Backup files for #{m} are deleted."
+    }
+    v.clear_backups
+    puts "Backup files for #{File.basename( v.config_file )}"
+  end
+end
+
+#
+# tasks for each machines
+#
+VboxConfigAdmin.new.machines.each { |m|
+  namespace m do
+    desc "getextradata from #{m}"
+    task :getextradata do
+      puts VboxConfigAdmin.new.getextradata( m )
+    end
+
+    desc "backup files of #{m}"
+    task :backup_files do
+      puts VboxConfigAdmin.new.backup_files( m )
+    end
+
+    desc "create backup for #{m}"
+    task :create_backup do
+      VboxConfigAdmin.new.create_backup( m )
+      puts "backup created."
+    end
+
+    desc "clear backup files for #{m}"
+    task :clear_backups do
+      VboxConfigAdmin.new.clear_backups( m )
+      puts "Backup files are deleted."
+    end
+
+    desc "open config file for #{m}"
+    task :open_config do
+      VboxConfigAdmin.new.open_config( m )
+    end
+
+    desc "open latest backup for #{m}"
+    task :open_latest_backup do
+      VboxConfigAdmin.new.open_latest_backup( m )
+    end
+  end
+}
+
+#
+# default task
+#
+task :default do
+  app = Rake.application
+  app.instance_eval {
+    @name = File.basename( __FILE__ )
+  }
+  app.options.show_task_pattern = Regexp.new('')
+  app.display_tasks_and_comments
+end

data/bin/vbox_config_admin.bat

@@ -0,0 +1,6 @@
+@ECHO OFF
+IF NOT "%~f0" == "~f0" GOTO :WinNT
+@"C:\Ruby\bin\rake.bat" "vbox_config_admin" %1 %2 %3 %4 %5 %6 %7 %8 %9
+GOTO :EOF
+:WinNT
+@"C:\Ruby\bin\rake.bat" -f "%~d0%~p0%~n0" %*

data/lib/vbox_config_admin.rb

@@ -0,0 +1,160 @@
+# -*- coding: utf-8 -*-
+
+require 'fileutils'
+
+#
+# require VBoxManage executable binary
+#
+
+class VboxConfigAdmin
+  VERSION = '0.0.2'
+
+  def version
+    cmdline = "#{manager} --version"
+    `#{cmdline}`.strip
+  end
+
+  def machine_base
+    return File.join( vm_root, 'Machines' )
+  end
+
+  def vm_root
+    home = ENV['HOME']
+    ['Library/VirtualBox', '.VirtualBox'].each { |dir|
+      d = File.join( home, dir )
+      if ( File.exist?( d ) and File.directory?( d ) )
+        return d
+      end
+    }
+  end
+
+  def machines
+    cmdline = "#{manager} list vms"
+    `#{cmdline}`.split( /(\r\n|[\r\n])/ ).map { |e|
+      e.strip.match( /\A"(.+)" \{[0-9a-z-]+\}\z/ )
+      $1
+    }.compact.sort
+  end
+
+  #
+  # VBoxManage binary
+  #
+  def manager
+    @manager
+
+    if ( !@manager )
+      if ( RUBY_PLATFORM =~ /win/ and RUBY_PLATFORM !~ /darwin/ )
+        @manager = which( 'VBoxManage.exe',
+                          'C:\Program Files\Sun\xVM VirtualBox' )
+      else
+        @manager = 'VBoxManage'
+      end
+    end
+
+    return @manager
+  end
+
+  def config_file( machine = nil )
+    if ( machine )
+      file = File.join( machine_base, machine, "#{machine}.xml" )
+    else
+      file = File.join( vm_root, 'VirtualBox.xml' )
+    end
+
+    return ( File.exist?( file ) and File.file?( file ) ) ? file : nil
+  end
+
+  def create_backup( machine = nil )
+    return FileUtils.cp( config_file( machine ), backup_file( machine ) )
+  end
+
+  def backup_file( machine = nil )
+    return config_file( machine ) +
+      '.bak' + Time.now.strftime( "%Y%m%d%H%M%S" ) + '.txt'
+  end
+
+  def backup_files( machine = nil )
+    path = File.dirname( config_file( machine ) )
+    return Dir.chdir( path ) {
+      Dir.glob( File.basename( config_file( machine ) ) +
+                '.bak[0-9]*.txt' ).map { |f|
+        File.join( path, f )
+      }
+    }
+  end
+
+  def clear_backups( machine = nil )
+    if ( machine )
+      backup_files( machine ).map { |e|
+        FileUtils.rm( e )
+      }
+    else
+      backup_files.map { |e|
+        FileUtils.rm( File.join( vm_root, e ) )
+      }
+    end
+  end
+
+  def open( file )
+    cmd = open_cmd
+    if ( cmd )
+      system( cmd, file )
+    else
+      # for Windows. Cannot open #{Machine}.xml, why ?
+      system( 'cmd.exe /c "' + file + '"' )
+    end
+  end
+
+  def open_config( machine )
+    open( config_file( machine ) )
+  end
+
+  def open_latest_backup( machine )
+    file = backup_files( machine ).sort.last
+    if ( file )
+      open( file )
+    else
+      puts "No backup."
+    end
+  end
+
+  def getextradata( machine )
+    call4vm( machine, 'getextradata', 'enumerate' )
+  end
+
+  private
+  def call4vm( machine, subcommand, *params )
+    if ( machines.include?( machine ) )
+      machine = '"' + machine + '"' if ( machine.include?(' ') )
+      cmdline = "#{manager} #{subcommand} #{machine} #{params.join(' ')}"
+      puts cmdline
+      `#{cmdline}`
+    end
+  end
+
+  def open_cmd
+    cmd = nil
+
+    if ( ENV['EDITOR'] )
+      cmd = ENV['EDITOR']
+    else
+      cmd = %w( gnome-open open start.com ).map { |cmd|
+        ( which( cmd ) ) ? cmd : nil
+      }.compact.first
+    end
+
+    return cmd
+  end
+end
+
+def which( cmd, *additional )
+  paths = ENV['PATH'].split( File::PATH_SEPARATOR )
+  if ( additional )
+    paths += additional
+  end
+  
+  return paths.map { |path|
+    file = File.join( path, cmd )
+    ( File.exist?( file ) ) ? file : nil
+  }.compact.first
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/vbox_config_admin'
+

data/test/vbox_config_admin_test.rb

@@ -0,0 +1,83 @@
+#! /usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require 'test/unit'
+require File.dirname( __FILE__ ) + '/../lib/vbox_config_admin'
+
+class Test_VboxConfigAdmin < Test::Unit::TestCase
+  def setup
+    @obj = VboxConfigAdmin.new
+  end
+
+  def test_version
+    assert( @obj.version.size > 0 )
+  end
+
+  def test_machine_base
+    assert( @obj.machine_base.size > 0 )
+  end
+
+  def test_vm_root
+    assert( @obj.vm_root.class == String )
+  end
+
+  def test_machines
+    assert( @obj.machines.class == Array )
+  end
+
+  def test_manager
+    assert( @obj.manager.size > 0 )
+  end
+
+  def test_config_file
+    @obj.machines.each { |m|
+      assert( @obj.config_file( m ).size > 0 )
+    }
+    assert( @obj.config_file.size > 0 )
+  end
+
+  def test_create_backup
+    @obj.machines.each { |m|
+      assert( @obj.backup_files( m ) == [] )
+      @obj.create_backup( m )
+      assert( @obj.backup_files( m ).size > 0 )
+      @obj.clear_backups( m )
+      assert( @obj.backup_files( m ) == [] )
+    }
+  end
+
+  def test_backup_file
+    @obj.machines.each { |m|
+      assert( @obj.backup_file( m ).size > 0 )
+    }
+    assert( @obj.backup_file.size > 0 )
+  end
+
+  def test_backup_files
+    # already tested in test_create_backup
+  end
+
+  def test_clear_backups
+    # already tested in test_clear_backups
+  end
+
+  def test_open
+    # don't know how to test
+  end
+
+  def test_open_config
+    # don't know how to test
+  end
+
+  def test_open_latest_backup
+    # don't know how to test
+  end
+
+  def 
+
+  def test_getextradata
+    @obj.machines.each { |m|
+      assert( @obj.getextradata( m ).size > 0 )
+    }
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: wtnabe-vbox_config_admin
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- wtnabe
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-12 00:00:00 -07:00
+default_executable: vbox_config_admin
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Create and delete backups for VirtualBox configuration, and open config & backups
+email: wtnabe@gmail.com
+executables: 
+- vbox_config_admin
+extensions: []
+
+extra_rdoc_files: 
+- README
+- ChangeLog
+files: 
+- README
+- ChangeLog
+- Rakefile
+- bin/vbox_config_admin
+- bin/vbox_config_admin.bat
+- test/test_helper.rb
+- test/vbox_config_admin_test.rb
+- lib/vbox_config_admin.rb
+has_rdoc: false
+homepage: ""
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --title
+- vbox_config_admin documentation
+- --charset
+- utf-8
+- --opname
+- index.html
+- --line-numbers
+- --main
+- README
+- --inline-source
+- --exclude
+- ^(examples|extras)/
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: 
+- rake
+rubyforge_project: ""
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Create and delete backups for VirtualBox configuration, and open config & backups
+test_files: 
+- test/vbox_config_admin_test.rb