- Start Microsoft Visual Studio C++ 6.0 and select File->New.
- Select ATL COM AppWizard, enter a project name and click OK.
- Click Finish and then OK.
- Right click on the project and select New ATL Object
- Select Simple Object and press next.
- Enter a short name for your tester creator object and press select the Attributes tab.
- Select Free Threading Model and press OK.
- In the class view right click on your tester creator object, select Implement Interface and then press OK.
- Select TestScriptRunner 5.0 Type Library(5.0) in the Available type libraries and press OK.
- Select ITesterCreator and ITesterCreator1 in the interfaces box and press OK.
- In the project file view right click on the project and select add files to project and add Tester.h and Tester.cpp from the Test Script Runner install directory (usually C:\Program Files\Ideal Systems Consultancy Ltd\Test Script Runner).
- Right click on the project and select settings.
- In the settings for box select All Configurations.
- Open the C/C++ tab, select the pre-processor category, add the Test Script Runner install directory to the Additional Include Directories box.
- In the Category select C++ Language and enable exception handling then press OK.
- In the project class view right click on the project and select New Class.
- In the class type box select generic type, enter a name for your tester object, add Tester in the Base class(es) box and press OK.
- Open the tester object header file and add the code below before the class definition replacing DemoTester with the name of your tester class: -
class DemoTester;
typedef CComObject<DemoTester> CComObjectDemoTester;
- Also within the class add the methods below: -
virtual Result execute(ULONG ActionId, ULONG numberOfParameters, VARIANT *parameters);
virtual bool open(ULONG numberOfParameters, VARIANT *parameters);
virtual bool close();
- Also add an enumeration to the header containing an entry for each action you intend to provide. In this case this enumeration will be: -
enum ActionId
{
ePass,
eFail,
eRandom,
eRandomValue
};
- Open the tester object source file and add :Tester(“<your tester object type>”,"<version>") to the constructor. In this case this will be :Tester(“demo”,"2.0").
- Inside the braces of the constructor you need to add calls to addAction for each of the actions you intend to implement. The addAction method has the signature: -
void addAction(unsigned int ActionId,
const char *actionType,
const char *description,
...);
The ActionId is one of your enumeration values, actionType is the name of the action to be used in the script, description is a free format text describing what the action does and the variable parameter list is a the list of parameters and return values for the action each list separated by a 0. In this case these calls are as follows:-
addAction(ePass, //Action Id
"Pass", //Action name
"Return TestPassed", //Action Description
0, //End of action parameters
0); //End of action return values
addAction(eFail, //Action Id
"Fail", //Action name
"Return TestFailed", //Action Description
0, //End of action parameters
0); //End of action return value
addAction(eRandom, //Action Id
"Fail", //Action name
"Random Passed/Failed", //Action Description
"int value=2", //int parameter with a default value of 2
0, //End of action parameters
0); //End of action return value
addAction(eRandomValue, //Action Id
"RandomValue", //Action name
"Return a random value", //Action Description
"int value=2", //int parameter with a default value of 2
0, //End of action parameters
"int rndval", //int return value
- Add implementations for the open and close functions. The open function is called after the object is created and is supplied with the parameters from new command within the script. The close function is called when the object is deleted in the script. In this case there is nothing to do and we could have decided not to overload these but there were included in case you do need to implement them. Each function should return true if successful false otherwise.
bool DemoTester::open(ULONG numberOfParameters, VARIANT *parameters)
{
return true;
}
bool DemoTester::close()
{
return true;
}
- Next add the implementation of the execute function. This function actually performs the actions in a big switch statement. Here is the implementation for the demo tester: -
Result DemoTester::execute(ULONG ActionId, ULONG numberOfParameters, VARIANT *parameters)
{
switch (ActionId)
{
case ePass:
return TestPassed;
case eFail:
return TestFailed;
case eRandom:
{
int val = 2;// Default to 2 as per addAction documentation
if ((numberOfParameters == 1) && (parameters[0].vt == VT_I4))
{
val = parameters[0].intVal;
}
if (val > 0)
{
return ((rand() % val) == 0) ? TestFailed : TestPassed;
}
break;
}
case eRandomValue:
{
val = 2;//Default to 2 as per addAction documentation
if ((numberOfParameters == 1) && (parameters[0].vt == VT_I4))
{
val = parameters[0].intVal;
}
if (val > 0)
{
value(rand() % val);
return TestPassed;
}
break;
}
}
return TestError;
}
- Open your tester creator header and implement the three functions create, get_NumberOfTypes and get_Version. Below is the demo implementation for these. Add a #include statement for the DemoTester.h file. Please note you can create multiple tester types from creator object and you need to add a #include statement to each tester object.
STDMETHOD(create)(unsigned long TesterNumber, ITester * * tester)
{
if (0 != tester)
{
if (TesterNumber == 0)
{
CComObjectDemoTester *temp;
CComObjectDemoTester::CreateInstance(&temp);
temp->AddRef();
*tester = temp;
return S_OK;
}
return E_INVALIDARG;
}
return E_POINTER;
}
STDMETHOD(get_NumberOfTypes)(unsigned long * pVal)
{
if (0 != pVal)
{
*pVal = 1;
return S_OK;
}
return E_POINTER;
}
STDMETHOD(get_Version)(BSTR * pVal)
{
if (0 != pVal)
{
*pVal = CComBSTR("2.0").Detach();
return S_OK;
}
return E_POINTER;
}
- Finally, locate the line COM_INTERFACE_ENTRY(ITesterCreator) line in the COM MAP and change it to:-
COM_INTERFACE_ENTRY2(ITesterCreator,ITesterCreator1)
- Compile the code and then select the program identifier from the registry file for your tester creator and add this to the system via the Admin->Add Testers command. The program identifier for the demo tester creator (located in DemoTesterCreator.rgs file) is:-
VCPP_6_0_Demo.DemoTesterCreator
- You can now create objects of your tester in your scripts using the commands such as in the script below: -
d = new Demo() # Create a demo tester
i = 0
while i < 20 do # loop for 20 iterations
d.pass()
d.fail()
d.random(5)
r = d.randomValue(10)
sleep(r) #sleep length is random 0 - 9
endwhile
delete d
- To Debug you plug-in simply run the debugger and select PlugInRunner.exe (from the install directory) as the Executable For Debug Session and press OK when informed that there are no debug symbols. Add break points in your action code and run a script.
Please note that when you wish to compile your plug-in for release you may find that you have an unresolved external symbol _main. If this is the case remove the pre-processor definition _ATL_MIN_CRT (Project Settings->C/C++ Tab, Preprocessor Category - Preprocessor Definitions) then recompile.
If you wish to add logging information to your tester object you can call the log method at any point. All logging entries from configuration to sever will be displayed in the logger view window and in the log file. If you wish to add debug log entries then use levels finest, finer and fine levels and change the logging level via the Logging->Set Logging Level option.