Skip to content

Messages

Dave Nicolette edited this page Jan 1, 2021 · 19 revisions

Home

Messages emitted by Cobol Check

These messages may be attached to an exception or written to a log.

Messages prefixed with "ERR" cause the tool to stop.

Messages prefixed with "INF" are informational.

ERR001: variableName is null on entry to classname.methodName() method.

This accompanies PossibleInternalLogicErrorException when the cause is a null reference that should not occur at that point in the application. Typical cause is a caller does not ensure a reference is non-null before making a call. This can happen inadvertently when we modify the calling code.

ERR002: configFilePath does not contain an entry for configKeyValue.

This means a configuration setting that is necessary for the application is missing. You need to add an entry (or entries) in configFilePath with the key or keys given in configKeyValue. The problem can also occur when you're pointing to the wrong config file, and the one you're using doesn't have that entry.

ERR003: IOException accessing config file configFilePath in Config.load(configResourceName).

There was a problem accessing the configuration file at the indicated location. The most likely cause is the file does not exist at that location. Another cause may be read permissions are not set (details vary by platform). Finally, the file may exist but is corrupted; this is unlikely, but possible.

ERR004: Expecting an argument for command line option <option> but got <another option>.

Command line options and arguments were not specified in the correct order. The tool cannot proceed, as it does not know what you want to do. You can try running the tool with the "--help" option to get usage hints.

ERR005: Command line option specification string passed to GetOpt was null.

This is an internal logic error in the tool. The GetOpt class is used only by the main class of the tool. It is not exposed externally. The cause of the error will be in the Driver class. The error can only occur because the string is null on the GetOpt constructor call.

ERR006: Expecting a command line option but got <something else>.

A possible cause is that you forgot to put a dash or dashes on the front of a command line option. The tool cannot proceed, as it does not know what you want to do. For example, you might have typed "config-file foo" instead of "--config-file foo".

Another possibility is you left a space in the middle of an option argument value, like this:

"--config-file my-config file.properties" when you intended "--config-file my-config-file.properties"

It is also possible you typed two arguments in succession and forgot to include an option, like this:

"--config-file foo warn" when you intended "--config-file foo --log-level warn".

ERR007: Generator.runSuite() empty input stream (cobolSourceIn).

This means the Cobol source file for the code under test was empty.

ERR008: %1$s expected to find a copybook name following COPY verb in <%2$s>.

During copybook expansion, cobol-check encountered a COPY statement that was not followed by the name of a copybook. The run is aborted.

ERR009: Undefined keyword <%1$s> was encountered while parsing a test suite.

At a point in the a suite where cobol-check expected to find one of its own keywords, it found something else (or nothing) instead. The run is aborted. The offending token might be a valid keyword, but was found in a context where it makes no sense. This can happen when we mis-type something, like this:

EXPECT TO BE 'value'

or

EXPECT WS-FIELDNAME FALSE

ERR010: Generator.parseTestSuite() empty input stream (testSuiteReader).

The Generator found no data in the test suite input source. This is probably an internal logic error in cobol-check, as the Generator should not be invoked at all when the test suite is empty.

ERR011: Test suite input file not found: filename. Define in config as test.suite.path or on command line as --test-suite-path.

A test suite file specified in the configuration setting test.suite.path or on the command-line option --test-suite-path was not found. The filename may have been mis-keyed or the file may not be located where specified.

ERR012: There was a problem creating or writing the concatenated test suite input file: path.

Multiple test suite input files are concatenated into a single file which is passed along to the Generator to be merged with the program under test. When an exception occurs during creation of this concatenated file, Cobol Check throws ConcatenatedTestSuiteIOException with this message. The most likely cause is permission settings on the file or a directory on its path.

INF001: Attempting to load config from configFilePath.

Class Config method load() logs this message at the info level just before it tries to load the configuration data.

INF002: Config loaded successfully from configFilePath.

Class Config method load() logs this message on completion of loading and computing the configuration settings.

INF003: Cobol-Check starting

Informational message emitted when Cobol Check starts batch execution.

INF004: Cobol-Check terminating

Informational message emitted when Cobol Check ends batch execution.

INF005: Log level is FATAL | ERROR | WARN | INFO | DEBUG | TRACE

Informational message emitted during batch startup when the log level is INFO or higher.

INF006: Configuration settings: production | test | user-defined

Informational message emitted during batch startup when the log level is INFO or higher. Indicates which configuration file was read. Echoes the value of config.loaded in that config file.

INF007: Concatenating test suite input file path-to-a-test-suite-file to path-to-concatenated-test-suite-file.

During startup, Cobol Check concatenates test suite input files into a single file to pass along to the Generator. This is an informational message to state which input file is about to be concatenated. In case of problems creating the concatenated file, this message may help with debugging.

Clone this wiki locally