Buildbot config file tester

[bhearsum]

This is a little script I wrote to test a master.cfg file without running Buildbot. It accepts an optional parameter of the configuration file, defaulting to 'master.cfg'. It returns 2 if the file does not exist, 1 if the configuration file is bad, and 0 otherwise.

[bhearsum]

buildbot config file tester

[warner]

hm, maybe we should build this into the 'buildbot' command? like, 'buildbot check-config master.cfg', and have it emit a message like "good config"/"bad config" in addition to the exit code? And if it sees a --quiet flag, set the exit code but don't emit the message?

source:buildbot/scripts/runner.py is the place where this would want to go..

[warner]

hm, and maybe there's a way we could watch for warnings raised or messages that get put in the logfile while the config-checker runs..

[warner]

no progress on this yet, bumping to 0.7.8

[bhearsum]

This totally fell off my radar. I'm working on it now, should be able to finish it in time for 0.7.7.

[bhearsum]

integrate checkconfig.py into the runner

[bhearsum]

This patch integrates checkconfig.py into runner.py. It copies files to a temporary directory and checks the config from there. This means it will not mess up your working directory with subdirs or .pyc files.

If you have code that you import from a subdirectory it will not work. It _will_ work if you have subdirectories for code, config files, etc, and those files are symlinked back to the basedir. I didn't want to do a full copytree()...this would make it icky to run in an existing master's basedir (which could have subdirectories/logfiles that are hundreds of megs in size).

[bhearsum]

fix stupid indentation error

[bhearsum]

All of the unit tests pass (23 skipped) w/ integrateConfigTester-v2.diff

[bhearsum]

The latest patch here will require Python 2.5, because of its use of 'finally'. I've got a version that doesn't use it, if you'd prefer that, let me know.

[bhearsum]

The latest patch causes problems on Windows. It imports BuildMaster? buildbot.master so it can subclass master.BuildMaster? for the ConfigLoader?. I'm not sure there's any way to prevent twisted.internet.reactor from getting imported when doing this. I'll have a look at this soon, though.

[warner]

Yeah, we need a version that's compatible with python2.3,2.4, and 2.5 to get this into trunk. Plus the windows reactor-import problem needs to be fixed.

To fix the latter, move most of the code off into a separate module, called buildbot/scripts/checkconfig.py . Then only import that module from buildbot/scripts/runner.py in the function that handles the "check-config" subcommand. That should remove the reactor-import from the top level and allow the other subcommands to work properly.

If you can fix this by tuesday, we'll get it into 0.7.7. If not, we'll get it in at the beginning of the 0.7.8 cycle.

[bhearsum]

Alright, here's an updated patch. It passes all of the unit tests and even works on Windows. Nice bonus here is that checkconfig.py can be copied around or run manually in addition to 'buildbot checkconfig'.

I've tested this on Windows (Python 2.4) and Mac (Python 2.5). This version doesn't use 'finally' so I expect that it works with Python 2.3, too.

[bhearsum]

config file tester - works on windows

[warner]

excellent, thanks

[warner]

Applied, in [73a2c7cfb4893f11961bb28f7a03db54f6dc0482]. My only change was to remove an unused 'file =' definition statement. I wrote up some quick docs too.

thanks!