libreoffice/uitest/ui_logger_dsl/dsl_core.py

#!/usr/bin/env python3
# This file is part of the LibreOffice UI_logger project.
#
# This file contain the implementation of the Compiler
# for the new logger grammar
#
# ul stands for Ui_Logger

import os
import sys
import argparse
from textx.metamodel import metamodel_from_file

def parse_args():
    """
    This function parses the command-line arguments
    to get the input and output file details
    """
    parser = argparse.ArgumentParser(description = "Generate a UI test file from log")
    parser.add_argument("input_address", type = str, help = "The log file address")
    parser.add_argument("output_address", type = str, help = "The test file address")
    args = parser.parse_args()
    return args

class ul_Compiler:
    variables=[]
    objects = dict()
    def __init__(self , input_address , output_address):
        self.ui_dsl_mm = metamodel_from_file('ui_logger_dsl_grammar.tx')
        self.output_stream=self.initiate_test_generation(output_address)
        self.input_address=input_address

    def get_log_file(self , input_address):
        try:
            # load the program
            content = self.ui_dsl_mm.model_from_file(input_address)
        except IOError as err:
            print("IO error: {0}".format(err))
            print("Use " + os.path.basename(sys.argv[0]) + " -h to get usage instructions")
            sys.exit(1)

        return content

    def initiate_test_generation(self,output_address):
        try:
            f = open(output_address,"w")
        except IOError as err:
            print("IO error: {0}".format(err))
            print("Use " + os.path.basename(sys.argv[0]) + " -h to get usage instructions")
            sys.exit(1)
        line="# -*- tab-width: 4; indent-tabs-mode: nil; py-indent-offset: 4 -*-\n\n" + \
        "from uitest.framework import UITestCase\n" + \
        "from libreoffice.uno.propertyvalue import mkPropertyValues\n" + \
        "import importlib\n\n" + \
        "class TestClass(UITestCase):\n" + \
        "\tdef test_function(self):\n"

        self.variables.append(line)

        return f

    def compile(self):
        self.ui_dsl_mm.register_obj_processors({
            'UNOCommand': self.handle_uno,
            'StarterCommand': self.handle_start,
            'CloseDialog': self.handle_Dialog,
            'OpenModelessDialog': self.handle_Dialog,
            'OpenModalDialog':self.handle_Dialog,
            'ButtonUIObject':self.handle_button,
            'CheckBoxUIObject':self.handle_check_box,
            'TabControlUIObject':self.handle_tab,
            'ComboBoxUIObject':self.handle_Combo_box,
            'RadioButtonUIObject':self.handle_Radio_button,
            'ListBoxUIObject':self.handle_List_box,
            'SpinFieldUIObject':self.handle_spin_field,
            'EditUIObject':self.handle_Edit_uiObject,
            })

        self.log_lines=self.get_log_file(self.input_address)

    def handle_uno(self, UNOCommand):
        if(UNOCommand.prameters==None):
            line = "\t\tself.xUITest.executeCommand(\"" + \
                UNOCommand.uno_command_name +"\")\n"
        else:
            paramaters=""
            for p in UNOCommand.prameters.parameter_data :
                paramaters = paramaters + "\"" + p.key + "\" : " + str(p.value) + " ,"
            paramaters = paramaters[:-1]

            line = "\t\tself.xUITest.executeCommandWithParameters(\"" + \
                UNOCommand.uno_command_name +"\", mkPropertyValues({"+ paramaters +"}) )\n"

        self.variables.append(line)

    def handle_start(self, StarterCommand):
        line="\t\tMainDoc = self.ui_test.create_doc_in_start_center(\""+\
            StarterCommand.program_name+"\")\n"
        self.variables.append(line)

        line="\t\tMainWindow = self.xUITest.getTopFocusWindow()\n"
        self.variables.append(line)

    def handle_Dialog(self, DialogCommand):

        if (DialogCommand.__class__.__name__ == "OpenModalDialog"):
            old_line = self.variables.pop()

            key_word=old_line[-9:-3]
            if ( key_word == "Dialog"):
                old_line="\t\tself.ui_test.execute_dialog_through_command(\""+\
                    old_line[31:-3]+"\")\n"
            self.variables.append(old_line)
            line = "\t\t" + DialogCommand.dialog_name + " = self.xUITest.getTopFocusWindow()\n"

        elif (DialogCommand.__class__.__name__ == "OpenModelessDialog"):
            old_line = self.variables.pop()

            key_word=old_line[-9:-3]
            if ( key_word == "Dialog"):
                old_line="\t\tself.ui_test.execute_modeless_dialog_through_command(\""+\
                    old_line[31:-3]+"\")\n"
            self.variables.append(old_line)
            line = "\t\t" + DialogCommand.dialog_name + "  = self.xUITest.getTopFocusWindow()\n"

        elif (DialogCommand.__class__.__name__ == "CloseDialog"):
            line="\t\tto be implemented after ui Objects\n"

        self.variables.append(line)

    def handle_button(self, ButtonUIObject):

        if ButtonUIObject.ui_button in self.objects:
            self.objects[ButtonUIObject.ui_button]+=1
        else:
            self.objects[ButtonUIObject.ui_button]=1
            line="\t\t"+ButtonUIObject.ui_button+" = "+ButtonUIObject.parent_id+\
                ".getChild(\""+ButtonUIObject.ui_button+"\")\n"
            self.variables.append(line)

        line="\t\t"+ButtonUIObject.ui_button+".executeAction(\"CLICK\",tuple())\n"
        self.variables.append(line)

    def handle_check_box(self, CheckBoxUIObject):

        if CheckBoxUIObject.Check_box_id in self.objects:
            self.objects[CheckBoxUIObject.Check_box_id]+=1
        else:
            self.objects[CheckBoxUIObject.Check_box_id]=1
            line="\t\t"+CheckBoxUIObject.Check_box_id+" = "+CheckBoxUIObject.parent_id+\
                ".getChild(\""+CheckBoxUIObject.Check_box_id+"\")\n"
            self.variables.append(line)

        line="\t\t"+CheckBoxUIObject.Check_box_id+".executeAction(\"CLICK\",tuple())\n"
        self.variables.append(line)

    def handle_tab(self, TabControlUIObject):

        if TabControlUIObject.tab_id in self.objects:
            self.objects[TabControlUIObject.tab_id]+=1
        else:
            self.objects[TabControlUIObject.tab_id]=1
            line="\t\t"+TabControlUIObject.tab_id+" = "+TabControlUIObject.parent_id+\
                ".getChild(\""+TabControlUIObject.tab_id+"\")\n"
            self.variables.append(line)

        line="\t\t"+TabControlUIObject.tab_id+\
            ".executeAction(\"SELECT\", mkPropertyValues({\"POS\": \""+\
            str(TabControlUIObject.tab_page_number)+"\"}))\n"
        self.variables.append(line)

    def handle_Combo_box(self, ComboBoxUIObject):

        if ComboBoxUIObject.Combo_box_id in self.objects:
            self.objects[ComboBoxUIObject.Combo_box_id]+=1
        else:
            self.objects[ComboBoxUIObject.Combo_box_id]=1
            line="\t\t"+ComboBoxUIObject.Combo_box_id+" = "+ComboBoxUIObject.parent_id+\
                ".getChild(\""+ComboBoxUIObject.Combo_box_id+"\")\n"
            self.variables.append(line)

        line="\t\t"+ComboBoxUIObject.Combo_box_id+\
            ".executeAction(\"SELECT\", mkPropertyValues({\"POS\": \""+\
            str(ComboBoxUIObject.item_num)+"\"}))\n"
        self.variables.append(line)

    def handle_Radio_button(self,RadioButtonUIObject):

        if RadioButtonUIObject.Radio_button_id in self.objects:
            self.objects[RadioButtonUIObject.Radio_button_id]+=1
        else:
            self.objects[RadioButtonUIObject.Radio_button_id]=1
            line="\t\t"+RadioButtonUIObject.Radio_button_id+" = "+RadioButtonUIObject.parent_id+\
                ".getChild(\""+RadioButtonUIObject.Radio_button_id+"\")\n"
            self.variables.append(line)

        line="\t\t"+RadioButtonUIObject.Radio_button_id+".executeAction(\"CLICK\",tuple())\n"
        self.variables.append(line)

    def handle_List_box(self, ListBoxUIObject):

        if ListBoxUIObject.list_id in self.objects:
            self.objects[ListBoxUIObject.list_id]+=1
        else:
            self.objects[ListBoxUIObject.list_id]=1
            line="\t\t"+ListBoxUIObject.list_id+" = "+ListBoxUIObject.parent_id+\
                ".getChild(\""+ListBoxUIObject.list_id+"\")\n"
            self.variables.append(line)

        line="\t\t"+ListBoxUIObject.list_id+\
            ".executeAction(\"SELECT\", mkPropertyValues({\"POS\": \""+\
            str(ListBoxUIObject.POS)+"\"}))\n"
        self.variables.append(line)

    def handle_spin_field(self,SpinFieldUIObject):

        if SpinFieldUIObject.Spin_id in self.objects:
            self.objects[SpinFieldUIObject.Spin_id]+=1
        else:
            self.objects[SpinFieldUIObject.Spin_id]=1
            line="\t\t"+SpinFieldUIObject.Spin_id+" = "+SpinFieldUIObject.parent_id+\
                ".getChild(\""+SpinFieldUIObject.Spin_id+"\")\n"
            self.variables.append(line)

        if(SpinFieldUIObject.change=="Increase"):
            line="\t\t"+SpinFieldUIObject.Spin_id+".executeAction(\"UP\",tuple())\n"
        elif(SpinFieldUIObject.change=="Decrease"):
            line="\t\t"+SpinFieldUIObject.Spin_id+".executeAction(\"DOWN\",tuple())\n"
        self.variables.append(line)

    def handle_Edit_uiObject(self,EditUIObject):

        if(EditUIObject.action.__class__.__name__ =="Type_action"):
            if EditUIObject.action.edit_button in self.objects:
                self.objects[EditUIObject.action.edit_button]+=1
            else:
                self.objects[EditUIObject.action.edit_button]=1
                line="\t\t"+EditUIObject.action.edit_button+" = "+EditUIObject.parent_id+\
                ".getChild(\""+EditUIObject.action.edit_button+"\")\n"
                self.variables.append(line)

            if(EditUIObject.action.what_to_type.__class__.__name__=="char"):
                line="\t\t"+EditUIObject.action.edit_button+\
                ".executeAction(\"TYPE\", mkPropertyValues({\"TEXT\": \""+\
                EditUIObject.action.what_to_type.input_char+"\"}))\n"

            elif(EditUIObject.action.what_to_type.__class__.__name__=="KeyCode"):
                line="\t\t"+EditUIObject.action.edit_button+\
                ".executeAction(\"TYPE\", mkPropertyValues({\"KEYCODE\":"+\
                EditUIObject.action.what_to_type.input_key_code+"\"}))\n"
            self.variables.append(line)

        if(EditUIObject.action.__class__.__name__ =="SELECT"):
            if EditUIObject.action.edit_button in self.objects:
                self.objects[EditUIObject.action.edit_button]+=1
            else:
                self.objects[EditUIObject.action.edit_button]=1
                line="\t\t"+EditUIObject.action.edit_button+" = "+EditUIObject.parent_id+\
                ".getChild(\""+EditUIObject.action.edit_button+"\")\n"
                self.variables.append(line)

            line="\t\t"+EditUIObject.action.edit_button+\
                ".executeAction(\"SELECT\", mkPropertyValues({\"from\": \""+\
                str(EditUIObject.action.from_pos )+"\", \"TO\": \""+\
                str(EditUIObject.action.to_pos)+"\"}))\n"
            self.variables.append(line)

        if(EditUIObject.action.__class__.__name__ =="Clear"):
            if EditUIObject.action.edit_button in self.objects:
                self.objects[EditUIObject.action.edit_button]+=1
            else:
                self.objects[EditUIObject.action.edit_button]=1
                line="\t\t"+EditUIObject.action.edit_button+" = "+EditUIObject.parent_id+\
                ".getChild(\""+EditUIObject.action.edit_button+"\")\n"
                self.variables.append(line)

            line="\t\t"+EditUIObject.action.edit_button+\
                ".executeAction(\"CLEAR\",tuple())\n"
            self.variables.append(line)

    def Generate_UI_test(self):
        line="\t\tself.ui_test.close_doc()"
        self.variables.append(line)

        for line in self.variables:
            self.output_stream.write(str(line))

    def __del__(self):
        self.output_stream.close()

def main():
    args = parse_args()
    ui_logger = ul_Compiler(args.input_address,args.output_address)
    ui_logger.compile()
    for statement in (ui_logger.log_lines.commands):
        print(statement)
    ui_logger.Generate_UI_test()
    del ui_logger

if __name__ == '__main__':
    main()