ps-voodoo 0.0.3 → 0.0.4

data/.gitignore

@@ -5,3 +5,5 @@
 TODO.md
 lib/voodoo/commands/test.rb
 pkg
+
+.DS_Store

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 JR
+Copyright (c) 2011 JR Bing
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,13 +1,21 @@
 VooDoo
 ===========
 
-VooDoo is a command line application to help automate some PeopleSoft administration activities that are typically performed locally.  
+VooDoo is a command line application to help automate some PeopleSoft
+administration activities that are typically performed locally.
 
 Why?
-----
-PeopleSoft installation and administration is tedious.  Migrating projects, generating compare reports, and running SQR's locally is a pain.
+---- 
 
-VooDoo alleviates some of this by providing a simple command line interface for interacting with your local PeopleTools installation using predefined settings for each of your environments.  For example, migrating a project between two environments using VooDoo is as simple as issuing the following command: 
+PeopleSoft installation and administration is tedious.
+Migrating projects, generating compare reports, and running SQR's
+locally is a pain.
+
+VooDoo alleviates some of this by providing a simple command line
+interface for interacting with your local PeopleTools installation
+using predefined settings for each of your environments. For example,
+migrating a project between two environments using VooDoo is as simple
+as issuing the following command:
 
     C:\> voodoo migrate TEST_PROJECT HRDEV HRTEST
 
@@ -22,7 +30,7 @@ VooDoo alleviates some of this by providing a simple command line interface for
 
 
 Super. What are the requirements?
-------------
+---------------------------------
 
 In order to run VooDoo, you'll first need the following:
 
@@ -82,7 +90,8 @@ To run a compare report:
     Name for output folder: VOODOO_TEST
     07/18/2011 13:09:54: Creating compare reports for SCRIPTING_TEST between FNDEV and FNSPTB
 
-If successful, the generated HTML output of the compare report will be opened in your default browser.  To see what else you can do, run: 
+If successful, the generated HTML output of the compare report will be
+opened in your default browser. To see what else you can do, run:
 
     C:\>voodoo help
       NAME:
@@ -107,6 +116,7 @@ If successful, the generated HTML output of the compare report will be opened in
         run appengine        runs an appengine against the specified environment
         run sqr              runs the specified sqr locally
         show                 shows configuration details for an environment
+        template datafix     creates a datafix folder with template files
 
       GLOBAL OPTIONS:
 
@@ -124,9 +134,15 @@ If successful, the generated HTML output of the compare report will be opened in
 Sounds too easy.  How does it work?
 ----------------------------------
 
-It's actually pretty simple.  Global and environment configuration data is stored in YAML files under the .voodoo folder in the user's HOME directory.  When commands are issued to VooDoo, it uses the environment configuration information to pass command line arguments to the local executable.  
+It's actually pretty simple. Global and environment configuration data
+is stored in YAML files under the .voodoo folder in the user's HOME
+directory. When commands are issued to VooDoo, it uses the environment
+configuration information to pass command line arguments to the local
+executable.
 
-In some situations the Windows registry is updated to set options that cannot be passed via the command line (project build output destinations, datamover output destinations).
+In some situations the Windows registry is updated to set options
+that cannot be passed via the command line (project build output
+destinations, datamover output destinations).
 
 
 Who wrote this thing?
@@ -149,8 +165,8 @@ distribute, sublicense, and/or sell copies of the Software, and to
 permit persons to whom the Software is furnished to do so, subject to
 the following conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF

data/bin/voodoo

@@ -9,9 +9,11 @@ program :name, 'Voodoo'
 program :version, Voodoo::VERSION
 program :description, 'Black Magic Utility for PeopleSoft Administration'
 
+global_option('--debug') { Voodoo.show_debugging }
+
 command :add do |c|
   c.syntax = 'voodoo add [environment name]'
-  c.summary = 'adds an environment to the configuration file'
+  c.summary = 'Adds an environment to the configuration file'
   c.description = 'Prompts for environment information and saves it to the environment configuration file'
   c.example 'Prompt for setup values before adding VDDMO to the configuration file', 'voodoo add VDDMO'
   c.action do |args|
@@ -21,7 +23,7 @@ end
 
 command :remove do |c|
   c.syntax = 'voodoo remove [environment name]'
-  c.summary = 'removes an environment from the configuration file'
+  c.summary = 'Removes an environment from the configuration file'
   c.description = 'Deletes the specified environment from the configuration file'
   c.example 'Removes the environment VDDMO from the configuration file', 'voodoo remove VDDMO'
   c.action do |args|
@@ -41,7 +43,7 @@ end
 
 command :show do |c|
   c.syntax = 'voodoo show [environment name]'
-  c.summary = 'shows configuration details for an environment'
+  c.summary = 'Shows configuration details for an environment'
   c.description = 'Outputs a table containing information about the specified environment'
   c.example 'Show information about VDDMO', 'voodoo show VDDMO'
   c.action do |args|
@@ -51,7 +53,7 @@ end
 
 command :config do |c|
   c.syntax = 'voodoo config'
-  c.summary = 'create global configuration settings'
+  c.summary = 'Create global configuration settings'
   c.description = 'Prompts for global configuration information and saves it to the configuration file'
   c.action do |args, options|
     c.when_called Voodoo::Commands.config
@@ -60,7 +62,7 @@ end
 
 command :compare do |c|
   c.syntax = 'voodoo compare [project] [source] [target]'
-  c.summary = 'create a compare report for the specified project'
+  c.summary = 'Create a compare report for the specified project'
   c.description = 'Creates an HTML compare report for the specified project and opens it in the default browser'
   c.example 'Create a compare report between two environments', 'voodoo compare EXAMPLE_PROJECT VDDEV VDTEST'
   c.action do |args|
@@ -70,7 +72,7 @@ end
 
 command :build do |c|
   c.syntax = 'voodoo build [project] [environment]'
-  c.summary = 'builds a project definition in the specified environment'
+  c.summary = 'Builds a project definition in the specified environment'
   c.description = 'Builds a project definition script for the specified project using AppDesigner and executes it in the target database'
   c.example 'Build specified project', 'voodoo build EXAMPLE_PROJECT VDTEST'
   c.action do |args|
@@ -80,7 +82,7 @@ end
 
 command :archive do |c|
   c.syntax = 'voodoo archive [project] [environment]'
-  c.summary = 'copies a project to file from the specified environment'
+  c.summary = 'Copies a project to file from the specified environment'
   c.description = 'Copies a project from the specified environment to file in the output directory'
   c.example 'Archive specified project', 'voodoo archive EXAMPLE_PROJECT VDTEST'
   c.action do |args|
@@ -90,7 +92,7 @@ end
 
 command :migrate do |c|
   c.syntax = 'voodoo migrate [project] [source] [target]'
-  c.summary = 'migrates a project between environments'
+  c.summary = 'Migrates a project between environments'
   c.description = 'Migrates a project between two environments after running a compare report and copying the objects to file'
   c.example 'Migrate project between environments', 'voodoo migrate EXAMPLE_PROJECT VDDEV VDTEST'
   c.action do |args|
@@ -100,7 +102,7 @@ end
 
 command :'run appengine' do |c|
   c.syntax = 'voodoo run appengine [ae_name] [environment]'
-  c.summary = 'runs an appengine against the specified environment'
+  c.summary = 'Runs an appengine against the specified environment'
   c.description = 'Runs an appengine against the specified PeopleSoft environment'
   c.example 'Run the VERSION appengine agains VDTEST', 'voodoo run appengine VERSION VDTEST'
   c.action do |args|
@@ -110,7 +112,7 @@ end
 
 command :'run sqr' do |c|
   c.syntax = 'voodoo run sqr [sqr name] [environment]'
-  c.summary = 'runs the specified sqr locally'
+  c.summary = 'Runs the specified sqr locally'
   c.description = 'Run the specified SQR locally using the sqr bin specified in the environment configuration.'
   c.example 'Run SQR', 'voodoo run sqr SETSPACE.sqr VDDEV'
   c.action do |args|
@@ -118,3 +120,13 @@ command :'run sqr' do |c|
   end
 end
 
+command :'template datafix' do |c|
+  c.syntax = 'voodoo template datafix [output folder]'
+  c.summary = 'Creates a datafix folder with sample files'
+  c.description = 'Create a folder and populate sample files to be updated with datafix SQL.'
+  c.example 'Create datafix folder', 'voodoo template datafix SAMPLE_DATAFIX'
+  c.action do |args|
+    Voodoo::Commands.template_datafix(args)
+  end
+end
+

data/lib/voodoo.rb

@@ -15,6 +15,10 @@ module Voodoo
       "#{Time.now.strftime("%m/%d/%Y %H:%M:%S")}: #{msg}\n"
     }
 
+  def self.show_debugging
+    LOG.level = Logger::DEBUG
+  end
+
   def self.libpath( *args )
     rv =  args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
     if block_given?

data/lib/voodoo/commands.rb

@@ -1,4 +1,5 @@
 require 'terminal-table/import'
+require 'mail'
 Voodoo.require_all_libs_relative_to(__FILE__)
 
 module Voodoo

data/lib/voodoo/commands/add.rb

@@ -5,7 +5,7 @@ module Voodoo
 
     def self.add(args=nil)
       settings = {}
-      puts "\n### Appdesigner/Datamover/AppEngine Settings ###"
+      puts "\n----Appdesigner/Datamover/AppEngine Settings------"
       if args.first.nil?
         name = ask("Database name: ").upcase
       else
@@ -13,11 +13,13 @@ module Voodoo
       end
       settings['db_type'] = ask("Database type: ", %w{ORACLE}) { |q| q.default = "ORACLE" }
       settings['app_username'] = ask("Application username: ")
+
+      puts "\n----Output Archive Settings-----------------------"
       if agree("\nWould you like to archive migration output files for this environment? (y/n) ") == true
         settings['migration_archive'] = get_path("Archive destination")
       end
 
-      puts "\n### SQR Settings ###"
+      puts "\n----SQR Settings----------------------------------"
       settings['db_username'] = ask("Database username: ") { |q| q.default = "sysadm" }
       settings['ps_home'] = get_path("PS_HOME directory")
 

data/lib/voodoo/commands/config.rb

@@ -5,9 +5,15 @@ module Voodoo
 
     def self.config
       settings = {}
-      puts "\n### Global Configuration Settings ###"
+      puts "\n----Global Configuration Settings-----------------"
       settings[:ps_home] = get_path("Local tools directory")
       settings[:migration_output_dir] = get_path("Default output directory for migration data")
+
+      if agree("\nWould you like to define email notification settings? (y/n) ") == true
+        settings[:mail_server] = ask("SMTP server: ")
+        settings[:smtp_port] = ask("SMTP port: ") { |q| q.default = "587" }
+        settings[:email_from] = ask("Email from address: ")
+      end
       Voodoo.write_config_file(settings)
     end
 

data/lib/voodoo/commands/run.rb

@@ -19,6 +19,7 @@ module Voodoo
           end
 
           migration = get_migration
+          puts migration.log_folder
 
           instance = Voodoo::Sqr.new
           instance.run(migration, target, sqr_name)

data/lib/voodoo/commands/template.rb

@@ -0,0 +1,49 @@
+require 'erb'
+
+module Voodoo
+
+  module Commands
+    extend self
+
+    class ErbBinding < OpenStruct
+      def get_binding
+        return binding()
+      end
+    end
+
+    def template_datafix(args=nil)
+
+      if args[0].nil?
+        datafix = get_migration
+      else
+        datafix = Migration.new(args.first.upcase)
+      end
+
+      records = ask("Records to be affected: ", Array)
+
+      backup_template = File.read(File.join((File.dirname(__FILE__)), '/templates/backup.dms').gsub!(File::SEPARATOR, File::ALT_SEPARATOR))
+      script_template = File.read(File.join((File.dirname(__FILE__)), '/templates/script.sql').gsub!(File::SEPARATOR, File::ALT_SEPARATOR))
+
+      vars = ErbBinding.new
+      vars.name = datafix.migration_name
+      vars.folder = datafix.migration_folder
+      vars.records = records
+      vars_binding = vars.send(:get_binding)
+
+      generated_backup = ERB.new(backup_template, 0, "%<>")
+      generated_script = ERB.new(script_template, 0, "%<>")
+
+      backup_file = File.join(datafix.migration_folder, 'backup.dms').gsub!(File::SEPARATOR, File::ALT_SEPARATOR)
+      puts "Creating file #{backup_file}"
+      File.open(backup_file, 'w') {|f| f.write(generated_backup.result(vars_binding))}
+
+      script_file = File.join(datafix.migration_folder, 'script.sql').gsub!(File::SEPARATOR, File::ALT_SEPARATOR)
+      puts "Creating file #{script_file}"
+      File.open(script_file, 'w') {|f| f.write(generated_script.result(vars_binding))}
+
+      # puts File.expand_path(__FILE__)
+    end
+
+  end
+
+end

data/lib/voodoo/commands/templates/backup.dms

@@ -0,0 +1,10 @@
+-- Datafix <%= name %>
+-- Created on: <%= Time.now.localtime.strftime("%m/%d/%Y") %>
+
+SET OUTPUT <%= folder %>\backup.dat;
+SET LOG <%= folder %>\backup.log;
+
+% records.each do |record|
+EXPORT <%= record.upcase %> WHERE ... ;
+% end
+

data/lib/voodoo/commands/templates/migration_email.erb

@@ -0,0 +1,20 @@
+
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+    <title>VooDoo Migration Email</title>
+  </head>
+  <body>
+    <h2>This is a header</h2>
+      <p>This is some text telling you about the migration that just happened.  </p>
+      <p>Here are the steps from the migration:  </p>
+        <ol>
+          <li>step one</li>
+          <li>step two</li>
+          <li>step three</li>
+        </ol>
+      <p>This is some additional information regarding the migration.</p>
+      <p><strong>VooDoo</strong></p>
+  </body>
+</html>

data/lib/voodoo/commands/templates/script.sql

@@ -0,0 +1,4 @@
+-- Datafix <%= name %>
+-- Created on: <%= Time.now.localtime.strftime("%m/%d/%Y") %>
+
+-- Insert sql inserts/updates/deletes here

data/lib/voodoo/migration.rb

@@ -3,28 +3,32 @@ module Voodoo
 
   class Migration
 
+    attr_reader :migration_folder
+    attr_reader :migration_name
+
     def initialize(name)
+      @migration_name = name
       @migration_folder = create_folder(File.join(CONFIGURATION.migration_output_dir, name))
     end
 
     def log_folder
-      @log_folder = create_folder(File.join(@migration_folder, 'logs').gsub!(File::SEPARATOR, File::ALT_SEPARATOR))
+      @log_folder = create_folder(File.join(@migration_folder, 'logs'))
     end
 
     def archive_folder
-      @archive_folder = create_folder(File.join(@migration_folder, 'archive').gsub!(File::SEPARATOR, File::ALT_SEPARATOR))
+      @archive_folder = create_folder(File.join(@migration_folder, 'archive'))
     end
 
     def sql_folder
-      @sql_folder = create_folder(File.join(@migration_folder, 'sql').gsub!(File::SEPARATOR, File::ALT_SEPARATOR))
+      @sql_folder = create_folder(File.join(@migration_folder, 'sql'))
     end
 
     def compare_folder(source, target)
-      create_folder(File.join(compare_base_folder, "#{source}_to_#{target}").gsub!(File::SEPARATOR, File::ALT_SEPARATOR))
+      @compare_folder = create_folder(File.join(compare_base_folder, "#{source}_to_#{target}"))
     end
 
     def export_folder(source)
-      create_folder(File.join(project_folder, source).gsub!(File::SEPARATOR, File::ALT_SEPARATOR))
+      @export_folder = create_folder(File.join(project_folder, source))
     end
 
     def continue?
@@ -34,22 +38,23 @@ module Voodoo
     end
 
     def copy_to_archive(archive_folder)
+      # add error handling
       FileUtils.cp_r(@migration_folder, archive_folder, :verbose => true)
     end
 
     private
 
     def project_folder
-      @project_folder = create_folder(File.join(@migration_folder, 'project').gsub!(File::SEPARATOR, File::ALT_SEPARATOR))
+      @project_folder = create_folder(File.join(@migration_folder, 'project'))
     end
 
     def compare_base_folder
-      @compare_base_folder = create_folder(File.join(@migration_folder, 'compares').gsub!(File::SEPARATOR, File::ALT_SEPARATOR))
+      @compare_base_folder = create_folder(File.join(@migration_folder, 'compares'))
     end
 
     def create_folder(folder_path)
       Dir.mkdir(folder_path) unless File.exists?(folder_path)
-      return folder_path
+      return folder_path.gsub!(File::SEPARATOR, File::ALT_SEPARATOR)
     end
 
   end

data/lib/voodoo/peopletools.rb

@@ -66,7 +66,7 @@ module Voodoo
       LOG.debug("Command line options are set to #{@command_line_options.join(" ")}")
 
       f = IO.popen(@executable + " " + @command_line_options.join(" "))
-      f.readlines.each { |line| LOG.info("#{line.chomp}")}
+      f.readlines.each { |line| puts ("#{line.chomp}")}
       f.close
 
       @command_line_options.clear

data/lib/voodoo/peopletools/sqr.rb

@@ -12,6 +12,7 @@ module Voodoo
     end
 
     def run(migration, target, sqr_name)
+      @sqr_name = sqr_name
       append(:sqr => File.join(target.ps_home, 'sqr', sqr_name).gsub!(File::SEPARATOR, File::ALT_SEPARATOR))
       append(:db_login => target.db_username + '/' + target.db_password + '@' + target.name)
       append(:input => File.join(target.ps_home, 'sqr').gsub!(File::SEPARATOR, File::ALT_SEPARATOR))
@@ -56,8 +57,9 @@ module Voodoo
       LOG.debug("Executable is set to #{@executable}")
       LOG.debug("Command line options are set to #{@command_line_options.join(" ")}")
 
+      puts "Running #{@sqr_name}..."
       f = IO.popen(@executable + " " + @command_line_options.join(" "))
-      f.readlines.each { |line| LOG.info("#{line.chomp}")}
+      f.readlines.each { |line| puts ("#{line.chomp}")}
       f.close
 
       @command_line_options.clear

data/lib/voodoo/version.rb

@@ -1,3 +1,3 @@
 module Voodoo
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ps-voodoo
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-18 00:00:00.000000000Z
+date: 2011-08-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
-  requirement: &21806580 !ruby/object:Gem::Requirement
+  requirement: &20414196 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 4.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *21806580
+  version_requirements: *20414196
 - !ruby/object:Gem::Dependency
   name: terminal-table
-  requirement: &21806256 !ruby/object:Gem::Requirement
+  requirement: &20413884 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: 1.4.2
   type: :runtime
   prerelease: false
-  version_requirements: *21806256
+  version_requirements: *20413884
 description: A small command line utility for helping with PeopleSoft administration
 email:
 - jrbing@gmail.com
@@ -60,6 +60,10 @@ files:
 - lib/voodoo/commands/remove.rb
 - lib/voodoo/commands/run.rb
 - lib/voodoo/commands/show.rb
+- lib/voodoo/commands/template.rb
+- lib/voodoo/commands/templates/backup.dms
+- lib/voodoo/commands/templates/migration_email.erb
+- lib/voodoo/commands/templates/script.sql
 - lib/voodoo/migration.rb
 - lib/voodoo/peopletools.rb
 - lib/voodoo/peopletools/appdesigner.rb
@@ -88,7 +92,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: ps-voodoo
-rubygems_version: 1.8.5
+rubygems_version: 1.8.7
 signing_key: 
 specification_version: 3
 summary: Black magic utility for PeopleSoft administration