CreateSwarmReview.py #3

  • //
  • guest/
  • perforce_software/
  • sdp/
  • dev/
  • Server/
  • Unix/
  • p4/
  • common/
  • bin/
  • triggers/
  • CreateSwarmReview.py
  • View
  • Commits
  • Open Download .zip Download (5 KB)
#!/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:
    CreateSwarmReview.py

DESCRIPTION:
    This trigger is intended for use with Swarm installations

    It will search for any jobs associated with the changelist and find any reviews
    associated with that job.
    If found it will update the review with this changelist
    Otherwise it will create a new Swarm review with a template description
    and with configurable reviewers as requested.

    To install, add a line to your Perforce triggers table like the following:

        create_swarm_review change-commit //... "python /p4/common/bin/triggers/CreateSwarmReview.py -p %serverport% -u perforce %change% "

    or (if server is standard SDP and has appropriate environment defaults for P4PORT and P4USER):

        create_swarm_review change-commit //... "python /p4/common/bin/triggers/CreateSwarmReview.py %change% "

    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.
"""

# Python 2.7/3.3 compatibility.
from __future__ import print_function

import sys
import re
import argparse
import textwrap
import P4Triggers
import P4
import requests
import yaml

class CreateSwarmReview(P4Triggers.P4Trigger):
    """See module doc string for details"""

    def __init__(self, *args, **kwargs):
        P4Triggers.P4Trigger.__init__(self, **kwargs)
        desc = textwrap.dedent(__doc__)
        parser = argparse.ArgumentParser(
            formatter_class=argparse.RawDescriptionHelpFormatter,
            description=desc,
            epilog="Copyright (c) 2008-2017 Perforce Software, Inc."
        )
        self.add_parse_args(parser)
        self.options = parser.parse_args(args=args)
        self.init_logger()
        self.logger.debug("Command Line Options: %s\n" % self.options)

    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('--test-mode', default=False, action='store_true',
                            help="Trigger runs in test mode - for unit testing only")
        parser.add_argument('change', help="Change to process - %%change%% argument from triggers entry.")
        super(CreateSwarmReview, self).add_parse_args(parser)

    def load_config(self, config_file=None):
        if not config_file:
            config_file = "/p4/common/config/CreateSwarmReview.yaml"
        with open(config_file, 'r') as f:
            config = yaml.load(f)
        return config

    def get_swarm_url(self):
        """Read from Perforce server propery value"""
        if self.options.test_mode:
            return "http://swarm.dev/"
        prop = self.p4.run('property', '-l' , '-n', 'P4.Swarm.URL')
        self.logger.debug("Property: %s" % str(prop))
        return prop[0]['value']

    def ignore_change(self, config, change):
        """Returns true if changelist should be ignored"""
        map = P4.Map()
        for grp in config['groups']:
            if not 'name' in grp or not 'depot_paths' in grp:
                return False
            for p in grp['depot_paths']:
                map.insert(p)
        for df in change.files:
            if map.includes(df.depotFile):
                return False
        return True

    def run(self):
        """Runs trigger"""
        try:
            self.logger.debug("CreateSwarmReview trigger firing")
            self.setupP4()
            self.p4.connect()
            change = self.getChange(self.options.change)

            config = self.load_config(self.options.config_file)
            if self.ignore_change(config, change):
                return 0

            swarm_url = self.get_swarm_url()
            base_url = "%s%s" % (swarm_url, config['api'])
            url = '%s/reviews' % base_url
            data = {'change': self.options.change, 'description': config['review_description']}
            self.logger.debug("Post: %s data: %s" % (url, data))
            r = requests.post(url, auth=(config['user'], config['ticket']), data=data)
            self.logger.debug("Result: %s" % (r.json()))
        except Exception:
            return self.reportException()

        return 0


if __name__ == '__main__':
    """ Main Program"""
    trigger = CreateSwarmReview(*sys.argv[1:])
    sys.exit(trigger.run())
# Change User Description Committed
#15 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.
#14 24158 Robert Cowham Refactor - tidy up triggers to make a little more consistent.
No functional change.
#13 23581 Robert Cowham Fix Swarm REST query - remove qutoe chars for \[\]
#12 23420 Robert Cowham Refactored to use common WorkflowTriggers class
#11 23419 Robert Cowham Refer to Workflow.yaml
Change name of field from create_review to post_submit_create_review
#10 23197 Robert Cowham Patch the newly created review to set the author field
#9 23196 Robert Cowham Call Swarm in way that handles multiple reviewers
#8 23160 Robert Cowham Mention config file in comments.
#7 23153 Robert Cowham Make executable
#6 23152 Robert Cowham Refactor to push common arg_parse into P4Triggers
#5 23133 Robert Cowham Create new review if no other changes
#4 23132 Robert Cowham Search for jobs and update existing review
Also add default reviewers
#3 23122 Robert Cowham Add functionality to allow depot paths to be specified in groups
#2 23073 Robert Cowham Use mocks for unit tests
#1 23070 Robert Cowham Initial versions