dbgeni 0.10.0

data/lib/dbgeni/code_list.rb

@@ -0,0 +1,60 @@
+module DBGeni
+
+  class CodeList
+
+    attr_reader :code
+    attr_reader :code_directory
+
+    def initialize(code_directory)
+      @code_directory = code_directory
+      file_list
+    end
+
+    def current(config, connection)
+      @code.select{ |c| c.current?(config, connection) }
+    end
+
+    def outstanding(config, connection)
+      @code.select{ |c| ! c.current?(config, connection) }
+    end
+
+    def list(list_of_code, config, connection)
+      valid_code = []
+      list_of_code.each do |c|
+        code_obj = Code.new(config.code_dir, c)
+        if i = @code.index(code_obj)
+          valid_code.push @code[i]
+        else
+          raise DBGeni::CodeFileNotExist, c
+        end
+      end
+      valid_code.sort {|x,y|
+        x.sort_field <=> y.sort_field
+      }
+    end
+
+    private
+
+    def file_list
+      begin
+        # The allowed list of code filetypes is in the Code class.
+        # Use that list to form a dynamic regex so all the extensions are only in one place.
+        extensions = DBGeni::Code::EXT_MAP.keys
+        files = Dir.entries(@code_directory).grep(/\.(#{extensions.join('|')})$/).sort
+      rescue Exception => e
+        raise DBGeni::CodeDirectoryNotExist, "Code directory: #{@code_directory}"
+      end
+      @code = Array.new
+      files.each do |f|
+        @code.push DBGeni::Code.new(@code_directory, f)
+        @code.sort! {|x,y|
+          x.sort_field <=> y.sort_field
+        }
+      end
+    end
+
+  end
+
+end
+
+

data/lib/dbgeni/commands/code.rb

@@ -0,0 +1,151 @@
+if %w(-h --help).include? ARGV[0]
+  puts <<-EOF
+Usage: dbgeni code 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, all code files will be compiled 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 code modules
+            dbgeni code list --config-file /home/myapp/.dbgeni
+
+current     Prints all code modules that have been applied to an environment
+            dbgeni code applied --environment-name test --config-file /home/myapp/.dbgeni
+
+outstanding Prints all code modules that have not been applied to an environment
+            dbgeni code outstanding --environment-name test --config-file /home/myapp/.dbgeni
+
+
+Destructive
+-----------
+
+apply       Apply code modules to the given environment. Can specify:
+
+              all         Apply all code modules, even if they have already been applied.
+              outstanding Apply only code modules that have changed since they were last applied
+              specific code modules to apply
+
+            dbgeni code apply all     --environment-name test --config-file /home/myapp/.dbgeni <--force>
+            dbgeni code apply outstanding --environment-name test --config-file /home/myapp/.dbgeni <--force>
+            dbgeni code apply insert_t1_proc.prc admin_package.pkb --environment-name test --config-file /home/myapp/.dbgeni <--force>
+
+remove      Remove code modules from the given environment. Can specify:
+
+            all      Remove all code modules installed
+            specific code modules to remove
+
+            dbgeni code remove all  --environment-name test --config-file /home/myapp/.dbgeni <--force>
+            dbgeni code remove insert_t1_proc.prc admin_package.pkb --environment-name test --config-file /home/myapp/.dbgeni <--force>
+
+EOF
+  exit
+end
+
+command = ARGV.shift
+installer = $build_installer.call
+logger    = DBGeni::Logger.instance
+
+begin
+  case command
+  when 'list', 'current', 'outstanding'
+    method_mapper = {
+      'list'             => :code,
+      'current'          => :current_code,
+      'outstanding'      => :outstanding_code
+    }
+    code = installer.send(method_mapper[command])
+    if code.length == 0
+      if command == 'list'
+        logger.info "There are no code modules in #{installer.config.code_dir}"
+      else
+        logger.info "There are no code modules #{command}"
+      end
+      exit(0)
+    end
+    code.each do |c|
+      puts c.to_s
+    end
+  when 'apply'
+    sub_command = ARGV.shift
+    case sub_command
+    when 'all'
+      installer.apply_all_code($force)
+    when 'outstanding'
+      installer.apply_outstanding_code($force)
+    when /\.(#{DBGeni::Code::EXT_MAP.keys.join('|')})$/
+      # The param list are specific code files. 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 =~ /\.(#{DBGeni::Code::EXT_MAP.keys.join('|')})$/ }
+      files.unshift sub_command
+      installer.apply_list_of_code(files, $force)
+    else
+      logger.error "#{sub_command} is not a valid command"
+    end
+
+  when 'remove'
+    sub_command = ARGV.shift
+    case sub_command
+    when 'all'
+      installer.remove_all_code($force)
+    when /\.(#{DBGeni::Code::EXT_MAP.keys.join('|')})$/
+      files = ARGV.select{ |f| f =~ /\.(#{DBGeni::Code::EXT_MAP.keys.join('|')})$/ }
+      files.unshift sub_command
+      installer.remove_list_of_code(files, $force)
+    else
+      logger.error "#{sub_command} is not a valid command"
+    end
+  else
+    logger.error "#{command} is not a valid command"
+  end
+rescue DBGeni::NoOutstandingCode => e
+  logger.info "There are no outstanding code modules to apply"
+  exit(0)
+rescue DBGeni::NoCodeFilesExist => e
+  logger.error "There are no code files in the code_directory"
+  exit(1)
+rescue DBGeni::CodeApplyFailed => e
+#  logger.error "There was a problem applying #{e.to_s}"
+  exit(1)
+rescue DBGeni::CodeModuleCurrent => e
+  logger.error "The code module is already current #{e.to_s}"
+  exit(1)
+rescue DBGeni::CodeFileNotExist => e
+  logger.error "The code 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::CodeDirectoryNotExist
+  logger.error "The code directory does not exist"
+  exit(1)
+rescue DBGeni::DBCLINotOnPath
+  logger.error "The command line interface for the database is not on the path (sqlite3, sqlplus)"
+  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/commands.rb

@@ -0,0 +1,41 @@
+ARGV << '--help' if ARGV.empty?
+
+$initial_command = ARGV.shift
+
+case $initial_command
+  when 'new', 'new-config'             ,'n'
+  require 'dbgeni/commands/new'
+  when 'initialize'                    ,'i'
+  require 'dbgeni/commands/initialize'
+  when 'config'
+  require 'dbgeni/commands/config'
+  when 'generate'                      ,'g'
+  require 'dbgeni/commands/generate'
+  when 'migrations'                    ,'m'
+  require 'dbgeni/commands/migrations'
+  when 'dmls', 'dml'                   ,'d'
+  require 'dbgeni/commands/dmls'
+  when 'code'                          ,'c'
+  require 'dbgeni/commands/code'
+  when 'milestones'
+  require 'dbgeni/commands/milestones'
+
+  else
+  puts "Error: Command not recognized" unless %w(-h --help).include?($initial_command)
+  puts <<-EOT
+Usage: dbgeni COMMAND [ARGS]
+
+The available dbgeni commands are:
+  new        Generate a new default application directory structure
+  new-config Generate a templated config file in an existing directory
+  initialize Create the dbgeni_migrations table in the database
+  config     List the current config for a given environment
+  migrations List and Apply Migations
+  dmls       List and Apply DML Migrations
+  code       List, compile and remove stored procedures
+  generate   Generate migrations and code files
+
+All commands can be run with -h for more information.
+EOT
+end
+

data/lib/dbgeni/commands/config.rb

@@ -0,0 +1,36 @@
+if %w(-h --help).include? ARGV[0]
+  puts <<-EOF
+Usage:
+By default, dbgeni will search in the current directory for a config file
+called .dbgeni
+
+To list all the config for all environments:
+  dbgeni config
+
+To use a different config_file, specify the config_file switch:
+  dbgeni config environment_name --config_file </path/to/config/file>
+EOF
+  exit(0)
+end
+
+if ! File.exists?($config_file)
+  puts "error: The config file #{$config_file} does not exist"
+  exit(1)
+end
+
+begin
+  cfg = DBGeni::Config.load_from_file($config_file)
+rescue DBGeni::ConfigSyntaxError => e
+  puts "There is an error in the config file: #{e.to_s}"
+end
+puts "-----------------------------\n"
+puts "| Current Parameter Details |\n"
+puts "-----------------------------\n\n"
+puts cfg.to_s
+
+exit(0)
+
+
+
+
+

data/lib/dbgeni/commands/dmls.rb

@@ -0,0 +1,244 @@
+if %w(-h --help).include? ARGV[0]
+  puts <<-EOF
+Usage: dbgeni dmls 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 dml migrations
+            dbgeni dmls list --config-file /home/myapp/.dbgeni
+
+applied     Prints all dml migrations which have been applied to an environment
+            dbgeni dmls applied --environment-name test --config-file /home/myapp/.dbgeni
+
+outstanding Prints all dml migrations which have not been applied to an environment
+            dbgeni dmls outstanding --environment-name test --config-file /home/myapp/.dbgeni
+
+
+Destructive
+-----------
+
+apply       Apply dml migrations to the given environment. Can specify:
+
+              all       Apply all outstanding dml migrations
+              next      Apply only the next dml migration and stop
+              until     Apply upto and including the specified dml migration
+              specific dml migrations to apply
+              milestone Apply upto a specified milestone
+
+            dbgeni dmls apply all  --environment-name test --config-file /home/myapp/.dbgeni <--force>
+            dbgeni dmls apply next --environment-name test --config-file /home/myapp/.dbgeni <--force>
+            dbgeni dmls apply until YYYYMMDDHHMM::Name1 --environment-name test --config-file /home/myapp/.dbgeni <--force>
+            dbgeni dmls apply YYYYMMDDHHMM::Name1 YYYYMMDDHHMM::Name2 YYYYMMDDHHMM::Name3 --environment-name test --config-file /home/myapp/.dbgeni <--force>
+            dbgeni dmls apply milestone release_1.0 --environment-name test --config-file /home/myapp/.dbgeni <--force>
+
+rollback    Run the rollback script for a given dml migration. Can specify:
+
+            all       Rollback everything that has even been applied
+            last      Rollback the last dml migration applied
+            until     Rollback from the last applied dml migration until and including the specified migration
+            specific migrations to rollback
+
+            dbgeni dmls rollback all  --environment-name test --config-file /home/myapp/.dbgeni <--force>
+            dbgeni dmls rollback last --environment-name test --config-file /home/myapp/.dbgeni <--force>
+            dbgeni dmls rollback until YYYYMMDDHHMM::Name1 --environment-name test --config-file /home/myapp/.dbgeni <--force>
+            dbgeni dmls rollback YYYYMMDDHHMM::Name1 YYYYMMDDHHMM::Name2 YYYYMMDDHHMM::Name3 --environment-name test --config-file /home/myapp/.dbgeni <--force>
+            dbgeni dmls 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.dmls
+    if migrations.length == 0
+      logger.info "There are no dml migrations in #{installer.config.dml_directory}"
+    end
+    migrations.each do |m|
+      puts m.to_s
+    end
+  when 'applied'
+    applied = installer.applied_dmls
+    if applied.length == 0
+      logger.info "There are no applied dml migrations in #{installer.config.dml_directory}"
+    end
+    applied.each do |m|
+      puts m.to_s
+    end
+  when 'outstanding'
+    outstanding = installer.outstanding_dmls
+    if outstanding.length == 0
+      logger.info "There are no outstanding dml migrations in #{installer.config.dml_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_dmls($force)
+    when 'next'
+      installer.apply_next_dml($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.dml_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.dml_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 dml 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 dml migration name"
+        exit(1)
+      end
+      installer.apply_until_dml(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_dmls(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_dmls($force)
+    when 'last'
+      installer.rollback_last_dml($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.dml_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.dml_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 dml 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 dml migration name"
+        exit(1)
+      end
+      installer.rollback_until_dml(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_dmls(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 dml 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 dml migration is already applied #{e.to_s}"
+  exit(1)
+rescue DBGeni::MigrationFileNotExist => e
+  logger.error "The dml 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 dml 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 dml 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)