Preferences

As usual the preferences are available from the menu "Window" -> "Preferences".

iRPGUnit Preferences

Run order

Specifies the order for running the test procedures. Useful to check that there is no dependencies between test procedures.

The possible values are:

*API Run test procedures in the order provided by the system API.

*REVERSE Run test procedures in reverse order.

Library list

Specifies the library list for executing the specified unit test.

The possible values are:

*JOBD The initial library list part of the specified job description is used to execute the unit test suite.

*CURRENT The current library list is used to execute the unit test suite.

Job description

Specifies the name of the job description that is used to set the library list, when parameter 'Library list' is set to '*JOBD'.

The possible values are:

*DFT The library of the unit test suite (service program) is searched for job description 'RPGUNIT'.

name The name of the job description that is used to set the library list of the unit test suite.

Job description library

Specifies the library that is searched for the job description.

The possible values are:

*LIBL All libraries in the user and system portions of the job's library list are searched until the first match is found.

name Specify the name of the library to be searched.

Report detail

Specifies how detailed the test run report should be.

The possible values are:

*BASIC Full detail for failures and errors, no detail for successes.

*ALL Full detail in all cases.

Create report

Specifies whether a report is created.

The possible values are:

*NONE Does not create any report.

*ERROR Creates a report in case of failures and errors, only.

*ALLWAYS Creates a report regardless of the test result.

Reclaim resources

Specifies when to reclaim resources. Resources, such as open files, can be reclaimed after each test case or at the end of the test suite.

This option is useful if the test suite calls OPM programs, which do not set the *INLR indicator.

The possible values are:

*NO Resources are not reclaimed.

*ALLWAYS Resources are reclaimed after each test case and at the end of the test suite.

*ONCE Resources are reclaimed at the end of the test suite.

XML stream file

Specifies the path of an XML stream file that contains the result of the unit test. The XML file is created with a format, which can be parsed by a Jenkins build server. Existing files are replaced.

You can use the following replacement variables to produce the name of the XML stream file on the fly:

Command parameters

<TESTPGM> Name of the test test suite.

<TESTLIB> Name of the library where the test suite is stored.

Function strftime()

%C Century number [00-99], the year divided by 100.

%d Day of the month [01-31].

%F ISO Date Format, same as %Y-%m-%d.

%g 2 digit year portion of ISO week date [00,99].

%H Hour in 24-hour format [00-23].

%I Hour in 12-hour format [01-12].

%j Day of the year [001-366].

%m Month [01-12].

%M Minute [00-59].

%p AM or PM string.

%R 24-hour time format without seconds, same as %H.%M.

%S Second [00-61].

%T 24-hour time format with seconds, same as %H.%M.%S.

%u Weekday [1,7]. Monday is 1 and Sunday is 7.

%U Week number of the year [00-53]. Sunday is first day of week.

%V ISO week number of the year [01-53]. Monday is first day of week.

%w Weekday [0,6], Sunday is 0.

%W Week number of the year [00-53]. Monday is first day of week.

%y 2 digit year [00,99].

The table above shows some but not all variables of the strftime() function. Some replacement variables, which are not listed here, are not allowed, because their values may produce an invalid path.

Disable report

Temporary disables the report, provided that 'Create report' does not specify '*NONE'. This checkbox relates to button 'Disable iRPGUnit report' of the 'iRPGUnit' view.

Disable XML stream file

Temporary disables writing the XML stream file.

Product library

Specifies the name of the RPGUnit product library on the host. This value is used to locate program 'RUPGMRMT' which is called from the plug-in to execute the unit tests.

Upload button Press the upload button to open a dialog for uploading the RPGUnit library to your host system using FTP file transfer:

Upload dialog

Press the [Install] button to open a sign-on dialog and to start the upload process.

Check test suite service program

Specifies whether or not to validate the test suite service program.

The possible values are:

*NONE Service programs are not validated when selected for execution.

*TEXT The object description of the selected service program must start with 'RPGUnit' or iRPGUnit (case insensitive).

*ATTRIBUTE The user defined attribute of the service program is checked for 'RPGUnit' or iRPGUnit (case insensitive). That is the preferred option, but does not work for all RDi versions. See APAR SE55976 for details.

The user defined attribute of the test suite service program is automatically set to 'RPGUNIT', when the service program is created by RUCRTRPG.

Do not capture anything - No messages are captured from the job log.

Capture escape messages on unexpected errors - Escape messages are captured from the job log, when a test case ended with errors.

Capture all messages on unexpected errors - All messages of the job log are captured, when a test case ended with errors.

Capture all job log entries - All messages of the job log are captured at any time.

Format job log entries - Specifies whether or not the job log entries are formatted when appended to the Commands Log view.

Format job log entries

Specifies whether or not the job log entries are formatted when appended to the Command Log view.

Show result view

Specifies whether the iRPGUnit result view is automatically displayed at the end of a unit test.

Reset warning messages

Resets all warning messages that have been answered with "Do not ask me again." so that these messages pop up again.

*API	Run test procedures in the order provided by the system API.
*REVERSE	Run test procedures in reverse order.

*JOBD	The initial library list part of the specified job description is used to execute the unit test suite.
*CURRENT	The current library list is used to execute the unit test suite.

*DFT	The library of the unit test suite (service program) is searched for job description 'RPGUNIT'.
name	The name of the job description that is used to set the library list of the unit test suite.

*LIBL	All libraries in the user and system portions of the job's library list are searched until the first match is found.
name	Specify the name of the library to be searched.

*BASIC	Full detail for failures and errors, no detail for successes.
*ALL	Full detail in all cases.

*NONE	Does not create any report.
*ERROR	Creates a report in case of failures and errors, only.
*ALLWAYS	Creates a report regardless of the test result.

*NO	Resources are not reclaimed.
*ALLWAYS	Resources are reclaimed after each test case and at the end of the test suite.
*ONCE	Resources are reclaimed at the end of the test suite.

<TESTPGM>	Name of the test test suite.
<TESTLIB>	Name of the library where the test suite is stored.

%C	Century number [00-99], the year divided by 100.
%d	Day of the month [01-31].
%F	ISO Date Format, same as %Y-%m-%d.
%g	2 digit year portion of ISO week date [00,99].
%H	Hour in 24-hour format [00-23].
%I	Hour in 12-hour format [01-12].
%j	Day of the year [001-366].
%m	Month [01-12].
%M	Minute [00-59].
%p	AM or PM string.
%R	24-hour time format without seconds, same as %H.%M.
%S	Second [00-61].
%T	24-hour time format with seconds, same as %H.%M.%S.
%u	Weekday [1,7]. Monday is 1 and Sunday is 7.
%U	Week number of the year [00-53]. Sunday is first day of week.
%V	ISO week number of the year [01-53]. Monday is first day of week.
%w	Weekday [0,6], Sunday is 0.
%W	Week number of the year [00-53]. Monday is first day of week.
%y	2 digit year [00,99].

		Press the upload button to open a dialog for uploading the RPGUnit library to your host system using FTP file transfer:

		Press the [Install] button to open a sign-on dialog and to start the upload process.

*NONE	Service programs are not validated when selected for execution.
*TEXT	The object description of the selected service program must start with 'RPGUnit' or iRPGUnit (case insensitive).
*ATTRIBUTE	The user defined attribute of the service program is checked for 'RPGUnit' or iRPGUnit (case insensitive). That is the preferred option, but does not work for all RDi versions. See APAR SE55976 for details.

Do not capture anything	-	No messages are captured from the job log.
Capture escape messages on unexpected errors	-	Escape messages are captured from the job log, when a test case ended with errors.
Capture all messages on unexpected errors	-	All messages of the job log are captured, when a test case ended with errors.
Capture all job log entries	-	All messages of the job log are captured at any time.
Format job log entries	-	Specifies whether or not the job log entries are formatted when appended to the Commands Log view.

Preferences

Run order

Library list

Job description

Job description library

Report detail

Create report

Reclaim resources

XML stream file

Disable report

Disable XML stream file

Product library

Check test suite service program

Enforce new connection

Position editor to line of assertion

Capture job log

Format job log entries

Show result view

Reset warning messages