SpiraPlan & SpiraTeam Version Control Integration User Guide Inflectra Corporation

Transcription

1 SpiraPlan & SpiraTeam Versin Cntrl Integratin User Guide Inflectra Crpratin Date: Nvember 19th, 2014

2 Cntents 1. Intrductin Integrating with Subversin Integrating with Perfrce Integrating with CVS Integrating with VSS Integrating with TFS Integrating with Mercurial Integrating with Git Intrductin SpiraPlan is a cmplete Agile Prject Management System in ne package, that manages yur prject's requirements, releases, iteratins, tasks and bugs/issues. Designed specifically t supprt agile methdlgies such as Extreme Prgramming (XP), Scrum, DSDM and Agile Unified Prcess (AUP) it allws teams t manage all their infrmatin in ne envirnment. SpiraTeam is an integrated Applicatin Lifecycle Management (ALM) system that manages yur prject's requirements, releases, test cases, issues and tasks in ne unified envirnment. SpiraTeam cntains all f the features prvided by SpiraTest - ur highly acclaimed quality assurance system and SpiraPlan. This guide utlines hw t use either SpiraPlan r SpiraTeam in cnjunctin with a variety f Versin Cntrl / Sftware Cnfiguratin Management tls. This guide assumes that the reader is familiar with bth SpiraPlan/SpiraTeam and the apprpriate versin cntrl tl. Fr infrmatin regarding hw t use the Surce Cde management features f SpiraPlan/Team, please refer t the SpiraPlan User Manual r the SpiraTeam User Manual. Each f the sectins in this dcument cvers a different versin cntrl system s we recmmend using the table f cntents n the left t lcate the versin cntrl system yu re lking t integrate, then read the installatin and usage instructins. Page 1 f 45 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

3 2. Integrating with Subversin Subversin (als knwn as SVN) is a Sftware Cnfiguratin Management (SCM) system, that enables users t wrk n cde simultaneusly while preserving previus versins by aviding cllisins in cde edits. While users wrking n the cde will usually have a cmplete cpy f the repsitry n their lcal systems, this plug-in will access the repsitry remtely by use f the svn://, and prtcls. (Nte that svn+ssh:// may be supprted n a server by server basis.) Due t the methdlgies in which IIS handles web requests and runs n the server, any SSH cnnectin certificates that have trust issues will be autmatically accepted. Therefre, we recmmend using an IP address t cnnect t the server instead f a DNS name that culd be redirected t an unsafe cnnectin. The current versin f the Subversin plugin requires SpiraPlan r SpiraTeam v r later Installing the Subversin Plug-In T install the Subversin Versin Cntrl plug-in, fllw these steps: Cpy the fllwing files int place n yur Web Server s SpiraTeam installatin: Cpy the file SubversinPrvider.dll file int the VersinCntrl sub-flder f the SpiraTeam installatin. If yur server perating system is 64-bit, then cpy all the files in the x64 directry f the dwnladed plug-in zip file int the VersinCntrl sub-flder f the SpiraTeam installatin. Nte: D nt create an x64 flder under VersinCntrl, make sure the files live in the VersinCntrl flder itself. If yur server perating system is 32-bit, then cpy all the files in the x32 directry f the dwnladed plug-in zip file int the VersinCntrl sub-flder f the SpiraTeam installatin. Nte: D nt create an x32 flder under VersinCntrl, make sure the files live in the VersinCntrl flder itself. Lg in as the Administratr and g int SpiraTeam main Administratin page and click n the Versin Cntrl link under System. Click the Add buttn t enter the Plug-in details page. The fields required are as fllws: Name: The name must be SubversinPrvider. Page 2 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

4 Descriptin: The descriptin is fr yur use nly, and des nt affect peratin f the plug-in. Active: If checked, the plug-in is active and able t be used fr any prject. Cnnectin Inf: This field hlds the rt f the repsitry fr any prject accessing the plug-in, unless verridden in the Prject Settings. Start the cnnectin string with svn://, r Lgin / Passwrd: The user id and the passwrd f the user t use while accessing and retrieving infrmatin frm the Subversin server. Custm1: This field is used fr deugging. Please leave it blank unless specified by supprt. Other Fields: The ther fields (Dmain, Custm2 Custm5) are nt used by the plug-in and will be ignred. When finished, click the Insert buttn and yu will be taken back t the Versin Cntrl integratin list page, with SubversinPrvider listed as an available plug-in. Verify that yu are in the crrect prject using the drp-dwn at tp, and click n the Prject Settings link fr the SubversinPrvider. Yu will get a screen listing all the same cnfiguratin settings: Be sure t change the Active field t Yes, r the repsitry will nt be available fr the current prject. Any ther settings entered n this page will verride - and have the same use as - the general settings that yu created abve. Yu wuld use these settings if yu will have mre than ne prject access different cde repsitries. Initial setup is cmplete, click n the Surce Cde menu under the Tracking tab t navigate and brwse the surce cde repsitry Using Subversin with SpiraTeam While being able t brwse the surce cde repsitry can be useful in itself, the real strength cmes frm linking artifacts in SpiraTeam - including Incidents, Requirements, and Tasks - t revisins checked int the sftware repsitry. Page 3 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

5 Viewing the Repsitry Tree View the surce cde tree by selecting the Surce Cde link under the Tracking tab. Yu will get a screen similar t: The flder tree f the repsitry is n the left, and files in the current selected directry will be listed in the right table. Nte that this view will always shw the current (HEAD) revisin f the repsitry. The file view will display the filename, the current revisin number f the file, the authr f the last cmmit, and the date f the last cmmit. Yu can filter and srt n any f the clumns, as well Viewing File Details T view the file details, click n a file in the right-hand side f the repsitry. The file details page displays the details n the selected revisin. By default, it will be the HEAD revisin, unless yu clicked t view the file details frm a revisin. By clicking n the file name, yu can dwnlad the specified revisin f the file t yur lcal machine. This des nt d an SVN checkut; yu are merely dwnlading the file t yur lcal machine. Underneath the file details are tabs that shw a preview f the file (with syntax highlighting), a list f all the revisins that this file belngs in, r was cmmitted t, wh perfrmed the cmmit, and the lg message fr the cmmit, and a tab that shws any artifact assciatins. Thrughut SpiraTeam, revisins are indicated by the icn: Page 4 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

6 Revisin Details By clicking n a revisin in SpiraTeam, yu will be taken t the revisin details page. The revisin details screen shws the lg fr the Cmmit, the cmmit date and authr. At the bttm f the page are tw tabs, Files and Assciatins. The Files tab lists all files that were a part f this cmmit, with their full path and the actin that was perfrmed n them fr this cmmit. Pssible values are Added, Mdified, r Deleted. The Assciatins tab shws any artifact (Incident, Task, Requirement, Test Case, Test Set, etc.) that the lg message references. See sectin fr infrmatin n hw t link a revisin with a Subversin Cmmit: Page 5 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

7 Linking Artifacts Linking an artifact is quite simple. T maintain the readability f Subversin s cmmit messages, we adpted a bracket tken. The tken is in the frmat f: [<artifact identifier>:<artifact id>] The first half, the Artifact Identifier, is a tw-letter cde that is used thrughut SpiraTeam, and is visible n almst every page in the applicatin. Fr example, a requirement s identifier is RQ. Incidents are IN, and test cases are TC. The artifact ID is the number f the artifact. S by creating a cmmit message that reads: Due t requirement #12 [RQ:12], the cde fr.tstring in class XMLparser was mdified. This als fixed Incident #1034 [IN:1034]. SpiraTeam will autmatically detect tkens and will include links t them under the Assciatins tab fr a revisin detail. If yu frget t add the assciatin during the cmmit, yu can use the Add Assciatin ptin within SpiraTeam t add the assciatin after the fact Trubleshting While integratin with Subversin is rather cmplex, as a user yu will nly receive a cuple f errrs that will prevent the integratin frm wrking: SpiraTeam will nt display the lgin page, and there is an errr (either n the page r in the Applicatin Event Lg) that says Culd nt lad file r assembly. Subversin cntrl and library files cme in bth 32-bit and 64-bit ( Win32 r x64 ) versins. If this errr ccurs, it is mst likely that the wrng versin f the files were installed. Dwnlad the crrect versin frm the Inflectra website, and verwrite the files in the VersinCntrl flder. SpiraTeam reprts that the lgin infrmatin is incrrect. In this case, duble check the Versin Cntrl settings, bth fr the Prject (which verrides the general settings) and the general settings. Prject settings will ver-ride the general settings. Be sure t use a user that has access t all ndes in the tree starting frm the rt repsitry lcatin. If yu are taken back t the repsitry screen and given a message saying that the requested file was deleted frm the system, this means that an attempt was made t view details n a file that is n lnger part f the HEAD revisin. This can happen when a file is deleted r renamed, and this is a nrmal cnditin in the cde repsitry, nt necessarily an errr with Subversin r SpiraTeam. Page 6 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

8 3. Integrating with Perfrce 3.1. Installing the Perfrce Plug-In T install the Perfrce Versin Cntrl plug-in, fllw these steps: Cpy the fllwing files t the flder named VersinCntrl in the SpiraTeam installatin flder: Inflectra.Glbal.dll P4API.dll P4DN.dll PerfrcePrvider.dll Lg in as the Administratr and g int SpiraTeam main Administratin page and click n the Versin Cntrl link under System. Click the Add buttn t enter the Plug-in details page. The fields required are as fllws: Name: The name must be PerfrcePrvider. Descriptin: The descriptin is fr yur use nly, and des nt affect peratin f the plug-in. Active: If checked, the plug-in is active and able t be used fr any prject. Cnnectin Inf: This field is the server s DNS r IP with the prt t cnnect t. N dept infrmatin r rt directry is t be specified here. D nt enter in any prtcl, like r ftp://. Page 7 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

9 Lgin / Passwrd: The user id and the passwrd f the user t use while accessing and retrieving infrmatin frm the Subversin server. If either field needs t be blank, enter in annymus. Dmain: Nt used. Custm01: The client name is t be entered here. The plugin will attempt t create the client if it des nt exist. Unless yu have a client pre-defined fr the plugin, we recmmend using the default, PerfrcePrvider. Custm02: The base dept r rt directry must be entered here. Other Fields: The ther custm fields (Custm03 Custm05) are nt used by the plugin and will be ignred. When finished, click the Insert buttn and yu will be taken back t the Versin Cntrl integratin list page, with PerfrcePrvider listed as an available plug-in. Verify that yu are in the crrect prject using the drp-dwn at tp, and click n the Prject Settings link fr the PerfrcePrvider. Yu will get a screen listing all the same cnfiguratin settings: Be sure t change the Active field t Yes, r the repsitry will nt be available fr the current prject. Any ther settings entered n this page will verride - and have the same use as - the general settings that yu created abve. Yu wuld use these settings if yu will have mre than ne prject access different cde repsitries. Initial setup is cmplete, click n the Surce Cde menu under the Tracking tab t navigate and brwse the surce cde repsitry Using Perfrce with SpiraTeam While being able t brwse the surce cde repsitry can be useful in itself, the real strength cmes frm linking artifacts in SpiraTeam - including Incidents, Requirements, and Tasks - t revisins checked int the sftware repsitry Viewing the Repsitry Tree View the surce cde tree by selecting the Surce Cde link under the Tracking tab. Yu will get a screen similar t: Page 8 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

10 The flder tree f the repsitry is n the left, and files in the current selected directry will be listed in the right table. Nte that this view will always shw the current (HEAD) changelist f the dept. The file view will display the filename, the current change number f the file, the authr f the last change, and the date f the last change. Yu can filter and srt n any f the clumns, as well Viewing File Details T view the file details, click n a file in the right-hand side f the screen. The file details page displays the details n the selected file. By default, it will be the HEAD change, unless yu clicked t view the file details frm a change. By clicking n the file name, yu can dwnlad the specified change versin f the file t yur lcal machine. This des nt pen the file n the dept; yu are merely dwnlading the file t yur lcal machine. Underneath the file s details is a list f all the changes that this file was changed in, wh perfrmed the change, and the lg message fr the change. Thrughut SpiraTeam, changes are indicated by the icn Change Details By clicking n a change in SpiraTeam, yu will be taken t the changelist details page: Page 9 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

11 The revisin details screen shws the lg fr the change, the change date and authr. At the bttm f the page are tw tabs, Files and Assciatins. The Files tab lists all files that were a part f this change, with their full path and the actin that was perfrmed n them fr this change. Pssible values are Added, Mdified, Deleted, r Other. The Assciatins tab shws any artifact (Incident, Requirement, Test Case, Test Set) that the lg message references. See sectin fr infrmatin n hw t link a revisin with a Perfrce change: Linking Artifacts Linking an artifact is quite simple. T maintain the readability f Subversin s change messages, we adpted a bracket tken. The tken is in the frmat f: [<artifact identifier>:<artifact id>] The first half, the Artifact Identifier, is a tw-letter cde that is used thrughut SpiraTeam, and is visible n almst every page in the applicatin. Fr example, a requirement s identifier is RQ. Incidents are IN, and test cases are TC. The artifact ID is the number f the artifact. S by creating a change message that reads: Due t requirement #12 [RQ:12], the cde fr.tstring in class XMLparser was mdified. This als fixed Incident #1034 [IN:1034]. SpiraTeam will autmatically detect tkens and will include links t them under the Assciatins tab fr a revisin detail. Page 10 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

12 3.3. Trubleshting While integratin with Perfrce is rather cmplex, as a user yu will nly receive a cuple f errrs that will prevent the integratin frm wrking: SpiraTeam will nt display the lgin page, and there is an errr (either n the page r in the Applicatin Event Lg) that says Culd nt lad file r assembly. This simply means that nt all f the required DLL libraries (listed abve in 3.1) are present in the \VersinCntrl directry inside f the installatin. It culd als mean that the IIS Applicatin Pl is nt set t allw 32-bit applicatins. (At this time, there are n 64-bit DLLs available fr the Perfrce Prvider.) SpiraTeam reprts that the lgin infrmatin is incrrect. In this case, duble check the Versin Cntrl settings, bth fr the Prject (which verrides the general settings) and the general settings. Prject settings will ver-ride the general settings. Be sure t use a user that has access t all ndes in the tree starting frm the rt repsitry lcatin. If yu are taken back t the repsitry screen and given a message saying that the requested file was deleted frm the system, this means that an attempt was made t view details n a file that is n lnger part f the HEAD revisin. This can happen when a file is deleted r renamed, and this is a nrmal cnditin in the cde repsitry, nt necessarily an errr with Subversin r SpiraTeam. Any ther errrs abut nt being able t lad the versin cntrl prvider will have the errr messages lgged in the web server s (that hsts SpiraTeam) Applicatin Event Lg. When cntacting supprt, be sure t have the event lgs ready. Page 11 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

13 4. Integrating with CVS The Cncurrent Versins System (CVS) is a Sftware Cnfiguratin Management (SCM) system that enables users t wrk n cde simultaneusly while preserving previus versins by aviding cllisins in cde edits. This plug-in will allw users f SpiraPlan r SpiraTeam (hereafter referred t as SpiraTeam) t be able t brwse a CVS repsitry and view revisins linked t SpiraTeam artifacts. The plug-in will dwnlad a wrking-cpy f the CVS repsitry nt the SpiraTeam server and use that fr displaying the list f files/flders. The list f revisins will be queries dynamically frm the CVS repsitry n an as-needed basis. The rest f this sectin utlines hw t install and use the plug-in with SpiraTeam. Nte: The plug-in will allw users t dwnlad and view different revisins f files and view revisin lgs, but n changes t the repsitry are allwed thrugh the plug-in Installing the CVS Plug-In T install the CVS Versin Cntrl plug-in, fllw these steps: Cpy the fllwing files frm the plug-in zip-archive int the VersinCntrl sub-flder f the SpiraTeam installatin: CvsPrvider.dll DcsVisin.Remting.dll ICSharpCde.SharpCvsLib.dll ICSharpCde.SharpZipLib.dll lg4net.dll Lg in as the Administratr and g int SpiraTeam main Administratin page and click n the Versin Cntrl link under System. Click the Add buttn t enter the Plug-in details page. The fields required are as fllws: Name: The name must be CvsPrvider. Descriptin: The descriptin is fr yur use nly, and des nt affect peratin f the plug-in. Page 12 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

14 Active: If checked, the plug-in is active and able t be used fr any prject. Cnnectin Inf: This field hlds the rt f the repsitry fr any prject accessing the plug-in, unless verridden in the Prject Settings. Please use the fllwing frmat: <cvs repsitry url>:/cvsrt/<repsitry path> Fr example: sharpcvslib.cvs.surcefrge.net:/cvsrt/sharpcvslib Lgin / Passwrd: The user id and the passwrd f the user t use while accessing and retrieving infrmatin frm the CVS server. If yu are accessing a public repsitry annymusly, just use annymus fr bth username and passwrd and it will be handled crrectly. Custm 01 This must cntain the name f the cnnectin prtcl being used t access the CVS server. The fllwing prtcls are supprted: pserver - the first access prtcl accrding t the client-server scheme, the mst simple and the fastest ne. Its imperfectin - it transfers all the data unsecured. If yu need t secure cdes and user passwrds, d nt use this prtcl in public nets. ext r ssh - access prtcl using SSH (Secure Shell). It is used fr accessing UNIX servers and it supprts all data encdings. sspi - access prtcl fr Windws server with data encding supprt. Custm 02 This must cntain the name f the mdule yu wish t access in the CVS repsitry. When finished, click the Insert buttn and yu will be taken back t the Versin Cntrl integratin list page, with CvsPrvider listed as an available plug-in. Verify that yu are in the crrect prject using the drp-dwn at tp, and click n the Prject Settings link fr the CvsPrvider. Yu will get a screen listing all the same cnfiguratin settings: Be sure t change the Active field t Yes, r the repsitry will nt be available fr the current prject. Any ther settings entered n this page will verride - and have the same use as - the general settings that yu created abve. Yu wuld use these settings if yu will have mre than ne prject access different cde repsitries. Page 13 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

15 Initial setup is cmplete, click n the Surce Cde menu under the Tracking tab t navigate and brwse the surce cde repsitry Using CVS with SpiraTeam While being able t brwse the surce cde repsitry can be useful in itself, the real strength cmes frm linking artifacts in SpiraTeam - including Incidents, Requirements, and Tasks - t revisins checked int the sftware repsitry Viewing the Repsitry Tree View the surce cde tree by selecting the Surce Cde link under the Tracking tab. Yu will get a screen similar t: The flder tree f the repsitry is n the left, and files in the current selected directry will be listed in the right table. Nte that this view will always shw the current (HEAD) revisin f the repsitry. The file view will display the filename, the current revisin number f the file and the date f the last cmmit. Yu can filter and srt n any f the clumns, as well Viewing File Details T view the file details, click n a file in the right-hand side f the repsitry. The file details page displays the details n the selected revisin. By default, it will be the HEAD revisin, unless yu clicked t view the file details frm a revisin. By clicking n the file name, yu can dwnlad the specified revisin f the file t yur lcal machine. This des nt d an CVS checkut; yu are merely dwnlading the file t yur lcal machine. Page 14 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

16 Underneath the file details is a list f all the revisins that this file belngs in, r was cmmitted t, wh perfrmed the cmmit, and the lg message fr the cmmit. Thrughut SpiraTeam, revisins are indicated by the icn Revisin Details By clicking n a revisin in SpiraTeam, yu will be taken t the revisin details page. The revisin details screen shws the lg fr the Cmmit, the cmmit date and authr. At the bttm f the page are tw tabs, Files and Assciatins. The Files tab lists all files that were a part f this cmmit, with their full path, size, latest revisin and date f edit. The Assciatins tab shws any artifact (Incident, Requirement, Test Case, Test Set) that the lg message references. See sectin fr infrmatin n hw t link a revisin with a CVS Cmmit: Page 15 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

17 Linking Artifacts Linking an artifact is quite simple. T maintain the readability f CVS cmmit messages, we adpted a square bracket tken. The tken is in the frmat f: [<artifact identifier>:<artifact id>] The first half, the Artifact Identifier, is a tw-letter cde that is used thrughut SpiraTeam, and is visible n almst every page in the applicatin. Fr example, a requirement s identifier is RQ. Incidents are IN, and test cases are TC. The artifact ID is the number f the artifact. S by creating a cmmit message that reads: Due t requirement #12 [RQ:12], the cde fr.tstring in class XMLparser was mdified. This als fixed Incident #1034 [IN:1034]. SpiraTeam will autmatically detect tkens and will include links t them under the Assciatins tab fr a revisin detail Trubleshting While integratin with CVS is rather cmplex, as a user yu will nly receive a cuple f errrs that will prevent the integratin frm wrking: When yu first lad the list f flders and files fr a repsitry it may take several minutes t lad as it s dwnlading the entire repsitry frm the CVS server t the SpiraTeam server. This delay will nt ccur n subsequent views f the page. SpiraTeam will nt display the lgin page, and there is an errr (either n the page r in the Applicatin Event Lg) that says Culd nt lad file r assembly.. If this errr ccurs, it is mst likely that the CvsPrvider.dll r sme f its dependent assemblies were nt crrectly placed in the VersinCntrl flder f the SpiraTeam installatin. SpiraTeam reprts that the lgin infrmatin is incrrect. In this case, duble check the Versin Cntrl settings, bth fr the Prject (which verrides the general settings) and the general settings. Prject settings will ver-ride the general settings. Be sure t use a user that has access t all ndes in the tree starting frm the rt repsitry lcatin. If yu are taken back t the repsitry screen and given a message saying that the requested file was deleted frm the system, this means that an attempt was made t view details n a file that is n lnger part f the HEAD revisin. This can happen when a file is deleted r renamed, and this is a nrmal cnditin in the cde repsitry, nt necessarily an errr with CVS r SpiraTeam Data Purging Since the integratin with CVS requires that a wrking cpy f the CVS repsitry be stred n the SpiraTeam server, yu may decide at sme pint t unlink a disused CVS repsitry frm SpiraTeam t save disk-space. Hwever unlinking the repsitry thrugh the SpiraTeam web interface will nt remve the wrking cpy f the repsitry frm the server. T permanently remve a repsitry frm the SpiraTeam server, yu need t lcate the fllwing path: (Windws XP, 2003) - C:\Dcuments and Settings\All Users\Applicatin Data (Windws 2008, 7, Vista) C:\PrgramData Page 16 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

18 If yu lk inside this flder, yu will see a subflder called Inflectra, and under that will be a subflder called CvsPrvider. If yu pen up this subflder, yu will see a list f all the CVS mdules that have been accessed thrugh SpiraTeam. T purge a mdule, just select it and chse the Delete Flder ptin in Windws. Page 17 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

19 5. Integrating with VSS Visual SurceSafe (VSS) frm Micrsft is a Sftware Cnfiguratin Management (SCM) system that enables users t wrk n cde simultaneusly while preserving previus versins by aviding cllisins in cde edits. This plug-in will allw users f SpiraPlan r SpiraTeam (hereafter referred t as SpiraTeam) t be able t brwse a VSS database and view revisins linked t SpiraTeam artifacts. While users wrking n the cde will usually have a cmplete cpy f the repsitry n their lcal systems, this plug-in will access the VSS database remtely.the rest f this sectin utlines hw t install and use the plug-in with SpiraTeam. Nte: The plug-in will allw users t dwnlad and view different revisins f files and view revisin lgs, but n changes t the repsitry are allwed thrugh the plug-in Installing the VSS Plug-In T install the VSS Versin Cntrl plug-in, fllw these steps: Install a cpy f Visual SurceSafe n the same server that is running SpiraTeam (if it is already installed n the server, yu can disregard this step). Cpy the fllwing files frm the plug-in zip-archive int the VersinCntrl sub-flder f the SpiraTeam installatin: VssPrvider.dll SurceSafe.Interp.dll Lg in as the Administratr and g int SpiraTeam main Administratin page and click n the Versin Cntrl link under System. Click the Add buttn t enter the Plug-in details page. The fields required are as fllws: Name: The name must be VssPrvider. Descriptin: The descriptin is fr yur use nly, and des nt affect peratin f the plug-in. Page 18 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

20 Active: If checked, the plug-in is active and able t be used fr any prject. Cnnectin Inf: This field pints t the filepath where the srcsafe.ini file is lcated (which cntains the VSS database infrmatin). Fr example: C:\VssDatabases\Prject1\srcsafe.ini Lgin / Passwrd: The user id and the passwrd f the user t use while accessing and retrieving infrmatin frm the VSS database. If the repsitry desn t require a passwrd, just use annymus as the passwrd. Dmain: is nt used by the VSS plug-in and can be ignred Custm01 05: are nt used by the VSS plug-in and can be ignred When finished, click the Insert buttn and yu will be taken back t the Versin Cntrl integratin list page, with VssPrvider listed as an available plug-in. Verify that yu are in the crrect prject using the drp-dwn at tp, and click n the Prject Settings link fr the VssPrvider. Yu will get a screen listing all the same cnfiguratin settings: Be sure t change the Active field t Yes, r the repsitry will nt be available fr the current prject. Any ther settings entered n this page will verride - and have the same use as - the general settings that yu created abve. Yu wuld use these settings if yu will have mre than ne prject access different cde repsitries. Initial setup is cmplete, click n the Surce Cde menu under the Tracking tab t navigate and brwse the surce cde database Using VSS with SpiraTeam While being able t brwse the surce cde repsitry can be useful in itself, the real strength cmes frm linking artifacts in SpiraTeam - including Incidents, Requirements, and Tasks - t revisins checked int the VSS database Viewing the Repsitry Tree View the surce cde tree by selecting the Surce Cde link under the Tracking tab. Yu will get a screen similar t: Page 19 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

21 The flder tree f the repsitry is n the left, and files in the current selected directry will be listed in the right table. Nte that this view will always shw the mst recent revisin f the database. The file view will display the filename, the current revisin number f the file and the date f the last check-in. Yu can filter and srt n any f the clumns, as well Viewing File Details T view the file details, click n a file in the right-hand side f the repsitry. The file details page displays the details n the selected revisin. By default, it will be the mst recent revisin, unless yu clicked t view the file details frm a revisin. By clicking n the file name, yu can dwnlad the specified revisin f the file t yur lcal machine. This des nt d a VSS checkut; yu are merely dwnlading the file t yur lcal machine. Underneath the file details is a list f all the revisins made t this file, wh perfrmed the revisin, and the lg message fr the actin perfrmed. Thrughut SpiraTeam, revisins are indicated by the icn Revisin Details By clicking n a revisin in SpiraTeam, yu will be taken t the revisin details page. Page 20 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

22 The revisin details screen shws the lg fr the actin perfrmed, the date and authr. At the bttm f the page are tw tabs, Files and Assciatins. The Files tab lists all files that were a part f this revisin, with their full path, latest revisin and date f edit. The Assciatins tab shws any artifact (Incident, Requirement, Test Case, Test Set) that the lg message references. See sectin fr infrmatin n hw t link a revisin with a VSS check-in r ther actin: Linking Artifacts Linking an artifact is quite simple. T maintain the readability f VSS check-in messages, we adpted a square bracket tken. The tken is in the frmat f: [<artifact identifier>:<artifact id>] The first half, the Artifact Identifier, is a tw-letter cde that is used thrughut SpiraTeam, and is visible n almst every page in the applicatin. Fr example, a requirement s identifier is RQ. Incidents are IN, and test cases are TC. The artifact ID is the number f the artifact. S by creating a cmmit message that reads: Due t requirement #12 [RQ:12], the cde fr.tstring in class XMLparser was mdified. This als fixed Incident #1034 [IN:1034]. SpiraTeam will autmatically detect tkens and will include links t them under the Assciatins tab fr a revisin detail Trubleshting While integratin with VSS is rather cmplex behind the scenes, as a user yu will nly receive a cuple f errrs that will prevent the integratin frm wrking: SpiraTeam will nt display the lgin page, and there is an errr (either n the page r in the Applicatin Event Lg) that says Culd nt lad file r assembly.. If this errr ccurs, it is Page 21 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

23 mst likely that the VssPrvider.dll r sme f its dependent assemblies were nt crrectly placed in the VersinCntrl flder f the SpiraTeam installatin. SpiraTeam reprts that the lgin infrmatin is incrrect. In this case, duble check the Versin Cntrl settings, bth fr the Prject (which verrides the general settings) and the general settings. Prject settings will ver-ride the general settings. Be sure t use a user that has access t all ndes in the tree starting frm the rt repsitry lcatin. If yu are taken back t the repsitry screen and given a message saying that the requested file was deleted frm the system, this means that an attempt was made t view details n a file that was deleted r destryed in VSS. This is a nrmal cnditin in the cde repsitry, nt necessarily an errr with VSS r SpiraTeam. If yu have the VSS database lcated n a remte file-share n a separate server t SpiraTeam, yu will need t mdify the identify used by the IIS Applicatin Pl running SpiraTeam. By default the IIS Applicatin Pl will run as the special Windws user NETWORK SERVICE. Whilst this is a secure accunt with lw privileges fr nrmal use f the system, it may nt have sufficient permissins t access the VSS repsitry ver yur Lcal Area Netwrk (LAN). We recmmend changing the IIS Applicatin Pl t instead run as a Windws Dmain user that has permissins t access the remte file-share cntaining the VSS database. Page 22 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

24 6. Integrating with TFS Micrsft Visual Studi Team System (VSTS) Team Fundatin Server (TFS) frm Micrsft (hereafter referred t as TFS) is a Sftware Cnfiguratin Management (SCM) system that enables users t wrk n cde simultaneusly while preserving previus versins by aviding cllisins in cde edits. This plug-in will allw users f SpiraPlan r SpiraTeam (hereafter referred t as SpiraTeam) t be able t brwse a TFS repsitry and view revisins linked t SpiraTeam artifacts. There are separate plug-ins fr TFS 2005/2008, 2010 and When cnnecting t a TFS 2010/2012+ repsitry, the cnnectin URL will als need t be in a different frmat (see belw). While users wrking n the cde will usually have a cmplete cpy f the repsitry n their lcal systems, this plug-in will access the TFS repsitry remtely. The rest f this sectin utlines hw t install and use the plug-in with SpiraTeam. Nte: The plug-in will allw users t dwnlad and view different revisins f files and view revisin lgs, but n changes t the repsitry are allwed thrugh the plug-in Installing the TFS Plug-In T install the TFS Versin Cntrl plug-in, fllw these steps: Dwnlad the apprpriate TFS prvider frm the Inflectra website ( there are separate versins fr TFS 2005/2008, 2010 and TFS 2012 r later. Cpy the fllwing files frm the plug-in zip-archive int the VersinCntrl sub-flder f the SpiraTeam installatin: Micrsft.TeamFundatin.Client.dll Micrsft.TeamFundatin.Cmmn.dll Micrsft.TeamFundatin.Cmmn.Library.dll Micrsft.TeamFundatin.dll Micrsft.TeamFundatin.VersinCntrl.Client.dll Micrsft.TeamFundatin.VersinCntrl.Cmmn.dll Micrsft.TeamFundatin.VersinCntrl.Cmmn.Integratin.dll TfsPrvider.dll Lg in as the Administratr and g int SpiraTeam main Administratin page and click n the Versin Cntrl link under System. Page 23 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

25 Click the Add buttn t enter the Plug-in details page. The fields required are as fllws: Name: The name must be TfsPrvider. Descriptin: The descriptin is fr yur use nly, and des nt affect peratin f the plug-in. Active: If checked, the plug-in is active and able t be used fr any prject. Cnnectin Inf: This field pints t the URL used fr accessing the Team Fundatin Server. Typically TFS runs n website prt 8080, but yu may need t check with yur IT administratr t verify. The exact cnnectin URL will depend n yur versin f TFS: Fr TFS 2005 / 2008: Fr TFS Where prjectcllectin is the name f the prject cllectin yu will be cnnecting t Fr TFS 2012 r later Where prjectcllectin is the name f the prject cllectin yu will be cnnecting t Lgin / Passwrd: The user id and the passwrd f the user t use while accessing and retrieving infrmatin frm the TFS repsitry. If the repsitry desn t require a username/passwrd, just use annymus as bth the username and passwrd. Dmain: This is the Windws Dmain that the TFS server is a member f. If the machine is nt part f a dmain, yu shuld just use the TFS server name instead. If yu are cnnecting t a hsted Visual Studi Online (VSO) repsitry, yu shuld leave the Dmain blank. Custm01 05: are nt used by the TFS plug-in and can be ignred Page 24 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

26 When finished, click the Insert buttn and yu will be taken back t the Versin Cntrl integratin list page, with TfsPrvider listed as an available plug-in. Verify that yu are in the crrect prject using the drp-dwn at tp, and click n the Prject Settings link fr the TfsPrvider. Yu will get a screen listing all the same cnfiguratin settings: Be sure t change the Active field t Yes, r the repsitry will nt be available fr the current prject. Custm 01: This shuld cntain the name f the equivalent team prject in TFS. Custm 02 05: are nt used by the TFS plug-in and can be ignred Any ther settings entered n this page will verride - and have the same use as - the general settings that yu created abve. Yu wuld use these settings if yu will have mre than ne prject access different cde repsitries. Initial setup is cmplete, click n the Surce Cde menu under the Tracking tab t navigate and brwse the surce cde repsitry Using TFS with SpiraTeam Whilst being able t brwse the surce cde repsitry can be useful in itself, the real strength cmes frm linking artifacts in SpiraTeam - including Incidents, Requirements, and Tasks - t revisins checked int the TFS repsitry Viewing the Repsitry Tree View the surce cde tree by selecting the Surce Cde link under the Tracking tab. Yu will get a screen similar t: Page 25 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

27 The flder tree f the repsitry is n the left, and files in the current selected directry will be listed in the right table. Nte that this view will always shw the mst recent revisin f the database. The file view will display the filename, the current revisin number f the file and the date f the last check-in. Yu can filter and srt n any f the clumns, as well. The page will display the flders and files fr the currently selected branch (in the example abve Main ), yu can change the current branch at any time by selecting it frm the drpdwn menu: Viewing File Details T view the file details, click n a file in the right-hand side f the repsitry. The file details page displays the details n the selected revisin. By default, it will be the mst recent revisin, unless yu clicked t view the file details frm a revisin. By clicking n the file name, yu can dwnlad the specified revisin f the file t yur lcal machine. This des nt d a TFS checkut; yu are merely dwnlading the file t yur lcal machine. Underneath the file details is a preview f the cntents f the surce cde file (with syntax clring t make it easier t read). Page 26 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

28 In additin, there are tw ther tabs that display the list f all the revisins made t this file and any assciatins with ther SpiraTeam artifacts: The revisin list will display the name f the revisin, wh perfrmed the revisin, and the lg message fr the actin perfrmed. Thrughut SpiraTeam, revisins are indicated by the icn. The assciatin list will display the list f SpiraTeam artifacts that are linked t this specific surce cde file. Yu can add a new assciatin by clicking n the Add Assciatin hyperlink Revisin Details By clicking n a revisin in SpiraTeam, yu will be taken t the revisin details page. The revisin details screen shws the lg fr the actin perfrmed, the date and authr. At the bttm f the page are tw tabs, Files and Assciatins. The Files tab lists all files that were a part f this revisin, with their full path, latest revisin and date f edit. The Assciatins tab shws any artifact (Incident, Requirement, Test Case, Test Set) that the lg message references. See sectin fr infrmatin n hw t link a revisin with a TFS check-in r ther actin: Page 27 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

29 Linking Artifacts Linking an artifact is quite simple. T maintain the readability f TFS check-in messages, we adpted a square bracket tken. The tken is in the frmat f: [<artifact identifier>:<artifact id>] The first half, the Artifact Identifier, is a tw-letter cde that is used thrughut SpiraTeam, and is visible n almst every page in the applicatin. Fr example, a requirement s identifier is RQ. Incidents are IN, and test cases are TC. The artifact ID is the number f the artifact. S by creating a cmmit message that reads: Due t requirement #12 [RQ:12], the cde fr.tstring in class XMLparser was mdified. This als fixed Incident #1034 [IN:1034]. SpiraTeam will autmatically detect tkens and will include links t them under the Assciatins tab fr a revisin detail. If yu frget t add the assciatin during the cmmit, yu can use the Add Assciatin ptin within SpiraTeam t add the assciatin after the fact Trubleshting While integratin with TFS is rather sphisticated behind the scenes, as a user yu will nly receive a cuple f errrs that will prevent the integratin frm wrking: SpiraTeam will nt display the lgin page, and there is an errr (either n the page r in the Applicatin Event Lg) that says Culd nt lad file r assembly.. If this errr ccurs, it is mst likely that the TfsPrvider.dll r sme f its dependent assemblies were nt crrectly placed in the VersinCntrl flder f the SpiraTeam installatin. SpiraTeam reprts that the lgin infrmatin is incrrect. In this case, duble check the Versin Cntrl settings, bth fr the Prject (which verrides the general settings) and the general settings. Prject settings will ver-ride the general settings. Be sure t use a user that has access t all ndes in the tree starting frm the rt repsitry lcatin. If yu are taken back t the repsitry screen and given a message saying that the requested file was deleted frm the system, this means that an attempt was made t view details n a file that was deleted in TFS. This is a nrmal cnditin in the cde repsitry, nt necessarily an errr with TFS r SpiraTeam Enfrcing Assciatins with a Custm Plicy As described in sectin abve, yu can easily assciate check-ins f cde in TFS with relevant SpiraTeam artifacts by adding the apprpriate artifact identifier in the cmmit messages. In rder t enfrce this prcess, ne f ur custmers has written a custm Visual Studi 2008 and 2010/2012+ Team System check-in plicy that will frce users t enter at least ne SpiraTeam artifact in each f the check-in cmments. This plicy will als check the IDs f the supplied artifacts t make sure they exist in the apprpriate SpiraTeam installatin. T install the custm check-in plicy, yu shuld dwnlad the SpiraPlicySetup.msi (fr 2008) r SpiraPlicy.vsix (fr 2010+) installatin package frm the Add-Ons/Dwnlads sectin f the Inflectra website ( and run the installatin package n each wrkstatin that has Visual Studi installed. Once this installatin has been cmpleted, yu need t tell Visual Studi t add the custm check-in plicy: Page 28 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

30 1. Inside Visual Studi, g t Team > Team Prject Settings > Surce Cntrl t pen up the Surce Cde extensins dialg bx: 2. Click n the Check-in Plicy tab t list the varius check-in plicies: 3. Click n the [Add ] buttn t add a new check-in plicy: Page 29 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

31 4. Select the SpiraTeam/Plan TFS check-in Plicy and click [OK]. This will bring up the SpiraTeam custm plicy cnfiguratin dialg bx: 5. Enter the URL fr the SpiraTeam server (yu nly need the server name and virtual directry prtin) as well as a valid lgin and passwrd. Then click [Cnnect] t get the list f prjects. 6. Select the checkbxes fr which artifact types yu want t be included in the artifact enfrcement and click the [OK] buttn t cnfirm the settings. 7. Nw when a user checks-in a change t the TFS surce cde repsitry, they will be required t enter at least ne SpiraTeam artifact, and the system will check t make sure that artifact actually exists in the specified prject. Page 30 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

32 7. Integrating with Mercurial Mercurial is a Distributed Versin Cntrl System (DVCS) system that keeps track f sftware revisins and allws many develpers t wrk n a given prject withut necessarily being cnnected t a cmmn netwrk since it desn t rely n a central repsitry, but instead distributes cpies f the entire surce cde repsitry t each user s wrkstatin. The SpiraTeam plug-in fr Mercurial allws users f SpiraPlan r SpiraTeam (hereafter referred t as SpiraTeam) t be able t brwse a Mercurial repsitry and view revisins linked t SpiraTeam artifacts. The plug-in will dwnlad a read-nly wrking-cpy f the Mercurial repsitry nt the SpiraTeam server and use that fr displaying the list f files/flders. The list f revisins will be queried dynamically frm this lcal repsitry n an as-needed basis. The plug-in als perfrms pull requests frm the specified remte repsitry t ensure that the lcal repsitry remains up t date. The rest f this sectin utlines hw t install and use the plug-in with SpiraTeam. Nte: The plug-in will allw users t dwnlad and view different revisins f files and view revisin lgs, but n changes t the repsitry are allwed thrugh the plug-in Installing the Mercurial Plug-In T install the Mercurial Versin Cntrl plug-in, fllw these steps: Cpy the fllwing files frm the plug-in zip-archive int the VersinCntrl sub-flder f the SpiraTeam installatin: MercurialPrvider.dll Mercurial.Net.dll Lg in as the Administratr and g int SpiraTeam main Administratin page and click n the Versin Cntrl link under System. Click the Add buttn t enter the Plug-in details page. The fields required are as fllws: Name: The name must be MercurialPrvider. Descriptin: The descriptin is fr yur use nly, and des nt affect peratin f the plug-in. Page 31 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

33 Active: If checked, the plug-in is active and able t be used fr any prject. Cnnectin Inf: This field hlds the clne URL f the repsitry fr any prject accessing the plug-in, unless verridden in the Prject Settings: Fr example: ssh://example.cm/hg/ Lgin / Passwrd: The user id and the passwrd f the user t use while accessing and retrieving infrmatin frm the remte Mercurial repsitry. If yu are accessing a public repsitry annymusly, just use annymus fr bth username and passwrd and it will be handled crrectly. Custm 01 This needs t cntain the path n the SpiraTeam server where the Mercurial executable (Hg.exe) can be fund. If left blank, it will attempt t autmatically discver Mercurial frm the Windws %PATH% envirnment variable. Custm 02 Custm 05 Nt used by this plugin. When finished, click the Insert buttn and yu will be taken back t the Versin Cntrl integratin list page, with MercurialPrvider listed as an available plug-in. Verify that yu are in the crrect prject using the drp-dwn at tp, and click n the Prject Settings link fr the MercurialPrvider. Yu will get a screen listing all the same cnfiguratin settings: Be sure t change the Active field t Yes, r the repsitry will nt be available fr the current prject. Any ther settings entered n this page will verride - and have the same use as - the general settings that yu created abve. Yu wuld use these settings if yu will have mre than ne prject access different cde repsitries. Initial setup is cmplete, click n the Surce Cde menu under the Tracking tab t navigate and brwse the surce cde repsitry. Page 32 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin

34 7.2. Using Mercurial with SpiraTeam While being able t brwse the surce cde repsitry can be useful in itself, the real strength cmes frm linking artifacts in SpiraTeam - including Incidents, Requirements, and Tasks - t revisins checked int the sftware repsitry Viewing the Repsitry Tree View the surce cde tree by selecting the Surce Cde link under the Tracking tab. Yu will get a screen similar t: The flder tree f the repsitry is n the left, and files in the current selected directry will be listed in the right table. Nte that this view will always shw the current (TIP) branch f the repsitry. The file view will display the filename, the current revisin number f the file and the date f the last cmmit. Yu can filter and srt n any f the clumns, as well Viewing File Details T view the file details, click n a file in the right-hand side f the repsitry. The file details page displays the details n the selected revisin. By default, it will be the TIP branch, unless yu clicked t view the file details frm a revisin. By clicking n the file name, yu can dwnlad the specified revisin f the file t yur lcal machine. This des nt d a Mercurial clne r pull; yu are merely dwnlading the file t yur lcal machine. Page 33 f 3 Cpyright , Inflectra Crpratin This dcument cntains Inflectra prprietary infrmatin