TFS2010 Object Model: gestiamo le project collections

In questo post vorrei porre l’attenzione su come utilizzare l’object model di TFS per gestire le Project Collection, cioè come utilizzare  da codice i servizi messi a disposizione dalla piattaforma TFS per creare, eseguire il detach o l’attach delle project collections del nostro server.

L’object model di TFS mette a disposizione l’interfaccia ITeamProjectCollectionService implementata da quelle classi che hanno la capacità di gestire le project collections.

Per prima cosa recuperiamo questa classe, utilizzando il metodo GetService (ereditato dalla classe TfsConnection) della TfsConfigurationServer:

1. Public Sub GetTeamProjectService()
2.     tpcService = CType(tfs.GetService(Of ITeamProjectCollectionService)(), ITeamProjectCollectionService)
3.     Console.WriteLine("ITeamProjectCollectionService ricavato!")
4. End Sub

dove tfs è un’istanza di TfsConfigurationServer ricavata tramite il seguente pezzo di codice:

1. Public Sub CreateTFSInstance(ByVal server As String)
2.     Try
3.         tfs = TfsConfigurationServerFactory.GetConfigurationServer(New Uri(server),
4.                                                                  New UICredentialsProvider())
5.         tfs.EnsureAuthenticated()
6.         Console.WriteLine("Instanza di TFS creata!")
7.     Catch ex As Exception
8.         Console.WriteLine("Errore nella connessione a tfs: {0}", ex.Message)
9.     End Try
10. End Sub

Una volta recuperata l’istanza del servizio che implementa ITeamProjectCollectionService abbiamo a disposizione una serie di metodi che ci permettono di “giocare” col le project collections.

Creare una collezione di progetti

I metodi di gestione delle collezioni di progetti sono, generalmente, metodi la cui esecuzione può anche durare molto ed è per questo che viene introdotto il concetto di ServicingJobDetail e di accodamento delle operazioni.

Di fatto il metodo che possiamo utilizzare per la creazione di una project collection è il metodo QueueCreateCollection che “accoda” l’operazione di creazione della collection e restituisce un oggetto di tipo ServicingJobDetail che possiamo interpellare per avere conoscenza delleo stato di avenzamento dell’operazione stessa.

Un esempio di codice per la creazione di una collezione è il seguente:

1. Dim job = tpcService.QueueCreateCollection(collName,
2.                                            String.Format("{0} - creata da codice", collName),
3.                                            False,
4.                                            String.Format("~/{0}", collName),
5.                                            Microsoft.TeamFoundation.Framework.Common.TeamFoundationServiceHostStatus.Started,
6.                                            Nothing)
7.  
8. Dim tpcoll = tpcService.WaitForCollectionServicingToComplete(job)

La versione del metodo QueueCreateCollection che stiamo utilizzando prevede i seguenti argomenti:

• name : è il nome che intendiamo dare alla nostra collection;
• description : è la descrizione della collection;
• isDefault : indica se la collection che stiamo creando è quella di default o meno;
• virtualDirectory : è la virtual directory in cui posizionare la collezione. nel nostro caso specifico utilizziamo il nome della collection preceduto da “~/”;
• state : indica lo stato in cui la collezione deve essere creata. Nel nostro caso lo stato è Started;
• servicingTokens : si tratta di un IDictionary(Of String,String) che può contenere parametri accessori utili alla crazione della collezione.

Nel momento in cui usciamo dal metodo precedente, possiamo metterci in attesa del completamento dell’operazione di creazione della collezione grazie al metodo WaitForCollectionServicingToComplete. Quest’ultimo terminerà nel momento in cui l’operazione sarà conclusa e restituirà un oggetto di classe TeamProjectCollection con le informazioni sulla collectionì stessa.

E’ interessante osservare l’operazione di creazione della collection utilizzando la console di amministrazione di TFS:

Detach di una project collection

Un’altra funzionalità esposta dall’interfaccia che stiamo esaminando è quella del detach di una project collection.

Per eseguire il detach di una collezione di progetti è necessario avere a disposizione o l’istanza della TeamProjectCollection o il Guid della collezione e richiamare l’overload opportuno del metodo QueueDetachCollection sull’interfaccia ITeamProjectCollectionService.

Il seguente pezzo di codice mostra come recuperare una TeamProjectCollection a partire dal nome della collezione di progetti ed eseguire il detach:

1. Dim collection = (From c In tpcService.GetCollections().ToList()
2.                      Where c.Name = collName
3.                      Select c).FirstOrDefault()
4. If collection IsNot Nothing Then
5.     Console.WriteLine("Detach collezione iniziato!")
6.     Try
7.         Dim connectionString As String = Nothing
8.         Dim job = tpcService.QueueDetachCollection(collection,
9.                                                    Nothing,
10.                                                    "Sto fermando la collection!!",
11.                                                    connectionString)
12.  
13.         Dim tpcoll = tpcService.WaitForCollectionServicingToComplete(job)
14.         Console.Write("Detach Collezione Ok: connectionstring={0}", connectionString)
15.     Catch ex As Exception
16.         Console.Write("Errore nel detach della collection : {0}", ex.Message)
17.     End Try
18.     Console.WriteLine()
19. Else
20.     Console.WriteLine("La collezione non esiste!")
21. End If

Anche in questo caso, il metodo QueueDetachCollection restituisce un oggetto di classe ServicingJobDetail grazie al quale siamo in grado di comprendere quando l’operazione ha termine.

I parametri utilizzati nella chiamata al metodo di detach sono:

• teamProjectCollection : è l’istanza di TeamProjectCollection che identifica la collezione da sganciare;
• servicingTokens : si tratta di un IDictionary(Of String,String) che può contenere parametri accessori utili al detach della collezione;
• collectionStoppedMessage : è il messaggio di avvertimento che appare, ad esempio, nella console di amministrazione di TFS durante l’operazione di detach;
• detachedConnectionString : è un valore restituito al chiamante e contenente la stringa di connessione del database “sganciato” da TFS che può essere, eventualmente, riagganciato in un altro TFS.
  

Attach di una project collection

La funzione inversa di una detach per una project collection è l’attach che permette di agganciare un databese (contenente una collezione di progettI) al server TFS.

Il metodo utilizzato per questa operazione è QueueAttachCollection che prevede un paio di overload il piuù semplice dei quali ha tre parametri:

• databaseConnectionString : è la stringa di connessione del database contenente la collezione di progetti;
• servicingToken : si tratta di un IDictionary(Of String,String) che può contenere parametri accessori utili al detach della collezione;
• cloneCollection : indica se eseguire o meno un clone della collezione.

Il seguente pezzo di codice mostra come si possa eseguire l’attach di una collezione data la connectionString:

1. Dim job = tpcService.QueueAttachCollection(databaseConnectionString,
2.                                            Nothing,
3.                                            True)
4.  
5. Dim tpcoll = tpcService.WaitForCollectionServicingToComplete(job)

Come visto in precedenza possiamo sfruttare il job restituito dal metodo di attach  per capire quando il lavoro è concluso.

Tra i metodi messi a disposizione dall’interfaccia vista in questo post abbiamo anche il metodo che può essere utilizzato per eseguire l’attach di un database di TFS precedente alla versione 2010.

A compendio di questo post vorrei allegare un esempio di console sviluppata con Visual Studio 2010 che permette di integrare le funzioni viste.

La console prevede che il nome del server TFS, nella forma http://server:8080/tfs , venga passato come argomento.

Tag di Technorati: tfs,tfs object model,project collection,ITeamProjectCollectionService,TfsConfigurationServer,QueueCreateCollection,ServicingJobDetail,QueueDetachCollection,QueueAttachCollection