MDTest Functions

Pre-Requisites

Ensure the prerequisites below are met before adding MDTest Test Functions described below to your test programs.

COBOL

• In Working Storage Section COPY MDTCBLWSC OF QLBLSRC.
• In Procedure Division COPY MDTCBLPRC OF QLBLSRC.
• Bind in MDTEST/MDRTEST Service Program (Use any preferred method)
• Ensure MDTEST is in the library list when compiling the program.

RPG

• Include the follwing copy book: /Copy QRPGLESRC,MDRTESTP
• Bind in MDTEST/MDRTEST Service Program (Use any preferred method)
• Ensure MDTEST is in the library list when compiling the program.

MDTest Procedures

Help Functions

MDTest_addInfo

writes an Information Entry to Result

ILE Procedure Interface

COBOL SECTION

MDTEST-ADDINFO USING

RPG Example

Dcl-S h_Message VarChar(128);

//Version 1
h_Message = 'This is my';
MDTest_addInfo(h_Message + ' first message');

//Version 2
MDTest_addInfo('This is my second message':'FINANCE');

MDTest_addPassResult

writes a Pass Result

ILE Procedure Interface

COBOL SECTION

MDTEST-ADDPASSRESULT USING

RPG Example

Chain 16 CUSTOMER;
If %found(CUSTOMER);
  MDTest_addPassResult('Customer record found.':'Customer':'exists');
EndIf;

MDTest_addLogEntry

writes a Log Entry

ILE Procedure Interface

COBOL SECTION

MDTEST-ADDLOGENTRY USING

RPG Example

Dcl-S h_LogEntryId Like(MDTest_addLogEntry);

h_LogEntryId = MDTest_addLogEntry('Check of Procedure getCustomer finished.');

MDTest_addLogDetailEntry

writes a Log Detail Entry

ILE Procedure Interface

COBOL SECTION

MDTEST-ADDLOGDETAILENTRY USING

RPG Example

Dcl-S h_LogEntryId Like(MDTest_addLogEntry);

MDTest_addLogDetailEntry(h_LogEntryId:'Paremter used for calling getCustomer: 16');

MDTest_getJobStatus

returns the current Job status

ILE Procedure Interface

COBOL SECTION

MDTEST-GETJOBSTATUS USING

RPG Example

Dcl-S h_JobStatus Like(MDTest_getJobStatus);

h_JobStatus = MDTest_getJobStatus();

MDTest_forceFail

writes a Fail Result

ILE Procedure Interface

COBOL SECTION

MDTEST-FORCEFAIL USING

RPG Example

MDTest_addInfo('Customer not found.':'FINANCE');

MDTest_abortBatch

writes a Fail Result

ILE Procedure Interface

COBOL SECTION

MDTEST-ABORTBATCH USING

RPG Example

MDTest_abortBatch('Customer file not found.':'FINANCE');

MDTest_waitManualStep

Wait for manual actions - Allows for test steps, such as interactive processes, to occur outside of the MDTest framework and then log the test status decision provided by a user from within MDOpen.

ILE Procedure Interface

COBOL SECTION

MDTEST-WAIT-MANUAL-STEP USING

RPG Example

MDTest_waitManualStep(600:'FINANCE');

Execute Functions

MDTest_Start_Timer

Start the timer for performance measurement and set the start-point for any job log messages to be reported.

After the timer is started, perform one or more program calls, procedure calls, etc. and then use MDTest_End_Timer to stop the timer and collect the results.

When using MDTest_Execute_CMD or MDTest_Execute_SQL, the timer start/stop procedures should be omitted as they are integrated with those 2 execution functions.

ILE Procedure Interface

COBOL SECTION

MDTEST-START-TIMER USING

RPG Example

If MDTest_Start_Timer(10:360:'application process':'EXAMPLE') = MDTest_FAIL;
  // system error
EndIf;

MDTest_End_Timer

End the timer that was started using MDTest_Start_Timer and collect any reporting data.

If the duration between the start and end of the timer exceeds the max duration provided to the start procedure, this procedure will return MDTest_FAIL.

ILE Procedure Interface

COBOL SECTION

MDTEST-END-TIMER USING

RPG Example

If MDTest_End_Timer('finished calling my program') = MDTest_FAIL;
  // process took too long
EndIf;

MDTest_Execute_CMD

executes an IBM i Command

ILE Procedure Interface

COBOL SECTION

MDTEST-EXECUTE-CMD USING

RPG Example

If MDTest_Execute_CMD('ADDLIBLE CUSTDATA':10:360) = MDTest_FAIL;
  //couldnt add CUSTDATA to Library List
EndIf;

MDTest_Execute_SQL

executes an SQL Statement

ILE Procedure Interface

COBOL SECTION

MDTEST-EXECUTE-SQL USING

RPG Example

If MDTest_Execute_SQL('UPDATE CUST set CUSTNAME = '' WHERE CUSTNBR = 16':10:360) = MDTest_FAIL;
  //couldnt update field CUSTNAME in file CUST
EndIf;

Numeric Functions

MDTest_Num_Equal

checks if "Expected Value" & "Actual Value" contain the same value

ILE Procedure Interface

COBOL SECTION

MDTEST-NUM-EQUAL USING

RPG Example

Dcl-S h_Result Like(MDTest_Num_Equal);

h_Result = MDTest_Num_Equal(CUSTNBR:16:'Customer Nbr should be 16.':'FINANCE');

MDTest_Num_NotEqual

checks if "Expected Value" & "Actual Value" contain different values

ILE Procedure Interface

COBOL SECTION

MDTEST-NUM-NOTEQUAL USING

RPG Example

Dcl-S h_Result Like(MDTest_Num_NotEqual);

h_Result = MDTest_Num_NotEqual(CUSTNBR:16:'Customer Nbr should NOT be 16.':'FINANCE');

MDTest_Num_Zero

checks if "Actual Value" is zero

ILE Procedure Interface

COBOL SECTION

MDTEST-NUM-ZERO USING

RPG Example

Dcl-S h_Result Like(MDTest_Num_Zero);

h_Result = MDTest_Num_Zero(CUSTNBR);

MDTest_Num_NotZero

checks if "Actual Value" is not zero

ILE Procedure Interface

COBOL SECTION

MDTEST-NUM-NOTZERO USING

RPG Example

Dcl-S h_Result Like(MDTest_Num_NotZero);

h_Result = MDTest_Num_NotZero(CUSTNBR);

MDTest_Num_LowerThan

checks if "Actual Value" is lower than "Expected Value"

ILE Procedure Interface

COBOL SECTION

MDTEST-NUM-LOWERTHAN USING

RPG Example

Dcl-S h_Result Like(MDTest_Num_LowerThan);

h_Result = MDTest_Num_LowerThan(CUSTNBR:16);

MDTest_Num_LowerEqualThan

checks if "Actual Value" is lower than or equal "Expected Value"

ILE Procedure Interface

COBOL SECTION

MDTEST-NUM-LOWEREQUALTHAN USING

RPG Example

Dcl-S h_Result Like(MDTest_Num_LowerEqualThan);

h_Result = MDTest_Num_LowerEqualThan(CUSTNBR:16);

MDTest_Num_GreaterThan

checks if "Actual Value" is greater than "Expected Value"

ILE Procedure Interface

COBOL SECTION

MDTEST-NUM-GREATERTHAN USING

RPG Example

Dcl-S h_Result Like(MDTest_Num_GreaterThan);

h_Result = MDTest_Num_GreaterThan(CUSTNBR:16);

MDTest_Num_GreaterEqualThan

checks if "Actual Value" is greater than or equal "Expected Value"

ILE Procedure Interface

COBOL SECTION

MDTEST-NUM-GREATEREQUALTHAN USING

RPG Example

Dcl-S h_Result Like(MDTest_Num_GreaterEqualThan);

h_Result = MDTest_Num_GreaterEqualThan(CUSTNBR:16);

MDTest_Num_InRange

checks if "Actual Value" is between "Range Start" and "Range End"

ILE Procedure Interface

COBOL SECTION

MDTEST-NUM-INRANGE USING

RPG Example

Dcl-S h_Result Like(MDTest_Num_InRange);

h_Result = MDTest_Num_InRange(CUSTNBR:1:229);

MDTest_Num_OutsideRange

checks if "Actual Value" is not between "Range Start" and "Range End"

ILE Procedure Interface

COBOL SECTION

MDTEST-NUM-OUTSIDERANGE USING

RPG Example

Dcl-S h_Result Like(MDTest_Num_OutsideRange);

h_Result = MDTest_Num_OutsideRange(CUSTNBR:1:229);

Character Functions

MDTest_Char_Equal

checks if "Expected Value" & "Actual Value" contain the same value

ILE Procedure Interface

COBOL SECTION

MDTEST-CHAR-EQUAL USING

RPG Example

Dcl-S h_Result Like(MDTest_Char_Equal);

h_Result = MDTest_Char_Equal('MDTest':'MDTEST':*On);

MDTest_Char_NotEqual

checks if "Expected Value" & "Actual Value" contain different values

ILE Procedure Interface

COBOL SECTION

MDTEST-CHAR-NOTEQUAL USING

RPG Example

Dcl-S h_Result Like(MDTest_Char_NotEqual);

h_Result = MDTest_Char_NotEqual('MDTest':'MDTEST':*On);

MDTest_Char_Contains

checks if "Actual Value" contains "Expected Value"

ILE Procedure Interface

COBOL SECTION

MDTEST-CHAR-CONTAINS USING

RPG Example

Dcl-S h_Result Like(MDTest_Char_Contains);

h_Result = MDTest_Char_Contains('test':'MDTest':*On);

MDTest_Char_NotContains

checks if "Actual Value" does not contain "Expected Value"

ILE Procedure Interface

COBOL SECTION

MDTEST-CHAR-NOTCONTAINS USING

RPG Example

Dcl-S h_Result Like(MDTest_Char_NotContains);

h_Result = MDTest_Char_NotContains('test':'MDTest':*On);

MDTest_Char_StartsWith

checks if "Actual Value" starts with value of "Expected Value"

ILE Procedure Interface

COBOL SECTION

MDTEST-CHAR-STARTSWITH USING

RPG Example

Dcl-S h_Result Like(MDTest_Char_StartsWith);

h_Result = MDTest_Char_StartsWith('MD':'MDTest');

MDTest_Char_EndsWith

checks if "Actual Value" ends with value of "Expected Value"

ILE Procedure Interface

COBOL SECTION

MDTEST-CHAR-ENDSWITH USING

RPG Example

Dcl-S h_Result Like(MDTest_Char_EndsWith);

h_Result = MDTest_Char_EndsWith('est':'MDTest');

MDTest_Char_Blank

checks if "Actual Value" is empty

ILE Procedure Interface

COBOL SECTION

MDTEST-CHAR-BLANK USING

RPG Example

Dcl-S h_Result Like(MDTest_Char_Blank);
Dcl-S h_Name Char(10) Inz('Sam');

h_Result = MDTest_Char_Blank(h_Name);

MDTest_Char_NotBlank

checks if "Actual Value" is not empty

ILE Procedure Interface

COBOL SECTION

MDTEST-CHAR-NOTBLANK USING

RPG Example

Dcl-S h_Result Like(MDTest_Char_NotBlank);
Dcl-S h_Name Char(10) Inz('Sam');

h_Result = MDTest_Char_NotBlank(h_Name);

MDTest_Char_In

checks if "Actual Value" is found in "Elements"

ILE Procedure Interface

COBOL SECTION

MDTEST-CHAR-IN USING

RPG Example

Dcl-S h_Result Like(MDTest_Char_In);
Dcl-S h_Elements VarChar(256) Dim(50);

h_Elements(1) = 'ABC';
h_Elements(2) = 'DEF';

h_Result = MDTest_Char_In('def':2:h_Elements:*On);

MDTest_Char_NotIn

checks if "Actual Value" is not found in "Elements"

ILE Procedure Interface

COBOL SECTION

MDTEST-CHAR-NOTIN USING

RPG Exampleregex

Dcl-S h_Result Like(MDTest_Char_NotIn);
Dcl-S h_Elements VarChar(256) Dim(50);

h_Elements(1) = 'ABC';
h_Elements(2) = 'DEF';

h_Result = MDTest_Char_NotIn('def':2:h_Elements:*On);

MDTest_Char_RegEx

checks if Regular Expression in "Expected Values" is found in "Actual Value"

ILE Procedure Interface

COBOL SECTION

MDTEST-CHAR-REGEX USING

RPG Example

h_Status = MDTest_Char_Regex('^(?:\w+\.?)*\w+@(?:\w+\.)*\w+$':'Saman.Neinawaie@MidrangeDynamics.com');

MDTest_Char_NotRegEx

checks if Regular Expression in "Expected Values" is not found in "Actual Value"

ILE Procedure Interface

COBOL SECTION

MDTEST-CHAR-NOTREGEX USING

RPG Example

h_Status = MDTest_Char_NoRegex('^(?:\w+\.?)*\w+@(?:\w+\.)*\w+$':'Saman.Neinawaie@MidrangeDynamics.com');

Code Coverage Functions

MDTest_reg_CodeCov_Mod

register code coverage for a module

ILE Procedure Interface

COBOL SECTION

MDTEST-REG-CODECOV-MOD USING

h_Status = MDTest_reg_CodeCov_Mod('MYLIB':'MYPGM':'*ALL':'*PGM':85:-1:1961:-1:'FINANCE');

MDTest_rpt_CodeCov

generate code coverage report

ILE Procedure Interface

COBOL SECTION

MDTEST-RPT-CODECOV USING

RPG Example

h_Status = MDTest_rpt_CodeCov();