# Perforce Defect Tracking Integration Project

# <http://www.ravenbrook.com/project/p4dti/>

#

# CONFIGURE_BUGZILLA.PY -- BUILD P4DTI CONFIGURATION FOR BUGZILLA

#

# Richard Brooksby, Ravenbrook Limited, 2000-12-07

#

#

# 1. INTRODUCTION

#

# This is the automatic configurator for the Bugzilla integration of the

# Perforce Defect Tracking Integration (P4DTI). Configuration

# generators are documented in detail in [GDR 2000-10-16, 8].

#

# This code takes a basic set of configuration parameters [RB

# 2000-08-10, 5.1] and generates a full set of parameters for the

# "dt_bugzilla", "p4", and "replicator" classes, as well as a Perforce

# jobspec.

#

# The intended readership of this document is project developers.

#

# This document is not confidential.

import bugzilla

import catalog

import check_config

import dt_bugzilla

import logger

import os

import string

import translator

import types

import mysqldb_support

error = "Bugzilla configuration error"

# perforce keyword translator.

keyword_translator = translator.keyword_translator()

# enum translator (just like keyword translator except '' <-> 'NONE')

enum_translator = dt_bugzilla.enum_translator(keyword_translator)

# make_state_pairs: (strings * string) -> (string * string) list. Make

# a list of pairs of state names (Bugzilla state, Perforce state). This

# list will be used to translate between states, and also to generate

# the possible values for the Status field in Perforce.

#

# The closed_state argument is the Bugzilla state which maps to the

# special state 'closed' in Perforce, or None if there is no such state.

# See requirement 45. See design decision [RB 2000-11-28 14:44:36

# GMT].

#

# The case of state names in these pairs is normalized for usability in

# Perforce: see design decision [RB 2000-11-28 14:24:32 GMT].

def make_state_pairs(states, closed_state):

return state_pairs

# Given the name of an enum column, calculate the values and default.

def translate_enum(column, bz_type):

return values, default

# Some Bugzilla fields should not be changed from Perforce, either

# because they can not be changed from Bugzilla

# (e.g. 'creation_ts', 'delta_ts', 'lastdiffed'), or because they

# can only be changed in Bugzilla in very restricted ways

# (e.g. 'groupset', 'product', 'version', 'component',

# 'target_milestone', 'everconfirmed'), or because changing them

# in Bugzilla has complex side-effects which can't be sensibly

# reproduced here (e.g. 'votes', 'keywords').

read_only_fields = ['bug_id',

'alias']

# Some Bugzilla fields can only be appended to.

# In particular, the 'Descriptions' section of a Bugzilla bug

# is actually a number of rows from another table, to which

# the Bugzilla web interface allows one to add a row.

# We fake this as if it's a regular field of the table, but

# retain the append-only restriction.

append_only_fields = ['longdesc']

# These Bugzilla fields are replicated by default. If they are in

# replicated_fields, that's a configuration error. If fields other

# than these are in omitted_fields, that's a configuration error too.

default_fields = ['bug_status',

]

# Map bugzilla field name to a name we can use in Perforce and a

# comment.

bz_field_map = {

}

def prepare_issue_advanced(config, bz, p4, dict, job):

config.prepare_issue(dict, job)

def translate_jobspec_advanced(config, dt, p4, job):

# Call user hook (see [GDR 2001-11-14, 4.6]).

return config.translate_jobspec(job)

def get_fields_bz_to_p4(config, bugs_types):

return fields_bz_to_p4

def check_bugzilla_directory(config):

raise error, catalog.msg(304)

def check_field_lists(config):

p4_fields_check.append(p4_field)

def get_user_name_length(config):

return profiles_types['login_name']['length']

def make_p4_field_spec(bz_field,

)

def configuration(config):

return config

# A. REFERENCES

#

# [GDR 2001-11-14] "Perforce Defect Tracking Integration Advanced

# Administrator's Guide"; Gareth Rees; Ravenbrook Limited; 2001-11-14;

# <http://www.ravenbrook.com/project/p4dti/version/2.4/manual/aag/>.

#

# [GDR 2000-10-16] "Perforce Defect Tracking Integration Integrator's

# Guide"; Gareth Rees; Ravenbrook Limited; 2000-10-16;

# <http://www.ravenbrook.com/project/p4dti/version/2.4/manual/ig/>.

#

#

# B. DOCUMENT HISTORY

#

# 2000-12-07 RB Branched and adapted from configure_teamtrack.py.

#

# 2000-12-08 GDR Translate state name "ignore" to "_ignore".

#

# 2000-12-13 NB State names need to be lower case in Perforce. Also

# logger object needed for the bugzilla.bugzilla object.

#

# 2000-12-15 NB Added verbosity support.

#

# 2001-01-11 NB Added support for replicated_fields. Also support

# closed_state, and move MySQL connection code here (out of bugzilla.py)

# so that we only open one connection when starting up. Also sorted out

# the size of the jobspec fields.

#

# 2001-01-12 NB Moved configuration of read-only and append-only fields

# here from dt_bugzilla.py. Added configuration of fields not recorded

# in the bugs_activity table. Added comments for read-only and

# append-only fields.

#

# 2001-01-15 NB Added a table for field names and comments, because the

# automatically-generated ones were terrible. Added validation for

# config parameters.

#

# 2001-01-18 NB Removed bugzilla_user. Moved configuration checks out

# to check_config.py. Pass replicator_user to Bugzilla.

#

# 2001-01-19 NB closed_state and log_file may be None. Use system

# logger.

#

# 2001-01-25 NB Added bugzilla_directory to support processmail.

#

# 2001-01-26 NB Pass p4_server_description to Bugzilla.

#

# 2001-02-04 GDR Added start_date parameter.

#

# 2001-02-08 NB Prevent the existence of DateTime from changing our

# behaviour. (job000193).

#

# 2001-02-09 NB Added checks for bugzilla_directory.

#

# 2001-02-13 GDR Allow administrator_address and smtp_server to be None.

#

# 2001-02-16 NB Added replicate_p configuration parameter.

#

# 2001-02-19 NB Moved keyword translation to p4.py.

#

# 2001-02-22 GDR Moved keyword translation to keyword.py. Made sure

# that 'closed' is a legal job state in Perforce. Added text translator

# to replicator config.

#

# 2001-02-26 GDR Refer to "Bugzilla" explicitly in messages, not just

# "defect tracker".

#

# 2001-03-02 RB Transferred copyright to Perforce under their license.

#

# 2001-03-12 GDR Use messages for errors.

#

# 2001-03-13 GDR Removed verbose parameter; added log_level. Removed

# P4DTI-action field. Made P4DTI-filespec field optional. Get

# keyword_translator from translator, not keyword.

#

# 2001-03-15 GDR Store configuration in config module.

#

# 2001-03-23 GDR Added job-date-field to replicator configuration.

#

# 2001-06-22 NB Moved common jobspec code into p4.py.

#

# 2001-06-22 NB Added initial comment to the jobspec description.

#

# 2001-09-19 NB Bugzilla 2.14 (job000390): new fields, some

# functionality moved to bugzilla.py.

#

# 2001-10-25 NB Add check of MySQLdb module version. Moved code to

# ensure MySQLdb uses strings for dates and times to after the point

# at which we know that the MySQLdb release is supported.

#

# 2001-10-28 GDR Formatted as a document.

#

# 2001-11-05 GDR Added prepare_issue_advanced to replicator

# configuration.

#

# 2001-11-20 GDR Added translate_jobspec_advanced to replicator

# configuration. Put jobspec in config rather than returning it.

#

# 2001-11-26 GDR Support log_max_message_length configuration parameter.

#

# 2001-11-27 GDR Check migrated_user_groups.

#

# 2002-01-07 NB Use correct translator for enum fields (job000445).

#

# 2002-01-31 GDR Use mysqldb_support.connnect to connect to the MySQL

# database. This turns off date/time conversion in a way that's

# portable between MySQLdb releases.

#

# 2002-04-02 NB User fields should default to the current user,

# otherwise we get '0' which is no user at all. job000491.

#

# 2002-04-03 NB Take default for user fields from bugzilla interface.

# Clarify distinction between strict and lax user translators.

#

# 2002-06-26 RB Merged Bugzilla for Windows 2000 port.

#

# 2002-10-25 RB Added back logging to syslog under control of new

# configuration parameter "use_system_log".

#

# 2003-05-21 NB Fixed some comments which incorrectly referred to TeamTrack.

#

# 2003-11-25 NB Rewrite the jobspec-creation code, and the handling of

# the relevant configuration parameters. This is a step towards

# configurable jobspec.

#

# 2004-05-28 NB Add bugmail as alternative to processmail.

#

#

# C. COPYRIGHT AND LICENSE

#

# This file is copyright (c) 2001 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 THE COPYRIGHT

# HOLDERS AND CONTRIBUTORS 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: //info.ravenbrook.com/project/p4dti/version/2.4/code/replicator/configure_bugzilla.py#5 $