Skip to content

Configuration Settings

Jump to bottom
dakaa16 edited this page May 2, 2022 · 47 revisions

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)

Keys and values

application.copybook.directory = path

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.

application.copybook.filename.suffix = none

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".

application.source.directory = path

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

application.source.filename.suffix = none

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

cobolcheck.prefix = UT

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.

cobolcheck.decimalPointIsComma = false

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.

cobolcheck.script.directory = src/test/scripts

Location of scripts or JCL to compile and execute generated test programs.

cobolcheck.test.program.name = CC$$999.CBL

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.

testsuite.parser.error.log.path = ./

Path for the generated testsuite parse error log.

testsuite.parser.error.log.name = ParserErrorLog.txt

Name of the generated testsuite parse error log file - with extension.

config.loaded = production | test

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.

locale.language, locale.country, locale.variant = (commented out by default)

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.

test.suite.directory = (no default)

The directory under which all test suites are located.

test.results.file = output/testResults

Location of test output. File extension is determined by a given format.

test.results.format = txt

Determines the format of the test results written to the output file.

Supported formats:

  • txt
  • xml

test.results.format.style = directOutput

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. Format: txt and style: directOutput are exclusive. txt cannot use any other style than directOutput, and directOutput cannot be used with any other format than txt. Other formats and styles can be used interchangeably.

Supported styles:

  • directOutput
  • JUnit

xxxx.process

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

"Computed" property

This not set manually in the properties file. It is computed when the Config class loads the property values at runtime.

default.locale = Locale(...)

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.

Clone this wiki locally