Changes between Initial Version and Version 1 of Documentation/T3Q/Quality-Checks/Modularization-Imports

Timestamp:

06/03/10 15:59:46 (14 years ago)

Author:

zeiss

Comment:

Importing pages from "/var/lib/svn/trac/etsicheck2" using ​WikiImport plugin.

Documentation/T3Q/Quality-Checks/Modularization-Imports

@@ +1 @@
+=== Test Suite Modularization: Importing Libraries ===
+
+==== !TypesAndValues Modules Must Always Import From Certain Modules ====
+ - '''Symbolic Name in XML Configuration''': checkTypesAndValuesModuleImportsLibNames
+ - '''Dependant Tags in XML Configuration''': typesAndValuesImportsLibNamesRegExp, typesAndValuesImportsLibNamesExcludedRegExp
+
+The check inspects whether a module that contains ''!TypesAndValues'' (case-sensitive) in its name imports from modules with certain names (e.g. libraries - ''!LibCommon''). The names of the required imports are specified by means of regular expressions. The default setting is ''.*?!LibCommon.*'', meaning that definitions shall be imported from modules that contain ''!LibCommon'' in their name (regardless of the position of this substring). This setting is stored under the '''typesAndValuesImportsLibNamesRegExp''' tag in the configuration.
+
+Additionally, with the help of the '''typesAndValuesImportsLibNamesExcludedRegExp''' setting, certain modules can be excluded from this check (e.g. modules whose identifier also contains ''!LibCommon'', such as ''!LibCommon_TypesAndValues''). The default value for this setting is ''.*?!LibCommon.*''.
+
+The message text in the output for this quality check is: {{{Required imports ("$typesAndValuesImportsLibNamesRegExp") not found!}}}
+
+==== Testcases Module Must Always Import From Modules Prefixes with !LibCommon_Sync ====
+ - '''Symbolic Name in XML Configuration''': checkTestcasesModuleImportsLibCommon_Sync
+ - '''Dependant Tags in XML Configuration''': -
+
+The check inspects whether a module that contains ''Testcases'' (case-sensitive) in its name imports from modules that are prefixed with the string ''!LibCommon_Sync'' (case sensitive!).
+
+Similar conditions as in "!TypesAndValues Module Must Always Import From Modules Prefixes with !LibCommon" apply to this quality check as well. Modules whose identifiers contain "!LibCommon_Sync" are excluded (regardless of where the substring is placed). The configuration for this quality check will also be extended in the future to allow customized selection of the required prefix and the exclusion criteria.
+