P4Triggers.py #1

  • //
  • guest/
  • perforce_software/
  • sdp/
  • dev/
  • Server/
  • Unix/
  • p4/
  • common/
  • bin/
  • triggers/
  • P4Triggers.py
  • View
  • Commits
  • Open Download .zip Download (4 KB)
#
# P4Triggers.py
#
#
# Copyright (c) 2008, Perforce Software, Inc.  All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1.  Redistributions of source code must retain the above copyright
#	 notice, this list of conditions and the following disclaimer.
# 
# 2.  Redistributions in binary form must reproduce the above copyright
#	  notice, this list of conditions and the following disclaimer in the
#	 documentation and/or other materials provided with the distribution.
# 
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL PERFORCE SOFTWARE, INC. BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
# 
# $Id: //guest/perforce_software/sdp/dev/Server/Unix/p4/common/bin/triggers/P4Triggers.py#1 $
# 
# 
# # Base class for all Python based P4 triggers
#

from __future__ import print_function

import P4
from datetime import datetime
import sys

class P4Change:
	"""Encapsulates a Perforce change. Basically a pretty wrapping around p4.run_describe()"""
	def __init__( self, desc ):
		self.change = desc[ "change" ]
		self.user = desc[ "user" ]
		self.client = desc[ "client" ]
		self.desc = desc[ "desc" ]
		self.time = datetime.utcfromtimestamp( int( desc[ "time" ] ) )
		self.status = desc[ "status" ]
		
		self.files = []
		if "depotFile" in desc:
			for n, d in enumerate( desc[ "depotFile" ] ):
				df = P4.DepotFile(d)
				dr = df.new_revision()
				dr.type = desc[ "type" ][ n ]
				dr.rev = desc[ "rev" ][ n ]
				dr.action = desc[ "action" ][ n ]
				self.files.append( df )
		
		self.jobs = {}
		if "job" in desc:
			for n, j in enumerate( desc[ "job" ] ):
				self.jobs[j] = desc[ "jobstat" ][ n ]

DEFAULT_LOG = "p4triggers.log"

class P4Trigger:
	"""Base class for Perforce Triggers"""
	
	def __init__( self, **kargs):
		"""Constructor for P4Trigger. 
		   Keyword arguments are passed to the P4.P4() instance used"""
		
		logFileName = DEFAULT_LOG
		if "log" in kargs:
			logFileName = kargs["log"]
			del kargs["log"]
		
		self.log = open(logFileName, "a+")
	
		self.p4 = P4.P4(**kargs)
		
	def parseChange( self, changeNo ):
		try:
			self.p4.connect()
			self.setUp()
			
			self.change = self.getChange( changeNo )
			return 0 if self.validate() else 1
		except P4.P4Exception as err:
			return self.reportError(err)
		except:
			print("Exception during trigger execution: %s %s %s" % sys.exc_info(), file=self.log)
			return 1
		
		return 0
		
	def getChange( self, changeNo ):
		return P4Change( self.p4.run_describe( changeNo )[0] )
		
	def validate( self ):
		return True
	
	# method that sublasses can overwrite in order to complete the setup of P4 connection
	def setUp( self ):
		pass
	
	#
	# Method to send a message to the user. Just writes to stdout, but it's
	# nice to encapsulate that here.
	#
	def message( self, msg ):
		print( msg )

	def reportError( self , err ):
		"""Method to encapsulate error reporting to make sure
		   all errors are reported in a consistent way"""
		print( "Error during trigger execution:", file=self.log )
		self.reportP4Errors( self.log )
		print( sys.exc_info(), file=self.log ) 
		
		# return message to the user
		self.errorMessage()
		self.reportP4Errors( sys.stdout )
		
		return 1
	
	def reportP4Errors( self, channel ):
		for e in self.p4.errors:
			print( "ERROR: %s" % e, file=channel )
		for w in self.p4.warnings:
			print( "WARNING: %s" % w, file=channel )
 
		return 1
		
	# Default message for when things go wrong
	def errorMessage( self ):
		return """
	An error was encountered during trigger execution. Please
	contact your Perforce administrator and ask them to
	investigate the cause of this error
	"""
		
	
# Change User Description Committed
#18 26652 Robert Cowham This is Tom's change:

Introduced new 'Unsupported' directory to clarify that some files
in the SDP are not officially supported. These files are samples for
illustration, to provide examples, or are deprecated but not yet
ready for removal from the package.

The Maintenance and many SDP triggers have been moved under here,
along with other SDP scripts and triggers.

Added comments to p4_vars indicating that it should not be edited
directly. Added reference to an optional site_global_vars file that,
if it exists, will be sourced to provide global user settings
without needing to edit p4_vars.

As an exception to the refactoring, the totalusers.py Maintenance
script will be moved to indicate that it is supported.

Removed settings to support long-sunset P4Web from supported structure.

Structure under new .../Unsupported folder is:
   Samples/bin             Sample scripts.
   Samples/triggers        Sample trigger scripts.
   Samples/triggers/tests  Sample trigger script tests.
   Samples/broker          Sample broker filter scripts.
   Deprecated/triggers     Deprecated triggers.

To Do in a subsequent change: Make corresponding doc changes.
#17 26534 Robert Cowham Fix specification of p4user option which was getting confused with user being checked
#16 24435 C. Thomas Tyler Fixed bug in P4Triggers.py referencing an as-yet undefined function.

Changed default LOGS dir to /tmp for non-SDP environments.
#15 23830 Robert Cowham Refactor and move detection of shelved change up to P4Triggers.
Also WorkflowTriggers
#14 23671 Robert Cowham Tweak log setting for trigger logs
#13 23670 Robert Cowham Properly test CheckFixes when no matching project found.
#12 23526 Robert Cowham Fix typo
#11 23242 Robert Cowham Handle restricted changes (describe requires -f)
Don't overwrite a changed changelist description
#10 23152 Robert Cowham Refactor to push common arg_parse into P4Triggers
#9 22854 Robert Cowham Addressed pylint suggestions.
#8 22852 Robert Cowham Refactor reporting
#7 22851 Robert Cowham Works with job renaming now.
Trigger needs to be form-in not form-save.
#6 22850 Robert Cowham Refactored to move common stuff into P4Triggers.py
#5 21528 C. Thomas Tyler Merged Sven's change from @21316: Enhanced error output to print the actual exception.
#4 21286 C. Thomas Tyler SDP-ified log, moving p4triggers.log to ${LOGS}.
#3 21120 C. Thomas Tyler Corrected shebang line in CheckCaseTrigger.
Added manual-update version id to replace keyword tag.
#2 21101 C. Thomas Tyler SDP-ified; changed type to xtext, removed RCS keywoard.
#1 21100 C. Thomas Tyler Branched P4Triggers.py
//guest/robert_cowham/perforce/utils/triggers/P4Triggers.py
#2 19939 Robert Cowham Update with latest changes by Sven etc.
#1 7531 Robert Cowham Personal branch
//guest/sven_erik_knop/P4Pythonlib/triggers/P4Triggers.py
#5 7428 Sven Erik Knop Error output from Perforce is now written to the log file instead of stderr.
#4 7379 Sven Erik Knop Added output to a log file.
The default is the send output to p4triggers.log in the P4ROOT directory, this can be overridden with the parameter log=<path>
Also, errors now cause the trigger to fail with sensible output first.
#3 7372 Sven Erik Knop Rollback Rename/move file(s).
To folder "perforce" is needed.
#2 7370 Sven Erik Knop Rename/move file(s) again - this time to the right location inside a perforce directory.
#1 7367 Sven Erik Knop New locations for the Python triggers.
//guest/sven_erik_knop/perforce/P4Pythonlib/triggers/P4Triggers.py
#1 7370 Sven Erik Knop Rename/move file(s) again - this time to the right location inside a perforce directory.
//guest/sven_erik_knop/P4Pythonlib/triggers/P4Triggers.py
#1 7367 Sven Erik Knop New locations for the Python triggers.
//guest/sven_erik_knop/triggers/P4Triggers.py
#1 6413 Sven Erik Knop Added some P4Python-based Perforce triggers.

P4Triggers.py is the based class for change trigger in Python modelled on
Tony Smith's Ruby trigger with the same name.

CheckCaseTrigger.py is a trigger that ensures that no-one enters a file
or directory with a name only differing by case from an existing file. This
trigger is Unicode aware and uses Unicode-comparison of file names, so it
can be used on nocase-Unicode based Perforce servers, which cannot catch
the difference between, say, "�re" and "�re" at the moment.

clienttrigger.py is a simple trigger that modifies the option "normdir" to
"rmdir" for new client specs only. It is meant as a template to create more
complex default settings like standard views.