-
Notifications
You must be signed in to change notification settings - Fork 29
Configuration Settings
Home -> User Guide ->
This document was last updated on February 11, 2021.
By default, configuration settings are in a file named config.properties located in the project root directory. The path to the config file can be given as a command-line arguments to the main class. See usage documentation for details. (link TBD)
The path to the root directory where copybooks for the application under test are located. In config.properties this points to the user's application copybooks. Can be an absolute path (starting with /) or a relative path starting at the project root directory. In testconfig.properties it points to the copybooks used in cobol-check's own test suite.
If the application copybook filenames have a suffix, specify it (or them) here without the period. You can specify a comma-delimited list with no spaces between entries.
Example:
application.copybook.filename.suffix = CPY,cpy
The default is none, and if the property is not present in the config file cobol-check will assume "none".
The path to the root directory where source files for the application under test are located. In config.properties this points to the user's application source. Can be an absolute path (starting with /) or a relative path starting at the project root directory. In testconfig.properties it points to the Cobol sources used in cobol-check's own test suite.
Examples:
# relative
application.source.directory = app/copy
or
# absolute
application.source.directory = /home/myuser/projects/myapp/src/main/cobol/com/foo/bar/app/copy
or
# absolute
application.source.directory = C:\Users\myuser\Documents\myapp\src\main\cobol\com\foo\bar\app\copy
If the downloaded application source files are stored on your local system with a filename suffix, specify the suffix(es) here without the perior or dot. The value is case-sensitive. You can specify a comma-delimited list with no spaces between entries. Example:
application.source.filename.suffix = CBL,cbl,COB,cob
Prefix for field names and paragraph names in the test management code that cobol-check inserts into programs to be tested. The default is "UT". If this conflicts with names in the programs to be tested, you can override it with a value you specify here. The value of cobolcheck.prefix will be used in COPY REPLACING statements when cobol-check inserts its test management code into the program under test.
Tags written in the generated test code in the form of a comment, when a code injection starts and ends. Default is null, which will prevent the tags from appearing. Any other value will appear as comments surrounding the injected code. Examples:
cobolcheck.injectedCodeTag.start = ###INJECT START###
cobolcheck.injectedCodeTag.end = ###INJECT END###
A tag written at the start of entities stubbed by default. Recommended value-length is 4 or less. Note: The tag will appear only when cobolcheck stubs lines by default. This is the case for CALLs and batch file IO verbs. Default is null, which will prevent the tag from appearing.
Determines if cobolcheck should generate code, such that decimal point is comma. The default is "false". The value should be set to "true" if the compiler is set to read decimal points as comma. If the cobol source program sets DECIMAL-POINT IS COMMA, this configuration will be overwritten.
Example (decimalPointIsComma = false):
05 VALUE-1 PIC Z,ZZ9.99.
Example (decimalPointIsComma = true):
05 VALUE-1 PIC Z.ZZ9,99.
If the source program contains rules as the first line follwed by CBL, the given value will be appended to this. If no CBL is found in the source, it will be added along with the given value. Default is null, which will make no changes.
Location of scripts or JCL to compile and execute generated test programs.
For each program under test in a given run, cobol-check creates a copy of the program with test code inserted into it. This setting specifies the name of that program. Choose a value that does not conflict with your naming convention for actual programs.
Path for the generated testsuite parse error log.
Name of the generated testsuite parse error log file - with extension.
This value is echoed to the output when Cobol Check is executed, for informational purposes. It has no effect on Cobol Check functionality. If you have different config files for different environments or different testing situations, you can set different values here so you can be sure you are running with the configuration you think you are.
You can set these to cause the tool to use a different default Locale than the system default, if desired. You can set all three, or language and country, or just language. When omitted, the tool uses the system default Locale for localizing messages on exceptions and log entries.
The directory under which all test suites are located.
This configuration needs a specified OS by adding a dot followed by one of the platforms: linux, macosx, windows, zos and unix. It sets the charset that cobolcheck will use when reading- and writing to files. See this, for a list of valid values. Default value for each OS is default, which will use the default encoding for the OS.
Sets permissions for all files generated by Cobol Check, for all users. If read, write and execute permissions are set, all users can perform said actions on all files that Cobol Check generates. Value can be any permutation of the letters: 'rwx' (read, write, execute) or none - meaning no permissions. Default value: rx
Determines if Cobol Check should run the generated test program. Default is true. If set to false, Cobol Check will generate the code, but not run it. If more than one program is given as a command line option, the generated test file will be overwritten. Thus if set to false, only one program should be given at a time.
Location of test output. File extension is determined by a given format.
Determines the format of the test results written to the output file.
Supported formats:
- txt
- xml
- html
Determines the format style of the test results written to the output file. The style controls the hierarchy and structure of data and naming of the 'object' that is written in a given format. Specific styles only works for specific formats. See below listing
Formats and their supported styles:
- txt
- directOutput
- xml
- JUnit
- html
- tableDocument
- tableEmbed
Platform-dependent names of scripts or jobs to be executed by a ProcessLauncher instance to compile and run generated test programs.
linux.process = linux_compile_run_tests windows.process = TBD freebsd.process = TBD osx.process = TBD zos.process = TBD
This not set manually in the properties file. It is computed when the Config class loads the property values at runtime.
If you specify values for locale.language, locale.country, and/or locale.variant, the load() method of the Config class creates a Locale object and stores it in the runtime configuration for convenience.