GSoC work report - 24th June

Since my last update, I have
(1) Fixed the parent printing issue when logging keys - Gerrit #55675
(2) Made an interpreter for log statements - Gerrit #56120
(3) Changed some log statements - Gerrit #56305


About the interpreter -

The purpose of printing the log statements in a DSL is mainly to be able to interpret these log statements. The interpreter is written in python and is available at core/uitest/loginterpreter.py

The interpreter takes a log file as its input and outputs a python file which will act as a test case. It starts to read the log file line-by-line. Some events span two lines in log files, and others one. The first major task is done by the function get_coupling_type() which tells the interpreter whether the event being currently read spans over one line or two. Accordingly, either get_test_line_from_one_log_line() or get_test_line_from_two_log_lines() gets called. The interpreter then creates a python object corresponding to the UI element on which the action was performed. Finally, it calls a method from the created python object to actually perform the action. More information about the interpreter is in the commit message.

Coming up next -

After Gerrit change #56305, all the log statements are now in the appropriate DSL. The next task is to ensure their proper support. I will be working on the functions in the interpreter to support more types of log statements. After this, I will resume working on different UI wrapper classes.

Thank you for reading this :-)

Comments

Post a Comment

Popular posts from this blog

Things to know if you are a new contributor to LibreOffice code

When I began contributing code to LibreOffice, I faced some issues because I didn't know several facts that the other active contributors knew. This blog post summarizes some of those facts, and I hope it will be useful for other new contributors! 1) The data types LibreOffice code uses - If you have already browsed through the codebase of LibreOffice, you might have realized that the code doesn't generally use data types like int, float, double, et cetera like we use in small C++ programs. LibreOffice has its own classes, typedefs and structs defined and most of the code use them instead of the trivial data types. Some of those are OUString (instead of string), sal_uInt32 (instead of unsigned int), etc.
Read more

An overview of how UI logging works in LibreOffice

Logging in LibreOffice is mainly handled by a class called UITestLogger, defined here . The logger class logs the user actions only if the member flag mbValid is set to true. The flag can be turned on by setting the environment variable LO_COLLECT_UIINFO to a file name where the logs should be collected (see the constructor of UITestLogger, defined here ). We maintain a pointer to an instance of UITestLogger class here . To use the logger object, the static function getInstance can be used to get access to the pointer. The function logAction, defined in the same class, is used to log events from the classes which extend the class vcl::Control. The log statements corresponding to a particular class can be found in the function get_action of the UI wrapper classes. Most of the wrapper classes can be found with this OpenGrok search. The log statements get generated when VCL events get broadcasted. A list of the VCL events can be found in the enum class VclEventId here . For
Read more

GSoC final report - UI logger

Overview The idea of this GSoC project was to implement a feature which logs the interaction of users with the UI elements in an interpretable Domain Specific Language (DSL), and an interpreter which converts the log into a file into something which will help in replaying the user actions. The project involved working with the UI elements and the UI testing framework of LibreOffice. Achievements The logger - The logging for the following is currently supported - The UI elements of Visual Component Library like Buttons, Checkboxes, Radio-buttons, Listboxes, Comboboxes, Spinbuttons, etc. Keys pressed in different UI elements UNO commands sent with parameters Selection of Objects Opening of Sidebar/Deck Some application-specific events can also be logged - Writer - Goto Page, Set Zoom, Text Selection Calc - Autofilter Launch, Selection of cells/range of cells, Switching of Sheet Math - Selection of elements from the element selector panel Impress - Set Zoom Addition
Read more