dbgeni 0.10.0

data/lib/dbgeni/commands/generate.rb

@@ -0,0 +1,257 @@
+def usage
+  puts <<-EOF
+Usage:
+
+The generate command is a helper to create appropriately named db migration
+and code files.
+
+Use --config-file to specify the config file to use. If none is specified
+then a file called .dbgeni will be used if it is present in the current directory,
+otherwise an error will be raised.
+
+Usage:
+dbgeni generate command parameters
+
+The allowed commands are:
+
+migration  Generates a set of files for a new database migration. The only parameter
+           is a name for the migration:
+             dbgeni generate migration name_for_this_migration
+
+dml_migration  Generates a set of files for a new dml database migration. The only parameter
+               is a name for the migration:
+                dbgeni generate dml_migration name_for_this_migration
+
+
+milestone  Generates a milestone, which is like a tag on a particular migration indicating
+           that a migration completes a release of the application
+             dbgenu generate milestone name_for_milestone existing_migration_for_milestone
+
+package    Generates a pair of files for a plsql package with the given package name
+             dbgeni generate package my_package_name
+
+procedure  Generates a file for a stored procedure with the given procedure name
+             dbgeni generate procedure my_procedure_name
+
+function   Generates a file for a stored function with the given function name
+             dbgeni generate function my_procedure_name
+
+trigger    Generates a file for a trigger with the given trigger name
+             dbgeni generate trigger my_trigger_name
+
+type       Generates a file for a type definition with the given type name
+             dbgeni generate type my_type_name
+
+EOF
+end
+
+if %w(-h --help).include? ARGV[0]
+  usage
+  exit(0)
+end
+
+command = ARGV.shift
+name    = ARGV.shift
+
+unless name
+  puts "error: You must specify a name for the #{command}"
+  exit(1)
+end
+
+require 'fileutils'
+
+config = DBGeni::Config.load_from_file($config_file)
+
+case command
+when 'migration', 'mig'
+  datestamp = Time.now.strftime('%Y%m%d%H%M')
+  %w(up down).each do |f|
+    filename = File.join(config.migration_directory, "#{datestamp}_#{f}_#{name}.sql")
+    puts "creating: #{filename}"
+    FileUtils.touch(filename)
+  end
+when 'dml_migration', 'dml'
+  datestamp = Time.now.strftime('%Y%m%d%H%M')
+  %w(up down).each do |f|
+    filename = File.join(config.dml_directory, "#{datestamp}_#{f}_#{name}.sql")
+    puts "creating: #{filename}"
+    FileUtils.touch(filename)
+  end
+when 'package', 'pkg'
+  filename = File.join(config.code_dir, "#{name}.pks")
+  if File.exists?(filename)
+    puts "exists: #{filename}"
+  else
+    puts "creating: #{filename}"
+    File.open(filename, 'w') do |f|
+      f.puts "create or replace package #{name}"
+      f.puts "as"
+      f.puts "begin"
+      f.puts ""
+      f.puts "end #{name};"
+      f.puts "/"
+    end
+  end
+  filename = File.join(config.code_dir, "#{name}.pkb")
+  if File.exists?(filename)
+    puts "exists: #{filename}"
+  else
+    puts "creating: #{filename}"
+    File.open(filename, 'w') do |f|
+      f.puts "create or replace package body #{name}"
+      f.puts "as"
+      f.puts "begin"
+      f.puts ""
+      f.puts "end #{name};"
+      f.puts "/"
+    end
+  end
+when 'procedure', 'prc', 'proc'
+  filename = File.join(config.code_dir, "#{name}.prc")
+  if File.exists?(filename)
+    puts "exists: #{filename}"
+  else
+    puts "creating: #{filename}"
+    File.open(filename, 'w') do |f|
+      if config.db_type == 'oracle'
+        f.puts "create or replace procedure #{name}"
+        f.puts "as"
+        f.puts "begin"
+        f.puts "  null;"
+        f.puts "end #{name};"
+        f.puts "/"
+      elsif config.db_type == 'mysql'
+        f.puts "delimiter $$"
+        f.puts "drop procedure if exists #{name}$$"
+        f.puts "create procedure #{name}()"
+        f.puts "begin"
+        f.puts "end$$"
+      elsif config.db_type == 'sybase'
+        f.puts "if exists (select 1 from sysobjects"
+        f.puts "           where name = '#{name}'"
+        f.puts "           and type in ('P', 'TR'))"
+        f.puts "  drop proc #{name}"
+        f.puts "go"
+        f.puts ""
+        f.puts "create proc #{name}"
+        f.puts "as"
+        f.puts "return(0)"
+        f.puts "go"
+      end
+    end
+  end
+when 'function', 'fnc', 'func'
+  filename = File.join(config.code_dir, "#{name}.fnc")
+  if File.exists?(filename)
+    puts "exists: #{filename}"
+  else
+    puts "creating: #{filename}"
+    File.open(filename, 'w') do |f|
+      if config.db_type == 'oracle'
+        f.puts "create or replace function #{name}"
+        f.puts "  return varchar2"
+        f.puts "as"
+        f.puts "begin"
+        f.puts "  null;"
+        f.puts "end #{name};"
+        f.puts "/"
+      elsif config.db_type == 'mysql'
+        f.puts "delimiter $$"
+        f.puts "drop function if exists #{name}$$"
+        f.puts "create function #{name}()"
+        f.puts "  returns varchar(10)"
+        f.puts "begin"
+        f.puts "  return 'abcd';"
+        f.puts "end$$"
+      elsif config.db_type == 'sybase'
+        f.puts "if exists (select 1 from sysobjects"
+        f.puts "           where name = '#{name}'"
+        f.puts "           and type in ('P', 'TR'))"
+        f.puts "  drop func #{name}"
+        f.puts "go"
+        f.puts ""
+        f.puts "create func #{name}"
+        f.puts "  returns int"
+        f.puts "as"
+        f.puts "  return(0)"
+        f.puts "go"
+      end
+    end
+  end
+when 'trigger', 'trg'
+  filename = File.join(config.code_dir, "#{name}.trg")
+  if File.exists?(filename)
+    puts "exists: #{filename}"
+  else
+    puts "creating: #{filename}"
+    File.open(filename, 'w') do |f|
+      if config.db_type == 'oracle'
+        f.puts "create or replace trigger #{name} before insert on TABLE"
+        f.puts "for each row"
+        f.puts "begin"
+        f.puts "  null;"
+        f.puts "end;"
+        f.puts "/"
+      elsif config.db_type == 'mysql'
+        f.puts "delimiter $$"
+        f.puts "drop trigger if exists #{name}$$"
+        f.puts "CREATE TRIGGER #{name} BEFORE INSERT ON TABLE"
+        f.puts "FOR EACH ROW"
+        f.puts "BEGIN"
+        f.puts "END$$"
+      elsif config.db_type == 'sybase'
+        f.puts "if exists (select 1 from sysobjects"
+        f.puts "           where name = '#{name}'"
+        f.puts "           and type in ('P', 'TR'))"
+        f.puts "  drop trigger #{name}"
+        f.puts "go"
+        f.puts ""
+        f.puts "create trigger #{name}"
+        f.puts "on MYTABLE"
+        f.puts "for insert, update"
+        f.puts ""
+        f.puts "go"
+      end
+    end
+  end
+when 'type', 'typ'
+  filename = File.join(config.code_dir, "#{name}.typ")
+  if File.exists?(filename)
+    puts "exists: #{filename}"
+  else
+    puts "creating: #{filename}"
+    File.open(filename, 'w') do |f|
+      f.puts "create or replace type #{name}"
+      f.puts "as"
+      f.puts "/"
+    end
+  end
+when 'milestone'
+  filename = File.join(config.migration_directory, "#{name}.milestone")
+  if File.exists?(filename)
+    puts "milestone already exists"
+    exit(1)
+  end
+  # The migration can be either the migration filename, or the internal :: name
+  migration = ARGV.shift
+  unless migration
+    puts "You must specify a migration for the milestone"
+    exit(1)
+  end
+  if migration =~ /::/ # internal name
+    migration = DBGeni::Migration.filename_from_internal_name(migration)
+  end
+  unless File.exists?(File.join(config.migration_directory, migration))
+    puts "The migration #{migration} does not exist"
+    exit(1)
+  end
+  File.open(filename, 'w') do |f|
+    f.puts migration
+  end
+  puts "creating: #{filename}"
+else
+  puts "Error: #{command} is not a invalid generator"
+  exit(1)
+end
+
+exit(0)

data/lib/dbgeni/commands/initialize.rb

@@ -0,0 +1,41 @@
+if %w(-h --help).include? ARGV[0]
+  puts <<-EOF
+Usage: dbgeni initialize <--environment-name env_name> <--config-file path/to/config> <--username user> <--password password>
+
+If config-file is not specified, then a file called .dbgeni in the current directory will be
+used if it exists, otherwise an error will occurr
+
+If there is more than one environment defined in the config file, then environment-name must
+be specified.
+
+-e can be used as an abbreviation for --environment-name
+-c can be used as an abbreviation for --config-file
+-u can be used as an abbreviation for --username
+-p can be used as an abbreviation for --password
+
+
+EOF
+  exit(0)
+end
+
+installer = $build_installer.call
+
+begin
+  logger = DBGeni::Logger.instance
+  installer.initialize_database
+  logger.info "Database initialized successfully"
+rescue DBGeni::DatabaseAlreadyInitialized
+  logger.error "The Database has already been initialized"
+  exit(1)
+rescue DBGeni::NoInitializerForDBType
+  logger.error "There is no initializer for the db_type setting"
+  exit(1)
+rescue DBGeni::NoConnectorForDBType
+  logger.error "There is no connector defined for the db_type setting"
+  exit(1)
+end
+
+exit(0)
+
+
+

data/lib/dbgeni/commands/migrations.rb

@@ -0,0 +1,243 @@
+if %w(-h --help).include? ARGV[0]
+  puts <<-EOF
+Usage: dbgeni migrations command <--environment-name env_name> <--config-file path/to/config> <--force> <--username user> <--password password>
+
+If config-file is not specified, then a file called .dbgeni in the current directory will be
+used if it exists, otherwise an error will occurr
+
+If there is more than one environment defined in the config file, then environment-name must
+be specified.
+
+If --force is specified, the migration will run to completion and be marked as Completed even
+if errors occur.
+
+-e can be used as an abbreviation for --environment-name
+-c can be used as an abbreviation for --config-file
+-f can be used as an abbreviation for --force
+-u can be used as an abbreviation for --username
+-p can be used as an abbreviation for --password
+
+
+Avaliable commands are:
+
+Readonly
+--------
+
+list        Prints out all available migrations
+            dbgeni migrations list --config-file /home/myapp/.dbgeni
+
+applied     Prints all migrations which have been applied to an environment
+            dbgeni migrations applied --environment-name test --config-file /home/myapp/.dbgeni
+
+outstanding Prints all migrations which have not been applied to an environment
+            dbgeni migrations outstanding --environment-name test --config-file /home/myapp/.dbgeni
+
+
+Destructive
+-----------
+
+apply       Apply migrations to the given environment. Can specify:
+
+              all       Apply all outstanding migrations
+              next      Apply only the next migration and stop
+              until     Apply upto and including the specified migration
+              specific migrations to apply
+              milestone Apply upto a specified milestone
+
+            dbgeni migrations apply all  --environment-name test --config-file /home/myapp/.dbgeni <--force>
+            dbgeni migrations apply next --environment-name test --config-file /home/myapp/.dbgeni <--force>
+            dbgeni migrations apply until YYYYMMDDHHMM::Name1 --environment-name test --config-file /home/myapp/.dbgeni <--force>
+            dbgeni migrations apply YYYYMMDDHHMM::Name1 YYYYMMDDHHMM::Name2 YYYYMMDDHHMM::Name3 --environment-name test --config-file /home/myapp/.dbgeni <--force>
+            dbgeni migrations apply milestone release_1.0 --environment-name test --config-file /home/myapp/.dbgeni <--force>
+
+rollback    Run the rollback script for a given migration. Can specify:
+
+            all       Rollback everything that has even been applied
+            last      Rollback the last migration applied
+            until     Rollback from the last applied migration until and including the specified migration
+            specific migrations to rollback
+
+            dbgeni migrations rollback all  --environment-name test --config-file /home/myapp/.dbgeni <--force>
+            dbgeni migrations rollback last --environment-name test --config-file /home/myapp/.dbgeni <--force>
+            dbgeni migrations rollback until YYYYMMDDHHMM::Name1 --environment-name test --config-file /home/myapp/.dbgeni <--force>
+            dbgeni migrations rollback YYYYMMDDHHMM::Name1 YYYYMMDDHHMM::Name2 YYYYMMDDHHMM::Name3 --environment-name test --config-file /home/myapp/.dbgeni <--force>
+            dbgeni migrations rollback milestone release_1.0 --environment-name test --config-file /home/myapp/.dbgeni <--force>
+
+EOF
+  exit
+end
+
+command = ARGV.shift
+
+installer = nil
+installer = $build_installer.call
+
+logger    = DBGeni::Logger.instance
+
+begin
+  case command
+  when 'list'
+    migrations = installer.migrations
+    if migrations.length == 0
+      logger.info "There are no migrations in #{installer.config.migration_directory}"
+    end
+    migrations.each do |m|
+      puts m.to_s
+    end
+  when 'applied'
+    applied = installer.applied_migrations
+    if applied.length == 0
+      logger.info "There are no applied migrations in #{installer.config.migration_directory}"
+    end
+    applied.each do |m|
+      puts m.to_s
+    end
+  when 'outstanding'
+    outstanding = installer.outstanding_migrations
+    if outstanding.length == 0
+      logger.info "There are no outstanding migrations in #{installer.config.migration_directory}"
+    end
+    outstanding.each do |m|
+      puts m.to_s
+    end
+
+  when 'apply'
+    sub_command = ARGV.shift
+    case sub_command
+    when 'all'
+      installer.apply_all_migrations($force)
+    when 'next'
+      installer.apply_next_migration($force)
+    when 'until', 'milestone'
+      migration_name = nil
+      if sub_command == 'milestone'
+        unless ARGV[0]
+          logger.error "A milestone must be specified"
+          exit(1)
+        end
+        unless File.exists? File.join(installer.config.migration_directory, "#{ARGV[0]}.milestone")
+          logger.error "The milestone #{ARGV[0]} does not exist"
+          exit(1)
+        end
+        migration_name = DBGeni::Migration.internal_name_from_filename(
+                            DBGeni::Migration.get_milestone_migration(
+                              installer.config.migration_directory, "#{ARGV[0]}.milestone"))
+      else
+        # a migration name needs to be the next parameter
+        migration_name = ARGV[0]
+      end
+
+      unless migration_name
+        logger.error "A migration name must be specified"
+        exit(1)
+      end
+      # and the migration needs to be in the correct format
+      unless migration_name =~ /^(\d{12})::/
+        logger.error "#{migration_name} is not a valid migration name"
+        exit(1)
+      end
+      installer.apply_until_migration(migration_name, $force)
+    when /^(\d{12})::/
+      # The param list are specific migration files, but in the internal format. One is
+      # stored in sub_command and the rest are in ARGV. Grab all params that match the
+      # parameter name format
+      files = ARGV.select{ |f| f =~ /^(\d{12})::/ }
+      files.unshift sub_command
+      installer.apply_list_of_migrations(files, $force)
+    else
+      logger.error "#{sub_command} is not a valid command"
+    end
+
+  when 'rollback'
+    sub_command = ARGV.shift
+    case sub_command
+    when 'all'
+      installer.rollback_all_migrations($force)
+    when 'last'
+      installer.rollback_last_migration($force)
+    when 'until', 'milestone'
+      migration_name = nil
+      if sub_command == 'milestone'
+        unless ARGV[0]
+          logger.error "You must specify a milestone"
+          exit(1)
+        end
+        unless File.exists? File.join(installer.config.migration_directory, "#{ARGV[0]}.milestone")
+          logger.error "The milestone #{ARGV[0]} does not exist"
+          exit(1)
+        end
+        migration_name = DBGeni::Migration.internal_name_from_filename(
+                            DBGeni::Migration.get_milestone_migration(
+                              installer.config.migration_directory, "#{ARGV[0]}.milestone"))
+      else
+        # a migration name needs to be the next parameter
+        migration_name = ARGV[0]
+      end
+
+      unless migration_name
+        logger.error "A migration name must be specified"
+        exit(1)
+      end
+      # and the migration needs to be in the correct format
+      unless migration_name =~ /^(\d{12})::/
+        logger.error "#{migration_name} is not a valid migration name"
+        exit(1)
+      end
+      installer.rollback_until_migration(migration_name, $force)
+    when /^(\d{12})::/
+      # The param list are specific migration files, but in the internal format. One is
+      # stored in sub_command and the rest are in ARGV. Grab all params that match the
+      # parameter name format
+      files = ARGV.select{ |f| f =~ /^(\d{12})::/ }
+      files.unshift sub_command
+      installer.rollback_list_of_migrations(files, $force)
+#      migrations = files.map {|f| DBGeni::Migration.initialize_from_internal_name(installer.config.migration_directory, f)}
+#      # Now attempt to run each migration ... backwards for rollback
+#      migrations.sort{|x,y| y.migration_file <=> x.migration_file}.each do |m|
+#        installer.rollback_migration(m, $force)
+#      end
+    else
+      logger.error "#{sub_command} is not a valid command"
+    end
+  else
+    logger.error "#{command} is not a valid command"
+  end
+rescue DBGeni::NoOutstandingMigrations => e
+  logger.info "There are no outstanding migrations to apply"
+  exit(0)
+rescue DBGeni::MigrationApplyFailed => e
+  logger.error "There was a problem #{command == 'rollback' ? 'rolling back' : 'applying' } #{e.to_s}"
+  exit(1)
+rescue DBGeni::MigrationAlreadyApplied => e
+  logger.error "The migration is already applied #{e.to_s}"
+  exit(1)
+rescue DBGeni::MigrationFileNotExist => e
+  logger.error "The migration file #{e.to_s} does not exist"
+  exit(1)
+rescue DBGeni:: DatabaseNotInitialized => e
+  logger.error "The database needs to be initialized with the command dbgeni initialize"
+  exit(1)
+rescue DBGeni::NoAppliedMigrations => e
+  logger.error "There are no applied migrations to rollback"
+  exit(1)
+rescue DBGeni::MigrationNotApplied => e
+  logger.error "#{e.to_s} has not been applied so cannot be rolledback"
+  exit(1)
+rescue DBGeni::MigrationNotOutstanding => e
+  logger.error "#{e.to_s} does not exist or is not outstanding"
+  exit(1)
+rescue DBGeni::DBCLINotOnPath => e
+  logger.error "The command line interface for the database is not on the path (sqlite3, sqlplus)"
+  exit(1)
+rescue DBGeni::MilestoneHasNoMigration => e
+  logger.error "The milestone does not contain a valid migration"
+  exit(1)
+rescue DBGeni::PluginDirectoryNotAccessible => e
+  logger.error "The plugin directory specified in config is not accessable: #{e.to_s}"
+  exit(1)
+rescue DBGeni::PluginDoesNotRespondToRun
+  logger.error "A pluggin was loaded that does not have a run method: #{e.to_s}"
+  exit(1)
+end
+
+exit(0)

data/lib/dbgeni/commands/milestones.rb

@@ -0,0 +1,52 @@
+if %w(-h --help).include? ARGV[0]
+  puts <<-EOF
+
+The milestone command can be used to list milestones.
+
+Usage: dbgeni milestones command <--environment-name env_name> <--config-file path/to/config> <--force>
+
+If config-file is not specified, then a file called .dbgeni in the current directory will be
+used if it exists, otherwise an error will occurr
+
+If there is more than one environment defined in the config file, then environment-name must
+be specified.
+
+If --force is specified, the migration will run to completion and be marked as Completed even
+if errors occur.
+
+-e can be used as an abbreviation for --environment-name
+-c can be used as an abbreviation for --config-file
+-f can be used as an abbreviation for --force
+
+
+Avaliable commands are:
+
+list      Prints out all available milestones
+          dbgeni milestones list
+
+EOF
+  exit(0)
+end
+
+command = ARGV.shift
+
+installer = nil
+installer = $build_installer.call
+
+begin
+  case command
+  when 'list'
+    milestones = Dir.entries(installer.config.migration_directory).grep(/milestone$/)
+    if milestones.length == 0
+      puts "There are no milestones in the migrations_directory"
+      exit(1)
+    end
+    milestones.each do |m|
+      puts m.gsub(/\.milestone/, '')
+    end
+  else
+    puts "#{command} is an invalid command"
+    exit(1)
+  end
+end
+