TFS2010 Object Model: Scaricare tutti i file sorgente di tutte le project collection in un colpo solo e senza workspace

In questo post vorrei mostrarvi come sia possibile scaricare tutti i files presenti nel controllo di codice sorgente di TFS senza utilizzare un workspace.

Per fare questo utilizzeremo un istanza della classe VersionControlService (namespace Microsoft.TeamFoundation.VersionControl.Client).

Prima di tutto abbiamo la necessità di referenziare gli assembly:

• Microsoft.TeamFoundation.Client.dll;
• Microsoft.TeamFoundation.VersionControl.Client.dll;
• Microsoft.TeamFoundation.Common.dll

Le dll sono già presenti nelle macchine che hanno installato Team Explorer.

L’algoritmo che utilizzeremo sarà:

• recuperare l’elenco delle project collection presenti sul server TFS (e a cui abbiamo accesso);
• iterare su ogni collection e recuperare l’elenco di tutti i file sotto controllo di codice sorgente ad una certa data
• salvare i file in una cartella definita dall’utente mantenendo la struttura gerarchica delle cartelle sul server.

Abbiamo già visto in un precedente post come recuperare l’elenco delle collection e, riportiamo, quindi solo il codice necessario:

1. Private Sub CreateTFSServer(ByVal serverUrl As String)
2.     Contracts.Contract.Requires(Not String.IsNullOrWhiteSpace(serverUrl), "Url Server non pu? essere vuoto")
3.     If TFSServer IsNot Nothing Then TFSServer.Dispose()
4.     Try
5.         TFSServer = TfsConfigurationServerFactory.GetConfigurationServer(New Uri(serverUrl), New UICredentialsProvider())
6.     Catch ex As Exception
7.         Throw
8.     End Try
9. End Sub
10.  
11. Public Function GetCollectionUris() As IEnumerable(Of String)
12.     Contracts.Contract.Requires(Me.TFSServer IsNot Nothing, "Server non connesso")
13.     Dim retList As IEnumerable(Of String) = Nothing
14.     Try
15.         Dim collections = Me.TFSServer.CatalogNode().QueryChildren({CatalogResourceTypes.ProjectCollection},
16.                                                                    False,
17.                                                                    CatalogQueryOptions.None)
18.         retList = From o In collections
19.                   Select String.Format("{0}/{1}", Me.TFSServer.Uri.AbsoluteUri, o.Resource.DisplayName)
20.     Catch ex As Exception
21.         Throw
22.     End Try
23.     Return retList
24. End Function

Il metodo CreateTFSServer istanzia un oggetto di classe TfsConfigurationServer utile per accedere ai dati delle collection che sono, invece, recuperati dal metodo GetCollectionUris. Questo metodo restituisce una collezione di stringhe che rappresentano gli uri delle singole collezioni nella forma:

http://mioserver:8080/tfs/miacollezione

Il seguente metodo permette di recuperare l’elenco dei file sotto controllo di codice sorgente per una collezione:

1. Public Function GetVersionedItems(ByVal collectionUri As String,
2.                                   ByVal projectName As String,
3.                                   ByVal filter As String,
4.                                   ByVal versionDate As DateTime) As IEnumerable(Of Item)
5.     Contracts.Contract.Requires(Not String.IsNullOrWhiteSpace(collectionUri), "CollectionUri non pu? essere nullo")
6.     Dim retList As IEnumerable(Of Item) = Nothing
7.     Try
8.         Dim tpc = TfsTeamProjectCollectionFactory.GetTeamProjectCollection(New Uri(collectionUri))
9.         Dim versionControlServer = CType(tpc.GetService(Of VersionControlServer)(), VersionControlServer)
10.         Dim pathStr = String.Format("$/{0}/{1}", projectName, filter)
11.         Dim dateVerSpec = New DateVersionSpec(versionDate)
12.         retList = versionControlServer.GetItems(pathStr, dateVerSpec, RecursionType.Full).Items
13.     Catch ex As Exception
14.         Throw
15.     End Try
16.     Return retList
17. End Function

Per prima cosa otteniamo l’istanza della classe TfsTeamProjectCollection necessaria per ricavare l’oggetto VersionControlServer il quale ci permette, tramite il metodo GetItems, di recuperare l’elenco degli Items sotto controllo di codice sorgente. Da notare che l’argomento stringa filter può servire per recuperare tutti e soli gli item di un certo tipo (ad esempio “*.vb”).

Ultimo step dell’algoritmo è quello di salvare gli items di tipo file nella cartella decisa dall’utente e per fare ciò ci viene in aiuto il seguente codice:

1. Private Function SaveItems(ByVal items As IEnumerable(Of Microsoft.TeamFoundation.VersionControl.Client.Item),
2.                            ByVal destinationPath As String) As IEnumerable(Of String)
3.     Dim retval = New List(Of String)
4.     For Each Item In items
5.         If Item.ItemType = ItemType.File Then
6.             Dim origFileName = Item.ServerItem.Replace("$/", "")
7.             origFileName = origFileName.Replace("/", "\")
8.             Dim fileName = IO.Path.Combine(destinationPath, origFileName)
9.             Try
10.                 Item.DownloadFile(fileName)
11.                 retval.Add(fileName)
12.             Catch ex As Exception
13.                 Throw
14.             End Try
15.         End If
16.     Next
17.     Return retval
18. End Function

In questo caso iteriamo sugli items di tipo ItemType.File, per ognuno di questi creiamo il percorso in cui salvarlo a partire dal percorso originale all’interno della cartella di destinazione e salviamo il file.

Il metodo che esegue i tre passi precedenti è il seguente:

1. Private Function DownloadAllItems(ByVal destinationPath As String, _
2.                                   ByVal versionDate As DateTime) As IEnumerable(Of String)
3.     Contracts.Contract.Requires(Not String.IsNullOrWhiteSpace(destinationPath), "destinationPath non pu? essere vuota")
4.     Dim retval = New List(Of String)
5.     Dim colls As IEnumerable(Of String) = Nothing
6.     Try
7.         colls = Me.GetCollectionUris()
8.     Catch ex As Exception
9.         Throw
10.     End Try
11.     If colls IsNot Nothing Then
12.         For Each coll In colls
13.             Dim items As IEnumerable(Of Item) = Nothing
14.             Try
15.                 items = GetVersionedItems(coll, Nothing, "*.*", versionDate)
16.             Catch ex As Exception
17.                 Throw
18.             End Try
19.             If items IsNot Nothing Then
20.                 Dim collName = coll.Substring(coll.LastIndexOf("/") + 1)
21.                 Dim destPath = IO.Path.Combine(destinationPath, collName)
22.                 Try
23.                     retval.AddRange(SaveItems(items, destPath))
24.                 Catch ex As Exception
25.                     Throw
26.                 End Try
27.             End If
28.         Next
29.     End If
30.     Return retval
31. End Function

Nella soluzione che trovate allegata al post, è presente anche una versione asincrona (l’operazione di autenticazione e recupero degli items da TFS può durare anche qualche secondo) che utilizza un algoritmo del tutto analogo.

La form dell’applicazione è la seguente:

Tag di Technorati: tfs object model,tfs 2010 object model,controlversionservice,controllo sorgente,project collections