Documentation

Looking for something in particular?

Page Object Cleaner

When using Page Objects in Provar it’s possible that over time, as you remap elements or refactor your test cases, you may have mappings for elements that are no longer required. These can affect performance by bloating the size of your Page Objects and increasing the compilation time during execution. To resolve this issue, we have launched a new beta feature to allow you to automatically identify unused elements and optionally remove them.

Note: We deliver an experimental feature for seeking customer feedback before general availability.

Provar’s TechOps team developed this feature during a recent innovation competition using our Custom API feature. This is an excellent example of the power of Provar Automation and how you can extend the platform. To learn more about Custom APIs please check out our help pages and documentation here.

The Page Object Cleaner will help you remove unused web elements by analyzing your test project. The execution for the existing test suite should not be negatively impacted, and there shouldn’t be extra log entries related to cleaner in the usual run for the existing test cases.

Note: The use of Provar Labs prototypes is at your own risk. Provar Labs prototypes should only be used on your non-production instance to test their functionality if you accept the risk of doing so. These prototypes have not completed the beta testing phase and might pose a higher-than-normal risk for bugs. We may enhance, withdraw or replace prototype features based on extended testing and feedback gathered. Do not rely on these features as part of your test automation.

Steps to Remove Unused Page Objects

Step 1: Create a new test case by clicking New Test Case under New Test drop-down menu.

Step 2: Drag and Drop API (Page Object Cleaner) from Test Palette into test case.

Click Test Palette on the Provar screen and drag Page Object Cleaner API from Custom API section to test case.

Above: Snapshot of Page object cleaner in the custom API section.

Step 3: Enter the required details in the TestStep parameters section

In the Test Step Parameters section – 

1. Select an option from the drop-down in the Clean Page Object field.

Above: Snapshot of Test Step Parameters section.

        a). If you select Scan Unused Element, you can see all the unused elements from the page objects in the logs.

       b). If you select Remove Unused Element, you can remove all the unused elements from the page objects.

2. In the Result Name field, enter the value.

3. the Test Case will be displayed automatically in the Result Scope field.

Step 4: Run the test case.

Click Run to execute the test case. Then, you will be able to see the logs of all unused elements or remove all the unused elements, as mentioned in Step 3.

Note: Unused elements are removed from the Page Object while selecting “Remove Unused Element” and will generate a Log file with Page Object’s location, name, and all removed elements. The backup will be created in the user directory.

By selecting the “Scan Unused Element,” elements will not be removed from the Page Object, but we can see it in logs, and any log file will not be generated.

Known Limitations

  • Limited log entries output when the page object execution is performed
  • The feature is currently placed in the Test Palette for visibility, but we plan to move it to be a right-click or menu item that uses a modal dialog, providing multiple test project cleaning and refactoring options. This will remove the risk of accidental re-execution of the Page Object Cleaner when not required. 
  • The test case could have a web request step.

Feedback

Was this article helpful for you?
Documentation library

Trying to raise a case with our support team?

We use cookies to better understand how our website is used so we can tailor content for you. For more information about the different cookies we use please take a look at our Privacy Policy.

Scroll to Top