SAFS TestLink Integration

Current Public Development/TestBed: SAFSWorks TestLink
Current TestLink Version: 1.9.5
Current Database: MySQL

Key SAFS Assets

• .\custom_config.inc.php

• .\gui\templates\testcases\inc_SAFS_testsuite_viewer_ro.tpl
• .\gui\templates\testcases\tcSAFSStepEdit.tpl
• .\gui\templates\testcases\SAFScontainerView.tpl

• .\lib\functions\web_editor.php (may require a merge instead of a copy/overwrite)
• .\lib\functions\testsuite.class.php (may require a merge instead of a copy/overwrite)

• .\third_party\safs\safsstepeditor.class.php
• .\third_party\safs\stepeditor.html
• .\third_party\safs\resulteditor.html

Note the screenshots are intended to provide an idea of which assets make up which part of the SAFS TestLink Modifications.  As this editor is currently in-development, the actual content of the GUI may differ significantly from what is shown below.

Local Server Installation and Configuration

Local development on local web servers is possible.  To do so, the developer must have access to a web server meeting TestLink requirements for the web server, PHP, and Database.

1. Download and Install OpenSource TestLink per its installation instructions.
2. Create the TestLink Database according to TestLink install instructions.
   (We recommend using MySQL for easier cross-project support from all developers.)
3. Change default admin password and hide TestLink install directories as recommended by TestLink install instructions.

4. Configure\Merge 'custom_config.inc.php' where appropriate with entries like below:

   $tlCfg->default_language = 'en_US';
   
   $tlCfg->document_generator->company_name = 'SAFSWorks LLC';
   $tlCfg->document_generator->company_copyright = 'Copyright (C) SAFSWorks LLC';
   $tlCfg->document_generator->confidential_msg = 'GPL since 1998';
       

   and most importantly:

   $g_tpl = array('tcStepEdit' => 'tcSAFSStepEdit.tpl');
   
   $g_tl_admin_email     = 'your.email@your_company.com'; # for problem/error notification
   $g_from_email         = 'no_reply@your_company.com';  # email sender
   $g_return_path_email  = 'your.email@your_company.com';
   
   $g_log_level='DEBUG';
   
   $tlCfg->log_path = '/a/path/to/logs/testlink/'; (not public on web)
   $tlCfg->smarty_debug = false;                   (true if needed   )
   
   $tlCfg->gui->text_editor['steps_design'] = array( 'type' => 'safsstepedit');
   
   $tlCfg->results['status_code'] = array (
   	'failed'        => 'f',
   	'fail_ok'       => 'fok',
   	'blocked'       => 'b',
   	'generic'       => 'g',
   	'passed'        => 'p',
   	'not_run'       => 'n',
   	'not_available' => 'x',
   	'skipped'       => 's',
   	'unknown'       => 'u',
   	'all'           => 'a',
   	'warn'     	=> 'w',
   	'warn_ok'  	=> 'wok'
   );
   
   $tlCfg->results['status_label'] = array(
   	'failed'        => 'test_status_failure',
   	'fail_ok'       => 'test_status_failure_ok',
   	'blocked'       => 'test_status_blocked',
   	'generic'       => 'test_status_generic',
   	'passed'        => 'test_status_passed',
   	'not_run'       => 'test_status_not_run',
   	'not_available' => 'test_status_not_available',
   	'skipped' 	=> 'test_status_skipped',
   	'unknown'       => 'test_status_unknown',
   	'all'           => 'test_status_all_status',
   	'warn'       	=> 'test_status_warning',
   	'warn_ok'      	=> 'test_status_warning_ok'
   );
       

5. Copy\Merge SAFS source/common/testlink/ source files into appropriate server directories.

6. Create one or more TestLink users with 'TEST DESIGNER' roles for testing\developing editor functionality.

Public TestBed Development

Development on the public testbed requires a safsworks userid with FTP write permissions.