tfsbuildlab Wiki & Documentation Rss Feed

UPDATED WIKI: Home

MOlausson — Fri, 21 Dec 2007 09:32:36 GMT

Project Description
TFSBuildLab is a project to simplify the day to day operations when using automated builds and continuous integration with Visual Studio Team System.

This project handles common Team System issues such as:

Many of these issues are handled in the TFS 2008 release (http://download.microsoft.com/download/5/9/c/59cd0dc5-4691-4c3e-840c-66d865f27692/orcas-continuous-integration.xps), but for those out there using TFS 2005 TFSBuildLab is an easy way to handle build automation. We've also aimed to be as forward-compatible as possible so the features in TFSBuildLab will be very similar (conceptually atleast) to the ones in TFS 2008.

Project Documentation

Our blogs:

Mathias Olausson - http://olausson.net/blog
Peter Blomqvist - http://peterblomqvist.blogspot.com

UPDATED WIKI: Home

MOlausson — Mon, 05 Nov 2007 08:11:51 GMT

Project Description
TFSBuildLab is a project to simplify the day to day operations when using automated builds and Team System.

This project handles common Team System issues such as:

Many of these issues are handled in the upcoming TFS 2008 release (http://download.microsoft.com/download/5/9/c/59cd0dc5-4691-4c3e-840c-66d865f27692/orcas-continuous-integration.xps), but we wanted to have a good implementation until then and we also aim to be as forward-compatible as possible.

Project Documentation

Our blogs:

Mathias Olausson - http://olausson.net/blog
Peter Blomqvist - http://peterblomqvist.blogspot.com

UPDATED WIKI: RestrictedPaths

PeterBlomqvist — Sun, 14 Oct 2007 19:50:18 GMT

This policy enables you to restrict access to certain paths in you source control system and provide the users with an informative message explaining why the checkin is restricted.

To configure it you use this dialog:

The path input field Trigger Data expects a valid regular expression (currently not validated) for more info on regular expressions go to http://www.regular-expressions.info/tutorial.html and the break on error will decided if we continue to produce a list of failures based on the full changeset or if we stop on the first found.

UPDATED WIKI: RestrictedPaths

PeterBlomqvist — Sun, 14 Oct 2007 19:48:08 GMT

UPDATED WIKI: Adding a retention policy

PeterBlomqvist — Sun, 14 Oct 2007 19:39:16 GMT

Adding a retention policy

A retention policy will enable you to perform automatic cleanup of your builds to do this click on the new button in the upper right section and you will be prompted witht the following dialog:

There are three inputs that you can give.

Build Status can be on of the following (this input decides which builds get affected determined by their result status)

Any
BuildFailed
BuildStopped
BuildSucceded

Build Quality can be on of the following (this input decides which builds get affected determined by their build quality)

Any
Unexamined
UnderInvestigation
Released
Rejected
ReadyforInitialTest
ReadyforDeployment
InitialTestPassed
LabTestPassed
UserAcceptanceTestsPassed

Rentention Type can be on of the followin (this input decides how to interpret the third input)

Builds (when the retention policy is executed it will determine how many build to purge based on the number of builds that exists)
Days (will only purge builds older than the number of days specified)

Quantity here you specify the ammount of days to keep or the ammound of builds to keep based on the retention type given

Example:

Build Status = BuildSucceded
Build Quality = Any
Retention Type = Builds
Quantity = 5

This input will make sure you only have the latest five succeded builds for the build type in question.

UPDATED WIKI: Adding a continous integration build

PeterBlomqvist — Sun, 14 Oct 2007 19:29:14 GMT

Adding a continous integration build

A contious integration build will enable you to trigger a particular build type when ever a checkin occurs in a specific path you provide. It is also possible to exclude particular folders or files from the path given which can be handy to prevent exessive triggering of builds. If a checkin triggers a build that fails the person resonsible for this build will be emailed with information about the build break, also a work item will be created see the user's guide form more info about how this works. To create a checkin trigger click on the new button in the lower right section and you will be prompted witht the following dialog:

When you add a trigger if the type CheckinInclude or CheckinExclude the input field Trigger Data expects a valid regular expression (currently not validated) for more info on regular expressions go to http://www.regular-expressions.info/tutorial.html

If you expand the dialog to present the advanced options you will see a list of all the available properties from the build script you can override any of these. There will only be a actual result if doing this if you activly use the provided build task for this in your scripts LoadOverriddenProperty.

Example:

Trigger Type = CheckinInclude
Trigger Data = \$/DEMO

This input will trigger a build every time someone checkin a file that lives under the root $/DEMO in source control.

UPDATED WIKI: Adding a continous integration build

PeterBlomqvist — Sun, 14 Oct 2007 19:28:43 GMT

Adding a continous integration build

UPDATED WIKI: Build Queue

PeterBlomqvist — Sun, 14 Oct 2007 19:27:25 GMT

The build queue tab is the place where you can view what builds are currently queued up in the system. You can reorder the queued builds in case you really need a build to execute pronto or if you like you can delete a build from the queue and you can ofcourse put builds onto the queue.

To delete a build you simple select it from the grid in the middle part of the tab and then press the remove button in the lower part of the tab. If you need to reorder you select the build and either press move up or move down to move the build up and down in the execution order.

Finally if you need to queue a build maybe someone else is running a build on the server you need you simple press the queue build button in the lower left corner of the tab, this will bring up a dialog prompting you for which team project and the build type you which to queue (it will use the designated build server).

If you expand the dialog to present the advanced options you will see a list of all the available properties from the build script you can override any of these. There will only be a actual result if doing this if you activly use the provided build task for this in your scripts LoadOverriddenProperty.

UPDATED WIKI: Build Queue

PeterBlomqvist — Sun, 14 Oct 2007 19:25:51 GMT

UPDATED WIKI: TfsBuildLab History

PeterBlomqvist — Sun, 14 Oct 2007 19:04:26 GMT

This report let you play around with the event history in the TfsBuildLab database, the example below shows the number of deletes, scheduled builds, checkin triggered builds.

UPDATED WIKI: TfsBuildLab History

PeterBlomqvist — Sun, 14 Oct 2007 19:02:44 GMT

...

UPDATED WIKI: TfsBuildLab History

PeterBlomqvist — Sun, 14 Oct 2007 19:01:52 GMT

...

UPDATED WIKI: Installing TfsBuildLab Service

PeterBlomqvist — Sun, 14 Oct 2007 18:59:36 GMT

Installation

Run the service setup on any server of you choice. We test installing on the application tier of TFS and a standalone TfsBuildLab server. Make sure you change the account that runs the service to something other that local system since you need to give this account permissions to use the database.

Optionally create a database named TfsBuildLab, this is performed by the sevice setup if no database with the name you provide during setup exists already.

Run the CreateDatabase.sql script on your database to create the needed tables.
Run the CreateLogin.sql script to setup the needed security (don't forget to replace the string DOMAIN/ACCOUNT in the script with the account that is running your service).
Run the InsertData.sql script on your database to insert the needed data.

Prerequisites

The service reuqires that you have access to either a SQL Server 2005 or a SQL Server 2000 database server where it can install its database. Also you need to install .NET Framework 2.0 and .NET Framework 3.0 (this also limits you to running either Windows XP and Windows Server 2003, we currently do not test on Windows Vista).

Configuration

The following section explains the various settings available in the config file of the service:

tfsUser the identity (username) that the service should use when connecting to the TFS server, this needs to be a valid TFS account (if you want to use the auto registration functions this needs to be a member of the Server\Team Foundation Adminstrators group).
tfsPassword The password for the bove mentioned identity (username).
tfsServerAddress Fully qualified address for the TFS server (http://<servername>:<port>

buildLabPort The port used by the TfsBuildLab service for event notification subscriptions.
buildLabAdminPort The port used by the TfsBuildLab service to expose it's administrative services.

tfsBuildLabConnectionString The connection string to the TfsBuildLab database, for a single server installation the connection string would be the following "Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=TfsBuildLab;Data Source=(local)"

RetentionPoliciesOnlyCleanupDropLocation This setting allows you to turn on that the retention policies only will remove the actual build drop when enforcing the policies.
AutoRegisterNotifications This setting allows you to turn of the automatic registration of notifications, we introduced this since this feature requires the account used to access the TFS server to be a memeber of the administrators group.

QueueManagementInterval The poll frequency for checking the build queue (in milliseconds, defaults to 60000)
ScheduleManagementInterval The poll frequency for checking for new schedules (in milliseconds, defaults to 60000) this is only used if the service is started up without and schedules in the database.
RetentionPolicyEnforcementInterval The poll frequency for checking for old builds to purge (in milliseconds, defaults to 3600000)

smtpServerAddress The address for the SMTP server used for sending out CI alerts.
CINotificationSenderAddress The email address to that will be the sender of the CI info mails when the build breaks.
CIAdministrativeNotificationEmail The email address that will receive a copy of all CI info mails that are sent.

CINotificationWorkItemType The TFS workitem type to create when a CI build fails.
CINotificationWorkItemFields A list of fields and their values that are required to be filled out when creating the workitem type above this list is separated by semicolon. T he result would look like this "Microsoft.VSTS.CMMI.Symptom=Test;Microsoft.VSTS.CMMI.StepsToReproduce=YAT" (in a CMMI project where the feilds symptom and stepstoreproduce are mandatory)

Troubleshooting

If you encounter problems using the service you can shut it down and add the following section to the config file and you will get a detailed log to help tracking down the problems:

<system.diagnostics>
<trace autoflush="false" indentsize="4">
<listeners>
<add name="TextLog" type="System.Diagnostics.TextWriterTraceListener" initializeData="c:\\tfsbuildlab.log" />
</listeners>
</trace>
</system.diagnostics>

Problems with auto registration of notifications

If you encounter problems with the registration of build and checkin notifications when starting the service and if you are unable to give the apropriate rights you can turn off auto registration (see above) and do the registration yourself the following way:

BisSubscribe.exe /eventtype BuildStatusChangeEvent /address http://[TFSBUILDLABSERVER]:[PORT] / /deliveryType Soap /server http://[TFSSERVER]:[PORT]
BisSubscribe.exe /eventtype BuildCompletionEvent /address http://[TFSBUILDLABSERVER]:[PORT] / /deliveryType Soap /server http://[TFSSERVER]:[PORT]
BisSubscribe.exe /eventtype CheckinEvent /address http://[TFSBUILDLABSERVER]:[PORT] / /deliveryType Soap /server http://[TFSSERVER]:[PORT]

Problems with http.sys and exposing WCF services

The easy way around this is to make sure that the account running the service is a member of the local administrators group. If this is not possible you can grant the correct permissions to the account using one of the following ways:

Use a tool called HttpNamespaceManager which you can find here http://blogs.msdn.com/paulwh/archive/2007/05/04/addressaccessdeniedexception-http-could-not-register-url-http-8080.aspx just make sure that you have selected an account when you are about to modify the permissions and grant execute persmissions to your service account.

Make sure that the url you provide follows the following syntax {http://*:TfsBuildLabPort/} (the last trailing slash is crucial).
Make sure that when adding permission you select the account specified after you add it since otherwise you can add permissions (select GenericAll).

Manually configure it as described by Keith Brown in his article here http://msdn.microsoft.com/msdnmag/issues/06/11/SecurityBriefs/default.aspx?loc=null there are some syntax problems (atleast for us) when following this article (also you'll need to determine the sid so for clarity it should look like this:

Retrive the sid using a tool called getsid (it's included in the windows resource kit) to retrieve a sid you need to specify two servers (they can actually be the same server): getsid \\[server] [domain]/[account] \\[server] [domain]/[user]
Once you have a sid run httpcfg (make sure the port is the one you have specifed in your config as buildLabPort and that the sid is the one you retrieved in the previous step (note the command should return 0 if successful): httpcfg set urlacl /u http://+:8000/ /a D:(A;;GX;;;S-1-5-21-1681502023-2202157333-1552196959-1028)
On Windows Vista you can use the simpler netsh.exe command instead of httpcfg.exe: netsh.exe http add urlacl url=http://+:8000/ user=domain\user

UPDATED WIKI: Installing TfsBuildLab Service

PeterBlomqvist — Sun, 14 Oct 2007 18:57:45 GMT

Installation

Run the CreateDatabase.sql script on your database to create the needed tables.
Run the CreateLogin.sql script to setup the needed security (don't forget to replace the string DOMAIN/ACCOUNT in the script with the account that is running your service).
Run the InsertData.sql script on your database to insert the needed data.

Prerequisites

Configuration

The following section explains the various settings available in the config file of the service:

tfsUser the identity (username) that the service should use when connecting to the TFS server, this needs to be a valid TFS account (if you want to use the auto registration functions this needs to be a member of the Server\Team Foundation Adminstrators group).
tfsPassword The password for the bove mentioned identity (username).
tfsServerAddress Fully qualified address for the TFS server (http://<servername>:<port>

buildLabPort The port used by the TfsBuildLab service for event notification subscriptions.
buildLabAdminPort The port used by the TfsBuildLab service to expose it's administrative services.

tfsBuildLabConnectionString The connection string to the TfsBuildLab database, for a single server installation the connection string would be the following "Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=TfsBuildLab;Data Source=(local)"

RetentionPoliciesOnlyCleanupDropLocation This setting allows you to turn on that the retention policies only will remove the actual build drop when enforcing the policies.
AutoRegisterNotifications This setting allows you to turn of the automatic registration of notifications, we introduced this since this feature requires the account used to access the TFS server to be a memeber of the administrators group.

QueueManagementInterval The poll frequency for checking the build queue (in milliseconds, defaults to 60000)
ScheduleManagementInterval The poll frequency for checking for new schedules (in milliseconds, defaults to 60000) this is only used if the service is started up without and schedules in the database.
RetentionPolicyEnforcementInterval The poll frequency for checking for old builds to purge (in milliseconds, defaults to 3600000)

smtpServerAddress The address for the SMTP server used for sending out CI alerts.
CINotificationSenderAddress The email address to that will be the sender of the CI info mails when the build breaks.
CIAdministrativeNotificationEmail The email address that will receive a copy of all CI info mails that are sent.

CINotificationWorkItemType The TFS workitem type to create when a CI build fails.
CINotificationWorkItemFields A list of fields and their values that are required to be filled out when creating the workitem type above this list is separated by semicolon. T he result would look like this "Microsoft.VSTS.CMMI.Symptom=Test;Microsoft.VSTS.CMMI.StepsToReproduce=YAT" (in a CMMI project where the feilds symptom and stepstoreproduce are mandatory)

Troubleshooting

Use a tool called HttpNamespaceManager which you can find here http://blogs.msdn.com/paulwh/archive/2007/05/04/addressaccessdeniedexception-http-could-not-register-url-http-8080.aspx just make sure that you have selected an account when you are about to modify the permissions and grant execute persmissions to your service account.

Make sure that the url you provide follows the following syntax http://*:TfsBuildLabPort/ (the last trailing slash is crucial).
Make sure that when adding permission you select the account specified after you add it since otherwise you can add permissions (select GenericAll).

Manually configure it as described by Keith Brown in his article here http://msdn.microsoft.com/msdnmag/issues/06/11/SecurityBriefs/default.aspx?loc=null there are some syntax problems (atleast for us) when following this article (also you'll need to determine the sid so for clarity it should look like this:

Retrive the sid using a tool called getsid (it's included in the windows resource kit) to retrieve a sid you need to specify two servers (they can actually be the same server): getsid \\[server] [domain]/[account] \\[server] [domain]/[user]
Once you have a sid run httpcfg (make sure the port is the one you have specifed in your config as buildLabPort and that the sid is the one you retrieved in the previous step (note the command should return 0 if successful): httpcfg set urlacl /u http://+:8000/ /a D:(A;;GX;;;S-1-5-21-1681502023-2202157333-1552196959-1028)
On Windows Vista you can use the simpler netsh.exe command instead of httpcfg.exe: netsh.exe http add urlacl url=http://+:8000/ user=domain\user

UPDATED WIKI: Installing TfsBuildLab Service

PeterBlomqvist — Sun, 14 Oct 2007 18:49:20 GMT

Installation

Run the CreateDatabase.sql script on your database to create the needed tables.
Run the CreateLogin.sql script to setup the needed security (don't forget to replace the string DOMAIN/ACCOUNT in the script with the account that is running your service).
Run the InsertData.sql script on your database to insert the needed data.

Prerequisites

Configuration

The following section explains the various settings available in the config file of the service:

tfsUser the identity (username) that the service should use when connecting to the TFS server, this needs to be a valid TFS account (if you want to use the auto registration functions this needs to be a member of the Server\Team Foundation Adminstrators group).
tfsPassword The password for the bove mentioned identity (username).
tfsServerAddress Fully qualified address for the TFS server (http://<servername>:<port>

buildLabPort The port used by the TfsBuildLab service for event notification subscriptions.
buildLabAdminPort The port used by the TfsBuildLab service to expose it's administrative services.

tfsBuildLabConnectionString The connection string to the TfsBuildLab database, for a single server installation the connection string would be the following "Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=TfsBuildLab;Data Source=(local)"

RetentionPoliciesOnlyCleanupDropLocation This setting allows you to turn on that the retention policies only will remove the actual build drop when enforcing the policies.
AutoRegisterNotifications This setting allows you to turn of the automatic registration of notifications, we introduced this since this feature requires the account used to access the TFS server to be a memeber of the administrators group.

QueueManagementInterval The poll frequency for checking the build queue (in milliseconds, defaults to 60000)
ScheduleManagementInterval The poll frequency for checking for new schedules (in milliseconds, defaults to 60000) this is only used if the service is started up without and schedules in the database.
RetentionPolicyEnforcementInterval The poll frequency for checking for old builds to purge (in milliseconds, defaults to 3600000)

smtpServerAddress The address for the SMTP server used for sending out CI alerts.
CINotificationSenderAddress The email address to that will be the sender of the CI info mails when the build breaks.
CIAdministrativeNotificationEmail The email address that will receive a copy of all CI info mails that are sent.

CINotificationWorkItemType The TFS workitem type to create when a CI build fails.
CINotificationWorkItemFields A list of fields and their values that are required to be filled out when creating the workitem type above this list is separated by semicolon. T he result would look like this "Microsoft.VSTS.CMMI.Symptom=Test;Microsoft.VSTS.CMMI.StepsToReproduce=YAT" (in a CMMI project where the feilds symptom and stepstoreproduce are mandatory)

Troubleshooting

Use a tool called HttpNamespaceManager which you can find here http://blogs.msdn.com/paulwh/archive/2007/05/04/addressaccessdeniedexception-http-could-not-register-url-http-8080.aspx just make sure that you have selected an account when you are about to modify the permissions and grant execute persmissions to your service account.

Manually configure it as described by Keith Brown in his article here http://msdn.microsoft.com/msdnmag/issues/06/11/SecurityBriefs/default.aspx?loc=null there are some syntax problems (atleast for us) when following this article (also you'll need to determine the sid so for clarity it should look like this:

Retrive the sid using a tool called getsid (it's included in the windows resource kit) to retrieve a sid you need to specify two servers (they can actually be the same server): getsid \\[server] [domain]/[account] \\[server] [domain]/[user]
Once you have a sid run httpcfg (make sure the port is the one you have specifed in your config as buildLabPort and that the sid is the one you retrieved in the previous step (note the command should return 0 if successful): httpcfg set urlacl /u http://+:8000/ /a D:(A;;GX;;;S-1-5-21-1681502023-2202157333-1552196959-1028)

On Windows Vista you can use the simpler netsh.exe command instead of httpcfg.exe: netsh.exe http add urlacl url=http://+:8000/ user=domain\user

UPDATED WIKI: Installing TfsBuildLab Service

PeterBlomqvist — Sun, 14 Oct 2007 18:38:33 GMT

Installation

Run the CreateDatabase.sql script on your database to create the needed tables.
Run the CreateLogin.sql script to setup the needed security (don't forget to replace the string DOMAIN/ACCOUNT in the script with the account that is running your service).
Run the InsertData.sql script on your database to insert the needed data.

Prerequisites

Configuration

The following section explains the various settings available in the config file of the service:

tfsUser the identity (username) that the service should use when connecting to the TFS server, this needs to be a valid TFS account (if you want to use the auto registration functions this needs to be a member of the Server\Team Foundation Adminstrators group).
tfsPassword The password for the above mentioned identity (username).
tfsServerAddress Fully qualified address for the TFS server (http://<servername>:<port>

buildLabPort The port used by the TfsBuildLab service for event notification subscriptions.
buildLabAdminPort The port used by the TfsBuildLab service to expose it's administrative services.

tfsBuildLabConnectionString The connection string to the TfsBuildLab database, for a single server installation the connection string would be the following "Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=TfsBuildLab;Data Source=(local)"

RetentionPoliciesOnlyCleanupDropLocation This setting allows you to turn on that the retention policies only will remove the actual build drop when enforcing the policies.
AutoRegisterNotifications This setting allows you to turn of the automatic registration of notifications, we introduced this since this feature requires the account used to access the TFS server to be a memeber of the administrators group.

QueueManagementInterval The poll frequency for checking the build queue (in milliseconds, defaults to 60000)
ScheduleManagementInterval The poll frequency for checking for new schedules (in milliseconds, defaults to 60000) this is only used if the service is started up without and schedules in the database.
RetentionPolicyEnforcementInterval The poll frequency for checking for old builds to purge (in milliseconds, defaults to 3600000)

smtpServerAddress The address for the SMTP server used for sending out CI alerts.
CINotificationSenderAddress The email address to that will be the sender of the CI info mails when the build breaks.
CIAdministrativeNotificationEmail The email address that will receive a copy of all CI info mails that are sent.

CINotificationWorkItemType The TFS workitem type to create when a CI build fails.
CINotificationWorkItemFields A list of fields and their values that are required to be filled out when creating the workitem type above this list is separated by semicolon. T he result would look like this "Microsoft.VSTS.CMMI.Symptom=Test;Microsoft.VSTS.CMMI.StepsToReproduce=YAT" (in a CMMI project where the feilds symptom and stepstoreproduce are mandatory)

Troubleshooting

Make sure that the account (by default it's running as local system) running the service is a member of the local administrators group. This is a temporary requirement and will be removed in a future relese.

A more proper way to fix this (if you don't want the service to run as administrator) you need to configure http.sys to allow the service account to setup a channel using the http transport (this is a WCF related issue) you can do this in two ways:

Use a tool called HttpNamespaceManager which you can find here http://blogs.msdn.com/paulwh/archive/2007/05/04/addressaccessdeniedexception-http-could-not-register-url-http-8080.aspx just make sure that you have selected an account when you are about to modify the permissions and grant execute persmissions to your service account.
Manually configure it as described by Keith Brown in his article here http://msdn.microsoft.com/msdnmag/issues/06/11/SecurityBriefs/default.aspx?loc=null there are some syntax problems (atleast for us) when following this article (also you'll need to determine the sid so for clarity it should look like this:

Retrive the sid using a tool called getsid (it's included in the windows resource kit but we have uploaded it here as well) to retrieve a sid you need to specify two servers (they can actually be the same server): getsid \\[server] [domain]/[account] \\[server] [domain]/[user]
Once you have a sid run httpcfg (make sure the port is the one you have specifed in your config as buildLabPort and that the sid is the one you retrieved in the previous step (note the command should return 0 if successful): httpcfg set urlacl /u http://+:8000/ /a D:(A;;GX;;;S-1-5-21-1681502023-2202157333-1552196959-1028)

On Windows Vista you can use the simpler netsh.exe command instead of httpcfg.exe: netsh.exe http add urlacl url=http://+:8000/ user=domain\user

UPDATED WIKI: Installing TfsBuildLab Service

PeterBlomqvist — Sun, 14 Oct 2007 18:23:17 GMT

Installation

Run the CreateDatabase.sql script on your database to create the needed tables.
Run the CreateLogin.sql script to setup the needed security (don't forget to replace the string DOMAIN/ACCOUNT in the script with the account that is running your service).
Run the InsertData.sql script on your database to insert the needed data.

Prerequisites

Configuration

The following section explains the various settings available in the config file of the service:

tfsUser the identity (username) that the service should use when connecting to the TFS server, this needs to be a valid TFS account (if you want to use the auto registration functions this needs to be a member of the Server\Team Foundation Adminstrators group).
tfsPassword The password for the above mentioned identity (username).
tfsServerAddress Fully qualified address for the TFS server (http://<servername>:<port>

buildLabPort The port used by the TfsBuildLab service for event notification subscriptions.
buildLabAdminPort The port used by the TfsBuildLab service to expose it's administrative services.

tfsBuildLabConnectionString The connection string to the TfsBuildLab database, for a single server installation the connection string would be the following "Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=TfsBuildLab;Data Source=(local)"

RetentionPoliciesOnlyCleanupDropLocation
AutoRegisterNotifications This setting allows you to turn of the automatic registration of notifications, we introduced this since this feature requires the account used to access the TFS server to be a memeber of the administrators group. If you bump into problems during service intialization that is related to this you need to do one of the following to resolve it:

QueueManagementInterval The poll frequency for checking the build queue (in milliseconds, defaults to 60000)
ScheduleManagementInterval The poll frequency for checking for new schedules (in milliseconds, defaults to 60000) this is only used if the service is started up without and schedules in the database.
RetentionPolicyEnforcementInterval The poll frequency for checking for old builds to purge (in milliseconds, defaults to 3600000)

smtpServerAddress The address for the SMTP server used for sending out CI alerts.
CINotificationSenderAddress The email address to that will be the sender of the CI info mails when the build breaks.
CIAdministrativeNotificationEmail The email address that will receive a copy of all CI info mails that are sent.

CINotificationWorkItemType The TFS workitem type to create when a CI build fails.
CINotificationWorkItemFields A list of fields and their values that are required to be filled out when creating the workitem type above this list is separated by semicolon. T he result would look like this "Microsoft.VSTS.CMMI.Symptom=Test;Microsoft.VSTS.CMMI.StepsToReproduce=YAT" (in a CMMI project where the feilds symptom and stepstoreproduce are mandatory)

Troubleshooting

Add the user to the Team Foundation Administrators group. You can achive this by executing the following command: tfssecurity.exe /server:http://[TFSSERVER]:[PORT] /g+ adm: n:[DOMAIN]\[ACCOUNT] or simply using the Team Explorer and adding it to the group using the UI*
Turn of automatic registration by changing the setting to false and then manually add the nessecary registrations like this:

BisSubscribe.exe /eventtype BuildStatusChangeEvent /address http://[TFSBUILDLABSERVER]:[PORT] / /deliveryType Soap /server http://[TFSSERVER]:[PORT]
BisSubscribe.exe /eventtype BuildCompletionEvent /address http://[TFSBUILDLABSERVER]:[PORT] / /deliveryType Soap /server http://[TFSSERVER]:[PORT]
BisSubscribe.exe /eventtype CheckinEvent /address http://[TFSBUILDLABSERVER]:[PORT] / /deliveryType Soap /server http://[TFSSERVER]:[PORT]

Make sure that the account (by default it's running as local system) running the service is a member of the local administrators group. This is a temporary requirement and will be removed in a future relese.

A more proper way to fix this (if you don't want the service to run as administrator) you need to configure http.sys to allow the service account to setup a channel using the http transport (this is a WCF related issue) you can do this in two ways:

Use a tool called HttpNamespaceManager which you can find here http://blogs.msdn.com/paulwh/archive/2007/05/04/addressaccessdeniedexception-http-could-not-register-url-http-8080.aspx just make sure that you have selected an account when you are about to modify the permissions and grant execute persmissions to your service account.
Manually configure it as described by Keith Brown in his article here http://msdn.microsoft.com/msdnmag/issues/06/11/SecurityBriefs/default.aspx?loc=null there are some syntax problems (atleast for us) when following this article (also you'll need to determine the sid so for clarity it should look like this:

Retrive the sid using a tool called getsid (it's included in the windows resource kit but we have uploaded it here as well) to retrieve a sid you need to specify two servers (they can actually be the same server): getsid \\[server] [domain]/[account] \\[server] [domain]/[user]
Once you have a sid run httpcfg (make sure the port is the one you have specifed in your config as buildLabPort and that the sid is the one you retrieved in the previous step (note the command should return 0 if successful): httpcfg set urlacl /u http://+:8000/ /a D:(A;;GX;;;S-1-5-21-1681502023-2202157333-1552196959-1028)

On Windows Vista you can use the simpler netsh.exe command instead of httpcfg.exe: netsh.exe http add urlacl url=http://+:8000/ user=domain\user

Troubleshooting the service

Turn on the tracing by adding the following section to the configuration file:

<system.diagnostics>
<trace autoflush="false" indentsize="4">
<listeners>
<add name="TextLog" type="System.Diagnostics.TextWriterTraceListener" initializeData="c:\\tfsbuildlab.log" />
</listeners>
</trace>
</system.diagnostics>

UPDATED WIKI: Installing TfsBuildLab Service

PeterBlomqvist — Sun, 14 Oct 2007 18:18:33 GMT

Installation

Run the CreateDatabase.sql script on your database to create the needed tables.
Run the CreateLogin.sql script to setup the needed security (don't forget to replace the string DOMAIN/ACCOUNT in the script with the account that is running your service).
Run the InsertData.sql script on your database to insert the needed data.

Prerequisites

Configuration

The following section explains the various settings available in the config file of the service:

tfsUser the identity (username) that the service should use when connecting to the TFS server, this needs to be a valid TFS account (if you want to use the auto registration functions this needs to be a member of the Server\Team Foundation Adminstrators group).
tfsPassword The password for the above mentioned identity (username).
tfsServerAddress Fully qualified address for the TFS server (http://<servername>:<port>

smtpServerAddress The address for the SMTP server used for sending out CI alerts.
buildLabPort The port used by the TfsBuildLab service for event notification subscriptions.
buildLabAdminPort The port used by the TfsBuildLab service to expose it's administrative services.
tfsBuildLabConnectionString Fully qualified connection string to the TfsBuildLab database created in the second step, for a single server installation the connection string would be the following "Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=TfsBuildLab;Data Source=(local)"
RetentionPoliciesOnlyCleanupDropLocation
AutoRegisterNotifications This setting allows you to turn of the automatic registration of notifications, we introduced this since this feature requires the account used to access the TFS server to be a memeber of the administrators group. If you bump into problems during service intialization that is related to this you need to do one of the following to resolve it:

Add the user to the Team Foundation Administrators group. You can achive this by executing the following command: tfssecurity.exe /server:http://[TFSSERVER]:[PORT] /g+ adm: n:[DOMAIN]\[ACCOUNT] or simply using the Team Explorer and adding it to the group using the UI*
Turn of automatic registration by changing the setting to false and then manually add the nessecary registrations like this:

BisSubscribe.exe /eventtype BuildStatusChangeEvent /address http://[TFSBUILDLABSERVER]:[PORT] / /deliveryType Soap /server http://[TFSSERVER]:[PORT]
BisSubscribe.exe /eventtype BuildCompletionEvent /address http://[TFSBUILDLABSERVER]:[PORT] / /deliveryType Soap /server http://[TFSSERVER]:[PORT]
BisSubscribe.exe /eventtype CheckinEvent /address http://[TFSBUILDLABSERVER]:[PORT] / /deliveryType Soap /server http://[TFSSERVER]:[PORT]

QueueManagementInterval The poll frequency for checking the build queue (in milliseconds, defaults to 6000)
ScheduleManagementInterval The poll frequency for checking for new schedules (in milliseconds, defaults to 6000) this is only used if the service is started up without and schedules in the database.
RetentionPolicyEnforcementInterval The poll frequency for checking for old builds to purge (in milliseconds, defaults to 3600000)
CINotificationWorkItemType The TFS workitem type to create when a CI build fails.
CINotificationWorkItemFields A list of fields and their values that are required to be filled out when creating the workitem type above this list is separated by semicolon. T he result would look like this "Microsoft.VSTS.CMMI.Symptom=Test;Microsoft.VSTS.CMMI.StepsToReproduce=YAT" (in a CMMI project where the feilds symptom and stepstoreproduce are mandatory)
CINotificationSenderAddress The email address to that will be the sender of the CI info mails when the build breaks.
CIAdministrativeNotificationEmail The email address that will receive a copy of all CI info mails that are sent.

Troubleshooting

Make sure that the account (by default it's running as local system) running the service is a member of the local administrators group. This is a temporary requirement and will be removed in a future relese.

A more proper way to fix this (if you don't want the service to run as administrator) you need to configure http.sys to allow the service account to setup a channel using the http transport (this is a WCF related issue) you can do this in two ways:

Use a tool called HttpNamespaceManager which you can find here http://blogs.msdn.com/paulwh/archive/2007/05/04/addressaccessdeniedexception-http-could-not-register-url-http-8080.aspx just make sure that you have selected an account when you are about to modify the permissions and grant execute persmissions to your service account.
Manually configure it as described by Keith Brown in his article here http://msdn.microsoft.com/msdnmag/issues/06/11/SecurityBriefs/default.aspx?loc=null there are some syntax problems (atleast for us) when following this article (also you'll need to determine the sid so for clarity it should look like this:

Retrive the sid using a tool called getsid (it's included in the windows resource kit but we have uploaded it here as well) to retrieve a sid you need to specify two servers (they can actually be the same server): getsid \\[server] [domain]/[account] \\[server] [domain]/[user]
Once you have a sid run httpcfg (make sure the port is the one you have specifed in your config as buildLabPort and that the sid is the one you retrieved in the previous step (note the command should return 0 if successful): httpcfg set urlacl /u http://+:8000/ /a D:(A;;GX;;;S-1-5-21-1681502023-2202157333-1552196959-1028)

On Windows Vista you can use the simpler netsh.exe command instead of httpcfg.exe: netsh.exe http add urlacl url=http://+:8000/ user=domain\user

Troubleshooting the service

Turn on the tracing by adding the following section to the configuration file:

<system.diagnostics>
<trace autoflush="false" indentsize="4">
<listeners>
<add name="TextLog" type="System.Diagnostics.TextWriterTraceListener" initializeData="c:\\tfsbuildlab.log" />
</listeners>
</trace>
</system.diagnostics>

UPDATED WIKI: Installing TfsBuildLab Service

PeterBlomqvist — Sun, 14 Oct 2007 18:07:12 GMT

Installation

Run the CreateDatabase.sql script on your database to create the needed tables.
Run the CreateLogin.sql script to setup the needed security (don't forget to replace the string DOMAIN/ACCOUNT in the script with the account that is running your service).
Run the InsertData.sql script on your database to insert the needed data.

Prerequisites

Configuration

The following section explains the various settings available in the config file of the service:

tfsUser Contain the identity (username) that the service should use when connecting to the TFS server, this needs to be a valid TFS account (if you want to use the auto registration functions this needs to be a member of .
tfsPassword The password for the above mentioned identity.
tfsServerAddress Fully qualified address for the TFS server (http://<servername>:<port>
smtpServerAddress The address for the SMTP server used for sending out CI alerts.
buildLabPort The port used by the TfsBuildLab service for event notification subscriptions.
buildLabAdminPort The port used by the TfsBuildLab service to expose it's administrative services.
tfsBuildLabConnectionString Fully qualified connection string to the TfsBuildLab database created in the second step, for a single server installation the connection string would be the following "Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=TfsBuildLab;Data Source=(local)"
RetentionPoliciesOnlyCleanupDropLocation
AutoRegisterNotifications This setting allows you to turn of the automatic registration of notifications, we introduced this since this feature requires the account used to access the TFS server to be a memeber of the administrators group. If you bump into problems during service intialization that is related to this you need to do one of the following to resolve it:

Add the user to the Team Foundation Administrators group. You can achive this by executing the following command: tfssecurity.exe /server:http://[TFSSERVER]:[PORT] /g+ adm: n:[DOMAIN]\[ACCOUNT] or simply using the Team Explorer and adding it to the group using the UI*
Turn of automatic registration by changing the setting to false and then manually add the nessecary registrations like this:

BisSubscribe.exe /eventtype BuildStatusChangeEvent /address http://[TFSBUILDLABSERVER]:[PORT] / /deliveryType Soap /server http://[TFSSERVER]:[PORT]
BisSubscribe.exe /eventtype BuildCompletionEvent /address http://[TFSBUILDLABSERVER]:[PORT] / /deliveryType Soap /server http://[TFSSERVER]:[PORT]
BisSubscribe.exe /eventtype CheckinEvent /address http://[TFSBUILDLABSERVER]:[PORT] / /deliveryType Soap /server http://[TFSSERVER]:[PORT]

QueueManagementInterval The poll frequency for checking the build queue (in milliseconds, defaults to 6000)
ScheduleManagementInterval The poll frequency for checking for new schedules (in milliseconds, defaults to 6000) this is only used if the service is started up without and schedules in the database.
RetentionPolicyEnforcementInterval The poll frequency for checking for old builds to purge (in milliseconds, defaults to 3600000)
CINotificationWorkItemType The TFS workitem type to create when a CI build fails.
CINotificationWorkItemFields A list of fields and their values that are required to be filled out when creating the workitem type above this list is separated by semicolon. T he result would look like this "Microsoft.VSTS.CMMI.Symptom=Test;Microsoft.VSTS.CMMI.StepsToReproduce=YAT" (in a CMMI project where the feilds symptom and stepstoreproduce are mandatory)
CINotificationSenderAddress The email address to that will be the sender of the CI info mails when the build breaks.
CIAdministrativeNotificationEmail The email address that will receive a copy of all CI info mails that are sent.

Troubleshooting

Make sure that the account (by default it's running as local system) running the service is a member of the local administrators group. This is a temporary requirement and will be removed in a future relese.

A more proper way to fix this (if you don't want the service to run as administrator) you need to configure http.sys to allow the service account to setup a channel using the http transport (this is a WCF related issue) you can do this in two ways:

Use a tool called HttpNamespaceManager which you can find here http://blogs.msdn.com/paulwh/archive/2007/05/04/addressaccessdeniedexception-http-could-not-register-url-http-8080.aspx just make sure that you have selected an account when you are about to modify the permissions and grant execute persmissions to your service account.
Manually configure it as described by Keith Brown in his article here http://msdn.microsoft.com/msdnmag/issues/06/11/SecurityBriefs/default.aspx?loc=null there are some syntax problems (atleast for us) when following this article (also you'll need to determine the sid so for clarity it should look like this:

Retrive the sid using a tool called getsid (it's included in the windows resource kit but we have uploaded it here as well) to retrieve a sid you need to specify two servers (they can actually be the same server): getsid \\[server] [domain]/[account] \\[server] [domain]/[user]
Once you have a sid run httpcfg (make sure the port is the one you have specifed in your config as buildLabPort and that the sid is the one you retrieved in the previous step (note the command should return 0 if successful): httpcfg set urlacl /u http://+:8000/ /a D:(A;;GX;;;S-1-5-21-1681502023-2202157333-1552196959-1028)

On Windows Vista you can use the simpler netsh.exe command instead of httpcfg.exe: netsh.exe http add urlacl url=http://+:8000/ user=domain\user

Troubleshooting the service

Turn on the tracing by adding the following section to the configuration file:

<system.diagnostics>
<trace autoflush="false" indentsize="4">
<listeners>
<add name="TextLog" type="System.Diagnostics.TextWriterTraceListener" initializeData="c:\\tfsbuildlab.log" />
</listeners>
</trace>
</system.diagnostics>

UPDATED WIKI: Installing TfsBuildLab Service

PeterBlomqvist — Sun, 14 Oct 2007 18:00:59 GMT

Installation

Run the CreateDatabase.sql script on your database to create the needed tables.
Run the CreateLogin.sql script to setup the needed security (don't forget to replace the string DOMAIN/ACCOUNT in the script with the account that is running your service).
Run the InsertData.sql script on your database to insert the needed data.

Prerequisites

Configuration

The following section explains the various settings available in the config file of the service:

tfsUser Should contain the identity (username) that the service should use when connecting to the TFS server.
tfsPassword The password for the above mentioned identity.
tfsServerAddress Fully qualified address for the TFS server (http://<servername>:<port>
smtpServerAddress The address for the SMTP server used for sending out CI alerts.
buildLabPort The port used by the TfsBuildLab service for event notification subscriptions.
buildLabAdminPort The port used by the TfsBuildLab service to expose it's administrative services.
tfsBuildLabConnectionString Fully qualified connection string to the TfsBuildLab database created in the second step, for a single server installation the connection string would be the following "Integrated Security=SSPI;Persist Security Info=False;Initial Catalog=TfsBuildLab;Data Source=(local)"
RetentionPoliciesOnlyCleanupDropLocation
AutoRegisterNotifications This setting allows you to turn of the automatic registration of notifications, we introduced this since this feature requires the account used to access the TFS server to be a memeber of the administrators group. If you bump into problems during service intialization that is related to this you need to do one of the following to resolve it:

Add the user to the Team Foundation Administrators group. You can achive this by executing the following command: tfssecurity.exe /server:http://[TFSSERVER]:[PORT] /g+ adm: n:[DOMAIN]\[ACCOUNT] or simply using the Team Explorer and adding it to the group using the UI*
Turn of automatic registration by changing the setting to false and then manually add the nessecary registrations like this:

BisSubscribe.exe /eventtype BuildStatusChangeEvent /address http://[TFSBUILDLABSERVER]:[PORT] / /deliveryType Soap /server http://[TFSSERVER]:[PORT]
BisSubscribe.exe /eventtype BuildCompletionEvent /address http://[TFSBUILDLABSERVER]:[PORT] / /deliveryType Soap /server http://[TFSSERVER]:[PORT]
BisSubscribe.exe /eventtype CheckinEvent /address http://[TFSBUILDLABSERVER]:[PORT] / /deliveryType Soap /server http://[TFSSERVER]:[PORT]

QueueManagementInterval The poll frequency for checking the build queue (in milliseconds, defaults to 6000)
ScheduleManagementInterval The poll frequency for checking for new schedules (in milliseconds, defaults to 6000) this is only used if the service is started up without and schedules in the database.
RetentionPolicyEnforcementInterval The poll frequency for checking for old builds to purge (in milliseconds, defaults to 3600000)
CINotificationWorkItemType The TFS workitem type to create when a CI build fails.
CINotificationWorkItemFields A list of fields and their values that are required to be filled out when creating the workitem type above this list is separated by semicolon. T he result would look like this "Microsoft.VSTS.CMMI.Symptom=Test;Microsoft.VSTS.CMMI.StepsToReproduce=YAT" (in a CMMI project where the feilds symptom and stepstoreproduce are mandatory)
CINotificationSenderAddress The email address to that will be the sender of the CI info mails when the build breaks.
CIAdministrativeNotificationEmail The email address that will receive a copy of all CI info mails that are sent.

Troubleshooting

Make sure that the account (by default it's running as local system) running the service is a member of the local administrators group. This is a temporary requirement and will be removed in a future relese.

A more proper way to fix this (if you don't want the service to run as administrator) you need to configure http.sys to allow the service account to setup a channel using the http transport (this is a WCF related issue) you can do this in two ways:

Use a tool called HttpNamespaceManager which you can find here http://blogs.msdn.com/paulwh/archive/2007/05/04/addressaccessdeniedexception-http-could-not-register-url-http-8080.aspx just make sure that you have selected an account when you are about to modify the permissions and grant execute persmissions to your service account.
Manually configure it as described by Keith Brown in his article here http://msdn.microsoft.com/msdnmag/issues/06/11/SecurityBriefs/default.aspx?loc=null there are some syntax problems (atleast for us) when following this article (also you'll need to determine the sid so for clarity it should look like this:

Retrive the sid using a tool called getsid (it's included in the windows resource kit but we have uploaded it here as well) to retrieve a sid you need to specify two servers (they can actually be the same server): getsid \\[server] [domain]/[account] \\[server] [domain]/[user]
Once you have a sid run httpcfg (make sure the port is the one you have specifed in your config as buildLabPort and that the sid is the one you retrieved in the previous step (note the command should return 0 if successful): httpcfg set urlacl /u http://+:8000/ /a D:(A;;GX;;;S-1-5-21-1681502023-2202157333-1552196959-1028)

On Windows Vista you can use the simpler netsh.exe command instead of httpcfg.exe: netsh.exe http add urlacl url=http://+:8000/ user=domain\user

Troubleshooting the service

Turn on the tracing by adding the following section to the configuration file:

<system.diagnostics>
<trace autoflush="false" indentsize="4">
<listeners>
<add name="TextLog" type="System.Diagnostics.TextWriterTraceListener" initializeData="c:\\tfsbuildlab.log" />
</listeners>
</trace>
</system.diagnostics>