checkjob.rb #2

  • //
  • guest/
  • robert_cowham/
  • perforce/
  • utils/
  • triggers/
  • checkjob.rb
  • View
  • Commits
  • Open Download .zip Download (2 KB)
#!/usr/bin/ruby
#--
#-------------------------------------------------------------------------------
#++
#
#= Introduction
#
#== Name:   checkjob.rb
#
#== Author: Tony Smith        <tony@perforce.com>
#
#== Description
#
#     Example trigger to ensure that all changelists being
#     submitted have at least one job associated.
#                  
#== Requires
#     Ruby
#     P4Ruby
#     P4Triggers module
#
#== Example 'triggers' section
#
#     Triggers:
#        checkjob  //...  "ruby whatever/checkjob.rb %changelist%"
#
#== Note
#
#     For triggers I recommend you use a P4CONFIG file rather than hard coding
#     username/password in the script itself. This script assumes you've taken
#     that advice.
#
#--
#-------------------------------------------------------------------------------
#++
$:.unshift( File.dirname( __FILE__ ) )
require "P4"
require "P4Triggers"

#
# The trigger class itself. The main method in here is validate() which
# is invoked from the super-class' parse_change() method.
#
class JobTrigger < P4Trigger

    #
    # The error message we give to the user
    #
    @@USER_MESSAGE = 
    "\n\n" +
    "Your submission has been rejected because there are no jobs\n" +
    "associated with this change. Please associate a job with this \n" +
    "changelist and try again\n\n"

    # Do the enforcement.
    def validate()
        if ( change.jobs.length() == 0 )
            message( @@USER_MESSAGE )
            return false
        end
        return true
    end

end

#--
#-------------------------------------------------------------------------------
# Start of main script execution
#-------------------------------------------------------------------------------
#++

# By this stage it's pretty simple. Even argument validation is handled by
# the P4Trigger class so we don't even need to check that we were passed
# a changelist number.
jt = JobTrigger.new
exit( jt.parse_change( ARGV.shift ) )
# Change User Description Committed
#2 6016 Robert Cowham Untabify
#1 6014 Robert Cowham Bring in Tony's latest trigger changes
//guest/tony_smith/perforce/P4Rubylib/triggers/checkjob.rb
#2 3637 Tony Smith Add RDoc documentation to the sample triggers.
#1 3634 Tony Smith Kick off a library of P4Ruby resources with some sample trigger
implementations based on Jeff Bowles and Wes Peters' scripts.
These are not strict ports of their scripts to P4Ruby, but are
roughly in the same area.