Jason Prickett's Blog : PowerShell

Queuing a build in PowerShell

Jason Prickett — Wed, 25 Apr 2007 16:37:00 GMT

I just read Aaron's post "Team Build Object Model - Queueing a Build" and I just had convert his code to PowerShell (for those of us that just hate waiting for code to compile!).

So, here is how to Queue a build in PowerShell (uses my Get-BuildServer script found here):

> $buildserver = Get-BuildServer "http://tfs:8080"
> $teamProject = "TeamProject"
> $buildDefinition = "Nightly"
> $definition = $buildserver.GetBuildDefinition($teamProject, $buildDefinition)
> $request = $definition.CreateBuildRequest()
> $buildserver.QueueBuild($request, "None")

As you can see the code is almost identical (minus the great comments that Aaron's code has). The benefit that I see to doing this in PowerShell is simply that you don't have to open VS, create a new project, write the code, compile it, open the bin folder, and then run the exe. Instead, you can simply open PS, type the code, and see the results.

Look for more PowerShell scripts coming soon like Queue-Build.ps1!

Getting the Builds Associated with a Changeset Number

Jason Prickett — Thu, 29 Mar 2007 21:05:00 GMT

In the Orcas release we allow you to Query for builds (and build definitions) through the object model. However, the number of things you can filter the query on is somewhat limited.

One of the things that I find that I need to query builds for is the Changeset that they are associated with. Here's the scenario: I checked in a fix sometime in the past that fixed a bug, but my test team says that the bug is still broken in the latest build. I would like to see which build included my fix. Well, it's easy enough for me to look at the bug in TFS and see which changeset is associated with the fix, but I can't easily see which build contained that changeset. So, I need to query the Build Server to get my answer. Unfortunately, the object model does not easily allow me to query on builds by the associated changeset numbers, so, I wrote a PowerShell script.

The basic idea is that we need to Query for all Builds for a team project, look at each one's associated changesets, and return a list of only those that are associated with the changeset number we care about.

Here's the code:

     $serverName = "http://server:8080"
     $teamproject = "projectname"
     $changesetId = 123

     $buildserver = Get-BuildServer($servername)

     $spec = $buildserver.CreateBuildDetailSpec()
     $spec.DefinitionPath = "\" + $teamproject + "\**"
     $spec.BuildNumber = "*"
     $spec.QueryOptions = "None"
     $spec.InformationTypes = "AssociatedChangeset"

$queryResult = $buildserver.QueryBuilds($spec)

     $queryResult.Builds | foreach-object {
         $build = $_
         $associatedChangesetNodes = $build.Information.Nodes
         if ($associatedChangesetNodes)
         {
             $changesets = [int[]]@($associatedChangesetNodes | foreach-object { $_.Fields["ChangesetId"] })
             if ($changesets -contains $changesetId)
             {
                 add-member -in $build noteproperty "AssociatedChangesets" $changesets -passthru
             }
         }
     }

This script and other useful Build related PowerShell scripts are attached to my script post.

I called this script Get-BuildsForChangeset.ps1 and allowed the server name, team project and changeset number to be passed in. Here is an example of the call and the output:

> Get-BuildsForChangeset 'http://jpricket-test:8080' 'jpricket-032707-2' 6 AssociatedChangesets : {6} BuildServer : Microsoft.TeamFoundation.Build.Client.BuildServer BuildAgent : BuildDefinition : BuildFinished : True BuildNumber : Nightly_20070329.2 CompilationStatus : Succeeded ConfigurationFolderPath : $/jpricket-032707-2/TeamBuildTypes/Nightly DropLocation : \\jpricket-test\drops\Nightly_20070329.2 FinishTime : 3/29/2007 1:32:15 PM Information : Microsoft.TeamFoundation.Build.Client.BuildInformation LogLocation : \\jpricket-test\drops\Nightly_20070329.2\BuildLog.txt Quality : Status : Succeeded TestStatus : Succeeded Uri : vstfs:///Build/Build/9 BuildDefinitionUri : vstfs:///Build/Definition/1 CommandLineArguments : StartTime : 3/29/2007 1:31:48 PM BuildAgentUri : vstfs:///Build/Agent/1 ConfigurationFolderUri : vstfs:///VersionControl/VersionedItem... ConfigurationFolderGetTime : 3/29/2007 1:31:48 PM SourceGetVersion : C6 RequestedFor : NORTHAMERICA\jpricket RequestedBy : NORTHAMERICA\jpricket LastChangedOn : 3/29/2007 1:32:14 PM LastChangedBy : REDMOND\bissvc KeepForever : False LabelName : Nightly_20070329.2@$/jpricket-032707-2

Various PowerShell scripts

Jason Prickett — Thu, 29 Mar 2007 20:54:00 GMT

This page just gives me a place to keep a most-recent-copy of my various PowerShell scripts, mostly related to Team Build. This makes it easier for people that want to use them than having to copy-paste from lots of different blog posts.

Contents:

Get-BuildServer.ps1 - given a TFS server name, it returns an instance of IBuildServer (Orcas only)
Get-BuildsForChangeset.ps1 - given a TFS server name, team project, and changeset number, it returns a list of all builds that included that changeset (Orcas only)
(more to come)

History:

2007-03-29: initial posting

Average Build Size

Jason Prickett — Tue, 20 Mar 2007 22:24:00 GMT

So, I haven't actually gotten a request for this, but I thought it might be useful :)

This entry is based on Team Build's next version which is available in a CTP release right now, and will be in Beta very soon (don't ask, I don't know when). In the next version of Team Build, we have included an Object Model (OM) that wraps all the functionality of the Web Services. This makes writing your own apps that need build information, much easier.

Let's say you are using the new features of Team Build like drop management and continuous integration. So far you have the binaries for 12 builds sitting on your server for definition X. You notice you are almost out of disk space on that server and need to purchase some more. But how much? After looking at your drop managment policy for definition X, you see that the maximum number of builds you will need to keep is 20. But how much disk space does that correspond to? You could go to the drop location and sum up the size of every folder, but is there a faster way? Of course there is!

In the following PowerShell script, I get the list of builds for definition X and then sum up the size of all files in the drop locations.

> [void][System.Reflection.Assembly]::LoadWithPartialName("Microsoft.TeamFoundation.Client")
> [void][System.Reflection.Assembly]::LoadWithPartialName("Microsoft.TeamFoundation.Build.Client")
> $tfs = [Microsoft.TeamFoundation.Client.TeamFoundationServerFactory]::GetServer("http://server:8080/")
> $buildserver = $tfs.GetService([Microsoft.TeamFoundation.Build.Client.IBuildServer])
> $buildspec = $buildserver.CreateBuildDetailSpec()
> $buildspec.DefinitionPath = "\teamproject\CSharp_Tests"
> $buildspec.BuildNumber = "*"
> $queryResult = $buildserver.QueryBuilds($buildspec)
> $queryResult.Builds | foreach { Get-ChildItem $_.droplocation -force -recurse | measure-object length -sum } | measure-object sum -average -sum

Count : 4
Average : 341554
Sum : 1366216
Maximum :
Minimum :
Property : Sum

The most complicated part of the script is the last line that sums and averages everything. This could be a little simple, but I had some issues using the normal foreach ($b in $queryResult.Buidls). Piping the builds into the foreach uses a slightly different version of that command and worked better in this case. Basically, that line loops over the builds, calls Get-ChildItem recursively for all the files in the drop location (even hidden files, that's the -force options) and sums up the length property of all the files. Finally, it averages and sums the list of file length sums and reports on that result.

I hope some one finds this information useful!

Team Build OM thru PowerShell - Example GetAffectedBuildDefinitions

Jason Prickett — Mon, 05 Mar 2007 21:56:00 GMT

Well, it's been a long time since I have had the time (okay made the time) to blog on something interesting. To make up for that, I have a quick entry that includes all kinds of interesting tidbits.

As I talk about how to use the methods and objects in the OM, I will show examples using PowerShell commands. PowerShell is an incredible recently new shell for Windows, that allows you to manipulate not just text output by command line apps, but real objects returned from any managed library. If you want to know more (and you should), goto to http://www.microsoft.com/PowerShell

So, here's a quick example:

Problem: What Build Definitions are building this C Sharp project?

You can't find this out in Visual Studio without looking at every Build Definition's workspace mappings. But there's a simple OM call that can do the work for you - GetAffectedBuildDefinitions. All you have to do is

Get a TeamFoundationServer object.
Get the IBuildServer from the TFS object.
Create a string array that contains the server path to the project file.
Pass that string array to the GetAffectedBuildDefinitions method of IBuildServer.

Here's the PowerShell commands...


Windows PowerShell
Copyright (C) 2006 Microsoft Corporation. All rights reserved.
PS C:\> [void][System.Reflection.Assembly]::LoadWithPartialName("Microsoft.TeamFoundation.Client") 
PS C:\> [void][System.Reflection.Assembly]::LoadWithPartialName("Microsoft.TeamFoundation.Build.Client") 
PS C:\> $serverName="http://server:8080/" 
PS C:\> $tfs = [Microsoft.TeamFoundation.Client.TeamFoundationServerFactory]::GetServer($serverName) 
PS C:\> $buildserver = $tfs.GetService([Microsoft.TeamFoundation.Build.Client.IBuildServer]) 
PS C:\> $defs = $buildserver.GetAffectedBuildDefinitions("$/teamproj/app1/app1/app1.csproj") 
PS C:\> $defs | select TeamProject, Name, Uri
TeamProject                 Name         Uri
-----------                 ----         ---
teamproj                    Continuous   vstfs:///Build/Definition/2
teamproj                    Nightly      vstfs:///Build/Definition/1

If you don't understand something let me know or look it up in the PowerShell docs. I am new to PowerShell myself, but I know some gurus.

I hope this simple example whets your appetite for PowerShell and the Team Build Object Model. More to come...