AutoTestFunc

Description

AutoTestFunc runs one or more test cases in an auto test.

C Prototype

void EXTFUN AutoTestFunc(
lpSERVERINFO lpServer); /* Input:  Test information */

Arguments

lpServer

The lpServer argument is a SERVERINFO structure containing information that includes the test cases to run, the test source to run them against, and how to run them. The SERVERINFO structure is defined in the AUTOTEST.H file. It has the following members:

• hwnd—The handle of the window to which szLogPrintf and szMessageBox write screen output. hwnd is passed by AutoTestFunc to calls to szMessageBox.
  
  
• szLogFile—The name of the log file to which szLogPrintf writes file output. szLogFile is not used by AutoTestFunc.
  
  
• henv, hdbc, hstmt—If the test source is not "ODBC Test Handles," these are null and the auto test must allocate its own handles. If the test source is "ODBC Test Handles," these are the currently selected environment, connection, and statement handles; if there are no currently selected environment, connection, and statement handles, these are SQL_NULL_HANDLE.
  
  
• szSource—The name of the test source.
  
  
• szValidServer0—The name of the data source associated with the test source. The auto test connects to this data source. szValidServer0 is a null pointer if the test source is "ODBC Test Handles."
  
  
• szValidLogin0—The user ID associated with the test source. The auto test uses this to connect to the data source. szValidLogin0 is a null pointer if the test source is "ODBC Test Handles."
  
  
• szValidPassword0—The password associated with the test source. The auto test uses this to connect to the data source. szValidPassword0 is a null pointer if the test source is "ODBC Test Handles."

  Caution   The password is stored in the \ GATOR32.INI file in unencrypted form. Because of this, you may want to create special data sources and passwords for use with ODBC Test or use only the ODBC Test Handles test source.

• szKeywords—The keyword-value pairs associated with the test source. The auto test uses these to connect to the data source. szKeywords is a null pointer if the test source is "ODBC Test Handles."
  
  
• rglMask—A bitmask in which each bit represents a test case to be run. The auto test uses the GETBIT macro from the AUTOTEST.H file to determine which bits are set.
  
  
• failed—Included for backward compatibility with ODBC Test 1.0.
  
  
• cErrors—The number of errors that occurred in all test cases run by AutoTestFunc. ODBC Test displays this number after it has called AutoTestFunc.
  
  
• fDebug—TRUE if debugging was specified in the Run Auto Tests dialog box; otherwise, FALSE. What AutoTestFunc does when fDebug is TRUE depends on how it was written.
  
  
• fScreen—TRUE if the Screen box was selected in the Run Auto Tests dialog box; otherwise, FALSE. fScreen is used by the szLogPrintf function in ODBC Test to determine whether to log output to the screen; it is not used by AutoTestFunc.
  
  
• fLog—TRUE if the Log File box was selected in the Run Auto Tests dialog box; otherwise, FALSE. fLog is used by the szLogPrintf function in ODBC Test to determine whether to log output to the log file; it is not used by AutoTestFunc.
  
  
• fIsolate—If the Isolate Tests box was selected in the Run Auto Tests dialog box, this will be TRUE and a single bit will be set in the rglMask member. Otherwise, FALSE.
  
  
• vCursorLib—SQL_CUR_USE_IF_NEEDED, SQL_CUR_USE_ODBC, or SQL_CUR_USE_DRIVER, depending on the setting of the Cursor Library box in the Run Auto Tests dialog box. The auto test can pass this value to SQLSetConnectAttr for the SQL_ATTR_ODBC_CURSORS option.
  
  
• hLoadedInst—The auto-test DLL instance handle.
  
  
• szBuff—Used by szLogPrintf to buffer output until it receives the string " \r\n". szBuff is not used by AutoTestFunc.
  
  
• cBuff—Used by szLogPrintf to count the output in szBuff. cBuff is not used by AutoTestFunc.

Return Value

None.

Comments

ODBC Test calls this function to run one or more test cases in the auto test. If the szSource member of the SERVERINFO structure specified in the lpServer argument is ODBC Test Handles, AutoTestFunc uses the handles specified in the henv, hdbc, and hstmt members. Otherwise, it connects to the data source specified in the szValidServer0 member using the information in the szValidLogin0, szValidPassword0, and szKeywords members.

AutoTestFunc runs the test cases specified in the rglMask member, using the GETBIT macro to determine which bits are set. It calls szLogPrintf to send output to the screen or log file and stores the total number of errors encountered in the cErrors member.

Code Example

The following code example shows a simple AutoTestFunc function and supporting function:

void EXTFUN AutoTestFunc(lpSERVERINFO lpServer)
{
   UINT iCase;

   InitTest(lpServer);

   /* Loop through the rglMask bitmask with the */
    /* GETBIT macro to determine the test cases */
   /* to run. NumTests is the count of test */
   /* cases returned by AutoTestName. */

   for (iCase = 1; iCase = NumTests; iCase++)
      if (GETBIT(lpServer->rglMask, iCase))
         RunTestCase(lpServer, iCase);

   EndTest(lpServer);
}

void INTFUN RunTestCase(lpSERVERINFO lpServer, UINT iCase);
{
   szLogPrintf(lpServer, FALSE, "Running test case %u.\r\n", iCase);

   /* Run the test case specified by iCase. */

   szLogPrintf(lpServer, FALSE, "Test case %u finished.\r\n", iCase);
}