TestLink - User Manual
Contents
1. HM 4 2 2 Server side iiis dpenddscrisbnre c exDRdS e dpRd Ra Se cU NT URN RIE VIR E EUR M V NRCA CRURA ERE 4 2 2 1 psoft SQL server doesn t support UTF 8 ssssssseeseee nennen nnn 5 3 Ilfistallationsz i genes veracecivasavecaravaeuk teas Saba E eases sees DADOS RN NEE DES Fa UM UEM NEUES FEIN 7 3 1 Pre installatiori Steps s iiise eet xem Rede Van p a a c QR ev DA EE ENT nde eon 7 3 2 AUTOMATIC Installation ceseeseeseeeeeeeenn nnne nnnm nennen nennen nnn nn nn 7 3 3 MANUAL Installation cece tere nennen nennen mee enne nnne nnn nnn nn 8 3 4 Database Troubleshooting iiec renta eee ean ex Peau dene a a ERR DR X ERR RE E nad 10 3 5 Post installation steps esseesseseeeeeee nnne r neas a sna nnn nnn 11 3 5 1 Configure TestLink z aiii den ner can kkH E penu ga Du x Fea FRE EX RERR ENEE LEE TR ERAI ECREXED DE aad 11 3 5 2 Back Up TestLink installation eesseeseeeeen mnm mmn nn 11 3 5 3 Database back up ssesseeseeseeiee se hne hne hehehe anna sua ses aa sena sss sena nnn 11 3ibs4d Securibysssrssosse eti ERR a edt Yin viens vince vitae Yam xn vacat Yam inde ed NUEVE E UU NI XN REA 12 sse TIL ETE 14 4 1 1 Code upgrade only ssssssssseesseseeee enema enhn nn 14 4 1 2 Automatic upgrading with DB schema Chang s ecceeeeeee ee eee eee eeeeeeeeeae es 14 4 1 3 Manual upgrading eessen ttu drm a Xn on2. 50 Appendix B Set up Mantis bug tracking system integration B I Overview The integration between TestLink and a Bug Tracking System BTS has the following characteristics All communication between Test Link and the BTS is done through database tables except Trac TestLink at the time of this writing is neither able to send data to the BTS either able to receive data from the BTS in the traditional model of function call After all the configuration is up and running from a TestLink user point of view the process will be 1 While executing a test it fails 2 User saves execution result 3 User clicks on link that opens BTS web page used for issue reporting 4 After issue reporting user has to take note of issue ID assigned by BTS to input it into TestLink 5 User returns to TestLink test execution page and writes the issue ID in the bug input 6 After user saves the execution TestLink will display data taken from the BTS database B II Mantis DB Configuration Edit file your TestLink main directory gt cfg mantis cfg php Environment example TestLink and Mantis installed on the same web server Test Link URL http calypso testlink MySQL user password to access Mantis mantis bt user mantis bt password DB Anonymous login into mantis has to be turned on A mantis user with viewer rights to all public projects must be created anonymous account Change add following lines in your
3. upload folder home gat web testlink upload area filenamel backup folder testlink db mydate bck sql filename2 Sbackup folder testlink upload mydate bck tgz 11 dump data mysqldump uroot pyour password testlink 17 gt filenamel compress gzip f9 Sfilenamel backup attachments tar cvzf filename2 Supload_ folder save to backuped area on server titan mount titan export gat home gat backup titan o soft nosuid rw noauto user noexec cp Sfilename gz home gat backup titan The script create two compressed files with date in file name There is also commented possibility to mount another server and copy back up files to another server Now you have a script that can do back up You need to set up system to run it every day Linux Unix offers cron service to do it There is example of settings root execute the script as user gat europa crontab 1 DO NOT EDIT THIS FILE edit the master and reinstall tmp crontab 20829 installed on Fri Aug 6 11 56 56 2004 Wr ere uwc ealou c mole Teron abre Ww adis NOM 0L dh Oe Oly Sim ueiloxaHe usse 1 15 2 su gat c home gat backup db backup sh gt dev null 2 amp 1 Do not postpone back up to never 3 5 4 Security Is it safe to use TestLink over the Internet I mean if I put critical requirements cases in TestLink and access it without VPN from my home what are the chances that data will remain secure We impl
4. ENABLED Refreshing of Test specification navigator ENABLED gt every time user do an editing operation on test specification tree is updated DISABLED gt tree will not be updated user can update it manually g spec cfg automatic tree refresh ENABLED Allow to edit an executed version of Test case ENABLED gt user can edit executed Test case versions DISABLED gt editing of executed Test case versions is blocked DEFAULT VALUE tlCfg gt testcase cfg can edit executed DISABLED User can remove an executed version of test case at least one Test result exists from a Test plan Feature is ENABLED by default and could be DISABLED tlCfg testcase cfg can remove executed ENABLED 5 9 1 Test specification templates User can define the initial content of three text objects of a new Test case summary steps and expected results Each object configuration includes type and value The next types are possible e none template will not be used default will be a empty text area DEFAULT VALUE e string value of value member is assigned to FCK object string id gt value member is used in a lang get call and return value is assigned to FCK object Configure string id on custom strings txt ffile value member is used as file name The file is read and it s contents assigned to a text area component as input 299 g testcase
5. IIS v6 integration of windows MS added another group IIS WPG This group is responsible for web processes To get a successful installation I had to give full rights to both the group and the account This allowed the web application to install and also solitified the fact that it is in deed a permissions error and not an issue with TL But of course I could not leave a group and an account with full access unneededly So I began removing permissions until I received and error Having both accounts with only R W E permissions allowed the application to load but everytime I would move to a new page of the TL web application I would receive the smarty error To fix this issue I had to give the IIS WPG account R W E M permissions This fixed the errors and they system is now running fine I found a MS KB article that describes this account in more detail and I will be reviewing it to make sure I have not left any security holes with this permission setup 49 Appendix A Recommended configuration parameters There is a list of parameters that users modify in the most of cases g smtp host g tl admin email g from email g return path email g interface bugs tlCfg document generator company name tlCfg document generator company copyright tlCfg document generator confidential msg tlCfg company logo tlCfg fckeditor default toolbar g default language tlCfg api enabled
6. SS Not in use Current pager stdout Using outfile s Using delimiter B Server version DECIES IE Protocol version 10 Connection Localhost via UNIX socket Server character set Laie aia DB character set utf8 Client character set latinl Conn character set latinl UNIX socket var lib mysql mysql sock Uptime 36 min 55 sec e Run the upgrade installation provided by TestLink 1 6 Other resources what the heck is UTF 8 http www joelonsoftware com articles Unicode html octal table you can see octal values 000 177 are normal ASCII characters The perl script that is provided searches based on octal values http web cs mun ca michael c ascii table html description of tr Perl operation http www unix org ua orelly perl learn ch15 05 htm 18 5 Configuration This chapter describes the most important configuration parameters Additional information are together with parameters definition in configuration files Localization and API configuration are described in extra chapters below Note TestLink 1 8 introduced a new class tICfg to hold overall configuration Not all parameters are migrated yet 5 1 Configuration Files overview All configuration parameters are inside the file config inc php and included files For this release these are the configuration files 5 1 1 config inc php Main configuration file and wrapper for other configuration files The file lists defau
7. Test project prefix a separator defined below and a number related to a parent Test Suite Define the separator 44 Note The value cannot be empty 45 T TestLink API SOAP API is disabled by default for security reason Set then next parameter to TRUE if you would like to use it tlCfg api enabled FALSE e Format of showing the personal API identification within GUI View pages Slt Sejoi_ ic Eo rmmeit ips e js 46 8 FAQ Please also check the TestLink forum Smarty error or blank screen is shown instead of login page Smarty include C NInetpubWwwwrootNtestlinkNguiNtemplates cNN 6A 6A5 6A537DD8 10gin tpl php function Smarty include failed to open Stream No such file or directory in C Inetpub wwwroot testlink third party smarty Smarty class php on line 1247 Linux unix users Verify if write permissions are for temp directory default testlink root gt gui template c Fix by command chmod atw testlink root gui template c IIS users Give the iis user write access to the template c directory See below it will not helps Does TestLink support Secured HTTPS connection Yes it s settings of your web server lang api php Error is shown instead of login page ities qwexw 21 erro edbsusiue xesxasessaseesaceew IDS Wetcall Eiemo ies Call ito undefined function iconv in home ga site lib functions lang api php on line 54 Note to Windows Users In order
8. UTF8 support 2005 06 27 A Morsing 1 3 Updated automatic installation part 2005 09 12 F Mancardi 1 4 Updated for TL 1 6 added configuration parameters 2005 09 13 M Havlat restructured created pre installation steps section corrected layout added phpMyAdmin steps description 2 0 Converted to OO2 format added DB Charset update 2005 12 04 M Havlat explanation from Kevin 2 1 Corrected layout for export to HTML and PDF 2005 12 11 M Havlat 2 2 Some small changes 2005 12 17 A Morsing 2 3 Minor layout and grammar update 2006 02 14 M Havlat 2 4 Updated for TL 1 7 2006 11 17 M Havl t 2 5 Updated for TL 1 7 restructured merged BTS case layout 2007 09 13 M Havl t update prepare for 1 7 0 release 2 6 Added several new parameters for 1 7 updated styles 2008 01 02 M Havl t configuration divided into logical chapters 2 7 Fixed 0001347 0001284 0001331 2008 02 02 M Havl t New sections Add a new type of Test results on execution page drafted by Francisco Define HTML text editor 2 8 Updated for TL 1 8 include all new and missing features and 2008 06 06 M Havl t refactorization of configuration files 2 9 Language correction 2008 07 04 W Pollans 2 10 Layout update minor changes 2008 07 07 M Havl t 2 11 Update configuration to 1 8 RC3 01 15 09 M Havl t 2 12 Update configuration to 1 8 RC5 1 8 0 03 15 09 M Havl t 53 Description Date Author 2 13 Updated chapter Upgra
9. default The character set value is used for both data database and GUI Smarty templates We strongly recommend using Unicode character set UTF 8 ISO 8859 1 and other char sets can be configured for backward compatibility StlCfg gt charset UTF 8 MySQL Versions prior to 4 1 have not utf 8 support You can export data and convert exported file into Unicode for database upgrade Note that MySQL 5 is required to migration 1 6 gt 1 7 process MySQL see manual http dev mysql com doc refman 5 0 en charset connection html Character set of Bug tracking system uses the same value if you do not overwrite it via optional constant MySQL only Otherwise are used default values of BTS database deume SU CEN EA CKD Bm HAYS Hill MEETS 6 1 3 GUI special characters Separation characters used to surround some texts in the user interface for example user role StlCfg gt gui gt role separator open tlCfg 2gui role separator close Title separators are used when composing a title using several strings The first one is used preferably for logic relation object name for example Test Plan MyTestLink 1 0 The second separator is used to separate parent child tlCfg 2gui title separator 1 amp g tlCfg 2gui title separator 2 eg Each Test case has a unique identification number You can set up and use external ID as identifier instead of it The external ID is composed from a
10. do not recognize UTF 8 as valid character data This article discusses some options for dealing with this situation This limitation is valid for versions 2000 2005 There could be options e Use a better database engine e Use UCS 2 instead of UTF 8 Configure TL and convert strings texts e Use FreeTDS driver http www freetds org or ODBTP Use the ADO layer libraries and make database SQL changes as in the FreeTDS solution Now there is one new ADOdb driver It s called mssgql n and extends the standard mssql one just to intercept all the queries sent to DB in order to prepend all the SQL literals found with the N that guaranties that UCS 2 data will be handled properly by MSSQL Use ODBTP or FreeTDS with Unicode UTF8 lt gt UCS2 conversion enabled the new mssql n ADOdb driver Wait for PHP6 PHP6 is supposed to have better handling for internationalization 4 PHP 5 0 or 5 1 is possible to use if you disable js ext component in configuration json function is used Installation via yum http www jasonlitka com 2007 06 01 upgrading to php 523 on rhel and centos 5 See http www libgd org FAQ PHP for more 6 http support microsoft com kb 232580 3 Installation You can use automatic scripted installation or manual steps If you are upgrading from a previous version of TestLink look at the Upgrading section 3 1 Pre installation steps Do the next steps before installation 1 Insta
11. gt SnumRows Row SnumRows 1 2 s 2 Returned hl display the results while row mssql fetch array result 10 sang Vaia a STONA ERSE BURG 5 U l close the connection mssql close dbhandle Bo 3 5 Post installation steps 3 5 1 Configure TestLink There is amount of settings that helps to tool for your case There is configuration section in this document In addition we recommend to read config inc php and cfg const inc php You find commented parameters here 3 5 2 Back up TestLink installation It s useful to have the last working configuration in extra back up Minimal list contains custom config inc php config db inc php and configuration for connection to you bug tracker if any You should make some modification and patches We suggest to backup all the directory after any change then 3 5 3 Database back up Important save your time spend a half of hour today with arranging a simple script than boring days later There are two things to back up daily database and attachments You could use sophisticated tool to store back up files store to back up files to another server or use raid to suppress a storage failure Create a script that collect data from database and attachment folder An example for Linux environment follows bin sh Script for backup TestLink service create filenames mydate date ysm d backup folder home gat backup
12. mantis config inc php replace dummy with the anonymous account you will use 51 7 ehomywioms Login Allow anonymous login g allow anonymous login ON g anonymous account dummy B III Enable BTS integration Check the following lines from config inc php ff PSPS SRS SSS SSS SS SSS e M SS SS SS SRS SSS SSS SSS SSS SSS SSS Bug Tracking systems TestLink uses bug tracking systems to check if displayed bugs resolved verified and closed bugs If they are it will strike through them ZENO no bug tracking system integration BUGZILLA g edit configuration in TL ABS PATH cfg bugzilla cfg php MANTIS edit configuration in TL ABS PATH cfg mantis cfg php A g interface bugs NO Copy it to custom config inc php and change line Gig ahipexeiexcie bugs NO p Final result g interface bugs MANTIS B IV Check interface After your configuration is OK you will find the icon to add bugs in the execute screen Several checks are done when you try to add the bug Bug ID is present on BTS Bug ID format is valid a BD Appendix C Revision History Description Date Author 1 0 Initial creation of the document in DocXML 2005 03 12 A Morsing 1 1 Corrected title updated structure and added new sections 2005 04 12 M Havlat 1 2 Added some words for MySQL 4 1
13. out is limited by both php ini and this parameter Lower value is applied Some administrators could shorten the session time specifically for TestLink for security reason without affect other applications The problem is that the value in php ini is not always controllable to you if installation in a hosted environment or safe mode restrictions or php is shared with other applications and because the timeout is coupled with probabilities see gc probability and gc divisor it s not always predictable if the session will be cleaned up StlCfg gt sessionInactivityTimeout 60 5 12 4 Title duplicity of Test Projects Test Suites and Test Cases It is possible to create one of these objects Test Projects Test Suites and Test Cases doing a copy of an existing one The following checks will be done 1 Test Project name is unique 2 Test Suite Name inside Test Project is unique 3 Test Case Name inside Test Suite is unique Note Name of a Keyword a requirements document a Test Plan and Requirements eux identifier must be unique within Test Project You can configure how to proceed when the copy is done The options are generate new generate a new name using the value of g prefix name for copy and the original object name The prefix include timestamp by default block return with an error allow repeat allow the name to be repeated backward compatibility with version 1 0 4 and 1 5 x Example of form
14. template gt summary gt type string g testcase template gt summary gt value lt p gt Objective TBD lt p gt lt p gt Precondition N A lt p gt g testcase template gt steps gt type none g testcase template steps value g testcase template gt expected results gt type none g testcase template gt expected results gt value User can define the initial content of a new Test Suite description similar way g testsuite template gt details gt type file g testsuite template gt details gt value D w3 tl head_20080103 logs tsuite txt Note wrong value for type results in no data assigned to Web Editor object 5 10 Attachments Attachment feature could be enabled TRUE disabled FALSE g attachments enabled TRUE The type of the repository can be database or file system TL REPOSITORY TYPE DB gt database TL REPOSITORY TYPE FS gt filesystem g repositoryType TL REPOSITORY TYPE FS TL REPOSITORY TYPE FS where the filesystem repository should be located g repositoryPath TL ABS PATH upload area DS Security We recommend to change the directory for security reason Compression used within the repository TL REPOSITORY COMPRESSIONTYPE NONE gt no compression TL REPOSITORY COMPRESSIONTYPE GZIP gt gzip compression g repositoryCompressionType TL REPOSITORY COMPRESSIONTYPE NONE The maximum allowed fil
15. to enable this module on a Windows environment you need to put a DLL file named iconv dll or iconv 1 3 dll prior to 4 2 1 which is bundled with the PHP Win32 binary package into a directory specified by the PATH environment variable or one of the system directories of your Windows installation This module is part of PHP as of PHP 5 thus iconv dll and php iconv dll is not needed any more How to upload images into text See 5 7 3 Text area editor or http www teamst org index php option com_content amp task view amp id 43 amp Itemid 2 Allocated memory problem You can receive similar error notice Fatal error Allowed memory size of 8388608 bytes exhausted tried to allocate 1328642 bytes uy oe You can enhance the memory limit in php ini Value 64 MB is reasonable We are aware that PHP is not sufficient environment for difficult application there are bad memory releasing So we refactorize continuously code for this reason I upgraded from old TestLink version and I cannot login Your original database could be in different charset The default from 1 6 version is UTF 8 Try to switch DB SUPPORTS UTFS to FALSE in config inc php I cannot use functionality export XML a test case and open a file attachment word or excel Check session save path variable in php ini You need to put some directory with file write permission for example session save path c php5 This is in case you are using windo
16. using to a plain text in all places tlCfg 2gui text editor all array type gt none FCKeditor Toolbar definition allows disables icons in text area menu We recommend to investigate it The default testlink toolbar definition is tl default The customizable toolbar tl default is defined in testlink root cfg tl fckeditor config js file You can modify the content of toolbar as well as other configuration parameters for example templates styles spell checker etc See fckeditor homepage for more information about the component ToolbarSet Parameter configFile is also only applicable for type fckeditor See http docs fckeditor net for more information about CustomConfigurationsPath For example the next attributes could be defined by this parameter height the height in px for FCKEditor e width the width in px for FCKEditor cols the number of cols for tinymce and none e rows the number of rows for tinymce and none Hint After doing configuration changes clean you Browser s cookies and cache You could modify used editor toolbar or configuration for particular pages You can not define new areas without making changes to php code tlCfg gui text editor execution array type gt none BETTER 28 Performance with a lot of testcases This configuration is useful only if default type is set to fckeditor StlCfg g
17. ABLED gt nothing happens to execute a test case you need to click on test case DEFAULT VALUE StlCfg gt exec cfg show testsuite contents DISABLED TBD applicable for which tree menu component Allow to edit execution notes on old executions Attention user must have test case execution right ENABLED gt user can edit execution notes on old executions Attention user must have test case execution right DISABLED gt no edit allowed DEFAULT VALUE 232 tlCfg exec cfg edit notes DISABLED Filter Test cases a user with tester role can VIEW depending on test execution assignment all gt all test cases assigned to me test cases assigned to logged user DEFAULT VALUE assigned to me or free gt test cases assigned to logged user or not assigned SELCiG SsxSe Cig cete vim elem al assigned tO me y Filter Test cases a user with tester role can EXECUTE depending on test execution assignment all gt all test cases assigned to me test cases assigned to the current user DEFAULT VALUE assigned to me or free gt test cases assigned to logged user or not assigned tlCfg exec cfg exec mode tester assigned to me User filter in Test Execution navigator logged_user gt combo will be set to the current user none no filter applied by default DEFAULT VALUE tlCfg exec cfg user filter default none Filtering TC by a prio
18. ESC gt Descending last execution on top DEFAULT VALUE StlCfg gt exec cfg history order DESC Define if whole execution history for the chosen build will be shown in execution window TRUE gt the whole execution history for the build will be shown FALSE gt just last execution will be shown DEFAULT VALUE 234 tlCfg gt exec cfg history on FALSE Allow to show a results also for previous builds TRUE test case VERY LAST i e in any build execution status will be displayed FALSE only last result on current build DEFAULT VALUE tlCfg exec cfg 5show last exec any build FALSE Allow displaying of all builds execution history TRUE History for all builds will be shown FALSE Only history of the current build will be shown DEFAULT VALUE StlOfg exec cfg show history all builds FALSE 5 8 2 Test execution navigator Show test cases and test case counters coloured according to test case status ENABLED coloured test status DEFAULT VALUE DISABLED disable tlCfg gt exec cfg enable tree testcases colouring ENABLED tlCfg exec cfg enable tree counters colouring ENABLED Controls what happens in right frame when user clicks on a Test suite on tree menu Disabling this setting can help to avoid performance problems ENABLED gt show all test cases presents on test suite and children test suite old behaviour DIS
19. L Installation If you want to perform a manual installation here are the steps needed for a successful installation Warning We recommend using the automated script as there are some undocumented tweaks You can read the code of installation script if you need to do it manually and have a difficulty The next description is written for MySQL but these actions are applicable with different tools and syntax for other databases as well For installing the DB you can either choose the command line tools available in your MySQL installation or any MySQL Database Client e g phpMyAdmin Prepare MySQL via command line tools o Create a new empty MySQL database for MySQL gt 4 1 with UTF8 do CREATE DATABASE testlink CHARACTER SET utf8 COLLATE utf8 general ci By choosing UTF8 you should also change the value of DB SUPPORTS UTFS8 to TRUE in your testlinkdir config inc php See Configuration for more o Create tables for the newly created database f mysql u user p password lt dbname gt testlinkdir install sql testlink ereate calles sel E g 4 mysql u testlink ppass testlink var www html testlink install sql testlink create tables sql o Populate initial data for the newly created database admin account default roles f mysql u user p password lt dbname gt lt lt testlinkdir gt install sql testlink Create deteault ceca sel Alternatively you can use php
20. MyAdmin o Create new database from main page UTF 8 character set o Optionally create a new user and assign him correct rights for the created database o Select the created database in the left pane o Navigate to SQL window o Upload SQL request from files install sql testlink create tables sql and run the script o Upload SQL request from files install sql testlink create default data sql and run the script Create a lt testlinkdir gt config_db inc php file with the following data example php Automatically Generated by TestLink Installer elexi bave YDS WEY Vmyscd Y p eleme IDE UNES e p Cleitiime IDE PASS teslis pase defines VIDE HOSTY localhost 9 demme DIS INVA ed inveysiieveuie p be Optional Create a DB user for connection from TestLink Don t forget to assign a correct rights at least SELECT INSERT UPDATE DELETE for the created database The user must be defined in config_db inc php Otherwise you can use any other user available in MySQL database with correct rights You must allow write access to directories where TestLink expect to write Change the permissions of the templates c upload area and logs directory to be writeable by the web server Linux UNIX run from the TestLink root directory chmod 777 gui templates c chmod 777 logs chmod 777 upload area IIS users also needs to have allow it in dependence to IIS global c
21. QL 2000 and higher Any other TestLink satisfies SQL standards So you can use any well known database You need to set up related database schema Check directory testlink install sql and modify one of existing scripts Web server Apache 1 3 x or 2 x and higher IIS 3 and higher etc See php root install txt for more information Hint Improve security by using https protocol if your server is accessible from 1 Migration from TestLink 1 6 requires MySQL5 2 Database types MyISAM default and InnoDB are supported 3 ysoft SQL server misses an ability to work with UTF 8 character set We do not recommend to use for multi byte languages See more below 4 internet You need to configure your server not TestLink There is an exception collaboration with your bug tracking system BTS must be accessible without SSL PHP 5 2 and higher optional GD library is required for Charts rendering Bugtracking system optional collaboration Bugzilla 0 19 1 and higher Mantis 1 0 1 and higher JIRA 3 1 1 and higher TrackPlus 3 3 and higher Eventum 2 0 and higher Trac 0 10 and higher Fogbugz 3 1 9 and higher Gforce unknown version Redmine 0 6 3 and higher 2 2 1 psoft SQL server doesn t support UTF 8 Some applications especially those that are Web based must deal with Unicode data that is encoded with the UTF 8 encoding method SQL Server 7 0 and SQL Server 2000 use a different Unicode encoding UCS 2 and
22. UserFilesPath folder exists in the server and has write permission We suggest to modify similar to the examle SComeiaig Usexmileswakin Uiseririles Config UserFilesPath lt TL_HOME gt upload_ area fckeditor upload area Comment line Config UserFilesAbsolutePath Enable the uploader Open file FCKeditor editor filemanager upload php config php 29 SECURITY You must explicitelly enable this uploader SConfig Enabled true Make sure that the given UserFilesPath folder exists in the server and has write permission We suggest to modify similar to the examle SContig Wserkilesrach seeiules Config UserFilesPath lt TL_HOME gt upload_area fckeditor upload area Comment line Config UserFilesAbsolutePath 5 7 4 Javascript Use EXT JS library GUI widgets is default value ENABLED You can disable id DISABLED to slightly improve performance g use ext js library ENABLED Define table sorting library The default value kryogenix org uses Stuart Langridge sortTable Empty string disables table sorting feature g sort table engine kryogenix org 5 7 5 Using Your own Smarty templates GUI definition If You want to test a different solution for the user interface you can develop your own Smarty Templates At the time of this writting we have defined the following configuration array g tpl with the following ent
23. age requirement_doc 1 6 Attachments 1 7 Custom fields 1 7 Test Suites 1 7 Test Case versioning 1 7 SRS tree support 1 8 Test prioritization 1 8 Events logging 1 8 Note See testlink root install sql alter directory to see exact syntax of changes 15 4 2 2 Changed Terminology We continuously clarify terminology to fit testing standards You will experience the next changes Product TL 1 6 gt Test Project Component Category TL 1 6 gt Test Suite Test priority TL 1 5 gt Test urgency TL 1 8 Test priority composes from Importance and Urgency 4 2 3 Obsolete features The next feature was removed from TL 1 8 Personal metrics on main page parameter MAIN PAGE METRICS ENABLED 4 2 4 Test Plan relation to Test Project upgrade from 1 5 and older Starting with version 1 6 when you create a Test Plan it s associated to the current selected Test Project as default TestLink 1 7 automatically offers to assign not associated Test Plans It is not possible to share one Test Plan over more Test projects now Backward compatibility The solution in TL 1 6 tables include field TestProjectID in the Test Plan table Test Plans could be available over all Test projects Products Such Test Plan has TestProjectID value 0 Warning unassigned Test Plans are not officially supported TestLink 1 7 automatically offered to assign not associated Test Plans You can also via DB admini
24. ation i oec ELE A AA ek 23 5 6 1 External LDAP authentication aa a R A E nean nnn 24 5 6 2 Login related configurati M sraroiereig ininig NEE aA TA AEA EA 24 5 7 GUI Customization ie be ey Dn lax 4Ixk ea Ya iX RIXA I4 AR 4a CER AR ARR a NN AENEA ah 25 57i Pree MeNU Rm 25 Bi tees GUL LAVOE en e tr A A E A 26 5 7 3 Text area editor ue EID Ea a Aa Der N TER AR aE a RAAN 28 NAMEN Ies E 30 5 7 5 Using Your own Smarty templates GUI definition cessere 30 5 8 dTest execution settrgs oet eer TE eeepc en e m ete eva Geet ANN 31 5 8 1 Execution Ni Story siio casey dad ce xe erre rre x exu sexe exo exu rauca a 31 5 8 2 Test execution navigator eicere iiy rere nx IRR RR REX aa ER RIORIY UE CREARE Ta a EE ies 32 5 8 3 Add a new type of Test results on execution page seen nn 33 5 925 Test Specificato N 4 ede dece xe ck dese lect ingedes vise de sden deduce EITE E EEEE DE RER 36 5 9 1 Test specification templates eessessesseeseeen nnnm nnns 37 SiO Attachments cete eiecit eka el vobis Pew ea ea vr gl er ce EDEN 38 5 11 R quirements SUDDOEt ope o eyes vuv yeu Sa daw eae vb dy gece Re Yu yeesse dyes Be Tagore sa guy ks y rada 39 5 11 1 Generated Test Cases from Requirements sseseeeeeneen nnns 40 5 12 Configuration of misc functionality essssssssssssssssssesnenen menm 40 5 12 1 Data imiport limites rr reat ive ni e Evers ERES 40 5 12 2 Defa
25. atting tlCfg 2name duplicity checking generate new Note Obsolete parameter g check names for duplicates FALSE could disable the functionalty 5 12 5 String checking and conversions Allow automatic convertion of www URLs and email adresses into clickable links used by function string display links for example by custom fields Valid values are ENABLED DISABLED S tlCfg html make links ENABLED Define the valid html tags for content driven single line and multi line fields Do NOT include tags with parameters eg font face arial gt lt IMG gt and A HREF gt It s used by custom fields functionality for example eEXCOEsg cimiEmL walicl tags p li wh ol lo pes a ly wu cm Siecle Soci validi tags single line Val doy wi ean p 42 6 Localization TestLink supports localization of text date and time There is a default value in configuration but each user can set own language Language code is according to common standards g default language en GB 6 1 String localization A directory exists for every localization with a standard strings txt file inside TL INSTALL DIR locale de DE strings txt TL INSTALL DIR locale de DE custom strings txt TL INSTALL DIR locale en GB strings txt To change some of the original translations without changing those provided with the original file you can use custom strings txt You
26. de 03 25 09 M Havl t 2 14 Update according to issues TL 1 8 2 04 30 09 M Havl t 54
27. e size for each repository entry default 1MB 38 StlCfg gt repository max filesize 1 Also check your PHP settings default is usually 2MBs Users should add a title for the attachment You can leave it empty FALSE Default is TRUE The actions for validation TRUE none just write on db an empty title use filename use filename as title g attachments allow empty title TRUE g_attachments gt action on save empty title none Title is used as link description for download if title is empty show icon the g attachments access icon will be used show label gt the value of g attachments access string will be used g_attachments gt action on display empty title show icon Ge attachnents gt ECCSss uggu umg genug ML meaa IME DIR new x2 1g style border none gt Sg_attachments gt access string You can set own display order of uploaded files g_attachments gt order by ORDER BY date added DESC 5 11 Requirements support Requirement functionality could be enabled disabled per Test Project level not via TL configuration Navigate to the Edit Test project page as Administrator One of the unique features of TestLink is Requirement Management Classic structure of requirements allows just two levels SRS document and a list of requirements The parameter child requirements mgmt allows a tree organization o
28. em teamst org 19 g return path email no replay teamst org g smtp host 10 20 30 40 5 2 Logging TestLink has its own logging system with two possible output channels files and database Records in database are visible via GUI You can use it for troubleshooting A log file is created for each user Configure the next parameters in custom config inc php file LOG LEVEL Set this to the default level of logging NONE ERROR INFO DEBUG EXTENDED Note that TestLink doesn t verify the size of created files I e Use DEBUG level only for development or bug investigation to save disc place ERROR level is recommended for production It s default settings StlCf g gt log_ level ERROR LOGGING OUTPUT There are two output channels files and database Both ways are up by default Set the next parameter to false if you would like to disable one or both channels g loggerCfg null all loggers enabled default g loggerCfg db enabled FALSE true false g loggerCfg file enabled FALSE M exem relse LOGGING PATH The path for the logging of TestLink E g tmp for Linux and c temp for winxp relier coca ot Wik INES PANE MIO gr cO NMMID SI Note Using debug level for your production server can generate large files You can consider to create a script for periodic clean up PHP environment logging has Error level by default We want php errors to show up for
29. ement robust security features There is a role related system that allows access to certain pages only All input data are verified against danger characters Displayed data are also escaped if it s appropriate We recommend the next steps 1 Remove or disable default admin account 2 Remove installation directory 3 Use https protocol for access You can use certificates if you like 4 Don t share testlink URL on internet 5 Set up backup script to run every day 6 Configure all directories for temporary files write access required to non default path gui templates c logs upload 12 7 Disable write access for code directories I recommend to use linux apache These hints are not mandatory but highly decrease chance of attack zd3 4 Upgrading There are two possibilities you need update DB schema or do not This update is required for major version upgrade Major version upgrade You can upgrade either automatically via script or manually Release notes should state when DB schema update from the previous version is required 4 1 1 Code upgrade only This upgrade is common for bug fixing releases or release candidates Maintenance Bug fixing release is for example 1 6 0 gt 1 6 1 Database schema shouldn t changed in this case Please follow the next steps e Backup all files of the previous version in testlink directory and database e Remove the all files from directory e Copy a new versi
30. erated from the assigned requirement b br 5 12 Configuration of misc functionality 5 12 1 Data import limits Web servers have defined a maximum upload file size PHP allows to clarify this limit and testlink uses default 204800 bytes You can call the phpinfo function to find the location of your php ini file it will also tell you the current values for the following settings that we need to modify file_uploads upload max filesize e max_input_time memory_limit max execution time e post_max_size 40 You could increase this value if you import a bigger file There is also parameter limiting maximal size of one line of exported file The value 10000 characters should be enough tlCfg gt import max size 204800 tlCfg gt import max row 10000 Note attachment repository has an extra constraints 5 12 2 Default user role Set the default role used for new users This values is used for users e created from the login page e offered by default when using user management e when their original role definition is deleting from TestLink tlCfg default roleid TL ROLES GUEST Possible values TL ROLES TESTER TL ROLES GUEST TL ROLES NO RIGHTS and similar constants defined by you See const inc php for more 5 12 3 Time out limit Set the session time out for inactivity in minutes Default value of this internal limit is 60 minutes Time
31. eters to access to particular issue tracking system You need to edit this file if you want to access issue information from TestLink 5 3 1 Connectors to database of tracker The most of connectors uses direct access to database See Appendix for an example of Mantis configuration Other such connectors have same or similar parameters Generally you should set up connection settings authentication and DB type define BUG TRACK DB HOST localhost deitime BUG ETRA C DBE NAMEN imaster tracker Glee dine E WC MET IDIE ECHARSE AE OE 21 desse MUN MIB Eem 2 define BUG TRACK DB USER admin d etine BUG TRACK DB PASS password The constant BUG_TRACK_DB_TYPE is related to supported DB types of ADODB component 5 3 2 TRAC configuration TestLink connector to TRAC uses XML RPC communication instead of direct access to database There is a few settings on TRAC side at first e The XmlRpcPlugin plugin should be installed in your Trac See http trac hacks swapoff org wiki XmlRpcPlugin Add the permission of TICKET_VIEW and XML RPC to the user anonymous in Trac Now configure the next parameters in testlink cfg trac cfg php file URL of TRAC plugin define BUG TRACK DB HOST http YourTracServer trac You must map TestLink test project name against Trac project name part of URL g interface bugs project name mapping array YourTLTestProjectNa
32. f requirements similar to test specification Possible values e ENABLED allow N level depth tree e DISABLED just one level tlCfg gt req cfg gt child requirements mgmt DISABLED Requirement identification string req_doc_id must be unique TRUE identification is UNIQUE IN THE WHOLE DB system wide FALSE gt identification is UNIQUE INSIDE a SRS 39 g req cfg gt reqdoc_id gt is system wide FALSE 5 11 1 Generated Test Cases from Requirements You can choose to create test cases for every requirement after creating the Software Requirements Specifications SRS and populating it with requirements A specific Test Suite is created for the purpose You can define that the related SRS title is used TRUE FALSE gt test cases are created and assigned to a test suite with name defined via g req cfg default testsuite name TRUE Requirement Specification Title is used as testsuite name Sg reg gug use reg spec ES tessile name WUE The next test suite title is used if you set the previous parameter as FALSE g req cfg gt default testsuite name Auto created Test cases Two additional parameters values should be html or simple text g req cfg gt testsuite details Test Cases in the Test Suite are generated from Requirements A refinement of test scenario is highly recommended g req cfg testcase summary prefix lt b gt The Test Case was gen
33. fest Link Installation amp Configuration Manual TestLink version 1 8 Version 2 14 Status Updated 2004 2009 TestLink Community Permission is granted to copy distribute and or modify this document under the terms of the GNU Free Documentation License Version 1 2 published by the Free Software Foundation with no Invariant Sections no Front Cover Texts and no Back Cover Texts The license is available in GNU Free Documentation License homepage 1 Scope This document serves as a reference and knowledge base for the installation and configuration of tool TestLink 1 8 The first part includes the installation procedure and second part the configuration explanation The latest documentation is available on TestLink homepage You can also ask for help to solve your problems in an appropriate section of TestLink forum Summary of installation process 1 Install background services 2 Transfer and uncompress files into web directory 3 Generate database tables and add data create default or transfer from previous DB 4 Edit configuration files 5 PHP File extensions 6 Login TestLink includes installation scripts that helps you easily set up all required configuration and database structure Table of Contents 1e OCODE HET 2 2 System Requirerriernts i ipis ede setessscsstesetasezesekosuberebasuperek Us sberukasabhr an n Even E WEINE ANY 4 zumEcSice
34. for exec ui array Vigessecl gt Hrest SM OS ipsc d ME Mucius cSMIFC c lolexekeg gt es specu lloc tlCfg results default status passed 3 Add new statuses and save tcstatus 1 gt code q tcstatus 2 gt code w 4 custom config inc php will be tlCfg results status code array failed poo ria Milosike eiie cia gt Ulo passed p 34 Pug mum IN IUE Imot ehyeileiole gt xU unknown gt u cull Expo Meus tcstatus 1 gt q testatus 2 gt w tlCfg 2results status label array eub gt ites Sicecus alll Seu y Minne rumi gt Wrest Sterus NGL ium HASSET gt uei Sicsieuls joasiseel Vite cel gt lest ptatus ftarlegi lolexkeol gt aeg Svarus Blocken Ynor aweilalole gt MESSE status not araillaiile unknown gt TEST STATUS AKAOA N y tcstatus 1 gt test status new one tcstatus 2 gt test status new two tlCfg results status label for exec ui array Mpccod ME cci SM ES Vieilles Vies starus ieudleo B ccked scis seals icc tcstatus 1 gt test status new one tcstatus 2 gt test status new two i StlCf g gt results default status blocked 5 Modify css if you want new colours sECStacus 1 Ciy testatus i i Collies background o CCERARUS 2y color background chiy cesttacus il margin padding black yellow C
35. i layoutMainPageRight array testPlan gt 1 testExecution gt 2 testPlanContents gt 3 Configure round percentages on the metrics Dashboard tlCfg dashboard precision 2 Control availability of rounded corners for some GUI elements You would like to disable it to improve rendering performance of pages value DISABLED Parameters are enabled by default tlCfg gt gui gt round corners exec history ENABLED tlCfg gui round corners tc title ENABLED LI StlCfg 2gui round corners tc spec ENABLED 27 5 7 3 Text area editor Text data editing is solved via Javascript editor with toolbar over text area fckeditor or tinymce or simple text area with plain text none The configuration is defined by the next array tlCfg 2gui text editor array FCKeditor component is used by default as full featured component This is rich featured component and could be easily enhanced via configuration to allow more features and enhancements tlCfg 2gui text editor all array Tyee Muti citis o Me llogic gt mwl cleurenwdbwe configFile gt cfg tl fckeditor config js This configuration will be used if no element with search key area is found on this structure Every element is a map with this configuration keys Parameter type fckeditor tinymce or none gt use plain text area input field The next line modifies
36. iv 1TeSicaicws 2 1 black orange Cliy cestatus 2 i 8px 6px 35 text align center Effect at user interface level will be UW REAU USC AUIITHIISUGLUI r roulrrdt Tesc case IU tyupyvur ERI Test Results on Build BUILLL v Test plan notes v Build description v Bulk TC status management Setallto status Passed Setallto status Failed Setallto status Blocked Setallto status Status ONE Setallto status Status Two N Save all executions Test Plan 7 AQ A Not Run Assigned to Passed Failed Blocked Status ONE Status Two Cammi inicatiane T 3 YUMA AQ 3 fa Loepy me J c 10 G shock wd dn G No tester assigned E1 C Communications 3 7 eae E C1 Handheld devices 2 Last execution Build BUILLL pea Date Build Tested by Status attack 1 4 subspace channels 1 24 01 2008 07 29 10 BUILLL admin L 5 9 Test Specification Layout of steps and expected result text area could be horizontal steps and expected results panes are side by side 36 vertical steps pane is above the expected results default behaviour g spec cfg steps results layout vertical Availability of test suite filter in the test specification navigator ENABLED gt User will see a test suite filter default behaviour DISABLED gt no filter available g spec cfg show tsuite filter
37. ll environment Web server with php5 and database Refer to documentation of these products and TestLink System requirements 2 2 section You can also find installations package of all these products and install it together for example XAMPP EasyPHP Uniform Server etc 2 Transfer the TestLink installation file to your web server using whatever method you like best ftp scp etc You will need to telnet SSH access into the server machine for the next steps if not localhost 3 Decompress the package Linux untar gunzip it to the directory that you want The usual command is 1 step tar zxvf lt filename tar gz gt e Microsoft Total Commander Winzip Stuffit and other programs should also be able to handle decompression of the archive 4 At this point you may want to rename the directory to something simpler like testlink You will use the mv command to rename a directory Windows users substitute the ren command or use explorer mv directory name testlink 5 Continue Installation of database structure and configuration or Upgrade 3 2 AUTOMATIC Installation TestLink includes installation scripts that help you set up all mandatory configuration and database structure The following details the basic steps for installation on any system The instructions may seem Unix centric but should work fine on Windows systems Barring complications it should take you about 5 30 minutes to install configure a
38. llow Test case counters by status on tree menu ENABLED gt enable counters DEFAULT VALUE DISABLED gt disable tlCfg gt exec cfg gt enable tree testcase counters ENABLED 25 5 7 2 GUI Layout We have defined theme directory that includes CSS and image files testlink root gui themes default You should copy the default directory modify content and set the next parameter to point it tlCfg 2theme dir gui themes your theme You can change TestLink appearance by writing your own CSS Cascading Style Sheet files The default files within theme directory e testlink css main style definition e tl print css specific settings for printing of pages e tl documents css used for generated documents for example Test Specification e tl treemenu css specific settings for tree menu These filenames are defined as constants in const inc php file You could be modified it if you need to You can set own logo instead of the default TestLink image You must copy your image file into gui themes default images directory or within you layout theme to allow it tlCfg company logo company logo png Note This logo is used for both GUI and generated documents Login page could show the informational text in html format The value is empty by default tlCfg gt login info lt p gt Please contact administrator a href mailto jack caribic sea gt G B Shaw lt a gt if you have an
39. localhost is enough in the most cases g smtp host localhost Email address of administrator and sender are also mandatory parameters g tl admin email your name your company com for problem error notification g from email no replay testlink test_team email sender showed to recipient g return path email your name your company com Important set up SMTP host and email addresses are mandatory configuration Optionally you can set priority of email The value not urgent is default Urgent 1 Not Urgent 5 Disable 0 g_mail priority 5 Your SMTP server should requires login to relay emails The values remains empty in the most of cases Configure authentication g smtp username p g smtp password UM 5 6 User authentication TestLink supports two kinds of authentication e23 MD5 use encrypted password stored on internal database LDAP use password from LDAP Server Internal password is default tlCfg authentication method VIDE 5 6 1 External LDAP authentication LDAP authentication needs a few more parameters to be set StlCfg gt authentication ldap server localhost tlCfg gt authentication ldap port 389 tlCfg authentication ldap version By tlCfg authentication Ildap root dn dcemycompany dc com tlCfg authentication ldap organization Hil ras organizationname Traffic V cd Q LESE gr
40. lt values of configuration parameters This file is included into nearly each page See below for more config db inc php Contains configuration parameters to access the database This file is created by the installer during the installation or upgrade process Normally you don t need to change it manually custom config inc php serves for modification of default values of parameters in config inc php The benefit is that your modification is easy to copy during upgrade procedure cfg bug tracker cfg php set access to database of a bug tracking tool cfg const inc php define constants and variables that are not supposed to modify gui templates input dimensions conf Instead of hard coding attributes of html inputs like maxlength and size we have code it into this file there are exceptions for historical reasons cfg tl fckeditor config js set up fckeditor component configuration Use custom config inc php for your changes Instead of making changes to config inc php we suggest adding your changes to file lt testlink_root gt custom_config inc php This allows you to save your configuration in the case of update Example To configure mail server settings copy following lines from config inc php into custom config inc php and make changes according to your configuration this is your custom configuration file custom config inc php g tl admin email gandalf teamst org g from email testlink syst
41. mel gt YourTracProjectl YourTLTestProjectName2 gt YourTracProject2 Enable BTS integration On custom config inc php create line pg interface ouge WRNC p 5 3 3 BTS character set Garbled characters in BTS integration Check character set of your BTS database There is nothing to configure if it s the same like your TestLink database Configure the next constant in the corresponding bug tracking system configuration file directory testlink cfg if char set differs Character set can be defined like define BUG TRACK DB CHARSET ISO 8859 1 5 4 Generated documents The next strings are used in front page of printed document Left blank to disable 22 StlCfg document generator company name Your Company tlCfg gt document generator company copyright 2008 c TestLink Community tlCfg 2document generator confidential msg GPL Generated documents has own layout template You can modify CSS template to you own tlCfg 2document generator css template tlCfg theme dir ess tl documents css Test case version could be included in a generated document together with Test case title tlCfg document generator tc version enabled FALSE M 5 5 Send E MAIL TestLink has integrated mailing support for sending reports and notification You must set up the next values SMTP server delivers a generated email The value
42. n Rx en REXY SORA ME YA TERRE ECURER E SEO UU E Eua 15 4 2 Backward COMPAtiDILIty ccc cE EEE EEE mene nnn nnn nnn 15 4 2 1 Database schema Changes cceeceeeee a eee eee eee eee eee eee eee eaten 15 5 7 8 4 2 2 Changed Terminology ioc exe ena ede eX E EA ERR E RAE Re MEET caster avast 16 4 2 3 Obsolete features cicsedsacsecsivenstes duced acescoteete eek Dea Sd CIR SX EX EORR TED d a Eo CE Peg aaa RO 16 4 2 4 Test Plan relation to Test Project upgrade from 1 5 and older 16 4 2 5 Latin to UTF 8 conversion upgrade from 1 5 and older esssesse 16 CONTQUFATION Eme 19 5 1 Configuration Files overview sess mmm nemen emen emen rennen 19 5 1 1 Use custom config inc php for your changes sssssseeeeenen enm 19 DEQ Woorgcp e DENA 20 5 2 1 EVENE VEVET 5 iiisidetex eda rra ERIS ERR ERAXRTRAR RA IRTAEAXRERRRERRRDNR RE EEn Eaa aA aA 21 5 3 Configuration of Bug Tracker connector sssssssssssssessee emnes 21 5 3 1 Connectors to database of traCker ccceeeceece eee ee eee e eee ee eee e eee nennen nnns 21 5 3 2 TRAC configuration 2 eed eii ar teens Saaacdsedas APARESCA TNE R pase 22 5 3 3 BTS character set c ec ovde e e obere dioe tese ea des Tbe SES 22 5 4 Generated documents seesseseesseeseeseesee senses sea sea sea sea sea nnn nn 22 5 52 Send HIM 23 5 6 User authentic
43. nd be using TestLink Next we will create the necessary database tables and a configuration file for database access 1 From your web browser access http lt yoursite gt testlink install index php 2 This page will walk through the following steps e check basic parameters for the web server php config and DB version prompt for the database type and location and a database user password pair For installation an administrative user password pair can also be provided The operating user requires ALTER SELECT INSERT and UPDATE privileges For installation INDEX CREATE DELETE and DROP privileges are also required e create the database and tables Important A DEFAULT ADMINISTRATOR level account is created Use this when you first login to TestLink Immediately go to Manage and create at least one administrator level account You can recreate it but you should delete the account to prevent the cookie string from being used to trick the package It would be even better to rename the account or delete it permanently SECURITY Remove or disable the default admin account is good practice perform some post installation checks on the system 3 After a successful upgrade you should remove the lt testlinkwebdir gt install directory for security reasons 4 The next part involves configuring the installation to work with your specific setup See configuration section for description of configurable parameters 3 3 MANUA
44. need to place this file in the corresponding localization directory and use the same format and rules used in the original strings txt You can redefine a value present on strings txt without need of commenting it in the original file Instruction and help pages have their own location testlink root gt gui help lt language gt 6 1 1 Date and Time Localization For every defined locale you can set the format for date and time presentation This is configured using the following associative arrays g locales date format and g locales timestamp format At time of this writting the configuration is g locales date format array en GB gt d m Y it IT gt d m Y es AR gt d m Y es ES gt d m Y de DE gt d m Y fr FR gt d m SY pt BR gt d m Y g locales timestamp format array Jem CBU Msc cm s ahg aS Jit TEU gt Moc en SY wha M aS e AR gt Yoc eme whig Mg Sp es ES gt d m Y H M 5 gis ID gt Herl giomi shig eMe Ser fr FR gt d m Y H M 5 pt BR gt d m Y H M S If there is no entry in the previous arrays the value of the following configuration variables will be used g date format and g timestamp format Example of formatting g date format d m Y g timestamp format d m Y H M 5 6 1 2 Character set TestLink supports UTF 8 characters by
45. on to the same directory e Copy config db inc php and custom config inc php file to the new structure and modify other configuration parameters and changes according your previous settings for example in config inc php file e Now it should work 4 1 2 Automatic upgrading with DB schema changes Major versions have had typically new functionality and several changes in database against older TL main releases I e you are not able to use directly your original database for example 1 6 gt 1 7 Warning TestLink team doesn t support the scripted database migration from Beta versions See 3 3 MANUAL Installation Please follow the next steps e Follow check preinstallation steps Requirements could change e Copy new version code to your site See chapter 4 1 1 Code upgrade only for more e From a web browser run http testlinkwebdir install index php e Choose Migration from link if your original version is available in menu Read and follow procedure steps e Run the migration scripts until you see that process is finished For example your version is TL 1 6 3 Run scripts under Migration from 1 6 2 to 1 7 x then run scripts under Migration from 1 7 2 or greater to 1 8 0 link e You should run Upgrade Installation link in some cases Run the scripts until you 7 Occasionally for upgrade from Release Candidate or Hot Fix eda 4 see that notification process is finished e Afte
46. onfiguration Note You can configure testlink to use another writable directories for security reason 9 Modify configuration parameters to point another directories see configuration section e Log into TestLink Default credentials are e user admin pass admin e Changing this password is a good security practice TestLink notifies if you don t do it e After a successful upgrade you should remove the testlinkwebdir install directory for security reasons The next part involves configuring the installation to work with your specific set up See configuration section for description of configurable parameter Report any issues or feedback to TestLink Bug tracking system page 3 4 Database Troubleshooting Do you have problems with database Modify and run the next script The code fits MS SQL kind php SmyServer localhost SmyUser sa SmyPass passwordl SmyDB testlink connection to the database dbhandle mssql connect myServer myUser myPass or die Couldn t connect to SQL Server on SmyServer select a database to work with selected mssql select db myDB dbhandle or die Couldn t open database SmyDB declare the SQL statement that will query the database query SELECT Squery FROM users execute the SQL query and return records result mssql query query SnumRows mssql num rows result echo lt hi
47. r a successful upgrade you should remove the testlinkwebdir install directory for security reasons e Check configuring for changes We add modify and remove configuration parameters Especially TestLink 1 8 means conversion of a lot parameters to new singleton structure tlCfg See configuration section for description of configurable parameter e Check forum for troubleshooting Report any issues or feedback to TestLink Bug tracking system page Note Upgrade from version 1 6 and older to 1 7 needs to use the large scripted database migration because of major changes in DB schema It is an extra action in installation script follow the instructions of the script 1 3 Manual upgrading The automatic upgrade is recommended However there are cases that user cannot use it For example upgrade from Beta versions or user has own incompatible DB schema changes You can do it of course after a study of changes in database and installation script Good idea is to compare SQL files for create DB tables your current version and a new one See testlink install sql lt db type testlink create tables sql DB schema should be modified via any DB administration tool then for example phpMyAdmin for MySQL 4 4 2 Backward compatibility 2 1 Database schema changes New and enhanced functionality results into adaptation of user password is encrypted 1 5 A new tables for SRS feature requirements req_cover
48. ries g tpl tcView g tpl tcSearchView g tpl tcEdit g tpl tcNew g tpl execSetResults This allows you to create templates with different names than the original TestLink without the risk of overwriting them during the next upgrade Note Not all TestLink pages are ready for this kind of configuration The standard configuration 30 g tpl tcView tcView tpl g tpl tcSearchView tcSearchView tpl SG tolf remene Ule sil s g tpl tcNew tcNew tpl g tpl execSetResults execSetResults tpl 5 8 Test execution settings Allow XML RPC calls to external test automation server the special buttons will be displayed on execution pages ENABLED gt enable XML RPC calls DISABLED gt disable tlCfg exec cfg enable test automation DISABLED Different layout for the attachments management on execution page these variables are predefined in const inc php att model m1 shows upload button and title att model m2 hides upload button and title DEFAULT VALUE SEelCicg SsxSe Cig Saic_mocel pett nodal mzy Availability to delete execution result by an user ENABLED gt User can delete an execution result DISABLED gt User can not DEFAULT VALUE tlCfg gt exec cfg can delete execution DISABLED 5 8 4 Execution history Define order of execution history ASC gt Ascending last execution at bottom D
49. rity defines the threshold values according to the formula Priority urgency x importance The meaning of values is e LOW all Test cases with Priority lt LOW Threshold e HIGH all Test cases with Priority gt HIGH Threshold e MEDIUM all Test cases with Priority gt LOW Threshold AND Priority lt HIGH Threshold S tlCfg urgencyImportance LOW Threshold 3 tlCfg urgencyImportance HIGH Threshold 6 5 8 3 Adda new type of Test results on execution page You will need to work on the following files all paths are relative to installation directory custom config inc php create it if do not exist yet e locale en GB custom strings txt create it instead of editing strings txt e gui themes your theme css testlink css 33 1 Open c g const inc php and search for t1Cfg results status code 2 Copy following lines into custom config inc php tlCfg results status code array failed LSU blocked em Uu passed gt p sage sce gl gt n inot available gt xU unknown E eL IL Ug tlCfg 2results status label array reel lien gt Vrest Stars all sratus Vu ivi gt esse Hrarus imei Ewa passed gt hoe tarus passec Miceli Lee gt Uipegi Status ieu beg Vlolexkegol gt Wrest Status blocked Minor avyailablet gt iesu status not available unknown gt MOSE STATUS nssioisan tlCfg results status label
50. se to support UTF 8 First make a backup of your current database using the mysqldump utility usr bin mysqldump u root testlinkl15 p gt testlink15 backup e Now edit testlink15 backup so schema definitions for EACH table has utf8 encoding specified Change the CHARSET for each table from latini to utf8 For example the following line in the definition of a table which reads as follows ENGINE MyISAM DEFAULT CHARSET latinl COMMENT This table holds the bugs filed for each result should be changed to ENGINE MyISAM DEFAULT CHARSET utf8 COMMENT This table holds the bugs filed for each result e Then ran testlink15 backup through my the perl script below as follows replaceScript pl testlinkl5 backup gt testlink15 cleaned replaceScript pl is as follows usr bin perl while lt gt chomp tr 000 177 040 cs jesUeqE So yale e Created an empty testlink16 database with utf8 charset as follows CREATE DATABASE testlink16 CHARACTER SET utf8 e Install the tables into the new database mysql testlinkl6 u root p lt testlinkl5 cleaned 17 e You can verify your database s DB character set is now set to utf8 by using the following command login to mysql use testlink16 mysql Ns MST Wese 14 7 Wastes 4 iil ioe isclacie ilamub lt cjal aL SiS Connection id 26 Current database testlink15 Current user bugz localhost
51. stration assign this relation manually and use this feature for data from previous version Filtering Test Plans by Test Project As stated before the default behaviour is to filter Test Plan by Test Project Using the following configuration parameter g ui show check filter tp by testproject TRUE Allow the user through the user interface to enable disable test plan filter by Test Project A check box is displayed over the test plan combo box Force Test Plan filtering without any user possibility to change it g ui show check filter tp by testproject FALSE 4 2 5 Latin to UTF 8 conversion upgrade from 1 5 and older TestLink 1 6 allows for UTF 8 encoded character rendering therefore any extended character data that may have snuck into your database and didn t show up in 1 5 may start appearing in 1 6 UI You can turn UTF 8 support off in testlink by modifying a value in the 16 testlinkinstalldir config inc php file but then you will be missing out on the ability to use characters beyond ASCII If you have the same problem I did and see lots of extended characters appearing in your data after upgrading to 1 6 and having UTF 8 support turned on you should read through the following instructions Be sure to practice this exercise on a test machine before performing on your deployment system The instructions will help you clear out any non ASCII characters from your database and set up your databa
52. the rules you are using on your site 24 tlCfg validation cfg user login valid regex Nw Regular expression is used when validating user email addresses tlCfg validation cfg gt user email valid regex w w w 1 2 A 2 2 1 12 4 97 R TestLink makes security check on login and reports findings Configure the next parameter show_config_check_warning to show result of config checks e TRUE messages are displayed on login screen and testlink desktop e FALSE a two line message is displayed with indication about a file with check results StlCfg gt show config check warning FALSE 5 7 GUI Customization 5 7 1 Tree menu Testlink supports several tree menu components Possible values are EXTJS LAYERSMENU DTREE JTREE EXTJS is default value we recommend it The component EXTJS has the best performance because it uses asynchronous communication tlCfg treemenu type EXTJS Any type of node Test case Test Suite is added with ordering number 0 when creating an node in the tree The initial display order will be by node id A parent test suite has the next default values to separate child Test Suites and Test Cases These values must be gt 0 StlCEg gt treemenu default testsuite order T tlCfg treemenu default testcase order 100 Show or hide Test case unique ID on tree menu tlCfg treemenu show testcase id TRUE A
53. ui text editor design array toolbar gt tl mini tlCfg gui text editor testplan array type gt none tlCfg gui text editor build array type gt fckeditor toolbar gt Mell mamak i h p StlCfg gui text editor testproject array type gt tinymce StlCfg gui text editor role array type gt tinymce StlCfg gui text editor requirement array type gt none tlCfg gui text editor requirement spec array type gt none Performance warning The problem is that fckeditor uses iframe and each iframe needs to download fckeditor files So too much editors on page could make the loading problem Enabling Image Uploading in FCKEditor Procedure is based on article from Bin Blog This tutorial is aimed at FCKEditor 2 3 2 but the principle works in other versions of FCKEditor as well Open the file FCKEditor fckconfig js Make sure that the default php connector is selected By default the ASP connector is enabled Search for var FileBrowserLanguage php asp aspx cfm lasso perl php py var QuickUploadLanguage php asp aspx cfm lasso php Enable the connector Open FCKeditor editor filemanager browser default connectors php config php SECURITY You must explicitelly enable this connector Set it to true SConfig Enabled true Make sure that the given
54. ult user role oerte tiens ee ke p I aer easy x Y XR EAR EXE E E REE EE TES 41 5 12 3 Timesout limit 2 ener te eure sei ee ges Ee A ED E PUE Ld eig eerie 41 5 12 4 Title duplicity of Test Projects Test Suites and Test Cases sss 41 5 12 5 String checking and conversion Sissit aena i emen 42 tocalizatio nieni PR 43 6 45 String localizati rn RM ATE 43 6 1 1 Date and Time Localization sesseseeseeseenenenneenen nennen 43 6 1 2 Character Set eus oes E uox AENEAS REAS EFE DL E rcx Eee Ca Eb aU GE ARE nr TS 44 6 1 3 GUL Special characters iR Ree E wi vidya wees YES 44 ME 46 PA Qe diaz EM 47 2 System Requirements 2 1 Client side We support common web browsers Firefox 1 0 and higher and MS Internet Explorer 6 Generally any other browser should work if it supports JavaScript XHTML and CSS There are some issues with other browser because no one satisfy 10096 standards as well as two ones above 2 2 Server side TestLink server Sn aa PHP X module TestLink scripts Database There is no requirement about your operating system We test application on Linux and MS windows XP TestLink server requires these applications as background Database You can run also your database on both the same or different server than TestLink php scripts MySQL 4 1 x and higher 4 0 x doesn t support UTF 8 e Postgres 8 x and higher e soft S
55. users You can modify it of course See php net site for more error reporting E ALL SMARTY DEBUG WINDOW Developers should use this parameter to show extra window with list of all parameters and values that are sent from php script to Smarty template component The parameter must be false for production installation tlCfg gt smarty debug false 20 Show warning on login page and main page if there are security weak points The message is enabled by default TRUE Value FALSE causes a file config check txt with a list is created to logging directory but users are not notified via GUI StlCfg gt show config check warning TRUE 5 2 1 Event viever All events older this value days are removed from the database g removeEventsOlderThan 30 5 3 Configuration of Bug Tracker connector TestLink allows direct communication with your bug tracker To enable this feature you need to change a configuration parameter on the configuration file custom config inc php The interface is disabled by default value NO The available values are NO BUGZILLA MANTIS JIRA TRACKPLUS EVENTUM SEAPINE or TRAC For example og intertace bugs MANTIS p See system requirements chapter for supported versions The particular BTS configuration file could be for example cfg bugzilla cfg php cfg mantis cfg php generally cfg lt tracker_name gt cfg php Contains configuration param
56. ws linux would probably be session save path usr php sessions Either way you must have write permissions on those folders How can I improve performance There is several places where large data are proceed There is several hints to improve processing e Use EXT JS tree menu component default in 1 8 e Structure Test Cases to Test Suites properly 100 test cases directly in one Test Suite is wrong practice e Disable rounded corners for some GUI elements See parameter t1Cfg gui round corners above More troubleshooting for TestLink with IIS There are a few references here to IIS but most are in reference to IIS 5 Windows XP not IIS 6 Server 2003 On installation of TL version 1 7 1 1 7 3 I would receive the well known smarty error Warning Smarty include c Inetpub wwwroot testlink gui templates c 6A 6A5 6A537D D8SSlogin tpl php function Smarty include failed to open stream No such file or directory in e Inetpub wwwroot testlink third party smarty Smarty class php on line 1247 On versions 1 7 4 1 8b I would receive a blank screen The common reason for this error is due to insufficient rights to the folder The common resolution for this error is to make sure that the Internet Guest Account has R W E permissions for the web directory This is needed and you will receive this error if you do not give these rights 48 However for my installation I had to dig a bit deeper With the
57. xen EaL cetion Ice ticl zrele unigl g StlCfg authentication ldap bind dn tlCfg gt authentication ldap bind passwd t Check LDAP documentation to understand these settings The current last LDAP protocol version is 3 but some organizations could use version 2 invalid version causes connection problem UID field will be used to identify user against a value added via login form The default attribute name is uid For example Active directory uses sAMAccountName Parameters ldap bind dn and ldap bind passwd holds login information for LDAP access Left empty if you LDAP server allows anonymous binding More about LDAP http en wikipedia org wiki Lightweight_Directory Access Protocol Note TestLink API has its own kind of authentication via keys 5 6 2 Login related configuration TestLink allows new users to create accounts with default role by New user link on login page It speed up user administration procedure Administrator could disable this feature to fully control users in system by setting of the next parameter to value FALSE tlCfg user self signup TRUE Regular expression is used to validate new user login names The default regular expressionvalue is Nw It aloows a z A z 0 9 as well as space and underscore Note If you change this parameter you may want to update the TLS valid user name format string in the language files to explain
58. y question lt p gt You can modify the filename of bullet image Default schema includes arrow org gif and slide gripper gif default tlCfg 2bullet image slide gripper gif To specify the Test Project background colour tlCfg gt gui gt testproject coloring background Open the page edit Test project to specify particular colours Default value is none no background colour change is allowed Default background colour is defined 26 tlCfg gui background color 9BD Set up a way to display name and surname instead of login only Specify a format of displayed name tlCfg gt username format login Examples first Ylast gt John Cook last Yofirst gt Cook John Mfirst last login gt John Cook ux555 Configure the default navigator frame frmWorkArea width on left side of window tl1Cfg gt frame workarea default width 30 The Test project combo box in top menu has configurable order value must be SQL compliant tlCfg 2gui tprojects combo order by ORDER BY nodes hierarchy id DESC Examples ORDER BY name ORDER BY nodes hierarchy id DESC similar effect to order last created first Administrator could configure order of navigation topics on the Main Page tlCfg gui layoutMainPageLeft array testProject gt 1 userAdministration gt 2 requirements gt 3 testSpecification gt 4 tlCfg gu
Download Pdf Manuals
Related Search