regression_test/logFiles/logFiles_doc.script

   1 .******************************************************************************
   2 .* Copyright (c) 2000-2015 Ericsson Telecom AB
   3 .* All rights reserved. This program and the accompanying materials
   4 .* are made available under the terms of the Eclipse Public License v1.0
   5 .* which accompanies this distribution, and is available at
   6 .* http://www.eclipse.org/legal/epl-v10.html
   7 .******************************************************************************/
   8 :text.
   9 :lang eng.
  10
  11 .* EDML webpage:       http://cpi.ericsson.se/dwaxe/
  12 .* EDML2PDF converter: http://dwaxe.ericsson.se/x2pdf
  13 .* EDML user guide:    http://www.lmc.ericsson.se/~lmcmarg/isit/edml_ug.html
  14
  15 .* Document header information
  16 :docname.Test Description
  17 :docno.??/152 91-CRL 113 200 Uen
  18 :rev.A
  19 :date.2007.08.16.
  20
  21 :prep.ETH/RZD Adam Delic (+36 1 7992)
  22 :appr.ETH/RZ (Zsolt Szendrei)
  23 :checked.ETHGRY
  24
  25 :title.Test description of the Titan regression test : log files
  26 :contents level=2.
  27 .*---------------------------------------------------------------------*
  28 :h1.Introduction
  29 .*---------------------------------------------------------------------*
  30 .*---------------------------------------------------------------------*
  31 :h2.Revision history
  32 .*---------------------------------------------------------------------*
  33 :xmp tab=2.
  34 REV   DATE         PREPARED   CHANGE
  35 __________________________________________________
  36 PA1   2007-01-31   EDMDELI    New document for TITAN R7B
  37 A     2007-03-06   ETHNBA     Approved after review
  38 :exmp.
  39 .*---------------------------------------------------------------------*
  40 :h2.Purpose
  41 .*---------------------------------------------------------------------*
  42 The purpose of this Test Description is to define and describe the regression
  43 test activity for the TTCN-3 compiler:
  44 :nl.SA-10/x: Log files.
  45 :p.The specification of the test cases can be found in this document.
  46 .*---------------------------------------------------------------------*
  47 :h1.Test environment
  48 .*---------------------------------------------------------------------*
  49 .*---------------------------------------------------------------------*
  50 :h2.Hardware
  51 .*---------------------------------------------------------------------*
  52 No specific hardware requirement.
  53 .*---------------------------------------------------------------------*
  54 :h2.Software
  55 .*---------------------------------------------------------------------*
  56 Tests shall be carried out on the following platforms:
  57 :list.
  58 :li D='1.'.Solaris 8 (Sun OS 5.8) (gcc 3.0.4)
  59 :li D='2.'.SUSE Linux Enterprise server 8 (2.4.19-4GB) (gcc 3.2)
  60 :li D='3.'.CYGWIN_NT-5.0 (Cygwin DLL: 1.5.12) on Windows 2000 (gcc 3.3.3)
  61 :elist.
  62 .*---------------------------------------------------------------------*
  63 :h2.Configuration
  64 .*---------------------------------------------------------------------*
  65 The test environment had been setup in CVS. The tester program is stored in:
  66 :nl.TTCNv3/function_test/Tools/SAtester.pl
  67 :nl.Test cases are stored with extension .script in the directory:
  68 :nl.TTCNv3/regression_test/
  69 .*---------------------------------------------------------------------*
  70 :h2.Installation
  71 .*---------------------------------------------------------------------*
  72 Install proper TITAN binaries on the used platforms and make sure that
  73 your environment settings are correct:
  74 :list.
  75 :li D='1.'.TTCN3_DIR is set
  76 :li D='2.'.$TTCN3_DIR/bin is added to the PATH variable
  77 :li D='3.'.$TTCN3_DIR/lib is added to the LD_LIBRARY_PATH variable
  78 :li D='4.'.Perl 5.6.0 or higher is available on the platform
  79 :li D='5.'.Create a symlink to your Perl binary into the directory where the
  80 test cases are stored:
  81 :nl.ln -s <your Perl> perl
  82 :elist.
  83 .*---------------------------------------------------------------------*
  84 :h2.Test Tools
  85 .*---------------------------------------------------------------------*
  86 A tester program had been written in Perl especially for the Semantic Analyser
  87 tests. For the list of command line parameters, type 'SAtester.pl -help', for the
  88 complete documentation, type 'SAtester.pl -doc'.
  89 :p.Test cases are specified in the Test Description documents in EDML format.
  90 The tester program parses these files and generates the TTCN-3/ASN.1 modules, then
  91 calls the compiler to compile them. The result printout is then matched against
  92 different patterns to be able to set the verdict. Test cases contain not only
  93 the source modules, but the patterns as well.
  94 :p.The tester program allows one-by-one execution of test cases and batched
  95 execution as well.
  96 :p.NOTE: the tester program requires Perl 5.6.0 or higher.
  97 .*---------------------------------------------------------------------*
  98 :h1.Test cases
  99 .*---------------------------------------------------------------------*
 100 Ref [1]: SA-10/x: Log files
 101
 102 .*---------------------------------------------------------------------*
 103 :h2.Log files
 104 .*---------------------------------------------------------------------*
 105 This test case group covers the requirement SA-10/1.
 106
 107 The test cases below check the content of log files. In Titan R7B the log
 108 format has been enhanced. The following is checked: log event types and
 109 severities, component instance names, the content of log messages. In addition
 110 the tests implicitly check the Titan config files for the component instance
 111 names (in both file name and [LOGGING] section) and the log event types.
 112
 113 .*---------------------------------------------------------------------*
 114 :h3. Test case 1: Generate PTC and MTC logs, connect ports and send messages between components
 115 .*---------------------------------------------------------------------*
 116 Creates component ring of PTC components connected to each other. The MTC
 117 is the beginning and end of the ring. PTC instance names and the log severity
 118 to be logged by the component is taken from module parameters which are set in
 119 the configuration file. The configuration file LogFilesInc.cfg contains the
 120 module paramters. The MTC sends a message which is passed along the PTC ring
 121 and finally returned to the MTC. The names of logfiles are specified in the
 122 LogFiles.cfg file, this will be tested in test case 2. The LogFiles.cfg file
 123 has a FileMask specified for every component, which is set according to the given
 124 module parameters. The content of the created log files is based on this setting,
 125 this will be checked in test case 2.
 126
 127 .*---------------------------------------------------------------------*
 128 :h3. Test case 2: Check the content of PTC log files created in test case 1
 129 .*---------------------------------------------------------------------*
 130 Reads every PTC log file created in test case 1, according to the cfg files.
 131 Log file reading is done by an external function, the log file lines are read into
 132 charstrings which are then checked with the TTCN-3 regexp() function. The test case
 133 verdict is pass only if all checked lines match the regexp. Existance and position
 134 of specific log lines are checked.
 135 Every PTC logs one severity: the severity, it's log event types, the log strings
 136 and component instance names are checked.
 137 Severities:
 138 :list.
 139 :li PORTEVENT
 140 :li MATCHING
 141 :li USER
 142 :li PARALLEL
 143 :li EXECUTOR
 144 :li VERDICTOP
 145 :elist.
 146
 147 .*---------------------------------------------------------------------*
 148 :h3. Test case 3: Check the content of MTC log file created in test case 1
 149 .*---------------------------------------------------------------------*
 150 Reads the MTC.log file and checks it's content: the severity, it's log event types,
 151 the log strings and component instance names are checked. Existance and position
 152 of specific log lines are checked.
 153 Checks for the following severities/log event types:
 154 :list.
 155 :li EXECUTOR_COMPONENT
 156 :li EXECUTOR_LOGOPTIONS
 157 :li TIMEROP_START
 158 :li TIMEROP_STOP
 159 :li TESTCASE_START
 160 :li TESTCASE_FINISH
 161 :li PARALLEL_PTC
 162 :li VERDICTOP_FINAL
 163 :li PARALLEL_PORTCONN
 164 :elist.
 165
 166 .*---------------------------------------------------------------------*
 167 :h3. Test case 4: Generate PTC logs, procedure based communication, check PTC log files
 168 .*---------------------------------------------------------------------*
 169 Generates log files for two PTC components, the components make procedure based
 170 communication. PTC log files are checked for correct content: the severity,
 171 it's log event types, the log strings and component instance names are checked.
 172 Existance and position of specific log lines are checked.
 173 Checks for the following severities/log event types:
 174 :list.
 175 :li PORTEVENT_PCOUT
 176 :li PORTEVENT_PQUEUE
 177 :li MATCHING_PCSUCCESS
 178 :li PORTEVENT_PCIN
 179 :li USER_UNQUALIFIED
 180 :li PORTEVENT_PCOUT
 181 :elist.