VBScript - Custom classes in Script Extensions?

Question

Hi&nbsp;Hopefully a simple question.&nbsp;In a normal VBScript unit, you need to use a small helper function to pass an instance of a new class to a separate script unit.&nbsp;(As per VBScript specifics here: http://support.smartbear.com/viewarticle/72409/ )&nbsp;Which is fine.&nbsp;Does the same logic hold true if the routines in question will become Script Extension units?&nbsp;I'm adding much bigger TFS integration to my framework. It's using the new RESTful API into TFS so I have a JSON parser which will be used pretty frequently throughout all the TFS custom controls I'll be adding.&nbsp;However, I would like to separate the JSON parser into it's own module.&nbsp;So, do I still need to use the helper function way of creating new instances outside the (extension) script unit where the parser lives? Or is the logic different in Extensions and I can just declare the new instance directly in whatever module?&nbsp;Thanks!

manfred_f · Answer

You're completely right:&nbsp;"Set NewThing = Unit1.Helper1&nbsp;I can't just do:&nbsp;USEUNIT Unit1andNewThing = Helper1"&nbsp;That's the way it works.You do have the choice ofa) handing out an&nbsp;object of Your class Unit1.InternalClass, orb) provide routines in Unit1, which use the InternalClass to provide their service.&nbsp;In case of a), the class members do not have to be declared in the XML definition, so they are not visible for code completion. But it can be done, just add empty sub and function definitions with the member names outside the class definition and add these to the XML.&nbsp;&nbsp;

colin_mccrae · Answer

PS - In case anyone is wondering, I'm using the JSON parser from here:&nbsp;http://www.aspjson.com/&nbsp;The only thing I've had to change in the code for it so far, is this small function:&nbsp;	Public Function Collection()
		set Collection = Server.CreateObject("Scripting.Dictionary")
	End Function&nbsp;&nbsp;Just remove the "Server." part. It's not required in TC. So it simply becomes:&nbsp;	Public Function Collection()
		set Collection = CreateObject("Scripting.Dictionary")
	End Function&nbsp;I've only been using it to read thus far. Haven't tried writing with it yet. But the iterable object returned for a read action seems to be spot on. Saved me a lot of work!&nbsp;(And I'm much more familiar with VBScript, hence why I'm using it for the Script Extensions - in case anyone thinks I'd be better using Jscript)

colin_mccrae · Answer

Was still searching after posting this. This post:

http://community.smartbear.com/t5/Getting-Started-with/A-simple-example-of-script-extension-to-maintain-common-scripts/m-p/85551#M16123

Mentions some disadvantages to Script Extensions. Number 1 being they can't reference other script units.

Can someone (either who has used it or staff/mod) confirm? If this is the case, my parser will have to live in the same extension unit as all the TFS functions. I'm starting to set up the TFS functions now (I write all the VBScript as a normal TC project then ship it out to create the TCX file for the extension) so I'd rather not have to restructure it and change all my class declarations if I can't separate the two .....

Thanks again!

manfred_f · Answer

Script Extensions can't use script units, that's true.

But of course, Script Extensions can use other scrípt extensions, so modularization is not too difficult.

Another point is, that Script Extensions can't use all of the libraries available in script units.

As a workaround, references to the missing libraries can be handed into the Script Extension e.g. via an initialization routine and stored there on a module-global level. After using the Extension, they should be reset to Nothing in a shutdown routine.

Initialisation and shutdown can be done in event routines

GeneralEvents_OnStartTest, GeneralEvents_OnStopTest

Regards,

Manfred

colin_mccrae · Answer

"But of course, Script Extensions can use other scrípt extensions, so modularization is not too difficult."&nbsp;Yeah. I know they can call each other. I already do that with some other extension scripts.&nbsp;But in the case of a VBScript custom class, does this mean I have to make the helper function avilable as a method of the extension containing the custom class declaration? In order for the other extension units to be able to call it?&nbsp;In TC VBScript, a custom class instance can only be declared in the unit it's scripted in.&nbsp;If another unit wants to use an instance of the class, it has to call into a "helper" function of the unit containing the custom class, and the function will pass back the class instance as the response. This is normally (in a standard script unit), done via the USEUNIT statement.&nbsp;But I don't think that works in Script Extensions?&nbsp;So for Ext-Unit 2 to get a custom class instance back from Ext-Unit 1, Ext-Unit 1 needs to make the function available to call in to retrieve the instance?&nbsp;So if my helper function lived in "Unit1" and was called "Helper1", to get an instance of my class in unit 2, I would need to enable calls to Unit1 from unit 2 and then have something along the lines of:&nbsp;Set NewThing = Unit1.Helper1&nbsp;I can't just do:&nbsp;USEUNIT Unit1andNewThing = Helper1&nbsp;I wanted the class creating module to be self-contained within the extensions. I don't need, or want to make it available outwith the other extension units which will be using it. I suppose, I don't need to set up the code complete XML for it as I don't want it being used outwith the framework extensions.&nbsp;Extension units effectively form a test framework for me. This is new functionality to extend our framework further ....&nbsp;

Forum Discussion

VBScript - Custom classes in Script Extensions?

10 Replies

Related Content

Iterate Properties of a VBScript Class Object

Goto in VBScript

JScript - custom classes in script extensions

Calling a VBscript with extension .vbs from Test Complete code

Groovy returns No such property: testRunner for class when using java class

Recent Discussions

Floating window bleep overlapping window takes longer time (~10 min) to click the button on it.

Test case randomly fails with "parent object was not found"

Does TC have a .within() method similar to Cypress.io?

SessionCreator /Timeout option not firing EventControl_OnTimeout

testcomplete feature Intelligent Quality Add Ons