Versions Compared

Old Version 6

changes.mady.by.user ravi.chandran (Unlicensed)

Saved on

compared with

New Version 7

changes.mady.by.user ravi.chandran (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Generic Recommendations

For creating the custom actions for Selenium Webdriver, you need to create the action in Java and then map this action into Qualitia Automation Studio. You can use any IDE tool like Eclipse.

The following are some rules that must be considered when creating custom actions:

  • The parameter data types supported by Qualitia are String and Array. If an array parameter is used in Qualitia for the custom action, then custom action parameter should be of the type Object in Custom Action function. The parameter can then be type-casted into the data type which is required in the action.
    For example, the object parameter can be type-casted into the array list.

  • Based on the standard Java coding rules, actions should not be created in the default package. For better maintenance, it is recommended to use user-defined packages for development.

  • It is recommended to put a prefix when defining a name for new custom actions for easy identification.

  • No two custom actions can have the same function name in the same class. Function overloading is not allowed. Duplicate function names in different classes are allowed (not recommended). 

  • Once the action is mapped into Qualitia and used in a test case, do not change the existing signature or other details of the actions or the classes created. The functionality of the action can be modified. Do not delete the custom actions or custom classes that are used in test cases.

  • If the custom action belongs to any object type (such as WebEdit, WebElement, and so forth), ensure you add the objectInfo data type parameter while developing the code of an action.

  • While mapping actions into Automation Studio, it is important to map the action using <package.class> hierarchy. 

  • Objects should be added under appropriate Qualitia classes while mapping custom actions into Qualitia Automation Studio

Table of Contents

New Recommendations from Qualitia v8.0.0

Qualitia has come up with a new set of rules for creating custom actions in Qualitia 8.0.0 and later. If you have created custom actions to Qualitia version earlier than v8.0.0, then you must edit the existing ones with the following rules.

Making a New Class for Recommendations

The user should create his own class consisting of his custom actions. The newly generated class can be added in the same package as that of the already supported actions. 

The user has to ensure that in the testcase, the ‘name’ and ‘qClass’ fields of action is set to the correct name of the action and class containing that action respectively. Qualitia now uses the concept of java reflection through which the action mentioned in ‘name’ and class mentioned in ‘qClass’ is called directly for action execution. The following example demonstrates how to make a new class for custom actions. 

Info

   package <QASpackagename>; 

import com.qualitia.execution.ActionResponse; 
  import com.qualitia.execution.ApplicationLogger; 
  import com.qualitia.models.testcase.ExecutionResult; 
  import com.webdriverfw.Wrappers.General; 

  <QASimportlist> 

  

  public class <QASclassname> extends General { 

  

  //Define your customs actions here 

  

  }

Writing Custom Actions in the Accepted Format

Qualitia now allows to write code for a custom in the following format. 

Info

         public ActionResponse <QASmethodname>(<QASparametername>) { 

     

     ActionResponse actionResponse = getActionResponse(); 

     ApplicationLogger applicationLogger = actionResponse.getApplicationLogger(); 

     actionResponse.setExecutionResult(ExecutionResult.FAILED); 

     try { 

               // Your code here... 

             

           applicationLogger.writeToInfoLog(""); 

           actionResponse.setMessage("Successful message"); 

           actionResponse.setExecutionResult(ExecutionResult.PASSED); 

        } catch (Exception ex) { 

           applicationLogger.writeToErrorLog("Exception message", ex); 

           actionResponse.setMessage(“Failed Message”, FailureCategory); 

           actionResponse.setExecutionResult(ExecutionResult.FAILED); 

        } 

        return actionResponse; 

}  

As per the previous Qualita versions prior to v8.0.0 , the actions used to return integer value i.e 0,1,2,-1  which were used to indicate PASSED, FAILED, DEFECT, NOT-EXECUTED respectively .

The return value has been changed to ActionResponse. The actions return ActionResponse which contains 2 parameters Message and ExecutionResult. Before actionResponse is returned during the execution of action, the required message and ExecutionResult must be set properly. The primitive datatypes allowed for action parameters are String and Array. 

ApplicationLooger

In the Qualitia versions prior to v8.0.0,  DataLogger.writeToDebugAndInfoLogs(“”) was used for setting messages. From Qualitia v8.0.0, this is replaced by actionResponse.setMessage(“”)to set the messages related to executions.

Qualitia has also introduced ApplicationLogger. If the you want to set a message, which is not related to execution, then ApplicationLogger can be used. In general, For action specific logging  the user can use ApplicationLogger.  

  • applicationLogger.writeToInfoLog(""); 

  • applicationLogger.writeToErrorLog(""); 

The main purpose of ApplicationLogger is to create logs to understand the flow of execution. There are 2 types of logs supported for Qualitia: 

  • Info Log

  • Error Log

Show Link of File in Info Log Section 

Some custom actions needs to write a file during its execution. You can view that file inside Info Log of that custom action. If you want to view the file contents, then you can click the Link present in the Message section of Info. 

Below function needs to be called before returning Action Response to show the link of files inside the log section. 

showLinkOfFileInLogsSection(String sourceFilePath, ActionResponse actionResponse) 

The sourceFilePath denotes the file path you write during custom action execution, and actionResponse denotes the Action Response object 

  • Info 

  • Error  
    The user can use these logs according to the requirement. The Error logs must be in the catch block of Action. These logs can be seen in Qualitia report which is generated after the execution of the suite. 

Setting an Execution Result

While setting ExecutionResult, user can make use of ExecutionResult enum where the required results are available. 

  • ExecutionResult.PASSED , is used to set this when the action is passed. 

  • ExecutionResult.FAILED , is used to set this when the action is failed. 

  • ExecutionResult.DEFECT , is used to set this when the action has a defect. 

  • ExecutionResult.NOT_EXECUTED ,is used to set this when the action halts the execution halts.  

The message and ExecutionResult that has been set will appear in the final Qualitia report. After writing custom actions in the correct format user needs to make the following changes in DirectActionCall class: 

Aftercreating new class for Custom Actions, he has to create a new method in DirectActionCall class as “executeYour_Class_Name”. The format of the method should be , 

Info

    private ActionResponse executeYour_Class_Name(String actionName, 

  List<Object> paramValues, Your_Class_Name yourClassObject) throws Exception {  

  

    ActionResponse response;  

    switch (actionName) {  

      case "Your_Custom_Action1":     

        response = yourClassObject.Your_Custom_Action2(Parameters....);    

        break;  

  

       case "Your_Custom_Action2":  

        response = yourClassObject.Your_Custom_Action2(Parameters....);  

        break;  

  

        //Remaining custom Actions  

  

       default:  

       response = executeWebObject(action ,parameter ,yourClassObject, datalogger); 

 

      OR 

 

      response = executeMobileObject(action ,parameter ,yourClassObject,                                                 datalogger);       

       // ...Depending on the class which is extended by Custom Class       

 

       }  

  

        return response;  

  

    } 

 

The user can define the Strings “Your_Custom_Action1” and “Your_Custom_Action2” in Actions class as constants. After that the user can use those constants instead of Strings. However, it is not mandatory. It is achieved by editing the Actions class as follows, 

Info

     public static final String YOUR_CUSTOM_ACTION1 = “Your_Custom_Action1"; 

     public static final String YOUR_CUSTOM_ACTION2 = “Your_Custom_Action2"; 

 After adding the method in the required format , edit the switch block of ‘invoke’ method in the format given below, 

   

Info

  case "Your_Class_Name":  

        Your_Class_Name yourClassObject = new                                                                                Your_Class_Name();                     ... //create an instance of newly created class.  

        response = executeYour_Class_Name(executionContext, actionName, 

                               paramValues, yourClassObject, reportContext, response);   

                                                                   … //Calling the newly created method   

        break;  

 

 

Example:- 

Here is one brief example on writing custom Actions, showcasing how it was done in old version and how it is done in Qualitia 8.0.0 version. 

If a user wants to write a custom action for checking two strings are equal, he can do it as:  

Info

 

    In Older Versions before 8.0.0 :  

    public int EqualStrings(String a, String b)  

    {  

    if(a.equals(b))  

    {  

    DataLogger.writeToDebugAndInfoLogs("they are equal");  

    return 0;  

    }  

    else  

    {  

    DataLogger.writeToDebugAndInfoLogs("they are not equal");  

    return 1;  

    }  

    }  

  

    In Qualitia 8.0.0 Version :  

    public AcionResponse EqualStrings(String a, String b)  

    {  

    ActionResponse actionResponse = getActionResponse();  

    if(a.equals(b))  

    {  

    actionResponse.setMessage("they are equal");  

    actionResponse.setExecutionResult(ExecutionResult.PASSED);  

    return actionResponse;  

    }  

    else  

    {  

    actionResponse.setMessage("they are not                                                                                equal”,FailureCategories.Category.INVALID_DATA);  

    actionResponse.setExecutionResult(ExecutionResult.FAILED);  

    return actionResponse;  

    }  

    }