-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathconfig.inc.php
1505 lines (1231 loc) · 63.2 KB
/
config.inc.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/**
* TestLink Open Source Project - http://testlink.sourceforge.net/
* This script is distributed under the GNU General Public License 2 or later.
*
* Constants and configuration parameters used throughout TestLink
*
* There are included extra files:
* - your customized settings - custom_config.inc.php
* - DB access - config_db.inc.php
* - constants - const.inc.php
* - basic checking - configCheck.php
*
* IMPORTANT:
* To adapt values to your needs DO NOT EDIT THIS FILE but use custom_config.inc.php and
* replace values of TestLink configuration variables.
* It saves your changes for the next upgrade in one extra file.
*
* @filesource config.inc.php
* @package TestLink
* @copyright 2005-2011, TestLink community
* @link http://www.teamst.org/index.php
*
* @internal revisions
* 20110530 - Julian - allow to define seperate logo for generated documents including height
* 20110414 - franciscom - moved $g_prefix_name_for_copy BEFORE use of custom config
* 20110409 - franciscom - BUGID 4368: Provide WYSIWYG Editor for platform notes
* $tlCfg->platform_template
* 20110323 - franciscom - BUGID 4025: option to avoid that obsolete test cases can be added
* to new test plans. -> $tlCfg->tplanDesign
* 20110319 - franciscom - BUGID 4322: New Option to block delete of executed test cases.
* testcase_cfg->can_delete_executed
* 20110109 - franciscom - added $tlCfg->req_cfg->duplicated_name_algorithm
* $tlCfg->req_cfg->duplicated_docid_algorithm
* 20110101 - franciscom - new config options for PHPMAILER
* 20101212 - franciscom - req_cfg->log_message_len
* 20101130 - Julian - BUGID 4027: set default height of ckeditor to 300
* 20101122 - amitkhullar - BUGID 3998: added ckeditor option instead of fckeditor.
* 20101118 - asimon - BUGID 4031: added $tlCfg->req_cfg->copy_req_scope_to_tc_summary
* 20101109 - asimon - added $tlCfg->custom_fields->show_custom_fields_without_value
* 20101030 - franciscom - bullet image config removed
* 20101028 - Julian - BUGID 3950 - added $tlCfg->gui->dynamic_quick_tcase_search_input_size
* 20101014 - Julian - BUGID 3893 - added $tlCfg->metrics_dashboard->show_test_plan_status
* 20101010 - franciscom - BUGID 3872 - Admin should be able to set a new password for users - $tlCfg->password_reset_send_method
* 20100924 - asimon - added $tlCfg->enableTableExportButton
* 20100915 - amitkhullar - BUGID 3639 - added $tlcfg->testcase_reorder_by for Reorder Test Cases
* 20100915 - Julian - BUGID 3777 - added $tlCfg->req_cfg->allow_insertion_of_last_doc_id
* 20100901 - asimon - re-enabled filter for assigned user when assigning testcases
* 20100814 - franciscom - BUGID 3681 - new BTS youtrack (www.jetbrains.com)
* 20100810 - asimon - BUGID 3317 - added $tlCfg->req_cfg->external_req_management
* 20100810 - asimon - added TC ID filter for Test Cases to $tlCfg->tree_filter_cfg
* 20100809 - asimon - BUGID 3662 - disabled advanced filter mode choice for TC editing mode
* 20100808 - asimon - added requirement filtering options to $tlCfg->tree_filter_cfg
* 20100625 - asimon - added $tlCfg->tree_filter_cfg for configuration of available filters on JS tree
* and $tlCfg->exec_cfg->testcases_colouring_by_selected_build for BUGID 3450
* 20100620 - franciscom - fix strict messages after usign PHPDesigner.
* 20100619 - franciscom - define always $g_bugInterfaceOn = false,$g_bugInterface = null;
* 20100617 - franciscom - $tlCfg->req_cfg->importDocBook - new configuration for importing req in docbook format
* 20100616 - eloff - BUGID 3255 - Cleaned up bts configuration
* 20100527 - Julian - added $tlCfg->exec_cfg->expand_collapse->platform_description
* 20100504 - franciscom - BUGID 3424 Custom CSS path is being overwritten by config.inc.php value
* 20100311 - asimon - BUGID 1748 - $tlCfg->req_cfg->relations
* 20100313 - franciscom - BUGID 0003275
* 20100112 - asimon - BUGID 2976 - $tlCfg->req_cfg->search
* 20100110 - eloff - BUGID 2036 - changed $tlCfg->gui->checkNotSaved to true
* 20100106 - franciscom - added $tlCfg->diffEngine - diff for test case and req (Contribution)
*
**/
// ----------------------------------------------------------------------------
/* [INITIALIZATION] - DO NOT CHANGE THE SECTION */
/** @global array Global configuration class */
$tlCfg = new stdClass();
$tlCfg->api = new stdClass();
$tlCfg->document_generator = new stdClass();
$tlCfg->spec_cfg = new stdClass();
$tlCfg->exec_cfg = new stdClass();
$tlCfg->exec_cfg->view_mode = new stdClass();
$tlCfg->exec_cfg->exec_mode = new stdClass();
$tlCfg->gui = new stdClass();
$tlCfg->gui->custom_fields = new stdClass();
$tlCfg->testcase_cfg = new stdClass();
$tlCfg->req_cfg = new stdClass();
$tlCfg->validation_cfg = new stdClass();
$tlCfg->custom_fields = new stdClass();
$tlCfg->req_spec_cfg = new stdClass();
$tlCfg->diffEngine = new stdClass();
$tlCfg->tplanDesign = new stdClass();
/** @uses database access definition (generated automatically by TL installer) */
/** @uses database access definition (generated automatically by TL installer) */
@include_once('config_db.inc.php');
if( !defined('DB_TABLE_PREFIX') )
{
define('DB_TABLE_PREFIX','' );
}
/** The root dir for the testlink installation with trailing slash */
define('TL_ABS_PATH', dirname(__FILE__) . DIRECTORY_SEPARATOR);
/** Include constants and magic numbers (users should not change it)*/
require_once(TL_ABS_PATH . 'cfg' . DIRECTORY_SEPARATOR . 'const.inc.php');
// ----------------------------------------------------------------------------
/* [LOCALIZATION] */
/** @var string Default localization for users */
// The value must be available in $g_locales (see cfg/const.inc.php).
// Note: An attempt will be done to establish the default locale
// automatically using $_SERVER['HTTP_ACCEPT_LANGUAGE']
$tlCfg->default_language = 'en_GB';
/**
* @var string Charset 'UTF-8' is only officially supported charset (Require
* MySQL version >= 4.1) 'ISO-8859-1' or another Charset could be set for
* backward compatability by experienced users. However we have not resources
* to support such patches.
**/
$tlCfg->charset = 'UTF-8';
/**
* @var string characters used to surround a description in the user interface
* (for example role)
**/
$tlCfg->gui_separator_open = '[';
$tlCfg->gui_separator_close = ']';
/** @var string Title separators are used when componing an title using several strings */
$tlCfg->gui_title_separator_1 = ' : '; // object : name (Test Specification : My best product)
$tlCfg->gui_title_separator_2 = ' - '; // parent - child
/**
* @var string delimiter used to create DOC ID in this way:
* <test_project_Prefix> . g_testcase_cfg->glue_character . <doc_id>
* Could not be empty
*/
$tlCfg->testcase_cfg->glue_character = '-';
/**
* fonts set used to draw charts
**/
$tlCfg->charts_font_path = TL_ABS_PATH . "third_party/pchart/Fonts/tahoma.ttf";
/**
* font size used to draw charts
**/
$tlCfg->charts_font_size = 8;
// ----------------------------------------------------------------------------
/* [SERVER ENVIRONMENT] */
/**
* @var integer Set the session timeout for inactivity [minutes].
* Default high value disables this feature.
*/
$tlCfg->sessionInactivityTimeout = 9900;
/**
* Set the session timeout value (in minutes).
* This will prevent sessions timing out after very short periods of time
* Warning: your server could block this settings
**/
//ini_set('session.cache_expire',900);
/**
* Set the session garbage collection timeout value (in seconds)
* The default session garbage collection in php is set to 1440 seconds (24 minutes)
* If you want sessions to last longer this must be set to a higher value.
* You may need to set this in your global php.ini if the settings don't take effect.
*/
//ini_set('session.gc_maxlifetime', 54000);
// ----------------------------------------------------------------------------
/* [LOGGING] */
/** Error reporting - do we want php errors to show up for users */
error_reporting(E_ALL);
/** @var string Default level of logging (NONE, ERROR, INFO, DEBUG, EXTENDED) */
$tlCfg->log_level = 'ERROR';
/** @var boolean show smarty debug window */
$tlCfg->smarty_debug = false;
/** @var string Path to store logs */
$tlCfg->log_path = TL_ABS_PATH . 'logs' . DIRECTORY_SEPARATOR ;
/**
* @var string How to warning user when security weak points exists.
*
* 'SCREEN': messages will displayed on login screen, and tl desktop (default)
* 'FILE': a file with a list is created but users are not notified via GUI
* user will receive a message on screen.
* 'SILENT': same that FILE, but user will not receive message on screen.
*/
$tlCfg->config_check_warning_mode = 'FILE';
/**
* Configure if individual logging data stores are enabled of disabled
* Possibile values to identify loggers: 'db','file'
* $g_loggerCfg=null; all loggers enabled (default)
* $g_loggerCfg['db']['enable']=true/false;
* $g_loggerCfg['file']['enable']=true/false;
*/
$g_loggerCfg = null;
/** @var integer All events older this value [days] are removed from the db, during login */
$g_removeEventsOlderThan = 30;
// ----------------------------------------------------------------------------
/* [Bug Tracking systems] */
/**
* TestLink collaborates with bug tracking systems to check if displayed bugs resolved,
* verified, and closed reports.
*
* Note: Use this option to check if a bug interface is enabled, if so every
* page using bug tracking MUST include int_bugtracking.php to make the
* connection. The variable bugInterfaceOn is only set when a connection is made
*
* @var string $g_interface_bugs = [
* 'NO' : no bug tracking system integration (DEFAULT)
* 'BUGZILLA' : edit configuration in TL_ABS_PATH/cfg/bugzilla.cfg.php
* 'MANTIS' : edit configuration in TL_ABS_PATH/cfg/mantis.cfg.php
* 'JIRA' : edit configuration in TL_ABS_PATH/cfg/jira.cfg.php
* 'JIRASOAP' : edit configuration in TL_ABS_PATH/cfg/jira.cfg.php
* 'TRACKPLUS' : edit configuration in TL_ABS_PATH/cfg/trackplus.cfg.php
* 'EVENTUM' : edit configuration in TL_ABS_PATH/cfg/eventum.cfg.php
* 'SEAPINE' : edit configuration in TL_ABS_PATH/cfg/seapine.cfg.php
* 'GFORGE' : edit configuration in TL_ABS_PATH/cfg/gforge.cfg.php
* 'FOGBUGZ' : edit configuration in TL_ABS_PATH/cfg/fogbugz.cfg.php
* 'YOUTRACK' : edit configuration in TL_ABS_PATH/cfg/youtrack.cfg.php
* 'POLARION' : edit configuration in TL_ABS_PATH/cfg/polarion.cfg.php
* ]
*/
$g_interface_bugs = 'NO';
// do not change this
$g_bugInterfaceOn = false;
$g_bugInterface = null;
// ----------------------------------------------------------------------------
/* [SMTP] */
/**
* @var string SMTP server name or IP address ("localhost" should work in the most cases)
* Configure using custom_config.inc.php
* @uses lib/functions/email_api.php
*/
$g_smtp_host = '[smtp_host_not_configured]'; # SMTP server MUST BE configured
# Configure using custom_config.inc.php
$g_tl_admin_email = '[testlink_sysadmin_email_not_configured]'; # for problem/error notification
$g_from_email = '[from_email_not_configured]'; # email sender
$g_return_path_email = '[return_path_email_not_configured]';
/**
* Email notification priority (low by default)
* Urgent = 1, Not Urgent = 5, Disable = 0
**/
$g_mail_priority = 5;
/**
* Taken from mantis for phpmailer config
* select the method to mail by:
* PHPMAILER_METHOD_MAIL - mail()
* PHPMAILER_METHOD_SENDMAIL - sendmail
* PHPMAILER_METHOD_SMTP - SMTP
*/
$g_phpMailer_method = PHPMAILER_METHOD_SMTP;
/** Configure only if SMTP server requires authentication */
$g_smtp_username = ''; # user
$g_smtp_password = ''; # password
/**
* This control the connection mode to SMTP server.
* Can be '', 'ssl','tls'
* @global string $g_smtp_connection_mode
*/
$g_smtp_connection_mode = '';
/**
* The smtp port to use. The typical SMTP ports are 25 and 587. The port to use
* will depend on the SMTP server configuration and hence others may be used.
* @global int $g_smtp_port
*/
$g_smtp_port = 25;
// ----------------------------------------------------------------------------
/* [User Authentication] */
/**
* Login authentication method:
* 'MD5' => use password stored on db
* 'LDAP' => use password from LDAP Server
*/
$tlCfg->authentication['method'] = 'MD5';
/** LDAP authentication credentials */
$tlCfg->authentication['ldap_server'] = 'localhost';
$tlCfg->authentication['ldap_port'] = '389';
$tlCfg->authentication['ldap_version'] = '3'; // could be '2' in some cases
$tlCfg->authentication['ldap_root_dn'] = 'dc=mycompany,dc=com';
$tlCfg->authentication['ldap_organization'] = ''; // e.g. '(organizationname=*Traffic)'
$tlCfg->authentication['ldap_uid_field'] = 'uid'; // Use 'sAMAccountName' for Active Directory
$tlCfg->authentication['ldap_bind_dn'] = ''; // Left empty for anonymous LDAP binding
$tlCfg->authentication['ldap_bind_passwd'] = ''; // Left empty for anonymous LDAP binding
$tlCfg->authentication['ldap_tls'] = false; // true -> use tls
/** Enable/disable Users to create accounts on login page */
$tlCfg->user_self_signup = TRUE;
/** What happens when Administrator push the Reset Password Button
'send_password_by_mail'
'display_on_screen'
*/
$tlCfg->password_reset_send_method = 'send_password_by_mail';
/** Validating new user login names */
$tlCfg->validation_cfg->user_login_valid_regex='/^[\w \- .]+$/';
/**
* Validating user email addresses
* Example of other possibilities:
* <code>
* $regex = "/^[a-z0-9!#$%&'*+\/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+\/=?^_`{|}~-]+)*" .
* "@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$/i";
* $regex = "/^([\w]+)(.[\w]+)*@([\w-]+\.){1,5}([A-Za-z]){2,4}$/";
* </code>
**/
// This expression does not allow Top Level Domian (last part of domain name) longer than 4
// If you need to change this
// Configure this on custom_config.inc.php
$tlCfg->validation_cfg->user_email_valid_regex_js = "/^(\w+)([-+.][\w]+)*@(\w[-\w]*\.){1,5}([A-Za-z]){2,4}$/";
$tlCfg->validation_cfg->user_email_valid_regex_php = "/^([\w]+)(.[\w]+)*@([\w-]+\.){1,5}([A-Za-z]){2,4}$/U";
// --------------------------------------------------------------------------------------
/* [API] */
/** XML-RPC API availability (disabled by default) */
$tlCfg->api->enabled = FALSE;
// used to display API ID info in the *View pages
$tlCfg->api->id_format = "[ID: %s ]";
// --------------------------------------------------------------------------------------
/* [GUI LAYOUT] */
/** GUI themes (base for CSS and images)- modify if you create own one */
$tlCfg->theme_dir = 'gui/themes/default/';
/** Dir for compiled templates */
$tlCfg->temp_dir = TL_ABS_PATH . 'gui' . DIRECTORY_SEPARATOR . 'templates_c' . DIRECTORY_SEPARATOR;
/** Company logo (used by navigation bar and login page page) */
//$tlCfg->company_logo = '<img alt="TestLink" title="TestLink" style="width: 115px; height: 53px;" src="' .
// $tlCfg->theme_dir . 'images/company_logo.png" />';
$tlCfg->company_logo = 'company_logo.png';
/** Login page could show an informational text */
$tlCfg->login_info = ''; // Empty by default
/**
* @var string Availability of Test Project specific background colour
* 'background' -> standard behaviour for 1.6.x you can have a different
* background colour for every test project.
* 'none' -> new behaviour no background color change
*/
$tlCfg->gui->testproject_coloring = 'none'; // I'm sorry default is not coloring using coloring is a pain
// and useless
/** @TODO havlatm4francisco Ok, then merge these two attributes into one */
/** default background color */
$tlCfg->gui->background_color = '#9BD';
// ENABLED: on features that assign user role to test projects and test plan, colour user name
// according GLOBAL role
// DISABLED: do not color [STANDARD BEHAVIOUR]
$tlCfg->gui->usersAssignGlobalRoleColoring = DISABLED;
// Enable/disable rounded corners via javascript
$tlCfg->gui->round_corners = new stdClass();
$tlCfg->gui->round_corners->exec_history = ENABLED;
$tlCfg->gui->round_corners->tc_title = ENABLED;
$tlCfg->gui->round_corners->tc_spec = ENABLED;
/**
* Display name definition (used to build a human readable display name for users)
* Example of values:
* '%first% %last%' -> John Cook
* '%last%, %first%' -> Cook John
* '%first% %last% %login%' -> John Cook [ux555]
**/
$tlCfg->username_format = '%login%';
/** Configure the frame frmWorkArea navigator width */
$tlCfg->frame_workarea_default_width = "30%";
/** true => icon edit will be added into <a href> as indication an edit features */
$tlCfg->gui->show_icon_edit = false;
/**
* Order to use when building:
* test project combobox (value must be SQL compliant)
* list of test projects on test project view feature
*
* IS CRITIC that order be the SAME on combo and list on project view because context logic
* (test project id is context) dependends on this.
*
* For example:
* 'ORDER BY name'
* 'ORDER_BY nodes_hierarchy.id DESC' -> similar effect to order last created firts
**/
$tlCfg->gui->tprojects_combo_order_by = 'ORDER BY nodes_hierarchy.id DESC';
/** Configure the input size of test case search by id on navigation bar.
* This value will be added to the length of the prefix to dynamically set input size.
* Example: prefix is "projectA-" -> length of prefix is 9
* Now the here defined value (default: 6) will be added to the prefix length
* -> Input field will have an input size of 15
**/
$tlCfg->gui->dynamic_quick_tcase_search_input_size = 6;
// used to round percentages on metricsDashboard.php
$tlCfg->dashboard_precision = 2;
/**
* Choose what kind of webeditor you want to use in every TL area. This configuration
* will be used if no element with search key (area) is found on this structure.
* Every element is a mp with this configuration keys:
*
* 'type':
* 'ckeditor'
* 'fckeditor'
* 'tinymce'
* 'none' -> use plain text area input field
* 'toolbar': only applicable for type 'fckeditor' and 'ckeditor'
* TestLink stores toolbar definitions in <testlink_dir>/cfg/tl_fckeditor_config.js for fckeditor
* TestLink stores toolbar definitions in <testlink_dir>/cfg/tl_ckeditor_config.js for ckeditor
* 'configFile': only applicable for type 'fckeditor' and 'ckeditor'
* default for fckeditor: 'cfg/tl_fckeditor_config.js'
* default for ckeditor: 'cfg/tl_ckeditor_config.js'
* 'height': the height in px for fckeditor and ckeditor
* 'width': the width in px for FCKEditor and ckeditor
* 'cols': the number of cols for tinymce and none
* 'rows': the number of rows for tinymce and none
*
* The next keys/areas are supported:
* 'all' (default setting),
* 'design', 'steps_design', 'testplan', 'build', 'testproject', 'role', 'requirement', 'requirement_spec'.
*
* Examples:
* <code>
* // Copy this to custom_config.inc.php if you want use 'tinymce' as default.
* $tlCfg->gui->text_editor['all'] = array( 'type' => 'tinymce');
* // Copy this to custom_config.inc.php if you want use 'nome' as default.
* $tlCfg->gui->text_editor['all'] = array( 'type' => 'none');
* //This configuration is useful only if default type is set to 'fckeditor'
* $tlCfg->gui->text_editor['design'] = array('toolbar' => 'tl_mini');
*
* $tlCfg->gui->text_editor['testplan'] = array( 'type' => 'none');
* $tlCfg->gui->text_editor['build'] = array( 'type' => 'fckeditor','toolbar' => 'tl_mini');
* $tlCfg->gui->text_editor['testproject'] = array( 'type' => 'tinymce');
* $tlCfg->gui->text_editor['role'] = array( 'type' => 'tinymce');
* $tlCfg->gui->text_editor['requirement'] = array( 'type' => 'none');
* $tlCfg->gui->text_editor['requirement_spec'] = array( 'type' => 'none');
* </code>
*
* Hint: After doing configuration changes, clean you Browser's cookies and cache!
*/
$tlCfg->gui->text_editor = array();
/* $tlCfg->gui->text_editor['all'] = array('type' => 'fckeditor',
'toolbar' => 'tl_default',
'configFile' => 'cfg/tl_fckeditor_config.js'); */
// Enabled the line below to switch to the ckeditor and disabled the line above.
$tlCfg->gui->text_editor['all'] = array('type' => 'ckeditor',
'toolbar' => 'Testlink',
'configFile' => 'cfg/tl_ckeditor_config.js',
'height' => 300);
// BUGID 4163: mini toolbar for test case steps edit
$tlCfg->gui->text_editor['steps_design'] = array('type' => 'ckeditor',
'toolbar' => 'TestlinkMini',
'configFile' => 'cfg/tl_ckeditor_config.js',
'height' => 200);
$tlCfg->gui->text_editor['execution'] = array('type' => 'none');
/** User can choose order of menu areas */
$tlCfg->gui->layoutMainPageLeft = array('testProject' => 1, 'userAdministration' => 2,
'requirements' => 3, 'testSpecification' => 4,
'general' => 5);
$tlCfg->gui->layoutMainPageRight = array('testPlan' => 1, 'testExecution' => 2,
'testPlanContents' => 3);
/**
* Enable warning on a changed content before an user leave a page.
*
* Tested in:
* - IE8 OK
* - Firefox 3 OK
* - Chrome FAIL
*
* Does not work in Webkit browsers (Chrome, Safari) when using frames.
* Bug in webkit: https://bugs.webkit.org/show_bug.cgi?id=19418
*/
// franciscom -
// BUGID 0003275 + post on forum: // http://www.teamst.org/phpBB2/viewtopic.php?t=3075
// seems that with config options that will be used on javascript via smarty template variables
// we are having problems using FALSE/TRUE => use 0/1 (or our CONSTANT DISABLED/ENABLED)
$tlCfg->gui->checkNotSaved = ENABLED;
// ----------------------------------------------------------------------------
/* [GUI: TREE] */
/** Default ordering value for new Test Suites and Test Cases to separate them */
$tlCfg->treemenu_default_testsuite_order = 1;
$tlCfg->treemenu_default_testcase_order = 100;
/** show/hide testcase id on tree menu */
$tlCfg->treemenu_show_testcase_id = TRUE;
/** Reorder test cases based on TC Name or External ID in tree on
* test suite level using reorder button
*/
// 'EXTERNAL_ID' -> Sort on Test Case External ID field displayed on tree.(Default)
// 'NAME' -> Sort on Test Case Name field
$tlCfg->testcase_reorder_by = 'EXTERNAL_ID';
// $tlCfg->testcase_reorder_by = 'NAME';
// ----------------------------------------------------------------------------
/* [GUI: Javascript libraries] */
// May be in future another table sort engine will be better
// kryogenix.org -> Stuart Langridge sortTable
// '' (empty string) -> disable table sorting feature
$g_sort_table_engine='kryogenix.org';
// --------------------------------------------------------------------------------------
/* [Reports] */
$tlCfg->reportsCfg=new stdClass();
/** @TODO unfinished changes by Francisco? */
//Displayed execution statuses to use on reports (ordered). */
$tlCfg->reportsCfg->exec_status = $tlCfg->results['status_label_for_exec_ui'];
/**
* Default Offset in seconds for reporting start date (reports with date range)
* @uses lib/results/resultsMoreBuilds.php
*/
$tlCfg->reportsCfg->start_date_offset = (7*24*60*60); // one week
// minutes part is ignored but must be configured.
// Hint: set always to :00
$tlCfg->reportsCfg->start_time = '00:00';
// Result matrix (resultsTC.php)
// Shows an extra column which gives the status of the last executed build
$tlCfg->resultMatrixReport->buildColumns['showStatusLastExecuted'] = true;
// Show build columns in revers order. The latest build is to the left
$tlCfg->resultMatrixReport->buildColumns['latestBuildOnLeft'] = false;
// Show all available status details for test plans on metrics dashboard
$tlCfg->metrics_dashboard = new stdClass();
$tlCfg->metrics_dashboard->show_test_plan_status = false;
// ----------------------------------------------------------------------------
/* [GENERATED DOCUMENTATION] */
/**
* Texts and settings for printed documents
* Image is expected in directory <testlink_root>/gui/themes/<your_theme>/images/
* Leave text values empty if you would like to hide parameters.
*/
$tlCfg->document_generator->company_name = 'TestLink Community [configure $tlCfg->document_generator->company_name]';
$tlCfg->document_generator->company_copyright = '2009 © TestLink Community';
$tlCfg->document_generator->confidential_msg = '';
// Logo for generated documents
$tlCfg->document_generator->company_logo = 'company_logo.png';
$tlCfg->document_generator->company_logo_height = '53';
/** CSS used in printed html documents */
// $tlCfg->document_generator->css_template = $tlCfg->theme_dir . 'css/tl_documents.css';
// CSS file for Test Specification Document, Test Plan Report, Test Report and Test Case Print View
$tlCfg->document_generator->css_template = 'css/tl_documents.css';
// CSS file for Requirement Specification Document, Requirement and Requirement Spec Print View
$tlCfg->document_generator->requirement_css_template = 'css/tl_documents.css';
/** Misc settings */
// Display test case version when creating test spec document
$tlCfg->document_generator->tc_version_enabled = FALSE;
// ----------------------------------------------------------------------------
/* [Test Executions] */
// ENABLED -> enable XML-RPC calls to external test automation server
// new buttons will be displayed on execution pages
// DISABLED -> disable
$tlCfg->exec_cfg->enable_test_automation = DISABLED;
// 1 -> user can edit execution notes, on old executions (Attention: user must have test case execution right)
// DISABLED -> no edit allowed [STANDARD BEHAVIOUR]
$tlCfg->exec_cfg->edit_notes = DISABLED;
// ASCending -> last execution at bottom
// DESCending -> last execution on top [STANDARD BEHAVIOUR]
$tlCfg->exec_cfg->history_order = 'DESC';
// TRUE -> the whole execution history for the choosen build will be showed
// FALSE -> just last execution for the choosen build will be showed [STANDARD BEHAVIOUR]
$tlCfg->exec_cfg->history_on = FALSE;
// TRUE -> test case VERY LAST (i.e. in any build) execution status will be displayed [STANDARD BEHAVIOUR]
// FALSE -> only last result on current build.
$tlCfg->exec_cfg->show_last_exec_any_build = TRUE;
// TRUE -> History for all builds will be shown
// FALSE -> Only history of the current build will be shown [STANDARD BEHAVIOUR]
$tlCfg->exec_cfg->show_history_all_builds = FALSE;
// TRUE -> History for all platforms (if any exists for test plan) will be shown
// FALSE -> Only history of the current platform will be shown [STANDARD BEHAVIOUR]
$tlCfg->exec_cfg->show_history_all_platforms = FALSE;
// different models for the attachments management on execution page
// $att_model_m1 -> shows upload button and title
// $att_model_m2 -> hides upload button and title
$tlCfg->exec_cfg->att_model = $att_model_m2; //defined in const.inc.php
// ENABLED -> User can delete an execution result
// DISABLED -> User can not. [STANDARD BEHAVIOUR]
$tlCfg->exec_cfg->can_delete_execution = DISABLED;
// ENABLED -> test cases will be coloured according to test case status
$tlCfg->exec_cfg->enable_tree_testcases_colouring = ENABLED;
// ENABLED -> test cases will be coloured according to execution status on build selected for execution
// DISABLED -> test cases will be coloured according status on latest execution regardless of selected build
// see http://mantis.testlink.org/view.php?id=3450 for more details
$tlCfg->exec_cfg->testcases_colouring_by_selected_build = ENABLED;
// ENABLED -> test case counters will be coloured according to test case status
$tlCfg->exec_cfg->enable_tree_counters_colouring = ENABLED;
// 20080303 - franciscom
// This can help to avoid performance problems.
// Controls what happens on right frame when user clicks on a testsuite on tree.
// ENABLED -> show all test cases presents on test suite and children test suite.
// DISABLED -> nothing happens, to execute a test case you need to click on test case
$tlCfg->exec_cfg->show_testsuite_contents = DISABLED;
// ENABLED -> enable testcase counters by status on tree
$tlCfg->exec_cfg->enable_tree_testcase_counters = ENABLED;
// Define list of roles that are affected by:
// $tlCfg->exec_cfg->view_mode and $tlCfg->exec_cfg->exec_mode
// User must reconfigure if define other simple tester roles
//
// In addition (till code changes) also roles that verify this condition:
// $effective_role->hasRight('testplan_execute') and !$effective_role->hasRight('testplan_planning')
// Will be affected by:
// $tlCfg->exec_cfg->view_mode and $tlCfg->exec_cfg->exec_mode
//
$tlCfg->exec_cfg->simple_tester_roles=array(TL_ROLES_TESTER);
// Filter Test cases a user with tester role can VIEW depending on
// test execution assignment.
// all: all test cases.
// assigned_to_me: test cases assigned to logged user.
// assigned_to_me_or_free: test cases assigned to logged user or not assigned
$tlCfg->exec_cfg->view_mode->tester='assigned_to_me';
// Filter Test cases a user with tester role can EXECUTE depending on
// test execution assignment.
// all: all test cases.
// assigned_to_me: test cases assigned to logged user.
// assigned_to_me_or_free: test cases assigned to logged user or not assigned
$tlCfg->exec_cfg->exec_mode->tester='assigned_to_me';
/** User filter in Test Execution navigator - default value */
// logged_user -> combo will be set to logged user
// none -> no filter applied by default
$tlCfg->exec_cfg->user_filter_default='none';
// 'horizontal' -> step and results on the same row
// 'vertical' -> steps on one row, results in the row bellow
$tlCfg->exec_cfg->steps_results_layout = 'horizontal';
// Parameters to show notes/details when entering test execution feature
// EXPAND: show expanded/open
// COLLAPSE: show collapsed/closede
// LAST_USER_CHOICE: get status from cookie that holds last user choice.[STANDARD BEHAVIOUR]
$tlCfg->exec_cfg->expand_collapse = new stdClass();
$tlCfg->exec_cfg->expand_collapse->testplan_notes = LAST_USER_CHOICE;
$tlCfg->exec_cfg->expand_collapse->platform_description = LAST_USER_CHOICE;
$tlCfg->exec_cfg->expand_collapse->build_description = LAST_USER_CHOICE;
$tlCfg->exec_cfg->expand_collapse->testsuite_details = LAST_USER_CHOICE;
// ----------------------------------------------------------------------------
/* [Test Specification] */
// $g_spec_cfg = new stdClass();
// 'horizontal' -> step and results on the same row
// 'vertical' -> steps on one row, results in the row bellow
// $g_spec_cfg->steps_results_layout = 'vertical';
$tlCfg->spec_cfg->steps_results_layout = 'horizontal';
// ENABLED -> User will see a test suite filter while creating test specification
// DISABLED -> no filter available
// $g_spec_cfg->show_tsuite_filter = ENABLED;
$tlCfg->spec_cfg->show_tsuite_filter = ENABLED;
// ENABLED -> every time user do some operation on test specification
// tree is updated on screen.
// DISABLED -> tree will not be updated, user can update it manually.
// Anyway on user interface user will be able to change this choice
// $g_spec_cfg->automatic_tree_refresh = ENABLED;
$tlCfg->spec_cfg->automatic_tree_refresh = ENABLED;
// ENABLED -> user can edit executed tc versions
// DISABLED -> editing of executed tc versions is blocked. [STANDARD BEHAVIOUR]
$tlCfg->testcase_cfg->can_edit_executed = DISABLED;
// ENABLED -> user can removed from a testplan executed tc versions. [STANDARD BEHAVIOUR]
// DISABLED -> user can NOT remove from a testplan executed tc versions.
$tlCfg->testcase_cfg->can_remove_executed = ENABLED;
// ENABLED -> user can DELETE a TEST CASE that has been executed.
// DISABLED -> [STANDARD BEHAVIOUR]
// IMPORTANT: this is valid for any role => admin is also under this law.
$tlCfg->testcase_cfg->can_delete_executed = DISABLED;
// To avoid perfomance problems on search test case feature,
// we can decide when to inform user that results can not be displayed
// due to too many results.
$tlCfg->testcase_cfg->search=new stdClass();
$tlCfg->testcase_cfg->search->max_qty_for_display=200;
$tlCfg->testcase_cfg->duplicated_name_algorithm = new stdClass();
// 'stringPrefix' => use duplicated_name_algorithm->text
// 'counterSuffix' => creare name as :
// test case title + (number of existent test cases +1)
// example: My Test Title 2
// duplicated_name_algorithm->text is used as sprintf format mask
$tlCfg->testcase_cfg->duplicated_name_algorithm->type = 'stringPrefix';
$tlCfg->testcase_cfg->duplicated_name_algorithm->text = strftime("%Y%m%d-%H:%M:%S", time());
// $tlCfg->testcase_cfg->duplicated_name_algorithm->type = 'counterSuffix';
// $tlCfg->testcase_cfg->duplicated_name_algorithm->text = " (%s)";
/** text template for a new items:
Test Case: summary, steps, expected_results, preconditions
*/
// object members has SAME NAME that FCK editor objects.
// the logic present on tcEdit.php is dependent of this rule.
// every text object contains an object with following members: type and value
//
// Possible values for type member:
// none: template will not be used, default will be a clean editor screen.
//
// string: value of value member is assigned to FCK object
// string_id: value member is used in a lang_get() call, and return value
// is assigned to FCK object. Configure string_id on custom_strings.txt
// file: value member is used as file name.
// file is readed and it's contains assigned to FCK object
//
// any other value for type, results on '' assigned to FCK object
$tlCfg->testcase_template = new stdClass();
$tlCfg->testcase_template->summary = new stdClass();
$tlCfg->testcase_template->summary->type = 'none';
$tlCfg->testcase_template->summary->value = '';
$tlCfg->testcase_template->steps = new stdClass();
$tlCfg->testcase_template->steps->type = 'none';
$tlCfg->testcase_template->steps->value = '';
$tlCfg->testcase_template->expected_results = new stdClass();
$tlCfg->testcase_template->expected_results->type = 'none';
$tlCfg->testcase_template->expected_results->value = '';
$tlCfg->testcase_template->preconditions = new stdClass();
$tlCfg->testcase_template->preconditions->type = 'none';
$tlCfg->testcase_template->preconditions->value = '';
/** text template for a new Test Suite description */
$tlCfg->testsuite_template = new stdClass();
$tlCfg->testsuite_template->details = new stdClass();
$tlCfg->testsuite_template->details->type = 'none';
$tlCfg->testsuite_template->details->value = '';
// Contribution - Julian (Refactore)
// BUGID 0002968,0002961,0002962,0002963
$tlCfg->project_template = new stdClass();
$tlCfg->project_template->notes = new stdClass();
$tlCfg->project_template->notes->type = 'none';
$tlCfg->project_template->notes->value = '';
$tlCfg->testplan_template = new stdClass();
$tlCfg->testplan_template->notes = new stdClass();
$tlCfg->testplan_template->notes->type = 'none';
$tlCfg->testplan_template->notes->value = '';
$tlCfg->execution_template = new stdClass();
$tlCfg->execution_template->bulk_exec_notes = new stdClass();
$tlCfg->execution_template->bulk_exec_notes->type = 'none';
$tlCfg->execution_template->bulk_exec_notes->value = '';
$tlCfg->execution_template->notes = new stdClass();
$tlCfg->execution_template->notes->type = 'none';
$tlCfg->execution_template->notes->value = '';
$tlCfg->build_template = new stdClass();
$tlCfg->build_template->notes = new stdClass();
$tlCfg->build_template->notes->type = 'none';
$tlCfg->build_template->notes->value = '';
$tlCfg->requirement_template = new stdClass();
$tlCfg->requirement_template->scope = new stdClass();
$tlCfg->requirement_template->scope->type = 'none';
$tlCfg->requirement_template->scope->value = '';
$tlCfg->req_spec_template = new stdClass();
$tlCfg->req_spec_template->scope = new stdClass();
$tlCfg->req_spec_template->scope->type = 'none';
$tlCfg->req_spec_template->scope->value = '';
$tlCfg->role_template = new stdClass();
$tlCfg->role_template->notes = new stdClass();
$tlCfg->role_template->notes->type = 'none';
$tlCfg->role_template->notes->value = '';
$tlCfg->platform_template = new stdClass();
$tlCfg->platform_template->notes = new stdClass();
$tlCfg->platform_template->notes->type = 'none';
$tlCfg->platform_template->notes->value = '';
// ----------------------------------------------------------------------------
/* [ATTACHMENTS] */
/** Attachment feature availability */
$g_attachments = new stdClass();
$g_attachments->enabled = TRUE;
/** the type of the repository can be database or filesystem
* TL_REPOSITORY_TYPE_DB => database
* TL_REPOSITORY_TYPE_FS => filesystem
**/
$g_repositoryType = TL_REPOSITORY_TYPE_FS;
/**
* TL_REPOSITORY_TYPE_FS: the where the filesystem repository should be located
* We recommend to change the directory for security reason.
**/
$g_repositoryPath = TL_ABS_PATH . "upload_area" . DIRECTORY_SEPARATOR;
/**
* compression used within the repository
* TL_REPOSITORY_COMPRESSIONTYPE_NONE => no compression
* TL_REPOSITORY_COMPRESSIONTYPE_GZIP => gzip compression
*/
$g_repositoryCompressionType = TL_REPOSITORY_COMPRESSIONTYPE_NONE;
// the maximum allowed file size for each repository entry, default 1MB.
// Also check your PHP settings (default is usually 2MBs)
$tlCfg->repository_max_filesize = 1; //MB
// TRUE -> when you upload a file you can give no title
$g_attachments->allow_empty_title = TRUE;
// $g_attachments->allow_empty_title == TRUE, you can ask the system
// to do something
//
// 'none' -> just write on db an empty title
// 'use_filename' -> use filename as title
//$g_attachments->action_on_save_empty_title='use_filename';
//
$g_attachments->action_on_save_empty_title = 'none';
// Remember that title is used as link description for download
// then if title is empty, what the system has to do when displaying ?
// 'show_icon' -> the $g_attachments->access_icon will be used.
// 'show_label' -> the value of $g_attachments->access_string will be used .
$g_attachments->action_on_display_empty_title = 'show_icon';
// martin: @TODO use an image file only
// BUGID 3424 - need to be moved AFTER include of custom_config
//
// $g_attachments->access_icon = '<img src="' . $tlCfg->theme_dir . 'images/new_f2_16.png" style="border:none" />';
$g_attachments->access_string = "[*]";
// Set display order of uploaded files - BUGID 1086
$g_attachments->order_by = " ORDER BY date_added DESC ";
// ----------------------------------------------------------------------------
/* [Requirements] */
// 20101212 - truncate log message to this amount of chars for reqCompareVersions
$tlCfg->req_cfg->log_message_len = 200;
/**
* Test Case generation from Requirements - use_req_spec_as_testsuite_name
* FALSE => test cases are created and assigned to a test suite
* with name $tlCfg->req_cfg->default_testsuite_name
* TRUE => REQuirement Specification Title is used as testsuite name
*/
$tlCfg->req_cfg->use_req_spec_as_testsuite_name = TRUE;
$tlCfg->req_cfg->default_testsuite_name = "Auto-created Test cases";
$tlCfg->req_cfg->testsuite_details = "Test Cases in the Test Suite are generated from Requirements. " .
"A refinement of test scenario is highly recommended.";
$tlCfg->req_cfg->testcase_summary_prefix = "<b>The Test Case was generated from the assigned requirement.</b><br />";
// If the following value is enabled, then the summary prefix string will include the
// title and version number of the assigned requirement.
$tlCfg->req_cfg->use_testcase_summary_prefix_with_title_and_version = ENABLED;
// If above option is enabled, the following string will be used as a template for the tc summary prefix.
// It has to include four variables in the form of "%s". The first,second and third one will be used internally by the system.
// The fourth one will then be replaced by the title of the originating Requirement,
// the fivth one by its version number.
// Attention: If there aren't exactly four variables in it, the operation will fail.
$tlCfg->req_cfg->testcase_summary_prefix_with_title_and_version = "<b>The Test Case was generated from the assigned" .
" requirement <a href=\"javascript:openLinkedReqVersionWindow(%s,%s,%s)\">\"%s\" (version %s)</a>.</b><br />";
/**
* ENABLED: When generating Test Cases from Requirements, copy the scope of the Requirement
* to the summary of the newly created Test Case.
*/
$tlCfg->req_cfg->copy_req_scope_to_tc_summary = DISABLED;
// To avoid perfomance problems on search Requirements feature,
// we can decide when to inform user that results can not be displayed
// due to too many results.
$tlCfg->req_cfg->search=new stdClass();
$tlCfg->req_cfg->search->max_qty_for_display=200;
// ENABLED: ask for this value on user interface and use on several features
// DISABLED: do not ask, do not use
$tlCfg->req_cfg->expected_coverage_management = ENABLED;
// Show Child Requirements on Requirement Specification Print View
// ENABLED: Requirement Specification including Child Requirements are shown
// DIABLED: ONLY Requirement Specification is shown
$tlCfg->req_cfg->show_child_reqs_on_reqspec_print_view = DISABLED;
// 20090111 - franciscom
// Order of test cases status in this array, is used to undestand
// to what status set requirement in the requirements report.
// Standard algorithm, present in getReqCoverage(), is:
//
//
// if at least one of Test Cases linked to Requirement has status FAILED
// Requirement Coverage Status = FAILED
// else if at least one of Test Cases linked to Requirement has status BLOCKED
// Requirement Coverage Status = BLOCKED
// else if ALL Test Cases linked to Requirement has status NOT RUN