TFS 2010 Object Model: connettersi ad un server TFS

Per questioni di lavoro mi sono occupato recentemente di interagire, via codice, utilizzando l’object model, con TFS. Vorrei iniziare una mini serie dedicata a trucchi e brevi articoli sull’utilizzo di alcune classi presenti all’interno dello stesso object model. La serie non ha la pretesa di essere esaustiva ma ha lo scopo, come mia consuetudine, di condividere il know-how.

Questo post riguarda la parte iniziale di ogni interazione con TFS: la connessione al server.

Se vogliamo creare applicativi client che interagiscono con Team Foundation Server 2010, possiamo utilizzare l’object model messo a disposizione dalle librerie Microsoft.TeamFoundation.*.dll.

In particolare per la connessione al server è necessario referenziare le librerie Microsoft.TeamFoundation.Client.dll e Microsoft.TeamFoundation.Common.dll.

La connessione al server TFS (allo scopo di ottenere servizi per la gestione delle entità proprie del server) può essere eseguita mediante la classe TFSConfigurationServer contenuta all’interno del namespace Microsoft.TeamFoundation.Client (nell’assembly Microsoft.TeamFoundation.Client.dll).

E’ possibile creare un’istanza della TFSConfigurationServer in due modalità:

• Utilizzando il costruttore:

1. Dim tfsInstance1 = New TfsConfigurationServer(New Uri("http://server:8080/tfs"), New UICredentialsProvider())

• Utilizzando la classe factory TFSConfigurationServerFactory:

1. Dim tfsInstance1 = TfsConfigurationServerFactory.GetConfigurationServer(New Uri("http://server:8080/tfs"), New UICredentialsProvider())

In entrambi i casi l’indirizzo http://server:8080/tfs deve essere un indirizzo valido per la connessione a TFS. Possiamo ottenere l’indirizzo sfruttando il Team Explorer. E’ sufficiente aprire le properties di una collection del Team Explorer per avere l’indirizzo da inserire nelle nostre classi:

Sia costruttore che factory mettono a disposizione overload per specificare le credenziali di accesso ma, in questo momento, non ce ne preoccupiamo e come provider di credenziali utilizziamo la classe UICredentialProvider che permette, se TfsConfigurationServer non trova delle credenziali in cache, di richiederle all’utente con un prompt.

Quello che ci interessa in questo post è mettere in evidenza la sostanziale differenza tra costruttore e factory e cioè il fatto che il costruttore permette di ottenere differenti istanze di conessione  (una per ogni New) mentre la factory crea una nuova istanza la prima volta che viene richiamato il metodo GetConfigurationServer e restituisce la stessa istanza le volte successive.

Per verificare questo non possimao utilizzare il metodo Equals delal classe Object perchè tale metodo e ridefinito nella classe TfsConnection da cui la TfsConfigurationServer deriva per confrontare due istanze della classe e definirle uguali quando hanno lo stesso Url. Allora scriviamo il seguente codice:

1. Dim tfsInstance1 = New TfsConfigurationServer(New Uri("http://server:8080/tfs"),
2.                                               New UICredentialsProvider())
3. Dim tfsInstance2 = New TfsConfigurationServer(New Uri("http://server:8080/tfs"),
4.                                               New UICredentialsProvider())
5. tfsInstance1.Dispose()

A seguito della chiamata al metodo Dispose, se le istanze sono distinte, tfsInstance1 sarà “disposata” mentre la tfsInstance2 no.

Per verificare questo inseriamo dei QuickWatch nel nostro progetto in modo da mettere in evidenza i valori delle proprietà Disposed (che non sono visibili direttamente perchè Friend) e osserviamo che, dopo il Dispose si ha:

Facciamo la stessa cosa per le istanze generate dalla Factory:

1. Dim tfsInstance1 = TfsConfigurationServerFactory.GetConfigurationServer(New Uri("http://server:8080/tfs"),
2.                                                                     New UICredentialsProvider())
3. Dim tfsInstance2 = TfsConfigurationServerFactory.GetConfigurationServer(New Uri("http://server:8080/tfs"),
4.                                                                     New UICredentialsProvider())
5.  
6. tfsInstance1.Dispose()

In questo caso, i QuickWatch ci segnalano:

Se questo non bastasse possiamo analizzare come viene implementato il metodo GetConfigeurationServer della TfsConfigurationServerFactory utilizzando Reflector:

La classe implementa una sorta di cache (si tratta di un Dictionary(Of Uri,TfsConfigurationServer) ) in cui viene ricercata un eventuale istanza già creata (punto 1) e, in caso in cui sia presente restituita. Se non esiste un’istanza per l’Uri passato come argomento, la factory utilizza il costruttore per istanziare una nuova TfsConfigurationServer e la memorizza nella propria cache (punto 2).

 

Tag di Technorati: tfs om,tfs object model,tfsconfigurationserver,tfsconfigurationserverfactory,tfsconnection,team foundation server object model,microsoft.teamfoundation.common,microsoft.teamfoundation.client