Installation & Configuration Manual: Testlink 1.6
Installation & Configuration Manual: Testlink 1.6
TestLink 1.6
Copyright 2004,2005,2006 TestLink Development Team Permission is granted to copy, distri !te and"or modi#y this doc!ment !nder the terms o# the $%& 'ree Doc!mentation License, (ersion )*2 or any later version p! lished y the 'ree +o#t,are 'o!ndation- ,ith no .nvariant +ections, no 'ront/ Cover Te0ts, and no 1ack/Cover Te0ts* The license is availa le in 2$%& 'ree Doc!mentation License2 homepage*
1 Scope
This doc!ment only serves as a re#erence doc!ment #or the installation and con#ig!ration o# TestLink* The #irst part incl!des the installation proced!re and second part the con#ig!ration e0planation* The c!rrent and other doc!mentation is availa le on TestLink homepage* 3o! can also ask a help to solve yo!r pro lems in an appropriate section o# TestLink #or!m* +!mmary o# installation process4 )* Tran#er #iles 2* &ncompress #iles 5* $enerate data ase ta les 4* Trans#er data or create de#a!lt data 5* 6dit con#ig!ration #ile 6* P7P 'ile e0tensions 8* Login
2 System Requirements
TestLink re9!ires these applications as ackgro!nd4
:y+;L 4*)*0 and higher <4*0*0 co!ld e !sed !t doesnt s!pport &T'/=> php 4*5*0 and higher <php5 is not s!pported !t sho!ld ,ork as ,ell> ?e server <@pache )*5*0 or 2*0*0 and higher, ..+ 5 and higher, etc*> +ee <php_root>/install.txt #or more in#ormation*
There is no re9!irement a o!t yo!r operating system <tested on Lin!0 and :+ ?in52>* 3o! can !se also :y+;L on di##erent server than TestLink*
3 Pre-installation steps
Do the ne0t steps e#ore installation4 )* .nstall environment4 Webserver, php4 and MySQL* Ae#er to doc!mentation o# these prod!cts* 3o! can also #ind installations package o# all these prod!cts and install it together* 6*g* B@:PP, 6asyP7P, &ni#orm +erver, etc* 2* Trans#er the TestLink installation #ile to yo!r ,e server !sing ,hatever method yo! like est <#tp, scp, etc*>* 3o! ,ill need to telnet"ssh into the server machine #or the ne0t steps* 5* %e0t, !ntar"g!nCip it to the directory that yo! ,ant* The !s!al command is <) step>4 # tar zxvf <filename.tar.gz> or # gunzip <filename.tar.gz> # tar xvf <filename.tar> ?inCip, +t!##it, and other programs sho!ld also e a le to handle decompression o# the archive* @t this point yo! may ,ant to rename the directory to something simpler like DtestlinkD* 3o! ,ill !se the mv command to rename a directory <?indo,s !sers s! stit!te the 2ren2 command or !se e0plorer>* # mv <directory_name> testlink 4* Contin!e .nstallation or &pgrade*
4 Installation
3o! can !se a!tomatic scripted installation or man!al steps* .# yo! are !pgrading #rom a previo!s version o# TestLink look at the &pgrading section*
4.1
The #ollo,ing details the asic steps #or installation on any system* The instr!ctions may seem !ni0/centric !t sho!ld ,ork #ine on ?indo,s systems* 1arring complications, it sho!ld take yo! a o!t )0/50 min!tes to install, con#ig!re, and e !sing TestLink* This installation process has changed ,ith release )*6* %e0t ,e ,ill create the necessary data ase ta les and a asic con#ig!ration #ile* )* 'rom yo!r ,e ro,ser access http://<yoursite>/testlink/install/index.php* 2* This page ,ill ,alk thro!gh the #ollo,ing steps4
check asic parameters #or the ,e server, php con#ig and D1 version* prompt #or the data ase type and location, and a data ase !ser"pass,ord pair* 'or installation, an administrative !ser"pass,ord pair can also e provided* The operating !ser re9!ires @LT6A, +6L6CT, .%+6AT, and &PD@T6 privileges* 'or installation, .%D6B, CA6@T6, D6L6T6, and DAEP privileges are also re9!ired* create the data ase and ta les* Warnin : @ D6'@< @D:.%.+TA@TEA level acco!nt is created* The acco!nt name and pass,ord are4 ad!in / ad!in* &se this ,hen yo! #irst login to TestLink* .mmediately go to :anage and create at least one administrator level acco!nt* .mmediately a#ter that D.+@1L6 or D6L6T6 the admin acco!nt* 3o! can recreate it !t yo! sho!ld delete the acco!nt to prevent the cookieFstring #rom eing !sed to trick the
package* .t ,o!ld e even etter to rename the acco!nt or delete it permanently* A6:6:16A4 @#ter setting !p the package, A6:E(6 the de#a!lt admin acco!nt
5* @#ter a s!ccess#!l !pgrade yo! sho!ld remove the <testlinkwebdir>/install/ directory #or sec!rity reasons* 4* The ne0t part involves con#ig!ring the installation to ,ork ,ith yo!r speci#ic set!p* +ee con#ig!ration section #or description o# con#ig!ra le parameter*
4.1.1 M $! % Installation
.# yo! ,ant to per#orm a :an!al installation <not re"o!ended> here are the steps needed #or a s!ccess#!l installation* 'or installing the D1 yo! can either choose the command line tools availa le in yo!r :y+;L installation or any :y+;L Data ase Client <e*g* php:y@dmin>*
#or :y+;L GH 4*) <,ith &T'=> do #$%&'% (&'&)&S% testlink #*&$&#'%$ S%' ut+, #-LL&'% ut+,. eneral."i 1y choosing &T'= yo! sho!ld also change the val!e o# D1F+&PPEAT+F&T'= to TA&6 in yo!r <testlinkdir>/config.inc.php +ee Con#ig!ration #or more*
Create ta les #or the ne,ly created data ase*
# mys l !u <user> !p<password> <dbname> < <testlinkdir>/install/s l/testlink_create_tables.s l ".g. # mys l !u testlink !ppass testlink < /var/www/html/testlink/install/s l/testlink_create_tables.s l
Pop!late initial data #or the ne,ly created data ase <admin acco!nt, de#a!lt
data ase*
+elect the created data ase in the le#t pane* %avigate to +;L ,indo,* &pload +;L re9!est #rom #iles /install/s l/testlink_create_tables.s l and
Create a ItestlinkdirG"con#igFd *inc*php #ile ,ith the #ollo,ing data <e0ample>4 <#php // $utomatically %enerated by &est'ink (nstaller define)*+,_&-."*/ *mys l*01 define)*+,_23"4*/ *tl_56*01 define)*+,_.$33*/ *tl_56*01 define)*+,_783&*/ *localhost*01 define)*+,_9$:"*/ *tl_56*01 #> <Eptional> Create a D1 !ser #or connection #rom TestLink* DonDt #orget to assign a correct rights <at least +6L6CT, .%+6AT, &PD@T6, D6L6T6> #or the created data ase* The !ser m!st e de#ined in con#igFd *inc*php* Ether,ise yo! can !se any other !ser
En Lin!0 or &%.B yo! m!st change the permissions o# the templates_c directory to e ,rita le y the ,e server* 'rom the TestLink root directory r!n / "h!od 000 ui/te!plates." Log into TestLinkJ De#a!lt credentials are4 !ser4 admin- pass4 admin Changing this pass,ord is a good sec!rity practice* TestLink noti#ies i# yo! donDt do it* @#ter a s!ccess#!l !pgrade yo! sho!ld remove the <testlinkwebdir>/install/ directory #or sec!rity reasons* The ne0t part involves con#ig!ring the installation to ,ork ,ith yo!r speci#ic set!p* +ee con#ig!ration section #or description o# con#ig!ra le parameter* Aeport any iss!es or #eed ack to TestLink 1!g tracking system page*
4.2 !gra&ing
:aKor version !pgrade4 3o! can !pgrade either a!tomatically <via script> or man!ally* There is a #e, changes in data ase against oth TL )*5 and )*0*4* .*e* yo! are not a le to !se directly yo!r original data ase* :inor version <maintenance> !pgrade is man!al, !t easy*
+ave #iles o# the previo!s version* Aemove the all #iles #rom directory* Copy a ne, version to the same directory* Copy con#igFd #ile to the ne, str!ct!re and modi#y con#ig!ration parameters acording yo!r previo!s settings* %o,, it sho!ld ,ork*
4.2.2
Choose D&pgrade .nstallationD link* A!n the scripts !ntil yo! see that process is #inished* @#ter a s!ccess#!l !pgrade yo! sho!ld remove the <testlinkwebdir>/install/ directory #or sec!rity reasons* The ne0t part involves con#ig!ring the installation to ,ork ,ith yo!r speci#ic set!p* +ee con#ig!ration section #or description o# con#ig!ra le parameter* Aeport any iss!es or #eed ack to TestLink 1!g tracking system page*
installation script*
re9!irements / list o# re9!irements itsel# re9Fcoverage / store relation et,een A6; and TC re9!irementFdoc / organiCe re9!irements
'irst make a ack!p o# yo!r c!rrent data ase !sing the mys9ld!mp !tility* # /usr/bin/mys ldump !u root testlink5> !p > testlink5>.backup %o, edit testlink)5* ack!p so schema de#initions #or 6@C7 ta le has !t#= encoding speci#ied* Change the C7@A+6T #or each ta le #rom latin) to !t#=* 'or e0ample the #ollo,ing line in the de#inition o# ) ta le ,hich reads as #ollo,s 4 "9%(9"=:y(3$: +"?$2'& CHARSET=latin1 @8::"9&=*&his table holds the bugs filed for each result*1 sho!ld e changed to "9%(9"=:y(3$: +"?$2'& CHARSET=utf8 @8::"9&=*&his table holds the bugs filed for each result*1
Then ran testlink)5* ack!p thr! my the perl script elo, as #ollo,s4 /replace3cript.pl < testlink5>.backup > testlink5>.cleaned replace3cript.pl is as follows ; #A/usr/bin/perl
Created an empty testlink)6 d ,ith !t#= charset as #ollo,s4 @4"$&" +$&$,$3" testlink56 @7$4$@&"4 3"& utfI1 .nstall the ta les into the ne, data ase # mys l testlink56 !u root !p < testlink5>.cleaned 3o! can veri#y yo!r data aseDs #ollo,ing command4 login to mys l use testlink56 mys l> Cs !!!!!!!!!!!!!! mys l Jer 5F.E +istrib @onnection id; @urrent database; @urrent user; 33'; @urrent pager; 2sing outfile; 2sing delimiter; 3erver version; .rotocol version; @onnection; 3erver characterset; +b characterset; @lient characterset; @onn. characterset; 29(N socket; 2ptime; 2D characterset2 is no, set to !t#= y !sing the
F.5.55/ for redhat!linux!gnu )iKI60 L6 testlink5> bugzMlocalhost 9ot in use stdout ** 1 F.5.55 5D 'ocalhost via 29(N socket latin5 utfI latin5 latin5 /var/lib/mys l/mys l.sock K6 min >> sec
Ether reso!rces4 ,hat the heck is &T'/= L http4"",,,*Koelonso#t,are*com"articles"&nicode*html octal ta le <yo! can see octal val!es 000 / )88 are 2normal ascii2 characters>* The perl script that is provided searches ased on octal val!es* http4"",e *cs*m!n*ca"Mmichael"c"ascii/ta le*html description o# tr perl operation http4"",,,*!ni0*org*!a"orelly"perl"learn"ch)5F05*htm
/ Configuration
/.1 Configuration -iles
@ll con#ig!ration parameters are inside the #ile con#ig*inc*php and incl!ded #iles* 'or this
release <)*6> these are the con#ig!ration #iles4 <testlink installation directory>/config.inc.php <testlink installation directory>/config_db.inc.php <testlink installation directory>/cfg/<bug_tracking_system>.cfg.php "on+i .in".php :ain con#ig!ration #ile* +ee elo, #or more* "on+i .db.in".php Contains con#ig!ration parameters to access the data ase* This #ile is created y the installer d!ring the installation or !pgrade process* %ormally yo! donDt need to change it man!ally* /"+ /bu 1illa."+ .php /"+ /!antis."+ .php /"+ /2ira."+ .php Contains con#ig!ration parameters to access !gCilla, mantis or Kira iss!e tracking system* 3o! need to edit this #ile is yo! ,ant to access iss!e in#ormation #rom testlink < !gtracking system integration #eat!re>* To ena le this #eat!re yo! need to change a con#ig!ration paramenter on the main con#ig!ration #ile <con#ig*inc*php>
().S344-$'S.3'5, +et this to '@L+6 #or :y+;L/(ersions prior to 4*) <no !t#= s!pport>, so all pages have charset .+E/==5N/) and data ,ill e stored ,ith charset latin) into the d * 'or :y+;L/ (ersions GH 4*) set it to TA&6 to ena le #!ll &T'/= s!pport in pages and also data ,ill e stored ,ith charset !t#= into the d *
'L.L-6.L%7%L.(%5&3L' +et this to the de#a!lt level o# logging <%E%6, 6AAEA, .%'E, D61&$>* %ote that TestLink doesnDt veri#y a siCe o# a created #ile* .*e* &se D61&$ level only #or development or !g investigation*
'L.L-6.4&'* The #ilename and path #or the log#ile o# TestLink* 6*g* "tmp"testlink*log M&89.4&6%.M%'$8#S.%9&)L%( This parameter controls ,hether the metrics ta le is displayed on the main page* @ccepts DTA&6D or D'@L+6D val!es*
'L.89'%$5&#%.)36S This parameter sets the inter#ace to a !gtracker system* Possi le val!es are D%ED, D1&$O.LL@D, D:@%T.+D, DP.A@D <TestLink GH )*6> 'or !gCilla con#ig!ration see also the #ile cfg/bugzilla.cfg.php* +!pported version4 0*)N*) 'or mantis con#ig!ration see also the #ile cfg/mantis.cfg.php* +!pported version4 )*0*0*a5 'or P.A@ con#ig!ration see also the #ile cfg/Oira.cfg.php* +!pported version4 P.A@ 5*)*)
'L.'$%%.:89(
This parameter also is !sed to con#ig!re tree men! Component !sed in TestLink* Possi le val!es are DL@36A+:6%&D, DDTA66D, DPTA66D* L@36A+:6%& is de#a!lt val!e* This Component PTA66 has the est per#ormance* The t,o others have the a ility to remem er the last position in addition*
'L.8M4-$'.L8M8' :a0im!m !pload#ile siCe in ytes* De#a!lt is 200000* 3o! co!ld increase this val!e i# yo! import a igger #ile* There is also parameter TLF.:PEATFAE?F:@B #or ma0imal siCe o# one line o# e0ported #ile* The val!e )0000 characters sho!ld e eno!gh*
; .+"keditor.toolbar #ckeditor Tool ar de#inition* 3o! can modi#y #ckeditor tool ar content* +ee #ckeditor homepage #or more in#ormation a o!t this Component*
'L.'4L.#*&$S%' #hinese users only4 +et4 define)*&'_&.'_@7$43"&*/ *gbLK5L*01 This de#ines a correct html charset* @ll other lang!ages co!ld leave this option !nchanged*
'L.(%5&3L'.L-#&L% +et this to yo!r de#a!lt locale, this m!st e one o# QgFlocales <de#ined in the same con#ig>* De#a!lt val!e is enF$1*
'L.#-M4&9<, 'L.(-#.#-4<$86*', 'L.(-#.#-958(%9' +trings are !sed in #ront o# printed doc!ment <re9!irements speci#ication only in )*6 version>* Le#t lank i# not !sed*
/.4 Customi0ation
/.4.1 Casca&ing Style S+eet
3o! can change TestLink appearance ,riting yo! o,n C++ <Cascading +tyle +heet> #iles* 3o! have to change the #ollo,ing constants4 define)*&'_'8%(9_@33*/*gui/css/tl_login.css*01 ! $ll 'ogin/'ogout pages @33 define)*&'_&"3&'(9P_@33*/*gui/css/testlink.css*01 ! :ain @33 define)*&'_+8@_,$3(@_@33*/*gui/css/tl_doc_basic.css*01 ! 2sed in 4eports .mportant4 paths to C++ are relative to the Itestlink installation directoryG .# yo! ,ant to !se yo!r o,n C++ #iles ,e s!ggest yo! to proceed as #ollo,4 )* create a ne, directory inside the g!i directory, e0ample g!i"css"my_css/ 2* copy the testlink original #iles to the ne, directory <yo! can change the names i# yo! ,ant> 5* modi#y them at yo!r ,ill 4* edit con#ig*inc*php // 8riginal configuration //define)*&'_'8%(9_@33*/*gui/css/tl_login.css*01 //define)*&'_&"3&'(9P_@33*/*gui/css/testlink.css*01 //define)*&'_+8@_,$3(@_@33*/*gui/css/tl_doc_basic.css*01 define)*&'_'8%(9_@33*/*gui/css/my_css/tl_login_ac ua.css*01 define)*&'_&"3&'(9P_@33*/*gui/css/my_css/testlink_ac ua.css*01 define)*&'_+8@_,$3(@_@33*/*gui/css/my_css/tl_doc_basic.css*01
*allow_repeat* 4 allo, the name to e repeated < ack,ard compati ility ,ith version )*0*4 and )*5*0> *generate_new* 4 generate a ne, name !sing the val!e o# QgFpre#i0FnameF#orFcopy and the original o Kect name* *block* 4 ret!rn ,ith an error *
%ame to give to the Component created4 <g_re _cfg!>default_component_name=G@omponent @reated by 4e uirement ! $utoG1
%ame to give to the Category created4 QgFre9Fc#g/Gde#a!ltFcategoryFnameH2TEDE2CategoryDs E Kective description4 QgFre9Fc#g/Go KectiveF#orFcategoryH2Category"Test Cases generated #rom Ae9!irements2-
'or the Category name yo! can con#ig!re the #ollo,ing options4
This allo,s yo! to create templates ,ith di##erent names that the original Testlink, ,itho!t the risk to over,rite them, d!ring the ne0t !pgrade* .mportant4 %ot all TestLink pages are ready #or this kind o# con#ig!ration* The standard con#ig!ration4 <g_tplR*tcJiew*S = GtcJiew.tplG1 <g_tplR*tc3earchJiew*S = Gtc3earchJiew.tplG1 <g_tplR*tc"dit*S = Gtc"dit.tplG1 <g_tplR*tc9ew*S = Gtc9ew.tplG1 <g_tplR*exec3et4esults*S = Gexec3et4esults.tplG1
3 - 9
There are listed o#ten pro lems* Please, check also TestLink #or!m*
. !pgraded #rom older version and . cannot login* 3o!r original data ase sho!ld e in di##erent charset* The de#a!lt #rom )*6 version is &T'/=* Try to s,itch D1F+&PPEAT+F&T'= to '@L+6 in con#ig*inc*php*
+marty error is sho,n instead o# login page* Lin!0"!ni0 !sers4 (eri#y i# correct permissions are #or temp directory <de#a!lt4 <testlink_root>/gui/template_c/>*
Aevision 7istory4 / (es"ription (ate 2005"05")2 2005"04")2 2005"06"28 2005"0N")2 2005"0N")5 &uthor @* :orsing :* 7avlat @* :orsing '* :ancardi :* 7avlat )*0 .nitial creation o# the doc!ment in DocB:L )*) Corrected title, !pdated str!ct!re and added ne, sections* )*2 @dded some ,ords #or :y+;L 4*), &T'= s!pport )*5 &pdated a!tomatic installation part )*4 &pdated #or TL )*6*- added con#ig!ration parametersrestr!ct!red <created pre/installation steps section>corrected layo!t- added php:y@dmin steps description 2*0 Converted to EE2 #ormat- added D1 Charset !pdate e0planation #rom Tevin 2*) Corrected layo!t #or e0port to 7T:L and PD' 2*2 +ome small changes 2*5 :inor layo!t and grammar !pdate