Default Directory Structure

Home -> User Guide -> General User Guide ->

Cobol-check makes a copy of the program under test and inserts test code into the copy. It uses Cobol copybooks to do this. You tell cobol-check where you have placed its copybooks using the config setting cobolcheck.copybook.directory.

You can organize your source code however you please. Tell cobol-check where to find your Cobol source programs and copybooks using config settings application.source.directory and application.copybook.directory.

Cobol-check expects to find all the testsuites under the same directory. Tell cobol-check what this directory is using config setting test.suite.path.

Under the directory specified as test.suite.path, cobol-check expects to find subdirectories named after the programs you will test. For example, if you have a program named ABCXYZ4 and you specified test.suite.path=mytests, then cobol-check will look for testsuites pertaining to program ABCXYZ4 under directory project-root/mytests/ABCXYZ4.

your-project-root/                                      config settings
  |
  +-- cobol-check-copybook-dir                       <- cobolcheck.copybook.directory
  |
  +-- your-prod-src-tree/                            <- application.source.directory,
  |     |                                               application.copybook.directory
  |     +-- cobol-programs-to-be-tested/ 
  |           | 
  |           +-- any-dir-structure-that-makes-sense-to-you/ 
  |                 |
  |                 +-- PROGRAM1.CBL
  |                 |
  |                 +-- PROGRAM2.CBL
  |
  +-- your-test-src-tree/                            <- test.suite.path (or --test-suite-path option)
        |
        +-- PROGRAM1/ 
        |     | 
        |     +-- testsuite-1-for-program-1 
        |     | 
        |     +-- testsuite-2-for-program-1 
        |
        +-- PROGRAM2/ 
              | 
              +-- testsuite-1-for-program-2 
              | 
              +-- testsuite-2-for-program-2 

Example

project-root/ 
  | 
  +-- cobolcheck/ 
  |     | 
  |     +-- copybooks/                          <- cobolcheck.copybook.directory = cobolcheck/copybooks          
  |           |
  |           +-- ZUTZCWS 
  |           | 
  |           +-- ZUTZCPD 
  |           | 
  |           +-- DFHEIBLK 
  | 
  +-- src/ 
        | 
        +-- main/ 
        |     | 
        |     + cobol/                          <- application.source.directory = src/main/cobol 
        |         | 
        |         +-- copy/                     <- application.copybook.directory = src/main/cobol/copy
        |         |     | 
        |         |     +-- *.CPY 
        |         | 
        |         +-- PROGRAM1.CBL 
        |         |
        |         +-- PROGRAM2.CBL 
        |       
        +--test/  
             |
             +-- cobol/                         <- test.suite.path = src/test/cobol
                   | 
                   +-- PROGRAM1/ 
                   |     |
                   |     +-- testsuite1-program1 
                   |     |
                   |     +-- testsuite2-program1 
                   | 
                   +-- PROGRAM2/ 
                         |
                         +-- testsuite1-program2 
                         |
                         +-- testsuite2-program2