kvm 0.0.1.pre

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in kvm.gemspec
+gemspec
+
+platforms :jruby do
+  gem 'jruby-openssl'
+end

data/Gemfile.lock

@@ -0,0 +1,32 @@
+PATH
+  remote: .
+  specs:
+    kvm (0.0.1.pre)
+      thor
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bouncy-castle-java (1.5.0146.1)
+    builder (3.0.0)
+    ci_reporter (1.6.4)
+      builder (>= 2.1.2)
+    fakeweb (1.3.0)
+    jruby-openssl (0.7.4)
+      bouncy-castle-java
+    rake (0.9.0)
+    rcov (0.9.9)
+    rcov (0.9.9-java)
+    thor (0.14.6)
+
+PLATFORMS
+  java
+  ruby
+
+DEPENDENCIES
+  ci_reporter
+  fakeweb
+  jruby-openssl
+  kvm!
+  rake
+  rcov

data/LICENSE

@@ -0,0 +1,23 @@
+= KVM
+
+Copyright (c) 2010 Incandescent Software LLC
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+== Additional Bundled Software
+
+Apache Ant is licensed according to the terms of Apache License, Version 2.0. See http://www.apache.org/licenses/LICENSE-2.0 for details.
+
+Kuali Rice datasets used in unit tests are licensed according to the terms of the Educational Community License 2.0.  See http://www.opensource.org/licenses/ecl2.php for details.
+

data/README.md

@@ -0,0 +1,73 @@
+Overview
+========
+
+
+Requirements
+============
+
+* JRuby (ideally through RVM)
+* manual install of jruby-openssl gem: `rvm use jruby; gem install jruby-openssl gem`
+
+
+Usage
+=====
+
+    kvm --help
+    
+    Tasks:
+      kvm checkout <relative repo> [path]                                        ...
+      kvm config                                                                 ...
+      kvm create-user <db options> <username> <password>                         ...
+      kvm def <db options with alias>                                            ...
+      kvm drop-user <username>                                                   ...
+      kvm fetch <project>-<version>[-dist]                                       ...
+      kvm generate-datasets <project>-<version> [-d dataset1,dataset2] [-t oracle...
+      kvm get <project>-<version>[-dist]                                         ...
+      kvm help [TASK]                                                            ...
+      kvm install-dataset <db options> <project>-<version> dataset [type]        ...
+      kvm install-testtables <db options> <project>-<version> [type]             ...
+      kvm list                                                                   ...
+      kvm list-datasets                                                          ...
+      kvm run-sql file <db options>                                              ...
+      kvm undef <alias>                                                          ...
+      kvm update <relative repo> [path]                                          ...
+
+To generate dataset SQL:
+
+    kvm generate-datasets rice-1.0.3.1
+
+To install SQL:
+
+    kvm install-dataset --url jdbc:oracle:thin:@localhost:1521:xe --username rice_test --password rice_test rice-1.0.3.1 bootstrap-server oracle
+
+Database Arguments
+==================
+
+Several commands take database connection arguments.  A database connection consists of:
+
+* jdbc url
+* username
+* password
+* type (oracle or mysql)
+
+There are two provisions for specifying these components, either directly, or via the `--db` options hash, and the two styles can be mixed.
+
+Directly: `--url jdbc:oracle:thin:@127.0.0.1:1521:xe --username user --password password --type oracle`
+
+Options hash: `--url jdbc:oracle:thin:@127.0.0.1:1521:xe --db username:user password:password type:oracle`
+
+Two other options are also available:
+
+* alias
+* jar
+
+If you have defined a db alias (via `define-db` command) then you can simply use the `--alias mydb` option to refer to the predefined db alias.  This will save repetition.
+
+Some commands also require the JDBC driver jar to be specified.  This can be done via the `--jar /path/to/ojdbc14.jar` option.
+
+Improvements
+============
+
+* better command documentation
+* better effort at automatically locating jdbc driver jars, and saving with db aliases
+* secure wallet functionality is sort of lame, it would be nice to take advantage of native keychain functionality if it exists

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'bundler/setup'
+#require 'test/unit'
+require 'rake/testtask'
+require 'rcov/rcovtask'
+# to get xunit test results: rake ci:setup:testunit test
+require 'ci/reporter/rake/test_unit'
+
+Bundler::GemHelper.install_tasks
+
+# integration test files
+INT_TEST_FILES = FileList['test/int_test*.rb']
+
+# helper to dry up tasks
+def def_test(t, opts = {})
+  t.libs << "test"
+  t.test_files = opts[:test_files] if opts[:test_files]
+  t.rcov_opts += opts[:rcov_opts] if opts[:rcov_opts]
+  t.verbose = true
+end
+
+Rake::TestTask.new do |t|
+  def_test(t)
+end
+
+Rake::TestTask.new(:integration) do |t|
+  def_test(t, :test_files => INT_TEST_FILES)
+end
+
+task :test_all => [ :test, :integration ]
+
+RCOV_OPTS = [ '--xrefs', # comment to disable cross-references
+              '--html',
+              '--exclude /gems/' ] # '-a'
+              
+#desc "Create a cross-referenced code coverage report."
+Rcov::RcovTask.new do |t|
+  def_test(t, :rcov_opts => RCOV_OPTS)
+end
+
+Rcov::RcovTask.new(:rcov_integration) do |t|
+  def_test(t, :test_files => INT_TEST_FILES, :rcov_opts => RCOV_OPTS)
+end
+
+Rcov::RcovTask.new(:rcov_all) do |t|
+  # test_files field not accessible on RcovTask? meh
+  def_test(t, :test_files => FileList['test/test*.rb'] + INT_TEST_FILES, :rcov_opts => RCOV_OPTS)
+end

data/bin/kvm

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# runs kvm
+# in development, use: bundle exec ./bin/kvm
+require 'kvm'
+
+KVM::App.start

data/kvm.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "kvm/version"
+
+Gem::Specification.new do |s|
+  s.name        = "kvm"
+  s.version     = KVM::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Aaron Hamid"]
+  s.email       = ["aaron@incandescentsoftware.com"]
+  s.homepage    = ""
+  s.summary     = %q{Kuali Version Manager}
+  s.description = %q{Kuali Version Manager}
+
+  s.rubyforge_project = "kvm"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency 'thor'
+  #s.add_dependency 'rake' # for jruby ant integration
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rcov'
+  s.add_development_dependency 'ci_reporter'
+  s.add_development_dependency 'fakeweb'
+end

data/lib/kvm.rb

@@ -0,0 +1,286 @@
+# jruby should be run in 1.9 mode
+# if you are using RVM:
+# mkdir ~/.rvm/hooks
+# cat > ~/.rvm/hooks/after_use <<EOF
+# case "$GEM_HOME" in
+#   *jruby*)
+#     JRUBY_OPTS="--1.9" ; export JRUBY_OPTS
+#   ;;
+# esac
+# EOF
+
+require "rubygems" # ruby1.9 doesn't "require" it though
+require "thor"
+require "openssl"
+require "base64"
+require "digest/sha2"
+require "ostruct"
+require "pp"
+
+KVM_DIR=File.expand_path('.kvm', '~')
+
+require 'kvm/db/types'
+require 'kvm/wallet'
+require 'kvm/impex'
+require 'kvm/rice_release'
+require 'kvm/rice_release_generated_dataset'
+require 'kvm/archive'
+require 'kvm/source'
+require 'kvm/log'
+
+# https://wiki.kuali.org/display/KULRICE/Creating+a+New+Revision+of+Rice
+class KVM::App < Thor
+  #SQL_TOOL = {
+  #  # sqlplus can't deal with blank lines without 'set blanklines' option; ripping out the blank lines with sed seems to be the simplest approach
+  #  "oracle" => lambda { |username, password, host, file| "sed '/^[ \t]*$/d' #{file} | sed '/^--.*$/d' | sqlplus -S -L #{username}/#{password}@#{host}" }
+ 
+  private 
+
+  # class helper for defining common database arguments to a Thor command
+  def self.db_method_options
+    method_options :url => :string, :username => :string, :password => :string, :type => :string, :jar => :string, :alias => :string
+  end
+
+  public
+
+  desc "fetch <project>-<version>[-dist]", "download a release"
+  method_option :dist, :aliases => "-d", :default => "bin"
+  def fetch(name)
+    archive = KVM::Archive.new(name, options[:dist])
+    archive.get || puts("Archive #{name} has already been fetched: #{archive.name}")
+  end
+
+  desc "get <project>-<version>[-dist]", "download and expand a release"
+  method_option :dist, :aliases => "-d", :default => "bin"
+  def get(name)
+    release = KVM::RiceRelease.new(name, options[:dist])
+    release.get || puts("Release #{name} has already been downloaded: #{release.name}")
+  end
+  
+  desc "list", "list downloaded releases"
+  def list
+    KVM::RiceRelease.list.each { |r| puts r.name }
+  end
+  
+  desc "list-datasets", "lists generated datasets"
+  def list_datasets(project=nil)
+    datasets = KVM::RiceReleaseGeneratedDataset.list
+    for dataset in datasets
+      puts "#{dataset.project} #{dataset.ds_name} #{dataset.db_type}"
+    end
+  end
+  
+  desc "generate-datasets <project>-<version> [-d dataset1,dataset2] [-t oracle|mysql]", "generates DDL for the specified project; if datasets or database type are omitted, all sets/types are generated"
+  method_option :datasets, :aliases => "-d", :type => :array
+  method_option :types, :aliases => "-t", :type => :string
+  def generate_datasets(project)
+    release = KVM::RiceRelease.new(project)
+    release.get
+
+    dataset_list = (options[:datasets] || release.datasets)
+    # generate sql of each type...
+    if options[:types]
+      db_types = options[:types].split('|')
+    else
+      db_types = KVM::Db::DB_TYPES
+    end
+    for db_type in db_types
+      # for each dataset
+      for ds_name in dataset_list
+        dataset = KVM::RiceReleaseGeneratedDataset.new(release.name, ds_name, db_type)
+        dataset.get
+      end
+    end
+  end
+  
+  desc "install-dataset <db options> <project>-<version> dataset [type]", "installs specified dataset"
+  db_method_options
+  def install_dataset(project, ds_name, type=nil)
+    db_config = parse_db_options(options)
+    validate_db_options(db_config)
+    type = resolve_db_type(db_config, type)
+
+    release = KVM::RiceRelease.new(project)
+    release.get
+    # generate sql if missing
+    KVM::LOG.debug "DATASET: " + ds_name
+    dataset = KVM::RiceReleaseGeneratedDataset.new(release.name, ds_name, type)
+    dataset.get
+
+    KVM::LOG.debug "Dataset path:"
+    KVM::LOG.debug dataset.path
+    KVM::LOG.debug dataset.exists?
+        
+    KVM::Impex::IMPEX_SOURCE.get
+    KVM::Impex::IMPEX.apply_sql(dataset.path, type, db_config.url, db_config.username, db_config.password)
+  end
+  
+  # ./bin/kvm install-testtables rice-1.0.3.1 oracle --db=alias:oraclexe-system jar:$HOME/.m2/repository/com/oracle/ojdbc14/10.2.0.3.0/ojdbc14-10.2.0.3.0.jar
+  desc "install-testtables <db options> <project>-<version> [type]", "installs test tables"
+  db_method_options
+  def install_testtables(project, type=nil)
+    db_config = parse_db_options(options)
+    validate_db_options(db_config)
+    type = resolve_db_type(db_config, type)
+    
+    release = KVM::RiceRelease.new(project)
+    release.get
+    run_sql_file(db_config, release.test_sql_file(type), true)
+  end
+
+  desc "run-sql file <db options>", "runs a sql file"
+  db_method_options
+  def run_sql(file)
+    db_config = parse_db_options(options)
+    validate_db_options(db_config)
+    resolve_db_type(db_config, nil)
+    run_sql_file(db_config, File.expand_path(file), false)
+  end
+  
+  desc "checkout <relative repo> [path]", "checks out a Kuali project from subversion"
+  def checkout(repo, path="trunk")
+    src = Source.new(repo, path)
+    src.get || puts("#{repo} #{path} already checked out: #{src.path}")
+  end
+  
+  desc "update <relative repo> [path]", "updates a checked out Kuali project"
+  def update(repo, path="trunk")
+    src = Source.new(repo, path)
+    src.get
+    src.update
+  end
+  
+  # ./bin/kvm drop-user rice_test --db=alias:oraclexe-system jar:$HOME/.m2/repository/com/oracle/ojdbc14/10.2.0.3.0/ojdbc14-10.2.0.3.0.jar
+  desc "drop-user <username>", "drops a database user"
+  db_method_options
+  def drop_user(username)
+    db_config = parse_db_options(options)
+    validate_db_options(db_config)
+
+    db_type = resolve_db_type(db_config, nil, 'oracle')
+    db = KVM::Db::JdbcAdapter.new(db_config)
+    # prepared statement doesn't work for drop? http://forums.oracle.com/forums/thread.jspa?threadID=504808
+    db.execute_update(KVM::Db::DB_PLATFORMS[db_type].drop_user(username))
+  end
+  
+  desc "create-user <db options> <username> <password>", "creates a database user"
+  db_method_options
+  def create_user(username, password)
+    db_config = parse_db_options(options)
+    validate_db_options(db_config)
+    
+    KVM::LOG.debug db_config
+    db_type = resolve_db_type(db_config, nil, 'oracle')
+    db = KVM::Db::JdbcAdapter.new(db_config)
+    # oracle-specific
+    # prepared statement doesn't work for drop? http://forums.oracle.com/forums/thread.jspa?threadID=504808
+    db.execute_update(KVM::Db::DB_PLATFORMS[db_type].create_user(username, password))
+  end
+  
+  desc "def <db options with alias>", "creates a database definition alias."
+  db_method_options
+  def def
+    db = parse_db_options(options)
+    
+    raise "alias is required" unless db.alias
+    
+    w = load_wallet
+    dbs = w.data['jdbc'] || {}
+    dbs[name] = {
+      'type' => db.type,
+      'url' => db.url,
+      'username' => db.username,
+      'password' => db.password
+    }
+    w.data['jdbc'] = dbs
+    w.save
+    puts "Saved #{name} alias:"
+    pp w.data
+  end
+  
+  desc "undef <alias>", "deletes a database definition alias"
+  def undef(name)
+    w = load_wallet
+    dbs = w.data['jdbc'] || {}
+    dbs.delete(name)
+    w.data['jdbc'] = dbs
+    w.save
+    puts "Deleted #{name} alias:"
+    pp w.data
+  end
+  
+  desc "config", "prints the kvm config"
+  def config
+    w = load_wallet
+    pp w.data
+  end
+  
+  protected
+
+  # uses the db type from either the specified type or the db alias
+  # raises an exception if missing and default is nil
+  def resolve_db_type(db_config, type, default=nil)
+    db_config.db_type = type if type
+    db_config.db_type = default unless db_config.db_type
+    raise "Database type must be specified" unless db_config.db_type
+    db_config.db_type
+  end
+
+  def run_sql_file(db_config, file, strip_eol = false)
+    db = KVM::Db::JdbcAdapter.new(db_config)
+    statements = KVM::Db::DB_PLATFORMS[db_config.db_type].parse_sql(db, file)
+    # fix strange problem with test create table sql... identifier error unless eols are removed
+    statements.map! { |s| s.gsub(/[\r\n]+/, ' ') } if strip_eol
+    db.execute_update(statements)
+  end
+
+  # parses database command line options, consulting wallet if alias is specified
+  def parse_db_options(options)
+    # required to merge url, username, password opts into db hash
+    # because thor has a funky hash argument syntax that can't be used
+    # with jdbc urls
+    db = options[:db] || {}
+    db['url'] = options[:url]
+    db['username'] = options[:username]
+    db['password'] = options[:password]
+    db['type'] = options[:type]
+    db['jar'] = options[:jar]
+        
+    raise "No database settings specified" unless db.size > 0
+
+    db_alias = db['alias']
+    if db_alias
+      w = load_wallet
+      db_def = nil
+      db_def = w.data['jdbc'][db_alias] if !w.data['jdbc'].nil?
+      raise "Alias not found: #{db_alias}" unless db_def      
+      db = db.merge(db_def)
+    end
+    db_config = OpenStruct.new
+    db_config.alias = db['alias']
+    db_config.url = db['url']
+    db_config.username = db['username']
+    db_config.password = db['password']
+    db_config.jar = db['jar']
+    db_config.db_type = db['type']
+    db_config
+  end
+  
+  def validate_db_options(db)
+    raise("Database url not specified") unless db.url
+    raise("Database username not specified") unless db.username
+    raise("Database password not specified") unless db.password
+  end
+  
+  def load_wallet
+    KVM::Wallet.new(File.expand_path("~/.kvm_data"), File.expand_path("~/.ssh/id_rsa"))
+  end
+  
+  def rice_server_bootstrap_dataset_path(version)
+    "#{RICE_SERVER_DB_REPO_PATH}/rice-release-#{version.gsub('\.', '-')}-br"
+  end
+  
+  def rice_client_bootstrap_dataset_path(version)
+    "#{RICE_CLIENT_DB_REPO_PATH}/rice-release-#{version.gsub('\.', '-')}-br"
+  end
+end