#!/usr/bin/env python3 # -*- coding: utf-8 -*- # ============================================================================== # Copyright and license info is available in the LICENSE file included with # the Server Deployment Package (SDP), and also available online: # https://swarm.workshop.perforce.com/projects/perforce-software-sdp/view/main/LICENSE # ------------------------------------------------------------------------------ """ NAME: DefaultSwarmReviewDesc.py DESCRIPTION: Create a default change description (form-in) for swarm user - so updates Swarm review changelist Can be used together with CheckChangeDesc.py (change-submit) To install, add a line to your Perforce triggers table like the following: default-swarm-desc form-in change "python /p4/common/bin/triggers/DefaultSwarmReviewDesc.py -p %serverport% -u perforce %user% %formfile% " or (if server is standard SDP and has appropriate environment defaults for P4PORT and P4USER): default-swarm-desc form-in change "python /p4/common/bin/triggers/DefaultSwarmReviewDesc.py %user% %formfile% " You may need to provide the full path to python executable, or edit the path to the trigger. Also, don't forget to make the file executable, and set the configuration variables below. To configure, read and modify the following lines up to the comment that reads "END OF CONFIGURATION BLOCK". You may also need to modify the definition of which fields constitute a new job based on your jobspec. This is in the allowed_job() function. """ # Python 2.7/3.3 compatibility. from __future__ import print_function import sys import yaml import re import argparse import textwrap import P4Triggers import shutil import os from string import Template class DefaultSwarmReviewDesc(P4Triggers.P4Trigger): """See module doc string for details""" def __init__(self, *args, **kwargs): P4Triggers.P4Trigger.__init__(self, **kwargs) self.parse_args(__doc__, args) def add_parse_args(self, parser): """Specific args for this trigger - also calls super class to add common trigger args""" parser.add_argument('-c', '--config-file', default=None, help="Configuration file for trigger. Default: CreateSwarmReview.yaml") parser.add_argument('user', help="User carrying out the command - %%user%% argument from triggers entry.") parser.add_argument('formfile', help="Formfile containing job definition - %%formfile%% argument from triggers entry.") super(DefaultSwarmReviewDesc, self).add_parse_args(parser) def formatReviewDescription(self, review_description, **kwargs): """Format using specified format options - see call below Assumes review_description is an array of lines in config file""" desc = "\n".join(review_description) desc = desc.replace("\\n", "\n") t = Template(desc) result = t.safe_substitute(**kwargs) return result def load_config(self, config_file=None): if not config_file: config_file = "/p4/common/config/DefaultSwarmReviewDesc.yaml" config = {} try: with open(config_file, 'r') as f: config = yaml.load(f) except Exception as e: self.logger.error(str(e)) return config def run(self): """Runs trigger""" try: self.logger.debug("DefaultSwarmReviewDesc firing") config = self.load_config(self.options.config_file) if not 'review_description' in config or not config['review_description']: return 0 self.setupP4() self.p4.connect() with open(self.options.formfile, 'r') as f: contents = f.read() chg = self.p4.parse_change(contents) self.logger.debug("Change: %s" % str(chg)) if "Date" in chg: # If Date field set then abort because change has already been processed self.logger.debug("Change already processed so exiting") return 0 if not "User" in chg or chg["User"] != config['swarm_user']: self.logger.debug("Ignoring change") return 0 # job_desc = "" # if jobs and len(jobs) > 0: # job_desc = jobs[0]['Description'] # job_desc = job_desc.rstrip("\n") description = self.formatReviewDescription(config['review_description']) chg["Description"] = description contents = self.p4.format_change(chg) self.logger.debug("Updated chg: %s" % str(chg)) tempfile = "%s~" % self.options.formfile shutil.move(self.options.formfile, tempfile) with open(self.options.formfile, 'w') as f: f.write(contents) os.remove(tempfile) except Exception: return self.reportException() return 0 if __name__ == '__main__': """ Main Program""" trigger = DefaultSwarmReviewDesc(*sys.argv[1:]) sys.exit(trigger.run())
# | Change | User | Description | Committed | |
---|---|---|---|---|---|
#4 | 27331 | C. Thomas Tyler |
Released SDP 2020.1.27325 (2021/01/29). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#3 | 25245 | C. Thomas Tyler |
Released SDP 2019.1.25238 (2019/03/02). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
#2 | 23510 | C. Thomas Tyler |
Released SDP 2018.1.23504 (2018/01/19). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev', with selective removal of work-in-progress files. |
||
#1 | 23331 | C. Thomas Tyler |
Released SDP 2017.4.23329 (2017/12/05). Copy Up using 'p4 copy -r -b perforce_software-sdp-dev'. |
||
//guest/perforce_software/sdp/dev/Server/Unix/p4/common/bin/triggers/DefaultSwarmReviewDesc.py | |||||
#1 | 23289 | Robert Cowham | Trigger to create a default swarm review description |