===============================================================
         TestLink 1.9.17 (Prague Bugfix 17) Alan Turing - Read me
===============================================================

Contents
1. Introduction
2. Release notes / CRITIC Configuration Notes
3. System Requirements
4. Installation & SECURITY
5. Upgrade and Migration
6. TestLink Team 
7. Bug Reports and Feedback
8. Supporting our work
9. Regarding forum usage www.testlink.org
10. Changes regarding 1.9.6,...,1.9.12,1.9.13,1.9.14,1.9.15,1.9.16
11. Testlink & FreeTest
12. Security
13. JIRA DB interface changes
14. People supporting TestLink
15. Miscelaneous
16. Use forum.testlink.org
17. User cries: I WANT HELP !!!
18. Use Mantis documentation
19. Link to GITORIOUS COMMITS




1. Introduction
===============================================================

TestLink is a web based test management and test execution system.
It enables quality assurance teams to create and manage their test 
cases as well as to organize them into test plans. These test plans 
allow team members to execute test cases and track test results 
dynamically.

TestLink is a GPL licensed open source project. All of the source code 
behind TestLink is freely available for download via SourceForge 
at http://www.sourceforge.net If you are interested in contributing 
to the TestLink effort feel free to contact us.
There is no hidden fee - 100% free for using!

In an ideal world, testing would be a pretty straightforward process.
A test team takes the product requirements, writes a test specification document,
reviews the tests, and then runs them all for each version of the product.
The team is composed of full-time staff, and everyone knows exactly what is expected of them.

In practice few organisations have that luxury.
There is not time to run all the tests on every product version - especially on fix-releases
that need to be rolled out quickly. 
Requirements are constantly changing, and the tests have to be changed in step.
Test staff come and go.
There are misunderstandings over who was supposed to run which tests, so some get missed.
Management suddenly wants a status update at seven in the evening.

In these situations you need the support of a test management tool, such as TestLink.
The purpose of TestLink is to answer questions such as:

- For which requirements do we still need to write or update test cases?
- Which tests do you want me to run for this version?
- How much progress have we made on testing this release?
- Which test cases are currently failing, and what are the errors?
- On which version was this group of test cases last run, and is it time we ran them again?
- And ultimately: is this version of the product fit for release?

TestLink helps you to keep the test process under control.
It forms a repository for requirements and test cases, and relates these to builds,
platforms and staff. 
You allocate tests to staff who carry them out and record the results.
A wide variety of reports provide information on what has been done and what still needs to be done.


2. Release notes / CRITIC Configuration Notes
===============================================================

This release contains bugfixes for 1.9.16
See CHANGELOG file for detailed list of issues fixed.

*** CRITIC PHP.INI Settings ***

** max_input_vars, Available since PHP 5.3.9. Default value:1000
If you are going to have test plans with more that 100 test cases, it will be CRITIC 
to increase this value in order to avoid issues (CRASH or MALFUNCTIONS) when adding
test cases to test plan.
See:
http://forum.testlink.org/viewtopic.php?f=11&t=7124&p=17284&sid=e3552aca223ac1f6b3676812aa02f04c#p17284
http://mantis.testlink.org/view.php?id=5372

** amount of memory assigned to php
See http://mantis.testlink.org/view.php?id=7178

3. System Requirements - server
===============================================================

Server environment should consists from:
- web-server: Apache 2.x
- PHP > 5.4
- DBMS: MySQL 5.6.x / MariaDB 10.1.x , Postgres 9.x , MS-SQL 2008/2012

Supported client web-browsers: 
- Firefox
- Internet Explorer 9.x or greater
- Chrome   

ATTENTION: we have not enough resources to test on all kind of browsers.
           Righ now development is done using Chrome & Firefox.

4. Installation & SECURITY
===============================================================
The following details the basic steps for installation on any system. 
Instructions may seem unix-centric but should work on Windows systems.

Barring complications, it should take you about 10-20 minutes 
to install, configure, and be using TestLink.

Short summary:
 1. Transfer files
 2. Uncompress files
 3. Launch web based installer

1. First, transfer the file to your web-server using whatever 
method you like best (ftp, scp, etc).  
You will need to telnet/ssh into the server machine for the next steps.

2. Next, untar/gunzip it to the directory that you want.
The usual command is (1 step):

	tar zxvf <filename.tar.gz>

OR  (2 steps):

	gunzip <filename.tar.gz>
	tar xvf <filename.tar>

Total Commander, Winzip, and other programs should also be able 
to handle decompression of the archive.

At this point you may want to rename the directory to something 
different to 'testlink'. 

*** SECURITY ****
You need to configure:

- log directory 	($tlCfg->log_path)
- upload directory  ($g_repositoryPath)

according to your installation, default values provided are examples THAT DOES NOT WORK OUT OF THE BOX

Give a look to:
http://mantis.testlink.org/view.php?id=5147
http://mantis.testlink.org/view.php?id=5148
http://mantis.testlink.org/view.php?id=4977
http://mantis.testlink.org/view.php?id=4906

You should also need to configure write access for logging, upload and template directories.

*** FCKEDITOR UPLOAD ****
ATTENTION We now use CKEDITOR
Give a look to:
http://forum.testlink.org/viewtopic.php?f=22&t=7098&sid=f4012a67d921cf5a2322c52fc38f21d6



3. Launch web based installer
We will create the necessary database tables and a basic configuration
file. From your web server, access http://yoursite/testlink/ 
or similar URL and follow instructions.

Check Installation manual and TestLink forum if you meet a problem.


5. Upgrade and Migration
===============================================================
When accessing Installer page you will found ONLY NEW INSTALLATION OPTION
Migration HAS TO BE DONE MANUALLY => read below 
- Upgrade from 1.9.3  to 1.9.4/5/6/7/8/9/10/11/12/13/14/15/16/17
- Upgrade from 1.9.4/5 to 1.9.7
- Upgrade from 1.9.7 to 1.9.8
- Migration from other releases that 1.9.3

 Steps
 - Make a Backup of your current database.
 - Using  a NEW DIRECTORY (DO NOT OVERWRITE your old installation),  
   do only following steps from Install procedure:
                                           Transfer files
                                           Uncompress files
 - Copy your old config_db.inc.php and custom_config.inc.php to NEW DIRECTORY.
 - Launch TestLink
 - TestLink will check Database version, and if some upgrade/migration 
   is needed will launch automatically the installer.

 If you are updating a same major version (for example 1.7.0 to 1.7.1) 
 you need to use Upgrade Database.
 
 PLEASE GIVE A LOOK TO:
 MANTIS 6594: Migration scripts don't cover testcase steps and expected results, also testcase ID's are empty in GUI

 If you are using a different major version detailed in options,  
 you need to use the specific Migrations.
 
 If in some steps TestLink ask you for two databases, 
 NEVER use same name from both.
 
 If you do not find nothing useful, post in forum
   
 Always before login, after an upgrade/migration clear browser cookies.

- Upgrade from 1.9.3 to 1.9.4/5/6/7/8/9/10/11/12/13/14/15/16/17
WARNING: if you are using a table prefix replace /*prefix*/ with your prefix
a) Execute install/sql/alter_tables/1.9.4/<your_db>/DB.1.5/step1/db_schema_update.sql
b) Execute install/sql/alter_tables/1.9.4/<your_db>/DB.1.5/stepZ/z_final_step.sql

then give a look to sections: 'Upgrade from 1.9.4/5 to 1.9.7'
                              'Upgrade from 1.9.7 to 1.9.8'

Hint: When using MySQL Query Browser make sure you are not using a single command execution. 
      (open script or use special script tab to execute the whole script at once)

- Upgrade from 1.9.4/5 to 1.9.7
WARNING: if you are using a table prefix replace /*prefix*/ with your prefix
a) Execute install/sql/alter_tables/1.9.6/<your_db>/DB.1.6/step1/db_schema_update.sql
b) Execute install/sql/alter_tables/1.9.6/<your_db>/DB.1.6/stepZ/z_final_step.sql

then give a look to section 'Upgrade from 1.9.7 to 1.9.8'
then give a look to section 'Upgrade from 1.9.8 to 1.9.9'
then give a look to section 'Upgrade from 1.9.9 to 1.9.10'
then give a look to section 'Upgrade from 1.9.10 to 1.9.11'
then give a look to section 'Upgrade from 1.9.11 to 1.9.12'
then give a look to section 'Upgrade from 1.9.12 to 1.9.13'
then give a look to section 'Upgrade from 1.9.13 to 1.9.14'
then give a look to section 'Upgrade from 1.9.14 to 1.9.15'
then give a look to section 'Upgrade from 1.9.15 to 1.9.16'
then give a look to section 'Upgrade from 1.9.16 to 1.9.17'

- Upgrade from 1.9.7 to 1.9.8
WARNING: if you are using a table prefix replace /*prefix*/ with your prefix
a) Execute install/sql/alter_tables/1.9.8/<your_db>/DB.1.9.8/step1/db_schema_update.sql
b) Execute install/sql/alter_tables/1.9.8/<your_db>/DB.1.9.8/stepZ/z_final_step.sql

- Upgrade from 1.9.8 to 1.9.9
WARNING: if you are using a table prefix replace /*prefix*/ with your prefix
a) Execute install/sql/alter_tables/1.9.9/<your_db>/DB.1.9.9/step1/db_schema_update.sql
b) Execute install/sql/alter_tables/1.9.9/<your_db>/DB.1.9.9/stepZ/z_final_step.sql

- Upgrade from 1.9.9 to 1.9.10
WARNING: if you are using a table prefix replace /*prefix*/ with your prefix
a) Execute install/sql/alter_tables/1.9.10/<your_db>/DB.1.9.10/step1/db_data_update.sql


- Upgrade from 1.9.10 to 1.9.11
WARNING: if you are using a table prefix replace /*prefix*/ with your prefix
a) Execute install/sql/alter_tables/1.9.11/<your_db>/DB.1.9.11/step1/db_schema_update.sql
b) Execute install/sql/alter_tables/1.9.11/<your_db>/DB.1.9.11/stepZ/z_final_step.sql

- Upgrade from 1.9.11 to 1.9.12
WARNING: if you are using a table prefix replace /*prefix*/ with your prefix
a) Execute install/sql/alter_tables/1.9.12/<your_db>/DB.1.9.12/step1/db_schema_update.sql
b) Execute install/sql/alter_tables/1.9.12/<your_db>/DB.1.9.12/stepZ/z_final_step.sql

- Upgrade from 1.9.12 to 1.9.13
WARNING: if you are using a table prefix replace /*prefix*/ with your prefix
a) Execute install/sql/alter_tables/1.9.13/<your_db>/DB.1.9.13/step1/db_schema_update.sql
b) Execute install/sql/alter_tables/1.9.13/<your_db>/DB.1.9.13/stepZ/z_final_step.sql

- Upgrade from 1.9.13 to 1.9.14
WARNING: if you are using a table prefix replace /*prefix*/ with your prefix
a) Execute install/sql/alter_tables/1.9.14/<your_db>/DB.1.9.14/step1/db_schema_update.sql
b) Execute install/sql/alter_tables/1.9.14/<your_db>/DB.1.9.14/stepZ/z_final_step.sql

- Upgrade from 1.9.14 to 1.9.15
WARNING: if you are using a table prefix replace /*prefix*/ with your prefix

a) Execute install/sql/alter_tables/1.9.15/<your_db>/DB.1.9.15/step1/db_schema_update.sql

b) Execute (IF EXISTS) install/sql/alter_tables/1.9.15/<your_db>/DB.1.9.15/stepZ/z_final_step.sql

- Upgrade from 1.9.15 to 1.9.16
WARNING: if you are using a table prefix replace /*prefix*/ with your prefix

a) Execute install/sql/alter_tables/1.9.16/<your_db>/DB.1.9.16/step1/db_schema_update.sql

b) Execute (IF EXISTS) install/sql/alter_tables/1.9.16/<your_db>/DB.1.9.16/stepZ/z_final_step.sql

- Upgrade from 1.9.16 to 1.9.17
WARNING: if you are using a table prefix replace /*prefix*/ with your prefix

a) Execute install/sql/alter_tables/1.9.17/<your_db>/DB.1.9.17/step1/db_schema_update.sql

b) Execute (IF EXISTS) install/sql/alter_tables/1.9.17/<your_db>/DB.1.9.17/stepZ/z_final_step.sql

Hint: When using MySQL Query Browser make sure you are not using a single command execution. 
      (open script or use special script tab to execute the whole script at once)


USE THE FORUM SECTION
- http://forum.testlink.org/viewforum.php?f=11

USER UPGRADE SECTION
- http://forum.testlink.org/viewforum.php?f=58


Migration from other releases that 1.9.3

You have always have to migrate one by one to each version that is newer that yours.
Extreme example Migration from 1.7.4

1.7.4 => 1.7.5 => 1.8.1 => 1.8.2 => 1.8.3 => 1.8.4 => 1.8.5 => 1.9.0 
1.9.0 => 1.9.1 => 1.9.2 => 1.9.3 => 1.9.4 => 1.9.5 => 1.9.6 => 1.9.7 => 
1.9.8 => 1.9.9 => 1.9.10 => 1.9.11 => 1.9.12 => 1.9.13 => 1.9.14 => 1.9.15 => 1.9.16 => 1.9.17

You have to read carefully README and instructions (if any) provided by installer.
Sometimes version changes do not require actions on DB structure or data. 



6. TestLink Team 
===============================================================

This list comprise people that has helped

--- Most Active on this release
* Francisco Mancardi - Project lead, builds, core developer, contributors code reviewer
                       (well, really the One Man Band ;) )
* Asiel Brumfield - Infrastructure


--- Contributors and developers active on older releases ---
* Maradana Amardeep - Leader of testlink-qa group effort on 1.9.5
* Bruno de Paula Kinoshita - some work on API, CSRF, Turn Key Linux
* Julian Krien - Leader of testlink-qa group effort on 1.9.1,1.9.2,1.9.3
* Andreas Simon
* Erik Eloff
* Martin Havlat - Project lead, builds, infrastructure, developer
* Andreas Morsing - core developer
* Amit Khullar

--- TestLink - QA Team - for 1.9.4
* Romoy Headly - QA Manager
* Sujata Verma   
* Damien Mathieu
* Amardeep Maradana
* Amit Khullar
* Andreas Simon
* Ngoc Vu
* Biache Benoit

--- TestLink - QA - for 1.9 RC1
* Andreia Balani
* Andreas Simon
* Biache Benoit
* James Bohnert
* Micky Zhang
* Rocky Yang


* Masami Ichikawa - Automated Testing


* Toshiyuki Kawanishi - Japanese localization, developer
* Chad Rosen - (Originator - version 1.0.x)
* Kevin Levy - Developer
* Asiel Brumfield - Infrastructure, developer
* Jason B. Archibald - Developer

* Tools R Us - contributing team
* Oscar Castroviejo - trackplus interface
* Seweryn Plywaczyk - text area custom field
* grdscarabe@grdscarabe.net and Alexandre Da Costa - French localization
* Walter Giaquinto/Alessandro Lia	and  bruno.busco@gmail.com - Italian localization
* Alessandro Lia - Javascript and CSS advice.
* Leonardo Molinari - Portuguese (Brazil) localization
* Hélio Guilherme - Portuguese localization
* jorgesf@jsf.jazztel.es - Spanish localization
* Jonas Fleer : search test case by custom field on test projects
* Lightbulb Technology Services Pvt. Ltd. - techpartners: import test cases from XLS file
  abhishek.kulkarni@gmail.com and amit.dixit@lbtp.co.in 
* Kester Mielke <kmielke@pironet-ndh.com> (execution tree colouring and counters by tc status)
* Peter Rooms - Bug coloring and labeling according status using same colors than Mantis.
* Eugenia Drosdezki - Move/copy multiple testcases
*                     Access to content of docs folder on combo box  
*                     Multiselect OR keywords filter
* Japanese Testing Engineer's Forum (TEF) in Japan
  Working Group of TestLink Japanese Translation Project
  http://sourceforge.jp/projects/testlinkjp/
 
  Atsushi Nagata,       AZMA Daisuke,         Hiromi Nishiyama,
  Kaname Mochizuki,     Kaoru Nakamura,       Kunio Murakami,
  Lumina Nishihara,     Marino Suda,          Masahide Katsumata,
  Masami Ichikawa,      Masataka Yoneta,      Sadahiko Hantani,
  Shinichi Sugiyama,    Shinsuke Matsuki,     Shizuka Ban,
  Takahiro Wada,        Toshinori Sawaguchi,  Toshiyuki Kawanishi,
  Yasuhiko Okada,       Yoichi Kunihiro,      Yoshihiro Yoshimura,
  Yukiko Kajino			    Yasuharu Nishi



--- Code reuse ---  
  We try to follow as much as possibile the following principle:
       Do not reinvent the wheel.
  We use code, and documentation from other Open Source Systems 
  (see CODE_REUSE document for details).


7. Bug Reports and Feedback
===============================================================

You may contact TestLink User Community forum at 
http://www.testlink.org/

If you found this software useful for your company please
post in forum on section "Companies using TestLink".

To submit a bug or a feature, please use ONLY our Mantis installation at 
http://www.testlink.org/mantis/

You can follow us on twitter => http://twitter.com/#!/TLOpenSource


8. Supporting our work
===============================================================

if you find TestLinl useful, think about a donation to support our work.
contact testlink.forum@gmail.com
You can donate using PayPal or Flattr


9. Regarding forum usage www.testlink.org
===============================================================

PLEASE: read this short hints before you write a topic:

:!: Use search forum before you add a new question.
:!: Did you search User or Installation manual before?
:!: Don't use the forum as a Bug Tracker - use http://mantis.testlink.org/login_page.php. 
	  Bug issues report done here will be DELETED
:!: Consider that some issues are related to Apache, browser or database instead of TestLink. Use google at first. 

      
10. Changes regarding 1.9.6,...,1.9.12,1.9.13,1.9.14,1.9.15,1.9.16
=====================================================================

1.9.17
-
-

1.9.16
- issues on step are saved on TestLink DB wth step ID
- redmine integration: reported will be testlink user creating issue.
- ADODB upgraded
- Ckeditor upgraded
  ... and more (read CHANGELOG file)


1.9.15
- plugin system by Collabnet
  ... and more (read CHANGELOG file)

1.9.14
- proxy config available for MANTISSOAP & JIRASOAP Integration


1.9.13
- new tag to allow inline images in test case summary,preconditions and steps
- new tag to allow inline images in test suite details
- new tag to allow inline images in requirement scope
- Test Step execution - Attachment management 
- Automatically copy linked bugs from previous execution to the new one
- Export Test Spec - add option to export external ID WITH PREFIX
- Improvements on JIRA integration:
  user can set values on GUI for Components,Priorities,Versions,IssueTypes 
  getting domain values from JIRA.

... and more (read CHANGELOG file)


1.9.12
Test case relations
Improvements on Issue Tracker integration (edit notes when linking)
Requirements Overview performance improvements

1.9.10
Long waited feature: execution notes & results for test steps

1.9.9
User can have two different (mutual exclusive) kind of authentication

1.9.6
10.1 Admin role can not be edit anymore

1.9.7
10.2 Reports do not use anymore Custom fields:
     CF_ESTIMATED_EXEC_TIME
     CF_EXEC_TIME
     
     Specific columns have been added to tcversions and executions tables.
10.3 Smarty 3 is the default.


11. Testlink & FreeTest
===============================================================

There is project on Brazil regarding the development of a method/process
for testing and delivering, focused on providing a method suitable for
micro/mini companies.

If you are interested you can get some info on:
http://www.freetest.net.br


12. Security
===============================================================
1.9.15
Multiple XSS and Blind SQL Injection by 
Netsparker Web Application Security Scanner.

They have also provided a free account.


1.9.12
Research team of Portcullis Computer Security Ltd
cedric (mantis.testlink.org user name)


1.9.10
We want to thanks xistence (xistence@0x90.nl) for his tests.




13. JIRA DB interface changes
===============================================================

TICKET 6028: Integration with Jira 6.1 broken. - Due to JIRA schema changes
Contribution by adnkoks
You need to change you xml configuration on TestLink, to add a new MANDATORY
property <jiraversion></jiraversion>
Without this property TestLink WILL CRASH => this is a desired behaviour


14. People/Companies supporting TestLink
===============================================================

- Bitnami
provided a VM on Cloud to do tests

- Team Cortado (Germany)
payed custom development of Long waited feature: execution notes & results for test steps,
donating feature to community (is not the first time they do this!)

- MAMP PRO


15. Miscelaneous
===============================================================
https://www.owasp.org/index.php/Cross-Site_Request_Forgery_(CSRF)_Prevention_Cheat_Sheet

Hitek School (http://www.hitekschool.com/)
 - Group of students help to test TestLink

Wellington Institute of Technology (www.weltec.ac.nz)
 - Group of studente is working on creating automation infrastructure to test TestLink


16. Use forum.testlink.org
===============================================================
Informantion has been collected with user's help

FAQ & HINTS 
- http://forum.testlink.org/viewforum.php?f=14

TestLink 1.9.4 and greater , News,changes, etc
- http://forum.testlink.org/viewforum.php?f=25

How to get the answer (self service)
- http://forum.testlink.org/viewtopic.php?f=50&t=7798

17. User cries: I WANT HELP !!!
==============================================================
Relax, as usual I've to say the resources are limited,
that this effort is not supported by a company or a foundation
but is result of usage of free time.

Guidelines for getting help and/or solving a situation are what I use everyday:
First try for yourself searching on:
- mantis.testlink.org
- forum.testlink.org
- https://github.com/TestLinkOpenSourceTRMS/testlink-documentation/wiki/Execution-Feature---Configuration
- https://github.com/TestLinkOpenSourceTRMS/testlink-documentation/wiki/Execution-Feature---Test-Step-Execution-configuration

Please do not operate on lazy mode: just asking.
First thing will be always asked will be:
- have you already did some searches ?

When you report a potential issue on a TestLink version,
first thing that will be requested will be the 30minTest:
- get latest code from github, do fresh install, retest & provide feedback.

Do not send PRIVATE email to ask for things that have to be PUBLIC
this is a bad approach.
Use PRIVATE CHANNELS only on Dev Team Request.

If you need more specialized help, it can be provided paying for it.

18. Use Mantis documentation
CHANGE LOG
http://mantis.testlink.org/changelog_page.php

TICKET with available fixes for latest stable version (1.9.16)
http://mantis.testlink.org/view.php?id=7817

19. Link to GITORIOUS COMMITS
Time ago we have migrated from Gitorious (thanks a lot for all years  of free repo) to Github.
On tickets or documentation that belong to the GITORIOUS ERA you will find LINK to commits that are not accessible ANYMORE AS IS.
But accessing to SAME COMMITS in GITHUB (THE COMMIT ID DO NOT CHANGE)
is just a matter of understand how to change the URL Part that is present BEFORE the commit ID. => then Nike => Just DO IT