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 increase 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 are delivering an experimental feature for seeking feedback from customers before general availability.

Provar’s TechOps team developed this feature during a recent innovation competition using our Custom API feature. This is a great 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 to remove all such unused web elements by analyzing your test project. The execution for the existing test suite should be not 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.

Click New Test Case under New Test drop-down menu.

Above: Snapshot of creating a new test case.

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

Click Test Pallete 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. In the Clean Page Object field, select an option from the drop-down.

Above: Snapshot of Test Step Parameters section.

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

       b). If you select Remove Unused Element, you will be able to remove all the unused elements from the page objects.

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

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

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 you can remove all the unused elements as mentioned in Step 3.

Above: Snapshot of Scan Unused Element.

Above: Screenshot displaying “Remove unused element”.

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 with 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 would be able to 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.