Relevant Codes (by Anshoo Arora) » VBScript

ExcelUtil Class Library (MS Excel Utility Methods)

Anshoo Arora — Sat, 12 Mar 2011 20:34:45 +0000

Over the past few years, I have read numerous threads and posts talking about working with Excel using VBScript. Not only have there been numerous threads, but also frameworks that use Excel as the input and/or driver engine. I wanted to work on this mini-project for a long time, and I finally have Version 1.0 of ExcelUtil ready for download! It comes with .CHM documentation.

I’m quite sure I have missed some methods that the community uses, which I have not been able to include in the 1st version. I, however, am open to suggestions and would gladly include your ideas for Version 2.0.

Download RelevantCodes.ExcelUtil Class Library (1066)

IMPORTANT: To use any method of ExcelUtil, be sure to use SetFile. This will set the Excel WorkBook and WorkSheet ready for use. To use a different WorkBook or WorkSheet, SetFile will have to be called again.

SetFile Property

Value Type

Read only. A [RelevantCodes.ExcelUtil] object.

Description

Sets the region instances for Excel WorkBook and WorkSheet. These instances for the Excel source are created only once and used by other methods. NOTE: For any method to execute, SetFile must be executed first to set the WorkBook and WorkSheet.

Syntax

ExcelUtil.SetFile WorkBookPath, WorkSheet

Examples

'Example 1
ExcelUtil.SetFile "C:\Student.xls", "Sheet1"
 
'Example 2:  Reading value directly from a file
sCellValue = ExcelUtil.SetFile("C:\Student.xls", "Sheet1").GetCellValue(1, 1)
 
'Example 3:  Reading values from 2 different files - Approach 1
ExcelUtil.SetFile "C:\Student.xls", "Sheet1"
var1 = ExcelUtil.GetCellValue(1, 1)
ExcelUtil.SetFile "C:\Teacher.xls", "Sheet1"
var2 = ExcelUtil.GetCellValue(1, 1)
 
'Example 4:  Reading values from 2 different files - Approach 2
var1 = ExcelUtil.SetFile("C:\Student.xls", "Sheet1").GetCellValue(1, 1)
var2 = ExcelUtil.SetFile("C:\Teacher.xls", "Sheet1").GetCellValue(1, 1)

I found a Bug. What should I do next?

Reporting the bug in the comments section will ensure the next version of this class library is more robust! It may not be possible to release the fixed code immediately, but notifying me and the readers of all potential bugs will be highly appreciated! Thank you.

I have something cool I would like you to add to ExcelUtil.

I would love to hear all ideas and suggestions to improve or enhance this library. Please use the comments section to share them with me and the community. Thank you.

Download RelevantCodes.ExcelUtil Class Library (1066)

Executing QC TestSet via OTA API (QCRunTestSet)

Anshoo Arora — Mon, 10 Jan 2011 12:10:31 +0000

For the past few weeks, I have been actively working on Quality Center (ALM) and its integration with QuickTest Professional. One of the mini-projects I’ve worked on is creating a custom object that executes a test set and sends an email to the supplied distribution list from ALM TestSet’s Automation tab (as shown below):

Note: The above part (EMailTo) can be modified by either hard-coding it, or supplying an input from the Class Constructor.

I’ve extensively used the OTA API Reference to build this object and to understand how the API works. .NET developers having difficulty converting the VBScript code, please post in the comments section and I will mail you the class library (currently only C#).

Download (ALM Only)

QCRunTestSet is available for download, but comes as-is and currently executes TestSets on the localHost. However, I would be more than happy in helping you to modify this code to suit your needs.

QCRunTestSet.cls.vbs.zip [for ALM] (1244)

If you’re having issues creating an instance of the TSScheduler object, please read this thread carefully. You may need to upgrade to a higher patch or perform a client registration on the execution machine.

Running QCRunTestSet from CommandLine

If you would like to pass parameters from the CommandLine instead of hard-coding them in the code, use WScript to pass arguments and WScript.Arguments to retrieve them in the class library. Example:

'Passing arguments
wscript C:\QCRunTestSet.cls.vbs "http//:8080/qcbin" myUser myPassword myDomain _
                                                  myProject myTestSetPath myTestSetName

'Retrieving arguments
Set args = WScript.Arguments
 
QCServer = args(0)
UserName =  args(1)
Password = args(2)
QCDomain = args(3)
QCProject = args(4)
QCTestSetPath = args(5)
QCTestSetName = args(6)

I hope you find this helpful. Thanks for visiting Relevant Codes! :)

IE Error: A script is causing IE to run slowly

Anshoo Arora — Mon, 06 Dec 2010 03:55:25 +0000

While testing a script on IE8, me and my colleague kept getting the error “A script on this page is causing Internet Explorer to run slowly”. Below is a snapshot of the error:

After some research, I came across an article on MSDN which already had the solution: Microsoft KB # 175500. The part we are concerned about is in the section “Let me fix it myself”:

1.Using a Registry Editor such as Regedt32.exe, open this key: HKEY_CURRENT_USER\Software\Microsoft\Internet Explorer\Styles
Note: If the Styles key is not present, create a new key that is called Styles.
2. Create a new DWORD value called “MaxScriptStatements” under this key and set the value to the desired number of script statements. If you are unsure of what value you need to set this to, you can set it to a DWORD value of 0xFFFFFFFF to completely avoid the dialog.

For the curious ones, the article states that, to encounter the error, the DWord value of 0xFFFFFFFF must be added. The value equates to -1, which is what has been used in the function below.

The VBScript:

Sub IE_ChangeScriptTimeOut()
	Dim Registry, sKeyPath, sValueName, dwValue, sComputer
	CONST HKEY_CURRENT_USER = &H80000001
 
	sKeyPath = "Software\Microsoft\Internet Explorer\Styles"
	sValueName = "MaxScriptStatements"
	dwValue = -1
	sComputer = "."
 
	On Error Resume Next
		Set Registry = GetObject("winmgmts:{impersonationLevel=impersonate}!\\" &_ 
				sComputer & "\root\default:StdRegProv")
 
		Registry.CreateKey HKEY_CURRENT_USER, sKeyPath
		Registry.SetDWORDValue HKEY_CURRENT_USER, sKeyPath, sValueName, CLng(dwValue)
	On Error Goto 0
 
	Set Registry = Nothing
End Sub

Thanks for reading, and thanks for visiting Relevant Codes! :)

GUI Objects VBScript & Try Catch Finally

Anshoo Arora — Mon, 30 Aug 2010 06:31:17 +0000

VBScript’s error handling techniques have been quite limited to On Error statements, and even though they satisfy our needs to some extent, the lack of incorporating dynamic behavior with them has been a much bigger issue. Lee Harvey here shows how Classes can be extended to create simple Try-Catch-Finally statements with just a bit more work. I like this technique, and have been using it for the past few days with success. We know that this is not the best solution that is possible with a scripting language (JS does a lot better!), but its a start and a terrific workaround (thanks Lee!).

Creating Try-Catch-Finally Statements in VBScript

If you have already read Lee’s article, you can skip this part. Otherwise, a simple implementation is shown below:

As soon as the class executes, it enters Class_Initialize – Try statement
It encounters an error – Err.Raise 1002
As soon as it encounters an error, the Try statement (Class_Initialize) immediately ends execution
Because we’re releasing the Class reference using Set NewTryCatchFinally = Nothing right after initializing it, the Class enters Class_Terminate
Class_Terminate calls the Catch subroutine
When Catch runs in its entirety, Class_Terminate executes

On Error Resume Next
 
Class TryCatchFinally
 
    Private Sub Class_Initialize 'Try
        Print "Entering Try.." & vbNewLine
 
        Err.Raise 1002 'Raise a Syntax Error
        MsgBox "This line will not execute"
    End Sub
 
    Private Sub Catch 'Catch
        If Err.Number = 0 Then Exit Sub
 
        Print "Entering Catch.."
        Print "Error caught: " & Err.Description  & vbNewLine
 
        Err.Clear
    End Sub
 
    Private Sub Class_Terminate : Catch 'Finally
        Print "Exiting.." 
    End Sub
 
End Class
 
Set NewTryCatchFinally = New TryCatchFinally : Set NewTryCatchFinally = Nothing

The output of executing the above code should be the following:

Try Catch Finally Implementation in VBScript

We can see from the result that as soon as the Class executes, it enters Class_Initialize. When it encounters an error, it enters into Class_Terminate which contains (and executes) the Catch method. A simple yet such an elegant solution!

Utility Class & Error Handler

In this article, I will try to implement the technique with QTP’s GUI objects. To begin, let’s create a simple Login class with the following methods:

CheckPage
CheckImage
Login

The Login Class outputs the result through the Result property:

A simple Login Class

On Error Resume Next
 
Class Login
 
    Public Property Get Result
        Result = CheckPage And CheckImage And Login
    End Property
 
    Private Function CheckPage
        MsgBox "CheckPage" : CheckPage = True
    End Function
 
    Private Function CheckImage
        CheckImage = False
 
        Browser("title:=Welcome.*").WebElement("text:=Relevant Codes").Click 'Error here!

        MsgBox "Error!" 'This will not execute
    End Function
 
    'This will not execute
    Private Function Login
        MsgBox "Login"
    End Function
 
End Class
 
Dim NewLogin : Set NewLogin = New Login

Above, the Result property of the Login Class is called, which first executes CheckPage, then CheckImage and finally Login. Note that Login will only execute if CheckImage runs without any errors.

Let’s create another class that calls the methods of the original Login class, but with the error handling capabilities of a Try-Catch-Finally statement. This is also the Class that will always execute the original Login class because that’s where the actual error handling using Try-Catch-Finally exists.

Try..Catch..Finally with Class_Initialize & Class_Terminate

Class LoginHandler 'LoginHandler start

    Public bResult
 
    Private Sub Class_Initialize
         Print "Entering Try.." & vbNewLine
         bResult = NewLogin.Result
    End Sub
 
    Private Sub CatchErr
        If Err.Number = 0 Then Exit Sub
 
        Print "Entering Catch.."
        Print "Error: " & Err.Description & vbNewLine
 
        Err.Clear
    End Sub
 
    Private Sub Class_Terminate : CatchErr
        Print "Exiting.."
    End Sub
 
End Class 'LoginHandler end

Set NewLoginHandler = New LoginHandler
Set NewLoginHandler = Nothing
Set NewLogin = Nothing

The Class_Initialize method of the class calls the Result property of the Login class. Once Result is called, it executes all the methods called by the Result property. If any error occurs, CatchErr is immediately called by Class_Terminate and later, all code inside the Class_Terminate method is executed.

Output of executing Login Class & LoginHandler:

QTP Print Log

Method Containing the Error?

By including the name of each method in the very first line, we can also find out where exactly the error occurred. This, however, I agree is quite time consuming and repetitive work. The only alternative to this has been shown by PowerDebug Beta. However, if you would like to extend the above approach in VBScript, this *may be* the only possible approach. I’ve been wrong before, and would love to see a technique which simplifies the method naming approach used below.

Login Class with Method Names

On Error Resume Next
 
Class Login 'Login start

    Public sMethod
 
    Public Property Get Result
        Result = CheckPage And CheckImage And Login
    End Property
 
    Private Function CheckPage
        Me.sMethod = "CheckPage"
 
        MsgBox "CheckPage" : CheckPage = True
    End Function
 
    Private Function CheckImage
        Me.sMethod = "CheckImage"
 
        CheckImage = False
        Browser("title:=Welcome.*").WebElement("text:=Relevant Codes").Click 'Error here!
        
        MsgBox "Error!" 'This will not execute
    End Function
 
    Private Function Login 'This will not execute
        Me.sMethod = "Login"
 
        Msgbox "Login"
    End Function
 
End Class 'Login end
Dim NewLogin : Set NewLogin = New Login

LoginHandler (Outputs Method Names)

Class LoginHandler 'LoginHandler start

    Public bResult
 
    Private Sub Class_Initialize
         Print "Entering Try.." & vbNewLine
         bResult = NewLogin.Result
    End Sub
 
    Private Sub CatchErr
        If Err.Number = 0 Then Exit Sub
 
        Print "Entering Catch.."
        Print "Error occured in: " & NewLogin.sMethod
        Print "Error: " & Err.Description & vbNewLine
 
        Err.Clear
    End Sub
 
    Private Sub Class_Terminate : CatchErr
        Print "Exiting.."
    End Sub
 
End Class 'LoginHandler end

Set NewLoginHandler = New LoginHandler
Set NewLoginHandler = Nothing
Set NewLogin = Nothing

View code.

Output of executing Login Class & LoginHandler:

QTP Print Log

Notes

After using this technique for several days and manipulating it a bit from the original work, I have found some success. However, implementing Handler classes when the scope of the utility class increases can be quite challenging, and time consuming. I still believe its a start to something that we haven’t witnessed in QTP (yet). To be honest, I still prefer the old way of doing things where I can branch out most of my GUI code in conditional statements – which has enabled me to always create more comprehensive reporting.

My recommendation would be to use this approach with VBScript code instead of using it for QTP’s GUI objects, ofcourse, until absolutely necessary. Most of my usage for the above technique has been with pure VBScript code which has enabled me to create better error handling. In an upcoming article, I will show how this technique will be used to handle Excel errors and recover from them in the CatchErr method using a Select Case block. Including Try-Catch-Finally statements within Try-Catch-Finally statements is quite easily done in .NET, but its very complex to perform the same operation with VBScript. I’m still happy to have a start though.

If you have any questions, please ask them in the comments section.

Eval Function & Execute Statement

Anshoo Arora — Wed, 21 Apr 2010 20:24:29 +0000

This topic covers the concepts of the Eval function and Execute statement in depth. The function Eval is used to evaluate a string and return the result of the string expression. The Execute statement on the other hand, executes one or more statements in a string expression and enables creation of dynamic code. Multiple statements can be executed at once by using colons or line breaks to separate them.

If you have had a chance to use RelevantCodes[1]One and went over the function libraries, you would find that all the events are controlled through Execute statement – data is retrieved from the Excel Table and parsed by the function libraries into string statements. Once parsed, these string statements are then executed in the same manner as QTP code.

Eval Syntax

Eval(expression)

Execute Syntax

Execute statement

Difference between Eval & Execute

In the syntax above, both expression and statement arguments are string statements. Both expressions can be derived from VBScript or QTP code; the difference lies in the fact that Eval will always return the result of the string evaluation whereas Execute will execute a string statement for execution and will not retrieve the result (but there are workarounds). The following example demonstrates the main difference between the 2 functions:

x = 9
y = 10
 
bIsEqual = Eval("x = y")
Execute "x = y"
 
MsgBox "bIsEqual: " & bIsEqual
MsgBox "X is no longer 9. It is: " & x

Eval Function

Execute Statement

Note that Eval returned a Boolean value whereas Execute function performed a variable assignment. This article will cover the usage of both techniques in depth through both VBS and QTP code.

You must be wondering why the syntax for Eval and Execute is different. The reason is that, Eval is a function. Execute is not. That means, the following statement for Eval: bIsEqual = Eval("x = y"), when written for Execute will return a Null value for bResult (but assignment will be performed for x):

bResult = Execute("x = y")
MsgBox bResult
MsgBox "x: " & x

Null Output

X = 10

With that said, let me share the workaround that can be used with Execute to return the evaluation just like we did with Eval. Here’s how:

x = 9
y = 10
 
Execute "z = (x = y)"
MsgBox "z: " & z

Return Z (False)

More on this concept will be covered in the section Evaluating Statements.

Creating Variables

Let’s assume a scenario where you need to create the following variables: var_1, … , var_5. One way is to manually create the variables:

var_1 = 1 : var_2 = 2 : var_3 = 3 : var_4 = 4: var_5 = 5

A quicker, and more dynamic way to achieve the same is through Execute statement:

For ix = 1 to 5
    Execute "var_" & ix & " = " & ix
Next

Option Explicit

Using the Execute statement also has a direct impact if the Option Explicit statement is ON. If a variable is not explicitly declared, an error will be occurred:

Option Explicit
 
iNumber = 9

Run Error

When the same variable is created through Execute, the error will not occur and the variable will be created and value assigned successfully.

Option Explicit
 
Execute "iNumber = 9"

Evaluating Statements

Instead of equating variables and values, we will evaluate statements using Eval. A quick example using IsObject is demonstrated below:

Set dicObject = CreateObject("Scripting.Dictionary")
 
If Eval("IsObject(dicObject)") Then
    MsgBox "Object created."
    Set dicObject = Nothing
End If

Similarly, the above code can be broken into a Select Case block and variables can be evaluated by their type:

Sub RetType(ByVal var)
	Select Case Eval("TypeName(var)")
		Case "Integer" : MsgBox "Integer"
		Case "Dictionary" : MsgBox "Dictionary"
		Case "Nothing" : MsgBox "Nothing"
		Case "String" : MsgBox "String"
	End Select
End Sub
 
Call RetType(Nothing)
Call RetType("Test")
Call RetType(CreateObject("Scripting.Dictionary"))
Call RetType(1)

Upon execution, the following results will be retrieved:

RetType(Nothing)

RetType('Test')

RetType(CreateObject)

RetType(1)

The same function above can be written through Execute. However, with Execute, we cannot directly retrieve the result (it is not a function, unlike Eval). Therefore, we will create a variable and store the result with the variable; the variable will then be used as the Select Case condition.

Sub RetType(ByVal var)
	Dim bResult
 
	Execute "bResult = TypeName(var)"
 
	Select Case bResult
		Case "Integer" : MsgBox "Integer"
		Case "Dictionary" : MsgBox "Dictionary"
		Case "Nothing" : MsgBox "Nothing"
		Case "String" : MsgBox "String"
	End Select
End Sub
 
Call RetType(Nothing)
Call RetType("Test")
Call RetType(CreateObject("Scripting.Dictionary"))
Call RetType(1)

In short then, with Execute, bResult is represented within the string statement:

Execute "bResult = TypeName(var)"

With Eval, bResult is an actual variable that holds the result like below:

bResult = Eval("TypeName(var)")

Creating Functions

I have seen this approach rarely used, but its important to know all the possibilities nonetheless. Yes, we can create Functions (really!) at run-time, as long as everything is a string and new lines are separated by colons or a line feed. This approach is generally fine for small functions, but it can get really confusing and hard to debug as the lines of code increase.

sFunc = "Function ExecuteTest"
sFunc = sFunc & vbLf
sFunc = sFunc & "MsgBox ""ExecuteTest executed."""
sFunc = sFunc & vbLf
sFunc = sFunc & "End Function"
 
Execute sFunc
 
Call ExecuteTest()

Function ExecuteTest()

We can write the same code above using colons (:) as well:

Execute "Function ExecuteTest : MsgBox ""ExecuteTest executed."" : End Function"
 
Call ExecuteTest()

Executing QTP Statements

This is where the Execute statement absolutely shines. As stated before, RelevantCodes[1]One executes all keywords through Execute statement. It retrieves keywords from the Excel Table as strings at runtime, creates the relevant hierarchies, and executes the hierarchies with chosen events. The concept here and the concepts covered by previous examples will remain the same: we create action strings and execute them. The last example in this topic will show how different strings can be joined together to implement events on supplied test-objects (as strings).

Let’s start with a quick example to check if our target browser exists:

strBrowser = "Browser(""title:=Google"")"
 
Execute "MsgBox " & strBrowser & ".Exist(0)"

The above code can also be written with Eval as well, enabling us to retrieve the value directly instead of using the workaround approach if we were to use Execute:

strBrowser = "Browser(""title:=Google"")"
 
bExist = Eval(strBrowser & ".Exist(0)")

The above statement when executed does the same operation as it would when you would verify the browser existence using an inline DP statement: Msgbox Browser("title:=Google").Exist(0). Let’s consider another example where we create an event on a WebEdit object by creating an object hierarchy through strings at run time.

strBrowser = "Browser(""title:=Google"")"  'Browser("title:=Google")
strPage    = "Page(""title:=Google"")"     'Page("title:=Google")
strText    = "WebEdit(""name:=q"")"        'WebEdit("name:=q")
strEvent   = "Set ""Execute Test"""        'Set "Execute Test"

Execute strBrowser & "." & strPage & "." & strText & "." & strEvent

It does look interesting, doesn’t it? The same approach can be used if you are using Object Repository instead of Descriptive Programming; simply replace the Programmatic Descriptions with the Logical Descriptions in your OR, parse everything in a string and Execute it!

The example below shows how QTP code can be executed into succession through strings. The last 4 statements show how all strings are combined together to 1. Enter the search terms, 2. Click Search Button, 3. Synchronize and 4. Navigate back to the Google search page.

strBrowser = "Browser(""title:=.*Google.*"")"      'Browser("title:=Google")
strPage    = "Page(""title:=.*Google.*"")"         'Page("title:=Google")
strText    = "WebEdit(""name:=q"")"                'WebEdit("name:=q")
strButton  = "WebButton(""value:=Google Search"")" 'WebButton("value:=Google Search")
strEvent   = "Set ""Execute Test"""                'Set "Execute Test"
strClick   = "Click"                               'Click
strSync    = "Sync"                                'Sync
strBack    = "Back"                                'Back

Execute strBrowser & "." & strPage & "." & strText & "." & strEvent
Execute strBrowser & "." & strPage & "." & strButton & "." & strClick
Execute strBrowser & "." & strSync
Execute strBrowser & "." & strBack

The above strings are equivalent to the following QTP code:

Browser("title:=.*Google.*").Page("title:=.*Google.*").WebEdit("name:=q").Set "Execute Test"
Browser("title:=.*Google.*").Page("title:=.*Google.*").WebButton("value:=Google Search").Click
Browser("title:=.*Google.*").Sync
Browser("title:=.*Google.*").Back

Closing Remarks

I hope this article has covered most of the common (and uncommon) uses of Eval and Execute. I’m sure you’ll find areas in your framework where these 2 techniques will make things cleaner and more dynamic. If there is something I have omitted, please feel free to share it with us. I hope you guys find this article useful :)

If you have any questions, please ask them in the comments section. If your query is confidential, please use the Contact Form to send me an e-mail instead.

VBScript: Compare 2 Excel Files

Anshoo Arora — Mon, 22 Mar 2010 18:31:29 +0000

This post shows a quick and easy way to compare 2 Excel files. I know there are several code snippets on forums that show how to compare do this, so you may ask the following question: how is this technique any different? What makes this technique different is performance. I know there may be faster ways to achieve this, but after much experiment, this was the one that continuously worked at the best speed in comparison to other methods.

Download Class | View Class

The main concept of this technique is performing all validations through a range object, instead of traversing all cells of an Excel sheet (which takes a little longer). Below is the skeleton of how the class is arranged, with documentation. Please use one of the download links above to download this class. There is a usage example shown at the end of this article.

Class clsExcelComparer

Class clsComparer
	'[--- Region Private Variables Start ---]

	Private oExcel		'Excel.Application
	Private arrRangeUno	'Range.Value (array) of the Primary Excel spreadsheet
	Private arrRangeDos	'Range.Value (array) of the Secondary Excecl spreadsheet
	Private oDict		'Scripting.Dictionary containing unmatched cells

	'[--- Region Private Variables End ---]

 
	'[--- Region Public Variables Start ---]

	Public Operation	'0: Only Compare   1: Compare & Highlight Differences

	'[--- Region Public Variables End ---]

 
	'--------------------------------------------------------
	' Name: Function Compare [Public]
	'
	' Remarks: N/A
	'
	' Purpose: Compares differences between 2 Excel Spreadsheets
	'	
	' Arguments:
	'	sWorkBookUno: Primary Excel WorkBook (with complete path)
	'	vSheetUno: Primary Excel Spreadsheet Name
	'	sWorkBookDos: Secondary Excel WorkBook (with complete path)
	'	vSheetDos: Secondary Excel Spreadsheet Name
	'
	' Return: Boolean
	'
	' Author: Anshoo Arora, Relevant Codes
	'
	' Date: 03/17/2010
	'
	' References: N/A
	'--------------------------------------------------------
	Public Function Compare(sWorkBookUno, vSheetUno, sWorkBookDos, vSheetDos)
 
	End Function
 
	'--------------------------------------------------------
	' Name: Function CellsFound [Private]
	'
	' Remarks: N/A
	'
	' Purpose: Finds the dissimilar cells between 2 sheets
	'	
	' Arguments: N/a
	'
	' Return: Integer
	'
	' Author: Anshoo Arora, Relevant Codes
	'
	' Date: 03/17/2010
	'
	' References: N/A
	'--------------------------------------------------------
	Private Function CellsFound()
 
	End Function
 
	'--------------------------------------------------------
	' Name: Sub Class_Terminate [Private]
	'
	' Remarks: N/A
	'
	' Purpose: Disposes the Excel.Application object
	'	
	' Arguments: N/A
	'
	' Author: Anshoo Arora, Relevant Codes
	'
	' Date: 03/17/2010
	'
	' References: N/A
	'--------------------------------------------------------
	Private Sub Class_Terminate()
 
	End Sub
 
End Class
 
'--------------------------------------------------------
' Name: Function CompareExcelSheets
'
' Remarks: N/A
'
' Purpose: Constructor for Class clsComparer
'	
' Arguments:
'	sWorkBookUno: Primary Excel WorkBook (with complete path)
'	vSheetUno: Primary Excel Spreadsheet Name
'	sWorkBookDos: Secondary Excel WorkBook (with complete path)
'	vSheetDos: Secondary Excel Spreadsheet Name
'	Operation: 0: Compare Only   1: Compare & Highlight Differences
'
' Return: Boolean
'
' Author: Anshoo Arora, Relevant Codes
'
' Date: 03/17/2010
'
' References: N/A
'--------------------------------------------------------
Function CompareExcelSheets(sWorkBookUno, vSheetUno, sWorkBookDos, vSheetDos, Operation)
 
End Function

Download clsComparer (645) | View clsComparer (602)

Usage (Example)

Consider the following 2 Excel Sheets, with a few dissimilar cells:

Sheet #1 Original

Sheet #2 Original

There are 2 main operations that can be done through our code. 1. We can simply check if both Excel Sheets are similar and 2. we can check as well as highlight the differences between the two. To only compare the 2 sheets, without highlighting the differences the Operation argument will have a value of 0. On the other hand, to compare as well as highlight the values, the Operation argument will have a value of 1. Let’s first consider a case where the 2 sheets are only to be compared:

Compare Only

'Only Compare:
MsgBox CompareExcelSheets("C:\Test1.xls", "Sheet1", "C:\Test2.xls", "Sheet1", 0)

Because the 2 sheets are not similar, the following will be the output upon execution of the above statement:

Compare Only

Also, the 2 sheets will remain unchanged.

When changing the value of Operation to 1, we will notice that, not only does the code compare the 2 sheets, but also highlights the differences.

Compare and Highlight Differences

'Compare and highlight differences:
MsgBox CompareExcelSheets("C:\Test1.xls", "Sheet1", "C:\Test2.xls", "Sheet1", 1)

Upon execution of the above statement, the following 2 sheets will be highlighed in areas where they differ:

Sheet #1 With Highlighted Differences

Sheet #2 with Highlighted Differences

Limitations

1. This code will work with Excel Sheets with the same number of rows and columns in each (like ranges).

Update: RelevantCodes.Comparer COM DLL

The following .NET assembly is available as well to download: here.

Snapshot of the assembly can be found here.

To register the assembly to your PC, the following code can be used:

RegAsm C:\RelevantCodes.dll /codebase

C:\WINDOWS\Microsoft.NET\Framework\v2.0.50727\RegAsm.exe C:\RelevantCodes.dll /codebase

Once done, the code can be used in QTP like this:

Set oCompare = CreateObject("RelevantCodes.Comparer")

oCompare. should give you the proper intellisense to use all methods. The assembly compares the following items:

Arrays
Excel Sheets
Images
Integers
Strings
TextFiles

I hope you find this useful :)

If you have any questions, please ask them in the comments section. If your query is confidential, please use the Contact Form to send me an e-mail instead.

RelevantCodes[1]One – QTP Automation Framework

Anshoo Arora — Mon, 04 Jan 2010 10:51:11 +0000

The first release of RelevantCodes[1]One is ready, and has been successfully tested on QTP versions 9.2, 9.5 and 10.0. I would like to thank Clive Farrington, Mahesh Upadhyay and Sunitha Reddy for helping me beta-test this framework. I really appreciate your efforts, guys!

Download RelevantCodes[1]One (6171)

Be sure to view the videos at the end of this post, which show RelevantCodes[1]One being initiated through the Excel Table, and full executions on versions 9.2 and 10.0.

January 27, 2010: Added examples. These show how DP statements can be converted to RelevantCodes[1]One keywords.

Features:

OO Architecture
Custom DOTNetFactory Form
Hierarchical Reporting
Product Version Settings
Single Block for Loading and Unloading Global Objects
Advanced Dictionary Object usage
Generic Structure (Currently supports Web & Standard Windows)
Simple Validations
Custom CheckPoints
Supports execution on multiple windows/browsers (see Test Case 002)
Simple Reporting
Data Sheet with Custom Macros (macros will not available for viewing)
Customized Test Execution
Supports multiple object descriptions

I have tried to keep everything quite basic in this release, but there will be several enhancements in the next, including a CustomUserActions object which will give ability to create tests from the Table as well as perform custom actions through code simultaneously. Also in the next release will be featured an upgrade to the Implementor Class, that will enable multiple iterations of a group of statements from the Data Table.

Setting Up

1. Download, unzip and copy the RelevantCodes folder to your “C:\”. The folder structure should look exactly like:

C:\RelevantCodes\RelevantCodes[1]One\0.1

2. In the folder C:\RelevantCodes\RelevantCodes[1]One\0.1\Test Resources\Excel Tables: change the name of the relevant table to Data.xls. If you are using QTP 9.2 or below, rename Data92.xls to Data.xls. For versions 9.5 and higher, rename Data95+.xls to Data.xls.

Current Version

0.1 Beta

Found a Bug. What should I do now?

If any issues that you may encounter, please use the comments section to notify me. I will try to have the fix ready, and the fix will be implemented in the next version, giving full credit to you for finding the bug. If the bug requires a small fix, then, the solution will be available for everyone to view/download immediately.

Will it support other technologies other than Web and Standard Windows?

Technically, this design is capable of working with all sorts of technologies, but because I don’t have access to other add-ins, this may not be possible in the near future. However, if someone is willing to utilize their time in this upgrade, you are most welcome to. If you get this framework to work with other technologies successfully, I would be happy to share it with the everyone giving full credit to your extraordinary work.

Does RelevantCodes[1]One come under any warranties?

No, and Relevant Codes, Anshoo Arora or any associated parties cannot be held responsible for any damage caused by the use of RelevantCodes[1]One.

Copyright Notice / License Agreement

RelevantCodes[1]One is being released under Creative Commons 3.0 Attribution License. For more information about this license, please view this topic at Creative Commons website. In other words, you can distribute, remix, tweak, and build upon this framework as long as you give proper credit to the authors, and to RelevantCodes.com. You must also leave the terms in the License Agreement in the source folder unchanged. Click here to view the Creative Commons 3.0 Attribution license legal code.

RelevantCodes[1]One Automation Framework by Anshoo Arora [RelevantCodes.com] is licensed under a Creative Commons Attribution 3.0 United States License.
Based on a work at relevantcodes.com.

Defects

1. Implementor.cls.vbs => Function CheckProperty: The value parsed after using Mid(), the property value stored in sExpected the result is stored in a variable cast as string, however, when using Execute() to set the value of sValue the value is being stored in a variable cast as boolean when performing the compare on these two variable types the checkpoint is failing when it should be passing. [Snapshot] [Credits go to Brock Vietor for reporting this defect; this defect is reported as-is from Brock's e-mail. Brock: Many thanks for your great reporting style and wonderful feedback!]

2. Engine.vbs.cls: Remove/Comment line #15 (Private TestData). Instead, insert Public TestData on line 2. This should fix the bug as reported in this comment. [Credits go to Daim Phillips for finding and reporting this defect. Daim: Thanks for all your time and efforts that went into finding and reporting this defect!]

Converting DP Into RelevantCodes[1]One Keywords

Example 1: Click Image

Browser("title:=Test").Page("title:=Test").Image("name:=ThisImage").Click

Parent       | Child | Description     | Event | Value
--------------------------------------------------------------------------
Browser Page | Image | name:=ThisImage | Click | ""

Example 2: Click Image (Multiple Properties)

Browser("title:=Test").Page("title:=Test").Image("name:=ThisImage", "index:=0").Click

Parent       | Child | Description                 | Event | Value
--------------------------------------------------------------------------
Browser Page | Image | [name:=ThisImage][index:=0] | Click |

Example 3: Enter Value in a Text Box

Browser("title:=Test").Page("title:=Test").WebEdit("name:=ThisText").Set "RelevantCodes[1]One"

Parent       | Child   | Description    | Event | Value
--------------------------------------------------------------------------
Browser Page | WebEdit | name:=ThisText | Set   | RelevantCodes[1]One

Example 4: Launching a Browser and Clicking “Links”

SystemUtil.Run "iexplore.exe", "http://relevantcodes.com"
Browser("title:=.*Relevant Codes.*").Link("innertext:=Links").Click

Parent       | Child | Description      | Event  | Value
--------------------------------------------------------------------------
Browser      |       | Relevant Codes   | Launch | http://relevantcodes.com
Browser      | Link  | innertext:=Links | Click  |

Example 5: Launching a Browser, Clicking “Links” and closing the Browser

SystemUtil.Run "iexplore.exe", "http://relevantcodes.com"
Browser("title:=.*Relevant Codes.*").Link("innertext:=Links").Click
Browser("title:=.*Relevant Codes.*").Close

Parent       | Child | Description      | Event  | Value
--------------------------------------------------------------------------
Browser      |       | Relevant Codes   | Launch | http://relevantcodes.com
Browser      | Link  | innertext:=Links | Click  |
Browser      |       | Relevant Codes   | Close  |

Example 6: Launching a Browser, Clicking “Links”, Synchronizing and closing the Browser

SystemUtil.Run "iexplore.exe", "http://relevantcodes.com"
Browser("title:=.*Relevant Codes.*").Link("innertext:=Links").Click
Browser("title:=.*Relevant Codes.*").Sync
Browser("title:=.*Relevant Codes.*").Close

Parent       | Child | Description      | Event  | Value
--------------------------------------------------------------------------
Browser      |       | Relevant Codes   | Launch | http://relevantcodes.com
Browser      | Link  | innertext:=Links | Click  |
Browser      |       | Relevant Codes   | Sync   |
Browser      |       | Relevant Codes   | Close  |

Example 7: Adding a new Browser to the Object Class

Note: The Activate method can be used to Activate a Browser, as well as add it to the clsImplementor Object Collection. This example shows how a resulting (new) browser TestDomain2 is added to the collection by specifying its properties.

'Open New Browser
SystemUtil.Run "iexplore.exe", "http://Domain.com"
'Clicking the link opens another Browser
Browser("title:=testDomain_1").Link("innertext:=OpenNewBrowser").Click
'Synchronize with new browser
Browser("title:=testDomain_2").Sync
Browser("title:=testDomain_2").Close
Browser("title:=testDomain_1").Close

Parent       | Child | Description      | Event  | Value
--------------------------------------------------------------------------
Browser      |       | TestDomain1               | Launch   | http://Domain.com
Browser      | Link  | innertext:=OpenNewBrowser | Click    |
Browser      |       | TestDomain2               | Activate | title:=testDomain_2
Browser      |       | TestDomain2               | Sync     |
Browser      |       | TestDomain2               | Close    |
Browser      |       | TestDomain1               | Activate |
Browser      |       | TestDomain1               | Close    |

Demos

I have created 3 simple runs. The first demonstrates RelevantCodes[1]One usage with a single browser, the second run demonstrates its usage with multiple browsers simultaneously and the last one demonstrates a simple execution with a standard windows application. The 4th test case is blank, and you can create more such blank test cases to experiment with this framework. The “Execute Y” determines which test case in the Excel Spreadsheet are going to be executed. Any test case with “Execute N” flag will not execute.

Executing Selected Tests through Excel Spreadsheet

Version 9.2

Version 10.0

Download RelevantCodes[1]One (6171)

QTP: Create Test Archives

Anshoo Arora — Fri, 28 Aug 2009 02:27:37 +0000

photo credit: Yme Bosma

This topic discusses archiving files created during a test session. These can be text files, XMLs, custom snapshots etc. The important bit is to keep them in one centralized test folder. At my current project, one of the core requirements of any automated test-suite is capturing snapshots wherever required by the user. Because each suite has several test scripts, we end up collecting hundreds of snapshots in each cycle. This is where archives come in – we create archives for each script, making it easier for the users to refer to the correct folder for the test and the time the test was run.

Assume you have a folder ‘Test XYZ’ is where you are storing all the runtime files and snapshots:

Z:\Automated Scripts\QuickTest Professional\Some Application\Image Captures\Test XYZ\

Using the technique below, you can create quick archives for each test session. I usually do this at the end of my tests, but this procedure can be called anywhere in the script.

Assume (again) you have the following file structure during a run-session:

Before Archiving

After running the following line of code:

'C:\Demo is the parent test folder
Call CreateTestArchive("C:\Demo")

You will see a neat archive folder with the correct timestamp:

After Archiving

The contents of the newly created folder (005) will now carry all the files that were in the parent folder:

Archive Folder- Contents

How it’s done:

'-------------------------------------------
' Name: function CreateTestArchive
' 
' Purpose: Creates an archive folder with a date-time stamp
'
' Input(s):
'      sPath - Path of the parent folder where all the files are located
'
' Output:
'      ""
'-------------------------------------------
function CreateTestArchive(sPath)
'-------------------------------------------
	Dim oFSO, oFolder, colSubFolder, sFolder
 
	'FileSystemObject
	Set oFSO = CreateObject("Scripting.FileSystemObject")
	'Bind to the supplied path
	Set oFolder = oFSO.GetFolder(sPath)
	'Retrieve collection of all subfolders
	Set colSubFolder = oFolder.SubFolders
 
	'Create numbering for the new folder
	Select Case Len(CStr(colSubFolder.Count))
		Case 1: sFolder = "00"
		Case 2: sFolder = "0"
		Case Else: sFolder = ""
	End Select
 
	'New folder name: this part can be modified so naming convention complies
	' 	to your guidelines.
	'Example: 009 - Archive Aug, 09 2009 3.05.02 PM
	sFolder = sFolder & colSubFolder.Count + 1 & " - Archive " & _
		  ParseDate(Date, "MMM, dd yyyy") & " " & Replace(Time, ":", ".")
 
      'Move all files to the new folder
	If oFolder.Files.Count > 0 Then
		If Not InStr(Len(sPath), sPath, "\") <> 0 Then sPath = sPath & "\"
		'Create the new folder
		oFSO.CreateFolder sPath & sFolder
		oFSO.MoveFile sPath & "*.*", sPath & sFolder
	End If
 
	Set oFSO = Nothing
	Set oFolder = Nothing
	Set colSubFolder = Nothing
end function

The snippet below parses the date to a desired format. I am using MM, dd yyyy, but you can modify this to support any format, or multiple formats:

'-------------------------------------------
' Name: function ParseDate
'
' Purpose: Uses DOTNetFactory to parse date in desired format
'
' Input(s):
'      dtDate: Date that is to be parsed
'      sFormat: Format in which the date is to be parsed
'
' Output:
'      Date
'-------------------------------------------
function ParseDate(dtDate, sFormat)
'-------------------------------------------
	Dim oInstance
 
	Set oInstance = DotNetFactory.CreateInstance("System.DateTime")
	ParseDate = oInstance.Parse(CStr(dtDate)).ToString(sFormat)
 
	Set oInstance = Nothing
end function

I hope you will like this simple approach.

Thanks for visiting Relevant Codes :)

If you have any questions, please ask them in the comments section. If your query is confidential, please use the Contact Form to send me an e-mail instead.

QTP: Using VBScript Classes as Test Modules I

Anshoo Arora — Thu, 13 Aug 2009 02:17:23 +0000

photo credit: jared

Using Classes as Test Modules in QTP (Part I).

In this article, techniques of creating modular classes will be demonstrated. Usage of modular classes helps in keeping all methods and properties for a module intact, and if done correctly, this can simply maintenance greatly. This article serves as an introduction to Class usage in QTP. In the coming articles, we will discover advanced concepts in building highly stable and robust class modules.

Each modular class can contain one or more methods, which provide some functionality to a framework. Before adding the appropriate methods, we must create a modular class. In our demonstration, ‘clsLogin’ has been created, which as the name suggests, is a Login class.

Class clsLogin
 
End Class

The goal of the class we created above is to Login to the Mercury Tours website. Let’s name our method ‘Login’ and include the steps that the method will perform:

Class clsLogin
 
    ' Login
    Public Function Login( sUserName, sPassword )
        'Page title
        Dim sTitle: sTitle = "Welcome: Mercury Tours"
 
        Login = False
 
        With Browser( "title:=" & sTitle ).Page( "title:=" & sTitle )
            'Set the userName
            .WebEdit( "name:=userName" ).Set sUserName
            'Set the password
            .WebEdit( "name:=password" ).SetSecure sPassword
            'Click SignIn
            .Image( "name:=login" ).Click
        End With
 
        'If the correct Page appears: Step Passed
        If Browser( "title:=Find a Flight: Mercury Tours:" ).Exist( 5 ) Then
            Login = True
        End If
    End Function
 
End Class

Let’s assume we have to check properties of the page banner, which is a part of our test-case. In reality, there may be multiple objects for which properties are being verified and they can be included within the same method. For our example though, we will verify property of a single object: page banner.

Class clsLogin
 
    ' CheckObjectProperties
    Public Function CheckObjectProperties
        'Page title
        Dim sTitle: sTitle = "Welcome: Mercury Tours"
 
        CheckObjectProperties = False
 
        With Browser("title:=" & sTitle).Page("title:=" & sTitle)
            'Check Page Banner
            If .Image("file name:=banner2.gif").GetROProperty("width") = 488 Then
                'If the width equals the expected width, step passed
                CheckObjectProperties = True
                Reporter.ReportEvent micPass, "Banner", "Size Correct."
            Else
                Reporter.ReportEvent micFail, "Banner", "Size Incorrect."
            End If
        End With
    End Function
 
    ' Login
    Public Function Login( sUserName, sPassword )
        Dim sTitle: sTitle = "Welcome: Mercury Tours"
 
        Login = False
 
        With Browser( "title:=" & sTitle ).Page( "title:=" & sTitle )
            'Set the userName
            .WebEdit( "name:=userName" ).Set sUserName
            'Set the password
            .WebEdit( "name:=password" ).SetSecure sPassword
            'Click SignIn
            .Image( "name:=login" ).Click
        End With
 
        Browser( "title:=" & sTitle ).Sync
 
        'If the correct Page appears: Step Passed.
        If Browser( "title:=Find a Flight: Mercury Tours:" ).Exist( 5 ) Then 
            Login = True
        End If
    End Function
 
End Class

The 2 methods discussed above are quite common: we generally perform actions on objects and create checks to replace (manual) visual verifications. Now, before we can really perform the above 2 checks, we may also need to check whether we’re on the correct page. Let’s add another method for that:

Class clsLogin
 
    ' IsPageFound: Check if we're on the correct page
    Public Function IsPageFound
        'Page title
        Dim sTitle: sTitle = "Welcome: Mercury Tours"
 
        IsPageFound = False
 
        With Browser( "title:=" & sTitle ).Page( "title:=" & sTitle )
            If .Exist( 10 ) Then
                IsPageFound = True
            End If
        End With
    End Function
 
    ' CheckObjectProperties
    Public Function CheckObjectProperties
        Dim sTitle: sTitle = "Welcome: Mercury Tours"
 
        CheckObjectProperties = False
 
        With Browser( "title:=" & sTitle ).Page( "title:=" & sTitle )
            'Check Page Banner
            If .Image("file name:=banner2.gif").GetROProperty("width") = 488 Then
                CheckObjectProperties = True
                Reporter.ReportEvent micPass, "Banner", "Size Correct."
            Else
                Reporter.ReportEvent micFail, "Banner", "Size Incorrect."
            End If
        End With
    End Function
 
    ' Login
    Public Function Login( sUserName, sPassword )
        Dim sTitle: sTitle = "Welcome: Mercury Tours"
 
        Login = False
 
        With Browser( "title:=" & sTitle ).Page( "title:=" & sTitle )
            'Set the userName
            .WebEdit( "name:=userName" ).Set sUserName
            'Set the password
            .WebEdit( "name:=password" ).SetSecure sPassword
            'Click SignIn
            .Image( "name:=login" ).Click
        End With
 
        'If the correct Page appears: Step Passed.
        If Browser( "title:=Find a Flight: Mercury Tours:" ).Exist( 5 ) Then 
            Login = True
        End If
    End Function
 
End Class

If we observe the code above, the variable “sTitle” is present in each method. This is quite redundant. We can simply replace this with a readOnly property:

Class clsLogin
 
    ' Property sTitle
    Private Property Get sTitle 'ReadOnly Property
        sTitle = "Welcome: Mercury Tours"
    End Property
 
    ' IsPageFound
    Public Function IsPageFound
        IsPageFound = False
 
        With Browser( "title:=" & sTitle ).Page( "title:=" & sTitle )
            If .Exist( 10 ) Then
                IsPageFound = True
            End If
        End With
    End Function
 
    ' CheckObjectProperties
    Public Function CheckObjectProperties
        CheckObjectProperties = False
 
        With Browser( "title:=" & sTitle ).Page( "title:=" & sTitle )
 
            'Check Page Banner
            If .Image("file name:=banner2.gif").GetROProperty("width") = 488 Then
                CheckObjectProperties = True
                Reporter.ReportEvent micPass, "Banner", "Size Correct."
            Else
                Reporter.ReportEvent micFail, "Banner", "Size Incorrect."
            End If
 
        End With
    End Function
 
    ' Login
    Public Function Login( sUserName, sPassword )
        Login = False
 
        With Browser( "title:=" & sTitle ).Page( "title:=" & sTitle )
            'Set the userName
            .WebEdit( "name:=userName" ).Set sUserName
            'Set the password
            .WebEdit( "name:=password" ).SetSecure sPassword
            'Click SignIn
            .Image( "name:=login" ).Click
        End With
 
        'If the correct Page appears: Step Passed.
        If Browser( "title:=Find a Flight: Mercury Tours:" ).Exist( 5 ) Then 
            Login = True
        End If
    End Function
 
End Class

Even though some methods of a class are crucial, they may only perform background operations. In our demonstration, ‘IsPageFound’ and ‘CheckObjectProperties’ are such methods. Both methods verify objects, and in the automation world, they can be very reasonable prerequisites to the main action, which is to Login to the application. In the demonstration below, ‘IsPageFound’ and ‘CheckObjectProperties’ have been marked as private. Both methods are included as a prerequisite to setting the userName and password for logging to the website. To reiterate, both ‘IsPageFound’ and ‘CheckObjectProperties’ can be made private methods of the class:

Class clsLogin
 
    ' IsPageFound: Private Function
    Private Function IsPageFound
        IsPageFound = False
 
        With Browser( "title:=" & sTitle ).Page( "title:=" & sTitle )
            If .Exist( 10 ) Then
                IsPageFound = True
            End If
        End With
    End Function
 
    ' CheckObjectProperties: Private Function
    Private Function CheckObjectProperties
        CheckObjectProperties = False
 
        With Browser( "title:=" & sTitle ).Page( "title:=" & sTitle )
 
            'Check Page Banner
            If .Image( "file name:=banner2.gif" ).GetROProperty( "width" ) = 488 Then
                CheckObjectProperties = True
                Reporter.ReportEvent micPass, "Banner", "Size Correct."
            Else
                Reporter.ReportEvent micFail, "Banner", "Size Incorrect."
            End If
 
        End With
    End Function
 
    ' Login: Public Function
    Public Function Login( sUserName, sPassword )
        Login = False
 
        If IsPageFound Then
            If CheckObjectProperties Then
                With Browser( "title:=" & sTitle ).Page( "title:=" & sTitle )
                    'Set the userName
                    .WebEdit( "name:=userName" ).Set sUserName
                    'Set the password
                    .WebEdit( "name:=password" ).SetSecure sPassword
                    'Click SignIn
                    .Image( "name:=login" ).Click
                End With
            End If
        End If
 
        'If the Page with the title 'Find a Flight: Mercury Tours:' appears: Step Passed.
        If Browser( "title:=Find a Flight: Mercury Tours:" ).Exist( 5 ) Then 
            Login = True
        End If
    End Function
 
    ' Property sTitle: Private Property
    Private Property Get sTitle
        sTitle = "Welcome: Mercury Tours"
    End Property
 
End Class

If you notice the code above, you will see that both private methods have become a part of the Login method. They’re both prerequisites to logging in to the application. Only once both are True, will the code perform the code-action of the class. We can implement the class above using the following snippet:

Public Function Login( sUserName, sPassword )
    Dim oAction: Set oAction = New clsLogin
    Login = oAction.Login( sUserName, sPassword )
End Function

If you would like to keep ‘IsPageFound’ and ‘CheckObjectProperties’ as public methods of the class, then you can even do this:

Public Function Login( sUserName, sPassword )
    Dim oAction: Set oAction = New clsLogin  
 
    Login = False
 
    With oAction
        If .IsPageFound Then
            If .CheckObjectProperties Then
                Login = .Login( sUserName, sPassword )
            End If
        End If
    End With
End Function

It is possible for a single function to do everything, but don’t you think its much easier to understand what each method of the class does with little effort? ‘IsPageFound’ simply checks if we’re on the correct page, ‘CheckObjectProperties’ checks if the object was loaded correctly, and ultimately, ‘Login’ performs to core-action by logging the user to the application. Moreover, all methods are grouped together in a class.

In practice, the entire test suite can be created on this principle with each module representing a core-functionality of the overall test. There are several ways to bind these modules together, and we must find an elegant solution for that as well. This is because, because of some major changes, we may need to completely remove a module, or even add one. Therefore, if done correctly, even such a big change can be implemented without much trouble. We will discuss such a technique in the next article in this series, which will be an advanced implementation of class usage in QTP.

I hope you guys find this article useful.

References

Implementing a GUI Layer of Classes by Meir-Bar Tal (AdvancedQTP, Solmar)

If you have any questions, please ask them in the comments section. If your query is confidential, please use the Contact Form to send me an e-mail instead.

CDO: Send Email from Yahoo, Hotmail, Live, AOL or GMail

Anshoo Arora — Mon, 10 Aug 2009 21:48:09 +0000

photo credit: Philippe sergent

This article discusses 2 ways of sending e-mail from your Yahoo, Hotmail, Gmail, Live or AOL e-mail accounts using the ‘clsSendMail’ class:

Calling the Method with the Body Message
Retrieve body-messages from text files

This can be quite handy during regression cycles – you can use this code to send yourself an e-mail whenever a step in the test process fails. You can even keep a count of the number of times this procedure executes in your script and even stop your test if too many steps fail.

Calling the Method with the Body Message
The code snippets below shows the syntax to send an HTML and plain text e-mails:

'TEXT

'Call Email( Sender's_ID, Sender's_Password, Send_To, CC_To, Subject, Message )
Email "XYZ@AOL.com", "myPassword", "ABC@Gmail.com", _
        "", "Subject", "Hello, this is a test mail."

'HTML

'Call Email( Sender's_ID, Sender's_Password, Send_To, CC_To, Subject, Message )
Email "XYZ@AOL.com", "myPassword", "ABC@Gmail.com", "", _
        "Subject", "Hello
Test Mail
"

Retrieve body-messages from text files
You can create a text file with the body message, and use the file path in the method to send the e-mail. Below is an example of an HTML body inserted into a text file:

'Call Email( Sender's_ID, Sender's_Password, Send_To, CC_To, Subject, Message )
Email "XYZ@AOL.com", "myPassword", "ABC@Gmail.com", "", _
        "Subject", "C:\MyTestMail.txt"

Sample Text File

Similarly, mails can be sent to multiple recipients using “;” between Recipient’s emails. Example:

Email "Me@MeEmail.Com", "mePassword", "You@YouEmail.Com;Them@TheirEmail.Com", _
    "CC@YouCC.Com;CC@MeCC.Com", "Test Subject", "Test Message"

You can find the download links to this class towards the end of this post.

How its done:

'Public Class clsSendMail
Class clsSendMail
 
    Private oMessage    'CDO.Message Object
    Private strFrom     'Sender's Email ID: XX@YY.COM
    Public Body         'Body Text from Text File

    '—————————————————————————————————————————————  
    ' Name: Sub Email (Public)
    ' 
    ' Purpose: Send Email Using CDO
    ' 
    ' Parameters:
    '    sEmailID: Sender's Mail ID String
    '    sPassword: Sender's Password String
    '    sTo: Recipient's Mail ID String (Primary)
    '    sCC: Recipient's Mail ID String (CC)
    '    sSubject: Subject String
    '    sBody: Body Message String
    ' 
    ' Return: -
    '————————————————————————————————————————————— 
    Public Sub Send( sEMailID, sPassword, sTo, sCC, sSubject, sBody )
    '————————————————————————————————————————————— 
        Dim oRegExp     'RegEx Object
        Dim sDetails    'Report Details
        Dim intStatus   'Report Status
        Dim sStepName   'Report Step
        
        'Sender ID has Class scope
        Me.From = sEmailID
        'Message Body
        If sBody <> "" Then Me.Body = sBody
 
        intStatus = micPass
        sStepName = " Sent"
 
        Set oRegExp = New RegExp
        oRegExp.Global = True
        oRegExp.Pattern = "<\w>|<\w\w>|<\w\d>"
        Set oMatches = oRegExp.Execute( Me.Body )
 
        'Build Message
        With oMessage
            .Subject = sSubject
            .From = sEmailID
            .To = sTo
            .CC = sCC
            'BCC Property can be added as well:
            '.BCC = sBCC
            'If HTML Tags found, use .HTMLBody
            If oMatches.Count > 0 Then
                .HTMLBody = Me.Body
            Else
                .TextBody = Me.Body
            End If
        End With
 
        Set oMatches = Nothing
        Set oRegExp = Nothing
 
        With oMessage.Configuration.Fields
            'Sender's Mail ID
            .Item("http://schemas.microsoft.com/cdo/configuration/" &_
            "sendusername") = sEmailID
            'Sender's Password
            .Item("http://schemas.microsoft.com/cdo/configuration/" &_
            "sendpassword") = sPassword
            'Name/IP of SMTP Server
            .Item("http://schemas.microsoft.com/cdo/configuration/" &_
            "smtpserver") = cdoSMTPServer
            'Server Port
            .Item("http://schemas.microsoft.com/cdo/configuration/" &_
            "smtpserverport") = cdoOutgoingMailSMTP
            'Send Using: (1) Local SMTP Pickup Service (2) Use SMTP Over Network
            .Item("http://schemas.microsoft.com/cdo/configuration/" &_
            "sendusing") = cdoSendUsing
            'Authentication Used: (1) None (2) Basic (3) NTLM
            .Item("http://schemas.microsoft.com/cdo/configuration/" &_
            "smtpauthenticate") = cdoAuthenticationType
            'SMTP Server Requires SSL/STARTTLS: Boolean
            .Item("http://schemas.microsoft.com/cdo/configuration/" &_
            "smtpusessl") = cdoUseSSL
            'Maximum Time in Seconds CDO will try to Establish Connection
            .Item("http://schemas.microsoft.com/cdo/configuration/" &_
            "smtpconnectiontimeout") = cdoTimeout
            'Update Configuration Entries
            .Update
        End With
 
        'Report Details
        sDetails = "SMTP Server: " & cdoSMTPServer & vbLf
        sDetails = sDetails & "Sender: " & sEMailID & vbLf
        sDetails = sDetails & "Recipient: " & sTo & vbLf
        sDetails = sDetails & "Server Port: " & cdoOutgoingMailSMTP & vbLf
        sDetails = sDetails & "SSL Used: " & cdoUseSSL & vbLf
        sDetails = sDetails & "Authentication Type: " & cdoAuthenticationType & vbLf
        sDetails = sDetails & "SMTP Service Type: " & cdoSendUsing & vbLf & vbLf
        sDetails = sDetails & "Subject: " & sSubject & vbLf & vbLf
        sDetails = sDetails & "Body: " & sBody
 
        On Error Resume Next
            'Send Message
            oMessage.Send
            If Err.Number <> 0 Then
                intStatus = micWarning
                sStepName = " Not Sent"
                sDetails = sDetails & vbLf & "Error Description: " & Err.Description
            End If
        On Error Goto 0
 
        'If you're not using QTP, please disable the statement below:
        Reporter.ReportEvent intStatus, "EMail" & sStepName, sDetails
    End Sub
 
    '—————————————————————————————————————————————  
    ' Name: Sub LoadBodyMessage (Public)
    ' 
    ' Purpose: Loads BodyText from a Text File
    ' 
    ' Parameters:
    '    sCompleteFilePath: Complete Path to the Text File (Eg: "C:\MyDocs\MyMail.txt")
    ' 
    ' Return: -
    '—————————————————————————————————————————————  
    Public Sub LoadBodyMessage( sCompleteFilePath )
    '————————————————————————————————————————————— 
        CONST ForReading = 1 
        Dim oFSO, oFile
 
        Set oFSO = CreateObject( "Scripting.FileSystemObject" )
        Set oFile = oFSO.OpenTextFile( sCompleteFilePath, ForReading )
        Me.Body = oFile.ReadAll
        oFile.Close: Set oFile = Nothing
 
        Set oFSO = Nothing
    End Sub
 
    '—————————————————————————————————————————————  
    ' Name: Class_Initialize (Private)
    ' 
    ' Purpose: Binds to the CDO Object
    ' 
    ' Parameters: -
    ' 
    ' Return: -
    '—————————————————————————————————————————————  
    Private Sub Class_Initialize
    '—————————————————————————————————————————————  
        Set oMessage = CreateObject( "CDO.Message" )
    End Sub
 
    '—————————————————————————————————————————————  
    ' Name: Class_Initialize (Private)
    ' 
    ' Purpose: Release the CDO Object
    ' 
    ' Parameters: -
    ' 
    ' Return: -
    '—————————————————————————————————————————————     
    Private Sub Class_Terminate
    '————————————————————————————————————————————— 
        Set oMessage = Nothing
    End Sub
 
    '—————————————————————————————————————
    ' Name: Property cdoSendUsing (Private)
    ' 
    ' Purpose: Readonly property configuration for SMTP Service
    '—————————————————————————————————————
    Private Property Get cdoSendUsing  'As Integer
    '—————————————————————————————————————    
        cdoSendUsing = 2    'Use SMTP Over The Network
        'cdoSendUsing = 1    'Use Local SMTP Service Pickup Directory
    End Property
 
    '—————————————————————————————————————
    ' Name: Property cdoTimeout (Private)
    ' 
    ' Purpose: Maximum time in seconds CDO will try to establish a connection
    '—————————————————————————————————————
    Private Property Get cdoTimeout  'As Integer
    '—————————————————————————————————————    
        'cdoTimeout = 15    'Seconds
        cdoTimeout = 45    'Seconds
        'cdoTimeout = 75    'Seconds
    End Property
 
    '—————————————————————————————————————
    ' Name: Property cdoAuthenticationType (Private)
    ' 
    ' Purpose: Type of Authentication to be used
    '—————————————————————————————————————    
    Private Property Get cdoAuthenticationType  'As Integer
    '—————————————————————————————————————    
        'cdoAuthenticationType = 0    'No Authentication
        cdoAuthenticationType = 1    'Basic Authentication
        'cdoAuthenticationType = 2    'NTML Authentication
    End Property
 
    '—————————————————————————————————————
    ' Name: Property cdoOutgoingMailSMTP (Private)
    ' 
    ' Purpose: Server Port
    '—————————————————————————————————————    
    Private Property Get cdoOutgoingMailSMTP  'As Integer
    '—————————————————————————————————————    
        If InStr(1, Lcase(Me.From), "@gmail") <> 0 Then
            cdoOutgoingMailSMTP = 465
        ElseIf InStr(1, LCase(Me.From), "@aol") <> 0 Then
            cdoOutgoingMailSMTP = 587
        Else
            cdoOutgoingMailSMTP = 25
        End If
    End Property
 
    '—————————————————————————————————————
    ' Name: Property cdoSMTPServer (Private)
    ' 
    ' Purpose: Name/IP of SMTP Server
    '—————————————————————————————————————    
    Private Property Get cdoSMTPServer  'As String
    '—————————————————————————————————————    
        If InStr(1, LCase(Me.From), "@yahoo") <> 0 Then
            cdoSMTPServer = "smtp.mail.yahoo.com"
        ElseIf InStr(1, LCase(Me.From), "@gmail") <> 0 Then
            cdoSMTPServer = "smtp.gmail.com"
        ElseIf InStr(1, LCase(Me.From), "@hotmail") <> 0 Or _
               InStr(1, LCase(Me.From), "@live") <> 0 Then
            cdoSMTPServer = "smtp.live.com"
        ElseIf InStr(1, LCase(Me.From), "@aol") <> 0 Then
            cdoSMTPServer = "smtp.aol.com"
        End If    
    End Property
 
    '—————————————————————————————————————
    ' Name: Property cdoUseSSL (Private)
    ' 
    ' Purpose: Setting for SMTP Server's use of SSL (Boolean)
    '—————————————————————————————————————        
    Private Property Get cdoUseSSL  'As Boolean
    '—————————————————————————————————————    
        cdoUseSSL = True
        If InStr(1, LCase(Me.From), "@aol") <> 0 Then
            cdoUseSSL = False
        End If
    End Property
 
    '—————————————————————————————————————
    ' Name: Property From (Public)
    ' 
    ' Purpose: Sender's Email ID
    '—————————————————————————————————————
    Public Property Let From( ByVal Val )
           strFrom = Val
    End Property
    Public Property Get From 'As String
           From = strFrom
    End Property
 
End Class
 
'—————————————————————————————————————————————  
' Name: Sub Email (Public)
' 
' Purpose: Sends an Email Using CDO to a recipient
' 
' Parameters:
'    sEmailID: Sender's Mail ID String
'    sPassword: Sender's Password String
'    sTo: Recipient's Mail ID String
'    sSubject: Subject String
'    sBody: Body Message String
' 
' Return: -
'————————————————————————————————————————————— 
Public Function Email( EmailID, Password, Recipient, CC, Subject, Body )
'————————————————————————————————————————————— 
    Set Email = New clsSendMail
    With Email
        .Send EmailID, Password, Recipient, CC, Subject, Body
    End with 
End Function
 
'—————————————————————————————————————————————  
' Name: Sub EmailFromFile (Public)
' 
' Purpose: Sends an Email Using CDO to a recipient
' 
' Parameters:
'    sEmailID: Sender's Mail ID String
'    sPassword: Sender's Password String
'    sTo: Recipient's Mail ID String
'    sSubject: Subject String
'    sCompleteFilePath: Text File containing the Body Message
' 
' Return: -
'————————————————————————————————————————————— 
Public Function EmailFromFile( EmailID, Password, Recipient, CC, Subject, sCompleteFilePath )
'————————————————————————————————————————————— 
    Set EmailFromFile = New clsSendMail
    With EmailFromFile
        .LoadBodyMessage sCompleteFilePath
        .Send EmailID, Password, Recipient, CC, Subject, ""
    End with 
End Function

You can use this code as a .VBS file, but, please remember to remove/comment the Reporter.ReportEvent statement on Line 113.

Download for QTP
Download for executing as .VBS

If you have any questions, please ask them in the comments section. If your query is confidential, please use the Contact Form to send me an e-mail instead.