Versions Compared

Old Version 5

changes.mady.by.user Dhiraj Chandanshive

Saved on

compared with

New Version Current

changes.mady.by.user Dhiraj Chandanshive

Saved on

Key

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

Though Qualitia covers most of the actions required for automation testing, there might still be a need to add some more actions to Qualitia based on the project requirements. Qualitia allows you to develop your own actions and make them available to use while automating test cases for the application under test.  

...

Expand
title1. Gather or generate all java source files at one place.

In order to import and streamline the custom actions with other project data in Qualitia, you must add all the java source files at one place. In case you do not have source files for some actions, you can generate the source code files easily using these commands mentioned below.

  1. Launch command prompt.

  2. Navigate to the %localappdata%\QualitiaWDClient\app-7.1.0\Dist folder.

  3. Enter the following command:

    “java -jar jd-cli.jar "<CLASS_FILE_SOURCE_PATH>" -od "<DESTINATION_FOLDER_TO_SAVE_SOURCE_CODE>"

    Code Block
    C:\Users\<HOSTNAME>\AppData\Local\QualitiaWDClient\app-7.1.0\Dist>java -jar jd-cli.jar "D:\ClassFiles" -od "D:\JavaFiles"
21:21:06.078 INFO  jd.cli.Main - Decompiling D:\ClassFiles
21:21:06.095 INFO  jd.core.output.DirOutput - Directory output will be initialized for path D:\JavaFiles
21:21:06.412 INFO  jd.core.output.DirOutput - Finished with 2 class file(s) and 1 resource file(s)

    Post executing this command, source code files will be added at the destination folder. You can use them now to build and compile Eclipse project.

Expand
title2. Create an Eclipse project and compile the project with all the custom actions.

To create and compile custom action project:

  1. Launch Eclipse and create a new java project using an execution environment as JRE 1.8.

  2. Set the bin folder as an output folder.

  3. Add new folder and name it as lib.
    The complete folder hierarchy will look something like this in the project directory.

    Image Modified

  4. Add all the existing custom action files in this directory.
    Before you start adding custom action-related data into these sub folders, ensure that the code is working fine.

    1. Add all the dependency files in the lib folder. 

    2. Add all the compiled class files in the bin folder.

    3. Add all the java source files in the src folder. 
      Ensure you add all your dependent jars in lib folder and provide the relative path for these jars in Build Path with the correct sequence.

  5. Compile and build the Eclipse project.
    Actions are now ready to be imported.

Expand
title3. Import custom action code in Qualitia Project.

You can import the existing set of custom actions in Qualitia to share with the other project members easily.

(info) Ensure the class files you are providing have all the custom actions functions present for which you have provided the metadata. A single class file can contain functions for multiple custom actions.

  1. Log on to automation studio as a user with Manage Custom Action Code privileges. 

  2. Navigate to the project in which you want to import the custom action code and then click Develop > Custom Actions.
    You will see the notification about importing custom actions on the top. This option is visible only if the project contains any custom actions that are not yet imported.

  3. Click Import.

  4. Provide path to the the Eclipse project which we have created and compiled earlier.

  5. After importing all the custom action files successfully, click Close.
    Eclipse project directory will be copied under Qualitia project path with all the sub-folders mentioned earlier (bin, lib, src, and so forth).
    The Custom Action Repository Path under Configuration Settings will be set automatically

...

In case there are any issues while importing the actions, these will be listed which can be exported in the HTML report.

...

Refer to the troubleshooting section to resolve the errors.

Points To Know:

  • For example, if you add a Qualitia Class "com.security.login", then this file creates a package and a java file called as "com.security" and "login.java" respectively.

  • The Custom Object Class is a user-friendly alternate name for a Qualitia Class, which you can specify.

  1. to this new directory created under Qualitia Project Path.

  2. In case there are any issues while importing the actions, these will be listed which can be exported in the HTML report.

  3. Refer to the troubleshooting section to resolve the errors.

    Points To Know:

    • For example, if you add a Qualitia Class "com.security.login", then this file creates a package and a java file called as "com.security" and "login.java" respectively.

    • The Custom Object Class is a user-friendly alternate name for a Qualitia Class, which you can specify.

Expand
title4. Add missing Qualitia jar file in the lib folder.

To add the missing Qualitia jar file in the lib folder, follow these steps:

  1. Navigate to %localappdata%\QualitiaWDClient\app-8.6.0.XXX\WebDriver.

  2. Copy the qualitia-8.6.X jar file and paste it in the lib folder under the following directory: Projectpath/Projectname_projectdb/Projectname_QASJavaproject/

  3. Launch Eclipse by navigating to Qualitia > right-click on project name (Projectname_QASJavaproject) > Build path > Configure Build Path.

  4. Now, go to Libraries > Add jars.

  5. Expand the Projectname_QASJavaproject and the lib folder.

  6. Select the qualitia-8.6.0 jar and click OK.

Creating a Custom Action for a Web/Mobile Project

...

To create new custom action in Qualitia:

  1. From the Expand menu, click Develop.

  2. Click the Custom Actions tab.

  3. Click the Add button ( Image Modified ) or Create Custom Action button.
    The Custom Actions screen appears.

  4. Select Base Class.
    (warning) The Custom Object Class file name including its file path should not exceed 256 characters when you are using Git/Bitbucket as a source control system for maintaining project artifacts.

  5. Do one of the following:

    • To add a new Qualitia Class:

      1. Click the Plus button next to Custom Object Class to add a custom object class by mapping to the Qualitia Class that you want to add.

      2. Enter the java class file name without its extension along with the package name (if required), in Qualitia Class.

    • To select a pre-defined Qualitia Class that is mapped to a Custom Object Class:

      • From the Custom Object Class drop-down list, select a pre-defined custom object class.
        The associated Qualitia Class is selected automatically.

        Points To Know:

        • For example, if you add a Qualitia Class "com.security.login", then this file creates a package and a java file called as "com.security" and "login.java" respectively.

        • The Custom Object Class is a user-friendly alternate name for a Qualitia Class, which you can specify.

        Image Modified

  6. Enter Action Name, Description and Function Name for the action to be created.

  7. In the Properties section, click Add.
    A new line will be added in the grid.

  8. Add Parameter Name, Description, ArgDataType for the parameter, and select whether this parameter is mandatory.

    1. To save the action, click Save.

    2. To save the action and launch the code template in Eclipse IDE, click Save and Launch Eclipse.

  9. Close the Welcome on the IDE window to see your auto-generated custom action code template.

  10. Import the pre-created Custom Action Java project workspace into Eclipse workspace.
    (info) This is a one-time activity for a project.

    1. To import the pre-created workspace, right-click Package Explorer, and select Import from the context-menu.

    2. On the Import window, under the General section, select Existing Projects into Workspace and then click Next.

    3. In the Select root directory section, click the Browse button, select <PROJECTNAME>_QASJavaproject and click Finish.
      You will find this directory under Qualitia project path.

      Image Modified

  11. In Eclipse IDE, from the Window menu, select Preferences.

  12. Select General > Workspace > select Refresh using native hooks or polling.

  13. Click Apply and Close.

  14. Ensure you do not change the method signature and provide only the method body. Changing the signature in code may break your action in Qualitia.

  15. In the editor, add the custom action code in the provided template for your custom action.

  16. To add the dependent jars, do the following in the order listed:

    1. Add the dependent jar files in the lib folder under the project.

    2. Right-click the Project, point to Build Path, and then select Configure Build Path.

    3. Click Libraries > Add JARs.

    4. Under Jar Selection window, expand the Project folder.

    5. Under the lib folder, select the dependent Jar, and click Ok. 

    6. Click Apply and Close.

  17. Build the project and close the Eclipse IDE.
    To work this custom action code in the Qualitia automation test cases, you must build the project successfully.
    You can now use this newly created custom action while developing task and test cases in Qualitia.

Info

Once you have closed the Eclipse IDE, Qualitia automatically commits the code to the version control system (if configured) and makes the code available to other Qualitia project members.

...

To debug a custom action:

  1. Do in the following order listed to create necessary test artifacts:

    1. Create a test case and include the custom action that you want to debug at the appropriate step. For more information, refer to Work with Test Cases

    2. From the test case editor, click Run to dry run the test case to verify whether the custom action is hit.

    3. Create a test suite that contains the test case. For more information, refer to Creating a Suite.

    4. Create an offline suite using the test suite. For detailed instructions, refer to Creating an Offline Package.

  2. To add the required files for debugging the custom action:

    1. Open the custom action you want to debug in the Eclipse project.

    2. Add the TestHarness.Java file for the custom action in the Eclipse project.

    3. Add the Config Folder in the Eclipse project.

    4. In the config folder, open the startupSettings.json file, and specify the location of the offline suite for “SuitesDir”.
      For example: "SuitesDir":"D:/Qualitia Offline/Suite1"

  3. Insert a breakpoint at an appropriate line number in the custom action.

  4. Start debugging the TestHarness.Java file.

  5. The test suite execution starts.
    When the custom action is executed, the execution stops at the breakpoint you have inserted.
    You can go ahead and debug the custom action.

Info

To specify Java system properties before executing the test suite.

  1. From the config folder in the custom action of Eclipse, open the QualitiaSystemProperties.json.

  2. In the QualitiaSystemProperties.json file, enter the key-value pairs in the following format:

    1. {"key1": "value1",

      "key2": "value2",

      .

      .

      "keyN": "valueN"}

  3. Save the file.   

Troubleshooting (Custom Action Module)

...

To re-import the project:

  1. Ensure you clone all the project data to the new directory.
    This includes Test cases, Tasks, Custom actions, and Java project folders (which hold all the latest custom action code).

  2. Remove the existing project from the workspace.

  3. To import the cloned java project from the new directory, right-click Package Explorer, and select Import from the context menu.

  4. On the Import window, under the General section, select Existing Projects into Workspace and then click Next.

  5. In the Select root directory section, click the Browse button, select <PROJECTNAME>_QASJavaproject and click Finish.
    This is in the new directory where you have cloned the Qualitia project data.

  6. Select General > Workspace > Select Refresh using native hooks or polling.

  7. Click Apply and Close.

Custom Action Custom Files are Not Pushed to Project Path GIT Repository

...

Perform the following steps:

  1. Open the Eclipse Project.

  2. Click Windows > Preferences > Teams > Git > Projects.

  3. In the right side of the Preference dialog box, under Projects, deselect the Automatically ignore derived resources by adding them.gitignore checkbox.

Other Validations

While importing custom actions code into automation studio, Qualitia validates certain things. In case some files or code is missing, Qualitia gives the list of issues to fix to continue importing custom actions.

...

Validation Error

Resolution

.classpath file is not present in your Eclipse project location 

Ensure that the Eclipse project was built successfully after adding all required artifacts (lib, bin, src folders) to it. This will create a .classpath file. 

.class files are not present in your Eclipse project location 

Collect the required compiled .class files and add them to the Eclipse project (under bin folder). Names of the required files is mentioned in the report.

Jar files mentioned in .classpath in your Eclipse project location

Collect all the required jar files and add them to your Eclipse project directory (under lib folder).

Java source files are not present in your Eclipse project location 

You need to generate the source code from the compiled class files and add them into the src folder under Eclipse project directory. For more information on the creating the source files, refer to the Importing Existing Custom Actions Created in Previous Qualitia Versions section. 

Once you have fixed all the errors mentioned above, you can continue importing custom actions in Qualitia. 

...

To create a custom action for desktop projects:

  1. Open the desktop project where you want to create a custom action.

  2. From the Expand Menu, click Custom Actions.

  3. Click the Custom Actions tab.

  4. Do the following in the order listed.

    1. Enter the name of action, in Action Name.

    2. Enter the role of the custom action, in Description.

    3. From the Technology drop-down list, select the technology under which you want to create a  custom action.

    4. From the Base Class drop-down list, select a base class.

    5. If you select a base class as General to create general actions, you get a pop-up to select  Java or VB.
      Do one of the following:

    6. From the VBS File drop-down list, do one of the following:

      1. Select an existing visual basic file.

      2. Select Create New File to create a new visual basic file. Enter the name of the new VB file you want to create without including its extension.

    7. From the Functions drop-down list, do one of the following:

      1. Select an existing function.

        You must ensure that you do not map a function created for a General Action to a Non General Action and vice versa.  However, if you do so, you might see unexpected behaviour of your Custom Action.

      2. Select Create New Function to create a new function. Enter the name of new function.

  5. Under Properties, do one of the following:

    1. If you have selected an existing function, the existing arguments are displayed. You need to select data type for existing parameters.

    2. If you have selected a new function, add new parameters along with their data types.

  6.  Do one of the following;

    • Click Save to save the custom action in the selected VB script file.

    • Click Save and Launch Editor to save the custom action in the selected VB script file and then launch this file in the VB editor.

      The custom action is added.

  7. Click Edit Code to write codes to develop the custom action.
    You need to consider the custom action rules.

Rules for Mapping Custom Actions

...

To edit custom action metadata:

  1. From the Expand Menu, click Develop.

  2. Click the Custom Actions tab.

  3. In the left pane, click the desired custom action which you want to update.
    Custom action details will appear in the right pane.

  4. Click Edit.

  5. Update Action Name, Description, Function Name, and parameters details based on the requirements.

  6. Click Save and Launch Editor.

    Info

    For desktop project custom action developed in VB, you cannot add or remove parameters from the mapped function for an unused cutsom action from Qualitia client.  To work around this issue, launch the associated VBS file from Qualitia client, add or remove parameters for the mapped function, and remap the function to the custom action from Custom Action window.

Modify Custom Action Code

...

Info

Ensure that your associated role is assigned with Custom Actions privileges.

While editing, it is strongly recommended to view and edit custom actions code from Qualitia Automation Studio only. In case you want to edit multiple custom actions, you must launch the code for each action differently from the automation studio. Modifying multiple actions in a single go may put you in conflicting situations which are difficult to handle.

  1. From the Expand Menu, click Develop.

  2. Click the Custom Actions tab.

  3. In the left pane, select the desired custom action which you want to update.
    Custom action details will appear in the right pane.

  4. Click View Code.
    The code appears in the different section.

  5. To update the code in the Eclipse IDE, click Edit Code.
    The code template with an existing code opens in the Eclipse IDE.

  6. Update the code based on the requirements.

  7. Build the project and close Eclipse IDE.

    Once you close the Eclipse IDE, Qualitia automatically commits the code to the version control system like Bitbucket or SVN (if configured) and makes the code available to other Qualitia project members.

Deleting Custom Actions

You can delete the custom actions only if they are not used in any of the test case or task.

...

To delete the custom action:

  1. From the Expand Menu, click Develop.

  2. Click the Custom Actions tab.

  3. Search the desired custom action.

  4. Select the action in the left pane.
    Custom action details will appear in the right pane.

  5. Click Delete.