Closed Bug 54608 Opened 26 years ago Closed 24 years ago

Tinderbox scripts should be config-file driven

Categories

(Webtools Graveyard :: Tinderbox2, defect, P3)

defect

Tracking

(Not tracked)

RESOLVED FIXED

People

(Reporter: mcafee, Assigned: kestes)

References

Details

Tinderbox scripts should be config-file driven. I should not have to edit tbox sources to configure for my system, this will make it hard to update sources later (conflicts, etc.). Tinderbox 1.0 client build-seamonkey.pl script does this using tinder-config.pl, we should do something similar here. [Current install instructions says: ] 1) read and edit the variables found in the files ./src/lib/* particularly: TinderConfig.pm: general configuration settings Error_Parse.pm: the regular expressions for highlighting errors FileStructure.pm: filesystem (storage) and global/per-project settings BTData.pm: bug tracking configuration TreeData.pm: version control configuration
This gets to a very difficult design problem which I have not solved yet. The new tinderbox is very flexible (perhaps too flexible) and this flexibility means that configuration involves writing functions. Most users will not need to write any functions but no setting of the software will satisfy everyone. In fact there are only a few files which have user editable code in them. Those files are listed in the install. If you can help me come up with a better way to configure this I would love to hear it. I am unhappy both with this issue and with the configure script which installs the program. Here is a list of some of the code that users may need to write: 1) Error parsers: no build environment is the same, users will need to configure the parsers to match the tools which are used by the build process. 2) Bug tracking: Given a bug system which mails tickets to tinderbox, how do we know which tree a bug ticket is destined for? Typically this will be the contents of a field like 'Product', however some projects may be more complicated like if all of the product is part of one project except for a particular feature/platform which is being developed by a separate project. How do we know what the states that a ticket can be in. Most bug tracking systems allow users to configure the states themselves. 3) The file system may not be regular. Local system administrator may need to put different trees onto different disk partitions and this will require making get_filename() less regular then typical. What is the structure of the administration password file? Is there one set of administrators for all trees or is their a different set of administrators for each tree? 4) Version Control data: I am particularly troubled by the addition of the version control data. The concept of a "tree" is central to the code so every module needs to be aware of the version control data structure. However I wish the code to be really flexible. I do not wish to lock users in to a CVS like data structure. Very few modules know the internals of the data structure. How should I expose the flexibility inherent in the code (most of the code works for any version control system) to the configuration? 5) most users will find that they only need to adjust TinderConfig and TreeData.
I spent most of the weekend thinking about this and I am not any closer to a solution. It seems to me that a good high level design would be to: 1) provide reasonable defaults (So no users need to touch Error_Parse.pm or FileStructure.pm but they were designed to make local changes easy. ) 2) allow users to change certain, commonly adjusted, configuration parameters in a central file (TinderConfig.pm). This file would hold installation configuration parameters and would not need to be adjusted ever again. 2) keep a separate configuration file to allow project based configuration (TreeData.pm). As new projects are added/completed then this file will need adjusting. With a few caveats I am close to the above 'ideal' so I need new ways of thinking about this if I am going to make substantial improvements. Here are some problems with my current approach: 1) I have not separated out the "tree" class functions from the "treedata" config file. This is mostly because there are so few methods and they are so small. There is little additional to the file besides configuration data. 2) The bug tracking module is new and I have not finished adding hooks to the TinderConfig.pm module. Thought this module has a similar feel to problem #1, namely it consists mostly of configuration data. The actual class structure is small.
I am making this bug dependent on bug 48679 in the hopes that once it is installed at netscape/mozilla then I will get good feedback and suggestions on how to fix the design. In the mean time I am doing some design review here at my company to find a better configuration method.
Status: NEW → ASSIGNED
Depends on: 48679
Here is my latest idea on how to configure this higly flexible and process specific program: There are a few files which define "classes" that are user configurable. With these files I expect the users to edit a table which makes up most of the file OR to create functions which are needed by the library and which only make sense for one companies usage of tinderbox (the parsers in Error_Parse.pm depend on the build tools and company policy on what is a warning/error). These perl libraries are what I am trying to allow local configuration of. I am just going to create three directories and the perl search path will search the directories in this order: ./local_config ./default_config ./lib local_config will be empty, any perl files which I expect people to change will be moved out of ./lib into default_config. Mozilla.org is encouraged to make the necessary changes to these files in the ./default_config directory and check them back in. All other users (besides Mozilla.org) can copy any files from the ./default_config into the ./local_config and make the nessary changes to their own copy. The ./local_config directory is entirely under "local" control and will interpose libraries on the ./default_config directory.
I think we have a good first-pass at this, and suggest we mark this fixed.
QA Contact: matty → timeless
tinderbox2 component
Component: Tinderbox → Tinderbox2
This was fixed long ago.
Status: ASSIGNED → RESOLVED
Closed: 24 years ago
Resolution: --- → FIXED
QA Contact: timeless → tinderbox2
Product: Webtools → Webtools Graveyard
You need to log in before you can comment on or make changes to this bug.