SoapUI Tests : Integration with QC/ALM

The article aims to explain the steps needed to integrate your SoapUI tests with HP quality center/ALM.

Prerequisites 

•  SoapUI 2.0.2 version or above installed
• Access to Quality Center envelope where the tests are to be integrated.

Principle of the solution

• The solution interface presented here is based on the performance of existing SoapUI tests.
• SOAPUI scripts are launched from the VAPI-XP scripts of the automated test under Quality Center
• VAPI-XP tests retrieve the status of the SOAP-UI tests and returns to PASSED or FAILED state in Quality Center.
• SopaUI test must have a assertion available to be able to determine the passed or failed status.
• SoapUI project saved as an XML file on your system.

Creation of the Script VAPI-XP

In the TestPlan view, create a test of type VAPI-XP-Test in the corresponding directory.

On the "New Test" window, select "VAPI-XP-TEST" from the template type, update the name of the test and click on OK.

Select the script language of the test (VBScript) and name of the script, then click Next.

 

Select the type of test (Console Application Test), then click Next.

Click on "Finish" in the next step

Select the "Test Script" tab on the test. 

Replace the code generated by the Quality Center with the one given below.

'' ----------------------------------------------------
' Main Test Function
' Debug - Boolean. Equals to false if running in [Test Mode] : reporting to Quality Center
' CurrentTestSet - [OTA COM Library].TestSet.
' CurrentTest - [OTA COM Library].TSTest.
' CurrentRun - [OTA COM Library].Run.
' ----------------------------------------------------
Sub Test_Main(Debug, CurrentTestSet, CurrentTest, CurrentRun)
  ' *** VBScript Limitation ! ***
  ' "On Error Resume Next" statement suppresses run-time script errors.
  ' To handle run-time error in a right way, you need to put "If Err.Number <> 0 Then"
  ' after each line of code that can cause such a run-time error.
  On Error Resume Next
 
  ' clear output window
  TDOutput.Clear
 
  ' TODO: put your code here
  ' ---------------------
  ' début code spécifique
  ' ---------------------
  Dim RepResultSoap
  Dim Mois, Jour, Heure, Minutes, Seconde
  Dim oFSO, oFld
 
  Mois    = Month(Now)
  Jour    = Day(Now)
  Heure   = Hour(Now)
  Minutes = Minute(Now)
  Seconde = Second(Now)
 
  If Mois < 10 Then
    Mois = "0" & Mois
  End If
  If Jour < 10 Then
    Jour = "0" & Jour
  End If
  If Heure < 10 Then
    Heure = "0" & Heure
  End If
  If Minutes < 10 Then
    Minutes = "0" & Minutes
  End If
  If Seconde < 10 Then
    Seconde = "0" & Seconde
  End If
 
  ' Répertoire de copie du fichier résultat du script Soap en cas d'échec'
  ' (paramètre du script testrunner.bat)'
  RepResultSoap = "C:\TestSoapUI\FoxSoapUI\runs\"
  RepResultSoap = RepResultSoap & Year(Now) & Mois & Jour & "-" & Heure & Minutes & Seconde
 
  ' Création du répertoire résultat
  Set oFSO = CreateObject("Scripting.FileSystemObject")
 

  Set oFld=oFSO.CreateFolder(RepResultSoap)
  sleep 10
 
  ' Appel de la fonction déclenchant l'exécution du script Soap'
  doTest(RepResultSoap)
 
  ' Appel de la fonction testant le résultat du script Soap'
  If checkTest(RepResultSoap) <> 0 Then
    CurrentRun.Status = "Failed"
    CurrentTest.Status = "Failed"
  End If
  ' -------------------
  ' fin code spécifique
  ' -------------------
 
  If Not Debug Then
  End If
  ' handle run-time errors
  If Err.Number <> 0 Then
    TDOutput.Print "Run-time error [" & Err.Number & "] : " & Err.Description
    ' update execution status in "Test" mode
    If Not Debug Then
      CurrentRun.Status = "Failed"
      CurrentTest.Status = "Failed"
    End If
  End If
End Sub
 
' ----------------------------------------------------
' doTest Function : exécution du test
' ----------------------------------------------------
Public Function doTest(RepResultSoap)
  Dim WshShell, URITestSet
 
  'Script SoapUI à exécuté (paramètre du script testrunner.bat)'
  URITestSet = "C:\TestSoapUI\FoxSoapUI\xml\Fox1-soapui-project.xml"
  Set WshShell = CreateObject("WScript.Shell")
  ' Positionnement dans le répertoire du script testrunner.bat'
  WshShell.CurrentDirectory = "C:\Program Files\SmartBear\SoapUI-5.0.0\bin"
  ' Exécution du script testrunner.bat (script SoapUI)'
  WshShell.run "cmd /C testrunner.bat -f " & RepResultSoap & " " & URITestSet, ,true
 
End Function
 
' ----------------------------------------------------
' checkTest Function : contrôle du test
' ----------------------------------------------------
Public Function checkTest(RepResultSoap)
  Dim oFSO, oFl, nbFichiers
 
  ' Le contrôle consiste à vérifier la présence d'un fichier résultat dans le répertoire'
  ' Si aucun fichier n'est présent, le test est OK'
  Set oFSO = CreateObject("Scripting.FileSystemObject")
  nbFichiers = 0
  If oFSO.FolderExists(RepResultSoap) Then
    For each oFl in oFSO.GetFolder(RepResultSoap).Files
      nbFichiers = nbFichiers + 1
    Next
  End If
  checkTest = nbFichiers
 
End Function  
' ----------------------------------------------------
' doTest Function : exécution du test
' ----------------------------------------------------
Public Function doTest(RepResultSoap)
  Dim WshShell, URITestSet
 
  'Script SoapUI à exécuté (paramètre du script testrunner.bat)'
  URITestSet = "C:\TestSoapUI\FoxSoapUI\xml\Fox1-soapui-project.xml"
  Set WshShell = CreateObject("WScript.Shell")
  ' Positionnement dans le répertoire du script testrunner.bat'
  WshShell.CurrentDirectory = "C:\Program Files\SmartBear\SoapUI-5.0.0\bin"
  ' Exécution du script testrunner.bat (script SoapUI)'
  WshShell.run "cmd /C testrunner.bat -f " & RepResultSoap & " " & URITestSet, ,true
 
End Function
 
' ----------------------------------------------------
' checkTest Function : contrôle du test
' ----------------------------------------------------
Public Function checkTest(RepResultSoap)
  Dim oFSO, oFl, nbFichiers
 
  ' Le contrôle consiste à vérifier la présence d'un fichier résultat dans le répertoire'
  ' Si aucun fichier n'est présent, le test est OK'
  Set oFSO = CreateObject("Scripting.FileSystemObject")
  nbFichiers = 0
  If oFSO.FolderExists(RepResultSoap) Then
    For each oFl in oFSO.GetFolder(RepResultSoap).Files
      nbFichiers = nbFichiers + 1
    Next
  End If
  checkTest = nbFichiers
 
End Function 

The VAPI script performs the following operations.

• Create a timestamped directory containing the result of Soap script file if it is KO, errors are listed in the file are :
• Launch Soap Script (function "doTest")
• Check the presence of the log file of Soap Script. 
• File Present : QC Test status = Failed 
• File Absent : QC Test status = Passed. 

Do not forget to update the following values in Red

URITestSet : Location of the XML file describing SOAP-UI project.
    URITestSet = "C:\TestSoapUI\FoxSoapUI\xml\Fox1-soapui-project.xml"
    Remark : Do not pur space in the directory names

RepResultSoap : Location of the result files.
    RepResultSoap = "C:\TestSoapUI\FoxSoapUI\runs\"
    Remark : Do not pur space in the directory names

WshShell.CurrentDirectory : Location of the script to launch "testrunner.bat" (SoapUI 'bin' directory)
    WshShell.CurrentDirectory = "C:\Program Files\SmartBear\SoapUI-5.0.0\bin"
    Remark : The directory above is a standard installation of SoapUI 5.0.0 software.